2 * Driver interface definition
3 * Copyright (c) 2003-2014, 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 "utils/list.h"
25 #define HOSTAPD_CHAN_DISABLED 0x00000001
26 #define HOSTAPD_CHAN_NO_IR 0x00000002
27 #define HOSTAPD_CHAN_RADAR 0x00000008
28 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
29 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
30 #define HOSTAPD_CHAN_HT40 0x00000040
31 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
33 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
34 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
35 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
36 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
37 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
39 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
40 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
41 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
42 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
44 #define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
45 #define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
48 * enum reg_change_initiator - Regulatory change initiator
50 enum reg_change_initiator {
54 REGDOM_SET_BY_COUNTRY_IE,
59 * enum reg_type - Regulatory change types
65 REGDOM_TYPE_CUSTOM_WORLD,
66 REGDOM_TYPE_INTERSECTION,
70 * struct hostapd_channel_data - Channel information
72 struct hostapd_channel_data {
74 * chan - Channel number (IEEE 802.11)
79 * freq - Frequency in MHz
84 * flag - Channel flags (HOSTAPD_CHAN_*)
89 * max_tx_power - Regulatory transmit power limit in dBm
94 * survey_list - Linked list of surveys (struct freq_survey)
96 struct dl_list survey_list;
99 * min_nf - Minimum observed noise floor, in dBm, based on all
100 * surveyed channel data
106 * interference_factor - Computed interference factor on this
107 * channel (used internally in src/ap/acs.c; driver wrappers do not
110 long double interference_factor;
111 #endif /* CONFIG_ACS */
114 * dfs_cac_ms - DFS CAC time in milliseconds
116 unsigned int dfs_cac_ms;
119 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
120 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
123 * struct hostapd_hw_modes - Supported hardware mode information
125 struct hostapd_hw_modes {
127 * mode - Hardware mode
129 enum hostapd_hw_mode mode;
132 * num_channels - Number of entries in the channels array
137 * channels - Array of supported channels
139 struct hostapd_channel_data *channels;
142 * num_rates - Number of entries in the rates array
147 * rates - Array of supported rates in 100 kbps units
152 * ht_capab - HT (IEEE 802.11n) capabilities
157 * mcs_set - MCS (IEEE 802.11n) rate parameters
162 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
167 * vht_capab - VHT (IEEE 802.11ac) capabilities
172 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
176 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
180 #define IEEE80211_MODE_INFRA 0
181 #define IEEE80211_MODE_IBSS 1
182 #define IEEE80211_MODE_AP 2
183 #define IEEE80211_MODE_MESH 5
185 #define IEEE80211_CAP_ESS 0x0001
186 #define IEEE80211_CAP_IBSS 0x0002
187 #define IEEE80211_CAP_PRIVACY 0x0010
188 #define IEEE80211_CAP_RRM 0x1000
190 /* DMG (60 GHz) IEEE 802.11ad */
191 /* type - bits 0..1 */
192 #define IEEE80211_CAP_DMG_MASK 0x0003
193 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
194 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
195 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
197 #define WPA_SCAN_QUAL_INVALID BIT(0)
198 #define WPA_SCAN_NOISE_INVALID BIT(1)
199 #define WPA_SCAN_LEVEL_INVALID BIT(2)
200 #define WPA_SCAN_LEVEL_DBM BIT(3)
201 #define WPA_SCAN_AUTHENTICATED BIT(4)
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 * @ie_len: length of the following IE field in octets
218 * @beacon_ie_len: length of the following Beacon IE field in octets
220 * This structure is used as a generic format for scan results from the
221 * driver. Each driver interface implementation is responsible for converting
222 * the driver or OS specific scan results into this format.
224 * If the driver does not support reporting all IEs, the IE data structure is
225 * constructed of the IEs that are available. This field will also need to
226 * include SSID in IE format. All drivers are encouraged to be extended to
227 * report all IEs to make it easier to support future additions.
229 * This structure data is followed by ie_len octets of IEs from Probe Response
230 * frame (or if the driver does not indicate source of IEs, these may also be
231 * from Beacon frame). After the first set of IEs, another set of IEs may follow
232 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
234 struct wpa_scan_res {
246 size_t beacon_ie_len;
247 /* Followed by ie_len + beacon_ie_len octets of IE data */
251 * struct wpa_scan_results - Scan results
252 * @res: Array of pointers to allocated variable length scan result entries
253 * @num: Number of entries in the scan result array
254 * @fetch_time: Time when the results were fetched from the driver
256 struct wpa_scan_results {
257 struct wpa_scan_res **res;
259 struct os_reltime fetch_time;
263 * struct wpa_interface_info - Network interface information
264 * @next: Pointer to the next interface or NULL if this is the last one
265 * @ifname: Interface name that can be used with init() or init2()
266 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
268 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
269 * is not an allocated copy, i.e., get_interfaces() caller will not free
272 struct wpa_interface_info {
273 struct wpa_interface_info *next;
276 const char *drv_name;
279 #define WPAS_MAX_SCAN_SSIDS 16
282 * struct wpa_driver_scan_params - Scan parameters
283 * Data for struct wpa_driver_ops::scan2().
285 struct wpa_driver_scan_params {
287 * ssids - SSIDs to scan for
289 struct wpa_driver_scan_ssid {
291 * ssid - specific SSID to scan for (ProbeReq)
292 * %NULL or zero-length SSID is used to indicate active scan
293 * with wildcard SSID.
297 * ssid_len: Length of the SSID in octets
300 } ssids[WPAS_MAX_SCAN_SSIDS];
303 * num_ssids - Number of entries in ssids array
304 * Zero indicates a request for a passive scan.
309 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
314 * extra_ies_len - Length of extra_ies in octets
316 size_t extra_ies_len;
319 * freqs - Array of frequencies to scan or %NULL for all frequencies
321 * The frequency is set in MHz. The array is zero-terminated.
326 * filter_ssids - Filter for reporting SSIDs
328 * This optional parameter can be used to request the driver wrapper to
329 * filter scan results to include only the specified SSIDs. %NULL
330 * indicates that no filtering is to be done. This can be used to
331 * reduce memory needs for scan results in environments that have large
332 * number of APs with different SSIDs.
334 * The driver wrapper is allowed to take this allocated buffer into its
335 * own use by setting the pointer to %NULL. In that case, the driver
336 * wrapper is responsible for freeing the buffer with os_free() once it
337 * is not needed anymore.
339 struct wpa_driver_scan_filter {
345 * num_filter_ssids - Number of entries in filter_ssids array
347 size_t num_filter_ssids;
350 * filter_rssi - Filter by RSSI
352 * The driver may filter scan results in firmware to reduce host
353 * wakeups and thereby save power. Specify the RSSI threshold in s32
359 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
361 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
362 * Mbps from the support rates element(s) in the Probe Request frames
363 * and not to transmit the frames at any of those rates.
365 unsigned int p2p_probe:1;
368 * only_new_results - Request driver to report only new results
370 * This is used to request the driver to report only BSSes that have
371 * been detected after this scan request has been started, i.e., to
372 * flush old cached BSS entries.
374 unsigned int only_new_results:1;
377 * low_priority - Requests driver to use a lower scan priority
379 * This is used to request the driver to use a lower scan priority
380 * if it supports such a thing.
382 unsigned int low_priority:1;
385 * NOTE: Whenever adding new parameters here, please make sure
386 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
392 * struct wpa_driver_auth_params - Authentication parameters
393 * Data for struct wpa_driver_ops::authenticate().
395 struct wpa_driver_auth_params {
403 const u8 *wep_key[4];
404 size_t wep_key_len[4];
406 int local_state_change;
409 * p2p - Whether this connection is a P2P group
414 * sae_data - SAE elements for Authentication frame
416 * This buffer starts with the Authentication transaction sequence
417 * number field. If SAE is not used, this pointer is %NULL.
422 * sae_data_len - Length of sae_data buffer in octets
428 * enum wps_mode - WPS mode
432 * WPS_MODE_NONE - No WPS provisioning being used
437 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
442 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
448 * struct hostapd_freq_params - Channel parameters
450 struct hostapd_freq_params {
452 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
454 enum hostapd_hw_mode mode;
457 * freq - Primary channel center frequency in MHz
462 * channel - Channel number
467 * ht_enabled - Whether HT is enabled
472 * sec_channel_offset - Secondary channel offset for HT40
475 * -1 = HT40 enabled, secondary channel below primary,
476 * 1 = HT40 enabled, secondary channel above primary
478 int sec_channel_offset;
481 * vht_enabled - Whether VHT is enabled
486 * center_freq1 - Segment 0 center frequency in MHz
488 * Valid for both HT and VHT.
493 * center_freq2 - Segment 1 center frequency in MHz
495 * Non-zero only for bandwidth 80 and an 80+80 channel
500 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
506 * struct wpa_driver_associate_params - Association parameters
507 * Data for struct wpa_driver_ops::associate().
509 struct wpa_driver_associate_params {
511 * bssid - BSSID of the selected AP
512 * This can be %NULL, if ap_scan=2 mode is used and the driver is
513 * responsible for selecting with which BSS to associate. */
517 * bssid_hint - BSSID of a proposed AP
519 * This indicates which BSS has been found a suitable candidate for
520 * initial association for drivers that use driver/firmwate-based BSS
521 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
522 * the driver from selecting other BSSes in the ESS.
524 const u8 *bssid_hint;
527 * ssid - The selected SSID
532 * ssid_len - Length of the SSID (1..32)
537 * freq - channel parameters
539 struct hostapd_freq_params freq;
542 * freq_hint - Frequency of the channel the proposed AP is using
544 * This provides a channel on which a suitable BSS has been found as a
545 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
546 * limit the driver from selecting other channels for
547 * driver/firmware-based BSS selection.
552 * bg_scan_period - Background scan period in seconds, 0 to disable
553 * background scan, or -1 to indicate no change to default driver
559 * beacon_int - Beacon interval for IBSS or 0 to use driver default
564 * wpa_ie - WPA information element for (Re)Association Request
565 * WPA information element to be included in (Re)Association
566 * Request (including information element id and length). Use
567 * of this WPA IE is optional. If the driver generates the WPA
568 * IE, it can use pairwise_suite, group_suite, and
569 * key_mgmt_suite to select proper algorithms. In this case,
570 * the driver has to notify wpa_supplicant about the used WPA
571 * IE by generating an event that the interface code will
572 * convert into EVENT_ASSOCINFO data (see below).
574 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
575 * instead. The driver can determine which version is used by
576 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
579 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
584 * wpa_ie_len - length of the wpa_ie
589 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
591 unsigned int wpa_proto;
594 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
596 * This is usually ignored if @wpa_ie is used.
598 unsigned int pairwise_suite;
601 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
603 * This is usually ignored if @wpa_ie is used.
605 unsigned int group_suite;
608 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
610 * This is usually ignored if @wpa_ie is used.
612 unsigned int key_mgmt_suite;
615 * auth_alg - Allowed authentication algorithms
616 * Bit field of WPA_AUTH_ALG_*
621 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
626 * wep_key - WEP keys for static WEP configuration
628 const u8 *wep_key[4];
631 * wep_key_len - WEP key length for static WEP configuration
633 size_t wep_key_len[4];
636 * wep_tx_keyidx - WEP TX key index for static WEP configuration
641 * mgmt_frame_protection - IEEE 802.11w management frame protection
643 enum mfp_options mgmt_frame_protection;
646 * ft_ies - IEEE 802.11r / FT information elements
647 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
648 * for fast transition, this parameter is set to include the IEs that
649 * are to be sent in the next FT Authentication Request message.
650 * update_ft_ies() handler is called to update the IEs for further
651 * FT messages in the sequence.
653 * The driver should use these IEs only if the target AP is advertising
654 * the same mobility domain as the one included in the MDIE here.
656 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
657 * AP after the initial association. These IEs can only be used if the
658 * target AP is advertising support for FT and is using the same MDIE
659 * and SSID as the current AP.
661 * The driver is responsible for reporting the FT IEs received from the
662 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
663 * type. update_ft_ies() handler will then be called with the FT IEs to
664 * include in the next frame in the authentication sequence.
669 * ft_ies_len - Length of ft_ies in bytes
674 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
676 * This value is provided to allow the driver interface easier access
677 * to the current mobility domain. This value is set to %NULL if no
678 * mobility domain is currently active.
683 * passphrase - RSN passphrase for PSK
685 * This value is made available only for WPA/WPA2-Personal (PSK) and
686 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
687 * the 8..63 character ASCII passphrase, if available. Please note that
688 * this can be %NULL if passphrase was not used to generate the PSK. In
689 * that case, the psk field must be used to fetch the PSK.
691 const char *passphrase;
694 * psk - RSN PSK (alternative for passphrase for PSK)
696 * This value is made available only for WPA/WPA2-Personal (PSK) and
697 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
698 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
699 * be prepared to handle %NULL value as an error.
704 * drop_unencrypted - Enable/disable unencrypted frame filtering
706 * Configure the driver to drop all non-EAPOL frames (both receive and
707 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
708 * still be allowed for key negotiation.
710 int drop_unencrypted;
713 * prev_bssid - Previously used BSSID in this ESS
715 * When not %NULL, this is a request to use reassociation instead of
718 const u8 *prev_bssid;
723 * If the driver needs to do special configuration for WPS association,
724 * this variable provides more information on what type of association
725 * is being requested. Most drivers should not need ot use this.
730 * p2p - Whether this connection is a P2P group
735 * uapsd - UAPSD parameters for the network
736 * -1 = do not change defaults
737 * AP mode: 1 = enabled, 0 = disabled
738 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
743 * fixed_bssid - Whether to force this BSSID in IBSS mode
744 * 1 = Fix this BSSID and prevent merges.
745 * 0 = Do not fix BSSID.
750 * disable_ht - Disable HT (IEEE 802.11n) for this connection
755 * htcaps - HT Capabilities over-rides
757 * Only bits set in the mask will be used, and not all values are used
758 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
760 * Pointer to struct ieee80211_ht_capabilities.
765 * htcaps_mask - HT Capabilities over-rides mask
767 * Pointer to struct ieee80211_ht_capabilities.
769 const u8 *htcaps_mask;
771 #ifdef CONFIG_VHT_OVERRIDES
773 * disable_vht - Disable VHT for this connection
778 * VHT capability overrides.
780 const struct ieee80211_vht_capabilities *vhtcaps;
781 const struct ieee80211_vht_capabilities *vhtcaps_mask;
782 #endif /* CONFIG_VHT_OVERRIDES */
785 * req_key_mgmt_offload - Request key management offload for connection
787 * Request key management offload for this connection if the device
790 int req_key_mgmt_offload;
793 * Flag for indicating whether this association includes support for
794 * RRM (Radio Resource Measurements)
801 HIDDEN_SSID_ZERO_LEN,
802 HIDDEN_SSID_ZERO_CONTENTS
805 struct wowlan_triggers {
809 u8 gtk_rekey_failure;
811 u8 four_way_handshake;
815 struct wpa_driver_ap_params {
817 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
822 * head_len - Length of the head buffer in octets
827 * tail - Beacon tail following TIM IE
832 * tail_len - Length of the tail buffer in octets
837 * dtim_period - DTIM period
842 * beacon_int - Beacon interval
847 * basic_rates: -1 terminated array of basic rates in 100 kbps
849 * This parameter can be used to set a specific basic rate set for the
850 * BSS. If %NULL, default basic rate set is used.
855 * proberesp - Probe Response template
857 * This is used by drivers that reply to Probe Requests internally in
858 * AP mode and require the full Probe Response template.
863 * proberesp_len - Length of the proberesp buffer in octets
865 size_t proberesp_len;
868 * ssid - The SSID to use in Beacon/Probe Response frames
873 * ssid_len - Length of the SSID (1..32)
878 * hide_ssid - Whether to hide the SSID
880 enum hide_ssid hide_ssid;
883 * pairwise_ciphers - WPA_CIPHER_* bitfield
885 unsigned int pairwise_ciphers;
888 * group_cipher - WPA_CIPHER_*
890 unsigned int group_cipher;
893 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
895 unsigned int key_mgmt_suites;
898 * auth_algs - WPA_AUTH_ALG_* bitfield
900 unsigned int auth_algs;
903 * wpa_version - WPA_PROTO_* bitfield
905 unsigned int wpa_version;
908 * privacy - Whether privacy is used in the BSS
913 * beacon_ies - WPS/P2P IE(s) for Beacon frames
915 * This is used to add IEs like WPS IE and P2P IE by drivers that do
916 * not use the full Beacon template.
918 const struct wpabuf *beacon_ies;
921 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
923 * This is used to add IEs like WPS IE and P2P IE by drivers that
924 * reply to Probe Request frames internally.
926 const struct wpabuf *proberesp_ies;
929 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
931 * This is used to add IEs like WPS IE by drivers that reply to
932 * (Re)Association Request frames internally.
934 const struct wpabuf *assocresp_ies;
937 * isolate - Whether to isolate frames between associated stations
939 * If this is non-zero, the AP is requested to disable forwarding of
940 * frames between associated stations.
945 * cts_protect - Whether CTS protection is enabled
950 * preamble - Whether short preamble is enabled
955 * short_slot_time - Whether short slot time is enabled
957 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
958 * not set (e.g., when 802.11g mode is not in use)
963 * ht_opmode - HT operation mode or -1 if HT not in use
968 * interworking - Whether Interworking is enabled
973 * hessid - Homogeneous ESS identifier or %NULL if not set
978 * access_network_type - Access Network Type (0..15)
980 * This is used for filtering Probe Request frames when Interworking is
983 u8 access_network_type;
986 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
988 * This is used by driver which advertises this capability.
990 int ap_max_inactivity;
993 * smps_mode - SMPS mode
995 * SMPS mode to be used by the AP, specified as the relevant bits of
996 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
998 unsigned int smps_mode;
1001 * disable_dgaf - Whether group-addressed frames are disabled
1006 * osen - Whether OSEN security is enabled
1011 * freq - Channel parameters for dynamic bandwidth changes
1013 struct hostapd_freq_params *freq;
1016 struct wpa_driver_mesh_bss_params {
1017 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1019 * TODO: Other mesh configuration parameters would go here.
1020 * See NL80211_MESHCONF_* for all the mesh config parameters.
1025 struct wpa_driver_mesh_join_params {
1028 const int *basic_rates;
1034 enum ht_mode ht_mode;
1035 struct wpa_driver_mesh_bss_params conf;
1036 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1037 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1038 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1039 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1044 * struct wpa_driver_capa - Driver capability information
1046 struct wpa_driver_capa {
1047 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1048 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1049 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1050 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1051 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1052 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1053 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1054 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1055 /** Bitfield of supported key management suites */
1056 unsigned int key_mgmt;
1058 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1059 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1060 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1061 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1062 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1063 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1064 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1065 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1066 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1067 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1068 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1069 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1070 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1071 /** Bitfield of supported cipher suites */
1074 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1075 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1076 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1077 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1080 /** Driver generated WPA/RSN IE */
1081 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1082 /** Driver needs static WEP key setup after association command */
1083 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1084 /** Driver takes care of all DFS operations */
1085 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1086 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1087 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1088 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1089 /** Driver is for a wired Ethernet interface */
1090 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1091 /** Driver provides separate commands for authentication and association (SME in
1092 * wpa_supplicant). */
1093 #define WPA_DRIVER_FLAGS_SME 0x00000020
1094 /** Driver supports AP mode */
1095 #define WPA_DRIVER_FLAGS_AP 0x00000040
1096 /** Driver needs static WEP key setup after association has been completed */
1097 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1098 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1099 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1100 /** Driver supports concurrent P2P operations */
1101 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1103 * Driver uses the initial interface as a dedicated management interface, i.e.,
1104 * it cannot be used for P2P group operations or non-P2P purposes.
1106 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1107 /** This interface is P2P capable (P2P GO or P2P Client) */
1108 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1109 /** Driver supports station and key removal when stopping an AP */
1110 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1112 * Driver uses the initial interface for P2P management interface and non-P2P
1113 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1114 * P2P group operations.
1116 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1118 * Driver is known to use sane error codes, i.e., when it indicates that
1119 * something (e.g., association) fails, there was indeed a failure and the
1120 * operation does not end up getting completed successfully later.
1122 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1123 /** Driver supports off-channel TX */
1124 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1125 /** Driver indicates TX status events for EAPOL Data frames */
1126 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1127 /** Driver indicates TX status events for Deauth/Disassoc frames */
1128 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1129 /** Driver supports roaming (BSS selection) in firmware */
1130 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1131 /** Driver supports operating as a TDLS peer */
1132 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1133 /** Driver requires external TDLS setup/teardown/discovery */
1134 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1135 /** Driver indicates support for Probe Response offloading in AP mode */
1136 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1137 /** Driver supports U-APSD in AP mode */
1138 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1139 /** Driver supports inactivity timer in AP mode */
1140 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1141 /** Driver expects user space implementation of MLME in AP mode */
1142 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1143 /** Driver supports SAE with user space SME */
1144 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1145 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1146 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1147 /** Driver supports IBSS (Ad-hoc) mode */
1148 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1149 /** Driver supports radar detection */
1150 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1151 /** Driver supports a dedicated interface for P2P Device */
1152 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1153 /** Driver supports QoS Mapping */
1154 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1155 /** Driver supports CSA in AP mode */
1156 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1157 /** Driver supports mesh */
1158 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1159 /** Driver support ACS offload */
1160 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1161 /** Driver supports key management offload */
1162 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1165 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1166 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1167 unsigned int smps_modes;
1169 unsigned int wmm_ac_supported:1;
1171 /** Maximum number of supported active probe SSIDs */
1174 /** Maximum number of supported active probe SSIDs for sched_scan */
1175 int max_sched_scan_ssids;
1177 /** Whether sched_scan (offloaded scanning) is supported */
1178 int sched_scan_supported;
1180 /** Maximum number of supported match sets for sched_scan */
1184 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1186 unsigned int max_remain_on_chan;
1189 * max_stations - Maximum number of associated stations the driver
1190 * supports in AP mode
1192 unsigned int max_stations;
1195 * probe_resp_offloads - Bitmap of supported protocols by the driver
1196 * for Probe Response offloading.
1198 /** Driver Probe Response offloading support for WPS ver. 1 */
1199 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1200 /** Driver Probe Response offloading support for WPS ver. 2 */
1201 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1202 /** Driver Probe Response offloading support for P2P */
1203 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1204 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1205 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1206 unsigned int probe_resp_offloads;
1208 unsigned int max_acl_mac_addrs;
1211 * Number of supported concurrent channels
1213 unsigned int num_multichan_concurrent;
1216 * extended_capa - extended capabilities in driver/device
1218 * Must be allocated and freed by driver and the pointers must be
1219 * valid for the lifetime of the driver, i.e., freed in deinit()
1221 const u8 *extended_capa, *extended_capa_mask;
1222 unsigned int extended_capa_len;
1224 struct wowlan_triggers wowlan_triggers;
1226 /** Driver adds the DS Params Set IE in Probe Request frames */
1227 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1228 /** Driver adds the WFA TPC IE in Probe Request frames */
1229 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1230 /** Driver handles quiet period requests */
1231 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1233 * Driver is capable of inserting the current TX power value into the body of
1234 * transmitted frames.
1235 * Background: Some Action frames include a TPC Report IE. This IE contains a
1236 * TX power field, which has to be updated by lower layers. One such Action
1237 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1238 * of spectrum management). Note that this insertion takes place at a fixed
1239 * offset, namely the 6th byte in the Action frame body.
1241 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1246 struct hostapd_data;
1248 struct hostap_sta_driver_data {
1249 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1250 unsigned long current_tx_rate;
1251 unsigned long inactive_msec;
1252 unsigned long flags;
1253 unsigned long num_ps_buf_frames;
1254 unsigned long tx_retry_failed;
1255 unsigned long tx_retry_count;
1260 struct hostapd_sta_add_params {
1264 const u8 *supp_rates;
1265 size_t supp_rates_len;
1266 u16 listen_interval;
1267 const struct ieee80211_ht_capabilities *ht_capabilities;
1268 const struct ieee80211_vht_capabilities *vht_capabilities;
1269 int vht_opmode_enabled;
1271 u32 flags; /* bitmask of WPA_STA_* flags */
1272 u32 flags_mask; /* unset bits in flags */
1274 enum mesh_plink_state plink_state;
1275 #endif /* CONFIG_MESH */
1276 int set; /* Set STA parameters instead of add */
1278 const u8 *ext_capab;
1279 size_t ext_capab_len;
1280 const u8 *supp_channels;
1281 size_t supp_channels_len;
1282 const u8 *supp_oper_classes;
1283 size_t supp_oper_classes_len;
1286 struct mac_address {
1290 struct hostapd_acl_params {
1292 unsigned int num_mac_acl;
1293 struct mac_address mac_acl[0];
1296 enum wpa_driver_if_type {
1298 * WPA_IF_STATION - Station mode interface
1303 * WPA_IF_AP_VLAN - AP mode VLAN interface
1305 * This interface shares its address and Beacon frame with the main
1311 * WPA_IF_AP_BSS - AP mode BSS interface
1313 * This interface has its own address and Beacon frame.
1318 * WPA_IF_P2P_GO - P2P Group Owner
1323 * WPA_IF_P2P_CLIENT - P2P Client
1328 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1329 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1334 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1335 * abstracted P2P Device function in the driver
1340 * WPA_IF_MESH - Mesh interface
1345 struct wpa_init_params {
1349 const char *driver_params;
1350 int use_pae_group_addr;
1354 u8 *own_addr; /* buffer for writing own MAC address */
1358 struct wpa_bss_params {
1359 /** Interface name (for multi-SSID/VLAN support) */
1361 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1370 enum mfp_options ieee80211w;
1373 #define WPA_STA_AUTHORIZED BIT(0)
1374 #define WPA_STA_WMM BIT(1)
1375 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1376 #define WPA_STA_MFP BIT(3)
1377 #define WPA_STA_TDLS_PEER BIT(4)
1378 #define WPA_STA_AUTHENTICATED BIT(5)
1391 WNM_SLEEP_ENTER_CONFIRM,
1392 WNM_SLEEP_ENTER_FAIL,
1393 WNM_SLEEP_EXIT_CONFIRM,
1394 WNM_SLEEP_EXIT_FAIL,
1395 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1396 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1397 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1399 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1401 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1402 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1404 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1407 /* enum chan_width - Channel width definitions */
1419 * struct wpa_signal_info - Information about channel signal quality
1421 struct wpa_signal_info {
1423 int above_threshold;
1428 enum chan_width chanwidth;
1434 * struct beacon_data - Beacon data
1435 * @head: Head portion of Beacon frame (before TIM IE)
1436 * @tail: Tail portion of Beacon frame (after TIM IE)
1437 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1438 * @proberesp_ies: Extra information element(s) to add into Probe Response
1440 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1441 * Response frames or %NULL
1442 * @probe_resp: Probe Response frame template
1443 * @head_len: Length of @head
1444 * @tail_len: Length of @tail
1445 * @beacon_ies_len: Length of beacon_ies in octets
1446 * @proberesp_ies_len: Length of proberesp_ies in octets
1447 * @proberesp_ies_len: Length of proberesp_ies in octets
1448 * @probe_resp_len: Length of probe response template (@probe_resp)
1450 struct beacon_data {
1457 size_t head_len, tail_len;
1458 size_t beacon_ies_len;
1459 size_t proberesp_ies_len;
1460 size_t assocresp_ies_len;
1461 size_t probe_resp_len;
1465 * struct csa_settings - Settings for channel switch command
1466 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1467 * @block_tx: 1 - block transmission for CSA period
1468 * @freq_params: Next channel frequency parameter
1469 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1470 * @beacon_after: Next beacon/probe resp/asooc resp info
1471 * @counter_offset_beacon: Offset to the count field in beacon's tail
1472 * @counter_offset_presp: Offset to the count field in probe resp.
1474 struct csa_settings {
1478 struct hostapd_freq_params freq_params;
1479 struct beacon_data beacon_csa;
1480 struct beacon_data beacon_after;
1482 u16 counter_offset_beacon;
1483 u16 counter_offset_presp;
1486 /* TDLS peer capabilities for send_tdls_mgmt() */
1487 enum tdls_peer_capability {
1488 TDLS_PEER_HT = BIT(0),
1489 TDLS_PEER_VHT = BIT(1),
1490 TDLS_PEER_WMM = BIT(2),
1493 /* valid info in the wmm_params struct */
1494 enum wmm_params_valid_info {
1495 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1499 * struct wmm_params - WMM parameterss configured for this association
1500 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1501 * of the struct contain valid information.
1502 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1503 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1510 #ifdef CONFIG_MACSEC
1511 struct macsec_init_params {
1512 Boolean always_include_sci;
1516 #endif /* CONFIG_MACSEC */
1518 enum drv_br_port_attr {
1519 DRV_BR_PORT_ATTR_PROXYARP,
1520 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1523 enum drv_br_net_param {
1524 DRV_BR_NET_PARAM_GARP_ACCEPT,
1527 struct drv_acs_params {
1528 /* Selected mode (HOSTAPD_MODE_*) */
1529 enum hostapd_hw_mode hw_mode;
1531 /* Indicates whether HT is enabled */
1534 /* Indicates whether HT40 is enabled */
1540 * struct wpa_driver_ops - Driver interface API definition
1542 * This structure defines the API that each driver interface needs to implement
1543 * for core wpa_supplicant code. All driver specific functionality is captured
1546 struct wpa_driver_ops {
1547 /** Name of the driver interface */
1549 /** One line description of the driver interface */
1553 * get_bssid - Get the current BSSID
1554 * @priv: private driver interface data
1555 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1557 * Returns: 0 on success, -1 on failure
1559 * Query kernel driver for the current BSSID and copy it to bssid.
1560 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1563 int (*get_bssid)(void *priv, u8 *bssid);
1566 * get_ssid - Get the current SSID
1567 * @priv: private driver interface data
1568 * @ssid: buffer for SSID (at least 32 bytes)
1570 * Returns: Length of the SSID on success, -1 on failure
1572 * Query kernel driver for the current SSID and copy it to ssid.
1573 * Returning zero is recommended if the STA is not associated.
1575 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1576 * can, at least in theory, contain control characters (including nul)
1577 * and as such, should be processed as binary data, not a printable
1580 int (*get_ssid)(void *priv, u8 *ssid);
1583 * set_key - Configure encryption key
1584 * @ifname: Interface name (for multi-SSID/VLAN support)
1585 * @priv: private driver interface data
1586 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1587 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1588 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1589 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1590 * %WPA_ALG_BIP_CMAC_256);
1591 * %WPA_ALG_NONE clears the key.
1592 * @addr: Address of the peer STA (BSSID of the current AP when setting
1593 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1594 * broadcast keys, %NULL for default keys that are used both for
1595 * broadcast and unicast; when clearing keys, %NULL is used to
1596 * indicate that both the broadcast-only and default key of the
1597 * specified key index is to be cleared
1598 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1600 * @set_tx: configure this key as the default Tx key (only used when
1601 * driver does not support separate unicast/individual key
1602 * @seq: sequence number/packet number, seq_len octets, the next
1603 * packet number to be used for in replay protection; configured
1604 * for Rx keys (in most cases, this is only used with broadcast
1605 * keys and set to zero for unicast keys); %NULL if not set
1606 * @seq_len: length of the seq, depends on the algorithm:
1607 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1608 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1610 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1611 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1613 * Returns: 0 on success, -1 on failure
1615 * Configure the given key for the kernel driver. If the driver
1616 * supports separate individual keys (4 default keys + 1 individual),
1617 * addr can be used to determine whether the key is default or
1618 * individual. If only 4 keys are supported, the default key with key
1619 * index 0 is used as the individual key. STA must be configured to use
1620 * it as the default Tx key (set_tx is set) and accept Rx for all the
1621 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1622 * broadcast keys, so key index 0 is available for this kind of
1625 * Please note that TKIP keys include separate TX and RX MIC keys and
1626 * some drivers may expect them in different order than wpa_supplicant
1627 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1628 * will trigger Michael MIC errors. This can be fixed by changing the
1629 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1630 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1631 * example on how this can be done.
1633 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1634 const u8 *addr, int key_idx, int set_tx,
1635 const u8 *seq, size_t seq_len,
1636 const u8 *key, size_t key_len);
1639 * init - Initialize driver interface
1640 * @ctx: context to be used when calling wpa_supplicant functions,
1641 * e.g., wpa_supplicant_event()
1642 * @ifname: interface name, e.g., wlan0
1644 * Returns: Pointer to private data, %NULL on failure
1646 * Initialize driver interface, including event processing for kernel
1647 * driver events (e.g., associated, scan results, Michael MIC failure).
1648 * This function can allocate a private configuration data area for
1649 * @ctx, file descriptor, interface name, etc. information that may be
1650 * needed in future driver operations. If this is not used, non-NULL
1651 * value will need to be returned because %NULL is used to indicate
1652 * failure. The returned value will be used as 'void *priv' data for
1653 * all other driver_ops functions.
1655 * The main event loop (eloop.c) of wpa_supplicant can be used to
1656 * register callback for read sockets (eloop_register_read_sock()).
1658 * See below for more information about events and
1659 * wpa_supplicant_event() function.
1661 void * (*init)(void *ctx, const char *ifname);
1664 * deinit - Deinitialize driver interface
1665 * @priv: private driver interface data from init()
1667 * Shut down driver interface and processing of driver events. Free
1668 * private data buffer if one was allocated in init() handler.
1670 void (*deinit)(void *priv);
1673 * set_param - Set driver configuration parameters
1674 * @priv: private driver interface data from init()
1675 * @param: driver specific configuration parameters
1677 * Returns: 0 on success, -1 on failure
1679 * Optional handler for notifying driver interface about configuration
1680 * parameters (driver_param).
1682 int (*set_param)(void *priv, const char *param);
1685 * set_countermeasures - Enable/disable TKIP countermeasures
1686 * @priv: private driver interface data
1687 * @enabled: 1 = countermeasures enabled, 0 = disabled
1689 * Returns: 0 on success, -1 on failure
1691 * Configure TKIP countermeasures. When these are enabled, the driver
1692 * should drop all received and queued frames that are using TKIP.
1694 int (*set_countermeasures)(void *priv, int enabled);
1697 * deauthenticate - Request driver to deauthenticate
1698 * @priv: private driver interface data
1699 * @addr: peer address (BSSID of the AP)
1700 * @reason_code: 16-bit reason code to be sent in the deauthentication
1703 * Returns: 0 on success, -1 on failure
1705 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1708 * associate - Request driver to associate
1709 * @priv: private driver interface data
1710 * @params: association parameters
1712 * Returns: 0 on success, -1 on failure
1714 int (*associate)(void *priv,
1715 struct wpa_driver_associate_params *params);
1718 * add_pmkid - Add PMKSA cache entry to the driver
1719 * @priv: private driver interface data
1720 * @bssid: BSSID for the PMKSA cache entry
1721 * @pmkid: PMKID for the PMKSA cache entry
1723 * Returns: 0 on success, -1 on failure
1725 * This function is called when a new PMK is received, as a result of
1726 * either normal authentication or RSN pre-authentication.
1728 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1729 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1730 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1731 * driver_ops function does not need to be implemented. Likewise, if
1732 * the driver does not support WPA, this function is not needed.
1734 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1737 * remove_pmkid - Remove PMKSA cache entry to the driver
1738 * @priv: private driver interface data
1739 * @bssid: BSSID for the PMKSA cache entry
1740 * @pmkid: PMKID for the PMKSA cache entry
1742 * Returns: 0 on success, -1 on failure
1744 * This function is called when the supplicant drops a PMKSA cache
1745 * entry for any reason.
1747 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1748 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1749 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1750 * from wpa_supplicant, this driver_ops function does not need to be
1751 * implemented. Likewise, if the driver does not support WPA, this
1752 * function is not needed.
1754 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1757 * flush_pmkid - Flush PMKSA cache
1758 * @priv: private driver interface data
1760 * Returns: 0 on success, -1 on failure
1762 * This function is called when the supplicant drops all PMKSA cache
1763 * entries for any reason.
1765 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1766 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1767 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1768 * from wpa_supplicant, this driver_ops function does not need to be
1769 * implemented. Likewise, if the driver does not support WPA, this
1770 * function is not needed.
1772 int (*flush_pmkid)(void *priv);
1775 * get_capa - Get driver capabilities
1776 * @priv: private driver interface data
1778 * Returns: 0 on success, -1 on failure
1780 * Get driver/firmware/hardware capabilities.
1782 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1785 * poll - Poll driver for association information
1786 * @priv: private driver interface data
1788 * This is an option callback that can be used when the driver does not
1789 * provide event mechanism for association events. This is called when
1790 * receiving WPA EAPOL-Key messages that require association
1791 * information. The driver interface is supposed to generate associnfo
1792 * event before returning from this callback function. In addition, the
1793 * driver interface should generate an association event after having
1794 * sent out associnfo.
1796 void (*poll)(void *priv);
1799 * get_ifname - Get interface name
1800 * @priv: private driver interface data
1802 * Returns: Pointer to the interface name. This can differ from the
1803 * interface name used in init() call. Init() is called first.
1805 * This optional function can be used to allow the driver interface to
1806 * replace the interface name with something else, e.g., based on an
1807 * interface mapping from a more descriptive name.
1809 const char * (*get_ifname)(void *priv);
1812 * get_mac_addr - Get own MAC address
1813 * @priv: private driver interface data
1815 * Returns: Pointer to own MAC address or %NULL on failure
1817 * This optional function can be used to get the own MAC address of the
1818 * device from the driver interface code. This is only needed if the
1819 * l2_packet implementation for the OS does not provide easy access to
1821 const u8 * (*get_mac_addr)(void *priv);
1824 * set_operstate - Sets device operating state to DORMANT or UP
1825 * @priv: private driver interface data
1826 * @state: 0 = dormant, 1 = up
1827 * Returns: 0 on success, -1 on failure
1829 * This is an optional function that can be used on operating systems
1830 * that support a concept of controlling network device state from user
1831 * space applications. This function, if set, gets called with
1832 * state = 1 when authentication has been completed and with state = 0
1833 * when connection is lost.
1835 int (*set_operstate)(void *priv, int state);
1838 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1839 * @priv: Private driver interface data
1840 * @addr: Address of the station for which to set protection (may be
1841 * %NULL for group keys)
1842 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1843 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1844 * Returns: 0 on success, -1 on failure
1846 * This is an optional function that can be used to set the driver to
1847 * require protection for Tx and/or Rx frames. This uses the layer
1848 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1849 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1850 * set protection operation; instead, they set protection implicitly
1851 * based on configured keys.
1853 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1857 * get_hw_feature_data - Get hardware support data (channels and rates)
1858 * @priv: Private driver interface data
1859 * @num_modes: Variable for returning the number of returned modes
1860 * flags: Variable for returning hardware feature flags
1861 * Returns: Pointer to allocated hardware data on success or %NULL on
1862 * failure. Caller is responsible for freeing this.
1864 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1869 * send_mlme - Send management frame from MLME
1870 * @priv: Private driver interface data
1871 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1872 * @data_len: Size of the management frame
1873 * @noack: Do not wait for this frame to be acked (disable retries)
1874 * Returns: 0 on success, -1 on failure
1876 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1880 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1881 * @priv: Private driver interface data
1882 * @md: Mobility domain (2 octets) (also included inside ies)
1883 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1884 * @ies_len: Length of FT IEs in bytes
1885 * Returns: 0 on success, -1 on failure
1887 * The supplicant uses this callback to let the driver know that keying
1888 * material for FT is available and that the driver can use the
1889 * provided IEs in the next message in FT authentication sequence.
1891 * This function is only needed for driver that support IEEE 802.11r
1892 * (Fast BSS Transition).
1894 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1898 * get_scan_results2 - Fetch the latest scan results
1899 * @priv: private driver interface data
1901 * Returns: Allocated buffer of scan results (caller is responsible for
1902 * freeing the data structure) on success, NULL on failure
1904 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1907 * set_country - Set country
1908 * @priv: Private driver interface data
1909 * @alpha2: country to which to switch to
1910 * Returns: 0 on success, -1 on failure
1912 * This function is for drivers which support some form
1913 * of setting a regulatory domain.
1915 int (*set_country)(void *priv, const char *alpha2);
1918 * get_country - Get country
1919 * @priv: Private driver interface data
1920 * @alpha2: Buffer for returning country code (at least 3 octets)
1921 * Returns: 0 on success, -1 on failure
1923 int (*get_country)(void *priv, char *alpha2);
1926 * global_init - Global driver initialization
1927 * Returns: Pointer to private data (global), %NULL on failure
1929 * This optional function is called to initialize the driver wrapper
1930 * for global data, i.e., data that applies to all interfaces. If this
1931 * function is implemented, global_deinit() will also need to be
1932 * implemented to free the private data. The driver will also likely
1933 * use init2() function instead of init() to get the pointer to global
1934 * data available to per-interface initializer.
1936 void * (*global_init)(void);
1939 * global_deinit - Global driver deinitialization
1940 * @priv: private driver global data from global_init()
1942 * Terminate any global driver related functionality and free the
1943 * global data structure.
1945 void (*global_deinit)(void *priv);
1948 * init2 - Initialize driver interface (with global data)
1949 * @ctx: context to be used when calling wpa_supplicant functions,
1950 * e.g., wpa_supplicant_event()
1951 * @ifname: interface name, e.g., wlan0
1952 * @global_priv: private driver global data from global_init()
1953 * Returns: Pointer to private data, %NULL on failure
1955 * This function can be used instead of init() if the driver wrapper
1958 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1961 * get_interfaces - Get information about available interfaces
1962 * @global_priv: private driver global data from global_init()
1963 * Returns: Allocated buffer of interface information (caller is
1964 * responsible for freeing the data structure) on success, NULL on
1967 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1970 * scan2 - Request the driver to initiate scan
1971 * @priv: private driver interface data
1972 * @params: Scan parameters
1974 * Returns: 0 on success, -1 on failure
1976 * Once the scan results are ready, the driver should report scan
1977 * results event for wpa_supplicant which will eventually request the
1978 * results with wpa_driver_get_scan_results2().
1980 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1983 * authenticate - Request driver to authenticate
1984 * @priv: private driver interface data
1985 * @params: authentication parameters
1986 * Returns: 0 on success, -1 on failure
1988 * This is an optional function that can be used with drivers that
1989 * support separate authentication and association steps, i.e., when
1990 * wpa_supplicant can act as the SME. If not implemented, associate()
1991 * function is expected to take care of IEEE 802.11 authentication,
1994 int (*authenticate)(void *priv,
1995 struct wpa_driver_auth_params *params);
1998 * set_ap - Set Beacon and Probe Response information for AP mode
1999 * @priv: Private driver interface data
2000 * @params: Parameters to use in AP mode
2002 * This function is used to configure Beacon template and/or extra IEs
2003 * to add for Beacon and Probe Response frames for the driver in
2004 * AP mode. The driver is responsible for building the full Beacon
2005 * frame by concatenating the head part with TIM IE generated by the
2006 * driver/firmware and finishing with the tail part. Depending on the
2007 * driver architectue, this can be done either by using the full
2008 * template or the set of additional IEs (e.g., WPS and P2P IE).
2009 * Similarly, Probe Response processing depends on the driver design.
2010 * If the driver (or firmware) takes care of replying to Probe Request
2011 * frames, the extra IEs provided here needs to be added to the Probe
2014 * Returns: 0 on success, -1 on failure
2016 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
2019 * set_acl - Set ACL in AP mode
2020 * @priv: Private driver interface data
2021 * @params: Parameters to configure ACL
2022 * Returns: 0 on success, -1 on failure
2024 * This is used only for the drivers which support MAC address ACL.
2026 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2029 * hapd_init - Initialize driver interface (hostapd only)
2030 * @hapd: Pointer to hostapd context
2031 * @params: Configuration for the driver wrapper
2032 * Returns: Pointer to private data, %NULL on failure
2034 * This function is used instead of init() or init2() when the driver
2035 * wrapper is used with hostapd.
2037 void * (*hapd_init)(struct hostapd_data *hapd,
2038 struct wpa_init_params *params);
2041 * hapd_deinit - Deinitialize driver interface (hostapd only)
2042 * @priv: Private driver interface data from hapd_init()
2044 void (*hapd_deinit)(void *priv);
2047 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2048 * @priv: Private driver interface data
2049 * @params: BSS parameters
2050 * Returns: 0 on success, -1 on failure
2052 * This is an optional function to configure the kernel driver to
2053 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2054 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2055 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2056 * for Beacon frames.
2058 * DEPRECATED - use set_ap() instead
2060 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2063 * set_privacy - Enable/disable privacy (AP only)
2064 * @priv: Private driver interface data
2065 * @enabled: 1 = privacy enabled, 0 = disabled
2066 * Returns: 0 on success, -1 on failure
2068 * This is an optional function to configure privacy field in the
2069 * kernel driver for Beacon frames. This can be left undefined (set to
2070 * %NULL) if the driver uses the Beacon template from set_ap().
2072 * DEPRECATED - use set_ap() instead
2074 int (*set_privacy)(void *priv, int enabled);
2077 * get_seqnum - Fetch the current TSC/packet number (AP only)
2078 * @ifname: The interface name (main or virtual)
2079 * @priv: Private driver interface data
2080 * @addr: MAC address of the station or %NULL for group keys
2082 * @seq: Buffer for returning the latest used TSC/packet number
2083 * Returns: 0 on success, -1 on failure
2085 * This function is used to fetch the last used TSC/packet number for
2086 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2087 * keys, so there is no strict requirement on implementing support for
2088 * unicast keys (i.e., addr != %NULL).
2090 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2094 * flush - Flush all association stations (AP only)
2095 * @priv: Private driver interface data
2096 * Returns: 0 on success, -1 on failure
2098 * This function requests the driver to disassociate all associated
2099 * stations. This function does not need to be implemented if the
2100 * driver does not process association frames internally.
2102 int (*flush)(void *priv);
2105 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2106 * @priv: Private driver interface data
2107 * @elem: Information elements
2108 * @elem_len: Length of the elem buffer in octets
2109 * Returns: 0 on success, -1 on failure
2111 * This is an optional function to add information elements in the
2112 * kernel driver for Beacon and Probe Response frames. This can be left
2113 * undefined (set to %NULL) if the driver uses the Beacon template from
2116 * DEPRECATED - use set_ap() instead
2118 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2121 * read_sta_data - Fetch station data
2122 * @priv: Private driver interface data
2123 * @data: Buffer for returning station information
2124 * @addr: MAC address of the station
2125 * Returns: 0 on success, -1 on failure
2127 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2131 * hapd_send_eapol - Send an EAPOL packet (AP only)
2132 * @priv: private driver interface data
2133 * @addr: Destination MAC address
2134 * @data: EAPOL packet starting with IEEE 802.1X header
2135 * @data_len: Length of the EAPOL packet in octets
2136 * @encrypt: Whether the frame should be encrypted
2137 * @own_addr: Source MAC address
2138 * @flags: WPA_STA_* flags for the destination station
2140 * Returns: 0 on success, -1 on failure
2142 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2143 size_t data_len, int encrypt,
2144 const u8 *own_addr, u32 flags);
2147 * sta_deauth - Deauthenticate a station (AP only)
2148 * @priv: Private driver interface data
2149 * @own_addr: Source address and BSSID for the Deauthentication frame
2150 * @addr: MAC address of the station to deauthenticate
2151 * @reason: Reason code for the Deauthentiation frame
2152 * Returns: 0 on success, -1 on failure
2154 * This function requests a specific station to be deauthenticated and
2155 * a Deauthentication frame to be sent to it.
2157 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2161 * sta_disassoc - Disassociate a station (AP only)
2162 * @priv: Private driver interface data
2163 * @own_addr: Source address and BSSID for the Disassociation frame
2164 * @addr: MAC address of the station to disassociate
2165 * @reason: Reason code for the Disassociation frame
2166 * Returns: 0 on success, -1 on failure
2168 * This function requests a specific station to be disassociated and
2169 * a Disassociation frame to be sent to it.
2171 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2175 * sta_remove - Remove a station entry (AP only)
2176 * @priv: Private driver interface data
2177 * @addr: MAC address of the station to be removed
2178 * Returns: 0 on success, -1 on failure
2180 int (*sta_remove)(void *priv, const u8 *addr);
2183 * hapd_get_ssid - Get the current SSID (AP only)
2184 * @priv: Private driver interface data
2185 * @buf: Buffer for returning the SSID
2186 * @len: Maximum length of the buffer
2187 * Returns: Length of the SSID on success, -1 on failure
2189 * This function need not be implemented if the driver uses Beacon
2190 * template from set_ap() and does not reply to Probe Request frames.
2192 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2195 * hapd_set_ssid - Set SSID (AP only)
2196 * @priv: Private driver interface data
2198 * @len: Length of the SSID in octets
2199 * Returns: 0 on success, -1 on failure
2201 * DEPRECATED - use set_ap() instead
2203 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2206 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2207 * @priv: Private driver interface data
2208 * @enabled: 1 = countermeasures enabled, 0 = disabled
2209 * Returns: 0 on success, -1 on failure
2211 * This need not be implemented if the driver does not take care of
2212 * association processing.
2214 int (*hapd_set_countermeasures)(void *priv, int enabled);
2217 * sta_add - Add a station entry
2218 * @priv: Private driver interface data
2219 * @params: Station parameters
2220 * Returns: 0 on success, -1 on failure
2222 * This function is used to add a station entry to the driver once the
2223 * station has completed association. This is only used if the driver
2224 * does not take care of association processing.
2226 * With TDLS, this function is also used to add or set (params->set 1)
2227 * TDLS peer entries.
2229 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2232 * get_inact_sec - Get station inactivity duration (AP only)
2233 * @priv: Private driver interface data
2234 * @addr: Station address
2235 * Returns: Number of seconds station has been inactive, -1 on failure
2237 int (*get_inact_sec)(void *priv, const u8 *addr);
2240 * sta_clear_stats - Clear station statistics (AP only)
2241 * @priv: Private driver interface data
2242 * @addr: Station address
2243 * Returns: 0 on success, -1 on failure
2245 int (*sta_clear_stats)(void *priv, const u8 *addr);
2248 * set_freq - Set channel/frequency (AP only)
2249 * @priv: Private driver interface data
2250 * @freq: Channel parameters
2251 * Returns: 0 on success, -1 on failure
2253 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2256 * set_rts - Set RTS threshold
2257 * @priv: Private driver interface data
2258 * @rts: RTS threshold in octets
2259 * Returns: 0 on success, -1 on failure
2261 int (*set_rts)(void *priv, int rts);
2264 * set_frag - Set fragmentation threshold
2265 * @priv: Private driver interface data
2266 * @frag: Fragmentation threshold in octets
2267 * Returns: 0 on success, -1 on failure
2269 int (*set_frag)(void *priv, int frag);
2272 * sta_set_flags - Set station flags (AP only)
2273 * @priv: Private driver interface data
2274 * @addr: Station address
2275 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2276 * @flags_or: Bitmap of WPA_STA_* flags to add
2277 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2278 * Returns: 0 on success, -1 on failure
2280 int (*sta_set_flags)(void *priv, const u8 *addr,
2281 int total_flags, int flags_or, int flags_and);
2284 * set_tx_queue_params - Set TX queue parameters
2285 * @priv: Private driver interface data
2286 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2290 * @burst_time: Maximum length for bursting in 0.1 msec units
2292 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2293 int cw_max, int burst_time);
2296 * if_add - Add a virtual interface
2297 * @priv: Private driver interface data
2298 * @type: Interface type
2299 * @ifname: Interface name for the new virtual interface
2300 * @addr: Local address to use for the interface or %NULL to use the
2301 * parent interface address
2302 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2303 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2304 * not allowed (applies only to %WPA_IF_AP_BSS type)
2305 * @force_ifname: Buffer for returning an interface name that the
2306 * driver ended up using if it differs from the requested ifname
2307 * @if_addr: Buffer for returning the allocated interface address
2308 * (this may differ from the requested addr if the driver cannot
2309 * change interface address)
2310 * @bridge: Bridge interface to use or %NULL if no bridge configured
2311 * @use_existing: Whether to allow existing interface to be used
2312 * Returns: 0 on success, -1 on failure
2314 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2315 const char *ifname, const u8 *addr, void *bss_ctx,
2316 void **drv_priv, char *force_ifname, u8 *if_addr,
2317 const char *bridge, int use_existing);
2320 * if_remove - Remove a virtual interface
2321 * @priv: Private driver interface data
2322 * @type: Interface type
2323 * @ifname: Interface name of the virtual interface to be removed
2324 * Returns: 0 on success, -1 on failure
2326 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2327 const char *ifname);
2330 * set_sta_vlan - Bind a station into a specific interface (AP only)
2331 * @priv: Private driver interface data
2332 * @ifname: Interface (main or virtual BSS or VLAN)
2333 * @addr: MAC address of the associated station
2335 * Returns: 0 on success, -1 on failure
2337 * This function is used to bind a station to a specific virtual
2338 * interface. It is only used if when virtual interfaces are supported,
2339 * e.g., to assign stations to different VLAN interfaces based on
2340 * information from a RADIUS server. This allows separate broadcast
2341 * domains to be used with a single BSS.
2343 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2347 * commit - Optional commit changes handler (AP only)
2348 * @priv: driver private data
2349 * Returns: 0 on success, -1 on failure
2351 * This optional handler function can be registered if the driver
2352 * interface implementation needs to commit changes (e.g., by setting
2353 * network interface up) at the end of initial configuration. If set,
2354 * this handler will be called after initial setup has been completed.
2356 int (*commit)(void *priv);
2359 * send_ether - Send an ethernet packet (AP only)
2360 * @priv: private driver interface data
2361 * @dst: Destination MAC address
2362 * @src: Source MAC address
2364 * @data: EAPOL packet starting with IEEE 802.1X header
2365 * @data_len: Length of the EAPOL packet in octets
2366 * Returns: 0 on success, -1 on failure
2368 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2369 const u8 *data, size_t data_len);
2372 * set_radius_acl_auth - Notification of RADIUS ACL change
2373 * @priv: Private driver interface data
2374 * @mac: MAC address of the station
2375 * @accepted: Whether the station was accepted
2376 * @session_timeout: Session timeout for the station
2377 * Returns: 0 on success, -1 on failure
2379 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2380 u32 session_timeout);
2383 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2384 * @priv: Private driver interface data
2385 * @mac: MAC address of the station
2386 * Returns: 0 on success, -1 on failure
2388 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2391 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2392 * @priv: Private driver interface data
2393 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2394 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2396 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2397 * to remove extra IE(s)
2398 * Returns: 0 on success, -1 on failure
2400 * This is an optional function to add WPS IE in the kernel driver for
2401 * Beacon and Probe Response frames. This can be left undefined (set
2402 * to %NULL) if the driver uses the Beacon template from set_ap()
2403 * and does not process Probe Request frames. If the driver takes care
2404 * of (Re)Association frame processing, the assocresp buffer includes
2405 * WPS IE(s) that need to be added to (Re)Association Response frames
2406 * whenever a (Re)Association Request frame indicated use of WPS.
2408 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2409 * frames when operating as a GO. The driver is responsible for adding
2410 * timing related attributes (e.g., NoA) in addition to the IEs
2411 * included here by appending them after these buffers. This call is
2412 * also used to provide Probe Response IEs for P2P Listen state
2413 * operations for drivers that generate the Probe Response frames
2416 * DEPRECATED - use set_ap() instead
2418 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2419 const struct wpabuf *proberesp,
2420 const struct wpabuf *assocresp);
2423 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2424 * @priv: Private driver interface data
2425 * @authorized: Whether the port is authorized
2426 * Returns: 0 on success, -1 on failure
2428 int (*set_supp_port)(void *priv, int authorized);
2431 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2432 * @priv: Private driver interface data
2433 * @addr: MAC address of the associated station
2434 * @aid: Association ID
2435 * @val: 1 = bind to 4-address WDS; 0 = unbind
2436 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2437 * to indicate that bridge is not to be used
2438 * @ifname_wds: Buffer to return the interface name for the new WDS
2439 * station or %NULL to indicate name is not returned.
2440 * Returns: 0 on success, -1 on failure
2442 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2443 const char *bridge_ifname, char *ifname_wds);
2446 * send_action - Transmit an Action frame
2447 * @priv: Private driver interface data
2448 * @freq: Frequency (in MHz) of the channel
2449 * @wait: Time to wait off-channel for a response (in ms), or zero
2450 * @dst: Destination MAC address (Address 1)
2451 * @src: Source MAC address (Address 2)
2452 * @bssid: BSSID (Address 3)
2454 * @data_len: data length in octets
2455 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2456 * Returns: 0 on success, -1 on failure
2458 * This command can be used to request the driver to transmit an action
2459 * frame to the specified destination.
2461 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2462 * be transmitted on the given channel and the device will wait for a
2463 * response on that channel for the given wait time.
2465 * If the flag is not set, the wait time will be ignored. In this case,
2466 * if a remain-on-channel duration is in progress, the frame must be
2467 * transmitted on that channel; alternatively the frame may be sent on
2468 * the current operational channel (if in associated state in station
2469 * mode or while operating as an AP.)
2471 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2472 const u8 *dst, const u8 *src, const u8 *bssid,
2473 const u8 *data, size_t data_len, int no_cck);
2476 * send_action_cancel_wait - Cancel action frame TX wait
2477 * @priv: Private driver interface data
2479 * This command cancels the wait time associated with sending an action
2480 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2481 * set in the driver flags.
2483 void (*send_action_cancel_wait)(void *priv);
2486 * remain_on_channel - Remain awake on a channel
2487 * @priv: Private driver interface data
2488 * @freq: Frequency (in MHz) of the channel
2489 * @duration: Duration in milliseconds
2490 * Returns: 0 on success, -1 on failure
2492 * This command is used to request the driver to remain awake on the
2493 * specified channel for the specified duration and report received
2494 * Action frames with EVENT_RX_MGMT events. Optionally, received
2495 * Probe Request frames may also be requested to be reported by calling
2496 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2498 * The driver may not be at the requested channel when this function
2499 * returns, i.e., the return code is only indicating whether the
2500 * request was accepted. The caller will need to wait until the
2501 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2502 * completed the channel change. This may take some time due to other
2503 * need for the radio and the caller should be prepared to timing out
2504 * its wait since there are no guarantees on when this request can be
2507 int (*remain_on_channel)(void *priv, unsigned int freq,
2508 unsigned int duration);
2511 * cancel_remain_on_channel - Cancel remain-on-channel operation
2512 * @priv: Private driver interface data
2514 * This command can be used to cancel a remain-on-channel operation
2515 * before its originally requested duration has passed. This could be
2516 * used, e.g., when remain_on_channel() is used to request extra time
2517 * to receive a response to an Action frame and the response is
2518 * received when there is still unneeded time remaining on the
2519 * remain-on-channel operation.
2521 int (*cancel_remain_on_channel)(void *priv);
2524 * probe_req_report - Request Probe Request frames to be indicated
2525 * @priv: Private driver interface data
2526 * @report: Whether to report received Probe Request frames
2527 * Returns: 0 on success, -1 on failure (or if not supported)
2529 * This command can be used to request the driver to indicate when
2530 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2531 * Since this operation may require extra resources, e.g., due to less
2532 * optimal hardware/firmware RX filtering, many drivers may disable
2533 * Probe Request reporting at least in station mode. This command is
2534 * used to notify the driver when the Probe Request frames need to be
2535 * reported, e.g., during remain-on-channel operations.
2537 int (*probe_req_report)(void *priv, int report);
2540 * deinit_ap - Deinitialize AP mode
2541 * @priv: Private driver interface data
2542 * Returns: 0 on success, -1 on failure (or if not supported)
2544 * This optional function can be used to disable AP mode related
2545 * configuration. If the interface was not dynamically added,
2546 * change the driver mode to station mode to allow normal station
2547 * operations like scanning to be completed.
2549 int (*deinit_ap)(void *priv);
2552 * deinit_p2p_cli - Deinitialize P2P client mode
2553 * @priv: Private driver interface data
2554 * Returns: 0 on success, -1 on failure (or if not supported)
2556 * This optional function can be used to disable P2P client mode. If the
2557 * interface was not dynamically added, change the interface type back
2560 int (*deinit_p2p_cli)(void *priv);
2563 * suspend - Notification on system suspend/hibernate event
2564 * @priv: Private driver interface data
2566 void (*suspend)(void *priv);
2569 * resume - Notification on system resume/thaw event
2570 * @priv: Private driver interface data
2572 void (*resume)(void *priv);
2575 * signal_monitor - Set signal monitoring parameters
2576 * @priv: Private driver interface data
2577 * @threshold: Threshold value for signal change events; 0 = disabled
2578 * @hysteresis: Minimum change in signal strength before indicating a
2580 * Returns: 0 on success, -1 on failure (or if not supported)
2582 * This function can be used to configure monitoring of signal strength
2583 * with the current AP. Whenever signal strength drops below the
2584 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2585 * should be generated assuming the signal strength has changed at
2586 * least %hysteresis from the previously indicated signal change event.
2588 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2591 * send_frame - Send IEEE 802.11 frame (testing use only)
2592 * @priv: Private driver interface data
2593 * @data: IEEE 802.11 frame with IEEE 802.11 header
2594 * @data_len: Size of the frame
2595 * @encrypt: Whether to encrypt the frame (if keys are set)
2596 * Returns: 0 on success, -1 on failure
2598 * This function is only used for debugging purposes and is not
2599 * required to be implemented for normal operations.
2601 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2605 * shared_freq - Get operating frequency of shared interface(s)
2606 * @priv: Private driver interface data
2607 * Returns: Operating frequency in MHz, 0 if no shared operation in
2608 * use, or -1 on failure
2610 * This command can be used to request the current operating frequency
2611 * of any virtual interface that shares the same radio to provide
2612 * information for channel selection for other virtual interfaces.
2614 int (*shared_freq)(void *priv);
2617 * get_noa - Get current Notice of Absence attribute payload
2618 * @priv: Private driver interface data
2619 * @buf: Buffer for returning NoA
2620 * @buf_len: Buffer length in octets
2621 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2622 * advertized, or -1 on failure
2624 * This function is used to fetch the current Notice of Absence
2625 * attribute value from GO.
2627 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2630 * set_noa - Set Notice of Absence parameters for GO (testing)
2631 * @priv: Private driver interface data
2633 * @start: Start time in ms from next TBTT
2634 * @duration: Duration in ms
2635 * Returns: 0 on success or -1 on failure
2637 * This function is used to set Notice of Absence parameters for GO. It
2638 * is used only for testing. To disable NoA, all parameters are set to
2641 int (*set_noa)(void *priv, u8 count, int start, int duration);
2644 * set_p2p_powersave - Set P2P power save options
2645 * @priv: Private driver interface data
2646 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2647 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2648 * @ctwindow: 0.. = change (msec), -1 = no change
2649 * Returns: 0 on success or -1 on failure
2651 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2655 * ampdu - Enable/disable aggregation
2656 * @priv: Private driver interface data
2657 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2658 * Returns: 0 on success or -1 on failure
2660 int (*ampdu)(void *priv, int ampdu);
2663 * get_radio_name - Get physical radio name for the device
2664 * @priv: Private driver interface data
2665 * Returns: Radio name or %NULL if not known
2667 * The returned data must not be modified by the caller. It is assumed
2668 * that any interface that has the same radio name as another is
2669 * sharing the same physical radio. This information can be used to
2670 * share scan results etc. information between the virtual interfaces
2671 * to speed up various operations.
2673 const char * (*get_radio_name)(void *priv);
2676 * send_tdls_mgmt - for sending TDLS management packets
2677 * @priv: private driver interface data
2678 * @dst: Destination (peer) MAC address
2679 * @action_code: TDLS action code for the mssage
2680 * @dialog_token: Dialog Token to use in the message (if needed)
2681 * @status_code: Status Code or Reason Code to use (if needed)
2682 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2683 * @initiator: Is the current end the TDLS link initiator
2684 * @buf: TDLS IEs to add to the message
2685 * @len: Length of buf in octets
2686 * Returns: 0 on success, negative (<0) on failure
2688 * This optional function can be used to send packet to driver which is
2689 * responsible for receiving and sending all TDLS packets.
2691 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2692 u8 dialog_token, u16 status_code, u32 peer_capab,
2693 int initiator, const u8 *buf, size_t len);
2696 * tdls_oper - Ask the driver to perform high-level TDLS operations
2697 * @priv: Private driver interface data
2698 * @oper: TDLS high-level operation. See %enum tdls_oper
2699 * @peer: Destination (peer) MAC address
2700 * Returns: 0 on success, negative (<0) on failure
2702 * This optional function can be used to send high-level TDLS commands
2705 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2708 * wnm_oper - Notify driver of the WNM frame reception
2709 * @priv: Private driver interface data
2710 * @oper: WNM operation. See %enum wnm_oper
2711 * @peer: Destination (peer) MAC address
2712 * @buf: Buffer for the driver to fill in (for getting IE)
2713 * @buf_len: Return the len of buf
2714 * Returns: 0 on success, negative (<0) on failure
2716 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2717 u8 *buf, u16 *buf_len);
2720 * set_qos_map - Set QoS Map
2721 * @priv: Private driver interface data
2722 * @qos_map_set: QoS Map
2723 * @qos_map_set_len: Length of QoS Map
2725 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2726 u8 qos_map_set_len);
2729 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2730 * @priv: Private driver interface data
2731 * @version: IP version of the IP address, 4 or 6
2732 * @ipaddr: IP address for the neigh entry
2733 * @prefixlen: IP address prefix length
2734 * @addr: Corresponding MAC address
2735 * Returns: 0 on success, negative (<0) on failure
2737 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2738 int prefixlen, const u8 *addr);
2741 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2742 * @priv: Private driver interface data
2743 * @version: IP version of the IP address, 4 or 6
2744 * @ipaddr: IP address for the neigh entry
2745 * Returns: 0 on success, negative (<0) on failure
2747 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2750 * br_port_set_attr - Set a bridge port attribute
2751 * @attr: Bridge port attribute to set
2752 * @val: Value to be set
2753 * Returns: 0 on success, negative (<0) on failure
2755 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2759 * br_port_set_attr - Set a bridge network parameter
2760 * @param: Bridge parameter to set
2761 * @val: Value to be set
2762 * Returns: 0 on success, negative (<0) on failure
2764 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2768 * set_wowlan - Set wake-on-wireless triggers
2769 * @priv: Private driver interface data
2770 * @triggers: wowlan triggers
2772 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2775 * signal_poll - Get current connection information
2776 * @priv: Private driver interface data
2777 * @signal_info: Connection info structure
2779 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2782 * set_authmode - Set authentication algorithm(s) for static WEP
2783 * @priv: Private driver interface data
2784 * @authmode: 1=Open System, 2=Shared Key, 3=both
2785 * Returns: 0 on success, -1 on failure
2787 * This function can be used to set authentication algorithms for AP
2788 * mode when static WEP is used. If the driver uses user space MLME/SME
2789 * implementation, there is no need to implement this function.
2791 * DEPRECATED - use set_ap() instead
2793 int (*set_authmode)(void *priv, int authmode);
2797 * driver_cmd - Execute driver-specific command
2798 * @priv: Private driver interface data
2799 * @cmd: Command to execute
2800 * @buf: Return buffer
2801 * @buf_len: Buffer length
2802 * Returns: 0 on success, -1 on failure
2804 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2805 #endif /* ANDROID */
2808 * vendor_cmd - Execute vendor specific command
2809 * @priv: Private driver interface data
2810 * @vendor_id: Vendor id
2811 * @subcmd: Vendor command id
2812 * @data: Vendor command parameters (%NULL if no parameters)
2813 * @data_len: Data length
2814 * @buf: Return buffer (%NULL to ignore reply)
2815 * Returns: 0 on success, negative (<0) on failure
2817 * This function handles vendor specific commands that are passed to
2818 * the driver/device. The command is identified by vendor id and
2819 * command id. Parameters can be passed as argument to the command
2820 * in the data buffer. Reply (if any) will be filled in the supplied
2823 * The exact driver behavior is driver interface and vendor specific. As
2824 * an example, this will be converted to a vendor specific cfg80211
2825 * command in case of the nl80211 driver interface.
2827 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2828 unsigned int subcmd, const u8 *data, size_t data_len,
2829 struct wpabuf *buf);
2832 * set_rekey_info - Set rekey information
2833 * @priv: Private driver interface data
2836 * @replay_ctr: Current EAPOL-Key Replay Counter
2838 * This optional function can be used to provide information for the
2839 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2840 * while the host (including wpa_supplicant) is sleeping.
2842 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2843 const u8 *replay_ctr);
2846 * sta_assoc - Station association indication
2847 * @priv: Private driver interface data
2848 * @own_addr: Source address and BSSID for association frame
2849 * @addr: MAC address of the station to associate
2850 * @reassoc: flag to indicate re-association
2851 * @status: association response status code
2852 * @ie: assoc response ie buffer
2853 * @len: ie buffer length
2854 * Returns: 0 on success, -1 on failure
2856 * This function indicates the driver to send (Re)Association
2857 * Response frame to the station.
2859 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2860 int reassoc, u16 status, const u8 *ie, size_t len);
2863 * sta_auth - Station authentication indication
2864 * @priv: Private driver interface data
2865 * @own_addr: Source address and BSSID for authentication frame
2866 * @addr: MAC address of the station to associate
2867 * @seq: authentication sequence number
2868 * @status: authentication response status code
2869 * @ie: authentication frame ie buffer
2870 * @len: ie buffer length
2872 * This function indicates the driver to send Authentication frame
2875 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2876 u16 seq, u16 status, const u8 *ie, size_t len);
2879 * add_tspec - Add traffic stream
2880 * @priv: Private driver interface data
2881 * @addr: MAC address of the station to associate
2882 * @tspec_ie: tspec ie buffer
2883 * @tspec_ielen: tspec ie length
2884 * Returns: 0 on success, -1 on failure
2886 * This function adds the traffic steam for the station
2887 * and fills the medium_time in tspec_ie.
2889 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2890 size_t tspec_ielen);
2893 * add_sta_node - Add a station node in the driver
2894 * @priv: Private driver interface data
2895 * @addr: MAC address of the station to add
2896 * @auth_alg: authentication algorithm used by the station
2897 * Returns: 0 on success, -1 on failure
2899 * This function adds the station node in the driver, when
2900 * the station gets added by FT-over-DS.
2902 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2905 * sched_scan - Request the driver to initiate scheduled scan
2906 * @priv: Private driver interface data
2907 * @params: Scan parameters
2908 * @interval: Interval between scan cycles in milliseconds
2909 * Returns: 0 on success, -1 on failure
2911 * This operation should be used for scheduled scan offload to
2912 * the hardware. Every time scan results are available, the
2913 * driver should report scan results event for wpa_supplicant
2914 * which will eventually request the results with
2915 * wpa_driver_get_scan_results2(). This operation is optional
2916 * and if not provided or if it returns -1, we fall back to
2917 * normal host-scheduled scans.
2919 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2923 * stop_sched_scan - Request the driver to stop a scheduled scan
2924 * @priv: Private driver interface data
2925 * Returns: 0 on success, -1 on failure
2927 * This should cause the scheduled scan to be stopped and
2928 * results should stop being sent. Must be supported if
2929 * sched_scan is supported.
2931 int (*stop_sched_scan)(void *priv);
2934 * poll_client - Probe (null data or such) the given station
2935 * @priv: Private driver interface data
2936 * @own_addr: MAC address of sending interface
2937 * @addr: MAC address of the station to probe
2938 * @qos: Indicates whether station is QoS station
2940 * This function is used to verify whether an associated station is
2941 * still present. This function does not need to be implemented if the
2942 * driver provides such inactivity polling mechanism.
2944 void (*poll_client)(void *priv, const u8 *own_addr,
2945 const u8 *addr, int qos);
2948 * radio_disable - Disable/enable radio
2949 * @priv: Private driver interface data
2950 * @disabled: 1=disable 0=enable radio
2951 * Returns: 0 on success, -1 on failure
2953 * This optional command is for testing purposes. It can be used to
2954 * disable the radio on a testbed device to simulate out-of-radio-range
2957 int (*radio_disable)(void *priv, int disabled);
2960 * switch_channel - Announce channel switch and migrate the GO to the
2962 * @priv: Private driver interface data
2963 * @settings: Settings for CSA period and new channel
2964 * Returns: 0 on success, -1 on failure
2966 * This function is used to move the GO to the legacy STA channel to
2967 * avoid frequency conflict in single channel concurrency.
2969 int (*switch_channel)(void *priv, struct csa_settings *settings);
2972 * add_tx_ts - Add traffic stream
2973 * @priv: Private driver interface data
2974 * @tsid: Traffic stream ID
2975 * @addr: Receiver address
2976 * @user_prio: User priority of the traffic stream
2977 * @admitted_time: Admitted time for this TS in units of
2978 * 32 microsecond periods (per second).
2979 * Returns: 0 on success, -1 on failure
2981 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
2985 * del_tx_ts - Delete traffic stream
2986 * @priv: Private driver interface data
2987 * @tsid: Traffic stream ID
2988 * @addr: Receiver address
2989 * Returns: 0 on success, -1 on failure
2991 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
2994 * start_dfs_cac - Listen for radar interference on the channel
2995 * @priv: Private driver interface data
2996 * @freq: Channel parameters
2997 * Returns: 0 on success, -1 on failure
2999 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
3002 * stop_ap - Removes beacon from AP
3003 * @priv: Private driver interface data
3004 * Returns: 0 on success, -1 on failure (or if not supported)
3006 * This optional function can be used to disable AP mode related
3007 * configuration. Unlike deinit_ap, it does not change to station
3010 int (*stop_ap)(void *priv);
3013 * get_survey - Retrieve survey data
3014 * @priv: Private driver interface data
3015 * @freq: If set, survey data for the specified frequency is only
3016 * being requested. If not set, all survey data is requested.
3017 * Returns: 0 on success, -1 on failure
3019 * Use this to retrieve:
3021 * - the observed channel noise floor
3022 * - the amount of time we have spent on the channel
3023 * - the amount of time during which we have spent on the channel that
3024 * the radio has determined the medium is busy and we cannot
3026 * - the amount of time we have spent receiving data
3027 * - the amount of time we have spent transmitting data
3029 * This data can be used for spectrum heuristics. One example is
3030 * Automatic Channel Selection (ACS). The channel survey data is
3031 * kept on a linked list on the channel data, one entry is added
3032 * for each survey. The min_nf of the channel is updated for each
3035 int (*get_survey)(void *priv, unsigned int freq);
3038 * status - Get driver interface status information
3039 * @priv: Private driver interface data
3040 * @buf: Buffer for printing tou the status information
3041 * @buflen: Maximum length of the buffer
3042 * Returns: Length of written status information or -1 on failure
3044 int (*status)(void *priv, char *buf, size_t buflen);
3047 * roaming - Set roaming policy for driver-based BSS selection
3048 * @priv: Private driver interface data
3049 * @allowed: Whether roaming within ESS is allowed
3050 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3051 * Returns: Length of written status information or -1 on failure
3053 * This optional callback can be used to update roaming policy from the
3054 * associate() command (bssid being set there indicates that the driver
3055 * should not roam before getting this roaming() call to allow roaming.
3056 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3057 * capability, roaming policy is handled within wpa_supplicant and there
3058 * is no need to implement or react to this callback.
3060 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3063 * set_mac_addr - Set MAC address
3064 * @priv: Private driver interface data
3065 * @addr: MAC address to use or %NULL for setting back to permanent
3066 * Returns: 0 on success, -1 on failure
3068 int (*set_mac_addr)(void *priv, const u8 *addr);
3070 #ifdef CONFIG_MACSEC
3071 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3073 int (*macsec_deinit)(void *priv);
3076 * enable_protect_frames - Set protect frames status
3077 * @priv: Private driver interface data
3078 * @enabled: TRUE = protect frames enabled
3079 * FALSE = protect frames disabled
3080 * Returns: 0 on success, -1 on failure (or if not supported)
3082 int (*enable_protect_frames)(void *priv, Boolean enabled);
3085 * set_replay_protect - Set replay protect status and window size
3086 * @priv: Private driver interface data
3087 * @enabled: TRUE = replay protect enabled
3088 * FALSE = replay protect disabled
3089 * @window: replay window size, valid only when replay protect enabled
3090 * Returns: 0 on success, -1 on failure (or if not supported)
3092 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3095 * set_current_cipher_suite - Set current cipher suite
3096 * @priv: Private driver interface data
3097 * @cs: EUI64 identifier
3098 * @cs_len: Length of the cs buffer in octets
3099 * Returns: 0 on success, -1 on failure (or if not supported)
3101 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3105 * enable_controlled_port - Set controlled port status
3106 * @priv: Private driver interface data
3107 * @enabled: TRUE = controlled port enabled
3108 * FALSE = controlled port disabled
3109 * Returns: 0 on success, -1 on failure (or if not supported)
3111 int (*enable_controlled_port)(void *priv, Boolean enabled);
3114 * get_receive_lowest_pn - Get receive lowest pn
3115 * @priv: Private driver interface data
3116 * @channel: secure channel
3117 * @an: association number
3118 * @lowest_pn: lowest accept pn
3119 * Returns: 0 on success, -1 on failure (or if not supported)
3121 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3125 * get_transmit_next_pn - Get transmit next pn
3126 * @priv: Private driver interface data
3127 * @channel: secure channel
3128 * @an: association number
3130 * Returns: 0 on success, -1 on failure (or if not supported)
3132 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3136 * set_transmit_next_pn - Set transmit next pn
3137 * @priv: Private driver interface data
3138 * @channel: secure channel
3139 * @an: association number
3141 * Returns: 0 on success, -1 on failure (or if not supported)
3143 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3147 * get_available_receive_sc - get available receive channel
3148 * @priv: Private driver interface data
3149 * @channel: secure channel
3150 * Returns: 0 on success, -1 on failure (or if not supported)
3152 int (*get_available_receive_sc)(void *priv, u32 *channel);
3155 * create_receive_sc - create secure channel for receiving
3156 * @priv: Private driver interface data
3157 * @channel: secure channel
3158 * @sci_addr: secure channel identifier - address
3159 * @sci_port: secure channel identifier - port
3160 * @conf_offset: confidentiality offset (0, 30, or 50)
3161 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3163 * Returns: 0 on success, -1 on failure (or if not supported)
3165 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3166 u16 sci_port, unsigned int conf_offset,
3170 * delete_receive_sc - delete secure connection for receiving
3171 * @priv: private driver interface data from init()
3172 * @channel: secure channel
3173 * Returns: 0 on success, -1 on failure
3175 int (*delete_receive_sc)(void *priv, u32 channel);
3178 * create_receive_sa - create secure association for receive
3179 * @priv: private driver interface data from init()
3180 * @channel: secure channel
3181 * @an: association number
3182 * @lowest_pn: the lowest packet number can be received
3183 * @sak: the secure association key
3184 * Returns: 0 on success, -1 on failure
3186 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3187 u32 lowest_pn, const u8 *sak);
3190 * enable_receive_sa - enable the SA for receive
3191 * @priv: private driver interface data from init()
3192 * @channel: secure channel
3193 * @an: association number
3194 * Returns: 0 on success, -1 on failure
3196 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3199 * disable_receive_sa - disable SA for receive
3200 * @priv: private driver interface data from init()
3201 * @channel: secure channel index
3202 * @an: association number
3203 * Returns: 0 on success, -1 on failure
3205 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3208 * get_available_transmit_sc - get available transmit channel
3209 * @priv: Private driver interface data
3210 * @channel: secure channel
3211 * Returns: 0 on success, -1 on failure (or if not supported)
3213 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3216 * create_transmit_sc - create secure connection for transmit
3217 * @priv: private driver interface data from init()
3218 * @channel: secure channel
3219 * @sci_addr: secure channel identifier - address
3220 * @sci_port: secure channel identifier - port
3221 * Returns: 0 on success, -1 on failure
3223 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3224 u16 sci_port, unsigned int conf_offset);
3227 * delete_transmit_sc - delete secure connection for transmit
3228 * @priv: private driver interface data from init()
3229 * @channel: secure channel
3230 * Returns: 0 on success, -1 on failure
3232 int (*delete_transmit_sc)(void *priv, u32 channel);
3235 * create_transmit_sa - create secure association for transmit
3236 * @priv: private driver interface data from init()
3237 * @channel: secure channel index
3238 * @an: association number
3239 * @next_pn: the packet number used as next transmit packet
3240 * @confidentiality: True if the SA is to provide confidentiality
3241 * as well as integrity
3242 * @sak: the secure association key
3243 * Returns: 0 on success, -1 on failure
3245 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3246 Boolean confidentiality, const u8 *sak);
3249 * enable_transmit_sa - enable SA for transmit
3250 * @priv: private driver interface data from init()
3251 * @channel: secure channel
3252 * @an: association number
3253 * Returns: 0 on success, -1 on failure
3255 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3258 * disable_transmit_sa - disable SA for transmit
3259 * @priv: private driver interface data from init()
3260 * @channel: secure channel
3261 * @an: association number
3262 * Returns: 0 on success, -1 on failure
3264 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3265 #endif /* CONFIG_MACSEC */
3268 * init_mesh - Driver specific initialization for mesh
3269 * @priv: Private driver interface data
3270 * Returns: 0 on success, -1 on failure
3272 int (*init_mesh)(void *priv);
3275 * join_mesh - Join a mesh network
3276 * @priv: Private driver interface data
3277 * @params: Mesh configuration parameters
3278 * Returns: 0 on success, -1 on failure
3280 int (*join_mesh)(void *priv,
3281 struct wpa_driver_mesh_join_params *params);
3284 * leave_mesh - Leave a mesh network
3285 * @priv: Private driver interface data
3286 * Returns 0 on success, -1 on failure
3288 int (*leave_mesh)(void *priv);
3291 * do_acs - Automatically select channel
3292 * @priv: Private driver interface data
3293 * @params: Parameters for ACS
3294 * Returns 0 on success, -1 on failure
3296 * This command can be used to offload ACS to the driver if the driver
3297 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3299 int (*do_acs)(void *priv, struct drv_acs_params *params);
3304 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3306 enum wpa_event_type {
3308 * EVENT_ASSOC - Association completed
3310 * This event needs to be delivered when the driver completes IEEE
3311 * 802.11 association or reassociation successfully.
3312 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3313 * after this event has been generated. In addition, optional
3314 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3315 * more information about the association. If the driver interface gets
3316 * both of these events at the same time, it can also include the
3317 * assoc_info data in EVENT_ASSOC call.
3322 * EVENT_DISASSOC - Association lost
3324 * This event should be called when association is lost either due to
3325 * receiving deauthenticate or disassociate frame from the AP or when
3326 * sending either of these frames to the current AP. If the driver
3327 * supports separate deauthentication event, EVENT_DISASSOC should only
3328 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3329 * In AP mode, union wpa_event_data::disassoc_info is required.
3334 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3336 * This event must be delivered when a Michael MIC error is detected by
3337 * the local driver. Additional data for event processing is
3338 * provided with union wpa_event_data::michael_mic_failure. This
3339 * information is used to request new encyption key and to initiate
3340 * TKIP countermeasures if needed.
3342 EVENT_MICHAEL_MIC_FAILURE,
3345 * EVENT_SCAN_RESULTS - Scan results available
3347 * This event must be called whenever scan results are available to be
3348 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3349 * is expected to be used some time after struct wpa_driver_ops::scan()
3350 * is called. If the driver provides an unsolicited event when the scan
3351 * has been completed, this event can be used to trigger
3352 * EVENT_SCAN_RESULTS call. If such event is not available from the
3353 * driver, the driver wrapper code is expected to use a registered
3354 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3355 * scan is expected to be completed. Optional information about
3356 * completed scan can be provided with union wpa_event_data::scan_info.
3361 * EVENT_ASSOCINFO - Report optional extra information for association
3363 * This event can be used to report extra association information for
3364 * EVENT_ASSOC processing. This extra information includes IEs from
3365 * association frames and Beacon/Probe Response frames in union
3366 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3367 * EVENT_ASSOC. Alternatively, the driver interface can include
3368 * assoc_info data in the EVENT_ASSOC call if it has all the
3369 * information available at the same point.
3374 * EVENT_INTERFACE_STATUS - Report interface status changes
3376 * This optional event can be used to report changes in interface
3377 * status (interface added/removed) using union
3378 * wpa_event_data::interface_status. This can be used to trigger
3379 * wpa_supplicant to stop and re-start processing for the interface,
3380 * e.g., when a cardbus card is ejected/inserted.
3382 EVENT_INTERFACE_STATUS,
3385 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3387 * This event can be used to inform wpa_supplicant about candidates for
3388 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3389 * for scan request (ap_scan=2 mode), this event is required for
3390 * pre-authentication. If wpa_supplicant is performing scan request
3391 * (ap_scan=1), this event is optional since scan results can be used
3392 * to add pre-authentication candidates. union
3393 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3394 * candidate and priority of the candidate, e.g., based on the signal
3395 * strength, in order to try to pre-authenticate first with candidates
3396 * that are most likely targets for re-association.
3398 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3399 * on the candidate list. In addition, it can be called for the current
3400 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3401 * will automatically skip pre-authentication in cases where a valid
3402 * PMKSA exists. When more than one candidate exists, this event should
3403 * be generated once for each candidate.
3405 * Driver will be notified about successful pre-authentication with
3406 * struct wpa_driver_ops::add_pmkid() calls.
3408 EVENT_PMKID_CANDIDATE,
3411 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3413 * This event can be used to inform wpa_supplicant about desire to set
3414 * up secure direct link connection between two stations as defined in
3415 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3416 * STAKey negotiation. The caller will need to set peer address for the
3422 * EVENT_TDLS - Request TDLS operation
3424 * This event can be used to request a TDLS operation to be performed.
3429 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3431 * The driver is expected to report the received FT IEs from
3432 * FT authentication sequence from the AP. The FT IEs are included in
3433 * the extra information in union wpa_event_data::ft_ies.
3438 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3440 * The driver can use this event to inform wpa_supplicant about a STA
3441 * in an IBSS with which protected frames could be exchanged. This
3442 * event starts RSN authentication with the other STA to authenticate
3443 * the STA and set up encryption keys with it.
3445 EVENT_IBSS_RSN_START,
3448 * EVENT_AUTH - Authentication result
3450 * This event should be called when authentication attempt has been
3451 * completed. This is only used if the driver supports separate
3452 * authentication step (struct wpa_driver_ops::authenticate).
3453 * Information about authentication result is included in
3454 * union wpa_event_data::auth.
3459 * EVENT_DEAUTH - Authentication lost
3461 * This event should be called when authentication is lost either due
3462 * to receiving deauthenticate frame from the AP or when sending that
3463 * frame to the current AP.
3464 * In AP mode, union wpa_event_data::deauth_info is required.
3469 * EVENT_ASSOC_REJECT - Association rejected
3471 * This event should be called when (re)association attempt has been
3472 * rejected by the AP. Information about the association response is
3473 * included in union wpa_event_data::assoc_reject.
3478 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3480 EVENT_AUTH_TIMED_OUT,
3483 * EVENT_ASSOC_TIMED_OUT - Association timed out
3485 EVENT_ASSOC_TIMED_OUT,
3488 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3490 EVENT_WPS_BUTTON_PUSHED,
3493 * EVENT_TX_STATUS - Report TX status
3498 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3500 EVENT_RX_FROM_UNKNOWN,
3503 * EVENT_RX_MGMT - Report RX of a management frame
3508 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3510 * This event is used to indicate when the driver has started the
3511 * requested remain-on-channel duration. Information about the
3512 * operation is included in union wpa_event_data::remain_on_channel.
3514 EVENT_REMAIN_ON_CHANNEL,
3517 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3519 * This event is used to indicate when the driver has completed
3520 * remain-on-channel duration, i.e., may noot be available on the
3521 * requested channel anymore. Information about the
3522 * operation is included in union wpa_event_data::remain_on_channel.
3524 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3527 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3529 * This event is used to indicate when a Probe Request frame has been
3530 * received. Information about the received frame is included in
3531 * union wpa_event_data::rx_probe_req. The driver is required to report
3532 * these events only after successfully completed probe_req_report()
3533 * commands to request the events (i.e., report parameter is non-zero)
3534 * in station mode. In AP mode, Probe Request frames should always be
3540 * EVENT_NEW_STA - New wired device noticed
3542 * This event is used to indicate that a new device has been detected
3543 * in a network that does not use association-like functionality (i.e.,
3544 * mainly wired Ethernet). This can be used to start EAPOL
3545 * authenticator when receiving a frame from a device. The address of
3546 * the device is included in union wpa_event_data::new_sta.
3551 * EVENT_EAPOL_RX - Report received EAPOL frame
3553 * When in AP mode with hostapd, this event is required to be used to
3554 * deliver the receive EAPOL frames from the driver.
3559 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3561 * This event is used to indicate changes in the signal strength
3562 * observed in frames received from the current AP if signal strength
3563 * monitoring has been enabled with signal_monitor().
3565 EVENT_SIGNAL_CHANGE,
3568 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3570 * This event is used to indicate that the interface was enabled after
3571 * having been previously disabled, e.g., due to rfkill.
3573 EVENT_INTERFACE_ENABLED,
3576 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3578 * This event is used to indicate that the interface was disabled,
3579 * e.g., due to rfkill.
3581 EVENT_INTERFACE_DISABLED,
3584 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3586 * This event is used to indicate that the channel list has changed,
3587 * e.g., because of a regulatory domain change triggered by scan
3588 * results including an AP advertising a country code.
3590 EVENT_CHANNEL_LIST_CHANGED,
3593 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3595 * This event is used to indicate that the driver cannot maintain this
3596 * interface in its operation mode anymore. The most likely use for
3597 * this is to indicate that AP mode operation is not available due to
3598 * operating channel would need to be changed to a DFS channel when
3599 * the driver does not support radar detection and another virtual
3600 * interfaces caused the operating channel to change. Other similar
3601 * resource conflicts could also trigger this for station mode
3602 * interfaces. This event can be propagated when channel switching
3605 EVENT_INTERFACE_UNAVAILABLE,
3608 * EVENT_BEST_CHANNEL
3610 * Driver generates this event whenever it detects a better channel
3611 * (e.g., based on RSSI or channel use). This information can be used
3612 * to improve channel selection for a new AP/P2P group.
3617 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3619 * This event should be called when a Deauthentication frame is dropped
3620 * due to it not being protected (MFP/IEEE 802.11w).
3621 * union wpa_event_data::unprot_deauth is required to provide more
3622 * details of the frame.
3624 EVENT_UNPROT_DEAUTH,
3627 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3629 * This event should be called when a Disassociation frame is dropped
3630 * due to it not being protected (MFP/IEEE 802.11w).
3631 * union wpa_event_data::unprot_disassoc is required to provide more
3632 * details of the frame.
3634 EVENT_UNPROT_DISASSOC,
3637 * EVENT_STATION_LOW_ACK
3639 * Driver generates this event whenever it detected that a particular
3640 * station was lost. Detection can be through massive transmission
3641 * failures for example.
3643 EVENT_STATION_LOW_ACK,
3646 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3648 EVENT_IBSS_PEER_LOST,
3651 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3653 * This event carries the new replay counter to notify wpa_supplicant
3654 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3655 * completed Group Key Handshake while the host (including
3656 * wpa_supplicant was sleeping).
3658 EVENT_DRIVER_GTK_REKEY,
3661 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3663 EVENT_SCHED_SCAN_STOPPED,
3666 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3668 * This event indicates that the station responded to the poll
3669 * initiated with @poll_client.
3671 EVENT_DRIVER_CLIENT_POLL_OK,
3674 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3676 EVENT_EAPOL_TX_STATUS,
3679 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3681 * Described in wpa_event_data.ch_switch
3686 * EVENT_WNM - Request WNM operation
3688 * This event can be used to request a WNM operation to be performed.
3693 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3695 * This event indicates that the driver reported a connection failure
3696 * with the specified client (for example, max client reached, etc.) in
3699 EVENT_CONNECT_FAILED_REASON,
3702 * EVENT_RADAR_DETECTED - Notify of radar detection
3704 * A radar has been detected on the supplied frequency, hostapd should
3705 * react accordingly (e.g., change channel).
3707 EVENT_DFS_RADAR_DETECTED,
3710 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3712 * After a successful CAC, the channel can be marked clear and used.
3714 EVENT_DFS_CAC_FINISHED,
3717 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3719 * The CAC was not successful, and the channel remains in the previous
3720 * state. This may happen due to a radar beeing detected or other
3721 * external influences.
3723 EVENT_DFS_CAC_ABORTED,
3726 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3728 * The channel which was previously unavailable is now available again.
3730 EVENT_DFS_NOP_FINISHED,
3733 * EVENT_SURVEY - Received survey data
3735 * This event gets triggered when a driver query is issued for survey
3736 * data and the requested data becomes available. The returned data is
3737 * stored in struct survey_results. The results provide at most one
3738 * survey entry for each frequency and at minimum will provide one
3739 * survey entry for one frequency. The survey data can be os_malloc()'d
3740 * and then os_free()'d, so the event callback must only copy data.
3745 * EVENT_SCAN_STARTED - Scan started
3747 * This indicates that driver has started a scan operation either based
3748 * on a request from wpa_supplicant/hostapd or from another application.
3749 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3750 * completed (either successfully or by getting cancelled).
3755 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3757 * This event indicates a set of frequency ranges that should be avoided
3758 * to reduce issues due to interference or internal co-existence
3759 * information in the driver.
3761 EVENT_AVOID_FREQUENCIES,
3764 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3766 EVENT_NEW_PEER_CANDIDATE,
3769 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
3771 * Indicates a pair of primary and secondary channels chosen by ACS
3774 EVENT_ACS_CHANNEL_SELECTED,
3779 * struct freq_survey - Channel survey info
3781 * @ifidx: Interface index in which this survey was observed
3782 * @freq: Center of frequency of the surveyed channel
3783 * @nf: Channel noise floor in dBm
3784 * @channel_time: Amount of time in ms the radio spent on the channel
3785 * @channel_time_busy: Amount of time in ms the radio detected some signal
3786 * that indicated to the radio the channel was not clear
3787 * @channel_time_rx: Amount of time the radio spent receiving data
3788 * @channel_time_tx: Amount of time the radio spent transmitting data
3789 * @filled: bitmask indicating which fields have been reported, see
3790 * SURVEY_HAS_* defines.
3791 * @list: Internal list pointers
3793 struct freq_survey {
3798 u64 channel_time_busy;
3799 u64 channel_time_rx;
3800 u64 channel_time_tx;
3801 unsigned int filled;
3802 struct dl_list list;
3805 #define SURVEY_HAS_NF BIT(0)
3806 #define SURVEY_HAS_CHAN_TIME BIT(1)
3807 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3808 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3809 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3813 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3815 union wpa_event_data {
3817 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3819 * This structure is optional for EVENT_ASSOC calls and required for
3820 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3821 * driver interface does not need to generate separate EVENT_ASSOCINFO
3826 * reassoc - Flag to indicate association or reassociation
3831 * req_ies - (Re)Association Request IEs
3833 * If the driver generates WPA/RSN IE, this event data must be
3834 * returned for WPA handshake to have needed information. If
3835 * wpa_supplicant-generated WPA/RSN IE is used, this
3836 * information event is optional.
3838 * This should start with the first IE (fixed fields before IEs
3839 * are not included).
3844 * req_ies_len - Length of req_ies in bytes
3849 * resp_ies - (Re)Association Response IEs
3851 * Optional association data from the driver. This data is not
3852 * required WPA, but may be useful for some protocols and as
3853 * such, should be reported if this is available to the driver
3856 * This should start with the first IE (fixed fields before IEs
3857 * are not included).
3862 * resp_ies_len - Length of resp_ies in bytes
3864 size_t resp_ies_len;
3867 * beacon_ies - Beacon or Probe Response IEs
3869 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3870 * Probe Response frames from the current AP (i.e., the one
3871 * that the client just associated with). This information is
3872 * used to update WPA/RSN IE for the AP. If this field is not
3873 * set, the results from previous scan will be used. If no
3874 * data for the new AP is found, scan results will be requested
3875 * again (without scan request). At this point, the driver is
3876 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3879 * This should start with the first IE (fixed fields before IEs
3880 * are not included).
3882 const u8 *beacon_ies;
3885 * beacon_ies_len - Length of beacon_ies */
3886 size_t beacon_ies_len;
3889 * freq - Frequency of the operational channel in MHz
3894 * wmm_params - WMM parameters used in this association.
3896 struct wmm_params wmm_params;
3899 * addr - Station address (for AP mode)
3904 * The following is the key management offload information
3907 * @key_replay_ctr_len
3915 * authorized - Status of key management offload,
3921 * key_replay_ctr - Key replay counter value last used
3922 * in a valid EAPOL-Key frame
3924 const u8 *key_replay_ctr;
3927 * key_replay_ctr_len - The length of key_replay_ctr
3929 size_t key_replay_ctr_len;
3932 * ptk_kck - The derived PTK KCK
3937 * ptk_kek_len - The length of ptk_kck
3942 * ptk_kek - The derived PTK KEK
3947 * ptk_kek_len - The length of ptk_kek
3953 * struct disassoc_info - Data for EVENT_DISASSOC events
3955 struct disassoc_info {
3957 * addr - Station address (for AP mode)
3962 * reason_code - Reason Code (host byte order) used in
3963 * Deauthentication frame
3968 * ie - Optional IE(s) in Disassociation frame
3973 * ie_len - Length of ie buffer in octets
3978 * locally_generated - Whether the frame was locally generated
3980 int locally_generated;
3984 * struct deauth_info - Data for EVENT_DEAUTH events
3986 struct deauth_info {
3988 * addr - Station address (for AP mode)
3993 * reason_code - Reason Code (host byte order) used in
3994 * Deauthentication frame
3999 * ie - Optional IE(s) in Deauthentication frame
4004 * ie_len - Length of ie buffer in octets
4009 * locally_generated - Whether the frame was locally generated
4011 int locally_generated;
4015 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4017 struct michael_mic_failure {
4020 } michael_mic_failure;
4023 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4025 struct interface_status {
4028 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4033 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4035 struct pmkid_candidate {
4036 /** BSSID of the PMKID candidate */
4038 /** Smaller the index, higher the priority */
4040 /** Whether RSN IE includes pre-authenticate flag */
4045 * struct stkstart - Data for EVENT_STKSTART
4052 * struct tdls - Data for EVENT_TDLS
4058 TDLS_REQUEST_TEARDOWN
4060 u16 reason_code; /* for teardown */
4064 * struct wnm - Data for EVENT_WNM
4082 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4084 * During FT (IEEE 802.11r) authentication sequence, the driver is
4085 * expected to use this event to report received FT IEs (MDIE, FTIE,
4086 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4087 * IEs for the next message will be delivered through the
4088 * struct wpa_driver_ops::update_ft_ies() callback.
4094 u8 target_ap[ETH_ALEN];
4095 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4097 /** Length of ric_ies buffer in octets */
4102 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4104 struct ibss_rsn_start {
4109 * struct auth_info - Data for EVENT_AUTH events
4115 u16 auth_transaction;
4122 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4124 struct assoc_reject {
4126 * bssid - BSSID of the AP that rejected association
4131 * resp_ies - (Re)Association Response IEs
4133 * Optional association data from the driver. This data is not
4134 * required WPA, but may be useful for some protocols and as
4135 * such, should be reported if this is available to the driver
4138 * This should start with the first IE (fixed fields before IEs
4139 * are not included).
4144 * resp_ies_len - Length of resp_ies in bytes
4146 size_t resp_ies_len;
4149 * status_code - Status Code from (Re)association Response
4154 struct timeout_event {
4159 * struct tx_status - Data for EVENT_TX_STATUS events
4171 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4173 struct rx_from_unknown {
4180 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4188 * drv_priv - Pointer to store driver private BSS information
4190 * If not set to NULL, this is used for comparison with
4191 * hostapd_data->drv_priv to determine which BSS should process
4197 * freq - Frequency (in MHz) on which the frame was received
4202 * ssi_signal - Signal strength in dBm (or 0 if not available)
4208 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4210 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4212 struct remain_on_channel {
4214 * freq - Channel frequency in MHz
4219 * duration - Duration to remain on the channel in milliseconds
4221 unsigned int duration;
4222 } remain_on_channel;
4225 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4226 * @aborted: Whether the scan was aborted
4227 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4228 * @num_freqs: Number of entries in freqs array
4229 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4231 * @num_ssids: Number of entries in ssids array
4237 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4242 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4244 struct rx_probe_req {
4246 * sa - Source address of the received Probe Request frame
4251 * da - Destination address of the received Probe Request frame
4252 * or %NULL if not available
4257 * bssid - BSSID of the received Probe Request frame or %NULL
4263 * ie - IEs from the Probe Request body
4268 * ie_len - Length of ie buffer in octets
4273 * signal - signal strength in dBm (or 0 if not available)
4279 * struct new_sta - Data for EVENT_NEW_STA events
4286 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4295 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4297 struct wpa_signal_info signal_change;
4300 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4301 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4302 * @freq_5: Best 5 GHz band channel frequency in MHz
4303 * @freq_overall: Best channel frequency in MHz
4305 * 0 can be used to indicate no preference in either band.
4307 struct best_channel {
4313 struct unprot_deauth {
4319 struct unprot_disassoc {
4326 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4327 * @addr: station address
4334 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4336 struct ibss_peer_lost {
4341 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4343 struct driver_gtk_rekey {
4345 const u8 *replay_ctr;
4349 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4350 * @addr: station address
4352 struct client_poll {
4357 * struct eapol_tx_status
4358 * @dst: Original destination
4359 * @data: Data starting with IEEE 802.1X header (!)
4360 * @data_len: Length of data
4361 * @ack: Indicates ack or lost frame
4363 * This corresponds to hapd_send_eapol if the frame sent
4364 * there isn't just reported as EVENT_TX_STATUS.
4366 struct eapol_tx_status {
4375 * @freq: Frequency of new channel in MHz
4376 * @ht_enabled: Whether this is an HT channel
4377 * @ch_offset: Secondary channel offset
4378 * @ch_width: Channel width
4379 * @cf1: Center frequency 1
4380 * @cf2: Center frequency 2
4386 enum chan_width ch_width;
4392 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4393 * @addr: Remote client address
4394 * @code: Reason code for connection failure
4396 struct connect_failed_reason {
4402 } connect_failed_reason;
4405 * struct dfs_event - Data for radar detected events
4406 * @freq: Frequency of the channel in MHz
4412 enum chan_width chan_width;
4418 * survey_results - Survey result data for EVENT_SURVEY
4419 * @freq_filter: Requested frequency survey filter, 0 if request
4420 * was for all survey data
4421 * @survey_list: Linked list of survey data (struct freq_survey)
4423 struct survey_results {
4424 unsigned int freq_filter;
4425 struct dl_list survey_list; /* struct freq_survey */
4429 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4430 * @initiator: Initiator of the regulatory change
4431 * @type: Regulatory change type
4432 * @alpha2: Country code (or "" if not available)
4434 struct channel_list_changed {
4435 enum reg_change_initiator initiator;
4438 } channel_list_changed;
4441 * freq_range - List of frequency ranges
4443 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4445 struct wpa_freq_range_list freq_range;
4450 * @peer: Peer address
4452 * @ie_len: Length of @ies
4454 * Notification of new candidate mesh peer.
4463 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4464 * @pri_channel: Selected primary channel
4465 * @sec_channel: Selected secondary channel
4467 struct acs_selected_channels {
4470 } acs_selected_channels;
4474 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4475 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4476 * with struct wpa_driver_ops::init()
4477 * @event: event type (defined above)
4478 * @data: possible extra data for the event
4480 * Driver wrapper code should call this function whenever an event is received
4483 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4484 union wpa_event_data *data);
4488 * The following inline functions are provided for convenience to simplify
4489 * event indication for some of the common events.
4492 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4493 size_t ielen, int reassoc)
4495 union wpa_event_data event;
4496 os_memset(&event, 0, sizeof(event));
4497 event.assoc_info.reassoc = reassoc;
4498 event.assoc_info.req_ies = ie;
4499 event.assoc_info.req_ies_len = ielen;
4500 event.assoc_info.addr = addr;
4501 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4504 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4506 union wpa_event_data event;
4507 os_memset(&event, 0, sizeof(event));
4508 event.disassoc_info.addr = addr;
4509 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4512 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4515 union wpa_event_data event;
4516 os_memset(&event, 0, sizeof(event));
4517 event.eapol_rx.src = src;
4518 event.eapol_rx.data = data;
4519 event.eapol_rx.data_len = data_len;
4520 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4523 /* driver_common.c */
4524 void wpa_scan_results_free(struct wpa_scan_results *res);
4526 /* Convert wpa_event_type to a string for logging */
4527 const char * event_to_string(enum wpa_event_type event);
4529 /* Convert chan_width to a string for logging and control interfaces */
4530 const char * channel_width_to_string(enum chan_width width);
4532 int ht_supported(const struct hostapd_hw_modes *mode);
4533 int vht_supported(const struct hostapd_hw_modes *mode);
4535 struct wowlan_triggers *
4536 wpa_get_wowlan_triggers(const char *wowlan_triggers,
4537 const struct wpa_driver_capa *capa);
4539 /* NULL terminated array of linked in driver wrappers */
4540 extern struct wpa_driver_ops *wpa_drivers[];
4542 #endif /* DRIVER_H */