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
1080 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1081 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1082 unsigned int smps_modes;
1084 unsigned int wmm_ac_supported:1;
1087 int max_sched_scan_ssids;
1088 int sched_scan_supported;
1092 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1094 unsigned int max_remain_on_chan;
1097 * max_stations - Maximum number of associated stations the driver
1098 * supports in AP mode
1100 unsigned int max_stations;
1103 * probe_resp_offloads - Bitmap of supported protocols by the driver
1104 * for Probe Response offloading.
1106 /* Driver Probe Response offloading support for WPS ver. 1 */
1107 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1108 /* Driver Probe Response offloading support for WPS ver. 2 */
1109 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1110 /* Driver Probe Response offloading support for P2P */
1111 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1112 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1113 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1114 unsigned int probe_resp_offloads;
1116 unsigned int max_acl_mac_addrs;
1119 * Number of supported concurrent channels
1121 unsigned int num_multichan_concurrent;
1124 * extended_capa - extended capabilities in driver/device
1126 * Must be allocated and freed by driver and the pointers must be
1127 * valid for the lifetime of the driver, i.e., freed in deinit()
1129 const u8 *extended_capa, *extended_capa_mask;
1130 unsigned int extended_capa_len;
1132 struct wowlan_triggers wowlan_triggers;
1134 /* Driver adds the DS Params Set IE in Probe Request frames */
1135 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1136 /* Driver adds the WFA TPC IE in Probe Request frames */
1137 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1138 /* Driver handles quiet period requests */
1139 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1141 * Driver is capable of inserting the current TX power value into the body of
1142 * transmitted frames.
1143 * Background: Some Action frames include a TPC Report IE. This IE contains a
1144 * TX power field, which has to be updated by lower layers. One such Action
1145 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1146 * of spectrum management). Note that this insertion takes place at a fixed
1147 * offset, namely the 6th byte in the Action frame body.
1149 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1154 struct hostapd_data;
1156 struct hostap_sta_driver_data {
1157 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1158 unsigned long current_tx_rate;
1159 unsigned long inactive_msec;
1160 unsigned long flags;
1161 unsigned long num_ps_buf_frames;
1162 unsigned long tx_retry_failed;
1163 unsigned long tx_retry_count;
1168 struct hostapd_sta_add_params {
1172 const u8 *supp_rates;
1173 size_t supp_rates_len;
1174 u16 listen_interval;
1175 const struct ieee80211_ht_capabilities *ht_capabilities;
1176 const struct ieee80211_vht_capabilities *vht_capabilities;
1177 int vht_opmode_enabled;
1179 u32 flags; /* bitmask of WPA_STA_* flags */
1180 u32 flags_mask; /* unset bits in flags */
1182 enum mesh_plink_state plink_state;
1183 #endif /* CONFIG_MESH */
1184 int set; /* Set STA parameters instead of add */
1186 const u8 *ext_capab;
1187 size_t ext_capab_len;
1188 const u8 *supp_channels;
1189 size_t supp_channels_len;
1190 const u8 *supp_oper_classes;
1191 size_t supp_oper_classes_len;
1194 struct mac_address {
1198 struct hostapd_acl_params {
1200 unsigned int num_mac_acl;
1201 struct mac_address mac_acl[0];
1204 enum wpa_driver_if_type {
1206 * WPA_IF_STATION - Station mode interface
1211 * WPA_IF_AP_VLAN - AP mode VLAN interface
1213 * This interface shares its address and Beacon frame with the main
1219 * WPA_IF_AP_BSS - AP mode BSS interface
1221 * This interface has its own address and Beacon frame.
1226 * WPA_IF_P2P_GO - P2P Group Owner
1231 * WPA_IF_P2P_CLIENT - P2P Client
1236 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1237 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1242 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1243 * abstracted P2P Device function in the driver
1248 struct wpa_init_params {
1252 const char *driver_params;
1253 int use_pae_group_addr;
1257 u8 *own_addr; /* buffer for writing own MAC address */
1261 struct wpa_bss_params {
1262 /** Interface name (for multi-SSID/VLAN support) */
1264 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1273 enum mfp_options ieee80211w;
1276 #define WPA_STA_AUTHORIZED BIT(0)
1277 #define WPA_STA_WMM BIT(1)
1278 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1279 #define WPA_STA_MFP BIT(3)
1280 #define WPA_STA_TDLS_PEER BIT(4)
1281 #define WPA_STA_AUTHENTICATED BIT(5)
1294 WNM_SLEEP_ENTER_CONFIRM,
1295 WNM_SLEEP_ENTER_FAIL,
1296 WNM_SLEEP_EXIT_CONFIRM,
1297 WNM_SLEEP_EXIT_FAIL,
1298 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1299 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1300 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1302 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1304 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1305 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1307 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1310 /* enum chan_width - Channel width definitions */
1322 * struct wpa_signal_info - Information about channel signal quality
1324 struct wpa_signal_info {
1326 int above_threshold;
1331 enum chan_width chanwidth;
1337 * struct beacon_data - Beacon data
1338 * @head: Head portion of Beacon frame (before TIM IE)
1339 * @tail: Tail portion of Beacon frame (after TIM IE)
1340 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1341 * @proberesp_ies: Extra information element(s) to add into Probe Response
1343 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1344 * Response frames or %NULL
1345 * @probe_resp: Probe Response frame template
1346 * @head_len: Length of @head
1347 * @tail_len: Length of @tail
1348 * @beacon_ies_len: Length of beacon_ies in octets
1349 * @proberesp_ies_len: Length of proberesp_ies in octets
1350 * @proberesp_ies_len: Length of proberesp_ies in octets
1351 * @probe_resp_len: Length of probe response template (@probe_resp)
1353 struct beacon_data {
1360 size_t head_len, tail_len;
1361 size_t beacon_ies_len;
1362 size_t proberesp_ies_len;
1363 size_t assocresp_ies_len;
1364 size_t probe_resp_len;
1368 * struct csa_settings - Settings for channel switch command
1369 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1370 * @block_tx: 1 - block transmission for CSA period
1371 * @freq_params: Next channel frequency parameter
1372 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1373 * @beacon_after: Next beacon/probe resp/asooc resp info
1374 * @counter_offset_beacon: Offset to the count field in beacon's tail
1375 * @counter_offset_presp: Offset to the count field in probe resp.
1377 struct csa_settings {
1381 struct hostapd_freq_params freq_params;
1382 struct beacon_data beacon_csa;
1383 struct beacon_data beacon_after;
1385 u16 counter_offset_beacon;
1386 u16 counter_offset_presp;
1389 /* TDLS peer capabilities for send_tdls_mgmt() */
1390 enum tdls_peer_capability {
1391 TDLS_PEER_HT = BIT(0),
1392 TDLS_PEER_VHT = BIT(1),
1393 TDLS_PEER_WMM = BIT(2),
1396 /* valid info in the wmm_params struct */
1397 enum wmm_params_valid_info {
1398 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1402 * struct wmm_params - WMM parameterss configured for this association
1403 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1404 * of the struct contain valid information.
1405 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1406 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1413 #ifdef CONFIG_MACSEC
1414 struct macsec_init_params {
1415 Boolean always_include_sci;
1419 #endif /* CONFIG_MACSEC */
1421 enum drv_br_port_attr {
1422 DRV_BR_PORT_ATTR_PROXYARP,
1423 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1426 enum drv_br_net_param {
1427 DRV_BR_NET_PARAM_GARP_ACCEPT,
1430 struct drv_acs_params {
1431 /* Selected mode (HOSTAPD_MODE_*) */
1432 enum hostapd_hw_mode hw_mode;
1434 /* Indicates whether HT is enabled */
1437 /* Indicates whether HT40 is enabled */
1443 * struct wpa_driver_ops - Driver interface API definition
1445 * This structure defines the API that each driver interface needs to implement
1446 * for core wpa_supplicant code. All driver specific functionality is captured
1449 struct wpa_driver_ops {
1450 /** Name of the driver interface */
1452 /** One line description of the driver interface */
1456 * get_bssid - Get the current BSSID
1457 * @priv: private driver interface data
1458 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1460 * Returns: 0 on success, -1 on failure
1462 * Query kernel driver for the current BSSID and copy it to bssid.
1463 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1466 int (*get_bssid)(void *priv, u8 *bssid);
1469 * get_ssid - Get the current SSID
1470 * @priv: private driver interface data
1471 * @ssid: buffer for SSID (at least 32 bytes)
1473 * Returns: Length of the SSID on success, -1 on failure
1475 * Query kernel driver for the current SSID and copy it to ssid.
1476 * Returning zero is recommended if the STA is not associated.
1478 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1479 * can, at least in theory, contain control characters (including nul)
1480 * and as such, should be processed as binary data, not a printable
1483 int (*get_ssid)(void *priv, u8 *ssid);
1486 * set_key - Configure encryption key
1487 * @ifname: Interface name (for multi-SSID/VLAN support)
1488 * @priv: private driver interface data
1489 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1490 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1491 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1492 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1493 * %WPA_ALG_BIP_CMAC_256);
1494 * %WPA_ALG_NONE clears the key.
1495 * @addr: Address of the peer STA (BSSID of the current AP when setting
1496 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1497 * broadcast keys, %NULL for default keys that are used both for
1498 * broadcast and unicast; when clearing keys, %NULL is used to
1499 * indicate that both the broadcast-only and default key of the
1500 * specified key index is to be cleared
1501 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1503 * @set_tx: configure this key as the default Tx key (only used when
1504 * driver does not support separate unicast/individual key
1505 * @seq: sequence number/packet number, seq_len octets, the next
1506 * packet number to be used for in replay protection; configured
1507 * for Rx keys (in most cases, this is only used with broadcast
1508 * keys and set to zero for unicast keys); %NULL if not set
1509 * @seq_len: length of the seq, depends on the algorithm:
1510 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1511 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1513 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1514 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1516 * Returns: 0 on success, -1 on failure
1518 * Configure the given key for the kernel driver. If the driver
1519 * supports separate individual keys (4 default keys + 1 individual),
1520 * addr can be used to determine whether the key is default or
1521 * individual. If only 4 keys are supported, the default key with key
1522 * index 0 is used as the individual key. STA must be configured to use
1523 * it as the default Tx key (set_tx is set) and accept Rx for all the
1524 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1525 * broadcast keys, so key index 0 is available for this kind of
1528 * Please note that TKIP keys include separate TX and RX MIC keys and
1529 * some drivers may expect them in different order than wpa_supplicant
1530 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1531 * will trigger Michael MIC errors. This can be fixed by changing the
1532 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1533 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1534 * example on how this can be done.
1536 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1537 const u8 *addr, int key_idx, int set_tx,
1538 const u8 *seq, size_t seq_len,
1539 const u8 *key, size_t key_len);
1542 * init - Initialize driver interface
1543 * @ctx: context to be used when calling wpa_supplicant functions,
1544 * e.g., wpa_supplicant_event()
1545 * @ifname: interface name, e.g., wlan0
1547 * Returns: Pointer to private data, %NULL on failure
1549 * Initialize driver interface, including event processing for kernel
1550 * driver events (e.g., associated, scan results, Michael MIC failure).
1551 * This function can allocate a private configuration data area for
1552 * @ctx, file descriptor, interface name, etc. information that may be
1553 * needed in future driver operations. If this is not used, non-NULL
1554 * value will need to be returned because %NULL is used to indicate
1555 * failure. The returned value will be used as 'void *priv' data for
1556 * all other driver_ops functions.
1558 * The main event loop (eloop.c) of wpa_supplicant can be used to
1559 * register callback for read sockets (eloop_register_read_sock()).
1561 * See below for more information about events and
1562 * wpa_supplicant_event() function.
1564 void * (*init)(void *ctx, const char *ifname);
1567 * deinit - Deinitialize driver interface
1568 * @priv: private driver interface data from init()
1570 * Shut down driver interface and processing of driver events. Free
1571 * private data buffer if one was allocated in init() handler.
1573 void (*deinit)(void *priv);
1576 * set_param - Set driver configuration parameters
1577 * @priv: private driver interface data from init()
1578 * @param: driver specific configuration parameters
1580 * Returns: 0 on success, -1 on failure
1582 * Optional handler for notifying driver interface about configuration
1583 * parameters (driver_param).
1585 int (*set_param)(void *priv, const char *param);
1588 * set_countermeasures - Enable/disable TKIP countermeasures
1589 * @priv: private driver interface data
1590 * @enabled: 1 = countermeasures enabled, 0 = disabled
1592 * Returns: 0 on success, -1 on failure
1594 * Configure TKIP countermeasures. When these are enabled, the driver
1595 * should drop all received and queued frames that are using TKIP.
1597 int (*set_countermeasures)(void *priv, int enabled);
1600 * deauthenticate - Request driver to deauthenticate
1601 * @priv: private driver interface data
1602 * @addr: peer address (BSSID of the AP)
1603 * @reason_code: 16-bit reason code to be sent in the deauthentication
1606 * Returns: 0 on success, -1 on failure
1608 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1611 * associate - Request driver to associate
1612 * @priv: private driver interface data
1613 * @params: association parameters
1615 * Returns: 0 on success, -1 on failure
1617 int (*associate)(void *priv,
1618 struct wpa_driver_associate_params *params);
1621 * add_pmkid - Add PMKSA cache entry to the driver
1622 * @priv: private driver interface data
1623 * @bssid: BSSID for the PMKSA cache entry
1624 * @pmkid: PMKID for the PMKSA cache entry
1626 * Returns: 0 on success, -1 on failure
1628 * This function is called when a new PMK is received, as a result of
1629 * either normal authentication or RSN pre-authentication.
1631 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1632 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1633 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1634 * driver_ops function does not need to be implemented. Likewise, if
1635 * the driver does not support WPA, this function is not needed.
1637 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1640 * remove_pmkid - Remove PMKSA cache entry to the driver
1641 * @priv: private driver interface data
1642 * @bssid: BSSID for the PMKSA cache entry
1643 * @pmkid: PMKID for the PMKSA cache entry
1645 * Returns: 0 on success, -1 on failure
1647 * This function is called when the supplicant drops a PMKSA cache
1648 * entry for any reason.
1650 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1651 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1652 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1653 * from wpa_supplicant, this driver_ops function does not need to be
1654 * implemented. Likewise, if the driver does not support WPA, this
1655 * function is not needed.
1657 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1660 * flush_pmkid - Flush PMKSA cache
1661 * @priv: private driver interface data
1663 * Returns: 0 on success, -1 on failure
1665 * This function is called when the supplicant drops all PMKSA cache
1666 * entries for any reason.
1668 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1669 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1670 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1671 * from wpa_supplicant, this driver_ops function does not need to be
1672 * implemented. Likewise, if the driver does not support WPA, this
1673 * function is not needed.
1675 int (*flush_pmkid)(void *priv);
1678 * get_capa - Get driver capabilities
1679 * @priv: private driver interface data
1681 * Returns: 0 on success, -1 on failure
1683 * Get driver/firmware/hardware capabilities.
1685 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1688 * poll - Poll driver for association information
1689 * @priv: private driver interface data
1691 * This is an option callback that can be used when the driver does not
1692 * provide event mechanism for association events. This is called when
1693 * receiving WPA EAPOL-Key messages that require association
1694 * information. The driver interface is supposed to generate associnfo
1695 * event before returning from this callback function. In addition, the
1696 * driver interface should generate an association event after having
1697 * sent out associnfo.
1699 void (*poll)(void *priv);
1702 * get_ifname - Get interface name
1703 * @priv: private driver interface data
1705 * Returns: Pointer to the interface name. This can differ from the
1706 * interface name used in init() call. Init() is called first.
1708 * This optional function can be used to allow the driver interface to
1709 * replace the interface name with something else, e.g., based on an
1710 * interface mapping from a more descriptive name.
1712 const char * (*get_ifname)(void *priv);
1715 * get_mac_addr - Get own MAC address
1716 * @priv: private driver interface data
1718 * Returns: Pointer to own MAC address or %NULL on failure
1720 * This optional function can be used to get the own MAC address of the
1721 * device from the driver interface code. This is only needed if the
1722 * l2_packet implementation for the OS does not provide easy access to
1724 const u8 * (*get_mac_addr)(void *priv);
1727 * send_eapol - Optional function for sending EAPOL packets
1728 * @priv: private driver interface data
1729 * @dest: Destination MAC address
1731 * @data: EAPOL packet starting with IEEE 802.1X header
1732 * @data_len: Size of the EAPOL packet
1734 * Returns: 0 on success, -1 on failure
1736 * This optional function can be used to override l2_packet operations
1737 * with driver specific functionality. If this function pointer is set,
1738 * l2_packet module is not used at all and the driver interface code is
1739 * responsible for receiving and sending all EAPOL packets. The
1740 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1741 * event. The driver interface is required to implement get_mac_addr()
1742 * handler if send_eapol() is used.
1744 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1745 const u8 *data, size_t data_len);
1748 * set_operstate - Sets device operating state to DORMANT or UP
1749 * @priv: private driver interface data
1750 * @state: 0 = dormant, 1 = up
1751 * Returns: 0 on success, -1 on failure
1753 * This is an optional function that can be used on operating systems
1754 * that support a concept of controlling network device state from user
1755 * space applications. This function, if set, gets called with
1756 * state = 1 when authentication has been completed and with state = 0
1757 * when connection is lost.
1759 int (*set_operstate)(void *priv, int state);
1762 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1763 * @priv: Private driver interface data
1764 * @addr: Address of the station for which to set protection (may be
1765 * %NULL for group keys)
1766 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1767 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1768 * Returns: 0 on success, -1 on failure
1770 * This is an optional function that can be used to set the driver to
1771 * require protection for Tx and/or Rx frames. This uses the layer
1772 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1773 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1774 * set protection operation; instead, they set protection implicitly
1775 * based on configured keys.
1777 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1781 * get_hw_feature_data - Get hardware support data (channels and rates)
1782 * @priv: Private driver interface data
1783 * @num_modes: Variable for returning the number of returned modes
1784 * flags: Variable for returning hardware feature flags
1785 * Returns: Pointer to allocated hardware data on success or %NULL on
1786 * failure. Caller is responsible for freeing this.
1788 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1793 * send_mlme - Send management frame from MLME
1794 * @priv: Private driver interface data
1795 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1796 * @data_len: Size of the management frame
1797 * @noack: Do not wait for this frame to be acked (disable retries)
1798 * Returns: 0 on success, -1 on failure
1800 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1804 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1805 * @priv: Private driver interface data
1806 * @md: Mobility domain (2 octets) (also included inside ies)
1807 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1808 * @ies_len: Length of FT IEs in bytes
1809 * Returns: 0 on success, -1 on failure
1811 * The supplicant uses this callback to let the driver know that keying
1812 * material for FT is available and that the driver can use the
1813 * provided IEs in the next message in FT authentication sequence.
1815 * This function is only needed for driver that support IEEE 802.11r
1816 * (Fast BSS Transition).
1818 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1822 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1823 * @priv: Private driver interface data
1824 * @action: Action field value
1825 * @target_ap: Target AP address
1826 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1827 * @ies_len: Length of FT IEs in bytes
1828 * Returns: 0 on success, -1 on failure
1830 * The supplicant uses this callback to request the driver to transmit
1831 * an FT Action frame (action category 6) for over-the-DS fast BSS
1834 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1835 const u8 *ies, size_t ies_len);
1838 * get_scan_results2 - Fetch the latest scan results
1839 * @priv: private driver interface data
1841 * Returns: Allocated buffer of scan results (caller is responsible for
1842 * freeing the data structure) on success, NULL on failure
1844 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1847 * set_country - Set country
1848 * @priv: Private driver interface data
1849 * @alpha2: country to which to switch to
1850 * Returns: 0 on success, -1 on failure
1852 * This function is for drivers which support some form
1853 * of setting a regulatory domain.
1855 int (*set_country)(void *priv, const char *alpha2);
1858 * get_country - Get country
1859 * @priv: Private driver interface data
1860 * @alpha2: Buffer for returning country code (at least 3 octets)
1861 * Returns: 0 on success, -1 on failure
1863 int (*get_country)(void *priv, char *alpha2);
1866 * global_init - Global driver initialization
1867 * Returns: Pointer to private data (global), %NULL on failure
1869 * This optional function is called to initialize the driver wrapper
1870 * for global data, i.e., data that applies to all interfaces. If this
1871 * function is implemented, global_deinit() will also need to be
1872 * implemented to free the private data. The driver will also likely
1873 * use init2() function instead of init() to get the pointer to global
1874 * data available to per-interface initializer.
1876 void * (*global_init)(void);
1879 * global_deinit - Global driver deinitialization
1880 * @priv: private driver global data from global_init()
1882 * Terminate any global driver related functionality and free the
1883 * global data structure.
1885 void (*global_deinit)(void *priv);
1888 * init2 - Initialize driver interface (with global data)
1889 * @ctx: context to be used when calling wpa_supplicant functions,
1890 * e.g., wpa_supplicant_event()
1891 * @ifname: interface name, e.g., wlan0
1892 * @global_priv: private driver global data from global_init()
1893 * Returns: Pointer to private data, %NULL on failure
1895 * This function can be used instead of init() if the driver wrapper
1898 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1901 * get_interfaces - Get information about available interfaces
1902 * @global_priv: private driver global data from global_init()
1903 * Returns: Allocated buffer of interface information (caller is
1904 * responsible for freeing the data structure) on success, NULL on
1907 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1910 * scan2 - Request the driver to initiate scan
1911 * @priv: private driver interface data
1912 * @params: Scan parameters
1914 * Returns: 0 on success, -1 on failure
1916 * Once the scan results are ready, the driver should report scan
1917 * results event for wpa_supplicant which will eventually request the
1918 * results with wpa_driver_get_scan_results2().
1920 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1923 * authenticate - Request driver to authenticate
1924 * @priv: private driver interface data
1925 * @params: authentication parameters
1926 * Returns: 0 on success, -1 on failure
1928 * This is an optional function that can be used with drivers that
1929 * support separate authentication and association steps, i.e., when
1930 * wpa_supplicant can act as the SME. If not implemented, associate()
1931 * function is expected to take care of IEEE 802.11 authentication,
1934 int (*authenticate)(void *priv,
1935 struct wpa_driver_auth_params *params);
1938 * set_ap - Set Beacon and Probe Response information for AP mode
1939 * @priv: Private driver interface data
1940 * @params: Parameters to use in AP mode
1942 * This function is used to configure Beacon template and/or extra IEs
1943 * to add for Beacon and Probe Response frames for the driver in
1944 * AP mode. The driver is responsible for building the full Beacon
1945 * frame by concatenating the head part with TIM IE generated by the
1946 * driver/firmware and finishing with the tail part. Depending on the
1947 * driver architectue, this can be done either by using the full
1948 * template or the set of additional IEs (e.g., WPS and P2P IE).
1949 * Similarly, Probe Response processing depends on the driver design.
1950 * If the driver (or firmware) takes care of replying to Probe Request
1951 * frames, the extra IEs provided here needs to be added to the Probe
1954 * Returns: 0 on success, -1 on failure
1956 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1959 * set_acl - Set ACL in AP mode
1960 * @priv: Private driver interface data
1961 * @params: Parameters to configure ACL
1962 * Returns: 0 on success, -1 on failure
1964 * This is used only for the drivers which support MAC address ACL.
1966 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1969 * hapd_init - Initialize driver interface (hostapd only)
1970 * @hapd: Pointer to hostapd context
1971 * @params: Configuration for the driver wrapper
1972 * Returns: Pointer to private data, %NULL on failure
1974 * This function is used instead of init() or init2() when the driver
1975 * wrapper is used with hostapd.
1977 void * (*hapd_init)(struct hostapd_data *hapd,
1978 struct wpa_init_params *params);
1981 * hapd_deinit - Deinitialize driver interface (hostapd only)
1982 * @priv: Private driver interface data from hapd_init()
1984 void (*hapd_deinit)(void *priv);
1987 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1988 * @priv: Private driver interface data
1989 * @params: BSS parameters
1990 * Returns: 0 on success, -1 on failure
1992 * This is an optional function to configure the kernel driver to
1993 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1994 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1995 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1996 * for Beacon frames.
1998 * DEPRECATED - use set_ap() instead
2000 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2003 * set_privacy - Enable/disable privacy (AP only)
2004 * @priv: Private driver interface data
2005 * @enabled: 1 = privacy enabled, 0 = disabled
2006 * Returns: 0 on success, -1 on failure
2008 * This is an optional function to configure privacy field in the
2009 * kernel driver for Beacon frames. This can be left undefined (set to
2010 * %NULL) if the driver uses the Beacon template from set_ap().
2012 * DEPRECATED - use set_ap() instead
2014 int (*set_privacy)(void *priv, int enabled);
2017 * get_seqnum - Fetch the current TSC/packet number (AP only)
2018 * @ifname: The interface name (main or virtual)
2019 * @priv: Private driver interface data
2020 * @addr: MAC address of the station or %NULL for group keys
2022 * @seq: Buffer for returning the latest used TSC/packet number
2023 * Returns: 0 on success, -1 on failure
2025 * This function is used to fetch the last used TSC/packet number for
2026 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2027 * keys, so there is no strict requirement on implementing support for
2028 * unicast keys (i.e., addr != %NULL).
2030 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2034 * flush - Flush all association stations (AP only)
2035 * @priv: Private driver interface data
2036 * Returns: 0 on success, -1 on failure
2038 * This function requests the driver to disassociate all associated
2039 * stations. This function does not need to be implemented if the
2040 * driver does not process association frames internally.
2042 int (*flush)(void *priv);
2045 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2046 * @priv: Private driver interface data
2047 * @elem: Information elements
2048 * @elem_len: Length of the elem buffer in octets
2049 * Returns: 0 on success, -1 on failure
2051 * This is an optional function to add information elements in the
2052 * kernel driver for Beacon and Probe Response frames. This can be left
2053 * undefined (set to %NULL) if the driver uses the Beacon template from
2056 * DEPRECATED - use set_ap() instead
2058 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2061 * read_sta_data - Fetch station data
2062 * @priv: Private driver interface data
2063 * @data: Buffer for returning station information
2064 * @addr: MAC address of the station
2065 * Returns: 0 on success, -1 on failure
2067 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2071 * hapd_send_eapol - Send an EAPOL packet (AP only)
2072 * @priv: private driver interface data
2073 * @addr: Destination MAC address
2074 * @data: EAPOL packet starting with IEEE 802.1X header
2075 * @data_len: Length of the EAPOL packet in octets
2076 * @encrypt: Whether the frame should be encrypted
2077 * @own_addr: Source MAC address
2078 * @flags: WPA_STA_* flags for the destination station
2080 * Returns: 0 on success, -1 on failure
2082 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2083 size_t data_len, int encrypt,
2084 const u8 *own_addr, u32 flags);
2087 * sta_deauth - Deauthenticate a station (AP only)
2088 * @priv: Private driver interface data
2089 * @own_addr: Source address and BSSID for the Deauthentication frame
2090 * @addr: MAC address of the station to deauthenticate
2091 * @reason: Reason code for the Deauthentiation frame
2092 * Returns: 0 on success, -1 on failure
2094 * This function requests a specific station to be deauthenticated and
2095 * a Deauthentication frame to be sent to it.
2097 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2101 * sta_disassoc - Disassociate a station (AP only)
2102 * @priv: Private driver interface data
2103 * @own_addr: Source address and BSSID for the Disassociation frame
2104 * @addr: MAC address of the station to disassociate
2105 * @reason: Reason code for the Disassociation frame
2106 * Returns: 0 on success, -1 on failure
2108 * This function requests a specific station to be disassociated and
2109 * a Disassociation frame to be sent to it.
2111 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2115 * sta_remove - Remove a station entry (AP only)
2116 * @priv: Private driver interface data
2117 * @addr: MAC address of the station to be removed
2118 * Returns: 0 on success, -1 on failure
2120 int (*sta_remove)(void *priv, const u8 *addr);
2123 * hapd_get_ssid - Get the current SSID (AP only)
2124 * @priv: Private driver interface data
2125 * @buf: Buffer for returning the SSID
2126 * @len: Maximum length of the buffer
2127 * Returns: Length of the SSID on success, -1 on failure
2129 * This function need not be implemented if the driver uses Beacon
2130 * template from set_ap() and does not reply to Probe Request frames.
2132 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2135 * hapd_set_ssid - Set SSID (AP only)
2136 * @priv: Private driver interface data
2138 * @len: Length of the SSID in octets
2139 * Returns: 0 on success, -1 on failure
2141 * DEPRECATED - use set_ap() instead
2143 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2146 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2147 * @priv: Private driver interface data
2148 * @enabled: 1 = countermeasures enabled, 0 = disabled
2149 * Returns: 0 on success, -1 on failure
2151 * This need not be implemented if the driver does not take care of
2152 * association processing.
2154 int (*hapd_set_countermeasures)(void *priv, int enabled);
2157 * sta_add - Add a station entry
2158 * @priv: Private driver interface data
2159 * @params: Station parameters
2160 * Returns: 0 on success, -1 on failure
2162 * This function is used to add a station entry to the driver once the
2163 * station has completed association. This is only used if the driver
2164 * does not take care of association processing.
2166 * With TDLS, this function is also used to add or set (params->set 1)
2167 * TDLS peer entries.
2169 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2172 * get_inact_sec - Get station inactivity duration (AP only)
2173 * @priv: Private driver interface data
2174 * @addr: Station address
2175 * Returns: Number of seconds station has been inactive, -1 on failure
2177 int (*get_inact_sec)(void *priv, const u8 *addr);
2180 * sta_clear_stats - Clear station statistics (AP only)
2181 * @priv: Private driver interface data
2182 * @addr: Station address
2183 * Returns: 0 on success, -1 on failure
2185 int (*sta_clear_stats)(void *priv, const u8 *addr);
2188 * set_freq - Set channel/frequency (AP only)
2189 * @priv: Private driver interface data
2190 * @freq: Channel parameters
2191 * Returns: 0 on success, -1 on failure
2193 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2196 * set_rts - Set RTS threshold
2197 * @priv: Private driver interface data
2198 * @rts: RTS threshold in octets
2199 * Returns: 0 on success, -1 on failure
2201 int (*set_rts)(void *priv, int rts);
2204 * set_frag - Set fragmentation threshold
2205 * @priv: Private driver interface data
2206 * @frag: Fragmentation threshold in octets
2207 * Returns: 0 on success, -1 on failure
2209 int (*set_frag)(void *priv, int frag);
2212 * sta_set_flags - Set station flags (AP only)
2213 * @priv: Private driver interface data
2214 * @addr: Station address
2215 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2216 * @flags_or: Bitmap of WPA_STA_* flags to add
2217 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2218 * Returns: 0 on success, -1 on failure
2220 int (*sta_set_flags)(void *priv, const u8 *addr,
2221 int total_flags, int flags_or, int flags_and);
2224 * set_tx_queue_params - Set TX queue parameters
2225 * @priv: Private driver interface data
2226 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2230 * @burst_time: Maximum length for bursting in 0.1 msec units
2232 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2233 int cw_max, int burst_time);
2236 * if_add - Add a virtual interface
2237 * @priv: Private driver interface data
2238 * @type: Interface type
2239 * @ifname: Interface name for the new virtual interface
2240 * @addr: Local address to use for the interface or %NULL to use the
2241 * parent interface address
2242 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2243 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2244 * not allowed (applies only to %WPA_IF_AP_BSS type)
2245 * @force_ifname: Buffer for returning an interface name that the
2246 * driver ended up using if it differs from the requested ifname
2247 * @if_addr: Buffer for returning the allocated interface address
2248 * (this may differ from the requested addr if the driver cannot
2249 * change interface address)
2250 * @bridge: Bridge interface to use or %NULL if no bridge configured
2251 * @use_existing: Whether to allow existing interface to be used
2252 * Returns: 0 on success, -1 on failure
2254 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2255 const char *ifname, const u8 *addr, void *bss_ctx,
2256 void **drv_priv, char *force_ifname, u8 *if_addr,
2257 const char *bridge, int use_existing);
2260 * if_remove - Remove a virtual interface
2261 * @priv: Private driver interface data
2262 * @type: Interface type
2263 * @ifname: Interface name of the virtual interface to be removed
2264 * Returns: 0 on success, -1 on failure
2266 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2267 const char *ifname);
2270 * set_sta_vlan - Bind a station into a specific interface (AP only)
2271 * @priv: Private driver interface data
2272 * @ifname: Interface (main or virtual BSS or VLAN)
2273 * @addr: MAC address of the associated station
2275 * Returns: 0 on success, -1 on failure
2277 * This function is used to bind a station to a specific virtual
2278 * interface. It is only used if when virtual interfaces are supported,
2279 * e.g., to assign stations to different VLAN interfaces based on
2280 * information from a RADIUS server. This allows separate broadcast
2281 * domains to be used with a single BSS.
2283 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2287 * commit - Optional commit changes handler (AP only)
2288 * @priv: driver private data
2289 * Returns: 0 on success, -1 on failure
2291 * This optional handler function can be registered if the driver
2292 * interface implementation needs to commit changes (e.g., by setting
2293 * network interface up) at the end of initial configuration. If set,
2294 * this handler will be called after initial setup has been completed.
2296 int (*commit)(void *priv);
2299 * send_ether - Send an ethernet packet (AP only)
2300 * @priv: private driver interface data
2301 * @dst: Destination MAC address
2302 * @src: Source MAC address
2304 * @data: EAPOL packet starting with IEEE 802.1X header
2305 * @data_len: Length of the EAPOL packet in octets
2306 * Returns: 0 on success, -1 on failure
2308 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2309 const u8 *data, size_t data_len);
2312 * set_radius_acl_auth - Notification of RADIUS ACL change
2313 * @priv: Private driver interface data
2314 * @mac: MAC address of the station
2315 * @accepted: Whether the station was accepted
2316 * @session_timeout: Session timeout for the station
2317 * Returns: 0 on success, -1 on failure
2319 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2320 u32 session_timeout);
2323 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2324 * @priv: Private driver interface data
2325 * @mac: MAC address of the station
2326 * Returns: 0 on success, -1 on failure
2328 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2331 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2332 * @priv: Private driver interface data
2333 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2334 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2336 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2337 * to remove extra IE(s)
2338 * Returns: 0 on success, -1 on failure
2340 * This is an optional function to add WPS IE in the kernel driver for
2341 * Beacon and Probe Response frames. This can be left undefined (set
2342 * to %NULL) if the driver uses the Beacon template from set_ap()
2343 * and does not process Probe Request frames. If the driver takes care
2344 * of (Re)Association frame processing, the assocresp buffer includes
2345 * WPS IE(s) that need to be added to (Re)Association Response frames
2346 * whenever a (Re)Association Request frame indicated use of WPS.
2348 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2349 * frames when operating as a GO. The driver is responsible for adding
2350 * timing related attributes (e.g., NoA) in addition to the IEs
2351 * included here by appending them after these buffers. This call is
2352 * also used to provide Probe Response IEs for P2P Listen state
2353 * operations for drivers that generate the Probe Response frames
2356 * DEPRECATED - use set_ap() instead
2358 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2359 const struct wpabuf *proberesp,
2360 const struct wpabuf *assocresp);
2363 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2364 * @priv: Private driver interface data
2365 * @authorized: Whether the port is authorized
2366 * Returns: 0 on success, -1 on failure
2368 int (*set_supp_port)(void *priv, int authorized);
2371 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2372 * @priv: Private driver interface data
2373 * @addr: MAC address of the associated station
2374 * @aid: Association ID
2375 * @val: 1 = bind to 4-address WDS; 0 = unbind
2376 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2377 * to indicate that bridge is not to be used
2378 * @ifname_wds: Buffer to return the interface name for the new WDS
2379 * station or %NULL to indicate name is not returned.
2380 * Returns: 0 on success, -1 on failure
2382 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2383 const char *bridge_ifname, char *ifname_wds);
2386 * send_action - Transmit an Action frame
2387 * @priv: Private driver interface data
2388 * @freq: Frequency (in MHz) of the channel
2389 * @wait: Time to wait off-channel for a response (in ms), or zero
2390 * @dst: Destination MAC address (Address 1)
2391 * @src: Source MAC address (Address 2)
2392 * @bssid: BSSID (Address 3)
2394 * @data_len: data length in octets
2395 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2396 * Returns: 0 on success, -1 on failure
2398 * This command can be used to request the driver to transmit an action
2399 * frame to the specified destination.
2401 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2402 * be transmitted on the given channel and the device will wait for a
2403 * response on that channel for the given wait time.
2405 * If the flag is not set, the wait time will be ignored. In this case,
2406 * if a remain-on-channel duration is in progress, the frame must be
2407 * transmitted on that channel; alternatively the frame may be sent on
2408 * the current operational channel (if in associated state in station
2409 * mode or while operating as an AP.)
2411 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2412 const u8 *dst, const u8 *src, const u8 *bssid,
2413 const u8 *data, size_t data_len, int no_cck);
2416 * send_action_cancel_wait - Cancel action frame TX wait
2417 * @priv: Private driver interface data
2419 * This command cancels the wait time associated with sending an action
2420 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2421 * set in the driver flags.
2423 void (*send_action_cancel_wait)(void *priv);
2426 * remain_on_channel - Remain awake on a channel
2427 * @priv: Private driver interface data
2428 * @freq: Frequency (in MHz) of the channel
2429 * @duration: Duration in milliseconds
2430 * Returns: 0 on success, -1 on failure
2432 * This command is used to request the driver to remain awake on the
2433 * specified channel for the specified duration and report received
2434 * Action frames with EVENT_RX_MGMT events. Optionally, received
2435 * Probe Request frames may also be requested to be reported by calling
2436 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2438 * The driver may not be at the requested channel when this function
2439 * returns, i.e., the return code is only indicating whether the
2440 * request was accepted. The caller will need to wait until the
2441 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2442 * completed the channel change. This may take some time due to other
2443 * need for the radio and the caller should be prepared to timing out
2444 * its wait since there are no guarantees on when this request can be
2447 int (*remain_on_channel)(void *priv, unsigned int freq,
2448 unsigned int duration);
2451 * cancel_remain_on_channel - Cancel remain-on-channel operation
2452 * @priv: Private driver interface data
2454 * This command can be used to cancel a remain-on-channel operation
2455 * before its originally requested duration has passed. This could be
2456 * used, e.g., when remain_on_channel() is used to request extra time
2457 * to receive a response to an Action frame and the response is
2458 * received when there is still unneeded time remaining on the
2459 * remain-on-channel operation.
2461 int (*cancel_remain_on_channel)(void *priv);
2464 * probe_req_report - Request Probe Request frames to be indicated
2465 * @priv: Private driver interface data
2466 * @report: Whether to report received Probe Request frames
2467 * Returns: 0 on success, -1 on failure (or if not supported)
2469 * This command can be used to request the driver to indicate when
2470 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2471 * Since this operation may require extra resources, e.g., due to less
2472 * optimal hardware/firmware RX filtering, many drivers may disable
2473 * Probe Request reporting at least in station mode. This command is
2474 * used to notify the driver when the Probe Request frames need to be
2475 * reported, e.g., during remain-on-channel operations.
2477 int (*probe_req_report)(void *priv, int report);
2480 * deinit_ap - Deinitialize AP mode
2481 * @priv: Private driver interface data
2482 * Returns: 0 on success, -1 on failure (or if not supported)
2484 * This optional function can be used to disable AP mode related
2485 * configuration. If the interface was not dynamically added,
2486 * change the driver mode to station mode to allow normal station
2487 * operations like scanning to be completed.
2489 int (*deinit_ap)(void *priv);
2492 * deinit_p2p_cli - Deinitialize P2P client mode
2493 * @priv: Private driver interface data
2494 * Returns: 0 on success, -1 on failure (or if not supported)
2496 * This optional function can be used to disable P2P client mode. If the
2497 * interface was not dynamically added, change the interface type back
2500 int (*deinit_p2p_cli)(void *priv);
2503 * suspend - Notification on system suspend/hibernate event
2504 * @priv: Private driver interface data
2506 void (*suspend)(void *priv);
2509 * resume - Notification on system resume/thaw event
2510 * @priv: Private driver interface data
2512 void (*resume)(void *priv);
2515 * signal_monitor - Set signal monitoring parameters
2516 * @priv: Private driver interface data
2517 * @threshold: Threshold value for signal change events; 0 = disabled
2518 * @hysteresis: Minimum change in signal strength before indicating a
2520 * Returns: 0 on success, -1 on failure (or if not supported)
2522 * This function can be used to configure monitoring of signal strength
2523 * with the current AP. Whenever signal strength drops below the
2524 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2525 * should be generated assuming the signal strength has changed at
2526 * least %hysteresis from the previously indicated signal change event.
2528 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2531 * send_frame - Send IEEE 802.11 frame (testing use only)
2532 * @priv: Private driver interface data
2533 * @data: IEEE 802.11 frame with IEEE 802.11 header
2534 * @data_len: Size of the frame
2535 * @encrypt: Whether to encrypt the frame (if keys are set)
2536 * Returns: 0 on success, -1 on failure
2538 * This function is only used for debugging purposes and is not
2539 * required to be implemented for normal operations.
2541 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2545 * shared_freq - Get operating frequency of shared interface(s)
2546 * @priv: Private driver interface data
2547 * Returns: Operating frequency in MHz, 0 if no shared operation in
2548 * use, or -1 on failure
2550 * This command can be used to request the current operating frequency
2551 * of any virtual interface that shares the same radio to provide
2552 * information for channel selection for other virtual interfaces.
2554 int (*shared_freq)(void *priv);
2557 * get_noa - Get current Notice of Absence attribute payload
2558 * @priv: Private driver interface data
2559 * @buf: Buffer for returning NoA
2560 * @buf_len: Buffer length in octets
2561 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2562 * advertized, or -1 on failure
2564 * This function is used to fetch the current Notice of Absence
2565 * attribute value from GO.
2567 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2570 * set_noa - Set Notice of Absence parameters for GO (testing)
2571 * @priv: Private driver interface data
2573 * @start: Start time in ms from next TBTT
2574 * @duration: Duration in ms
2575 * Returns: 0 on success or -1 on failure
2577 * This function is used to set Notice of Absence parameters for GO. It
2578 * is used only for testing. To disable NoA, all parameters are set to
2581 int (*set_noa)(void *priv, u8 count, int start, int duration);
2584 * set_p2p_powersave - Set P2P power save options
2585 * @priv: Private driver interface data
2586 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2587 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2588 * @ctwindow: 0.. = change (msec), -1 = no change
2589 * Returns: 0 on success or -1 on failure
2591 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2595 * ampdu - Enable/disable aggregation
2596 * @priv: Private driver interface data
2597 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2598 * Returns: 0 on success or -1 on failure
2600 int (*ampdu)(void *priv, int ampdu);
2603 * get_radio_name - Get physical radio name for the device
2604 * @priv: Private driver interface data
2605 * Returns: Radio name or %NULL if not known
2607 * The returned data must not be modified by the caller. It is assumed
2608 * that any interface that has the same radio name as another is
2609 * sharing the same physical radio. This information can be used to
2610 * share scan results etc. information between the virtual interfaces
2611 * to speed up various operations.
2613 const char * (*get_radio_name)(void *priv);
2616 * send_tdls_mgmt - for sending TDLS management packets
2617 * @priv: private driver interface data
2618 * @dst: Destination (peer) MAC address
2619 * @action_code: TDLS action code for the mssage
2620 * @dialog_token: Dialog Token to use in the message (if needed)
2621 * @status_code: Status Code or Reason Code to use (if needed)
2622 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2623 * @initiator: Is the current end the TDLS link initiator
2624 * @buf: TDLS IEs to add to the message
2625 * @len: Length of buf in octets
2626 * Returns: 0 on success, negative (<0) on failure
2628 * This optional function can be used to send packet to driver which is
2629 * responsible for receiving and sending all TDLS packets.
2631 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2632 u8 dialog_token, u16 status_code, u32 peer_capab,
2633 int initiator, const u8 *buf, size_t len);
2636 * tdls_oper - Ask the driver to perform high-level TDLS operations
2637 * @priv: Private driver interface data
2638 * @oper: TDLS high-level operation. See %enum tdls_oper
2639 * @peer: Destination (peer) MAC address
2640 * Returns: 0 on success, negative (<0) on failure
2642 * This optional function can be used to send high-level TDLS commands
2645 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2648 * wnm_oper - Notify driver of the WNM frame reception
2649 * @priv: Private driver interface data
2650 * @oper: WNM operation. See %enum wnm_oper
2651 * @peer: Destination (peer) MAC address
2652 * @buf: Buffer for the driver to fill in (for getting IE)
2653 * @buf_len: Return the len of buf
2654 * Returns: 0 on success, negative (<0) on failure
2656 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2657 u8 *buf, u16 *buf_len);
2660 * set_qos_map - Set QoS Map
2661 * @priv: Private driver interface data
2662 * @qos_map_set: QoS Map
2663 * @qos_map_set_len: Length of QoS Map
2665 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2666 u8 qos_map_set_len);
2669 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2670 * @priv: Private driver interface data
2671 * @version: IP version of the IP address, 4 or 6
2672 * @ipaddr: IP address for the neigh entry
2673 * @prefixlen: IP address prefix length
2674 * @addr: Corresponding MAC address
2675 * Returns: 0 on success, negative (<0) on failure
2677 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2678 int prefixlen, const u8 *addr);
2681 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2682 * @priv: Private driver interface data
2683 * @version: IP version of the IP address, 4 or 6
2684 * @ipaddr: IP address for the neigh entry
2685 * Returns: 0 on success, negative (<0) on failure
2687 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2690 * br_port_set_attr - Set a bridge port attribute
2691 * @attr: Bridge port attribute to set
2692 * @val: Value to be set
2693 * Returns: 0 on success, negative (<0) on failure
2695 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2699 * br_port_set_attr - Set a bridge network parameter
2700 * @param: Bridge parameter to set
2701 * @val: Value to be set
2702 * Returns: 0 on success, negative (<0) on failure
2704 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2708 * set_wowlan - Set wake-on-wireless triggers
2709 * @priv: Private driver interface data
2710 * @triggers: wowlan triggers
2712 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2715 * signal_poll - Get current connection information
2716 * @priv: Private driver interface data
2717 * @signal_info: Connection info structure
2719 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2722 * set_authmode - Set authentication algorithm(s) for static WEP
2723 * @priv: Private driver interface data
2724 * @authmode: 1=Open System, 2=Shared Key, 3=both
2725 * Returns: 0 on success, -1 on failure
2727 * This function can be used to set authentication algorithms for AP
2728 * mode when static WEP is used. If the driver uses user space MLME/SME
2729 * implementation, there is no need to implement this function.
2731 * DEPRECATED - use set_ap() instead
2733 int (*set_authmode)(void *priv, int authmode);
2737 * driver_cmd - Execute driver-specific command
2738 * @priv: Private driver interface data
2739 * @cmd: Command to execute
2740 * @buf: Return buffer
2741 * @buf_len: Buffer length
2742 * Returns: 0 on success, -1 on failure
2744 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2745 #endif /* ANDROID */
2748 * vendor_cmd - Execute vendor specific command
2749 * @priv: Private driver interface data
2750 * @vendor_id: Vendor id
2751 * @subcmd: Vendor command id
2752 * @data: Vendor command parameters (%NULL if no parameters)
2753 * @data_len: Data length
2754 * @buf: Return buffer (%NULL to ignore reply)
2755 * Returns: 0 on success, negative (<0) on failure
2757 * This function handles vendor specific commands that are passed to
2758 * the driver/device. The command is identified by vendor id and
2759 * command id. Parameters can be passed as argument to the command
2760 * in the data buffer. Reply (if any) will be filled in the supplied
2763 * The exact driver behavior is driver interface and vendor specific. As
2764 * an example, this will be converted to a vendor specific cfg80211
2765 * command in case of the nl80211 driver interface.
2767 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2768 unsigned int subcmd, const u8 *data, size_t data_len,
2769 struct wpabuf *buf);
2772 * set_rekey_info - Set rekey information
2773 * @priv: Private driver interface data
2776 * @replay_ctr: Current EAPOL-Key Replay Counter
2778 * This optional function can be used to provide information for the
2779 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2780 * while the host (including wpa_supplicant) is sleeping.
2782 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2783 const u8 *replay_ctr);
2786 * sta_assoc - Station association indication
2787 * @priv: Private driver interface data
2788 * @own_addr: Source address and BSSID for association frame
2789 * @addr: MAC address of the station to associate
2790 * @reassoc: flag to indicate re-association
2791 * @status: association response status code
2792 * @ie: assoc response ie buffer
2793 * @len: ie buffer length
2794 * Returns: 0 on success, -1 on failure
2796 * This function indicates the driver to send (Re)Association
2797 * Response frame to the station.
2799 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2800 int reassoc, u16 status, const u8 *ie, size_t len);
2803 * sta_auth - Station authentication indication
2804 * @priv: Private driver interface data
2805 * @own_addr: Source address and BSSID for authentication frame
2806 * @addr: MAC address of the station to associate
2807 * @seq: authentication sequence number
2808 * @status: authentication response status code
2809 * @ie: authentication frame ie buffer
2810 * @len: ie buffer length
2812 * This function indicates the driver to send Authentication frame
2815 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2816 u16 seq, u16 status, const u8 *ie, size_t len);
2819 * add_tspec - Add traffic stream
2820 * @priv: Private driver interface data
2821 * @addr: MAC address of the station to associate
2822 * @tspec_ie: tspec ie buffer
2823 * @tspec_ielen: tspec ie length
2824 * Returns: 0 on success, -1 on failure
2826 * This function adds the traffic steam for the station
2827 * and fills the medium_time in tspec_ie.
2829 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2830 size_t tspec_ielen);
2833 * add_sta_node - Add a station node in the driver
2834 * @priv: Private driver interface data
2835 * @addr: MAC address of the station to add
2836 * @auth_alg: authentication algorithm used by the station
2837 * Returns: 0 on success, -1 on failure
2839 * This function adds the station node in the driver, when
2840 * the station gets added by FT-over-DS.
2842 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2845 * sched_scan - Request the driver to initiate scheduled scan
2846 * @priv: Private driver interface data
2847 * @params: Scan parameters
2848 * @interval: Interval between scan cycles in milliseconds
2849 * Returns: 0 on success, -1 on failure
2851 * This operation should be used for scheduled scan offload to
2852 * the hardware. Every time scan results are available, the
2853 * driver should report scan results event for wpa_supplicant
2854 * which will eventually request the results with
2855 * wpa_driver_get_scan_results2(). This operation is optional
2856 * and if not provided or if it returns -1, we fall back to
2857 * normal host-scheduled scans.
2859 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2863 * stop_sched_scan - Request the driver to stop a scheduled scan
2864 * @priv: Private driver interface data
2865 * Returns: 0 on success, -1 on failure
2867 * This should cause the scheduled scan to be stopped and
2868 * results should stop being sent. Must be supported if
2869 * sched_scan is supported.
2871 int (*stop_sched_scan)(void *priv);
2874 * poll_client - Probe (null data or such) the given station
2875 * @priv: Private driver interface data
2876 * @own_addr: MAC address of sending interface
2877 * @addr: MAC address of the station to probe
2878 * @qos: Indicates whether station is QoS station
2880 * This function is used to verify whether an associated station is
2881 * still present. This function does not need to be implemented if the
2882 * driver provides such inactivity polling mechanism.
2884 void (*poll_client)(void *priv, const u8 *own_addr,
2885 const u8 *addr, int qos);
2888 * radio_disable - Disable/enable radio
2889 * @priv: Private driver interface data
2890 * @disabled: 1=disable 0=enable radio
2891 * Returns: 0 on success, -1 on failure
2893 * This optional command is for testing purposes. It can be used to
2894 * disable the radio on a testbed device to simulate out-of-radio-range
2897 int (*radio_disable)(void *priv, int disabled);
2900 * switch_channel - Announce channel switch and migrate the GO to the
2902 * @priv: Private driver interface data
2903 * @settings: Settings for CSA period and new channel
2904 * Returns: 0 on success, -1 on failure
2906 * This function is used to move the GO to the legacy STA channel to
2907 * avoid frequency conflict in single channel concurrency.
2909 int (*switch_channel)(void *priv, struct csa_settings *settings);
2912 * add_tx_ts - Add traffic stream
2913 * @priv: Private driver interface data
2914 * @tsid: Traffic stream ID
2915 * @addr: Receiver address
2916 * @user_prio: User priority of the traffic stream
2917 * @admitted_time: Admitted time for this TS in units of
2918 * 32 microsecond periods (per second).
2919 * Returns: 0 on success, -1 on failure
2921 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
2925 * del_tx_ts - Delete traffic stream
2926 * @priv: Private driver interface data
2927 * @tsid: Traffic stream ID
2928 * @addr: Receiver address
2929 * Returns: 0 on success, -1 on failure
2931 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
2934 * start_dfs_cac - Listen for radar interference on the channel
2935 * @priv: Private driver interface data
2936 * @freq: Channel parameters
2937 * Returns: 0 on success, -1 on failure
2939 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
2942 * stop_ap - Removes beacon from AP
2943 * @priv: Private driver interface data
2944 * Returns: 0 on success, -1 on failure (or if not supported)
2946 * This optional function can be used to disable AP mode related
2947 * configuration. Unlike deinit_ap, it does not change to station
2950 int (*stop_ap)(void *priv);
2953 * get_survey - Retrieve survey data
2954 * @priv: Private driver interface data
2955 * @freq: If set, survey data for the specified frequency is only
2956 * being requested. If not set, all survey data is requested.
2957 * Returns: 0 on success, -1 on failure
2959 * Use this to retrieve:
2961 * - the observed channel noise floor
2962 * - the amount of time we have spent on the channel
2963 * - the amount of time during which we have spent on the channel that
2964 * the radio has determined the medium is busy and we cannot
2966 * - the amount of time we have spent receiving data
2967 * - the amount of time we have spent transmitting data
2969 * This data can be used for spectrum heuristics. One example is
2970 * Automatic Channel Selection (ACS). The channel survey data is
2971 * kept on a linked list on the channel data, one entry is added
2972 * for each survey. The min_nf of the channel is updated for each
2975 int (*get_survey)(void *priv, unsigned int freq);
2978 * status - Get driver interface status information
2979 * @priv: Private driver interface data
2980 * @buf: Buffer for printing tou the status information
2981 * @buflen: Maximum length of the buffer
2982 * Returns: Length of written status information or -1 on failure
2984 int (*status)(void *priv, char *buf, size_t buflen);
2987 * roaming - Set roaming policy for driver-based BSS selection
2988 * @priv: Private driver interface data
2989 * @allowed: Whether roaming within ESS is allowed
2990 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
2991 * Returns: Length of written status information or -1 on failure
2993 * This optional callback can be used to update roaming policy from the
2994 * associate() command (bssid being set there indicates that the driver
2995 * should not roam before getting this roaming() call to allow roaming.
2996 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
2997 * capability, roaming policy is handled within wpa_supplicant and there
2998 * is no need to implement or react to this callback.
3000 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3003 * set_mac_addr - Set MAC address
3004 * @priv: Private driver interface data
3005 * @addr: MAC address to use or %NULL for setting back to permanent
3006 * Returns: 0 on success, -1 on failure
3008 int (*set_mac_addr)(void *priv, const u8 *addr);
3010 #ifdef CONFIG_MACSEC
3011 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3013 int (*macsec_deinit)(void *priv);
3016 * enable_protect_frames - Set protect frames status
3017 * @priv: Private driver interface data
3018 * @enabled: TRUE = protect frames enabled
3019 * FALSE = protect frames disabled
3020 * Returns: 0 on success, -1 on failure (or if not supported)
3022 int (*enable_protect_frames)(void *priv, Boolean enabled);
3025 * set_replay_protect - Set replay protect status and window size
3026 * @priv: Private driver interface data
3027 * @enabled: TRUE = replay protect enabled
3028 * FALSE = replay protect disabled
3029 * @window: replay window size, valid only when replay protect enabled
3030 * Returns: 0 on success, -1 on failure (or if not supported)
3032 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3035 * set_current_cipher_suite - Set current cipher suite
3036 * @priv: Private driver interface data
3037 * @cs: EUI64 identifier
3038 * @cs_len: Length of the cs buffer in octets
3039 * Returns: 0 on success, -1 on failure (or if not supported)
3041 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3045 * enable_controlled_port - Set controlled port status
3046 * @priv: Private driver interface data
3047 * @enabled: TRUE = controlled port enabled
3048 * FALSE = controlled port disabled
3049 * Returns: 0 on success, -1 on failure (or if not supported)
3051 int (*enable_controlled_port)(void *priv, Boolean enabled);
3054 * get_receive_lowest_pn - Get receive lowest pn
3055 * @priv: Private driver interface data
3056 * @channel: secure channel
3057 * @an: association number
3058 * @lowest_pn: lowest accept pn
3059 * Returns: 0 on success, -1 on failure (or if not supported)
3061 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3065 * get_transmit_next_pn - Get transmit next pn
3066 * @priv: Private driver interface data
3067 * @channel: secure channel
3068 * @an: association number
3070 * Returns: 0 on success, -1 on failure (or if not supported)
3072 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3076 * set_transmit_next_pn - Set transmit next pn
3077 * @priv: Private driver interface data
3078 * @channel: secure channel
3079 * @an: association number
3081 * Returns: 0 on success, -1 on failure (or if not supported)
3083 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3087 * get_available_receive_sc - get available receive channel
3088 * @priv: Private driver interface data
3089 * @channel: secure channel
3090 * Returns: 0 on success, -1 on failure (or if not supported)
3092 int (*get_available_receive_sc)(void *priv, u32 *channel);
3095 * create_receive_sc - create secure channel for receiving
3096 * @priv: Private driver interface data
3097 * @channel: secure channel
3098 * @sci_addr: secure channel identifier - address
3099 * @sci_port: secure channel identifier - port
3100 * @conf_offset: confidentiality offset (0, 30, or 50)
3101 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3103 * Returns: 0 on success, -1 on failure (or if not supported)
3105 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3106 u16 sci_port, unsigned int conf_offset,
3110 * delete_receive_sc - delete secure connection for receiving
3111 * @priv: private driver interface data from init()
3112 * @channel: secure channel
3113 * Returns: 0 on success, -1 on failure
3115 int (*delete_receive_sc)(void *priv, u32 channel);
3118 * create_receive_sa - create secure association for receive
3119 * @priv: private driver interface data from init()
3120 * @channel: secure channel
3121 * @an: association number
3122 * @lowest_pn: the lowest packet number can be received
3123 * @sak: the secure association key
3124 * Returns: 0 on success, -1 on failure
3126 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3127 u32 lowest_pn, const u8 *sak);
3130 * enable_receive_sa - enable the SA for receive
3131 * @priv: private driver interface data from init()
3132 * @channel: secure channel
3133 * @an: association number
3134 * Returns: 0 on success, -1 on failure
3136 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3139 * disable_receive_sa - disable SA for receive
3140 * @priv: private driver interface data from init()
3141 * @channel: secure channel index
3142 * @an: association number
3143 * Returns: 0 on success, -1 on failure
3145 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3148 * get_available_transmit_sc - get available transmit channel
3149 * @priv: Private driver interface data
3150 * @channel: secure channel
3151 * Returns: 0 on success, -1 on failure (or if not supported)
3153 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3156 * create_transmit_sc - create secure connection for transmit
3157 * @priv: private driver interface data from init()
3158 * @channel: secure channel
3159 * @sci_addr: secure channel identifier - address
3160 * @sci_port: secure channel identifier - port
3161 * Returns: 0 on success, -1 on failure
3163 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3164 u16 sci_port, unsigned int conf_offset);
3167 * delete_transmit_sc - delete secure connection for transmit
3168 * @priv: private driver interface data from init()
3169 * @channel: secure channel
3170 * Returns: 0 on success, -1 on failure
3172 int (*delete_transmit_sc)(void *priv, u32 channel);
3175 * create_transmit_sa - create secure association for transmit
3176 * @priv: private driver interface data from init()
3177 * @channel: secure channel index
3178 * @an: association number
3179 * @next_pn: the packet number used as next transmit packet
3180 * @confidentiality: True if the SA is to provide confidentiality
3181 * as well as integrity
3182 * @sak: the secure association key
3183 * Returns: 0 on success, -1 on failure
3185 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3186 Boolean confidentiality, const u8 *sak);
3189 * enable_transmit_sa - enable SA for transmit
3190 * @priv: private driver interface data from init()
3191 * @channel: secure channel
3192 * @an: association number
3193 * Returns: 0 on success, -1 on failure
3195 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3198 * disable_transmit_sa - disable SA for transmit
3199 * @priv: private driver interface data from init()
3200 * @channel: secure channel
3201 * @an: association number
3202 * Returns: 0 on success, -1 on failure
3204 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3205 #endif /* CONFIG_MACSEC */
3208 * init_mesh - Driver specific initialization for mesh
3209 * @priv: Private driver interface data
3210 * Returns: 0 on success, -1 on failure
3212 int (*init_mesh)(void *priv);
3215 * join_mesh - Join a mesh network
3216 * @priv: Private driver interface data
3217 * @params: Mesh configuration parameters
3218 * Returns: 0 on success, -1 on failure
3220 int (*join_mesh)(void *priv,
3221 struct wpa_driver_mesh_join_params *params);
3224 * leave_mesh - Leave a mesh network
3225 * @priv: Private driver interface data
3226 * Returns 0 on success, -1 on failure
3228 int (*leave_mesh)(void *priv);
3231 * do_acs - Automatically select channel
3232 * @priv: Private driver interface data
3233 * @params: Parameters for ACS
3234 * Returns 0 on success, -1 on failure
3236 * This command can be used to offload ACS to the driver if the driver
3237 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3239 int (*do_acs)(void *priv, struct drv_acs_params *params);
3244 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3246 enum wpa_event_type {
3248 * EVENT_ASSOC - Association completed
3250 * This event needs to be delivered when the driver completes IEEE
3251 * 802.11 association or reassociation successfully.
3252 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3253 * after this event has been generated. In addition, optional
3254 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3255 * more information about the association. If the driver interface gets
3256 * both of these events at the same time, it can also include the
3257 * assoc_info data in EVENT_ASSOC call.
3262 * EVENT_DISASSOC - Association lost
3264 * This event should be called when association is lost either due to
3265 * receiving deauthenticate or disassociate frame from the AP or when
3266 * sending either of these frames to the current AP. If the driver
3267 * supports separate deauthentication event, EVENT_DISASSOC should only
3268 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3269 * In AP mode, union wpa_event_data::disassoc_info is required.
3274 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3276 * This event must be delivered when a Michael MIC error is detected by
3277 * the local driver. Additional data for event processing is
3278 * provided with union wpa_event_data::michael_mic_failure. This
3279 * information is used to request new encyption key and to initiate
3280 * TKIP countermeasures if needed.
3282 EVENT_MICHAEL_MIC_FAILURE,
3285 * EVENT_SCAN_RESULTS - Scan results available
3287 * This event must be called whenever scan results are available to be
3288 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3289 * is expected to be used some time after struct wpa_driver_ops::scan()
3290 * is called. If the driver provides an unsolicited event when the scan
3291 * has been completed, this event can be used to trigger
3292 * EVENT_SCAN_RESULTS call. If such event is not available from the
3293 * driver, the driver wrapper code is expected to use a registered
3294 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3295 * scan is expected to be completed. Optional information about
3296 * completed scan can be provided with union wpa_event_data::scan_info.
3301 * EVENT_ASSOCINFO - Report optional extra information for association
3303 * This event can be used to report extra association information for
3304 * EVENT_ASSOC processing. This extra information includes IEs from
3305 * association frames and Beacon/Probe Response frames in union
3306 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3307 * EVENT_ASSOC. Alternatively, the driver interface can include
3308 * assoc_info data in the EVENT_ASSOC call if it has all the
3309 * information available at the same point.
3314 * EVENT_INTERFACE_STATUS - Report interface status changes
3316 * This optional event can be used to report changes in interface
3317 * status (interface added/removed) using union
3318 * wpa_event_data::interface_status. This can be used to trigger
3319 * wpa_supplicant to stop and re-start processing for the interface,
3320 * e.g., when a cardbus card is ejected/inserted.
3322 EVENT_INTERFACE_STATUS,
3325 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3327 * This event can be used to inform wpa_supplicant about candidates for
3328 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3329 * for scan request (ap_scan=2 mode), this event is required for
3330 * pre-authentication. If wpa_supplicant is performing scan request
3331 * (ap_scan=1), this event is optional since scan results can be used
3332 * to add pre-authentication candidates. union
3333 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3334 * candidate and priority of the candidate, e.g., based on the signal
3335 * strength, in order to try to pre-authenticate first with candidates
3336 * that are most likely targets for re-association.
3338 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3339 * on the candidate list. In addition, it can be called for the current
3340 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3341 * will automatically skip pre-authentication in cases where a valid
3342 * PMKSA exists. When more than one candidate exists, this event should
3343 * be generated once for each candidate.
3345 * Driver will be notified about successful pre-authentication with
3346 * struct wpa_driver_ops::add_pmkid() calls.
3348 EVENT_PMKID_CANDIDATE,
3351 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3353 * This event can be used to inform wpa_supplicant about desire to set
3354 * up secure direct link connection between two stations as defined in
3355 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3356 * STAKey negotiation. The caller will need to set peer address for the
3362 * EVENT_TDLS - Request TDLS operation
3364 * This event can be used to request a TDLS operation to be performed.
3369 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3371 * The driver is expected to report the received FT IEs from
3372 * FT authentication sequence from the AP. The FT IEs are included in
3373 * the extra information in union wpa_event_data::ft_ies.
3378 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3380 * The driver can use this event to inform wpa_supplicant about a STA
3381 * in an IBSS with which protected frames could be exchanged. This
3382 * event starts RSN authentication with the other STA to authenticate
3383 * the STA and set up encryption keys with it.
3385 EVENT_IBSS_RSN_START,
3388 * EVENT_AUTH - Authentication result
3390 * This event should be called when authentication attempt has been
3391 * completed. This is only used if the driver supports separate
3392 * authentication step (struct wpa_driver_ops::authenticate).
3393 * Information about authentication result is included in
3394 * union wpa_event_data::auth.
3399 * EVENT_DEAUTH - Authentication lost
3401 * This event should be called when authentication is lost either due
3402 * to receiving deauthenticate frame from the AP or when sending that
3403 * frame to the current AP.
3404 * In AP mode, union wpa_event_data::deauth_info is required.
3409 * EVENT_ASSOC_REJECT - Association rejected
3411 * This event should be called when (re)association attempt has been
3412 * rejected by the AP. Information about the association response is
3413 * included in union wpa_event_data::assoc_reject.
3418 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3420 EVENT_AUTH_TIMED_OUT,
3423 * EVENT_ASSOC_TIMED_OUT - Association timed out
3425 EVENT_ASSOC_TIMED_OUT,
3428 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3430 EVENT_WPS_BUTTON_PUSHED,
3433 * EVENT_TX_STATUS - Report TX status
3438 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3440 EVENT_RX_FROM_UNKNOWN,
3443 * EVENT_RX_MGMT - Report RX of a management frame
3448 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3450 * This event is used to indicate when the driver has started the
3451 * requested remain-on-channel duration. Information about the
3452 * operation is included in union wpa_event_data::remain_on_channel.
3454 EVENT_REMAIN_ON_CHANNEL,
3457 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3459 * This event is used to indicate when the driver has completed
3460 * remain-on-channel duration, i.e., may noot be available on the
3461 * requested channel anymore. Information about the
3462 * operation is included in union wpa_event_data::remain_on_channel.
3464 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3467 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3469 * This event is used to indicate when a Probe Request frame has been
3470 * received. Information about the received frame is included in
3471 * union wpa_event_data::rx_probe_req. The driver is required to report
3472 * these events only after successfully completed probe_req_report()
3473 * commands to request the events (i.e., report parameter is non-zero)
3474 * in station mode. In AP mode, Probe Request frames should always be
3480 * EVENT_NEW_STA - New wired device noticed
3482 * This event is used to indicate that a new device has been detected
3483 * in a network that does not use association-like functionality (i.e.,
3484 * mainly wired Ethernet). This can be used to start EAPOL
3485 * authenticator when receiving a frame from a device. The address of
3486 * the device is included in union wpa_event_data::new_sta.
3491 * EVENT_EAPOL_RX - Report received EAPOL frame
3493 * When in AP mode with hostapd, this event is required to be used to
3494 * deliver the receive EAPOL frames from the driver. With
3495 * %wpa_supplicant, this event is used only if the send_eapol() handler
3496 * is used to override the use of l2_packet for EAPOL frame TX.
3501 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3503 * This event is used to indicate changes in the signal strength
3504 * observed in frames received from the current AP if signal strength
3505 * monitoring has been enabled with signal_monitor().
3507 EVENT_SIGNAL_CHANGE,
3510 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3512 * This event is used to indicate that the interface was enabled after
3513 * having been previously disabled, e.g., due to rfkill.
3515 EVENT_INTERFACE_ENABLED,
3518 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3520 * This event is used to indicate that the interface was disabled,
3521 * e.g., due to rfkill.
3523 EVENT_INTERFACE_DISABLED,
3526 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3528 * This event is used to indicate that the channel list has changed,
3529 * e.g., because of a regulatory domain change triggered by scan
3530 * results including an AP advertising a country code.
3532 EVENT_CHANNEL_LIST_CHANGED,
3535 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3537 * This event is used to indicate that the driver cannot maintain this
3538 * interface in its operation mode anymore. The most likely use for
3539 * this is to indicate that AP mode operation is not available due to
3540 * operating channel would need to be changed to a DFS channel when
3541 * the driver does not support radar detection and another virtual
3542 * interfaces caused the operating channel to change. Other similar
3543 * resource conflicts could also trigger this for station mode
3544 * interfaces. This event can be propagated when channel switching
3547 EVENT_INTERFACE_UNAVAILABLE,
3550 * EVENT_BEST_CHANNEL
3552 * Driver generates this event whenever it detects a better channel
3553 * (e.g., based on RSSI or channel use). This information can be used
3554 * to improve channel selection for a new AP/P2P group.
3559 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3561 * This event should be called when a Deauthentication frame is dropped
3562 * due to it not being protected (MFP/IEEE 802.11w).
3563 * union wpa_event_data::unprot_deauth is required to provide more
3564 * details of the frame.
3566 EVENT_UNPROT_DEAUTH,
3569 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3571 * This event should be called when a Disassociation frame is dropped
3572 * due to it not being protected (MFP/IEEE 802.11w).
3573 * union wpa_event_data::unprot_disassoc is required to provide more
3574 * details of the frame.
3576 EVENT_UNPROT_DISASSOC,
3579 * EVENT_STATION_LOW_ACK
3581 * Driver generates this event whenever it detected that a particular
3582 * station was lost. Detection can be through massive transmission
3583 * failures for example.
3585 EVENT_STATION_LOW_ACK,
3588 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3590 EVENT_IBSS_PEER_LOST,
3593 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3595 * This event carries the new replay counter to notify wpa_supplicant
3596 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3597 * completed Group Key Handshake while the host (including
3598 * wpa_supplicant was sleeping).
3600 EVENT_DRIVER_GTK_REKEY,
3603 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3605 EVENT_SCHED_SCAN_STOPPED,
3608 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3610 * This event indicates that the station responded to the poll
3611 * initiated with @poll_client.
3613 EVENT_DRIVER_CLIENT_POLL_OK,
3616 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3618 EVENT_EAPOL_TX_STATUS,
3621 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3623 * Described in wpa_event_data.ch_switch
3628 * EVENT_WNM - Request WNM operation
3630 * This event can be used to request a WNM operation to be performed.
3635 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3637 * This event indicates that the driver reported a connection failure
3638 * with the specified client (for example, max client reached, etc.) in
3641 EVENT_CONNECT_FAILED_REASON,
3644 * EVENT_RADAR_DETECTED - Notify of radar detection
3646 * A radar has been detected on the supplied frequency, hostapd should
3647 * react accordingly (e.g., change channel).
3649 EVENT_DFS_RADAR_DETECTED,
3652 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3654 * After a successful CAC, the channel can be marked clear and used.
3656 EVENT_DFS_CAC_FINISHED,
3659 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3661 * The CAC was not successful, and the channel remains in the previous
3662 * state. This may happen due to a radar beeing detected or other
3663 * external influences.
3665 EVENT_DFS_CAC_ABORTED,
3668 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3670 * The channel which was previously unavailable is now available again.
3672 EVENT_DFS_NOP_FINISHED,
3675 * EVENT_SURVEY - Received survey data
3677 * This event gets triggered when a driver query is issued for survey
3678 * data and the requested data becomes available. The returned data is
3679 * stored in struct survey_results. The results provide at most one
3680 * survey entry for each frequency and at minimum will provide one
3681 * survey entry for one frequency. The survey data can be os_malloc()'d
3682 * and then os_free()'d, so the event callback must only copy data.
3687 * EVENT_SCAN_STARTED - Scan started
3689 * This indicates that driver has started a scan operation either based
3690 * on a request from wpa_supplicant/hostapd or from another application.
3691 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3692 * completed (either successfully or by getting cancelled).
3697 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3699 * This event indicates a set of frequency ranges that should be avoided
3700 * to reduce issues due to interference or internal co-existence
3701 * information in the driver.
3703 EVENT_AVOID_FREQUENCIES,
3706 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3708 EVENT_NEW_PEER_CANDIDATE,
3711 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
3713 * Indicates a pair of primary and secondary channels chosen by ACS
3716 EVENT_ACS_CHANNEL_SELECTED,
3721 * struct freq_survey - Channel survey info
3723 * @ifidx: Interface index in which this survey was observed
3724 * @freq: Center of frequency of the surveyed channel
3725 * @nf: Channel noise floor in dBm
3726 * @channel_time: Amount of time in ms the radio spent on the channel
3727 * @channel_time_busy: Amount of time in ms the radio detected some signal
3728 * that indicated to the radio the channel was not clear
3729 * @channel_time_rx: Amount of time the radio spent receiving data
3730 * @channel_time_tx: Amount of time the radio spent transmitting data
3731 * @filled: bitmask indicating which fields have been reported, see
3732 * SURVEY_HAS_* defines.
3733 * @list: Internal list pointers
3735 struct freq_survey {
3740 u64 channel_time_busy;
3741 u64 channel_time_rx;
3742 u64 channel_time_tx;
3743 unsigned int filled;
3744 struct dl_list list;
3747 #define SURVEY_HAS_NF BIT(0)
3748 #define SURVEY_HAS_CHAN_TIME BIT(1)
3749 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3750 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3751 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3755 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3757 union wpa_event_data {
3759 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3761 * This structure is optional for EVENT_ASSOC calls and required for
3762 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3763 * driver interface does not need to generate separate EVENT_ASSOCINFO
3768 * reassoc - Flag to indicate association or reassociation
3773 * req_ies - (Re)Association Request IEs
3775 * If the driver generates WPA/RSN IE, this event data must be
3776 * returned for WPA handshake to have needed information. If
3777 * wpa_supplicant-generated WPA/RSN IE is used, this
3778 * information event is optional.
3780 * This should start with the first IE (fixed fields before IEs
3781 * are not included).
3786 * req_ies_len - Length of req_ies in bytes
3791 * resp_ies - (Re)Association Response IEs
3793 * Optional association data from the driver. This data is not
3794 * required WPA, but may be useful for some protocols and as
3795 * such, should be reported if this is available to the driver
3798 * This should start with the first IE (fixed fields before IEs
3799 * are not included).
3804 * resp_ies_len - Length of resp_ies in bytes
3806 size_t resp_ies_len;
3809 * beacon_ies - Beacon or Probe Response IEs
3811 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3812 * Probe Response frames from the current AP (i.e., the one
3813 * that the client just associated with). This information is
3814 * used to update WPA/RSN IE for the AP. If this field is not
3815 * set, the results from previous scan will be used. If no
3816 * data for the new AP is found, scan results will be requested
3817 * again (without scan request). At this point, the driver is
3818 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3821 * This should start with the first IE (fixed fields before IEs
3822 * are not included).
3824 const u8 *beacon_ies;
3827 * beacon_ies_len - Length of beacon_ies */
3828 size_t beacon_ies_len;
3831 * freq - Frequency of the operational channel in MHz
3836 * wmm_params - WMM parameters used in this association.
3838 struct wmm_params wmm_params;
3841 * addr - Station address (for AP mode)
3846 * The following is the key management offload information
3849 * @key_replay_ctr_len
3857 * authorized - Status of key management offload,
3863 * key_replay_ctr - Key replay counter value last used
3864 * in a valid EAPOL-Key frame
3866 const u8 *key_replay_ctr;
3869 * key_replay_ctr_len - The length of key_replay_ctr
3871 size_t key_replay_ctr_len;
3874 * ptk_kck - The derived PTK KCK
3879 * ptk_kek_len - The length of ptk_kck
3884 * ptk_kek - The derived PTK KEK
3889 * ptk_kek_len - The length of ptk_kek
3895 * struct disassoc_info - Data for EVENT_DISASSOC events
3897 struct disassoc_info {
3899 * addr - Station address (for AP mode)
3904 * reason_code - Reason Code (host byte order) used in
3905 * Deauthentication frame
3910 * ie - Optional IE(s) in Disassociation frame
3915 * ie_len - Length of ie buffer in octets
3920 * locally_generated - Whether the frame was locally generated
3922 int locally_generated;
3926 * struct deauth_info - Data for EVENT_DEAUTH events
3928 struct deauth_info {
3930 * addr - Station address (for AP mode)
3935 * reason_code - Reason Code (host byte order) used in
3936 * Deauthentication frame
3941 * ie - Optional IE(s) in Deauthentication frame
3946 * ie_len - Length of ie buffer in octets
3951 * locally_generated - Whether the frame was locally generated
3953 int locally_generated;
3957 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3959 struct michael_mic_failure {
3962 } michael_mic_failure;
3965 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3967 struct interface_status {
3970 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3975 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3977 struct pmkid_candidate {
3978 /** BSSID of the PMKID candidate */
3980 /** Smaller the index, higher the priority */
3982 /** Whether RSN IE includes pre-authenticate flag */
3987 * struct stkstart - Data for EVENT_STKSTART
3994 * struct tdls - Data for EVENT_TDLS
4000 TDLS_REQUEST_TEARDOWN
4002 u16 reason_code; /* for teardown */
4006 * struct wnm - Data for EVENT_WNM
4024 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4026 * During FT (IEEE 802.11r) authentication sequence, the driver is
4027 * expected to use this event to report received FT IEs (MDIE, FTIE,
4028 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4029 * IEs for the next message will be delivered through the
4030 * struct wpa_driver_ops::update_ft_ies() callback.
4036 u8 target_ap[ETH_ALEN];
4037 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4039 /** Length of ric_ies buffer in octets */
4044 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4046 struct ibss_rsn_start {
4051 * struct auth_info - Data for EVENT_AUTH events
4057 u16 auth_transaction;
4064 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4066 struct assoc_reject {
4068 * bssid - BSSID of the AP that rejected association
4073 * resp_ies - (Re)Association Response IEs
4075 * Optional association data from the driver. This data is not
4076 * required WPA, but may be useful for some protocols and as
4077 * such, should be reported if this is available to the driver
4080 * This should start with the first IE (fixed fields before IEs
4081 * are not included).
4086 * resp_ies_len - Length of resp_ies in bytes
4088 size_t resp_ies_len;
4091 * status_code - Status Code from (Re)association Response
4096 struct timeout_event {
4101 * struct tx_status - Data for EVENT_TX_STATUS events
4113 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4115 struct rx_from_unknown {
4122 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4130 * drv_priv - Pointer to store driver private BSS information
4132 * If not set to NULL, this is used for comparison with
4133 * hostapd_data->drv_priv to determine which BSS should process
4139 * freq - Frequency (in MHz) on which the frame was received
4144 * ssi_signal - Signal strength in dBm (or 0 if not available)
4150 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4152 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4154 struct remain_on_channel {
4156 * freq - Channel frequency in MHz
4161 * duration - Duration to remain on the channel in milliseconds
4163 unsigned int duration;
4164 } remain_on_channel;
4167 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4168 * @aborted: Whether the scan was aborted
4169 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4170 * @num_freqs: Number of entries in freqs array
4171 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4173 * @num_ssids: Number of entries in ssids array
4179 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4184 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4186 struct rx_probe_req {
4188 * sa - Source address of the received Probe Request frame
4193 * da - Destination address of the received Probe Request frame
4194 * or %NULL if not available
4199 * bssid - BSSID of the received Probe Request frame or %NULL
4205 * ie - IEs from the Probe Request body
4210 * ie_len - Length of ie buffer in octets
4215 * signal - signal strength in dBm (or 0 if not available)
4221 * struct new_sta - Data for EVENT_NEW_STA events
4228 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4237 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4239 struct wpa_signal_info signal_change;
4242 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4243 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4244 * @freq_5: Best 5 GHz band channel frequency in MHz
4245 * @freq_overall: Best channel frequency in MHz
4247 * 0 can be used to indicate no preference in either band.
4249 struct best_channel {
4255 struct unprot_deauth {
4261 struct unprot_disassoc {
4268 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4269 * @addr: station address
4276 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4278 struct ibss_peer_lost {
4283 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4285 struct driver_gtk_rekey {
4287 const u8 *replay_ctr;
4291 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4292 * @addr: station address
4294 struct client_poll {
4299 * struct eapol_tx_status
4300 * @dst: Original destination
4301 * @data: Data starting with IEEE 802.1X header (!)
4302 * @data_len: Length of data
4303 * @ack: Indicates ack or lost frame
4305 * This corresponds to hapd_send_eapol if the frame sent
4306 * there isn't just reported as EVENT_TX_STATUS.
4308 struct eapol_tx_status {
4317 * @freq: Frequency of new channel in MHz
4318 * @ht_enabled: Whether this is an HT channel
4319 * @ch_offset: Secondary channel offset
4320 * @ch_width: Channel width
4321 * @cf1: Center frequency 1
4322 * @cf2: Center frequency 2
4328 enum chan_width ch_width;
4334 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4335 * @addr: Remote client address
4336 * @code: Reason code for connection failure
4338 struct connect_failed_reason {
4344 } connect_failed_reason;
4347 * struct dfs_event - Data for radar detected events
4348 * @freq: Frequency of the channel in MHz
4354 enum chan_width chan_width;
4360 * survey_results - Survey result data for EVENT_SURVEY
4361 * @freq_filter: Requested frequency survey filter, 0 if request
4362 * was for all survey data
4363 * @survey_list: Linked list of survey data
4365 struct survey_results {
4366 unsigned int freq_filter;
4367 struct dl_list survey_list; /* struct freq_survey */
4371 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4372 * @initiator: Initiator of the regulatory change
4373 * @type: Regulatory change type
4374 * @alpha2: Country code (or "" if not available)
4376 struct channel_list_changed {
4377 enum reg_change_initiator initiator;
4380 } channel_list_changed;
4383 * freq_range - List of frequency ranges
4385 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4387 struct wpa_freq_range_list freq_range;
4392 * @peer: Peer address
4394 * @ie_len: Length of @ies
4396 * Notification of new candidate mesh peer.
4405 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4406 * @pri_channel: Selected primary channel
4407 * @sec_channel: Selected secondary channel
4409 struct acs_selected_channels {
4412 } acs_selected_channels;
4416 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4417 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4418 * with struct wpa_driver_ops::init()
4419 * @event: event type (defined above)
4420 * @data: possible extra data for the event
4422 * Driver wrapper code should call this function whenever an event is received
4425 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4426 union wpa_event_data *data);
4430 * The following inline functions are provided for convenience to simplify
4431 * event indication for some of the common events.
4434 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4435 size_t ielen, int reassoc)
4437 union wpa_event_data event;
4438 os_memset(&event, 0, sizeof(event));
4439 event.assoc_info.reassoc = reassoc;
4440 event.assoc_info.req_ies = ie;
4441 event.assoc_info.req_ies_len = ielen;
4442 event.assoc_info.addr = addr;
4443 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4446 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4448 union wpa_event_data event;
4449 os_memset(&event, 0, sizeof(event));
4450 event.disassoc_info.addr = addr;
4451 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4454 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4457 union wpa_event_data event;
4458 os_memset(&event, 0, sizeof(event));
4459 event.eapol_rx.src = src;
4460 event.eapol_rx.data = data;
4461 event.eapol_rx.data_len = data_len;
4462 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4465 /* driver_common.c */
4466 void wpa_scan_results_free(struct wpa_scan_results *res);
4468 /* Convert wpa_event_type to a string for logging */
4469 const char * event_to_string(enum wpa_event_type event);
4471 /* Convert chan_width to a string for logging and control interfaces */
4472 const char * channel_width_to_string(enum chan_width width);
4474 int ht_supported(const struct hostapd_hw_modes *mode);
4475 int vht_supported(const struct hostapd_hw_modes *mode);
4477 struct wowlan_triggers *
4478 wpa_get_wowlan_triggers(const char *wowlan_triggers,
4479 const struct wpa_driver_capa *capa);
4481 /* NULL terminated array of linked in driver wrappers */
4482 extern struct wpa_driver_ops *wpa_drivers[];
4484 #endif /* DRIVER_H */