2 * Driver interface definition
3 * Copyright (c) 2003-2015, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
8 * This file defines a driver interface used by both %wpa_supplicant and
9 * hostapd. The first part of the file defines data structures used in various
10 * driver operations. This is followed by the struct wpa_driver_ops that each
11 * driver wrapper will beed to define with callback functions for requesting
12 * driver operations. After this, there are definitions for driver event
13 * reporting with wpa_supplicant_event() and some convenience helper functions
14 * that can be used to report events.
20 #define WPA_SUPPLICANT_DRIVER_VERSION 4
22 #include "common/defs.h"
23 #include "common/ieee802_11_defs.h"
24 #include "utils/list.h"
26 #define HOSTAPD_CHAN_DISABLED 0x00000001
27 #define HOSTAPD_CHAN_NO_IR 0x00000002
28 #define HOSTAPD_CHAN_RADAR 0x00000008
29 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
30 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
31 #define HOSTAPD_CHAN_HT40 0x00000040
32 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
34 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
35 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
36 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
37 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
38 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
40 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
41 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
42 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
43 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
45 #define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
46 #define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
49 * enum reg_change_initiator - Regulatory change initiator
51 enum reg_change_initiator
{
55 REGDOM_SET_BY_COUNTRY_IE
,
60 * enum reg_type - Regulatory change types
66 REGDOM_TYPE_CUSTOM_WORLD
,
67 REGDOM_TYPE_INTERSECTION
,
71 * struct hostapd_channel_data - Channel information
73 struct hostapd_channel_data
{
75 * chan - Channel number (IEEE 802.11)
80 * freq - Frequency in MHz
85 * flag - Channel flags (HOSTAPD_CHAN_*)
90 * max_tx_power - Regulatory transmit power limit in dBm
95 * survey_list - Linked list of surveys (struct freq_survey)
97 struct dl_list survey_list
;
100 * min_nf - Minimum observed noise floor, in dBm, based on all
101 * surveyed channel data
107 * interference_factor - Computed interference factor on this
108 * channel (used internally in src/ap/acs.c; driver wrappers do not
111 long double interference_factor
;
112 #endif /* CONFIG_ACS */
115 * dfs_cac_ms - DFS CAC time in milliseconds
117 unsigned int dfs_cac_ms
;
120 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
121 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
124 * struct hostapd_hw_modes - Supported hardware mode information
126 struct hostapd_hw_modes
{
128 * mode - Hardware mode
130 enum hostapd_hw_mode mode
;
133 * num_channels - Number of entries in the channels array
138 * channels - Array of supported channels
140 struct hostapd_channel_data
*channels
;
143 * num_rates - Number of entries in the rates array
148 * rates - Array of supported rates in 100 kbps units
153 * ht_capab - HT (IEEE 802.11n) capabilities
158 * mcs_set - MCS (IEEE 802.11n) rate parameters
163 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
168 * vht_capab - VHT (IEEE 802.11ac) capabilities
173 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
177 unsigned int flags
; /* HOSTAPD_MODE_FLAG_* */
181 #define IEEE80211_MODE_INFRA 0
182 #define IEEE80211_MODE_IBSS 1
183 #define IEEE80211_MODE_AP 2
184 #define IEEE80211_MODE_MESH 5
186 #define IEEE80211_CAP_ESS 0x0001
187 #define IEEE80211_CAP_IBSS 0x0002
188 #define IEEE80211_CAP_PRIVACY 0x0010
189 #define IEEE80211_CAP_RRM 0x1000
191 /* DMG (60 GHz) IEEE 802.11ad */
192 /* type - bits 0..1 */
193 #define IEEE80211_CAP_DMG_MASK 0x0003
194 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
195 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
196 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
198 #define WPA_SCAN_QUAL_INVALID BIT(0)
199 #define WPA_SCAN_NOISE_INVALID BIT(1)
200 #define WPA_SCAN_LEVEL_INVALID BIT(2)
201 #define WPA_SCAN_LEVEL_DBM BIT(3)
202 #define WPA_SCAN_ASSOCIATED BIT(5)
205 * struct wpa_scan_res - Scan result for an BSS/IBSS
206 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
208 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
209 * @beacon_int: beacon interval in TUs (host byte order)
210 * @caps: capability information field in host byte order
211 * @qual: signal quality
212 * @noise: noise level
213 * @level: signal level
215 * @age: Age of the information in milliseconds (i.e., how many milliseconds
216 * ago the last Beacon or Probe Response frame was received)
217 * @est_throughput: Estimated throughput in kbps (this is calculated during
218 * scan result processing if left zero by the driver wrapper)
219 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
220 * @ie_len: length of the following IE field in octets
221 * @beacon_ie_len: length of the following Beacon IE field in octets
223 * This structure is used as a generic format for scan results from the
224 * driver. Each driver interface implementation is responsible for converting
225 * the driver or OS specific scan results into this format.
227 * If the driver does not support reporting all IEs, the IE data structure is
228 * constructed of the IEs that are available. This field will also need to
229 * include SSID in IE format. All drivers are encouraged to be extended to
230 * report all IEs to make it easier to support future additions.
232 * This structure data is followed by ie_len octets of IEs from Probe Response
233 * frame (or if the driver does not indicate source of IEs, these may also be
234 * from Beacon frame). After the first set of IEs, another set of IEs may follow
235 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
237 struct wpa_scan_res
{
248 unsigned int est_throughput
;
251 size_t beacon_ie_len
;
252 /* Followed by ie_len + beacon_ie_len octets of IE data */
256 * struct wpa_scan_results - Scan results
257 * @res: Array of pointers to allocated variable length scan result entries
258 * @num: Number of entries in the scan result array
259 * @fetch_time: Time when the results were fetched from the driver
261 struct wpa_scan_results
{
262 struct wpa_scan_res
**res
;
264 struct os_reltime fetch_time
;
268 * struct wpa_interface_info - Network interface information
269 * @next: Pointer to the next interface or NULL if this is the last one
270 * @ifname: Interface name that can be used with init() or init2()
271 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
273 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
274 * is not an allocated copy, i.e., get_interfaces() caller will not free
277 struct wpa_interface_info
{
278 struct wpa_interface_info
*next
;
281 const char *drv_name
;
284 #define WPAS_MAX_SCAN_SSIDS 16
287 * struct wpa_driver_scan_params - Scan parameters
288 * Data for struct wpa_driver_ops::scan2().
290 struct wpa_driver_scan_params
{
292 * ssids - SSIDs to scan for
294 struct wpa_driver_scan_ssid
{
296 * ssid - specific SSID to scan for (ProbeReq)
297 * %NULL or zero-length SSID is used to indicate active scan
298 * with wildcard SSID.
302 * ssid_len: Length of the SSID in octets
305 } ssids
[WPAS_MAX_SCAN_SSIDS
];
308 * num_ssids - Number of entries in ssids array
309 * Zero indicates a request for a passive scan.
314 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
319 * extra_ies_len - Length of extra_ies in octets
321 size_t extra_ies_len
;
324 * freqs - Array of frequencies to scan or %NULL for all frequencies
326 * The frequency is set in MHz. The array is zero-terminated.
331 * filter_ssids - Filter for reporting SSIDs
333 * This optional parameter can be used to request the driver wrapper to
334 * filter scan results to include only the specified SSIDs. %NULL
335 * indicates that no filtering is to be done. This can be used to
336 * reduce memory needs for scan results in environments that have large
337 * number of APs with different SSIDs.
339 * The driver wrapper is allowed to take this allocated buffer into its
340 * own use by setting the pointer to %NULL. In that case, the driver
341 * wrapper is responsible for freeing the buffer with os_free() once it
342 * is not needed anymore.
344 struct wpa_driver_scan_filter
{
345 u8 ssid
[SSID_MAX_LEN
];
350 * num_filter_ssids - Number of entries in filter_ssids array
352 size_t num_filter_ssids
;
355 * filter_rssi - Filter by RSSI
357 * The driver may filter scan results in firmware to reduce host
358 * wakeups and thereby save power. Specify the RSSI threshold in s32
364 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
366 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
367 * Mbps from the support rates element(s) in the Probe Request frames
368 * and not to transmit the frames at any of those rates.
370 unsigned int p2p_probe
:1;
373 * only_new_results - Request driver to report only new results
375 * This is used to request the driver to report only BSSes that have
376 * been detected after this scan request has been started, i.e., to
377 * flush old cached BSS entries.
379 unsigned int only_new_results
:1;
382 * low_priority - Requests driver to use a lower scan priority
384 * This is used to request the driver to use a lower scan priority
385 * if it supports such a thing.
387 unsigned int low_priority
:1;
390 * mac_addr_rand - Requests driver to randomize MAC address
392 unsigned int mac_addr_rand
:1;
395 * mac_addr - MAC address used with randomization. The address cannot be
396 * a multicast one, i.e., bit 0 of byte 0 should not be set.
401 * mac_addr_mask - MAC address mask used with randomization.
403 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
404 * the mask should be taken as is from mac_addr. The mask should not
405 * allow the generation of a multicast address, i.e., bit 0 of byte 0
408 const u8
*mac_addr_mask
;
411 * NOTE: Whenever adding new parameters here, please make sure
412 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
418 * struct wpa_driver_auth_params - Authentication parameters
419 * Data for struct wpa_driver_ops::authenticate().
421 struct wpa_driver_auth_params
{
429 const u8
*wep_key
[4];
430 size_t wep_key_len
[4];
432 int local_state_change
;
435 * p2p - Whether this connection is a P2P group
440 * sae_data - SAE elements for Authentication frame
442 * This buffer starts with the Authentication transaction sequence
443 * number field. If SAE is not used, this pointer is %NULL.
448 * sae_data_len - Length of sae_data buffer in octets
454 * enum wps_mode - WPS mode
458 * WPS_MODE_NONE - No WPS provisioning being used
463 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
468 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
474 * struct hostapd_freq_params - Channel parameters
476 struct hostapd_freq_params
{
478 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
480 enum hostapd_hw_mode mode
;
483 * freq - Primary channel center frequency in MHz
488 * channel - Channel number
493 * ht_enabled - Whether HT is enabled
498 * sec_channel_offset - Secondary channel offset for HT40
501 * -1 = HT40 enabled, secondary channel below primary,
502 * 1 = HT40 enabled, secondary channel above primary
504 int sec_channel_offset
;
507 * vht_enabled - Whether VHT is enabled
512 * center_freq1 - Segment 0 center frequency in MHz
514 * Valid for both HT and VHT.
519 * center_freq2 - Segment 1 center frequency in MHz
521 * Non-zero only for bandwidth 80 and an 80+80 channel
526 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
532 * struct wpa_driver_associate_params - Association parameters
533 * Data for struct wpa_driver_ops::associate().
535 struct wpa_driver_associate_params
{
537 * bssid - BSSID of the selected AP
538 * This can be %NULL, if ap_scan=2 mode is used and the driver is
539 * responsible for selecting with which BSS to associate. */
543 * bssid_hint - BSSID of a proposed AP
545 * This indicates which BSS has been found a suitable candidate for
546 * initial association for drivers that use driver/firmwate-based BSS
547 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
548 * the driver from selecting other BSSes in the ESS.
550 const u8
*bssid_hint
;
553 * ssid - The selected SSID
558 * ssid_len - Length of the SSID (1..32)
563 * freq - channel parameters
565 struct hostapd_freq_params freq
;
568 * freq_hint - Frequency of the channel the proposed AP is using
570 * This provides a channel on which a suitable BSS has been found as a
571 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
572 * limit the driver from selecting other channels for
573 * driver/firmware-based BSS selection.
578 * bg_scan_period - Background scan period in seconds, 0 to disable
579 * background scan, or -1 to indicate no change to default driver
585 * beacon_int - Beacon interval for IBSS or 0 to use driver default
590 * wpa_ie - WPA information element for (Re)Association Request
591 * WPA information element to be included in (Re)Association
592 * Request (including information element id and length). Use
593 * of this WPA IE is optional. If the driver generates the WPA
594 * IE, it can use pairwise_suite, group_suite, and
595 * key_mgmt_suite to select proper algorithms. In this case,
596 * the driver has to notify wpa_supplicant about the used WPA
597 * IE by generating an event that the interface code will
598 * convert into EVENT_ASSOCINFO data (see below).
600 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
601 * instead. The driver can determine which version is used by
602 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
605 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
610 * wpa_ie_len - length of the wpa_ie
615 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
617 unsigned int wpa_proto
;
620 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
622 * This is usually ignored if @wpa_ie is used.
624 unsigned int pairwise_suite
;
627 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
629 * This is usually ignored if @wpa_ie is used.
631 unsigned int group_suite
;
634 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
636 * This is usually ignored if @wpa_ie is used.
638 unsigned int key_mgmt_suite
;
641 * auth_alg - Allowed authentication algorithms
642 * Bit field of WPA_AUTH_ALG_*
647 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
652 * wep_key - WEP keys for static WEP configuration
654 const u8
*wep_key
[4];
657 * wep_key_len - WEP key length for static WEP configuration
659 size_t wep_key_len
[4];
662 * wep_tx_keyidx - WEP TX key index for static WEP configuration
667 * mgmt_frame_protection - IEEE 802.11w management frame protection
669 enum mfp_options mgmt_frame_protection
;
672 * ft_ies - IEEE 802.11r / FT information elements
673 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
674 * for fast transition, this parameter is set to include the IEs that
675 * are to be sent in the next FT Authentication Request message.
676 * update_ft_ies() handler is called to update the IEs for further
677 * FT messages in the sequence.
679 * The driver should use these IEs only if the target AP is advertising
680 * the same mobility domain as the one included in the MDIE here.
682 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
683 * AP after the initial association. These IEs can only be used if the
684 * target AP is advertising support for FT and is using the same MDIE
685 * and SSID as the current AP.
687 * The driver is responsible for reporting the FT IEs received from the
688 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
689 * type. update_ft_ies() handler will then be called with the FT IEs to
690 * include in the next frame in the authentication sequence.
695 * ft_ies_len - Length of ft_ies in bytes
700 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
702 * This value is provided to allow the driver interface easier access
703 * to the current mobility domain. This value is set to %NULL if no
704 * mobility domain is currently active.
709 * passphrase - RSN passphrase for PSK
711 * This value is made available only for WPA/WPA2-Personal (PSK) and
712 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
713 * the 8..63 character ASCII passphrase, if available. Please note that
714 * this can be %NULL if passphrase was not used to generate the PSK. In
715 * that case, the psk field must be used to fetch the PSK.
717 const char *passphrase
;
720 * psk - RSN PSK (alternative for passphrase for PSK)
722 * This value is made available only for WPA/WPA2-Personal (PSK) and
723 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
724 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
725 * be prepared to handle %NULL value as an error.
730 * drop_unencrypted - Enable/disable unencrypted frame filtering
732 * Configure the driver to drop all non-EAPOL frames (both receive and
733 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
734 * still be allowed for key negotiation.
736 int drop_unencrypted
;
739 * prev_bssid - Previously used BSSID in this ESS
741 * When not %NULL, this is a request to use reassociation instead of
744 const u8
*prev_bssid
;
749 * If the driver needs to do special configuration for WPS association,
750 * this variable provides more information on what type of association
751 * is being requested. Most drivers should not need ot use this.
756 * p2p - Whether this connection is a P2P group
761 * uapsd - UAPSD parameters for the network
762 * -1 = do not change defaults
763 * AP mode: 1 = enabled, 0 = disabled
764 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
769 * fixed_bssid - Whether to force this BSSID in IBSS mode
770 * 1 = Fix this BSSID and prevent merges.
771 * 0 = Do not fix BSSID.
776 * fixed_freq - Fix control channel in IBSS mode
777 * 0 = don't fix control channel (default)
778 * 1 = fix control channel; this prevents IBSS merging with another
784 * disable_ht - Disable HT (IEEE 802.11n) for this connection
789 * htcaps - HT Capabilities over-rides
791 * Only bits set in the mask will be used, and not all values are used
792 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
794 * Pointer to struct ieee80211_ht_capabilities.
799 * htcaps_mask - HT Capabilities over-rides mask
801 * Pointer to struct ieee80211_ht_capabilities.
803 const u8
*htcaps_mask
;
805 #ifdef CONFIG_VHT_OVERRIDES
807 * disable_vht - Disable VHT for this connection
812 * VHT capability overrides.
814 const struct ieee80211_vht_capabilities
*vhtcaps
;
815 const struct ieee80211_vht_capabilities
*vhtcaps_mask
;
816 #endif /* CONFIG_VHT_OVERRIDES */
819 * req_key_mgmt_offload - Request key management offload for connection
821 * Request key management offload for this connection if the device
824 int req_key_mgmt_offload
;
827 * Flag for indicating whether this association includes support for
828 * RRM (Radio Resource Measurements)
835 HIDDEN_SSID_ZERO_LEN
,
836 HIDDEN_SSID_ZERO_CONTENTS
839 struct wowlan_triggers
{
843 u8 gtk_rekey_failure
;
845 u8 four_way_handshake
;
849 struct wpa_driver_ap_params
{
851 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
856 * head_len - Length of the head buffer in octets
861 * tail - Beacon tail following TIM IE
866 * tail_len - Length of the tail buffer in octets
871 * dtim_period - DTIM period
876 * beacon_int - Beacon interval
881 * basic_rates: -1 terminated array of basic rates in 100 kbps
883 * This parameter can be used to set a specific basic rate set for the
884 * BSS. If %NULL, default basic rate set is used.
889 * proberesp - Probe Response template
891 * This is used by drivers that reply to Probe Requests internally in
892 * AP mode and require the full Probe Response template.
897 * proberesp_len - Length of the proberesp buffer in octets
899 size_t proberesp_len
;
902 * ssid - The SSID to use in Beacon/Probe Response frames
907 * ssid_len - Length of the SSID (1..32)
912 * hide_ssid - Whether to hide the SSID
914 enum hide_ssid hide_ssid
;
917 * pairwise_ciphers - WPA_CIPHER_* bitfield
919 unsigned int pairwise_ciphers
;
922 * group_cipher - WPA_CIPHER_*
924 unsigned int group_cipher
;
927 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
929 unsigned int key_mgmt_suites
;
932 * auth_algs - WPA_AUTH_ALG_* bitfield
934 unsigned int auth_algs
;
937 * wpa_version - WPA_PROTO_* bitfield
939 unsigned int wpa_version
;
942 * privacy - Whether privacy is used in the BSS
947 * beacon_ies - WPS/P2P IE(s) for Beacon frames
949 * This is used to add IEs like WPS IE and P2P IE by drivers that do
950 * not use the full Beacon template.
952 const struct wpabuf
*beacon_ies
;
955 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
957 * This is used to add IEs like WPS IE and P2P IE by drivers that
958 * reply to Probe Request frames internally.
960 const struct wpabuf
*proberesp_ies
;
963 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
965 * This is used to add IEs like WPS IE by drivers that reply to
966 * (Re)Association Request frames internally.
968 const struct wpabuf
*assocresp_ies
;
971 * isolate - Whether to isolate frames between associated stations
973 * If this is non-zero, the AP is requested to disable forwarding of
974 * frames between associated stations.
979 * cts_protect - Whether CTS protection is enabled
984 * preamble - Whether short preamble is enabled
989 * short_slot_time - Whether short slot time is enabled
991 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
992 * not set (e.g., when 802.11g mode is not in use)
997 * ht_opmode - HT operation mode or -1 if HT not in use
1002 * interworking - Whether Interworking is enabled
1007 * hessid - Homogeneous ESS identifier or %NULL if not set
1012 * access_network_type - Access Network Type (0..15)
1014 * This is used for filtering Probe Request frames when Interworking is
1017 u8 access_network_type
;
1020 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1022 * This is used by driver which advertises this capability.
1024 int ap_max_inactivity
;
1027 * ctwindow - Client Traffic Window (in TUs)
1032 * smps_mode - SMPS mode
1034 * SMPS mode to be used by the AP, specified as the relevant bits of
1035 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1037 unsigned int smps_mode
;
1040 * disable_dgaf - Whether group-addressed frames are disabled
1045 * osen - Whether OSEN security is enabled
1050 * freq - Channel parameters for dynamic bandwidth changes
1052 struct hostapd_freq_params
*freq
;
1055 * reenable - Whether this is to re-enable beaconing
1060 struct wpa_driver_mesh_bss_params
{
1061 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1063 * TODO: Other mesh configuration parameters would go here.
1064 * See NL80211_MESHCONF_* for all the mesh config parameters.
1067 int peer_link_timeout
;
1070 struct wpa_driver_mesh_join_params
{
1073 const int *basic_rates
;
1076 struct hostapd_freq_params freq
;
1079 struct wpa_driver_mesh_bss_params conf
;
1080 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1081 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1082 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1083 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1088 * struct wpa_driver_capa - Driver capability information
1090 struct wpa_driver_capa
{
1091 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1092 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1093 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1094 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1095 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1096 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1097 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1098 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1099 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1100 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
1101 /** Bitfield of supported key management suites */
1102 unsigned int key_mgmt
;
1104 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1105 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1106 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1107 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1108 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1109 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1110 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1111 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1112 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1113 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1114 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1115 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1116 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1117 /** Bitfield of supported cipher suites */
1120 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1121 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1122 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1123 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1126 /** Driver generated WPA/RSN IE */
1127 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1128 /** Driver needs static WEP key setup after association command */
1129 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1130 /** Driver takes care of all DFS operations */
1131 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1132 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1133 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1134 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1135 /** Driver is for a wired Ethernet interface */
1136 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1137 /** Driver provides separate commands for authentication and association (SME in
1138 * wpa_supplicant). */
1139 #define WPA_DRIVER_FLAGS_SME 0x00000020
1140 /** Driver supports AP mode */
1141 #define WPA_DRIVER_FLAGS_AP 0x00000040
1142 /** Driver needs static WEP key setup after association has been completed */
1143 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1144 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1145 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1146 /** Driver supports concurrent P2P operations */
1147 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1149 * Driver uses the initial interface as a dedicated management interface, i.e.,
1150 * it cannot be used for P2P group operations or non-P2P purposes.
1152 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1153 /** This interface is P2P capable (P2P GO or P2P Client) */
1154 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1155 /** Driver supports station and key removal when stopping an AP */
1156 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1158 * Driver uses the initial interface for P2P management interface and non-P2P
1159 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1160 * P2P group operations.
1162 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1164 * Driver is known to use sane error codes, i.e., when it indicates that
1165 * something (e.g., association) fails, there was indeed a failure and the
1166 * operation does not end up getting completed successfully later.
1168 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1169 /** Driver supports off-channel TX */
1170 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1171 /** Driver indicates TX status events for EAPOL Data frames */
1172 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1173 /** Driver indicates TX status events for Deauth/Disassoc frames */
1174 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1175 /** Driver supports roaming (BSS selection) in firmware */
1176 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1177 /** Driver supports operating as a TDLS peer */
1178 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1179 /** Driver requires external TDLS setup/teardown/discovery */
1180 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1181 /** Driver indicates support for Probe Response offloading in AP mode */
1182 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1183 /** Driver supports U-APSD in AP mode */
1184 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1185 /** Driver supports inactivity timer in AP mode */
1186 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1187 /** Driver expects user space implementation of MLME in AP mode */
1188 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1189 /** Driver supports SAE with user space SME */
1190 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1191 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1192 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1193 /** Driver supports IBSS (Ad-hoc) mode */
1194 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1195 /** Driver supports radar detection */
1196 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1197 /** Driver supports a dedicated interface for P2P Device */
1198 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1199 /** Driver supports QoS Mapping */
1200 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1201 /** Driver supports CSA in AP mode */
1202 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1203 /** Driver supports mesh */
1204 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1205 /** Driver support ACS offload */
1206 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1207 /** Driver supports key management offload */
1208 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1209 /** Driver supports TDLS channel switching */
1210 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1211 /** Driver supports IBSS with HT datarates */
1212 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
1213 /** Driver supports IBSS with VHT datarates */
1214 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
1215 /** Driver supports automatic band selection */
1216 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
1217 /** Driver supports simultaneous off-channel operations */
1218 #define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
1221 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1222 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1223 unsigned int smps_modes
;
1225 unsigned int wmm_ac_supported
:1;
1227 unsigned int mac_addr_rand_scan_supported
:1;
1228 unsigned int mac_addr_rand_sched_scan_supported
:1;
1230 /** Maximum number of supported active probe SSIDs */
1233 /** Maximum number of supported active probe SSIDs for sched_scan */
1234 int max_sched_scan_ssids
;
1236 /** Whether sched_scan (offloaded scanning) is supported */
1237 int sched_scan_supported
;
1239 /** Maximum number of supported match sets for sched_scan */
1243 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1245 unsigned int max_remain_on_chan
;
1248 * max_stations - Maximum number of associated stations the driver
1249 * supports in AP mode
1251 unsigned int max_stations
;
1254 * probe_resp_offloads - Bitmap of supported protocols by the driver
1255 * for Probe Response offloading.
1257 /** Driver Probe Response offloading support for WPS ver. 1 */
1258 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1259 /** Driver Probe Response offloading support for WPS ver. 2 */
1260 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1261 /** Driver Probe Response offloading support for P2P */
1262 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1263 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1264 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1265 unsigned int probe_resp_offloads
;
1267 unsigned int max_acl_mac_addrs
;
1270 * Number of supported concurrent channels
1272 unsigned int num_multichan_concurrent
;
1275 * extended_capa - extended capabilities in driver/device
1277 * Must be allocated and freed by driver and the pointers must be
1278 * valid for the lifetime of the driver, i.e., freed in deinit()
1280 const u8
*extended_capa
, *extended_capa_mask
;
1281 unsigned int extended_capa_len
;
1283 struct wowlan_triggers wowlan_triggers
;
1285 /** Driver adds the DS Params Set IE in Probe Request frames */
1286 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1287 /** Driver adds the WFA TPC IE in Probe Request frames */
1288 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1289 /** Driver handles quiet period requests */
1290 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1292 * Driver is capable of inserting the current TX power value into the body of
1293 * transmitted frames.
1294 * Background: Some Action frames include a TPC Report IE. This IE contains a
1295 * TX power field, which has to be updated by lower layers. One such Action
1296 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1297 * of spectrum management). Note that this insertion takes place at a fixed
1298 * offset, namely the 6th byte in the Action frame body.
1300 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1303 /* Driver concurrency capabilities */
1304 unsigned int conc_capab
;
1305 /* Maximum number of concurrent channels on 2.4 GHz */
1306 unsigned int max_conc_chan_2_4
;
1307 /* Maximum number of concurrent channels on 5 GHz */
1308 unsigned int max_conc_chan_5_0
;
1312 struct hostapd_data
;
1314 struct hostap_sta_driver_data
{
1315 unsigned long rx_packets
, tx_packets
, rx_bytes
, tx_bytes
;
1316 unsigned long current_tx_rate
;
1317 unsigned long inactive_msec
;
1318 unsigned long flags
;
1319 unsigned long num_ps_buf_frames
;
1320 unsigned long tx_retry_failed
;
1321 unsigned long tx_retry_count
;
1326 struct hostapd_sta_add_params
{
1330 const u8
*supp_rates
;
1331 size_t supp_rates_len
;
1332 u16 listen_interval
;
1333 const struct ieee80211_ht_capabilities
*ht_capabilities
;
1334 const struct ieee80211_vht_capabilities
*vht_capabilities
;
1335 int vht_opmode_enabled
;
1337 u32 flags
; /* bitmask of WPA_STA_* flags */
1338 u32 flags_mask
; /* unset bits in flags */
1340 enum mesh_plink_state plink_state
;
1341 #endif /* CONFIG_MESH */
1342 int set
; /* Set STA parameters instead of add */
1344 const u8
*ext_capab
;
1345 size_t ext_capab_len
;
1346 const u8
*supp_channels
;
1347 size_t supp_channels_len
;
1348 const u8
*supp_oper_classes
;
1349 size_t supp_oper_classes_len
;
1352 struct mac_address
{
1356 struct hostapd_acl_params
{
1358 unsigned int num_mac_acl
;
1359 struct mac_address mac_acl
[0];
1362 enum wpa_driver_if_type
{
1364 * WPA_IF_STATION - Station mode interface
1369 * WPA_IF_AP_VLAN - AP mode VLAN interface
1371 * This interface shares its address and Beacon frame with the main
1377 * WPA_IF_AP_BSS - AP mode BSS interface
1379 * This interface has its own address and Beacon frame.
1384 * WPA_IF_P2P_GO - P2P Group Owner
1389 * WPA_IF_P2P_CLIENT - P2P Client
1394 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1395 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1400 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1401 * abstracted P2P Device function in the driver
1406 * WPA_IF_MESH - Mesh interface
1411 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1416 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1421 struct wpa_init_params
{
1425 const char *driver_params
;
1426 int use_pae_group_addr
;
1430 u8
*own_addr
; /* buffer for writing own MAC address */
1434 struct wpa_bss_params
{
1435 /** Interface name (for multi-SSID/VLAN support) */
1437 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1446 enum mfp_options ieee80211w
;
1449 #define WPA_STA_AUTHORIZED BIT(0)
1450 #define WPA_STA_WMM BIT(1)
1451 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1452 #define WPA_STA_MFP BIT(3)
1453 #define WPA_STA_TDLS_PEER BIT(4)
1454 #define WPA_STA_AUTHENTICATED BIT(5)
1467 WNM_SLEEP_ENTER_CONFIRM
,
1468 WNM_SLEEP_ENTER_FAIL
,
1469 WNM_SLEEP_EXIT_CONFIRM
,
1470 WNM_SLEEP_EXIT_FAIL
,
1471 WNM_SLEEP_TFS_REQ_IE_ADD
, /* STA requests driver to add TFS req IE */
1472 WNM_SLEEP_TFS_REQ_IE_NONE
, /* STA requests empty TFS req IE */
1473 WNM_SLEEP_TFS_REQ_IE_SET
, /* AP requests driver to set TFS req IE for
1475 WNM_SLEEP_TFS_RESP_IE_ADD
, /* AP requests driver to add TFS resp IE
1477 WNM_SLEEP_TFS_RESP_IE_NONE
, /* AP requests empty TFS resp IE */
1478 WNM_SLEEP_TFS_RESP_IE_SET
, /* AP requests driver to set TFS resp IE
1480 WNM_SLEEP_TFS_IE_DEL
/* AP delete the TFS IE */
1483 /* enum chan_width - Channel width definitions */
1495 * struct wpa_signal_info - Information about channel signal quality
1497 struct wpa_signal_info
{
1499 int above_threshold
;
1502 int avg_beacon_signal
;
1505 enum chan_width chanwidth
;
1511 * struct beacon_data - Beacon data
1512 * @head: Head portion of Beacon frame (before TIM IE)
1513 * @tail: Tail portion of Beacon frame (after TIM IE)
1514 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1515 * @proberesp_ies: Extra information element(s) to add into Probe Response
1517 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1518 * Response frames or %NULL
1519 * @probe_resp: Probe Response frame template
1520 * @head_len: Length of @head
1521 * @tail_len: Length of @tail
1522 * @beacon_ies_len: Length of beacon_ies in octets
1523 * @proberesp_ies_len: Length of proberesp_ies in octets
1524 * @proberesp_ies_len: Length of proberesp_ies in octets
1525 * @probe_resp_len: Length of probe response template (@probe_resp)
1527 struct beacon_data
{
1534 size_t head_len
, tail_len
;
1535 size_t beacon_ies_len
;
1536 size_t proberesp_ies_len
;
1537 size_t assocresp_ies_len
;
1538 size_t probe_resp_len
;
1542 * struct csa_settings - Settings for channel switch command
1543 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1544 * @block_tx: 1 - block transmission for CSA period
1545 * @freq_params: Next channel frequency parameter
1546 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1547 * @beacon_after: Next beacon/probe resp/asooc resp info
1548 * @counter_offset_beacon: Offset to the count field in beacon's tail
1549 * @counter_offset_presp: Offset to the count field in probe resp.
1551 struct csa_settings
{
1555 struct hostapd_freq_params freq_params
;
1556 struct beacon_data beacon_csa
;
1557 struct beacon_data beacon_after
;
1559 u16 counter_offset_beacon
;
1560 u16 counter_offset_presp
;
1563 /* TDLS peer capabilities for send_tdls_mgmt() */
1564 enum tdls_peer_capability
{
1565 TDLS_PEER_HT
= BIT(0),
1566 TDLS_PEER_VHT
= BIT(1),
1567 TDLS_PEER_WMM
= BIT(2),
1570 /* valid info in the wmm_params struct */
1571 enum wmm_params_valid_info
{
1572 WMM_PARAMS_UAPSD_QUEUES_INFO
= BIT(0),
1576 * struct wmm_params - WMM parameterss configured for this association
1577 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1578 * of the struct contain valid information.
1579 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1580 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1587 #ifdef CONFIG_MACSEC
1588 struct macsec_init_params
{
1589 Boolean always_include_sci
;
1593 #endif /* CONFIG_MACSEC */
1595 enum drv_br_port_attr
{
1596 DRV_BR_PORT_ATTR_PROXYARP
,
1597 DRV_BR_PORT_ATTR_HAIRPIN_MODE
,
1600 enum drv_br_net_param
{
1601 DRV_BR_NET_PARAM_GARP_ACCEPT
,
1602 DRV_BR_MULTICAST_SNOOPING
,
1605 struct drv_acs_params
{
1606 /* Selected mode (HOSTAPD_MODE_*) */
1607 enum hostapd_hw_mode hw_mode
;
1609 /* Indicates whether HT is enabled */
1612 /* Indicates whether HT40 is enabled */
1615 /* Indicates whether VHT is enabled */
1618 /* Configured ACS channel width */
1621 /* ACS channel list info */
1622 unsigned int ch_list_len
;
1624 const int *freq_list
;
1629 * struct wpa_driver_ops - Driver interface API definition
1631 * This structure defines the API that each driver interface needs to implement
1632 * for core wpa_supplicant code. All driver specific functionality is captured
1635 struct wpa_driver_ops
{
1636 /** Name of the driver interface */
1638 /** One line description of the driver interface */
1642 * get_bssid - Get the current BSSID
1643 * @priv: private driver interface data
1644 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1646 * Returns: 0 on success, -1 on failure
1648 * Query kernel driver for the current BSSID and copy it to bssid.
1649 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1652 int (*get_bssid
)(void *priv
, u8
*bssid
);
1655 * get_ssid - Get the current SSID
1656 * @priv: private driver interface data
1657 * @ssid: buffer for SSID (at least 32 bytes)
1659 * Returns: Length of the SSID on success, -1 on failure
1661 * Query kernel driver for the current SSID and copy it to ssid.
1662 * Returning zero is recommended if the STA is not associated.
1664 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1665 * can, at least in theory, contain control characters (including nul)
1666 * and as such, should be processed as binary data, not a printable
1669 int (*get_ssid
)(void *priv
, u8
*ssid
);
1672 * set_key - Configure encryption key
1673 * @ifname: Interface name (for multi-SSID/VLAN support)
1674 * @priv: private driver interface data
1675 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1676 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1677 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1678 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1679 * %WPA_ALG_BIP_CMAC_256);
1680 * %WPA_ALG_NONE clears the key.
1681 * @addr: Address of the peer STA (BSSID of the current AP when setting
1682 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1683 * broadcast keys, %NULL for default keys that are used both for
1684 * broadcast and unicast; when clearing keys, %NULL is used to
1685 * indicate that both the broadcast-only and default key of the
1686 * specified key index is to be cleared
1687 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1689 * @set_tx: configure this key as the default Tx key (only used when
1690 * driver does not support separate unicast/individual key
1691 * @seq: sequence number/packet number, seq_len octets, the next
1692 * packet number to be used for in replay protection; configured
1693 * for Rx keys (in most cases, this is only used with broadcast
1694 * keys and set to zero for unicast keys); %NULL if not set
1695 * @seq_len: length of the seq, depends on the algorithm:
1696 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1697 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1699 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1700 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1702 * Returns: 0 on success, -1 on failure
1704 * Configure the given key for the kernel driver. If the driver
1705 * supports separate individual keys (4 default keys + 1 individual),
1706 * addr can be used to determine whether the key is default or
1707 * individual. If only 4 keys are supported, the default key with key
1708 * index 0 is used as the individual key. STA must be configured to use
1709 * it as the default Tx key (set_tx is set) and accept Rx for all the
1710 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1711 * broadcast keys, so key index 0 is available for this kind of
1714 * Please note that TKIP keys include separate TX and RX MIC keys and
1715 * some drivers may expect them in different order than wpa_supplicant
1716 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1717 * will trigger Michael MIC errors. This can be fixed by changing the
1718 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1719 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1720 * example on how this can be done.
1722 int (*set_key
)(const char *ifname
, void *priv
, enum wpa_alg alg
,
1723 const u8
*addr
, int key_idx
, int set_tx
,
1724 const u8
*seq
, size_t seq_len
,
1725 const u8
*key
, size_t key_len
);
1728 * init - Initialize driver interface
1729 * @ctx: context to be used when calling wpa_supplicant functions,
1730 * e.g., wpa_supplicant_event()
1731 * @ifname: interface name, e.g., wlan0
1733 * Returns: Pointer to private data, %NULL on failure
1735 * Initialize driver interface, including event processing for kernel
1736 * driver events (e.g., associated, scan results, Michael MIC failure).
1737 * This function can allocate a private configuration data area for
1738 * @ctx, file descriptor, interface name, etc. information that may be
1739 * needed in future driver operations. If this is not used, non-NULL
1740 * value will need to be returned because %NULL is used to indicate
1741 * failure. The returned value will be used as 'void *priv' data for
1742 * all other driver_ops functions.
1744 * The main event loop (eloop.c) of wpa_supplicant can be used to
1745 * register callback for read sockets (eloop_register_read_sock()).
1747 * See below for more information about events and
1748 * wpa_supplicant_event() function.
1750 void * (*init
)(void *ctx
, const char *ifname
);
1753 * deinit - Deinitialize driver interface
1754 * @priv: private driver interface data from init()
1756 * Shut down driver interface and processing of driver events. Free
1757 * private data buffer if one was allocated in init() handler.
1759 void (*deinit
)(void *priv
);
1762 * set_param - Set driver configuration parameters
1763 * @priv: private driver interface data from init()
1764 * @param: driver specific configuration parameters
1766 * Returns: 0 on success, -1 on failure
1768 * Optional handler for notifying driver interface about configuration
1769 * parameters (driver_param).
1771 int (*set_param
)(void *priv
, const char *param
);
1774 * set_countermeasures - Enable/disable TKIP countermeasures
1775 * @priv: private driver interface data
1776 * @enabled: 1 = countermeasures enabled, 0 = disabled
1778 * Returns: 0 on success, -1 on failure
1780 * Configure TKIP countermeasures. When these are enabled, the driver
1781 * should drop all received and queued frames that are using TKIP.
1783 int (*set_countermeasures
)(void *priv
, int enabled
);
1786 * deauthenticate - Request driver to deauthenticate
1787 * @priv: private driver interface data
1788 * @addr: peer address (BSSID of the AP)
1789 * @reason_code: 16-bit reason code to be sent in the deauthentication
1792 * Returns: 0 on success, -1 on failure
1794 int (*deauthenticate
)(void *priv
, const u8
*addr
, int reason_code
);
1797 * associate - Request driver to associate
1798 * @priv: private driver interface data
1799 * @params: association parameters
1801 * Returns: 0 on success, -1 on failure
1803 int (*associate
)(void *priv
,
1804 struct wpa_driver_associate_params
*params
);
1807 * add_pmkid - Add PMKSA cache entry to the driver
1808 * @priv: private driver interface data
1809 * @bssid: BSSID for the PMKSA cache entry
1810 * @pmkid: PMKID for the PMKSA cache entry
1812 * Returns: 0 on success, -1 on failure
1814 * This function is called when a new PMK is received, as a result of
1815 * either normal authentication or RSN pre-authentication.
1817 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1818 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1819 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1820 * driver_ops function does not need to be implemented. Likewise, if
1821 * the driver does not support WPA, this function is not needed.
1823 int (*add_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
1826 * remove_pmkid - Remove PMKSA cache entry to the driver
1827 * @priv: private driver interface data
1828 * @bssid: BSSID for the PMKSA cache entry
1829 * @pmkid: PMKID for the PMKSA cache entry
1831 * Returns: 0 on success, -1 on failure
1833 * This function is called when the supplicant drops a PMKSA cache
1834 * entry for any reason.
1836 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1837 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1838 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1839 * from wpa_supplicant, this driver_ops function does not need to be
1840 * implemented. Likewise, if the driver does not support WPA, this
1841 * function is not needed.
1843 int (*remove_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
1846 * flush_pmkid - Flush PMKSA cache
1847 * @priv: private driver interface data
1849 * Returns: 0 on success, -1 on failure
1851 * This function is called when the supplicant drops all PMKSA cache
1852 * entries for any reason.
1854 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1855 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1856 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1857 * from wpa_supplicant, this driver_ops function does not need to be
1858 * implemented. Likewise, if the driver does not support WPA, this
1859 * function is not needed.
1861 int (*flush_pmkid
)(void *priv
);
1864 * get_capa - Get driver capabilities
1865 * @priv: private driver interface data
1867 * Returns: 0 on success, -1 on failure
1869 * Get driver/firmware/hardware capabilities.
1871 int (*get_capa
)(void *priv
, struct wpa_driver_capa
*capa
);
1874 * poll - Poll driver for association information
1875 * @priv: private driver interface data
1877 * This is an option callback that can be used when the driver does not
1878 * provide event mechanism for association events. This is called when
1879 * receiving WPA EAPOL-Key messages that require association
1880 * information. The driver interface is supposed to generate associnfo
1881 * event before returning from this callback function. In addition, the
1882 * driver interface should generate an association event after having
1883 * sent out associnfo.
1885 void (*poll
)(void *priv
);
1888 * get_ifname - Get interface name
1889 * @priv: private driver interface data
1891 * Returns: Pointer to the interface name. This can differ from the
1892 * interface name used in init() call. Init() is called first.
1894 * This optional function can be used to allow the driver interface to
1895 * replace the interface name with something else, e.g., based on an
1896 * interface mapping from a more descriptive name.
1898 const char * (*get_ifname
)(void *priv
);
1901 * get_mac_addr - Get own MAC address
1902 * @priv: private driver interface data
1904 * Returns: Pointer to own MAC address or %NULL on failure
1906 * This optional function can be used to get the own MAC address of the
1907 * device from the driver interface code. This is only needed if the
1908 * l2_packet implementation for the OS does not provide easy access to
1910 const u8
* (*get_mac_addr
)(void *priv
);
1913 * set_operstate - Sets device operating state to DORMANT or UP
1914 * @priv: private driver interface data
1915 * @state: 0 = dormant, 1 = up
1916 * Returns: 0 on success, -1 on failure
1918 * This is an optional function that can be used on operating systems
1919 * that support a concept of controlling network device state from user
1920 * space applications. This function, if set, gets called with
1921 * state = 1 when authentication has been completed and with state = 0
1922 * when connection is lost.
1924 int (*set_operstate
)(void *priv
, int state
);
1927 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1928 * @priv: Private driver interface data
1929 * @addr: Address of the station for which to set protection (may be
1930 * %NULL for group keys)
1931 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1932 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1933 * Returns: 0 on success, -1 on failure
1935 * This is an optional function that can be used to set the driver to
1936 * require protection for Tx and/or Rx frames. This uses the layer
1937 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1938 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1939 * set protection operation; instead, they set protection implicitly
1940 * based on configured keys.
1942 int (*mlme_setprotection
)(void *priv
, const u8
*addr
, int protect_type
,
1946 * get_hw_feature_data - Get hardware support data (channels and rates)
1947 * @priv: Private driver interface data
1948 * @num_modes: Variable for returning the number of returned modes
1949 * flags: Variable for returning hardware feature flags
1950 * Returns: Pointer to allocated hardware data on success or %NULL on
1951 * failure. Caller is responsible for freeing this.
1953 struct hostapd_hw_modes
* (*get_hw_feature_data
)(void *priv
,
1958 * send_mlme - Send management frame from MLME
1959 * @priv: Private driver interface data
1960 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1961 * @data_len: Size of the management frame
1962 * @noack: Do not wait for this frame to be acked (disable retries)
1963 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
1965 * Returns: 0 on success, -1 on failure
1967 int (*send_mlme
)(void *priv
, const u8
*data
, size_t data_len
,
1968 int noack
, unsigned int freq
);
1971 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1972 * @priv: Private driver interface data
1973 * @md: Mobility domain (2 octets) (also included inside ies)
1974 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1975 * @ies_len: Length of FT IEs in bytes
1976 * Returns: 0 on success, -1 on failure
1978 * The supplicant uses this callback to let the driver know that keying
1979 * material for FT is available and that the driver can use the
1980 * provided IEs in the next message in FT authentication sequence.
1982 * This function is only needed for driver that support IEEE 802.11r
1983 * (Fast BSS Transition).
1985 int (*update_ft_ies
)(void *priv
, const u8
*md
, const u8
*ies
,
1989 * get_scan_results2 - Fetch the latest scan results
1990 * @priv: private driver interface data
1992 * Returns: Allocated buffer of scan results (caller is responsible for
1993 * freeing the data structure) on success, NULL on failure
1995 struct wpa_scan_results
* (*get_scan_results2
)(void *priv
);
1998 * set_country - Set country
1999 * @priv: Private driver interface data
2000 * @alpha2: country to which to switch to
2001 * Returns: 0 on success, -1 on failure
2003 * This function is for drivers which support some form
2004 * of setting a regulatory domain.
2006 int (*set_country
)(void *priv
, const char *alpha2
);
2009 * get_country - Get country
2010 * @priv: Private driver interface data
2011 * @alpha2: Buffer for returning country code (at least 3 octets)
2012 * Returns: 0 on success, -1 on failure
2014 int (*get_country
)(void *priv
, char *alpha2
);
2017 * global_init - Global driver initialization
2018 * Returns: Pointer to private data (global), %NULL on failure
2020 * This optional function is called to initialize the driver wrapper
2021 * for global data, i.e., data that applies to all interfaces. If this
2022 * function is implemented, global_deinit() will also need to be
2023 * implemented to free the private data. The driver will also likely
2024 * use init2() function instead of init() to get the pointer to global
2025 * data available to per-interface initializer.
2027 void * (*global_init
)(void);
2030 * global_deinit - Global driver deinitialization
2031 * @priv: private driver global data from global_init()
2033 * Terminate any global driver related functionality and free the
2034 * global data structure.
2036 void (*global_deinit
)(void *priv
);
2039 * init2 - Initialize driver interface (with global data)
2040 * @ctx: context to be used when calling wpa_supplicant functions,
2041 * e.g., wpa_supplicant_event()
2042 * @ifname: interface name, e.g., wlan0
2043 * @global_priv: private driver global data from global_init()
2044 * Returns: Pointer to private data, %NULL on failure
2046 * This function can be used instead of init() if the driver wrapper
2049 void * (*init2
)(void *ctx
, const char *ifname
, void *global_priv
);
2052 * get_interfaces - Get information about available interfaces
2053 * @global_priv: private driver global data from global_init()
2054 * Returns: Allocated buffer of interface information (caller is
2055 * responsible for freeing the data structure) on success, NULL on
2058 struct wpa_interface_info
* (*get_interfaces
)(void *global_priv
);
2061 * scan2 - Request the driver to initiate scan
2062 * @priv: private driver interface data
2063 * @params: Scan parameters
2065 * Returns: 0 on success, -1 on failure
2067 * Once the scan results are ready, the driver should report scan
2068 * results event for wpa_supplicant which will eventually request the
2069 * results with wpa_driver_get_scan_results2().
2071 int (*scan2
)(void *priv
, struct wpa_driver_scan_params
*params
);
2074 * authenticate - Request driver to authenticate
2075 * @priv: private driver interface data
2076 * @params: authentication parameters
2077 * Returns: 0 on success, -1 on failure
2079 * This is an optional function that can be used with drivers that
2080 * support separate authentication and association steps, i.e., when
2081 * wpa_supplicant can act as the SME. If not implemented, associate()
2082 * function is expected to take care of IEEE 802.11 authentication,
2085 int (*authenticate
)(void *priv
,
2086 struct wpa_driver_auth_params
*params
);
2089 * set_ap - Set Beacon and Probe Response information for AP mode
2090 * @priv: Private driver interface data
2091 * @params: Parameters to use in AP mode
2093 * This function is used to configure Beacon template and/or extra IEs
2094 * to add for Beacon and Probe Response frames for the driver in
2095 * AP mode. The driver is responsible for building the full Beacon
2096 * frame by concatenating the head part with TIM IE generated by the
2097 * driver/firmware and finishing with the tail part. Depending on the
2098 * driver architectue, this can be done either by using the full
2099 * template or the set of additional IEs (e.g., WPS and P2P IE).
2100 * Similarly, Probe Response processing depends on the driver design.
2101 * If the driver (or firmware) takes care of replying to Probe Request
2102 * frames, the extra IEs provided here needs to be added to the Probe
2105 * Returns: 0 on success, -1 on failure
2107 int (*set_ap
)(void *priv
, struct wpa_driver_ap_params
*params
);
2110 * set_acl - Set ACL in AP mode
2111 * @priv: Private driver interface data
2112 * @params: Parameters to configure ACL
2113 * Returns: 0 on success, -1 on failure
2115 * This is used only for the drivers which support MAC address ACL.
2117 int (*set_acl
)(void *priv
, struct hostapd_acl_params
*params
);
2120 * hapd_init - Initialize driver interface (hostapd only)
2121 * @hapd: Pointer to hostapd context
2122 * @params: Configuration for the driver wrapper
2123 * Returns: Pointer to private data, %NULL on failure
2125 * This function is used instead of init() or init2() when the driver
2126 * wrapper is used with hostapd.
2128 void * (*hapd_init
)(struct hostapd_data
*hapd
,
2129 struct wpa_init_params
*params
);
2132 * hapd_deinit - Deinitialize driver interface (hostapd only)
2133 * @priv: Private driver interface data from hapd_init()
2135 void (*hapd_deinit
)(void *priv
);
2138 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2139 * @priv: Private driver interface data
2140 * @params: BSS parameters
2141 * Returns: 0 on success, -1 on failure
2143 * This is an optional function to configure the kernel driver to
2144 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2145 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2146 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2147 * for Beacon frames.
2149 * DEPRECATED - use set_ap() instead
2151 int (*set_ieee8021x
)(void *priv
, struct wpa_bss_params
*params
);
2154 * set_privacy - Enable/disable privacy (AP only)
2155 * @priv: Private driver interface data
2156 * @enabled: 1 = privacy enabled, 0 = disabled
2157 * Returns: 0 on success, -1 on failure
2159 * This is an optional function to configure privacy field in the
2160 * kernel driver for Beacon frames. This can be left undefined (set to
2161 * %NULL) if the driver uses the Beacon template from set_ap().
2163 * DEPRECATED - use set_ap() instead
2165 int (*set_privacy
)(void *priv
, int enabled
);
2168 * get_seqnum - Fetch the current TSC/packet number (AP only)
2169 * @ifname: The interface name (main or virtual)
2170 * @priv: Private driver interface data
2171 * @addr: MAC address of the station or %NULL for group keys
2173 * @seq: Buffer for returning the latest used TSC/packet number
2174 * Returns: 0 on success, -1 on failure
2176 * This function is used to fetch the last used TSC/packet number for
2177 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2178 * keys, so there is no strict requirement on implementing support for
2179 * unicast keys (i.e., addr != %NULL).
2181 int (*get_seqnum
)(const char *ifname
, void *priv
, const u8
*addr
,
2185 * flush - Flush all association stations (AP only)
2186 * @priv: Private driver interface data
2187 * Returns: 0 on success, -1 on failure
2189 * This function requests the driver to disassociate all associated
2190 * stations. This function does not need to be implemented if the
2191 * driver does not process association frames internally.
2193 int (*flush
)(void *priv
);
2196 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2197 * @priv: Private driver interface data
2198 * @elem: Information elements
2199 * @elem_len: Length of the elem buffer in octets
2200 * Returns: 0 on success, -1 on failure
2202 * This is an optional function to add information elements in the
2203 * kernel driver for Beacon and Probe Response frames. This can be left
2204 * undefined (set to %NULL) if the driver uses the Beacon template from
2207 * DEPRECATED - use set_ap() instead
2209 int (*set_generic_elem
)(void *priv
, const u8
*elem
, size_t elem_len
);
2212 * read_sta_data - Fetch station data
2213 * @priv: Private driver interface data
2214 * @data: Buffer for returning station information
2215 * @addr: MAC address of the station
2216 * Returns: 0 on success, -1 on failure
2218 int (*read_sta_data
)(void *priv
, struct hostap_sta_driver_data
*data
,
2222 * hapd_send_eapol - Send an EAPOL packet (AP only)
2223 * @priv: private driver interface data
2224 * @addr: Destination MAC address
2225 * @data: EAPOL packet starting with IEEE 802.1X header
2226 * @data_len: Length of the EAPOL packet in octets
2227 * @encrypt: Whether the frame should be encrypted
2228 * @own_addr: Source MAC address
2229 * @flags: WPA_STA_* flags for the destination station
2231 * Returns: 0 on success, -1 on failure
2233 int (*hapd_send_eapol
)(void *priv
, const u8
*addr
, const u8
*data
,
2234 size_t data_len
, int encrypt
,
2235 const u8
*own_addr
, u32 flags
);
2238 * sta_deauth - Deauthenticate a station (AP only)
2239 * @priv: Private driver interface data
2240 * @own_addr: Source address and BSSID for the Deauthentication frame
2241 * @addr: MAC address of the station to deauthenticate
2242 * @reason: Reason code for the Deauthentiation frame
2243 * Returns: 0 on success, -1 on failure
2245 * This function requests a specific station to be deauthenticated and
2246 * a Deauthentication frame to be sent to it.
2248 int (*sta_deauth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2252 * sta_disassoc - Disassociate a station (AP only)
2253 * @priv: Private driver interface data
2254 * @own_addr: Source address and BSSID for the Disassociation frame
2255 * @addr: MAC address of the station to disassociate
2256 * @reason: Reason code for the Disassociation frame
2257 * Returns: 0 on success, -1 on failure
2259 * This function requests a specific station to be disassociated and
2260 * a Disassociation frame to be sent to it.
2262 int (*sta_disassoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2266 * sta_remove - Remove a station entry (AP only)
2267 * @priv: Private driver interface data
2268 * @addr: MAC address of the station to be removed
2269 * Returns: 0 on success, -1 on failure
2271 int (*sta_remove
)(void *priv
, const u8
*addr
);
2274 * hapd_get_ssid - Get the current SSID (AP only)
2275 * @priv: Private driver interface data
2276 * @buf: Buffer for returning the SSID
2277 * @len: Maximum length of the buffer
2278 * Returns: Length of the SSID on success, -1 on failure
2280 * This function need not be implemented if the driver uses Beacon
2281 * template from set_ap() and does not reply to Probe Request frames.
2283 int (*hapd_get_ssid
)(void *priv
, u8
*buf
, int len
);
2286 * hapd_set_ssid - Set SSID (AP only)
2287 * @priv: Private driver interface data
2289 * @len: Length of the SSID in octets
2290 * Returns: 0 on success, -1 on failure
2292 * DEPRECATED - use set_ap() instead
2294 int (*hapd_set_ssid
)(void *priv
, const u8
*buf
, int len
);
2297 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2298 * @priv: Private driver interface data
2299 * @enabled: 1 = countermeasures enabled, 0 = disabled
2300 * Returns: 0 on success, -1 on failure
2302 * This need not be implemented if the driver does not take care of
2303 * association processing.
2305 int (*hapd_set_countermeasures
)(void *priv
, int enabled
);
2308 * sta_add - Add a station entry
2309 * @priv: Private driver interface data
2310 * @params: Station parameters
2311 * Returns: 0 on success, -1 on failure
2313 * This function is used to add a station entry to the driver once the
2314 * station has completed association. This is only used if the driver
2315 * does not take care of association processing.
2317 * With TDLS, this function is also used to add or set (params->set 1)
2318 * TDLS peer entries.
2320 int (*sta_add
)(void *priv
, struct hostapd_sta_add_params
*params
);
2323 * get_inact_sec - Get station inactivity duration (AP only)
2324 * @priv: Private driver interface data
2325 * @addr: Station address
2326 * Returns: Number of seconds station has been inactive, -1 on failure
2328 int (*get_inact_sec
)(void *priv
, const u8
*addr
);
2331 * sta_clear_stats - Clear station statistics (AP only)
2332 * @priv: Private driver interface data
2333 * @addr: Station address
2334 * Returns: 0 on success, -1 on failure
2336 int (*sta_clear_stats
)(void *priv
, const u8
*addr
);
2339 * set_freq - Set channel/frequency (AP only)
2340 * @priv: Private driver interface data
2341 * @freq: Channel parameters
2342 * Returns: 0 on success, -1 on failure
2344 int (*set_freq
)(void *priv
, struct hostapd_freq_params
*freq
);
2347 * set_rts - Set RTS threshold
2348 * @priv: Private driver interface data
2349 * @rts: RTS threshold in octets
2350 * Returns: 0 on success, -1 on failure
2352 int (*set_rts
)(void *priv
, int rts
);
2355 * set_frag - Set fragmentation threshold
2356 * @priv: Private driver interface data
2357 * @frag: Fragmentation threshold in octets
2358 * Returns: 0 on success, -1 on failure
2360 int (*set_frag
)(void *priv
, int frag
);
2363 * sta_set_flags - Set station flags (AP only)
2364 * @priv: Private driver interface data
2365 * @addr: Station address
2366 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2367 * @flags_or: Bitmap of WPA_STA_* flags to add
2368 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2369 * Returns: 0 on success, -1 on failure
2371 int (*sta_set_flags
)(void *priv
, const u8
*addr
,
2372 unsigned int total_flags
, unsigned int flags_or
,
2373 unsigned int flags_and
);
2376 * set_tx_queue_params - Set TX queue parameters
2377 * @priv: Private driver interface data
2378 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2382 * @burst_time: Maximum length for bursting in 0.1 msec units
2384 int (*set_tx_queue_params
)(void *priv
, int queue
, int aifs
, int cw_min
,
2385 int cw_max
, int burst_time
);
2388 * if_add - Add a virtual interface
2389 * @priv: Private driver interface data
2390 * @type: Interface type
2391 * @ifname: Interface name for the new virtual interface
2392 * @addr: Local address to use for the interface or %NULL to use the
2393 * parent interface address
2394 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2395 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2396 * not allowed (applies only to %WPA_IF_AP_BSS type)
2397 * @force_ifname: Buffer for returning an interface name that the
2398 * driver ended up using if it differs from the requested ifname
2399 * @if_addr: Buffer for returning the allocated interface address
2400 * (this may differ from the requested addr if the driver cannot
2401 * change interface address)
2402 * @bridge: Bridge interface to use or %NULL if no bridge configured
2403 * @use_existing: Whether to allow existing interface to be used
2404 * Returns: 0 on success, -1 on failure
2406 int (*if_add
)(void *priv
, enum wpa_driver_if_type type
,
2407 const char *ifname
, const u8
*addr
, void *bss_ctx
,
2408 void **drv_priv
, char *force_ifname
, u8
*if_addr
,
2409 const char *bridge
, int use_existing
);
2412 * if_remove - Remove a virtual interface
2413 * @priv: Private driver interface data
2414 * @type: Interface type
2415 * @ifname: Interface name of the virtual interface to be removed
2416 * Returns: 0 on success, -1 on failure
2418 int (*if_remove
)(void *priv
, enum wpa_driver_if_type type
,
2419 const char *ifname
);
2422 * set_sta_vlan - Bind a station into a specific interface (AP only)
2423 * @priv: Private driver interface data
2424 * @ifname: Interface (main or virtual BSS or VLAN)
2425 * @addr: MAC address of the associated station
2427 * Returns: 0 on success, -1 on failure
2429 * This function is used to bind a station to a specific virtual
2430 * interface. It is only used if when virtual interfaces are supported,
2431 * e.g., to assign stations to different VLAN interfaces based on
2432 * information from a RADIUS server. This allows separate broadcast
2433 * domains to be used with a single BSS.
2435 int (*set_sta_vlan
)(void *priv
, const u8
*addr
, const char *ifname
,
2439 * commit - Optional commit changes handler (AP only)
2440 * @priv: driver private data
2441 * Returns: 0 on success, -1 on failure
2443 * This optional handler function can be registered if the driver
2444 * interface implementation needs to commit changes (e.g., by setting
2445 * network interface up) at the end of initial configuration. If set,
2446 * this handler will be called after initial setup has been completed.
2448 int (*commit
)(void *priv
);
2451 * send_ether - Send an ethernet packet (AP only)
2452 * @priv: private driver interface data
2453 * @dst: Destination MAC address
2454 * @src: Source MAC address
2456 * @data: EAPOL packet starting with IEEE 802.1X header
2457 * @data_len: Length of the EAPOL packet in octets
2458 * Returns: 0 on success, -1 on failure
2460 int (*send_ether
)(void *priv
, const u8
*dst
, const u8
*src
, u16 proto
,
2461 const u8
*data
, size_t data_len
);
2464 * set_radius_acl_auth - Notification of RADIUS ACL change
2465 * @priv: Private driver interface data
2466 * @mac: MAC address of the station
2467 * @accepted: Whether the station was accepted
2468 * @session_timeout: Session timeout for the station
2469 * Returns: 0 on success, -1 on failure
2471 int (*set_radius_acl_auth
)(void *priv
, const u8
*mac
, int accepted
,
2472 u32 session_timeout
);
2475 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2476 * @priv: Private driver interface data
2477 * @mac: MAC address of the station
2478 * Returns: 0 on success, -1 on failure
2480 int (*set_radius_acl_expire
)(void *priv
, const u8
*mac
);
2483 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2484 * @priv: Private driver interface data
2485 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2486 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2488 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2489 * to remove extra IE(s)
2490 * Returns: 0 on success, -1 on failure
2492 * This is an optional function to add WPS IE in the kernel driver for
2493 * Beacon and Probe Response frames. This can be left undefined (set
2494 * to %NULL) if the driver uses the Beacon template from set_ap()
2495 * and does not process Probe Request frames. If the driver takes care
2496 * of (Re)Association frame processing, the assocresp buffer includes
2497 * WPS IE(s) that need to be added to (Re)Association Response frames
2498 * whenever a (Re)Association Request frame indicated use of WPS.
2500 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2501 * frames when operating as a GO. The driver is responsible for adding
2502 * timing related attributes (e.g., NoA) in addition to the IEs
2503 * included here by appending them after these buffers. This call is
2504 * also used to provide Probe Response IEs for P2P Listen state
2505 * operations for drivers that generate the Probe Response frames
2508 * DEPRECATED - use set_ap() instead
2510 int (*set_ap_wps_ie
)(void *priv
, const struct wpabuf
*beacon
,
2511 const struct wpabuf
*proberesp
,
2512 const struct wpabuf
*assocresp
);
2515 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2516 * @priv: Private driver interface data
2517 * @authorized: Whether the port is authorized
2518 * Returns: 0 on success, -1 on failure
2520 int (*set_supp_port
)(void *priv
, int authorized
);
2523 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2524 * @priv: Private driver interface data
2525 * @addr: MAC address of the associated station
2526 * @aid: Association ID
2527 * @val: 1 = bind to 4-address WDS; 0 = unbind
2528 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2529 * to indicate that bridge is not to be used
2530 * @ifname_wds: Buffer to return the interface name for the new WDS
2531 * station or %NULL to indicate name is not returned.
2532 * Returns: 0 on success, -1 on failure
2534 int (*set_wds_sta
)(void *priv
, const u8
*addr
, int aid
, int val
,
2535 const char *bridge_ifname
, char *ifname_wds
);
2538 * send_action - Transmit an Action frame
2539 * @priv: Private driver interface data
2540 * @freq: Frequency (in MHz) of the channel
2541 * @wait: Time to wait off-channel for a response (in ms), or zero
2542 * @dst: Destination MAC address (Address 1)
2543 * @src: Source MAC address (Address 2)
2544 * @bssid: BSSID (Address 3)
2546 * @data_len: data length in octets
2547 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2548 * Returns: 0 on success, -1 on failure
2550 * This command can be used to request the driver to transmit an action
2551 * frame to the specified destination.
2553 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2554 * be transmitted on the given channel and the device will wait for a
2555 * response on that channel for the given wait time.
2557 * If the flag is not set, the wait time will be ignored. In this case,
2558 * if a remain-on-channel duration is in progress, the frame must be
2559 * transmitted on that channel; alternatively the frame may be sent on
2560 * the current operational channel (if in associated state in station
2561 * mode or while operating as an AP.)
2563 int (*send_action
)(void *priv
, unsigned int freq
, unsigned int wait
,
2564 const u8
*dst
, const u8
*src
, const u8
*bssid
,
2565 const u8
*data
, size_t data_len
, int no_cck
);
2568 * send_action_cancel_wait - Cancel action frame TX wait
2569 * @priv: Private driver interface data
2571 * This command cancels the wait time associated with sending an action
2572 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2573 * set in the driver flags.
2575 void (*send_action_cancel_wait
)(void *priv
);
2578 * remain_on_channel - Remain awake on a channel
2579 * @priv: Private driver interface data
2580 * @freq: Frequency (in MHz) of the channel
2581 * @duration: Duration in milliseconds
2582 * Returns: 0 on success, -1 on failure
2584 * This command is used to request the driver to remain awake on the
2585 * specified channel for the specified duration and report received
2586 * Action frames with EVENT_RX_MGMT events. Optionally, received
2587 * Probe Request frames may also be requested to be reported by calling
2588 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2590 * The driver may not be at the requested channel when this function
2591 * returns, i.e., the return code is only indicating whether the
2592 * request was accepted. The caller will need to wait until the
2593 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2594 * completed the channel change. This may take some time due to other
2595 * need for the radio and the caller should be prepared to timing out
2596 * its wait since there are no guarantees on when this request can be
2599 int (*remain_on_channel
)(void *priv
, unsigned int freq
,
2600 unsigned int duration
);
2603 * cancel_remain_on_channel - Cancel remain-on-channel operation
2604 * @priv: Private driver interface data
2606 * This command can be used to cancel a remain-on-channel operation
2607 * before its originally requested duration has passed. This could be
2608 * used, e.g., when remain_on_channel() is used to request extra time
2609 * to receive a response to an Action frame and the response is
2610 * received when there is still unneeded time remaining on the
2611 * remain-on-channel operation.
2613 int (*cancel_remain_on_channel
)(void *priv
);
2616 * probe_req_report - Request Probe Request frames to be indicated
2617 * @priv: Private driver interface data
2618 * @report: Whether to report received Probe Request frames
2619 * Returns: 0 on success, -1 on failure (or if not supported)
2621 * This command can be used to request the driver to indicate when
2622 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2623 * Since this operation may require extra resources, e.g., due to less
2624 * optimal hardware/firmware RX filtering, many drivers may disable
2625 * Probe Request reporting at least in station mode. This command is
2626 * used to notify the driver when the Probe Request frames need to be
2627 * reported, e.g., during remain-on-channel operations.
2629 int (*probe_req_report
)(void *priv
, int report
);
2632 * deinit_ap - Deinitialize AP mode
2633 * @priv: Private driver interface data
2634 * Returns: 0 on success, -1 on failure (or if not supported)
2636 * This optional function can be used to disable AP mode related
2637 * configuration. If the interface was not dynamically added,
2638 * change the driver mode to station mode to allow normal station
2639 * operations like scanning to be completed.
2641 int (*deinit_ap
)(void *priv
);
2644 * deinit_p2p_cli - Deinitialize P2P client mode
2645 * @priv: Private driver interface data
2646 * Returns: 0 on success, -1 on failure (or if not supported)
2648 * This optional function can be used to disable P2P client mode. If the
2649 * interface was not dynamically added, change the interface type back
2652 int (*deinit_p2p_cli
)(void *priv
);
2655 * suspend - Notification on system suspend/hibernate event
2656 * @priv: Private driver interface data
2658 void (*suspend
)(void *priv
);
2661 * resume - Notification on system resume/thaw event
2662 * @priv: Private driver interface data
2664 void (*resume
)(void *priv
);
2667 * signal_monitor - Set signal monitoring parameters
2668 * @priv: Private driver interface data
2669 * @threshold: Threshold value for signal change events; 0 = disabled
2670 * @hysteresis: Minimum change in signal strength before indicating a
2672 * Returns: 0 on success, -1 on failure (or if not supported)
2674 * This function can be used to configure monitoring of signal strength
2675 * with the current AP. Whenever signal strength drops below the
2676 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2677 * should be generated assuming the signal strength has changed at
2678 * least %hysteresis from the previously indicated signal change event.
2680 int (*signal_monitor
)(void *priv
, int threshold
, int hysteresis
);
2683 * send_frame - Send IEEE 802.11 frame (testing use only)
2684 * @priv: Private driver interface data
2685 * @data: IEEE 802.11 frame with IEEE 802.11 header
2686 * @data_len: Size of the frame
2687 * @encrypt: Whether to encrypt the frame (if keys are set)
2688 * Returns: 0 on success, -1 on failure
2690 * This function is only used for debugging purposes and is not
2691 * required to be implemented for normal operations.
2693 int (*send_frame
)(void *priv
, const u8
*data
, size_t data_len
,
2697 * get_noa - Get current Notice of Absence attribute payload
2698 * @priv: Private driver interface data
2699 * @buf: Buffer for returning NoA
2700 * @buf_len: Buffer length in octets
2701 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2702 * advertized, or -1 on failure
2704 * This function is used to fetch the current Notice of Absence
2705 * attribute value from GO.
2707 int (*get_noa
)(void *priv
, u8
*buf
, size_t buf_len
);
2710 * set_noa - Set Notice of Absence parameters for GO (testing)
2711 * @priv: Private driver interface data
2713 * @start: Start time in ms from next TBTT
2714 * @duration: Duration in ms
2715 * Returns: 0 on success or -1 on failure
2717 * This function is used to set Notice of Absence parameters for GO. It
2718 * is used only for testing. To disable NoA, all parameters are set to
2721 int (*set_noa
)(void *priv
, u8 count
, int start
, int duration
);
2724 * set_p2p_powersave - Set P2P power save options
2725 * @priv: Private driver interface data
2726 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2727 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2728 * @ctwindow: 0.. = change (msec), -1 = no change
2729 * Returns: 0 on success or -1 on failure
2731 int (*set_p2p_powersave
)(void *priv
, int legacy_ps
, int opp_ps
,
2735 * ampdu - Enable/disable aggregation
2736 * @priv: Private driver interface data
2737 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2738 * Returns: 0 on success or -1 on failure
2740 int (*ampdu
)(void *priv
, int ampdu
);
2743 * get_radio_name - Get physical radio name for the device
2744 * @priv: Private driver interface data
2745 * Returns: Radio name or %NULL if not known
2747 * The returned data must not be modified by the caller. It is assumed
2748 * that any interface that has the same radio name as another is
2749 * sharing the same physical radio. This information can be used to
2750 * share scan results etc. information between the virtual interfaces
2751 * to speed up various operations.
2753 const char * (*get_radio_name
)(void *priv
);
2756 * send_tdls_mgmt - for sending TDLS management packets
2757 * @priv: private driver interface data
2758 * @dst: Destination (peer) MAC address
2759 * @action_code: TDLS action code for the mssage
2760 * @dialog_token: Dialog Token to use in the message (if needed)
2761 * @status_code: Status Code or Reason Code to use (if needed)
2762 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2763 * @initiator: Is the current end the TDLS link initiator
2764 * @buf: TDLS IEs to add to the message
2765 * @len: Length of buf in octets
2766 * Returns: 0 on success, negative (<0) on failure
2768 * This optional function can be used to send packet to driver which is
2769 * responsible for receiving and sending all TDLS packets.
2771 int (*send_tdls_mgmt
)(void *priv
, const u8
*dst
, u8 action_code
,
2772 u8 dialog_token
, u16 status_code
, u32 peer_capab
,
2773 int initiator
, const u8
*buf
, size_t len
);
2776 * tdls_oper - Ask the driver to perform high-level TDLS operations
2777 * @priv: Private driver interface data
2778 * @oper: TDLS high-level operation. See %enum tdls_oper
2779 * @peer: Destination (peer) MAC address
2780 * Returns: 0 on success, negative (<0) on failure
2782 * This optional function can be used to send high-level TDLS commands
2785 int (*tdls_oper
)(void *priv
, enum tdls_oper oper
, const u8
*peer
);
2788 * wnm_oper - Notify driver of the WNM frame reception
2789 * @priv: Private driver interface data
2790 * @oper: WNM operation. See %enum wnm_oper
2791 * @peer: Destination (peer) MAC address
2792 * @buf: Buffer for the driver to fill in (for getting IE)
2793 * @buf_len: Return the len of buf
2794 * Returns: 0 on success, negative (<0) on failure
2796 int (*wnm_oper
)(void *priv
, enum wnm_oper oper
, const u8
*peer
,
2797 u8
*buf
, u16
*buf_len
);
2800 * set_qos_map - Set QoS Map
2801 * @priv: Private driver interface data
2802 * @qos_map_set: QoS Map
2803 * @qos_map_set_len: Length of QoS Map
2805 int (*set_qos_map
)(void *priv
, const u8
*qos_map_set
,
2806 u8 qos_map_set_len
);
2809 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2810 * @priv: Private driver interface data
2811 * @version: IP version of the IP address, 4 or 6
2812 * @ipaddr: IP address for the neigh entry
2813 * @prefixlen: IP address prefix length
2814 * @addr: Corresponding MAC address
2815 * Returns: 0 on success, negative (<0) on failure
2817 int (*br_add_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
,
2818 int prefixlen
, const u8
*addr
);
2821 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2822 * @priv: Private driver interface data
2823 * @version: IP version of the IP address, 4 or 6
2824 * @ipaddr: IP address for the neigh entry
2825 * Returns: 0 on success, negative (<0) on failure
2827 int (*br_delete_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
);
2830 * br_port_set_attr - Set a bridge port attribute
2831 * @attr: Bridge port attribute to set
2832 * @val: Value to be set
2833 * Returns: 0 on success, negative (<0) on failure
2835 int (*br_port_set_attr
)(void *priv
, enum drv_br_port_attr attr
,
2839 * br_port_set_attr - Set a bridge network parameter
2840 * @param: Bridge parameter to set
2841 * @val: Value to be set
2842 * Returns: 0 on success, negative (<0) on failure
2844 int (*br_set_net_param
)(void *priv
, enum drv_br_net_param param
,
2848 * set_wowlan - Set wake-on-wireless triggers
2849 * @priv: Private driver interface data
2850 * @triggers: wowlan triggers
2852 int (*set_wowlan
)(void *priv
, const struct wowlan_triggers
*triggers
);
2855 * signal_poll - Get current connection information
2856 * @priv: Private driver interface data
2857 * @signal_info: Connection info structure
2859 int (*signal_poll
)(void *priv
, struct wpa_signal_info
*signal_info
);
2862 * set_authmode - Set authentication algorithm(s) for static WEP
2863 * @priv: Private driver interface data
2864 * @authmode: 1=Open System, 2=Shared Key, 3=both
2865 * Returns: 0 on success, -1 on failure
2867 * This function can be used to set authentication algorithms for AP
2868 * mode when static WEP is used. If the driver uses user space MLME/SME
2869 * implementation, there is no need to implement this function.
2871 * DEPRECATED - use set_ap() instead
2873 int (*set_authmode
)(void *priv
, int authmode
);
2877 * driver_cmd - Execute driver-specific command
2878 * @priv: Private driver interface data
2879 * @cmd: Command to execute
2880 * @buf: Return buffer
2881 * @buf_len: Buffer length
2882 * Returns: 0 on success, -1 on failure
2884 int (*driver_cmd
)(void *priv
, char *cmd
, char *buf
, size_t buf_len
);
2885 #endif /* ANDROID */
2888 * vendor_cmd - Execute vendor specific command
2889 * @priv: Private driver interface data
2890 * @vendor_id: Vendor id
2891 * @subcmd: Vendor command id
2892 * @data: Vendor command parameters (%NULL if no parameters)
2893 * @data_len: Data length
2894 * @buf: Return buffer (%NULL to ignore reply)
2895 * Returns: 0 on success, negative (<0) on failure
2897 * This function handles vendor specific commands that are passed to
2898 * the driver/device. The command is identified by vendor id and
2899 * command id. Parameters can be passed as argument to the command
2900 * in the data buffer. Reply (if any) will be filled in the supplied
2903 * The exact driver behavior is driver interface and vendor specific. As
2904 * an example, this will be converted to a vendor specific cfg80211
2905 * command in case of the nl80211 driver interface.
2907 int (*vendor_cmd
)(void *priv
, unsigned int vendor_id
,
2908 unsigned int subcmd
, const u8
*data
, size_t data_len
,
2909 struct wpabuf
*buf
);
2912 * set_rekey_info - Set rekey information
2913 * @priv: Private driver interface data
2915 * @kek_len: KEK length in octets
2917 * @kck_len: KCK length in octets
2918 * @replay_ctr: Current EAPOL-Key Replay Counter
2920 * This optional function can be used to provide information for the
2921 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2922 * while the host (including wpa_supplicant) is sleeping.
2924 void (*set_rekey_info
)(void *priv
, const u8
*kek
, size_t kek_len
,
2925 const u8
*kck
, size_t kck_len
,
2926 const u8
*replay_ctr
);
2929 * sta_assoc - Station association indication
2930 * @priv: Private driver interface data
2931 * @own_addr: Source address and BSSID for association frame
2932 * @addr: MAC address of the station to associate
2933 * @reassoc: flag to indicate re-association
2934 * @status: association response status code
2935 * @ie: assoc response ie buffer
2936 * @len: ie buffer length
2937 * Returns: 0 on success, -1 on failure
2939 * This function indicates the driver to send (Re)Association
2940 * Response frame to the station.
2942 int (*sta_assoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2943 int reassoc
, u16 status
, const u8
*ie
, size_t len
);
2946 * sta_auth - Station authentication indication
2947 * @priv: Private driver interface data
2948 * @own_addr: Source address and BSSID for authentication frame
2949 * @addr: MAC address of the station to associate
2950 * @seq: authentication sequence number
2951 * @status: authentication response status code
2952 * @ie: authentication frame ie buffer
2953 * @len: ie buffer length
2955 * This function indicates the driver to send Authentication frame
2958 int (*sta_auth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2959 u16 seq
, u16 status
, const u8
*ie
, size_t len
);
2962 * add_tspec - Add traffic stream
2963 * @priv: Private driver interface data
2964 * @addr: MAC address of the station to associate
2965 * @tspec_ie: tspec ie buffer
2966 * @tspec_ielen: tspec ie length
2967 * Returns: 0 on success, -1 on failure
2969 * This function adds the traffic steam for the station
2970 * and fills the medium_time in tspec_ie.
2972 int (*add_tspec
)(void *priv
, const u8
*addr
, u8
*tspec_ie
,
2973 size_t tspec_ielen
);
2976 * add_sta_node - Add a station node in the driver
2977 * @priv: Private driver interface data
2978 * @addr: MAC address of the station to add
2979 * @auth_alg: authentication algorithm used by the station
2980 * Returns: 0 on success, -1 on failure
2982 * This function adds the station node in the driver, when
2983 * the station gets added by FT-over-DS.
2985 int (*add_sta_node
)(void *priv
, const u8
*addr
, u16 auth_alg
);
2988 * sched_scan - Request the driver to initiate scheduled scan
2989 * @priv: Private driver interface data
2990 * @params: Scan parameters
2991 * @interval: Interval between scan cycles in milliseconds
2992 * Returns: 0 on success, -1 on failure
2994 * This operation should be used for scheduled scan offload to
2995 * the hardware. Every time scan results are available, the
2996 * driver should report scan results event for wpa_supplicant
2997 * which will eventually request the results with
2998 * wpa_driver_get_scan_results2(). This operation is optional
2999 * and if not provided or if it returns -1, we fall back to
3000 * normal host-scheduled scans.
3002 int (*sched_scan
)(void *priv
, struct wpa_driver_scan_params
*params
,
3006 * stop_sched_scan - Request the driver to stop a scheduled scan
3007 * @priv: Private driver interface data
3008 * Returns: 0 on success, -1 on failure
3010 * This should cause the scheduled scan to be stopped and
3011 * results should stop being sent. Must be supported if
3012 * sched_scan is supported.
3014 int (*stop_sched_scan
)(void *priv
);
3017 * poll_client - Probe (null data or such) the given station
3018 * @priv: Private driver interface data
3019 * @own_addr: MAC address of sending interface
3020 * @addr: MAC address of the station to probe
3021 * @qos: Indicates whether station is QoS station
3023 * This function is used to verify whether an associated station is
3024 * still present. This function does not need to be implemented if the
3025 * driver provides such inactivity polling mechanism.
3027 void (*poll_client
)(void *priv
, const u8
*own_addr
,
3028 const u8
*addr
, int qos
);
3031 * radio_disable - Disable/enable radio
3032 * @priv: Private driver interface data
3033 * @disabled: 1=disable 0=enable radio
3034 * Returns: 0 on success, -1 on failure
3036 * This optional command is for testing purposes. It can be used to
3037 * disable the radio on a testbed device to simulate out-of-radio-range
3040 int (*radio_disable
)(void *priv
, int disabled
);
3043 * switch_channel - Announce channel switch and migrate the GO to the
3045 * @priv: Private driver interface data
3046 * @settings: Settings for CSA period and new channel
3047 * Returns: 0 on success, -1 on failure
3049 * This function is used to move the GO to the legacy STA channel to
3050 * avoid frequency conflict in single channel concurrency.
3052 int (*switch_channel
)(void *priv
, struct csa_settings
*settings
);
3055 * add_tx_ts - Add traffic stream
3056 * @priv: Private driver interface data
3057 * @tsid: Traffic stream ID
3058 * @addr: Receiver address
3059 * @user_prio: User priority of the traffic stream
3060 * @admitted_time: Admitted time for this TS in units of
3061 * 32 microsecond periods (per second).
3062 * Returns: 0 on success, -1 on failure
3064 int (*add_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
, u8 user_prio
,
3068 * del_tx_ts - Delete traffic stream
3069 * @priv: Private driver interface data
3070 * @tsid: Traffic stream ID
3071 * @addr: Receiver address
3072 * Returns: 0 on success, -1 on failure
3074 int (*del_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
);
3077 * Enable channel-switching with TDLS peer
3078 * @priv: Private driver interface data
3079 * @addr: MAC address of the TDLS peer
3080 * @oper_class: Operating class of the switch channel
3081 * @params: Channel specification
3082 * Returns: 0 on success, -1 on failure
3084 * The function indicates to driver that it can start switching to a
3085 * different channel with a specified TDLS peer. The switching is
3086 * assumed on until canceled with tdls_disable_channel_switch().
3088 int (*tdls_enable_channel_switch
)(
3089 void *priv
, const u8
*addr
, u8 oper_class
,
3090 const struct hostapd_freq_params
*params
);
3093 * Disable channel switching with TDLS peer
3094 * @priv: Private driver interface data
3095 * @addr: MAC address of the TDLS peer
3096 * Returns: 0 on success, -1 on failure
3098 * This function indicates to the driver that it should stop switching
3099 * with a given TDLS peer.
3101 int (*tdls_disable_channel_switch
)(void *priv
, const u8
*addr
);
3104 * start_dfs_cac - Listen for radar interference on the channel
3105 * @priv: Private driver interface data
3106 * @freq: Channel parameters
3107 * Returns: 0 on success, -1 on failure
3109 int (*start_dfs_cac
)(void *priv
, struct hostapd_freq_params
*freq
);
3112 * stop_ap - Removes beacon from AP
3113 * @priv: Private driver interface data
3114 * Returns: 0 on success, -1 on failure (or if not supported)
3116 * This optional function can be used to disable AP mode related
3117 * configuration. Unlike deinit_ap, it does not change to station
3120 int (*stop_ap
)(void *priv
);
3123 * get_survey - Retrieve survey data
3124 * @priv: Private driver interface data
3125 * @freq: If set, survey data for the specified frequency is only
3126 * being requested. If not set, all survey data is requested.
3127 * Returns: 0 on success, -1 on failure
3129 * Use this to retrieve:
3131 * - the observed channel noise floor
3132 * - the amount of time we have spent on the channel
3133 * - the amount of time during which we have spent on the channel that
3134 * the radio has determined the medium is busy and we cannot
3136 * - the amount of time we have spent receiving data
3137 * - the amount of time we have spent transmitting data
3139 * This data can be used for spectrum heuristics. One example is
3140 * Automatic Channel Selection (ACS). The channel survey data is
3141 * kept on a linked list on the channel data, one entry is added
3142 * for each survey. The min_nf of the channel is updated for each
3145 int (*get_survey
)(void *priv
, unsigned int freq
);
3148 * status - Get driver interface status information
3149 * @priv: Private driver interface data
3150 * @buf: Buffer for printing tou the status information
3151 * @buflen: Maximum length of the buffer
3152 * Returns: Length of written status information or -1 on failure
3154 int (*status
)(void *priv
, char *buf
, size_t buflen
);
3157 * roaming - Set roaming policy for driver-based BSS selection
3158 * @priv: Private driver interface data
3159 * @allowed: Whether roaming within ESS is allowed
3160 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3161 * Returns: Length of written status information or -1 on failure
3163 * This optional callback can be used to update roaming policy from the
3164 * associate() command (bssid being set there indicates that the driver
3165 * should not roam before getting this roaming() call to allow roaming.
3166 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3167 * capability, roaming policy is handled within wpa_supplicant and there
3168 * is no need to implement or react to this callback.
3170 int (*roaming
)(void *priv
, int allowed
, const u8
*bssid
);
3173 * set_mac_addr - Set MAC address
3174 * @priv: Private driver interface data
3175 * @addr: MAC address to use or %NULL for setting back to permanent
3176 * Returns: 0 on success, -1 on failure
3178 int (*set_mac_addr
)(void *priv
, const u8
*addr
);
3180 #ifdef CONFIG_MACSEC
3181 int (*macsec_init
)(void *priv
, struct macsec_init_params
*params
);
3183 int (*macsec_deinit
)(void *priv
);
3186 * enable_protect_frames - Set protect frames status
3187 * @priv: Private driver interface data
3188 * @enabled: TRUE = protect frames enabled
3189 * FALSE = protect frames disabled
3190 * Returns: 0 on success, -1 on failure (or if not supported)
3192 int (*enable_protect_frames
)(void *priv
, Boolean enabled
);
3195 * set_replay_protect - Set replay protect status and window size
3196 * @priv: Private driver interface data
3197 * @enabled: TRUE = replay protect enabled
3198 * FALSE = replay protect disabled
3199 * @window: replay window size, valid only when replay protect enabled
3200 * Returns: 0 on success, -1 on failure (or if not supported)
3202 int (*set_replay_protect
)(void *priv
, Boolean enabled
, u32 window
);
3205 * set_current_cipher_suite - Set current cipher suite
3206 * @priv: Private driver interface data
3207 * @cs: EUI64 identifier
3208 * @cs_len: Length of the cs buffer in octets
3209 * Returns: 0 on success, -1 on failure (or if not supported)
3211 int (*set_current_cipher_suite
)(void *priv
, const u8
*cs
,
3215 * enable_controlled_port - Set controlled port status
3216 * @priv: Private driver interface data
3217 * @enabled: TRUE = controlled port enabled
3218 * FALSE = controlled port disabled
3219 * Returns: 0 on success, -1 on failure (or if not supported)
3221 int (*enable_controlled_port
)(void *priv
, Boolean enabled
);
3224 * get_receive_lowest_pn - Get receive lowest pn
3225 * @priv: Private driver interface data
3226 * @channel: secure channel
3227 * @an: association number
3228 * @lowest_pn: lowest accept pn
3229 * Returns: 0 on success, -1 on failure (or if not supported)
3231 int (*get_receive_lowest_pn
)(void *priv
, u32 channel
, u8 an
,
3235 * get_transmit_next_pn - Get transmit next pn
3236 * @priv: Private driver interface data
3237 * @channel: secure channel
3238 * @an: association number
3240 * Returns: 0 on success, -1 on failure (or if not supported)
3242 int (*get_transmit_next_pn
)(void *priv
, u32 channel
, u8 an
,
3246 * set_transmit_next_pn - Set transmit next pn
3247 * @priv: Private driver interface data
3248 * @channel: secure channel
3249 * @an: association number
3251 * Returns: 0 on success, -1 on failure (or if not supported)
3253 int (*set_transmit_next_pn
)(void *priv
, u32 channel
, u8 an
,
3257 * get_available_receive_sc - get available receive channel
3258 * @priv: Private driver interface data
3259 * @channel: secure channel
3260 * Returns: 0 on success, -1 on failure (or if not supported)
3262 int (*get_available_receive_sc
)(void *priv
, u32
*channel
);
3265 * create_receive_sc - create secure channel for receiving
3266 * @priv: Private driver interface data
3267 * @channel: secure channel
3268 * @sci_addr: secure channel identifier - address
3269 * @sci_port: secure channel identifier - port
3270 * @conf_offset: confidentiality offset (0, 30, or 50)
3271 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3273 * Returns: 0 on success, -1 on failure (or if not supported)
3275 int (*create_receive_sc
)(void *priv
, u32 channel
, const u8
*sci_addr
,
3276 u16 sci_port
, unsigned int conf_offset
,
3280 * delete_receive_sc - delete secure connection for receiving
3281 * @priv: private driver interface data from init()
3282 * @channel: secure channel
3283 * Returns: 0 on success, -1 on failure
3285 int (*delete_receive_sc
)(void *priv
, u32 channel
);
3288 * create_receive_sa - create secure association for receive
3289 * @priv: private driver interface data from init()
3290 * @channel: secure channel
3291 * @an: association number
3292 * @lowest_pn: the lowest packet number can be received
3293 * @sak: the secure association key
3294 * Returns: 0 on success, -1 on failure
3296 int (*create_receive_sa
)(void *priv
, u32 channel
, u8 an
,
3297 u32 lowest_pn
, const u8
*sak
);
3300 * enable_receive_sa - enable the SA for receive
3301 * @priv: private driver interface data from init()
3302 * @channel: secure channel
3303 * @an: association number
3304 * Returns: 0 on success, -1 on failure
3306 int (*enable_receive_sa
)(void *priv
, u32 channel
, u8 an
);
3309 * disable_receive_sa - disable SA for receive
3310 * @priv: private driver interface data from init()
3311 * @channel: secure channel index
3312 * @an: association number
3313 * Returns: 0 on success, -1 on failure
3315 int (*disable_receive_sa
)(void *priv
, u32 channel
, u8 an
);
3318 * get_available_transmit_sc - get available transmit channel
3319 * @priv: Private driver interface data
3320 * @channel: secure channel
3321 * Returns: 0 on success, -1 on failure (or if not supported)
3323 int (*get_available_transmit_sc
)(void *priv
, u32
*channel
);
3326 * create_transmit_sc - create secure connection for transmit
3327 * @priv: private driver interface data from init()
3328 * @channel: secure channel
3329 * @sci_addr: secure channel identifier - address
3330 * @sci_port: secure channel identifier - port
3331 * Returns: 0 on success, -1 on failure
3333 int (*create_transmit_sc
)(void *priv
, u32 channel
, const u8
*sci_addr
,
3334 u16 sci_port
, unsigned int conf_offset
);
3337 * delete_transmit_sc - delete secure connection for transmit
3338 * @priv: private driver interface data from init()
3339 * @channel: secure channel
3340 * Returns: 0 on success, -1 on failure
3342 int (*delete_transmit_sc
)(void *priv
, u32 channel
);
3345 * create_transmit_sa - create secure association for transmit
3346 * @priv: private driver interface data from init()
3347 * @channel: secure channel index
3348 * @an: association number
3349 * @next_pn: the packet number used as next transmit packet
3350 * @confidentiality: True if the SA is to provide confidentiality
3351 * as well as integrity
3352 * @sak: the secure association key
3353 * Returns: 0 on success, -1 on failure
3355 int (*create_transmit_sa
)(void *priv
, u32 channel
, u8 an
, u32 next_pn
,
3356 Boolean confidentiality
, const u8
*sak
);
3359 * enable_transmit_sa - enable SA for transmit
3360 * @priv: private driver interface data from init()
3361 * @channel: secure channel
3362 * @an: association number
3363 * Returns: 0 on success, -1 on failure
3365 int (*enable_transmit_sa
)(void *priv
, u32 channel
, u8 an
);
3368 * disable_transmit_sa - disable SA for transmit
3369 * @priv: private driver interface data from init()
3370 * @channel: secure channel
3371 * @an: association number
3372 * Returns: 0 on success, -1 on failure
3374 int (*disable_transmit_sa
)(void *priv
, u32 channel
, u8 an
);
3375 #endif /* CONFIG_MACSEC */
3378 * init_mesh - Driver specific initialization for mesh
3379 * @priv: Private driver interface data
3380 * Returns: 0 on success, -1 on failure
3382 int (*init_mesh
)(void *priv
);
3385 * join_mesh - Join a mesh network
3386 * @priv: Private driver interface data
3387 * @params: Mesh configuration parameters
3388 * Returns: 0 on success, -1 on failure
3390 int (*join_mesh
)(void *priv
,
3391 struct wpa_driver_mesh_join_params
*params
);
3394 * leave_mesh - Leave a mesh network
3395 * @priv: Private driver interface data
3396 * Returns 0 on success, -1 on failure
3398 int (*leave_mesh
)(void *priv
);
3401 * do_acs - Automatically select channel
3402 * @priv: Private driver interface data
3403 * @params: Parameters for ACS
3404 * Returns 0 on success, -1 on failure
3406 * This command can be used to offload ACS to the driver if the driver
3407 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3409 int (*do_acs
)(void *priv
, struct drv_acs_params
*params
);
3412 * set_band - Notify driver of band selection
3413 * @priv: Private driver interface data
3414 * @band: The selected band(s)
3415 * Returns 0 on success, -1 on failure
3417 int (*set_band
)(void *priv
, enum set_band band
);
3420 * get_pref_freq_list - Get preferred frequency list for an interface
3421 * @priv: Private driver interface data
3422 * @if_type: Interface type
3423 * @num: Number of channels
3424 * @freq_list: Preferred channel frequency list encoded in MHz values
3425 * Returns 0 on success, -1 on failure
3427 * This command can be used to query the preferred frequency list from
3428 * the driver specific to a particular interface type.
3430 int (*get_pref_freq_list
)(void *priv
, enum wpa_driver_if_type if_type
,
3431 unsigned int *num
, unsigned int *freq_list
);
3434 * set_prob_oper_freq - Indicate probable P2P operating channel
3435 * @priv: Private driver interface data
3436 * @freq: Channel frequency in MHz
3437 * Returns 0 on success, -1 on failure
3439 * This command can be used to inform the driver of the operating
3440 * frequency that an ongoing P2P group formation is likely to come up
3441 * on. Local device is assuming P2P Client role.
3443 int (*set_prob_oper_freq
)(void *priv
, unsigned int freq
);
3448 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3450 enum wpa_event_type
{
3452 * EVENT_ASSOC - Association completed
3454 * This event needs to be delivered when the driver completes IEEE
3455 * 802.11 association or reassociation successfully.
3456 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3457 * after this event has been generated. In addition, optional
3458 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3459 * more information about the association. If the driver interface gets
3460 * both of these events at the same time, it can also include the
3461 * assoc_info data in EVENT_ASSOC call.
3466 * EVENT_DISASSOC - Association lost
3468 * This event should be called when association is lost either due to
3469 * receiving deauthenticate or disassociate frame from the AP or when
3470 * sending either of these frames to the current AP. If the driver
3471 * supports separate deauthentication event, EVENT_DISASSOC should only
3472 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3473 * In AP mode, union wpa_event_data::disassoc_info is required.
3478 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3480 * This event must be delivered when a Michael MIC error is detected by
3481 * the local driver. Additional data for event processing is
3482 * provided with union wpa_event_data::michael_mic_failure. This
3483 * information is used to request new encyption key and to initiate
3484 * TKIP countermeasures if needed.
3486 EVENT_MICHAEL_MIC_FAILURE
,
3489 * EVENT_SCAN_RESULTS - Scan results available
3491 * This event must be called whenever scan results are available to be
3492 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3493 * is expected to be used some time after struct wpa_driver_ops::scan()
3494 * is called. If the driver provides an unsolicited event when the scan
3495 * has been completed, this event can be used to trigger
3496 * EVENT_SCAN_RESULTS call. If such event is not available from the
3497 * driver, the driver wrapper code is expected to use a registered
3498 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3499 * scan is expected to be completed. Optional information about
3500 * completed scan can be provided with union wpa_event_data::scan_info.
3505 * EVENT_ASSOCINFO - Report optional extra information for association
3507 * This event can be used to report extra association information for
3508 * EVENT_ASSOC processing. This extra information includes IEs from
3509 * association frames and Beacon/Probe Response frames in union
3510 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3511 * EVENT_ASSOC. Alternatively, the driver interface can include
3512 * assoc_info data in the EVENT_ASSOC call if it has all the
3513 * information available at the same point.
3518 * EVENT_INTERFACE_STATUS - Report interface status changes
3520 * This optional event can be used to report changes in interface
3521 * status (interface added/removed) using union
3522 * wpa_event_data::interface_status. This can be used to trigger
3523 * wpa_supplicant to stop and re-start processing for the interface,
3524 * e.g., when a cardbus card is ejected/inserted.
3526 EVENT_INTERFACE_STATUS
,
3529 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3531 * This event can be used to inform wpa_supplicant about candidates for
3532 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3533 * for scan request (ap_scan=2 mode), this event is required for
3534 * pre-authentication. If wpa_supplicant is performing scan request
3535 * (ap_scan=1), this event is optional since scan results can be used
3536 * to add pre-authentication candidates. union
3537 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3538 * candidate and priority of the candidate, e.g., based on the signal
3539 * strength, in order to try to pre-authenticate first with candidates
3540 * that are most likely targets for re-association.
3542 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3543 * on the candidate list. In addition, it can be called for the current
3544 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3545 * will automatically skip pre-authentication in cases where a valid
3546 * PMKSA exists. When more than one candidate exists, this event should
3547 * be generated once for each candidate.
3549 * Driver will be notified about successful pre-authentication with
3550 * struct wpa_driver_ops::add_pmkid() calls.
3552 EVENT_PMKID_CANDIDATE
,
3555 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3557 * This event can be used to inform wpa_supplicant about desire to set
3558 * up secure direct link connection between two stations as defined in
3559 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3560 * STAKey negotiation. The caller will need to set peer address for the
3566 * EVENT_TDLS - Request TDLS operation
3568 * This event can be used to request a TDLS operation to be performed.
3573 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3575 * The driver is expected to report the received FT IEs from
3576 * FT authentication sequence from the AP. The FT IEs are included in
3577 * the extra information in union wpa_event_data::ft_ies.
3582 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3584 * The driver can use this event to inform wpa_supplicant about a STA
3585 * in an IBSS with which protected frames could be exchanged. This
3586 * event starts RSN authentication with the other STA to authenticate
3587 * the STA and set up encryption keys with it.
3589 EVENT_IBSS_RSN_START
,
3592 * EVENT_AUTH - Authentication result
3594 * This event should be called when authentication attempt has been
3595 * completed. This is only used if the driver supports separate
3596 * authentication step (struct wpa_driver_ops::authenticate).
3597 * Information about authentication result is included in
3598 * union wpa_event_data::auth.
3603 * EVENT_DEAUTH - Authentication lost
3605 * This event should be called when authentication is lost either due
3606 * to receiving deauthenticate frame from the AP or when sending that
3607 * frame to the current AP.
3608 * In AP mode, union wpa_event_data::deauth_info is required.
3613 * EVENT_ASSOC_REJECT - Association rejected
3615 * This event should be called when (re)association attempt has been
3616 * rejected by the AP. Information about the association response is
3617 * included in union wpa_event_data::assoc_reject.
3622 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3624 EVENT_AUTH_TIMED_OUT
,
3627 * EVENT_ASSOC_TIMED_OUT - Association timed out
3629 EVENT_ASSOC_TIMED_OUT
,
3632 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3634 EVENT_WPS_BUTTON_PUSHED
,
3637 * EVENT_TX_STATUS - Report TX status
3642 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3644 EVENT_RX_FROM_UNKNOWN
,
3647 * EVENT_RX_MGMT - Report RX of a management frame
3652 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3654 * This event is used to indicate when the driver has started the
3655 * requested remain-on-channel duration. Information about the
3656 * operation is included in union wpa_event_data::remain_on_channel.
3658 EVENT_REMAIN_ON_CHANNEL
,
3661 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3663 * This event is used to indicate when the driver has completed
3664 * remain-on-channel duration, i.e., may noot be available on the
3665 * requested channel anymore. Information about the
3666 * operation is included in union wpa_event_data::remain_on_channel.
3668 EVENT_CANCEL_REMAIN_ON_CHANNEL
,
3671 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3673 * This event is used to indicate when a Probe Request frame has been
3674 * received. Information about the received frame is included in
3675 * union wpa_event_data::rx_probe_req. The driver is required to report
3676 * these events only after successfully completed probe_req_report()
3677 * commands to request the events (i.e., report parameter is non-zero)
3678 * in station mode. In AP mode, Probe Request frames should always be
3684 * EVENT_NEW_STA - New wired device noticed
3686 * This event is used to indicate that a new device has been detected
3687 * in a network that does not use association-like functionality (i.e.,
3688 * mainly wired Ethernet). This can be used to start EAPOL
3689 * authenticator when receiving a frame from a device. The address of
3690 * the device is included in union wpa_event_data::new_sta.
3695 * EVENT_EAPOL_RX - Report received EAPOL frame
3697 * When in AP mode with hostapd, this event is required to be used to
3698 * deliver the receive EAPOL frames from the driver.
3703 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3705 * This event is used to indicate changes in the signal strength
3706 * observed in frames received from the current AP if signal strength
3707 * monitoring has been enabled with signal_monitor().
3709 EVENT_SIGNAL_CHANGE
,
3712 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3714 * This event is used to indicate that the interface was enabled after
3715 * having been previously disabled, e.g., due to rfkill.
3717 EVENT_INTERFACE_ENABLED
,
3720 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3722 * This event is used to indicate that the interface was disabled,
3723 * e.g., due to rfkill.
3725 EVENT_INTERFACE_DISABLED
,
3728 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3730 * This event is used to indicate that the channel list has changed,
3731 * e.g., because of a regulatory domain change triggered by scan
3732 * results including an AP advertising a country code.
3734 EVENT_CHANNEL_LIST_CHANGED
,
3737 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3739 * This event is used to indicate that the driver cannot maintain this
3740 * interface in its operation mode anymore. The most likely use for
3741 * this is to indicate that AP mode operation is not available due to
3742 * operating channel would need to be changed to a DFS channel when
3743 * the driver does not support radar detection and another virtual
3744 * interfaces caused the operating channel to change. Other similar
3745 * resource conflicts could also trigger this for station mode
3746 * interfaces. This event can be propagated when channel switching
3749 EVENT_INTERFACE_UNAVAILABLE
,
3752 * EVENT_BEST_CHANNEL
3754 * Driver generates this event whenever it detects a better channel
3755 * (e.g., based on RSSI or channel use). This information can be used
3756 * to improve channel selection for a new AP/P2P group.
3761 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3763 * This event should be called when a Deauthentication frame is dropped
3764 * due to it not being protected (MFP/IEEE 802.11w).
3765 * union wpa_event_data::unprot_deauth is required to provide more
3766 * details of the frame.
3768 EVENT_UNPROT_DEAUTH
,
3771 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3773 * This event should be called when a Disassociation frame is dropped
3774 * due to it not being protected (MFP/IEEE 802.11w).
3775 * union wpa_event_data::unprot_disassoc is required to provide more
3776 * details of the frame.
3778 EVENT_UNPROT_DISASSOC
,
3781 * EVENT_STATION_LOW_ACK
3783 * Driver generates this event whenever it detected that a particular
3784 * station was lost. Detection can be through massive transmission
3785 * failures for example.
3787 EVENT_STATION_LOW_ACK
,
3790 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3792 EVENT_IBSS_PEER_LOST
,
3795 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3797 * This event carries the new replay counter to notify wpa_supplicant
3798 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3799 * completed Group Key Handshake while the host (including
3800 * wpa_supplicant was sleeping).
3802 EVENT_DRIVER_GTK_REKEY
,
3805 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3807 EVENT_SCHED_SCAN_STOPPED
,
3810 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3812 * This event indicates that the station responded to the poll
3813 * initiated with @poll_client.
3815 EVENT_DRIVER_CLIENT_POLL_OK
,
3818 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3820 EVENT_EAPOL_TX_STATUS
,
3823 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3825 * Described in wpa_event_data.ch_switch
3830 * EVENT_WNM - Request WNM operation
3832 * This event can be used to request a WNM operation to be performed.
3837 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3839 * This event indicates that the driver reported a connection failure
3840 * with the specified client (for example, max client reached, etc.) in
3843 EVENT_CONNECT_FAILED_REASON
,
3846 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
3848 * A radar has been detected on the supplied frequency, hostapd should
3849 * react accordingly (e.g., change channel).
3851 EVENT_DFS_RADAR_DETECTED
,
3854 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
3856 * After a successful CAC, the channel can be marked clear and used.
3858 EVENT_DFS_CAC_FINISHED
,
3861 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
3863 * The CAC was not successful, and the channel remains in the previous
3864 * state. This may happen due to a radar beeing detected or other
3865 * external influences.
3867 EVENT_DFS_CAC_ABORTED
,
3870 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
3872 * The channel which was previously unavailable is now available again.
3874 EVENT_DFS_NOP_FINISHED
,
3877 * EVENT_SURVEY - Received survey data
3879 * This event gets triggered when a driver query is issued for survey
3880 * data and the requested data becomes available. The returned data is
3881 * stored in struct survey_results. The results provide at most one
3882 * survey entry for each frequency and at minimum will provide one
3883 * survey entry for one frequency. The survey data can be os_malloc()'d
3884 * and then os_free()'d, so the event callback must only copy data.
3889 * EVENT_SCAN_STARTED - Scan started
3891 * This indicates that driver has started a scan operation either based
3892 * on a request from wpa_supplicant/hostapd or from another application.
3893 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3894 * completed (either successfully or by getting cancelled).
3899 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3901 * This event indicates a set of frequency ranges that should be avoided
3902 * to reduce issues due to interference or internal co-existence
3903 * information in the driver.
3905 EVENT_AVOID_FREQUENCIES
,
3908 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3910 EVENT_NEW_PEER_CANDIDATE
,
3913 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
3915 * Indicates a pair of primary and secondary channels chosen by ACS
3918 EVENT_ACS_CHANNEL_SELECTED
,
3921 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
3924 * This event indicates that channel availability check has been started
3925 * on a DFS frequency by a driver that supports DFS Offload.
3927 EVENT_DFS_CAC_STARTED
,
3932 * struct freq_survey - Channel survey info
3934 * @ifidx: Interface index in which this survey was observed
3935 * @freq: Center of frequency of the surveyed channel
3936 * @nf: Channel noise floor in dBm
3937 * @channel_time: Amount of time in ms the radio spent on the channel
3938 * @channel_time_busy: Amount of time in ms the radio detected some signal
3939 * that indicated to the radio the channel was not clear
3940 * @channel_time_rx: Amount of time the radio spent receiving data
3941 * @channel_time_tx: Amount of time the radio spent transmitting data
3942 * @filled: bitmask indicating which fields have been reported, see
3943 * SURVEY_HAS_* defines.
3944 * @list: Internal list pointers
3946 struct freq_survey
{
3951 u64 channel_time_busy
;
3952 u64 channel_time_rx
;
3953 u64 channel_time_tx
;
3954 unsigned int filled
;
3955 struct dl_list list
;
3958 #define SURVEY_HAS_NF BIT(0)
3959 #define SURVEY_HAS_CHAN_TIME BIT(1)
3960 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3961 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3962 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3966 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3968 union wpa_event_data
{
3970 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3972 * This structure is optional for EVENT_ASSOC calls and required for
3973 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3974 * driver interface does not need to generate separate EVENT_ASSOCINFO
3979 * reassoc - Flag to indicate association or reassociation
3984 * req_ies - (Re)Association Request IEs
3986 * If the driver generates WPA/RSN IE, this event data must be
3987 * returned for WPA handshake to have needed information. If
3988 * wpa_supplicant-generated WPA/RSN IE is used, this
3989 * information event is optional.
3991 * This should start with the first IE (fixed fields before IEs
3992 * are not included).
3997 * req_ies_len - Length of req_ies in bytes
4002 * resp_ies - (Re)Association Response IEs
4004 * Optional association data from the driver. This data is not
4005 * required WPA, but may be useful for some protocols and as
4006 * such, should be reported if this is available to the driver
4009 * This should start with the first IE (fixed fields before IEs
4010 * are not included).
4015 * resp_ies_len - Length of resp_ies in bytes
4017 size_t resp_ies_len
;
4020 * beacon_ies - Beacon or Probe Response IEs
4022 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4023 * Probe Response frames from the current AP (i.e., the one
4024 * that the client just associated with). This information is
4025 * used to update WPA/RSN IE for the AP. If this field is not
4026 * set, the results from previous scan will be used. If no
4027 * data for the new AP is found, scan results will be requested
4028 * again (without scan request). At this point, the driver is
4029 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4032 * This should start with the first IE (fixed fields before IEs
4033 * are not included).
4035 const u8
*beacon_ies
;
4038 * beacon_ies_len - Length of beacon_ies */
4039 size_t beacon_ies_len
;
4042 * freq - Frequency of the operational channel in MHz
4047 * wmm_params - WMM parameters used in this association.
4049 struct wmm_params wmm_params
;
4052 * addr - Station address (for AP mode)
4057 * The following is the key management offload information
4060 * @key_replay_ctr_len
4068 * authorized - Status of key management offload,
4074 * key_replay_ctr - Key replay counter value last used
4075 * in a valid EAPOL-Key frame
4077 const u8
*key_replay_ctr
;
4080 * key_replay_ctr_len - The length of key_replay_ctr
4082 size_t key_replay_ctr_len
;
4085 * ptk_kck - The derived PTK KCK
4090 * ptk_kek_len - The length of ptk_kck
4095 * ptk_kek - The derived PTK KEK
4100 * ptk_kek_len - The length of ptk_kek
4106 * struct disassoc_info - Data for EVENT_DISASSOC events
4108 struct disassoc_info
{
4110 * addr - Station address (for AP mode)
4115 * reason_code - Reason Code (host byte order) used in
4116 * Deauthentication frame
4121 * ie - Optional IE(s) in Disassociation frame
4126 * ie_len - Length of ie buffer in octets
4131 * locally_generated - Whether the frame was locally generated
4133 int locally_generated
;
4137 * struct deauth_info - Data for EVENT_DEAUTH events
4139 struct deauth_info
{
4141 * addr - Station address (for AP mode)
4146 * reason_code - Reason Code (host byte order) used in
4147 * Deauthentication frame
4152 * ie - Optional IE(s) in Deauthentication frame
4157 * ie_len - Length of ie buffer in octets
4162 * locally_generated - Whether the frame was locally generated
4164 int locally_generated
;
4168 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4170 struct michael_mic_failure
{
4173 } michael_mic_failure
;
4176 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4178 struct interface_status
{
4181 EVENT_INTERFACE_ADDED
, EVENT_INTERFACE_REMOVED
4186 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4188 struct pmkid_candidate
{
4189 /** BSSID of the PMKID candidate */
4191 /** Smaller the index, higher the priority */
4193 /** Whether RSN IE includes pre-authenticate flag */
4198 * struct stkstart - Data for EVENT_STKSTART
4205 * struct tdls - Data for EVENT_TDLS
4211 TDLS_REQUEST_TEARDOWN
,
4212 TDLS_REQUEST_DISCOVER
,
4214 u16 reason_code
; /* for teardown */
4218 * struct wnm - Data for EVENT_WNM
4236 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4238 * During FT (IEEE 802.11r) authentication sequence, the driver is
4239 * expected to use this event to report received FT IEs (MDIE, FTIE,
4240 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4241 * IEs for the next message will be delivered through the
4242 * struct wpa_driver_ops::update_ft_ies() callback.
4248 u8 target_ap
[ETH_ALEN
];
4249 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4251 /** Length of ric_ies buffer in octets */
4256 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4258 struct ibss_rsn_start
{
4263 * struct auth_info - Data for EVENT_AUTH events
4269 u16 auth_transaction
;
4276 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4278 struct assoc_reject
{
4280 * bssid - BSSID of the AP that rejected association
4285 * resp_ies - (Re)Association Response IEs
4287 * Optional association data from the driver. This data is not
4288 * required WPA, but may be useful for some protocols and as
4289 * such, should be reported if this is available to the driver
4292 * This should start with the first IE (fixed fields before IEs
4293 * are not included).
4298 * resp_ies_len - Length of resp_ies in bytes
4300 size_t resp_ies_len
;
4303 * status_code - Status Code from (Re)association Response
4308 struct timeout_event
{
4313 * struct tx_status - Data for EVENT_TX_STATUS events
4325 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4327 struct rx_from_unknown
{
4334 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4342 * drv_priv - Pointer to store driver private BSS information
4344 * If not set to NULL, this is used for comparison with
4345 * hostapd_data->drv_priv to determine which BSS should process
4351 * freq - Frequency (in MHz) on which the frame was received
4356 * ssi_signal - Signal strength in dBm (or 0 if not available)
4362 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4364 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4366 struct remain_on_channel
{
4368 * freq - Channel frequency in MHz
4373 * duration - Duration to remain on the channel in milliseconds
4375 unsigned int duration
;
4376 } remain_on_channel
;
4379 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4380 * @aborted: Whether the scan was aborted
4381 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4382 * @num_freqs: Number of entries in freqs array
4383 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4385 * @num_ssids: Number of entries in ssids array
4386 * @external_scan: Whether the scan info is for an external scan
4387 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
4388 * 0 if the source of the scan event is a vendor scan
4394 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
4401 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4403 struct rx_probe_req
{
4405 * sa - Source address of the received Probe Request frame
4410 * da - Destination address of the received Probe Request frame
4411 * or %NULL if not available
4416 * bssid - BSSID of the received Probe Request frame or %NULL
4422 * ie - IEs from the Probe Request body
4427 * ie_len - Length of ie buffer in octets
4432 * signal - signal strength in dBm (or 0 if not available)
4438 * struct new_sta - Data for EVENT_NEW_STA events
4445 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4454 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4456 struct wpa_signal_info signal_change
;
4459 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4460 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4461 * @freq_5: Best 5 GHz band channel frequency in MHz
4462 * @freq_overall: Best channel frequency in MHz
4464 * 0 can be used to indicate no preference in either band.
4466 struct best_channel
{
4472 struct unprot_deauth
{
4478 struct unprot_disassoc
{
4485 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4486 * @addr: station address
4493 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4495 struct ibss_peer_lost
{
4500 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4502 struct driver_gtk_rekey
{
4504 const u8
*replay_ctr
;
4508 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4509 * @addr: station address
4511 struct client_poll
{
4516 * struct eapol_tx_status
4517 * @dst: Original destination
4518 * @data: Data starting with IEEE 802.1X header (!)
4519 * @data_len: Length of data
4520 * @ack: Indicates ack or lost frame
4522 * This corresponds to hapd_send_eapol if the frame sent
4523 * there isn't just reported as EVENT_TX_STATUS.
4525 struct eapol_tx_status
{
4534 * @freq: Frequency of new channel in MHz
4535 * @ht_enabled: Whether this is an HT channel
4536 * @ch_offset: Secondary channel offset
4537 * @ch_width: Channel width
4538 * @cf1: Center frequency 1
4539 * @cf2: Center frequency 2
4545 enum chan_width ch_width
;
4551 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4552 * @addr: Remote client address
4553 * @code: Reason code for connection failure
4555 struct connect_failed_reason
{
4561 } connect_failed_reason
;
4564 * struct dfs_event - Data for radar detected events
4565 * @freq: Frequency of the channel in MHz
4571 enum chan_width chan_width
;
4577 * survey_results - Survey result data for EVENT_SURVEY
4578 * @freq_filter: Requested frequency survey filter, 0 if request
4579 * was for all survey data
4580 * @survey_list: Linked list of survey data (struct freq_survey)
4582 struct survey_results
{
4583 unsigned int freq_filter
;
4584 struct dl_list survey_list
; /* struct freq_survey */
4588 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4589 * @initiator: Initiator of the regulatory change
4590 * @type: Regulatory change type
4591 * @alpha2: Country code (or "" if not available)
4593 struct channel_list_changed
{
4594 enum reg_change_initiator initiator
;
4597 } channel_list_changed
;
4600 * freq_range - List of frequency ranges
4602 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4604 struct wpa_freq_range_list freq_range
;
4609 * @peer: Peer address
4611 * @ie_len: Length of @ies
4613 * Notification of new candidate mesh peer.
4622 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4623 * @pri_channel: Selected primary channel
4624 * @sec_channel: Selected secondary channel
4625 * @vht_seg0_center_ch: VHT mode Segment0 center channel
4626 * @vht_seg1_center_ch: VHT mode Segment1 center channel
4627 * @ch_width: Selected Channel width by driver. Driver may choose to
4628 * change hostapd configured ACS channel width due driver internal
4629 * channel restrictions.
4630 * hw_mode: Selected band (used with hw_mode=any)
4632 struct acs_selected_channels
{
4635 u8 vht_seg0_center_ch
;
4636 u8 vht_seg1_center_ch
;
4638 enum hostapd_hw_mode hw_mode
;
4639 } acs_selected_channels
;
4643 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4644 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4645 * with struct wpa_driver_ops::init()
4646 * @event: event type (defined above)
4647 * @data: possible extra data for the event
4649 * Driver wrapper code should call this function whenever an event is received
4652 void wpa_supplicant_event(void *ctx
, enum wpa_event_type event
,
4653 union wpa_event_data
*data
);
4657 * The following inline functions are provided for convenience to simplify
4658 * event indication for some of the common events.
4661 static inline void drv_event_assoc(void *ctx
, const u8
*addr
, const u8
*ie
,
4662 size_t ielen
, int reassoc
)
4664 union wpa_event_data event
;
4665 os_memset(&event
, 0, sizeof(event
));
4666 event
.assoc_info
.reassoc
= reassoc
;
4667 event
.assoc_info
.req_ies
= ie
;
4668 event
.assoc_info
.req_ies_len
= ielen
;
4669 event
.assoc_info
.addr
= addr
;
4670 wpa_supplicant_event(ctx
, EVENT_ASSOC
, &event
);
4673 static inline void drv_event_disassoc(void *ctx
, const u8
*addr
)
4675 union wpa_event_data event
;
4676 os_memset(&event
, 0, sizeof(event
));
4677 event
.disassoc_info
.addr
= addr
;
4678 wpa_supplicant_event(ctx
, EVENT_DISASSOC
, &event
);
4681 static inline void drv_event_eapol_rx(void *ctx
, const u8
*src
, const u8
*data
,
4684 union wpa_event_data event
;
4685 os_memset(&event
, 0, sizeof(event
));
4686 event
.eapol_rx
.src
= src
;
4687 event
.eapol_rx
.data
= data
;
4688 event
.eapol_rx
.data_len
= data_len
;
4689 wpa_supplicant_event(ctx
, EVENT_EAPOL_RX
, &event
);
4692 /* driver_common.c */
4693 void wpa_scan_results_free(struct wpa_scan_results
*res
);
4695 /* Convert wpa_event_type to a string for logging */
4696 const char * event_to_string(enum wpa_event_type event
);
4698 /* Convert chan_width to a string for logging and control interfaces */
4699 const char * channel_width_to_string(enum chan_width width
);
4701 int ht_supported(const struct hostapd_hw_modes
*mode
);
4702 int vht_supported(const struct hostapd_hw_modes
*mode
);
4704 struct wowlan_triggers
*
4705 wpa_get_wowlan_triggers(const char *wowlan_triggers
,
4706 const struct wpa_driver_capa
*capa
);
4708 /* NULL terminated array of linked in driver wrappers */
4709 extern const struct wpa_driver_ops
*const wpa_drivers
[];
4711 #endif /* DRIVER_H */