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
47 enum reg_change_initiator {
51 REGDOM_SET_BY_COUNTRY_IE,
59 REGDOM_TYPE_CUSTOM_WORLD,
60 REGDOM_TYPE_INTERSECTION,
64 * struct hostapd_channel_data - Channel information
66 struct hostapd_channel_data {
68 * chan - Channel number (IEEE 802.11)
73 * freq - Frequency in MHz
78 * flag - Channel flags (HOSTAPD_CHAN_*)
83 * max_tx_power - Regulatory transmit power limit in dBm
88 * survey_list - Linked list of surveys
90 struct dl_list survey_list;
93 * min_nf - Minimum observed noise floor, in dBm, based on all
94 * surveyed channel data
100 * interference_factor - Computed interference factor on this
101 * channel (used internally in src/ap/acs.c; driver wrappers do not
104 long double interference_factor;
105 #endif /* CONFIG_ACS */
107 /* DFS CAC time in milliseconds */
108 unsigned int dfs_cac_ms;
111 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
112 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
115 * struct hostapd_hw_modes - Supported hardware mode information
117 struct hostapd_hw_modes {
119 * mode - Hardware mode
121 enum hostapd_hw_mode mode;
124 * num_channels - Number of entries in the channels array
129 * channels - Array of supported channels
131 struct hostapd_channel_data *channels;
134 * num_rates - Number of entries in the rates array
139 * rates - Array of supported rates in 100 kbps units
144 * ht_capab - HT (IEEE 802.11n) capabilities
149 * mcs_set - MCS (IEEE 802.11n) rate parameters
154 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
159 * vht_capab - VHT (IEEE 802.11ac) capabilities
164 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
168 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
172 #define IEEE80211_MODE_INFRA 0
173 #define IEEE80211_MODE_IBSS 1
174 #define IEEE80211_MODE_AP 2
175 #define IEEE80211_MODE_MESH 5
177 #define IEEE80211_CAP_ESS 0x0001
178 #define IEEE80211_CAP_IBSS 0x0002
179 #define IEEE80211_CAP_PRIVACY 0x0010
180 #define IEEE80211_CAP_RRM 0x1000
182 /* DMG (60 GHz) IEEE 802.11ad */
183 /* type - bits 0..1 */
184 #define IEEE80211_CAP_DMG_MASK 0x0003
185 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
186 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
187 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
189 #define WPA_SCAN_QUAL_INVALID BIT(0)
190 #define WPA_SCAN_NOISE_INVALID BIT(1)
191 #define WPA_SCAN_LEVEL_INVALID BIT(2)
192 #define WPA_SCAN_LEVEL_DBM BIT(3)
193 #define WPA_SCAN_AUTHENTICATED BIT(4)
194 #define WPA_SCAN_ASSOCIATED BIT(5)
197 * struct wpa_scan_res - Scan result for an BSS/IBSS
198 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
200 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
201 * @beacon_int: beacon interval in TUs (host byte order)
202 * @caps: capability information field in host byte order
203 * @qual: signal quality
204 * @noise: noise level
205 * @level: signal level
207 * @age: Age of the information in milliseconds (i.e., how many milliseconds
208 * ago the last Beacon or Probe Response frame was received)
209 * @ie_len: length of the following IE field in octets
210 * @beacon_ie_len: length of the following Beacon IE field in octets
212 * This structure is used as a generic format for scan results from the
213 * driver. Each driver interface implementation is responsible for converting
214 * the driver or OS specific scan results into this format.
216 * If the driver does not support reporting all IEs, the IE data structure is
217 * constructed of the IEs that are available. This field will also need to
218 * include SSID in IE format. All drivers are encouraged to be extended to
219 * report all IEs to make it easier to support future additions.
221 struct wpa_scan_res {
233 size_t beacon_ie_len;
235 * Followed by ie_len octets of IEs from Probe Response frame (or if
236 * the driver does not indicate source of IEs, these may also be from
237 * Beacon frame). After the first set of IEs, another set of IEs may
238 * follow (with beacon_ie_len octets of data) if the driver provides
244 * struct wpa_scan_results - Scan results
245 * @res: Array of pointers to allocated variable length scan result entries
246 * @num: Number of entries in the scan result array
247 * @fetch_time: Time when the results were fetched from the driver
249 struct wpa_scan_results {
250 struct wpa_scan_res **res;
252 struct os_reltime fetch_time;
256 * struct wpa_interface_info - Network interface information
257 * @next: Pointer to the next interface or NULL if this is the last one
258 * @ifname: Interface name that can be used with init() or init2()
259 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
261 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
262 * is not an allocated copy, i.e., get_interfaces() caller will not free
265 struct wpa_interface_info {
266 struct wpa_interface_info *next;
269 const char *drv_name;
272 #define WPAS_MAX_SCAN_SSIDS 16
275 * struct wpa_driver_scan_params - Scan parameters
276 * Data for struct wpa_driver_ops::scan2().
278 struct wpa_driver_scan_params {
280 * ssids - SSIDs to scan for
282 struct wpa_driver_scan_ssid {
284 * ssid - specific SSID to scan for (ProbeReq)
285 * %NULL or zero-length SSID is used to indicate active scan
286 * with wildcard SSID.
290 * ssid_len: Length of the SSID in octets
293 } ssids[WPAS_MAX_SCAN_SSIDS];
296 * num_ssids - Number of entries in ssids array
297 * Zero indicates a request for a passive scan.
302 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
307 * extra_ies_len - Length of extra_ies in octets
309 size_t extra_ies_len;
312 * freqs - Array of frequencies to scan or %NULL for all frequencies
314 * The frequency is set in MHz. The array is zero-terminated.
319 * filter_ssids - Filter for reporting SSIDs
321 * This optional parameter can be used to request the driver wrapper to
322 * filter scan results to include only the specified SSIDs. %NULL
323 * indicates that no filtering is to be done. This can be used to
324 * reduce memory needs for scan results in environments that have large
325 * number of APs with different SSIDs.
327 * The driver wrapper is allowed to take this allocated buffer into its
328 * own use by setting the pointer to %NULL. In that case, the driver
329 * wrapper is responsible for freeing the buffer with os_free() once it
330 * is not needed anymore.
332 struct wpa_driver_scan_filter {
338 * num_filter_ssids - Number of entries in filter_ssids array
340 size_t num_filter_ssids;
343 * filter_rssi - Filter by RSSI
345 * The driver may filter scan results in firmware to reduce host
346 * wakeups and thereby save power. Specify the RSSI threshold in s32
352 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
354 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
355 * Mbps from the support rates element(s) in the Probe Request frames
356 * and not to transmit the frames at any of those rates.
358 unsigned int p2p_probe:1;
361 * only_new_results - Request driver to report only new results
363 * This is used to request the driver to report only BSSes that have
364 * been detected after this scan request has been started, i.e., to
365 * flush old cached BSS entries.
367 unsigned int only_new_results:1;
370 * low_priority - Requests driver to use a lower scan priority
372 * This is used to request the driver to use a lower scan priority
373 * if it supports such a thing.
375 unsigned int low_priority:1;
378 * NOTE: Whenever adding new parameters here, please make sure
379 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
385 * struct wpa_driver_auth_params - Authentication parameters
386 * Data for struct wpa_driver_ops::authenticate().
388 struct wpa_driver_auth_params {
396 const u8 *wep_key[4];
397 size_t wep_key_len[4];
399 int local_state_change;
402 * p2p - Whether this connection is a P2P group
412 WPS_MODE_NONE /* no WPS provisioning being used */,
413 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
414 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
418 struct hostapd_freq_params {
424 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
425 * secondary channel below primary, 1 = HT40
426 * enabled, secondary channel above primary */
431 /* valid for both HT and VHT, center_freq2 is non-zero
432 * only for bandwidth 80 and an 80+80 channel */
433 int center_freq1, center_freq2;
438 * struct wpa_driver_associate_params - Association parameters
439 * Data for struct wpa_driver_ops::associate().
441 struct wpa_driver_associate_params {
443 * bssid - BSSID of the selected AP
444 * This can be %NULL, if ap_scan=2 mode is used and the driver is
445 * responsible for selecting with which BSS to associate. */
449 * bssid_hint - BSSID of a proposed AP
451 * This indicates which BSS has been found a suitable candidate for
452 * initial association for drivers that use driver/firmwate-based BSS
453 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
454 * the driver from selecting other BSSes in the ESS.
456 const u8 *bssid_hint;
459 * ssid - The selected SSID
464 * ssid_len - Length of the SSID (1..32)
469 * freq - channel parameters
471 struct hostapd_freq_params freq;
474 * freq_hint - Frequency of the channel the proposed AP is using
476 * This provides a channel on which a suitable BSS has been found as a
477 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
478 * limit the driver from selecting other channels for
479 * driver/firmware-based BSS selection.
484 * bg_scan_period - Background scan period in seconds, 0 to disable
485 * background scan, or -1 to indicate no change to default driver
491 * beacon_int - Beacon interval for IBSS or 0 to use driver default
496 * wpa_ie - WPA information element for (Re)Association Request
497 * WPA information element to be included in (Re)Association
498 * Request (including information element id and length). Use
499 * of this WPA IE is optional. If the driver generates the WPA
500 * IE, it can use pairwise_suite, group_suite, and
501 * key_mgmt_suite to select proper algorithms. In this case,
502 * the driver has to notify wpa_supplicant about the used WPA
503 * IE by generating an event that the interface code will
504 * convert into EVENT_ASSOCINFO data (see below).
506 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
507 * instead. The driver can determine which version is used by
508 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
511 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
516 * wpa_ie_len - length of the wpa_ie
521 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
523 unsigned int wpa_proto;
526 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
528 * This is usually ignored if @wpa_ie is used.
530 unsigned int pairwise_suite;
533 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
535 * This is usually ignored if @wpa_ie is used.
537 unsigned int group_suite;
540 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
542 * This is usually ignored if @wpa_ie is used.
544 unsigned int key_mgmt_suite;
547 * auth_alg - Allowed authentication algorithms
548 * Bit field of WPA_AUTH_ALG_*
553 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
558 * wep_key - WEP keys for static WEP configuration
560 const u8 *wep_key[4];
563 * wep_key_len - WEP key length for static WEP configuration
565 size_t wep_key_len[4];
568 * wep_tx_keyidx - WEP TX key index for static WEP configuration
573 * mgmt_frame_protection - IEEE 802.11w management frame protection
575 enum mfp_options mgmt_frame_protection;
578 * ft_ies - IEEE 802.11r / FT information elements
579 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
580 * for fast transition, this parameter is set to include the IEs that
581 * are to be sent in the next FT Authentication Request message.
582 * update_ft_ies() handler is called to update the IEs for further
583 * FT messages in the sequence.
585 * The driver should use these IEs only if the target AP is advertising
586 * the same mobility domain as the one included in the MDIE here.
588 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
589 * AP after the initial association. These IEs can only be used if the
590 * target AP is advertising support for FT and is using the same MDIE
591 * and SSID as the current AP.
593 * The driver is responsible for reporting the FT IEs received from the
594 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
595 * type. update_ft_ies() handler will then be called with the FT IEs to
596 * include in the next frame in the authentication sequence.
601 * ft_ies_len - Length of ft_ies in bytes
606 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
608 * This value is provided to allow the driver interface easier access
609 * to the current mobility domain. This value is set to %NULL if no
610 * mobility domain is currently active.
615 * passphrase - RSN passphrase for PSK
617 * This value is made available only for WPA/WPA2-Personal (PSK) and
618 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
619 * the 8..63 character ASCII passphrase, if available. Please note that
620 * this can be %NULL if passphrase was not used to generate the PSK. In
621 * that case, the psk field must be used to fetch the PSK.
623 const char *passphrase;
626 * psk - RSN PSK (alternative for passphrase for PSK)
628 * This value is made available only for WPA/WPA2-Personal (PSK) and
629 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
630 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
631 * be prepared to handle %NULL value as an error.
636 * drop_unencrypted - Enable/disable unencrypted frame filtering
638 * Configure the driver to drop all non-EAPOL frames (both receive and
639 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
640 * still be allowed for key negotiation.
642 int drop_unencrypted;
645 * prev_bssid - Previously used BSSID in this ESS
647 * When not %NULL, this is a request to use reassociation instead of
650 const u8 *prev_bssid;
655 * If the driver needs to do special configuration for WPS association,
656 * this variable provides more information on what type of association
657 * is being requested. Most drivers should not need ot use this.
662 * p2p - Whether this connection is a P2P group
667 * uapsd - UAPSD parameters for the network
668 * -1 = do not change defaults
669 * AP mode: 1 = enabled, 0 = disabled
670 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
675 * fixed_bssid - Whether to force this BSSID in IBSS mode
676 * 1 = Fix this BSSID and prevent merges.
677 * 0 = Do not fix BSSID.
682 * disable_ht - Disable HT (IEEE 802.11n) for this connection
687 * HT Capabilities over-rides. Only bits set in the mask will be used,
688 * and not all values are used by the kernel anyway. Currently, MCS,
689 * MPDU and MSDU fields are used.
691 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */
692 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */
694 #ifdef CONFIG_VHT_OVERRIDES
696 * disable_vht - Disable VHT for this connection
701 * VHT capability overrides.
703 const struct ieee80211_vht_capabilities *vhtcaps;
704 const struct ieee80211_vht_capabilities *vhtcaps_mask;
705 #endif /* CONFIG_VHT_OVERRIDES */
708 * req_key_mgmt_offload - Request key management offload for connection
710 * Request key management offload for this connection if the device
713 int req_key_mgmt_offload;
716 * Flag for indicating whether this association includes support for
717 * RRM (Radio Resource Measurements)
724 HIDDEN_SSID_ZERO_LEN,
725 HIDDEN_SSID_ZERO_CONTENTS
728 struct wowlan_triggers {
732 u8 gtk_rekey_failure;
734 u8 four_way_handshake;
738 struct wpa_driver_ap_params {
740 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
745 * head_len - Length of the head buffer in octets
750 * tail - Beacon tail following TIM IE
755 * tail_len - Length of the tail buffer in octets
760 * dtim_period - DTIM period
765 * beacon_int - Beacon interval
770 * basic_rates: -1 terminated array of basic rates in 100 kbps
772 * This parameter can be used to set a specific basic rate set for the
773 * BSS. If %NULL, default basic rate set is used.
778 * proberesp - Probe Response template
780 * This is used by drivers that reply to Probe Requests internally in
781 * AP mode and require the full Probe Response template.
786 * proberesp_len - Length of the proberesp buffer in octets
788 size_t proberesp_len;
791 * ssid - The SSID to use in Beacon/Probe Response frames
796 * ssid_len - Length of the SSID (1..32)
801 * hide_ssid - Whether to hide the SSID
803 enum hide_ssid hide_ssid;
806 * pairwise_ciphers - WPA_CIPHER_* bitfield
808 unsigned int pairwise_ciphers;
811 * group_cipher - WPA_CIPHER_*
813 unsigned int group_cipher;
816 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
818 unsigned int key_mgmt_suites;
821 * auth_algs - WPA_AUTH_ALG_* bitfield
823 unsigned int auth_algs;
826 * wpa_version - WPA_PROTO_* bitfield
828 unsigned int wpa_version;
831 * privacy - Whether privacy is used in the BSS
836 * beacon_ies - WPS/P2P IE(s) for Beacon frames
838 * This is used to add IEs like WPS IE and P2P IE by drivers that do
839 * not use the full Beacon template.
841 const struct wpabuf *beacon_ies;
844 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
846 * This is used to add IEs like WPS IE and P2P IE by drivers that
847 * reply to Probe Request frames internally.
849 const struct wpabuf *proberesp_ies;
852 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
854 * This is used to add IEs like WPS IE by drivers that reply to
855 * (Re)Association Request frames internally.
857 const struct wpabuf *assocresp_ies;
860 * isolate - Whether to isolate frames between associated stations
862 * If this is non-zero, the AP is requested to disable forwarding of
863 * frames between associated stations.
868 * cts_protect - Whether CTS protection is enabled
873 * preamble - Whether short preamble is enabled
878 * short_slot_time - Whether short slot time is enabled
880 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
881 * not set (e.g., when 802.11g mode is not in use)
886 * ht_opmode - HT operation mode or -1 if HT not in use
891 * interworking - Whether Interworking is enabled
896 * hessid - Homogeneous ESS identifier or %NULL if not set
901 * access_network_type - Access Network Type (0..15)
903 * This is used for filtering Probe Request frames when Interworking is
906 u8 access_network_type;
909 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
911 * This is used by driver which advertises this capability.
913 int ap_max_inactivity;
916 * smps_mode - SMPS mode
918 * SMPS mode to be used by the AP, specified as the relevant bits of
919 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
921 unsigned int smps_mode;
924 * disable_dgaf - Whether group-addressed frames are disabled
929 * osen - Whether OSEN security is enabled
934 * freq - Channel parameters for dynamic bandwidth changes
936 struct hostapd_freq_params *freq;
939 struct wpa_driver_mesh_bss_params {
940 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
942 * TODO: Other mesh configuration parameters would go here.
943 * See NL80211_MESHCONF_* for all the mesh config parameters.
948 struct wpa_driver_mesh_join_params {
951 const int *basic_rates;
955 enum ht_mode ht_mode;
956 struct wpa_driver_mesh_bss_params conf;
957 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
958 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
959 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
960 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
965 * struct wpa_driver_capa - Driver capability information
967 struct wpa_driver_capa {
968 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
969 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
970 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
971 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
972 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
973 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
974 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
975 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
976 unsigned int key_mgmt;
978 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
979 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
980 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
981 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
982 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
983 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
984 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
985 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
986 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
987 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
988 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
989 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
990 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
993 #define WPA_DRIVER_AUTH_OPEN 0x00000001
994 #define WPA_DRIVER_AUTH_SHARED 0x00000002
995 #define WPA_DRIVER_AUTH_LEAP 0x00000004
998 /* Driver generated WPA/RSN IE */
999 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1000 /* Driver needs static WEP key setup after association command */
1001 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1002 /* Driver takes care of all DFS operations */
1003 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1004 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
1005 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1006 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1007 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1008 /* Driver provides separate commands for authentication and association (SME in
1009 * wpa_supplicant). */
1010 #define WPA_DRIVER_FLAGS_SME 0x00000020
1011 /* Driver supports AP mode */
1012 #define WPA_DRIVER_FLAGS_AP 0x00000040
1013 /* Driver needs static WEP key setup after association has been completed */
1014 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1015 /* Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1016 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1017 /* Driver supports concurrent P2P operations */
1018 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1020 * Driver uses the initial interface as a dedicated management interface, i.e.,
1021 * it cannot be used for P2P group operations or non-P2P purposes.
1023 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1024 /* This interface is P2P capable (P2P GO or P2P Client) */
1025 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1026 /* Driver supports station and key removal when stopping an AP */
1027 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1029 * Driver uses the initial interface for P2P management interface and non-P2P
1030 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1031 * P2P group operations.
1033 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1035 * Driver is known to use sane error codes, i.e., when it indicates that
1036 * something (e.g., association) fails, there was indeed a failure and the
1037 * operation does not end up getting completed successfully later.
1039 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1040 /* Driver supports off-channel TX */
1041 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1042 /* Driver indicates TX status events for EAPOL Data frames */
1043 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1044 /* Driver indicates TX status events for Deauth/Disassoc frames */
1045 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1046 /* Driver supports roaming (BSS selection) in firmware */
1047 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1048 /* Driver supports operating as a TDLS peer */
1049 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1050 /* Driver requires external TDLS setup/teardown/discovery */
1051 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1052 /* Driver indicates support for Probe Response offloading in AP mode */
1053 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1054 /* Driver supports U-APSD in AP mode */
1055 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1056 /* Driver supports inactivity timer in AP mode */
1057 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1058 /* Driver expects user space implementation of MLME in AP mode */
1059 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1060 /* Driver supports SAE with user space SME */
1061 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1062 /* Driver makes use of OBSS scan mechanism in wpa_supplicant */
1063 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1064 /* Driver supports IBSS (Ad-hoc) mode */
1065 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1066 /* Driver supports radar detection */
1067 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1068 /* Driver supports a dedicated interface for P2P Device */
1069 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1070 /* Driver supports QoS Mapping */
1071 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1072 /* Driver supports CSA in AP mode */
1073 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1074 /* Driver supports mesh */
1075 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1076 /* Driver support ACS offload */
1077 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1078 /* Driver supports key management offload */
1079 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1082 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1083 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1084 unsigned int smps_modes;
1086 unsigned int wmm_ac_supported:1;
1089 int max_sched_scan_ssids;
1090 int sched_scan_supported;
1094 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1096 unsigned int max_remain_on_chan;
1099 * max_stations - Maximum number of associated stations the driver
1100 * supports in AP mode
1102 unsigned int max_stations;
1105 * probe_resp_offloads - Bitmap of supported protocols by the driver
1106 * for Probe Response offloading.
1108 /* Driver Probe Response offloading support for WPS ver. 1 */
1109 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1110 /* Driver Probe Response offloading support for WPS ver. 2 */
1111 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1112 /* Driver Probe Response offloading support for P2P */
1113 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1114 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1115 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1116 unsigned int probe_resp_offloads;
1118 unsigned int max_acl_mac_addrs;
1121 * Number of supported concurrent channels
1123 unsigned int num_multichan_concurrent;
1126 * extended_capa - extended capabilities in driver/device
1128 * Must be allocated and freed by driver and the pointers must be
1129 * valid for the lifetime of the driver, i.e., freed in deinit()
1131 const u8 *extended_capa, *extended_capa_mask;
1132 unsigned int extended_capa_len;
1134 struct wowlan_triggers wowlan_triggers;
1136 /* Driver adds the DS Params Set IE in Probe Request frames */
1137 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1138 /* Driver adds the WFA TPC IE in Probe Request frames */
1139 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1140 /* Driver handles quiet period requests */
1141 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1143 * Driver is capable of inserting the current TX power value into the body of
1144 * transmitted frames.
1145 * Background: Some Action frames include a TPC Report IE. This IE contains a
1146 * TX power field, which has to be updated by lower layers. One such Action
1147 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1148 * of spectrum management). Note that this insertion takes place at a fixed
1149 * offset, namely the 6th byte in the Action frame body.
1151 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1156 struct hostapd_data;
1158 struct hostap_sta_driver_data {
1159 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1160 unsigned long current_tx_rate;
1161 unsigned long inactive_msec;
1162 unsigned long flags;
1163 unsigned long num_ps_buf_frames;
1164 unsigned long tx_retry_failed;
1165 unsigned long tx_retry_count;
1170 struct hostapd_sta_add_params {
1174 const u8 *supp_rates;
1175 size_t supp_rates_len;
1176 u16 listen_interval;
1177 const struct ieee80211_ht_capabilities *ht_capabilities;
1178 const struct ieee80211_vht_capabilities *vht_capabilities;
1179 int vht_opmode_enabled;
1181 u32 flags; /* bitmask of WPA_STA_* flags */
1182 u32 flags_mask; /* unset bits in flags */
1184 enum mesh_plink_state plink_state;
1185 #endif /* CONFIG_MESH */
1186 int set; /* Set STA parameters instead of add */
1188 const u8 *ext_capab;
1189 size_t ext_capab_len;
1190 const u8 *supp_channels;
1191 size_t supp_channels_len;
1192 const u8 *supp_oper_classes;
1193 size_t supp_oper_classes_len;
1196 struct mac_address {
1200 struct hostapd_acl_params {
1202 unsigned int num_mac_acl;
1203 struct mac_address mac_acl[0];
1206 enum wpa_driver_if_type {
1208 * WPA_IF_STATION - Station mode interface
1213 * WPA_IF_AP_VLAN - AP mode VLAN interface
1215 * This interface shares its address and Beacon frame with the main
1221 * WPA_IF_AP_BSS - AP mode BSS interface
1223 * This interface has its own address and Beacon frame.
1228 * WPA_IF_P2P_GO - P2P Group Owner
1233 * WPA_IF_P2P_CLIENT - P2P Client
1238 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1239 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1244 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1245 * abstracted P2P Device function in the driver
1250 * WPA_IF_MESH - Mesh interface
1255 struct wpa_init_params {
1259 const char *driver_params;
1260 int use_pae_group_addr;
1264 u8 *own_addr; /* buffer for writing own MAC address */
1268 struct wpa_bss_params {
1269 /** Interface name (for multi-SSID/VLAN support) */
1271 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1280 enum mfp_options ieee80211w;
1283 #define WPA_STA_AUTHORIZED BIT(0)
1284 #define WPA_STA_WMM BIT(1)
1285 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1286 #define WPA_STA_MFP BIT(3)
1287 #define WPA_STA_TDLS_PEER BIT(4)
1288 #define WPA_STA_AUTHENTICATED BIT(5)
1301 WNM_SLEEP_ENTER_CONFIRM,
1302 WNM_SLEEP_ENTER_FAIL,
1303 WNM_SLEEP_EXIT_CONFIRM,
1304 WNM_SLEEP_EXIT_FAIL,
1305 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1306 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1307 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1309 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1311 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1312 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1314 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1317 /* enum chan_width - Channel width definitions */
1329 * struct wpa_signal_info - Information about channel signal quality
1331 struct wpa_signal_info {
1333 int above_threshold;
1338 enum chan_width chanwidth;
1344 * struct beacon_data - Beacon data
1345 * @head: Head portion of Beacon frame (before TIM IE)
1346 * @tail: Tail portion of Beacon frame (after TIM IE)
1347 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1348 * @proberesp_ies: Extra information element(s) to add into Probe Response
1350 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1351 * Response frames or %NULL
1352 * @probe_resp: Probe Response frame template
1353 * @head_len: Length of @head
1354 * @tail_len: Length of @tail
1355 * @beacon_ies_len: Length of beacon_ies in octets
1356 * @proberesp_ies_len: Length of proberesp_ies in octets
1357 * @proberesp_ies_len: Length of proberesp_ies in octets
1358 * @probe_resp_len: Length of probe response template (@probe_resp)
1360 struct beacon_data {
1367 size_t head_len, tail_len;
1368 size_t beacon_ies_len;
1369 size_t proberesp_ies_len;
1370 size_t assocresp_ies_len;
1371 size_t probe_resp_len;
1375 * struct csa_settings - Settings for channel switch command
1376 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1377 * @block_tx: 1 - block transmission for CSA period
1378 * @freq_params: Next channel frequency parameter
1379 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1380 * @beacon_after: Next beacon/probe resp/asooc resp info
1381 * @counter_offset_beacon: Offset to the count field in beacon's tail
1382 * @counter_offset_presp: Offset to the count field in probe resp.
1384 struct csa_settings {
1388 struct hostapd_freq_params freq_params;
1389 struct beacon_data beacon_csa;
1390 struct beacon_data beacon_after;
1392 u16 counter_offset_beacon;
1393 u16 counter_offset_presp;
1396 /* TDLS peer capabilities for send_tdls_mgmt() */
1397 enum tdls_peer_capability {
1398 TDLS_PEER_HT = BIT(0),
1399 TDLS_PEER_VHT = BIT(1),
1400 TDLS_PEER_WMM = BIT(2),
1403 /* valid info in the wmm_params struct */
1404 enum wmm_params_valid_info {
1405 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1409 * struct wmm_params - WMM parameterss configured for this association
1410 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1411 * of the struct contain valid information.
1412 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1413 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1420 #ifdef CONFIG_MACSEC
1421 struct macsec_init_params {
1422 Boolean always_include_sci;
1426 #endif /* CONFIG_MACSEC */
1428 enum drv_br_port_attr {
1429 DRV_BR_PORT_ATTR_PROXYARP,
1430 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1433 enum drv_br_net_param {
1434 DRV_BR_NET_PARAM_GARP_ACCEPT,
1437 struct drv_acs_params {
1438 /* Selected mode (HOSTAPD_MODE_*) */
1439 enum hostapd_hw_mode hw_mode;
1441 /* Indicates whether HT is enabled */
1444 /* Indicates whether HT40 is enabled */
1450 * struct wpa_driver_ops - Driver interface API definition
1452 * This structure defines the API that each driver interface needs to implement
1453 * for core wpa_supplicant code. All driver specific functionality is captured
1456 struct wpa_driver_ops {
1457 /** Name of the driver interface */
1459 /** One line description of the driver interface */
1463 * get_bssid - Get the current BSSID
1464 * @priv: private driver interface data
1465 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1467 * Returns: 0 on success, -1 on failure
1469 * Query kernel driver for the current BSSID and copy it to bssid.
1470 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1473 int (*get_bssid)(void *priv, u8 *bssid);
1476 * get_ssid - Get the current SSID
1477 * @priv: private driver interface data
1478 * @ssid: buffer for SSID (at least 32 bytes)
1480 * Returns: Length of the SSID on success, -1 on failure
1482 * Query kernel driver for the current SSID and copy it to ssid.
1483 * Returning zero is recommended if the STA is not associated.
1485 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1486 * can, at least in theory, contain control characters (including nul)
1487 * and as such, should be processed as binary data, not a printable
1490 int (*get_ssid)(void *priv, u8 *ssid);
1493 * set_key - Configure encryption key
1494 * @ifname: Interface name (for multi-SSID/VLAN support)
1495 * @priv: private driver interface data
1496 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1497 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1498 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1499 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1500 * %WPA_ALG_BIP_CMAC_256);
1501 * %WPA_ALG_NONE clears the key.
1502 * @addr: Address of the peer STA (BSSID of the current AP when setting
1503 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1504 * broadcast keys, %NULL for default keys that are used both for
1505 * broadcast and unicast; when clearing keys, %NULL is used to
1506 * indicate that both the broadcast-only and default key of the
1507 * specified key index is to be cleared
1508 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1510 * @set_tx: configure this key as the default Tx key (only used when
1511 * driver does not support separate unicast/individual key
1512 * @seq: sequence number/packet number, seq_len octets, the next
1513 * packet number to be used for in replay protection; configured
1514 * for Rx keys (in most cases, this is only used with broadcast
1515 * keys and set to zero for unicast keys); %NULL if not set
1516 * @seq_len: length of the seq, depends on the algorithm:
1517 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1518 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1520 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1521 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1523 * Returns: 0 on success, -1 on failure
1525 * Configure the given key for the kernel driver. If the driver
1526 * supports separate individual keys (4 default keys + 1 individual),
1527 * addr can be used to determine whether the key is default or
1528 * individual. If only 4 keys are supported, the default key with key
1529 * index 0 is used as the individual key. STA must be configured to use
1530 * it as the default Tx key (set_tx is set) and accept Rx for all the
1531 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1532 * broadcast keys, so key index 0 is available for this kind of
1535 * Please note that TKIP keys include separate TX and RX MIC keys and
1536 * some drivers may expect them in different order than wpa_supplicant
1537 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1538 * will trigger Michael MIC errors. This can be fixed by changing the
1539 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1540 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1541 * example on how this can be done.
1543 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1544 const u8 *addr, int key_idx, int set_tx,
1545 const u8 *seq, size_t seq_len,
1546 const u8 *key, size_t key_len);
1549 * init - Initialize driver interface
1550 * @ctx: context to be used when calling wpa_supplicant functions,
1551 * e.g., wpa_supplicant_event()
1552 * @ifname: interface name, e.g., wlan0
1554 * Returns: Pointer to private data, %NULL on failure
1556 * Initialize driver interface, including event processing for kernel
1557 * driver events (e.g., associated, scan results, Michael MIC failure).
1558 * This function can allocate a private configuration data area for
1559 * @ctx, file descriptor, interface name, etc. information that may be
1560 * needed in future driver operations. If this is not used, non-NULL
1561 * value will need to be returned because %NULL is used to indicate
1562 * failure. The returned value will be used as 'void *priv' data for
1563 * all other driver_ops functions.
1565 * The main event loop (eloop.c) of wpa_supplicant can be used to
1566 * register callback for read sockets (eloop_register_read_sock()).
1568 * See below for more information about events and
1569 * wpa_supplicant_event() function.
1571 void * (*init)(void *ctx, const char *ifname);
1574 * deinit - Deinitialize driver interface
1575 * @priv: private driver interface data from init()
1577 * Shut down driver interface and processing of driver events. Free
1578 * private data buffer if one was allocated in init() handler.
1580 void (*deinit)(void *priv);
1583 * set_param - Set driver configuration parameters
1584 * @priv: private driver interface data from init()
1585 * @param: driver specific configuration parameters
1587 * Returns: 0 on success, -1 on failure
1589 * Optional handler for notifying driver interface about configuration
1590 * parameters (driver_param).
1592 int (*set_param)(void *priv, const char *param);
1595 * set_countermeasures - Enable/disable TKIP countermeasures
1596 * @priv: private driver interface data
1597 * @enabled: 1 = countermeasures enabled, 0 = disabled
1599 * Returns: 0 on success, -1 on failure
1601 * Configure TKIP countermeasures. When these are enabled, the driver
1602 * should drop all received and queued frames that are using TKIP.
1604 int (*set_countermeasures)(void *priv, int enabled);
1607 * deauthenticate - Request driver to deauthenticate
1608 * @priv: private driver interface data
1609 * @addr: peer address (BSSID of the AP)
1610 * @reason_code: 16-bit reason code to be sent in the deauthentication
1613 * Returns: 0 on success, -1 on failure
1615 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1618 * associate - Request driver to associate
1619 * @priv: private driver interface data
1620 * @params: association parameters
1622 * Returns: 0 on success, -1 on failure
1624 int (*associate)(void *priv,
1625 struct wpa_driver_associate_params *params);
1628 * add_pmkid - Add PMKSA cache entry to the driver
1629 * @priv: private driver interface data
1630 * @bssid: BSSID for the PMKSA cache entry
1631 * @pmkid: PMKID for the PMKSA cache entry
1633 * Returns: 0 on success, -1 on failure
1635 * This function is called when a new PMK is received, as a result of
1636 * either normal authentication or RSN pre-authentication.
1638 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1639 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1640 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1641 * driver_ops function does not need to be implemented. Likewise, if
1642 * the driver does not support WPA, this function is not needed.
1644 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1647 * remove_pmkid - Remove PMKSA cache entry to the driver
1648 * @priv: private driver interface data
1649 * @bssid: BSSID for the PMKSA cache entry
1650 * @pmkid: PMKID for the PMKSA cache entry
1652 * Returns: 0 on success, -1 on failure
1654 * This function is called when the supplicant drops a PMKSA cache
1655 * entry for any reason.
1657 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1658 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1659 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1660 * from wpa_supplicant, this driver_ops function does not need to be
1661 * implemented. Likewise, if the driver does not support WPA, this
1662 * function is not needed.
1664 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1667 * flush_pmkid - Flush PMKSA cache
1668 * @priv: private driver interface data
1670 * Returns: 0 on success, -1 on failure
1672 * This function is called when the supplicant drops all PMKSA cache
1673 * entries for any reason.
1675 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1676 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1677 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1678 * from wpa_supplicant, this driver_ops function does not need to be
1679 * implemented. Likewise, if the driver does not support WPA, this
1680 * function is not needed.
1682 int (*flush_pmkid)(void *priv);
1685 * get_capa - Get driver capabilities
1686 * @priv: private driver interface data
1688 * Returns: 0 on success, -1 on failure
1690 * Get driver/firmware/hardware capabilities.
1692 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1695 * poll - Poll driver for association information
1696 * @priv: private driver interface data
1698 * This is an option callback that can be used when the driver does not
1699 * provide event mechanism for association events. This is called when
1700 * receiving WPA EAPOL-Key messages that require association
1701 * information. The driver interface is supposed to generate associnfo
1702 * event before returning from this callback function. In addition, the
1703 * driver interface should generate an association event after having
1704 * sent out associnfo.
1706 void (*poll)(void *priv);
1709 * get_ifname - Get interface name
1710 * @priv: private driver interface data
1712 * Returns: Pointer to the interface name. This can differ from the
1713 * interface name used in init() call. Init() is called first.
1715 * This optional function can be used to allow the driver interface to
1716 * replace the interface name with something else, e.g., based on an
1717 * interface mapping from a more descriptive name.
1719 const char * (*get_ifname)(void *priv);
1722 * get_mac_addr - Get own MAC address
1723 * @priv: private driver interface data
1725 * Returns: Pointer to own MAC address or %NULL on failure
1727 * This optional function can be used to get the own MAC address of the
1728 * device from the driver interface code. This is only needed if the
1729 * l2_packet implementation for the OS does not provide easy access to
1731 const u8 * (*get_mac_addr)(void *priv);
1734 * set_operstate - Sets device operating state to DORMANT or UP
1735 * @priv: private driver interface data
1736 * @state: 0 = dormant, 1 = up
1737 * Returns: 0 on success, -1 on failure
1739 * This is an optional function that can be used on operating systems
1740 * that support a concept of controlling network device state from user
1741 * space applications. This function, if set, gets called with
1742 * state = 1 when authentication has been completed and with state = 0
1743 * when connection is lost.
1745 int (*set_operstate)(void *priv, int state);
1748 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1749 * @priv: Private driver interface data
1750 * @addr: Address of the station for which to set protection (may be
1751 * %NULL for group keys)
1752 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1753 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1754 * Returns: 0 on success, -1 on failure
1756 * This is an optional function that can be used to set the driver to
1757 * require protection for Tx and/or Rx frames. This uses the layer
1758 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1759 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1760 * set protection operation; instead, they set protection implicitly
1761 * based on configured keys.
1763 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1767 * get_hw_feature_data - Get hardware support data (channels and rates)
1768 * @priv: Private driver interface data
1769 * @num_modes: Variable for returning the number of returned modes
1770 * flags: Variable for returning hardware feature flags
1771 * Returns: Pointer to allocated hardware data on success or %NULL on
1772 * failure. Caller is responsible for freeing this.
1774 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1779 * send_mlme - Send management frame from MLME
1780 * @priv: Private driver interface data
1781 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1782 * @data_len: Size of the management frame
1783 * @noack: Do not wait for this frame to be acked (disable retries)
1784 * Returns: 0 on success, -1 on failure
1786 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1790 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1791 * @priv: Private driver interface data
1792 * @md: Mobility domain (2 octets) (also included inside ies)
1793 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1794 * @ies_len: Length of FT IEs in bytes
1795 * Returns: 0 on success, -1 on failure
1797 * The supplicant uses this callback to let the driver know that keying
1798 * material for FT is available and that the driver can use the
1799 * provided IEs in the next message in FT authentication sequence.
1801 * This function is only needed for driver that support IEEE 802.11r
1802 * (Fast BSS Transition).
1804 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1808 * get_scan_results2 - Fetch the latest scan results
1809 * @priv: private driver interface data
1811 * Returns: Allocated buffer of scan results (caller is responsible for
1812 * freeing the data structure) on success, NULL on failure
1814 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1817 * set_country - Set country
1818 * @priv: Private driver interface data
1819 * @alpha2: country to which to switch to
1820 * Returns: 0 on success, -1 on failure
1822 * This function is for drivers which support some form
1823 * of setting a regulatory domain.
1825 int (*set_country)(void *priv, const char *alpha2);
1828 * get_country - Get country
1829 * @priv: Private driver interface data
1830 * @alpha2: Buffer for returning country code (at least 3 octets)
1831 * Returns: 0 on success, -1 on failure
1833 int (*get_country)(void *priv, char *alpha2);
1836 * global_init - Global driver initialization
1837 * Returns: Pointer to private data (global), %NULL on failure
1839 * This optional function is called to initialize the driver wrapper
1840 * for global data, i.e., data that applies to all interfaces. If this
1841 * function is implemented, global_deinit() will also need to be
1842 * implemented to free the private data. The driver will also likely
1843 * use init2() function instead of init() to get the pointer to global
1844 * data available to per-interface initializer.
1846 void * (*global_init)(void);
1849 * global_deinit - Global driver deinitialization
1850 * @priv: private driver global data from global_init()
1852 * Terminate any global driver related functionality and free the
1853 * global data structure.
1855 void (*global_deinit)(void *priv);
1858 * init2 - Initialize driver interface (with global data)
1859 * @ctx: context to be used when calling wpa_supplicant functions,
1860 * e.g., wpa_supplicant_event()
1861 * @ifname: interface name, e.g., wlan0
1862 * @global_priv: private driver global data from global_init()
1863 * Returns: Pointer to private data, %NULL on failure
1865 * This function can be used instead of init() if the driver wrapper
1868 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1871 * get_interfaces - Get information about available interfaces
1872 * @global_priv: private driver global data from global_init()
1873 * Returns: Allocated buffer of interface information (caller is
1874 * responsible for freeing the data structure) on success, NULL on
1877 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1880 * scan2 - Request the driver to initiate scan
1881 * @priv: private driver interface data
1882 * @params: Scan parameters
1884 * Returns: 0 on success, -1 on failure
1886 * Once the scan results are ready, the driver should report scan
1887 * results event for wpa_supplicant which will eventually request the
1888 * results with wpa_driver_get_scan_results2().
1890 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1893 * authenticate - Request driver to authenticate
1894 * @priv: private driver interface data
1895 * @params: authentication parameters
1896 * Returns: 0 on success, -1 on failure
1898 * This is an optional function that can be used with drivers that
1899 * support separate authentication and association steps, i.e., when
1900 * wpa_supplicant can act as the SME. If not implemented, associate()
1901 * function is expected to take care of IEEE 802.11 authentication,
1904 int (*authenticate)(void *priv,
1905 struct wpa_driver_auth_params *params);
1908 * set_ap - Set Beacon and Probe Response information for AP mode
1909 * @priv: Private driver interface data
1910 * @params: Parameters to use in AP mode
1912 * This function is used to configure Beacon template and/or extra IEs
1913 * to add for Beacon and Probe Response frames for the driver in
1914 * AP mode. The driver is responsible for building the full Beacon
1915 * frame by concatenating the head part with TIM IE generated by the
1916 * driver/firmware and finishing with the tail part. Depending on the
1917 * driver architectue, this can be done either by using the full
1918 * template or the set of additional IEs (e.g., WPS and P2P IE).
1919 * Similarly, Probe Response processing depends on the driver design.
1920 * If the driver (or firmware) takes care of replying to Probe Request
1921 * frames, the extra IEs provided here needs to be added to the Probe
1924 * Returns: 0 on success, -1 on failure
1926 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1929 * set_acl - Set ACL in AP mode
1930 * @priv: Private driver interface data
1931 * @params: Parameters to configure ACL
1932 * Returns: 0 on success, -1 on failure
1934 * This is used only for the drivers which support MAC address ACL.
1936 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1939 * hapd_init - Initialize driver interface (hostapd only)
1940 * @hapd: Pointer to hostapd context
1941 * @params: Configuration for the driver wrapper
1942 * Returns: Pointer to private data, %NULL on failure
1944 * This function is used instead of init() or init2() when the driver
1945 * wrapper is used with hostapd.
1947 void * (*hapd_init)(struct hostapd_data *hapd,
1948 struct wpa_init_params *params);
1951 * hapd_deinit - Deinitialize driver interface (hostapd only)
1952 * @priv: Private driver interface data from hapd_init()
1954 void (*hapd_deinit)(void *priv);
1957 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1958 * @priv: Private driver interface data
1959 * @params: BSS parameters
1960 * Returns: 0 on success, -1 on failure
1962 * This is an optional function to configure the kernel driver to
1963 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1964 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1965 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1966 * for Beacon frames.
1968 * DEPRECATED - use set_ap() instead
1970 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1973 * set_privacy - Enable/disable privacy (AP only)
1974 * @priv: Private driver interface data
1975 * @enabled: 1 = privacy enabled, 0 = disabled
1976 * Returns: 0 on success, -1 on failure
1978 * This is an optional function to configure privacy field in the
1979 * kernel driver for Beacon frames. This can be left undefined (set to
1980 * %NULL) if the driver uses the Beacon template from set_ap().
1982 * DEPRECATED - use set_ap() instead
1984 int (*set_privacy)(void *priv, int enabled);
1987 * get_seqnum - Fetch the current TSC/packet number (AP only)
1988 * @ifname: The interface name (main or virtual)
1989 * @priv: Private driver interface data
1990 * @addr: MAC address of the station or %NULL for group keys
1992 * @seq: Buffer for returning the latest used TSC/packet number
1993 * Returns: 0 on success, -1 on failure
1995 * This function is used to fetch the last used TSC/packet number for
1996 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1997 * keys, so there is no strict requirement on implementing support for
1998 * unicast keys (i.e., addr != %NULL).
2000 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2004 * flush - Flush all association stations (AP only)
2005 * @priv: Private driver interface data
2006 * Returns: 0 on success, -1 on failure
2008 * This function requests the driver to disassociate all associated
2009 * stations. This function does not need to be implemented if the
2010 * driver does not process association frames internally.
2012 int (*flush)(void *priv);
2015 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2016 * @priv: Private driver interface data
2017 * @elem: Information elements
2018 * @elem_len: Length of the elem buffer in octets
2019 * Returns: 0 on success, -1 on failure
2021 * This is an optional function to add information elements in the
2022 * kernel driver for Beacon and Probe Response frames. This can be left
2023 * undefined (set to %NULL) if the driver uses the Beacon template from
2026 * DEPRECATED - use set_ap() instead
2028 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2031 * read_sta_data - Fetch station data
2032 * @priv: Private driver interface data
2033 * @data: Buffer for returning station information
2034 * @addr: MAC address of the station
2035 * Returns: 0 on success, -1 on failure
2037 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2041 * hapd_send_eapol - Send an EAPOL packet (AP only)
2042 * @priv: private driver interface data
2043 * @addr: Destination MAC address
2044 * @data: EAPOL packet starting with IEEE 802.1X header
2045 * @data_len: Length of the EAPOL packet in octets
2046 * @encrypt: Whether the frame should be encrypted
2047 * @own_addr: Source MAC address
2048 * @flags: WPA_STA_* flags for the destination station
2050 * Returns: 0 on success, -1 on failure
2052 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2053 size_t data_len, int encrypt,
2054 const u8 *own_addr, u32 flags);
2057 * sta_deauth - Deauthenticate a station (AP only)
2058 * @priv: Private driver interface data
2059 * @own_addr: Source address and BSSID for the Deauthentication frame
2060 * @addr: MAC address of the station to deauthenticate
2061 * @reason: Reason code for the Deauthentiation frame
2062 * Returns: 0 on success, -1 on failure
2064 * This function requests a specific station to be deauthenticated and
2065 * a Deauthentication frame to be sent to it.
2067 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2071 * sta_disassoc - Disassociate a station (AP only)
2072 * @priv: Private driver interface data
2073 * @own_addr: Source address and BSSID for the Disassociation frame
2074 * @addr: MAC address of the station to disassociate
2075 * @reason: Reason code for the Disassociation frame
2076 * Returns: 0 on success, -1 on failure
2078 * This function requests a specific station to be disassociated and
2079 * a Disassociation frame to be sent to it.
2081 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2085 * sta_remove - Remove a station entry (AP only)
2086 * @priv: Private driver interface data
2087 * @addr: MAC address of the station to be removed
2088 * Returns: 0 on success, -1 on failure
2090 int (*sta_remove)(void *priv, const u8 *addr);
2093 * hapd_get_ssid - Get the current SSID (AP only)
2094 * @priv: Private driver interface data
2095 * @buf: Buffer for returning the SSID
2096 * @len: Maximum length of the buffer
2097 * Returns: Length of the SSID on success, -1 on failure
2099 * This function need not be implemented if the driver uses Beacon
2100 * template from set_ap() and does not reply to Probe Request frames.
2102 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2105 * hapd_set_ssid - Set SSID (AP only)
2106 * @priv: Private driver interface data
2108 * @len: Length of the SSID in octets
2109 * Returns: 0 on success, -1 on failure
2111 * DEPRECATED - use set_ap() instead
2113 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2116 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2117 * @priv: Private driver interface data
2118 * @enabled: 1 = countermeasures enabled, 0 = disabled
2119 * Returns: 0 on success, -1 on failure
2121 * This need not be implemented if the driver does not take care of
2122 * association processing.
2124 int (*hapd_set_countermeasures)(void *priv, int enabled);
2127 * sta_add - Add a station entry
2128 * @priv: Private driver interface data
2129 * @params: Station parameters
2130 * Returns: 0 on success, -1 on failure
2132 * This function is used to add a station entry to the driver once the
2133 * station has completed association. This is only used if the driver
2134 * does not take care of association processing.
2136 * With TDLS, this function is also used to add or set (params->set 1)
2137 * TDLS peer entries.
2139 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2142 * get_inact_sec - Get station inactivity duration (AP only)
2143 * @priv: Private driver interface data
2144 * @addr: Station address
2145 * Returns: Number of seconds station has been inactive, -1 on failure
2147 int (*get_inact_sec)(void *priv, const u8 *addr);
2150 * sta_clear_stats - Clear station statistics (AP only)
2151 * @priv: Private driver interface data
2152 * @addr: Station address
2153 * Returns: 0 on success, -1 on failure
2155 int (*sta_clear_stats)(void *priv, const u8 *addr);
2158 * set_freq - Set channel/frequency (AP only)
2159 * @priv: Private driver interface data
2160 * @freq: Channel parameters
2161 * Returns: 0 on success, -1 on failure
2163 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2166 * set_rts - Set RTS threshold
2167 * @priv: Private driver interface data
2168 * @rts: RTS threshold in octets
2169 * Returns: 0 on success, -1 on failure
2171 int (*set_rts)(void *priv, int rts);
2174 * set_frag - Set fragmentation threshold
2175 * @priv: Private driver interface data
2176 * @frag: Fragmentation threshold in octets
2177 * Returns: 0 on success, -1 on failure
2179 int (*set_frag)(void *priv, int frag);
2182 * sta_set_flags - Set station flags (AP only)
2183 * @priv: Private driver interface data
2184 * @addr: Station address
2185 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2186 * @flags_or: Bitmap of WPA_STA_* flags to add
2187 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2188 * Returns: 0 on success, -1 on failure
2190 int (*sta_set_flags)(void *priv, const u8 *addr,
2191 int total_flags, int flags_or, int flags_and);
2194 * set_tx_queue_params - Set TX queue parameters
2195 * @priv: Private driver interface data
2196 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2200 * @burst_time: Maximum length for bursting in 0.1 msec units
2202 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2203 int cw_max, int burst_time);
2206 * if_add - Add a virtual interface
2207 * @priv: Private driver interface data
2208 * @type: Interface type
2209 * @ifname: Interface name for the new virtual interface
2210 * @addr: Local address to use for the interface or %NULL to use the
2211 * parent interface address
2212 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2213 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2214 * not allowed (applies only to %WPA_IF_AP_BSS type)
2215 * @force_ifname: Buffer for returning an interface name that the
2216 * driver ended up using if it differs from the requested ifname
2217 * @if_addr: Buffer for returning the allocated interface address
2218 * (this may differ from the requested addr if the driver cannot
2219 * change interface address)
2220 * @bridge: Bridge interface to use or %NULL if no bridge configured
2221 * @use_existing: Whether to allow existing interface to be used
2222 * Returns: 0 on success, -1 on failure
2224 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2225 const char *ifname, const u8 *addr, void *bss_ctx,
2226 void **drv_priv, char *force_ifname, u8 *if_addr,
2227 const char *bridge, int use_existing);
2230 * if_remove - Remove a virtual interface
2231 * @priv: Private driver interface data
2232 * @type: Interface type
2233 * @ifname: Interface name of the virtual interface to be removed
2234 * Returns: 0 on success, -1 on failure
2236 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2237 const char *ifname);
2240 * set_sta_vlan - Bind a station into a specific interface (AP only)
2241 * @priv: Private driver interface data
2242 * @ifname: Interface (main or virtual BSS or VLAN)
2243 * @addr: MAC address of the associated station
2245 * Returns: 0 on success, -1 on failure
2247 * This function is used to bind a station to a specific virtual
2248 * interface. It is only used if when virtual interfaces are supported,
2249 * e.g., to assign stations to different VLAN interfaces based on
2250 * information from a RADIUS server. This allows separate broadcast
2251 * domains to be used with a single BSS.
2253 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2257 * commit - Optional commit changes handler (AP only)
2258 * @priv: driver private data
2259 * Returns: 0 on success, -1 on failure
2261 * This optional handler function can be registered if the driver
2262 * interface implementation needs to commit changes (e.g., by setting
2263 * network interface up) at the end of initial configuration. If set,
2264 * this handler will be called after initial setup has been completed.
2266 int (*commit)(void *priv);
2269 * send_ether - Send an ethernet packet (AP only)
2270 * @priv: private driver interface data
2271 * @dst: Destination MAC address
2272 * @src: Source MAC address
2274 * @data: EAPOL packet starting with IEEE 802.1X header
2275 * @data_len: Length of the EAPOL packet in octets
2276 * Returns: 0 on success, -1 on failure
2278 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2279 const u8 *data, size_t data_len);
2282 * set_radius_acl_auth - Notification of RADIUS ACL change
2283 * @priv: Private driver interface data
2284 * @mac: MAC address of the station
2285 * @accepted: Whether the station was accepted
2286 * @session_timeout: Session timeout for the station
2287 * Returns: 0 on success, -1 on failure
2289 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2290 u32 session_timeout);
2293 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2294 * @priv: Private driver interface data
2295 * @mac: MAC address of the station
2296 * Returns: 0 on success, -1 on failure
2298 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2301 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2302 * @priv: Private driver interface data
2303 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2304 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2306 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2307 * to remove extra IE(s)
2308 * Returns: 0 on success, -1 on failure
2310 * This is an optional function to add WPS IE in the kernel driver for
2311 * Beacon and Probe Response frames. This can be left undefined (set
2312 * to %NULL) if the driver uses the Beacon template from set_ap()
2313 * and does not process Probe Request frames. If the driver takes care
2314 * of (Re)Association frame processing, the assocresp buffer includes
2315 * WPS IE(s) that need to be added to (Re)Association Response frames
2316 * whenever a (Re)Association Request frame indicated use of WPS.
2318 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2319 * frames when operating as a GO. The driver is responsible for adding
2320 * timing related attributes (e.g., NoA) in addition to the IEs
2321 * included here by appending them after these buffers. This call is
2322 * also used to provide Probe Response IEs for P2P Listen state
2323 * operations for drivers that generate the Probe Response frames
2326 * DEPRECATED - use set_ap() instead
2328 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2329 const struct wpabuf *proberesp,
2330 const struct wpabuf *assocresp);
2333 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2334 * @priv: Private driver interface data
2335 * @authorized: Whether the port is authorized
2336 * Returns: 0 on success, -1 on failure
2338 int (*set_supp_port)(void *priv, int authorized);
2341 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2342 * @priv: Private driver interface data
2343 * @addr: MAC address of the associated station
2344 * @aid: Association ID
2345 * @val: 1 = bind to 4-address WDS; 0 = unbind
2346 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2347 * to indicate that bridge is not to be used
2348 * @ifname_wds: Buffer to return the interface name for the new WDS
2349 * station or %NULL to indicate name is not returned.
2350 * Returns: 0 on success, -1 on failure
2352 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2353 const char *bridge_ifname, char *ifname_wds);
2356 * send_action - Transmit an Action frame
2357 * @priv: Private driver interface data
2358 * @freq: Frequency (in MHz) of the channel
2359 * @wait: Time to wait off-channel for a response (in ms), or zero
2360 * @dst: Destination MAC address (Address 1)
2361 * @src: Source MAC address (Address 2)
2362 * @bssid: BSSID (Address 3)
2364 * @data_len: data length in octets
2365 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2366 * Returns: 0 on success, -1 on failure
2368 * This command can be used to request the driver to transmit an action
2369 * frame to the specified destination.
2371 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2372 * be transmitted on the given channel and the device will wait for a
2373 * response on that channel for the given wait time.
2375 * If the flag is not set, the wait time will be ignored. In this case,
2376 * if a remain-on-channel duration is in progress, the frame must be
2377 * transmitted on that channel; alternatively the frame may be sent on
2378 * the current operational channel (if in associated state in station
2379 * mode or while operating as an AP.)
2381 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2382 const u8 *dst, const u8 *src, const u8 *bssid,
2383 const u8 *data, size_t data_len, int no_cck);
2386 * send_action_cancel_wait - Cancel action frame TX wait
2387 * @priv: Private driver interface data
2389 * This command cancels the wait time associated with sending an action
2390 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2391 * set in the driver flags.
2393 void (*send_action_cancel_wait)(void *priv);
2396 * remain_on_channel - Remain awake on a channel
2397 * @priv: Private driver interface data
2398 * @freq: Frequency (in MHz) of the channel
2399 * @duration: Duration in milliseconds
2400 * Returns: 0 on success, -1 on failure
2402 * This command is used to request the driver to remain awake on the
2403 * specified channel for the specified duration and report received
2404 * Action frames with EVENT_RX_MGMT events. Optionally, received
2405 * Probe Request frames may also be requested to be reported by calling
2406 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2408 * The driver may not be at the requested channel when this function
2409 * returns, i.e., the return code is only indicating whether the
2410 * request was accepted. The caller will need to wait until the
2411 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2412 * completed the channel change. This may take some time due to other
2413 * need for the radio and the caller should be prepared to timing out
2414 * its wait since there are no guarantees on when this request can be
2417 int (*remain_on_channel)(void *priv, unsigned int freq,
2418 unsigned int duration);
2421 * cancel_remain_on_channel - Cancel remain-on-channel operation
2422 * @priv: Private driver interface data
2424 * This command can be used to cancel a remain-on-channel operation
2425 * before its originally requested duration has passed. This could be
2426 * used, e.g., when remain_on_channel() is used to request extra time
2427 * to receive a response to an Action frame and the response is
2428 * received when there is still unneeded time remaining on the
2429 * remain-on-channel operation.
2431 int (*cancel_remain_on_channel)(void *priv);
2434 * probe_req_report - Request Probe Request frames to be indicated
2435 * @priv: Private driver interface data
2436 * @report: Whether to report received Probe Request frames
2437 * Returns: 0 on success, -1 on failure (or if not supported)
2439 * This command can be used to request the driver to indicate when
2440 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2441 * Since this operation may require extra resources, e.g., due to less
2442 * optimal hardware/firmware RX filtering, many drivers may disable
2443 * Probe Request reporting at least in station mode. This command is
2444 * used to notify the driver when the Probe Request frames need to be
2445 * reported, e.g., during remain-on-channel operations.
2447 int (*probe_req_report)(void *priv, int report);
2450 * deinit_ap - Deinitialize AP mode
2451 * @priv: Private driver interface data
2452 * Returns: 0 on success, -1 on failure (or if not supported)
2454 * This optional function can be used to disable AP mode related
2455 * configuration. If the interface was not dynamically added,
2456 * change the driver mode to station mode to allow normal station
2457 * operations like scanning to be completed.
2459 int (*deinit_ap)(void *priv);
2462 * deinit_p2p_cli - Deinitialize P2P client mode
2463 * @priv: Private driver interface data
2464 * Returns: 0 on success, -1 on failure (or if not supported)
2466 * This optional function can be used to disable P2P client mode. If the
2467 * interface was not dynamically added, change the interface type back
2470 int (*deinit_p2p_cli)(void *priv);
2473 * suspend - Notification on system suspend/hibernate event
2474 * @priv: Private driver interface data
2476 void (*suspend)(void *priv);
2479 * resume - Notification on system resume/thaw event
2480 * @priv: Private driver interface data
2482 void (*resume)(void *priv);
2485 * signal_monitor - Set signal monitoring parameters
2486 * @priv: Private driver interface data
2487 * @threshold: Threshold value for signal change events; 0 = disabled
2488 * @hysteresis: Minimum change in signal strength before indicating a
2490 * Returns: 0 on success, -1 on failure (or if not supported)
2492 * This function can be used to configure monitoring of signal strength
2493 * with the current AP. Whenever signal strength drops below the
2494 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2495 * should be generated assuming the signal strength has changed at
2496 * least %hysteresis from the previously indicated signal change event.
2498 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2501 * send_frame - Send IEEE 802.11 frame (testing use only)
2502 * @priv: Private driver interface data
2503 * @data: IEEE 802.11 frame with IEEE 802.11 header
2504 * @data_len: Size of the frame
2505 * @encrypt: Whether to encrypt the frame (if keys are set)
2506 * Returns: 0 on success, -1 on failure
2508 * This function is only used for debugging purposes and is not
2509 * required to be implemented for normal operations.
2511 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2515 * shared_freq - Get operating frequency of shared interface(s)
2516 * @priv: Private driver interface data
2517 * Returns: Operating frequency in MHz, 0 if no shared operation in
2518 * use, or -1 on failure
2520 * This command can be used to request the current operating frequency
2521 * of any virtual interface that shares the same radio to provide
2522 * information for channel selection for other virtual interfaces.
2524 int (*shared_freq)(void *priv);
2527 * get_noa - Get current Notice of Absence attribute payload
2528 * @priv: Private driver interface data
2529 * @buf: Buffer for returning NoA
2530 * @buf_len: Buffer length in octets
2531 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2532 * advertized, or -1 on failure
2534 * This function is used to fetch the current Notice of Absence
2535 * attribute value from GO.
2537 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2540 * set_noa - Set Notice of Absence parameters for GO (testing)
2541 * @priv: Private driver interface data
2543 * @start: Start time in ms from next TBTT
2544 * @duration: Duration in ms
2545 * Returns: 0 on success or -1 on failure
2547 * This function is used to set Notice of Absence parameters for GO. It
2548 * is used only for testing. To disable NoA, all parameters are set to
2551 int (*set_noa)(void *priv, u8 count, int start, int duration);
2554 * set_p2p_powersave - Set P2P power save options
2555 * @priv: Private driver interface data
2556 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2557 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2558 * @ctwindow: 0.. = change (msec), -1 = no change
2559 * Returns: 0 on success or -1 on failure
2561 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2565 * ampdu - Enable/disable aggregation
2566 * @priv: Private driver interface data
2567 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2568 * Returns: 0 on success or -1 on failure
2570 int (*ampdu)(void *priv, int ampdu);
2573 * get_radio_name - Get physical radio name for the device
2574 * @priv: Private driver interface data
2575 * Returns: Radio name or %NULL if not known
2577 * The returned data must not be modified by the caller. It is assumed
2578 * that any interface that has the same radio name as another is
2579 * sharing the same physical radio. This information can be used to
2580 * share scan results etc. information between the virtual interfaces
2581 * to speed up various operations.
2583 const char * (*get_radio_name)(void *priv);
2586 * send_tdls_mgmt - for sending TDLS management packets
2587 * @priv: private driver interface data
2588 * @dst: Destination (peer) MAC address
2589 * @action_code: TDLS action code for the mssage
2590 * @dialog_token: Dialog Token to use in the message (if needed)
2591 * @status_code: Status Code or Reason Code to use (if needed)
2592 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2593 * @initiator: Is the current end the TDLS link initiator
2594 * @buf: TDLS IEs to add to the message
2595 * @len: Length of buf in octets
2596 * Returns: 0 on success, negative (<0) on failure
2598 * This optional function can be used to send packet to driver which is
2599 * responsible for receiving and sending all TDLS packets.
2601 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2602 u8 dialog_token, u16 status_code, u32 peer_capab,
2603 int initiator, const u8 *buf, size_t len);
2606 * tdls_oper - Ask the driver to perform high-level TDLS operations
2607 * @priv: Private driver interface data
2608 * @oper: TDLS high-level operation. See %enum tdls_oper
2609 * @peer: Destination (peer) MAC address
2610 * Returns: 0 on success, negative (<0) on failure
2612 * This optional function can be used to send high-level TDLS commands
2615 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2618 * wnm_oper - Notify driver of the WNM frame reception
2619 * @priv: Private driver interface data
2620 * @oper: WNM operation. See %enum wnm_oper
2621 * @peer: Destination (peer) MAC address
2622 * @buf: Buffer for the driver to fill in (for getting IE)
2623 * @buf_len: Return the len of buf
2624 * Returns: 0 on success, negative (<0) on failure
2626 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2627 u8 *buf, u16 *buf_len);
2630 * set_qos_map - Set QoS Map
2631 * @priv: Private driver interface data
2632 * @qos_map_set: QoS Map
2633 * @qos_map_set_len: Length of QoS Map
2635 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2636 u8 qos_map_set_len);
2639 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2640 * @priv: Private driver interface data
2641 * @version: IP version of the IP address, 4 or 6
2642 * @ipaddr: IP address for the neigh entry
2643 * @prefixlen: IP address prefix length
2644 * @addr: Corresponding MAC address
2645 * Returns: 0 on success, negative (<0) on failure
2647 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2648 int prefixlen, const u8 *addr);
2651 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2652 * @priv: Private driver interface data
2653 * @version: IP version of the IP address, 4 or 6
2654 * @ipaddr: IP address for the neigh entry
2655 * Returns: 0 on success, negative (<0) on failure
2657 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2660 * br_port_set_attr - Set a bridge port attribute
2661 * @attr: Bridge port attribute to set
2662 * @val: Value to be set
2663 * Returns: 0 on success, negative (<0) on failure
2665 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2669 * br_port_set_attr - Set a bridge network parameter
2670 * @param: Bridge parameter to set
2671 * @val: Value to be set
2672 * Returns: 0 on success, negative (<0) on failure
2674 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2678 * set_wowlan - Set wake-on-wireless triggers
2679 * @priv: Private driver interface data
2680 * @triggers: wowlan triggers
2682 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2685 * signal_poll - Get current connection information
2686 * @priv: Private driver interface data
2687 * @signal_info: Connection info structure
2689 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2692 * set_authmode - Set authentication algorithm(s) for static WEP
2693 * @priv: Private driver interface data
2694 * @authmode: 1=Open System, 2=Shared Key, 3=both
2695 * Returns: 0 on success, -1 on failure
2697 * This function can be used to set authentication algorithms for AP
2698 * mode when static WEP is used. If the driver uses user space MLME/SME
2699 * implementation, there is no need to implement this function.
2701 * DEPRECATED - use set_ap() instead
2703 int (*set_authmode)(void *priv, int authmode);
2707 * driver_cmd - Execute driver-specific command
2708 * @priv: Private driver interface data
2709 * @cmd: Command to execute
2710 * @buf: Return buffer
2711 * @buf_len: Buffer length
2712 * Returns: 0 on success, -1 on failure
2714 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2715 #endif /* ANDROID */
2718 * vendor_cmd - Execute vendor specific command
2719 * @priv: Private driver interface data
2720 * @vendor_id: Vendor id
2721 * @subcmd: Vendor command id
2722 * @data: Vendor command parameters (%NULL if no parameters)
2723 * @data_len: Data length
2724 * @buf: Return buffer (%NULL to ignore reply)
2725 * Returns: 0 on success, negative (<0) on failure
2727 * This function handles vendor specific commands that are passed to
2728 * the driver/device. The command is identified by vendor id and
2729 * command id. Parameters can be passed as argument to the command
2730 * in the data buffer. Reply (if any) will be filled in the supplied
2733 * The exact driver behavior is driver interface and vendor specific. As
2734 * an example, this will be converted to a vendor specific cfg80211
2735 * command in case of the nl80211 driver interface.
2737 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2738 unsigned int subcmd, const u8 *data, size_t data_len,
2739 struct wpabuf *buf);
2742 * set_rekey_info - Set rekey information
2743 * @priv: Private driver interface data
2746 * @replay_ctr: Current EAPOL-Key Replay Counter
2748 * This optional function can be used to provide information for the
2749 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2750 * while the host (including wpa_supplicant) is sleeping.
2752 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2753 const u8 *replay_ctr);
2756 * sta_assoc - Station association indication
2757 * @priv: Private driver interface data
2758 * @own_addr: Source address and BSSID for association frame
2759 * @addr: MAC address of the station to associate
2760 * @reassoc: flag to indicate re-association
2761 * @status: association response status code
2762 * @ie: assoc response ie buffer
2763 * @len: ie buffer length
2764 * Returns: 0 on success, -1 on failure
2766 * This function indicates the driver to send (Re)Association
2767 * Response frame to the station.
2769 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2770 int reassoc, u16 status, const u8 *ie, size_t len);
2773 * sta_auth - Station authentication indication
2774 * @priv: Private driver interface data
2775 * @own_addr: Source address and BSSID for authentication frame
2776 * @addr: MAC address of the station to associate
2777 * @seq: authentication sequence number
2778 * @status: authentication response status code
2779 * @ie: authentication frame ie buffer
2780 * @len: ie buffer length
2782 * This function indicates the driver to send Authentication frame
2785 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2786 u16 seq, u16 status, const u8 *ie, size_t len);
2789 * add_tspec - Add traffic stream
2790 * @priv: Private driver interface data
2791 * @addr: MAC address of the station to associate
2792 * @tspec_ie: tspec ie buffer
2793 * @tspec_ielen: tspec ie length
2794 * Returns: 0 on success, -1 on failure
2796 * This function adds the traffic steam for the station
2797 * and fills the medium_time in tspec_ie.
2799 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2800 size_t tspec_ielen);
2803 * add_sta_node - Add a station node in the driver
2804 * @priv: Private driver interface data
2805 * @addr: MAC address of the station to add
2806 * @auth_alg: authentication algorithm used by the station
2807 * Returns: 0 on success, -1 on failure
2809 * This function adds the station node in the driver, when
2810 * the station gets added by FT-over-DS.
2812 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2815 * sched_scan - Request the driver to initiate scheduled scan
2816 * @priv: Private driver interface data
2817 * @params: Scan parameters
2818 * @interval: Interval between scan cycles in milliseconds
2819 * Returns: 0 on success, -1 on failure
2821 * This operation should be used for scheduled scan offload to
2822 * the hardware. Every time scan results are available, the
2823 * driver should report scan results event for wpa_supplicant
2824 * which will eventually request the results with
2825 * wpa_driver_get_scan_results2(). This operation is optional
2826 * and if not provided or if it returns -1, we fall back to
2827 * normal host-scheduled scans.
2829 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2833 * stop_sched_scan - Request the driver to stop a scheduled scan
2834 * @priv: Private driver interface data
2835 * Returns: 0 on success, -1 on failure
2837 * This should cause the scheduled scan to be stopped and
2838 * results should stop being sent. Must be supported if
2839 * sched_scan is supported.
2841 int (*stop_sched_scan)(void *priv);
2844 * poll_client - Probe (null data or such) the given station
2845 * @priv: Private driver interface data
2846 * @own_addr: MAC address of sending interface
2847 * @addr: MAC address of the station to probe
2848 * @qos: Indicates whether station is QoS station
2850 * This function is used to verify whether an associated station is
2851 * still present. This function does not need to be implemented if the
2852 * driver provides such inactivity polling mechanism.
2854 void (*poll_client)(void *priv, const u8 *own_addr,
2855 const u8 *addr, int qos);
2858 * radio_disable - Disable/enable radio
2859 * @priv: Private driver interface data
2860 * @disabled: 1=disable 0=enable radio
2861 * Returns: 0 on success, -1 on failure
2863 * This optional command is for testing purposes. It can be used to
2864 * disable the radio on a testbed device to simulate out-of-radio-range
2867 int (*radio_disable)(void *priv, int disabled);
2870 * switch_channel - Announce channel switch and migrate the GO to the
2872 * @priv: Private driver interface data
2873 * @settings: Settings for CSA period and new channel
2874 * Returns: 0 on success, -1 on failure
2876 * This function is used to move the GO to the legacy STA channel to
2877 * avoid frequency conflict in single channel concurrency.
2879 int (*switch_channel)(void *priv, struct csa_settings *settings);
2882 * add_tx_ts - Add traffic stream
2883 * @priv: Private driver interface data
2884 * @tsid: Traffic stream ID
2885 * @addr: Receiver address
2886 * @user_prio: User priority of the traffic stream
2887 * @admitted_time: Admitted time for this TS in units of
2888 * 32 microsecond periods (per second).
2889 * Returns: 0 on success, -1 on failure
2891 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
2895 * del_tx_ts - Delete traffic stream
2896 * @priv: Private driver interface data
2897 * @tsid: Traffic stream ID
2898 * @addr: Receiver address
2899 * Returns: 0 on success, -1 on failure
2901 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
2904 * start_dfs_cac - Listen for radar interference on the channel
2905 * @priv: Private driver interface data
2906 * @freq: Channel parameters
2907 * Returns: 0 on success, -1 on failure
2909 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
2912 * stop_ap - Removes beacon from AP
2913 * @priv: Private driver interface data
2914 * Returns: 0 on success, -1 on failure (or if not supported)
2916 * This optional function can be used to disable AP mode related
2917 * configuration. Unlike deinit_ap, it does not change to station
2920 int (*stop_ap)(void *priv);
2923 * get_survey - Retrieve survey data
2924 * @priv: Private driver interface data
2925 * @freq: If set, survey data for the specified frequency is only
2926 * being requested. If not set, all survey data is requested.
2927 * Returns: 0 on success, -1 on failure
2929 * Use this to retrieve:
2931 * - the observed channel noise floor
2932 * - the amount of time we have spent on the channel
2933 * - the amount of time during which we have spent on the channel that
2934 * the radio has determined the medium is busy and we cannot
2936 * - the amount of time we have spent receiving data
2937 * - the amount of time we have spent transmitting data
2939 * This data can be used for spectrum heuristics. One example is
2940 * Automatic Channel Selection (ACS). The channel survey data is
2941 * kept on a linked list on the channel data, one entry is added
2942 * for each survey. The min_nf of the channel is updated for each
2945 int (*get_survey)(void *priv, unsigned int freq);
2948 * status - Get driver interface status information
2949 * @priv: Private driver interface data
2950 * @buf: Buffer for printing tou the status information
2951 * @buflen: Maximum length of the buffer
2952 * Returns: Length of written status information or -1 on failure
2954 int (*status)(void *priv, char *buf, size_t buflen);
2957 * roaming - Set roaming policy for driver-based BSS selection
2958 * @priv: Private driver interface data
2959 * @allowed: Whether roaming within ESS is allowed
2960 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
2961 * Returns: Length of written status information or -1 on failure
2963 * This optional callback can be used to update roaming policy from the
2964 * associate() command (bssid being set there indicates that the driver
2965 * should not roam before getting this roaming() call to allow roaming.
2966 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
2967 * capability, roaming policy is handled within wpa_supplicant and there
2968 * is no need to implement or react to this callback.
2970 int (*roaming)(void *priv, int allowed, const u8 *bssid);
2973 * set_mac_addr - Set MAC address
2974 * @priv: Private driver interface data
2975 * @addr: MAC address to use or %NULL for setting back to permanent
2976 * Returns: 0 on success, -1 on failure
2978 int (*set_mac_addr)(void *priv, const u8 *addr);
2980 #ifdef CONFIG_MACSEC
2981 int (*macsec_init)(void *priv, struct macsec_init_params *params);
2983 int (*macsec_deinit)(void *priv);
2986 * enable_protect_frames - Set protect frames status
2987 * @priv: Private driver interface data
2988 * @enabled: TRUE = protect frames enabled
2989 * FALSE = protect frames disabled
2990 * Returns: 0 on success, -1 on failure (or if not supported)
2992 int (*enable_protect_frames)(void *priv, Boolean enabled);
2995 * set_replay_protect - Set replay protect status and window size
2996 * @priv: Private driver interface data
2997 * @enabled: TRUE = replay protect enabled
2998 * FALSE = replay protect disabled
2999 * @window: replay window size, valid only when replay protect enabled
3000 * Returns: 0 on success, -1 on failure (or if not supported)
3002 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3005 * set_current_cipher_suite - Set current cipher suite
3006 * @priv: Private driver interface data
3007 * @cs: EUI64 identifier
3008 * @cs_len: Length of the cs buffer in octets
3009 * Returns: 0 on success, -1 on failure (or if not supported)
3011 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3015 * enable_controlled_port - Set controlled port status
3016 * @priv: Private driver interface data
3017 * @enabled: TRUE = controlled port enabled
3018 * FALSE = controlled port disabled
3019 * Returns: 0 on success, -1 on failure (or if not supported)
3021 int (*enable_controlled_port)(void *priv, Boolean enabled);
3024 * get_receive_lowest_pn - Get receive lowest pn
3025 * @priv: Private driver interface data
3026 * @channel: secure channel
3027 * @an: association number
3028 * @lowest_pn: lowest accept pn
3029 * Returns: 0 on success, -1 on failure (or if not supported)
3031 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3035 * get_transmit_next_pn - Get transmit next pn
3036 * @priv: Private driver interface data
3037 * @channel: secure channel
3038 * @an: association number
3040 * Returns: 0 on success, -1 on failure (or if not supported)
3042 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3046 * set_transmit_next_pn - Set transmit next pn
3047 * @priv: Private driver interface data
3048 * @channel: secure channel
3049 * @an: association number
3051 * Returns: 0 on success, -1 on failure (or if not supported)
3053 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3057 * get_available_receive_sc - get available receive channel
3058 * @priv: Private driver interface data
3059 * @channel: secure channel
3060 * Returns: 0 on success, -1 on failure (or if not supported)
3062 int (*get_available_receive_sc)(void *priv, u32 *channel);
3065 * create_receive_sc - create secure channel for receiving
3066 * @priv: Private driver interface data
3067 * @channel: secure channel
3068 * @sci_addr: secure channel identifier - address
3069 * @sci_port: secure channel identifier - port
3070 * @conf_offset: confidentiality offset (0, 30, or 50)
3071 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3073 * Returns: 0 on success, -1 on failure (or if not supported)
3075 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3076 u16 sci_port, unsigned int conf_offset,
3080 * delete_receive_sc - delete secure connection for receiving
3081 * @priv: private driver interface data from init()
3082 * @channel: secure channel
3083 * Returns: 0 on success, -1 on failure
3085 int (*delete_receive_sc)(void *priv, u32 channel);
3088 * create_receive_sa - create secure association for receive
3089 * @priv: private driver interface data from init()
3090 * @channel: secure channel
3091 * @an: association number
3092 * @lowest_pn: the lowest packet number can be received
3093 * @sak: the secure association key
3094 * Returns: 0 on success, -1 on failure
3096 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3097 u32 lowest_pn, const u8 *sak);
3100 * enable_receive_sa - enable the SA for receive
3101 * @priv: private driver interface data from init()
3102 * @channel: secure channel
3103 * @an: association number
3104 * Returns: 0 on success, -1 on failure
3106 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3109 * disable_receive_sa - disable SA for receive
3110 * @priv: private driver interface data from init()
3111 * @channel: secure channel index
3112 * @an: association number
3113 * Returns: 0 on success, -1 on failure
3115 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3118 * get_available_transmit_sc - get available transmit channel
3119 * @priv: Private driver interface data
3120 * @channel: secure channel
3121 * Returns: 0 on success, -1 on failure (or if not supported)
3123 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3126 * create_transmit_sc - create secure connection for transmit
3127 * @priv: private driver interface data from init()
3128 * @channel: secure channel
3129 * @sci_addr: secure channel identifier - address
3130 * @sci_port: secure channel identifier - port
3131 * Returns: 0 on success, -1 on failure
3133 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3134 u16 sci_port, unsigned int conf_offset);
3137 * delete_transmit_sc - delete secure connection for transmit
3138 * @priv: private driver interface data from init()
3139 * @channel: secure channel
3140 * Returns: 0 on success, -1 on failure
3142 int (*delete_transmit_sc)(void *priv, u32 channel);
3145 * create_transmit_sa - create secure association for transmit
3146 * @priv: private driver interface data from init()
3147 * @channel: secure channel index
3148 * @an: association number
3149 * @next_pn: the packet number used as next transmit packet
3150 * @confidentiality: True if the SA is to provide confidentiality
3151 * as well as integrity
3152 * @sak: the secure association key
3153 * Returns: 0 on success, -1 on failure
3155 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3156 Boolean confidentiality, const u8 *sak);
3159 * enable_transmit_sa - enable SA for transmit
3160 * @priv: private driver interface data from init()
3161 * @channel: secure channel
3162 * @an: association number
3163 * Returns: 0 on success, -1 on failure
3165 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3168 * disable_transmit_sa - disable SA for transmit
3169 * @priv: private driver interface data from init()
3170 * @channel: secure channel
3171 * @an: association number
3172 * Returns: 0 on success, -1 on failure
3174 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3175 #endif /* CONFIG_MACSEC */
3178 * init_mesh - Driver specific initialization for mesh
3179 * @priv: Private driver interface data
3180 * Returns: 0 on success, -1 on failure
3182 int (*init_mesh)(void *priv);
3185 * join_mesh - Join a mesh network
3186 * @priv: Private driver interface data
3187 * @params: Mesh configuration parameters
3188 * Returns: 0 on success, -1 on failure
3190 int (*join_mesh)(void *priv,
3191 struct wpa_driver_mesh_join_params *params);
3194 * leave_mesh - Leave a mesh network
3195 * @priv: Private driver interface data
3196 * Returns 0 on success, -1 on failure
3198 int (*leave_mesh)(void *priv);
3201 * do_acs - Automatically select channel
3202 * @priv: Private driver interface data
3203 * @params: Parameters for ACS
3204 * Returns 0 on success, -1 on failure
3206 * This command can be used to offload ACS to the driver if the driver
3207 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3209 int (*do_acs)(void *priv, struct drv_acs_params *params);
3214 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3216 enum wpa_event_type {
3218 * EVENT_ASSOC - Association completed
3220 * This event needs to be delivered when the driver completes IEEE
3221 * 802.11 association or reassociation successfully.
3222 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3223 * after this event has been generated. In addition, optional
3224 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3225 * more information about the association. If the driver interface gets
3226 * both of these events at the same time, it can also include the
3227 * assoc_info data in EVENT_ASSOC call.
3232 * EVENT_DISASSOC - Association lost
3234 * This event should be called when association is lost either due to
3235 * receiving deauthenticate or disassociate frame from the AP or when
3236 * sending either of these frames to the current AP. If the driver
3237 * supports separate deauthentication event, EVENT_DISASSOC should only
3238 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3239 * In AP mode, union wpa_event_data::disassoc_info is required.
3244 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3246 * This event must be delivered when a Michael MIC error is detected by
3247 * the local driver. Additional data for event processing is
3248 * provided with union wpa_event_data::michael_mic_failure. This
3249 * information is used to request new encyption key and to initiate
3250 * TKIP countermeasures if needed.
3252 EVENT_MICHAEL_MIC_FAILURE,
3255 * EVENT_SCAN_RESULTS - Scan results available
3257 * This event must be called whenever scan results are available to be
3258 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3259 * is expected to be used some time after struct wpa_driver_ops::scan()
3260 * is called. If the driver provides an unsolicited event when the scan
3261 * has been completed, this event can be used to trigger
3262 * EVENT_SCAN_RESULTS call. If such event is not available from the
3263 * driver, the driver wrapper code is expected to use a registered
3264 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3265 * scan is expected to be completed. Optional information about
3266 * completed scan can be provided with union wpa_event_data::scan_info.
3271 * EVENT_ASSOCINFO - Report optional extra information for association
3273 * This event can be used to report extra association information for
3274 * EVENT_ASSOC processing. This extra information includes IEs from
3275 * association frames and Beacon/Probe Response frames in union
3276 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3277 * EVENT_ASSOC. Alternatively, the driver interface can include
3278 * assoc_info data in the EVENT_ASSOC call if it has all the
3279 * information available at the same point.
3284 * EVENT_INTERFACE_STATUS - Report interface status changes
3286 * This optional event can be used to report changes in interface
3287 * status (interface added/removed) using union
3288 * wpa_event_data::interface_status. This can be used to trigger
3289 * wpa_supplicant to stop and re-start processing for the interface,
3290 * e.g., when a cardbus card is ejected/inserted.
3292 EVENT_INTERFACE_STATUS,
3295 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3297 * This event can be used to inform wpa_supplicant about candidates for
3298 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3299 * for scan request (ap_scan=2 mode), this event is required for
3300 * pre-authentication. If wpa_supplicant is performing scan request
3301 * (ap_scan=1), this event is optional since scan results can be used
3302 * to add pre-authentication candidates. union
3303 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3304 * candidate and priority of the candidate, e.g., based on the signal
3305 * strength, in order to try to pre-authenticate first with candidates
3306 * that are most likely targets for re-association.
3308 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3309 * on the candidate list. In addition, it can be called for the current
3310 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3311 * will automatically skip pre-authentication in cases where a valid
3312 * PMKSA exists. When more than one candidate exists, this event should
3313 * be generated once for each candidate.
3315 * Driver will be notified about successful pre-authentication with
3316 * struct wpa_driver_ops::add_pmkid() calls.
3318 EVENT_PMKID_CANDIDATE,
3321 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3323 * This event can be used to inform wpa_supplicant about desire to set
3324 * up secure direct link connection between two stations as defined in
3325 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3326 * STAKey negotiation. The caller will need to set peer address for the
3332 * EVENT_TDLS - Request TDLS operation
3334 * This event can be used to request a TDLS operation to be performed.
3339 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3341 * The driver is expected to report the received FT IEs from
3342 * FT authentication sequence from the AP. The FT IEs are included in
3343 * the extra information in union wpa_event_data::ft_ies.
3348 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3350 * The driver can use this event to inform wpa_supplicant about a STA
3351 * in an IBSS with which protected frames could be exchanged. This
3352 * event starts RSN authentication with the other STA to authenticate
3353 * the STA and set up encryption keys with it.
3355 EVENT_IBSS_RSN_START,
3358 * EVENT_AUTH - Authentication result
3360 * This event should be called when authentication attempt has been
3361 * completed. This is only used if the driver supports separate
3362 * authentication step (struct wpa_driver_ops::authenticate).
3363 * Information about authentication result is included in
3364 * union wpa_event_data::auth.
3369 * EVENT_DEAUTH - Authentication lost
3371 * This event should be called when authentication is lost either due
3372 * to receiving deauthenticate frame from the AP or when sending that
3373 * frame to the current AP.
3374 * In AP mode, union wpa_event_data::deauth_info is required.
3379 * EVENT_ASSOC_REJECT - Association rejected
3381 * This event should be called when (re)association attempt has been
3382 * rejected by the AP. Information about the association response is
3383 * included in union wpa_event_data::assoc_reject.
3388 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3390 EVENT_AUTH_TIMED_OUT,
3393 * EVENT_ASSOC_TIMED_OUT - Association timed out
3395 EVENT_ASSOC_TIMED_OUT,
3398 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3400 EVENT_WPS_BUTTON_PUSHED,
3403 * EVENT_TX_STATUS - Report TX status
3408 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3410 EVENT_RX_FROM_UNKNOWN,
3413 * EVENT_RX_MGMT - Report RX of a management frame
3418 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3420 * This event is used to indicate when the driver has started the
3421 * requested remain-on-channel duration. Information about the
3422 * operation is included in union wpa_event_data::remain_on_channel.
3424 EVENT_REMAIN_ON_CHANNEL,
3427 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3429 * This event is used to indicate when the driver has completed
3430 * remain-on-channel duration, i.e., may noot be available on the
3431 * requested channel anymore. Information about the
3432 * operation is included in union wpa_event_data::remain_on_channel.
3434 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3437 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3439 * This event is used to indicate when a Probe Request frame has been
3440 * received. Information about the received frame is included in
3441 * union wpa_event_data::rx_probe_req. The driver is required to report
3442 * these events only after successfully completed probe_req_report()
3443 * commands to request the events (i.e., report parameter is non-zero)
3444 * in station mode. In AP mode, Probe Request frames should always be
3450 * EVENT_NEW_STA - New wired device noticed
3452 * This event is used to indicate that a new device has been detected
3453 * in a network that does not use association-like functionality (i.e.,
3454 * mainly wired Ethernet). This can be used to start EAPOL
3455 * authenticator when receiving a frame from a device. The address of
3456 * the device is included in union wpa_event_data::new_sta.
3461 * EVENT_EAPOL_RX - Report received EAPOL frame
3463 * When in AP mode with hostapd, this event is required to be used to
3464 * deliver the receive EAPOL frames from the driver.
3469 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3471 * This event is used to indicate changes in the signal strength
3472 * observed in frames received from the current AP if signal strength
3473 * monitoring has been enabled with signal_monitor().
3475 EVENT_SIGNAL_CHANGE,
3478 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3480 * This event is used to indicate that the interface was enabled after
3481 * having been previously disabled, e.g., due to rfkill.
3483 EVENT_INTERFACE_ENABLED,
3486 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3488 * This event is used to indicate that the interface was disabled,
3489 * e.g., due to rfkill.
3491 EVENT_INTERFACE_DISABLED,
3494 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3496 * This event is used to indicate that the channel list has changed,
3497 * e.g., because of a regulatory domain change triggered by scan
3498 * results including an AP advertising a country code.
3500 EVENT_CHANNEL_LIST_CHANGED,
3503 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3505 * This event is used to indicate that the driver cannot maintain this
3506 * interface in its operation mode anymore. The most likely use for
3507 * this is to indicate that AP mode operation is not available due to
3508 * operating channel would need to be changed to a DFS channel when
3509 * the driver does not support radar detection and another virtual
3510 * interfaces caused the operating channel to change. Other similar
3511 * resource conflicts could also trigger this for station mode
3512 * interfaces. This event can be propagated when channel switching
3515 EVENT_INTERFACE_UNAVAILABLE,
3518 * EVENT_BEST_CHANNEL
3520 * Driver generates this event whenever it detects a better channel
3521 * (e.g., based on RSSI or channel use). This information can be used
3522 * to improve channel selection for a new AP/P2P group.
3527 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3529 * This event should be called when a Deauthentication frame is dropped
3530 * due to it not being protected (MFP/IEEE 802.11w).
3531 * union wpa_event_data::unprot_deauth is required to provide more
3532 * details of the frame.
3534 EVENT_UNPROT_DEAUTH,
3537 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3539 * This event should be called when a Disassociation frame is dropped
3540 * due to it not being protected (MFP/IEEE 802.11w).
3541 * union wpa_event_data::unprot_disassoc is required to provide more
3542 * details of the frame.
3544 EVENT_UNPROT_DISASSOC,
3547 * EVENT_STATION_LOW_ACK
3549 * Driver generates this event whenever it detected that a particular
3550 * station was lost. Detection can be through massive transmission
3551 * failures for example.
3553 EVENT_STATION_LOW_ACK,
3556 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3558 EVENT_IBSS_PEER_LOST,
3561 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3563 * This event carries the new replay counter to notify wpa_supplicant
3564 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3565 * completed Group Key Handshake while the host (including
3566 * wpa_supplicant was sleeping).
3568 EVENT_DRIVER_GTK_REKEY,
3571 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3573 EVENT_SCHED_SCAN_STOPPED,
3576 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3578 * This event indicates that the station responded to the poll
3579 * initiated with @poll_client.
3581 EVENT_DRIVER_CLIENT_POLL_OK,
3584 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3586 EVENT_EAPOL_TX_STATUS,
3589 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3591 * Described in wpa_event_data.ch_switch
3596 * EVENT_WNM - Request WNM operation
3598 * This event can be used to request a WNM operation to be performed.
3603 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3605 * This event indicates that the driver reported a connection failure
3606 * with the specified client (for example, max client reached, etc.) in
3609 EVENT_CONNECT_FAILED_REASON,
3612 * EVENT_RADAR_DETECTED - Notify of radar detection
3614 * A radar has been detected on the supplied frequency, hostapd should
3615 * react accordingly (e.g., change channel).
3617 EVENT_DFS_RADAR_DETECTED,
3620 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3622 * After a successful CAC, the channel can be marked clear and used.
3624 EVENT_DFS_CAC_FINISHED,
3627 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3629 * The CAC was not successful, and the channel remains in the previous
3630 * state. This may happen due to a radar beeing detected or other
3631 * external influences.
3633 EVENT_DFS_CAC_ABORTED,
3636 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3638 * The channel which was previously unavailable is now available again.
3640 EVENT_DFS_NOP_FINISHED,
3643 * EVENT_SURVEY - Received survey data
3645 * This event gets triggered when a driver query is issued for survey
3646 * data and the requested data becomes available. The returned data is
3647 * stored in struct survey_results. The results provide at most one
3648 * survey entry for each frequency and at minimum will provide one
3649 * survey entry for one frequency. The survey data can be os_malloc()'d
3650 * and then os_free()'d, so the event callback must only copy data.
3655 * EVENT_SCAN_STARTED - Scan started
3657 * This indicates that driver has started a scan operation either based
3658 * on a request from wpa_supplicant/hostapd or from another application.
3659 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3660 * completed (either successfully or by getting cancelled).
3665 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3667 * This event indicates a set of frequency ranges that should be avoided
3668 * to reduce issues due to interference or internal co-existence
3669 * information in the driver.
3671 EVENT_AVOID_FREQUENCIES,
3674 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3676 EVENT_NEW_PEER_CANDIDATE,
3679 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
3681 * Indicates a pair of primary and secondary channels chosen by ACS
3684 EVENT_ACS_CHANNEL_SELECTED,
3689 * struct freq_survey - Channel survey info
3691 * @ifidx: Interface index in which this survey was observed
3692 * @freq: Center of frequency of the surveyed channel
3693 * @nf: Channel noise floor in dBm
3694 * @channel_time: Amount of time in ms the radio spent on the channel
3695 * @channel_time_busy: Amount of time in ms the radio detected some signal
3696 * that indicated to the radio the channel was not clear
3697 * @channel_time_rx: Amount of time the radio spent receiving data
3698 * @channel_time_tx: Amount of time the radio spent transmitting data
3699 * @filled: bitmask indicating which fields have been reported, see
3700 * SURVEY_HAS_* defines.
3701 * @list: Internal list pointers
3703 struct freq_survey {
3708 u64 channel_time_busy;
3709 u64 channel_time_rx;
3710 u64 channel_time_tx;
3711 unsigned int filled;
3712 struct dl_list list;
3715 #define SURVEY_HAS_NF BIT(0)
3716 #define SURVEY_HAS_CHAN_TIME BIT(1)
3717 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3718 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3719 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3723 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3725 union wpa_event_data {
3727 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3729 * This structure is optional for EVENT_ASSOC calls and required for
3730 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3731 * driver interface does not need to generate separate EVENT_ASSOCINFO
3736 * reassoc - Flag to indicate association or reassociation
3741 * req_ies - (Re)Association Request IEs
3743 * If the driver generates WPA/RSN IE, this event data must be
3744 * returned for WPA handshake to have needed information. If
3745 * wpa_supplicant-generated WPA/RSN IE is used, this
3746 * information event is optional.
3748 * This should start with the first IE (fixed fields before IEs
3749 * are not included).
3754 * req_ies_len - Length of req_ies in bytes
3759 * resp_ies - (Re)Association Response IEs
3761 * Optional association data from the driver. This data is not
3762 * required WPA, but may be useful for some protocols and as
3763 * such, should be reported if this is available to the driver
3766 * This should start with the first IE (fixed fields before IEs
3767 * are not included).
3772 * resp_ies_len - Length of resp_ies in bytes
3774 size_t resp_ies_len;
3777 * beacon_ies - Beacon or Probe Response IEs
3779 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3780 * Probe Response frames from the current AP (i.e., the one
3781 * that the client just associated with). This information is
3782 * used to update WPA/RSN IE for the AP. If this field is not
3783 * set, the results from previous scan will be used. If no
3784 * data for the new AP is found, scan results will be requested
3785 * again (without scan request). At this point, the driver is
3786 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3789 * This should start with the first IE (fixed fields before IEs
3790 * are not included).
3792 const u8 *beacon_ies;
3795 * beacon_ies_len - Length of beacon_ies */
3796 size_t beacon_ies_len;
3799 * freq - Frequency of the operational channel in MHz
3804 * wmm_params - WMM parameters used in this association.
3806 struct wmm_params wmm_params;
3809 * addr - Station address (for AP mode)
3814 * The following is the key management offload information
3817 * @key_replay_ctr_len
3825 * authorized - Status of key management offload,
3831 * key_replay_ctr - Key replay counter value last used
3832 * in a valid EAPOL-Key frame
3834 const u8 *key_replay_ctr;
3837 * key_replay_ctr_len - The length of key_replay_ctr
3839 size_t key_replay_ctr_len;
3842 * ptk_kck - The derived PTK KCK
3847 * ptk_kek_len - The length of ptk_kck
3852 * ptk_kek - The derived PTK KEK
3857 * ptk_kek_len - The length of ptk_kek
3863 * struct disassoc_info - Data for EVENT_DISASSOC events
3865 struct disassoc_info {
3867 * addr - Station address (for AP mode)
3872 * reason_code - Reason Code (host byte order) used in
3873 * Deauthentication frame
3878 * ie - Optional IE(s) in Disassociation frame
3883 * ie_len - Length of ie buffer in octets
3888 * locally_generated - Whether the frame was locally generated
3890 int locally_generated;
3894 * struct deauth_info - Data for EVENT_DEAUTH events
3896 struct deauth_info {
3898 * addr - Station address (for AP mode)
3903 * reason_code - Reason Code (host byte order) used in
3904 * Deauthentication frame
3909 * ie - Optional IE(s) in Deauthentication frame
3914 * ie_len - Length of ie buffer in octets
3919 * locally_generated - Whether the frame was locally generated
3921 int locally_generated;
3925 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3927 struct michael_mic_failure {
3930 } michael_mic_failure;
3933 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3935 struct interface_status {
3938 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3943 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3945 struct pmkid_candidate {
3946 /** BSSID of the PMKID candidate */
3948 /** Smaller the index, higher the priority */
3950 /** Whether RSN IE includes pre-authenticate flag */
3955 * struct stkstart - Data for EVENT_STKSTART
3962 * struct tdls - Data for EVENT_TDLS
3968 TDLS_REQUEST_TEARDOWN
3970 u16 reason_code; /* for teardown */
3974 * struct wnm - Data for EVENT_WNM
3992 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3994 * During FT (IEEE 802.11r) authentication sequence, the driver is
3995 * expected to use this event to report received FT IEs (MDIE, FTIE,
3996 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3997 * IEs for the next message will be delivered through the
3998 * struct wpa_driver_ops::update_ft_ies() callback.
4004 u8 target_ap[ETH_ALEN];
4005 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4007 /** Length of ric_ies buffer in octets */
4012 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4014 struct ibss_rsn_start {
4019 * struct auth_info - Data for EVENT_AUTH events
4025 u16 auth_transaction;
4032 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4034 struct assoc_reject {
4036 * bssid - BSSID of the AP that rejected association
4041 * resp_ies - (Re)Association Response IEs
4043 * Optional association data from the driver. This data is not
4044 * required WPA, but may be useful for some protocols and as
4045 * such, should be reported if this is available to the driver
4048 * This should start with the first IE (fixed fields before IEs
4049 * are not included).
4054 * resp_ies_len - Length of resp_ies in bytes
4056 size_t resp_ies_len;
4059 * status_code - Status Code from (Re)association Response
4064 struct timeout_event {
4069 * struct tx_status - Data for EVENT_TX_STATUS events
4081 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4083 struct rx_from_unknown {
4090 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4098 * drv_priv - Pointer to store driver private BSS information
4100 * If not set to NULL, this is used for comparison with
4101 * hostapd_data->drv_priv to determine which BSS should process
4107 * freq - Frequency (in MHz) on which the frame was received
4112 * ssi_signal - Signal strength in dBm (or 0 if not available)
4118 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4120 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4122 struct remain_on_channel {
4124 * freq - Channel frequency in MHz
4129 * duration - Duration to remain on the channel in milliseconds
4131 unsigned int duration;
4132 } remain_on_channel;
4135 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4136 * @aborted: Whether the scan was aborted
4137 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4138 * @num_freqs: Number of entries in freqs array
4139 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4141 * @num_ssids: Number of entries in ssids array
4147 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4152 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4154 struct rx_probe_req {
4156 * sa - Source address of the received Probe Request frame
4161 * da - Destination address of the received Probe Request frame
4162 * or %NULL if not available
4167 * bssid - BSSID of the received Probe Request frame or %NULL
4173 * ie - IEs from the Probe Request body
4178 * ie_len - Length of ie buffer in octets
4183 * signal - signal strength in dBm (or 0 if not available)
4189 * struct new_sta - Data for EVENT_NEW_STA events
4196 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4205 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4207 struct wpa_signal_info signal_change;
4210 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4211 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4212 * @freq_5: Best 5 GHz band channel frequency in MHz
4213 * @freq_overall: Best channel frequency in MHz
4215 * 0 can be used to indicate no preference in either band.
4217 struct best_channel {
4223 struct unprot_deauth {
4229 struct unprot_disassoc {
4236 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4237 * @addr: station address
4244 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4246 struct ibss_peer_lost {
4251 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4253 struct driver_gtk_rekey {
4255 const u8 *replay_ctr;
4259 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4260 * @addr: station address
4262 struct client_poll {
4267 * struct eapol_tx_status
4268 * @dst: Original destination
4269 * @data: Data starting with IEEE 802.1X header (!)
4270 * @data_len: Length of data
4271 * @ack: Indicates ack or lost frame
4273 * This corresponds to hapd_send_eapol if the frame sent
4274 * there isn't just reported as EVENT_TX_STATUS.
4276 struct eapol_tx_status {
4285 * @freq: Frequency of new channel in MHz
4286 * @ht_enabled: Whether this is an HT channel
4287 * @ch_offset: Secondary channel offset
4288 * @ch_width: Channel width
4289 * @cf1: Center frequency 1
4290 * @cf2: Center frequency 2
4296 enum chan_width ch_width;
4302 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4303 * @addr: Remote client address
4304 * @code: Reason code for connection failure
4306 struct connect_failed_reason {
4312 } connect_failed_reason;
4315 * struct dfs_event - Data for radar detected events
4316 * @freq: Frequency of the channel in MHz
4322 enum chan_width chan_width;
4328 * survey_results - Survey result data for EVENT_SURVEY
4329 * @freq_filter: Requested frequency survey filter, 0 if request
4330 * was for all survey data
4331 * @survey_list: Linked list of survey data
4333 struct survey_results {
4334 unsigned int freq_filter;
4335 struct dl_list survey_list; /* struct freq_survey */
4339 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4340 * @initiator: Initiator of the regulatory change
4341 * @type: Regulatory change type
4342 * @alpha2: Country code (or "" if not available)
4344 struct channel_list_changed {
4345 enum reg_change_initiator initiator;
4348 } channel_list_changed;
4351 * freq_range - List of frequency ranges
4353 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4355 struct wpa_freq_range_list freq_range;
4360 * @peer: Peer address
4362 * @ie_len: Length of @ies
4364 * Notification of new candidate mesh peer.
4373 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4374 * @pri_channel: Selected primary channel
4375 * @sec_channel: Selected secondary channel
4377 struct acs_selected_channels {
4380 } acs_selected_channels;
4384 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4385 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4386 * with struct wpa_driver_ops::init()
4387 * @event: event type (defined above)
4388 * @data: possible extra data for the event
4390 * Driver wrapper code should call this function whenever an event is received
4393 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4394 union wpa_event_data *data);
4398 * The following inline functions are provided for convenience to simplify
4399 * event indication for some of the common events.
4402 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4403 size_t ielen, int reassoc)
4405 union wpa_event_data event;
4406 os_memset(&event, 0, sizeof(event));
4407 event.assoc_info.reassoc = reassoc;
4408 event.assoc_info.req_ies = ie;
4409 event.assoc_info.req_ies_len = ielen;
4410 event.assoc_info.addr = addr;
4411 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4414 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4416 union wpa_event_data event;
4417 os_memset(&event, 0, sizeof(event));
4418 event.disassoc_info.addr = addr;
4419 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4422 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4425 union wpa_event_data event;
4426 os_memset(&event, 0, sizeof(event));
4427 event.eapol_rx.src = src;
4428 event.eapol_rx.data = data;
4429 event.eapol_rx.data_len = data_len;
4430 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4433 /* driver_common.c */
4434 void wpa_scan_results_free(struct wpa_scan_results *res);
4436 /* Convert wpa_event_type to a string for logging */
4437 const char * event_to_string(enum wpa_event_type event);
4439 /* Convert chan_width to a string for logging and control interfaces */
4440 const char * channel_width_to_string(enum chan_width width);
4442 int ht_supported(const struct hostapd_hw_modes *mode);
4443 int vht_supported(const struct hostapd_hw_modes *mode);
4445 struct wowlan_triggers *
4446 wpa_get_wowlan_triggers(const char *wowlan_triggers,
4447 const struct wpa_driver_capa *capa);
4449 /* NULL terminated array of linked in driver wrappers */
4450 extern struct wpa_driver_ops *wpa_drivers[];
4452 #endif /* DRIVER_H */