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
;
957 enum ht_mode ht_mode
;
958 struct wpa_driver_mesh_bss_params conf
;
959 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
960 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
961 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
962 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
967 * struct wpa_driver_capa - Driver capability information
969 struct wpa_driver_capa
{
970 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
971 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
972 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
973 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
974 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
975 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
976 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
977 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
978 unsigned int key_mgmt
;
980 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
981 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
982 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
983 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
984 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
985 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
986 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
987 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
988 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
989 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
990 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
991 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
992 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
995 #define WPA_DRIVER_AUTH_OPEN 0x00000001
996 #define WPA_DRIVER_AUTH_SHARED 0x00000002
997 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1000 /* Driver generated WPA/RSN IE */
1001 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1002 /* Driver needs static WEP key setup after association command */
1003 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1004 /* Driver takes care of all DFS operations */
1005 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1006 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
1007 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1008 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1009 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1010 /* Driver provides separate commands for authentication and association (SME in
1011 * wpa_supplicant). */
1012 #define WPA_DRIVER_FLAGS_SME 0x00000020
1013 /* Driver supports AP mode */
1014 #define WPA_DRIVER_FLAGS_AP 0x00000040
1015 /* Driver needs static WEP key setup after association has been completed */
1016 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1017 /* Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1018 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1019 /* Driver supports concurrent P2P operations */
1020 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1022 * Driver uses the initial interface as a dedicated management interface, i.e.,
1023 * it cannot be used for P2P group operations or non-P2P purposes.
1025 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1026 /* This interface is P2P capable (P2P GO or P2P Client) */
1027 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1028 /* Driver supports station and key removal when stopping an AP */
1029 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1031 * Driver uses the initial interface for P2P management interface and non-P2P
1032 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1033 * P2P group operations.
1035 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1037 * Driver is known to use sane error codes, i.e., when it indicates that
1038 * something (e.g., association) fails, there was indeed a failure and the
1039 * operation does not end up getting completed successfully later.
1041 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1042 /* Driver supports off-channel TX */
1043 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1044 /* Driver indicates TX status events for EAPOL Data frames */
1045 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1046 /* Driver indicates TX status events for Deauth/Disassoc frames */
1047 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1048 /* Driver supports roaming (BSS selection) in firmware */
1049 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1050 /* Driver supports operating as a TDLS peer */
1051 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1052 /* Driver requires external TDLS setup/teardown/discovery */
1053 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1054 /* Driver indicates support for Probe Response offloading in AP mode */
1055 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1056 /* Driver supports U-APSD in AP mode */
1057 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1058 /* Driver supports inactivity timer in AP mode */
1059 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1060 /* Driver expects user space implementation of MLME in AP mode */
1061 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1062 /* Driver supports SAE with user space SME */
1063 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1064 /* Driver makes use of OBSS scan mechanism in wpa_supplicant */
1065 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1066 /* Driver supports IBSS (Ad-hoc) mode */
1067 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1068 /* Driver supports radar detection */
1069 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1070 /* Driver supports a dedicated interface for P2P Device */
1071 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1072 /* Driver supports QoS Mapping */
1073 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1074 /* Driver supports CSA in AP mode */
1075 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1076 /* Driver supports mesh */
1077 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1078 /* Driver support ACS offload */
1079 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1080 /* Driver supports key management offload */
1081 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1084 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1085 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1086 unsigned int smps_modes
;
1088 unsigned int wmm_ac_supported
:1;
1091 int max_sched_scan_ssids
;
1092 int sched_scan_supported
;
1096 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1098 unsigned int max_remain_on_chan
;
1101 * max_stations - Maximum number of associated stations the driver
1102 * supports in AP mode
1104 unsigned int max_stations
;
1107 * probe_resp_offloads - Bitmap of supported protocols by the driver
1108 * for Probe Response offloading.
1110 /* Driver Probe Response offloading support for WPS ver. 1 */
1111 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1112 /* Driver Probe Response offloading support for WPS ver. 2 */
1113 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1114 /* Driver Probe Response offloading support for P2P */
1115 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1116 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1117 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1118 unsigned int probe_resp_offloads
;
1120 unsigned int max_acl_mac_addrs
;
1123 * Number of supported concurrent channels
1125 unsigned int num_multichan_concurrent
;
1128 * extended_capa - extended capabilities in driver/device
1130 * Must be allocated and freed by driver and the pointers must be
1131 * valid for the lifetime of the driver, i.e., freed in deinit()
1133 const u8
*extended_capa
, *extended_capa_mask
;
1134 unsigned int extended_capa_len
;
1136 struct wowlan_triggers wowlan_triggers
;
1138 /* Driver adds the DS Params Set IE in Probe Request frames */
1139 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1140 /* Driver adds the WFA TPC IE in Probe Request frames */
1141 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1142 /* Driver handles quiet period requests */
1143 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1145 * Driver is capable of inserting the current TX power value into the body of
1146 * transmitted frames.
1147 * Background: Some Action frames include a TPC Report IE. This IE contains a
1148 * TX power field, which has to be updated by lower layers. One such Action
1149 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1150 * of spectrum management). Note that this insertion takes place at a fixed
1151 * offset, namely the 6th byte in the Action frame body.
1153 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1158 struct hostapd_data
;
1160 struct hostap_sta_driver_data
{
1161 unsigned long rx_packets
, tx_packets
, rx_bytes
, tx_bytes
;
1162 unsigned long current_tx_rate
;
1163 unsigned long inactive_msec
;
1164 unsigned long flags
;
1165 unsigned long num_ps_buf_frames
;
1166 unsigned long tx_retry_failed
;
1167 unsigned long tx_retry_count
;
1172 struct hostapd_sta_add_params
{
1176 const u8
*supp_rates
;
1177 size_t supp_rates_len
;
1178 u16 listen_interval
;
1179 const struct ieee80211_ht_capabilities
*ht_capabilities
;
1180 const struct ieee80211_vht_capabilities
*vht_capabilities
;
1181 int vht_opmode_enabled
;
1183 u32 flags
; /* bitmask of WPA_STA_* flags */
1184 u32 flags_mask
; /* unset bits in flags */
1186 enum mesh_plink_state plink_state
;
1187 #endif /* CONFIG_MESH */
1188 int set
; /* Set STA parameters instead of add */
1190 const u8
*ext_capab
;
1191 size_t ext_capab_len
;
1192 const u8
*supp_channels
;
1193 size_t supp_channels_len
;
1194 const u8
*supp_oper_classes
;
1195 size_t supp_oper_classes_len
;
1198 struct mac_address
{
1202 struct hostapd_acl_params
{
1204 unsigned int num_mac_acl
;
1205 struct mac_address mac_acl
[0];
1208 enum wpa_driver_if_type
{
1210 * WPA_IF_STATION - Station mode interface
1215 * WPA_IF_AP_VLAN - AP mode VLAN interface
1217 * This interface shares its address and Beacon frame with the main
1223 * WPA_IF_AP_BSS - AP mode BSS interface
1225 * This interface has its own address and Beacon frame.
1230 * WPA_IF_P2P_GO - P2P Group Owner
1235 * WPA_IF_P2P_CLIENT - P2P Client
1240 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1241 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1246 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1247 * abstracted P2P Device function in the driver
1252 * WPA_IF_MESH - Mesh interface
1257 struct wpa_init_params
{
1261 const char *driver_params
;
1262 int use_pae_group_addr
;
1266 u8
*own_addr
; /* buffer for writing own MAC address */
1270 struct wpa_bss_params
{
1271 /** Interface name (for multi-SSID/VLAN support) */
1273 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1282 enum mfp_options ieee80211w
;
1285 #define WPA_STA_AUTHORIZED BIT(0)
1286 #define WPA_STA_WMM BIT(1)
1287 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1288 #define WPA_STA_MFP BIT(3)
1289 #define WPA_STA_TDLS_PEER BIT(4)
1290 #define WPA_STA_AUTHENTICATED BIT(5)
1303 WNM_SLEEP_ENTER_CONFIRM
,
1304 WNM_SLEEP_ENTER_FAIL
,
1305 WNM_SLEEP_EXIT_CONFIRM
,
1306 WNM_SLEEP_EXIT_FAIL
,
1307 WNM_SLEEP_TFS_REQ_IE_ADD
, /* STA requests driver to add TFS req IE */
1308 WNM_SLEEP_TFS_REQ_IE_NONE
, /* STA requests empty TFS req IE */
1309 WNM_SLEEP_TFS_REQ_IE_SET
, /* AP requests driver to set TFS req IE for
1311 WNM_SLEEP_TFS_RESP_IE_ADD
, /* AP requests driver to add TFS resp IE
1313 WNM_SLEEP_TFS_RESP_IE_NONE
, /* AP requests empty TFS resp IE */
1314 WNM_SLEEP_TFS_RESP_IE_SET
, /* AP requests driver to set TFS resp IE
1316 WNM_SLEEP_TFS_IE_DEL
/* AP delete the TFS IE */
1319 /* enum chan_width - Channel width definitions */
1331 * struct wpa_signal_info - Information about channel signal quality
1333 struct wpa_signal_info
{
1335 int above_threshold
;
1340 enum chan_width chanwidth
;
1346 * struct beacon_data - Beacon data
1347 * @head: Head portion of Beacon frame (before TIM IE)
1348 * @tail: Tail portion of Beacon frame (after TIM IE)
1349 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1350 * @proberesp_ies: Extra information element(s) to add into Probe Response
1352 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1353 * Response frames or %NULL
1354 * @probe_resp: Probe Response frame template
1355 * @head_len: Length of @head
1356 * @tail_len: Length of @tail
1357 * @beacon_ies_len: Length of beacon_ies in octets
1358 * @proberesp_ies_len: Length of proberesp_ies in octets
1359 * @proberesp_ies_len: Length of proberesp_ies in octets
1360 * @probe_resp_len: Length of probe response template (@probe_resp)
1362 struct beacon_data
{
1369 size_t head_len
, tail_len
;
1370 size_t beacon_ies_len
;
1371 size_t proberesp_ies_len
;
1372 size_t assocresp_ies_len
;
1373 size_t probe_resp_len
;
1377 * struct csa_settings - Settings for channel switch command
1378 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1379 * @block_tx: 1 - block transmission for CSA period
1380 * @freq_params: Next channel frequency parameter
1381 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1382 * @beacon_after: Next beacon/probe resp/asooc resp info
1383 * @counter_offset_beacon: Offset to the count field in beacon's tail
1384 * @counter_offset_presp: Offset to the count field in probe resp.
1386 struct csa_settings
{
1390 struct hostapd_freq_params freq_params
;
1391 struct beacon_data beacon_csa
;
1392 struct beacon_data beacon_after
;
1394 u16 counter_offset_beacon
;
1395 u16 counter_offset_presp
;
1398 /* TDLS peer capabilities for send_tdls_mgmt() */
1399 enum tdls_peer_capability
{
1400 TDLS_PEER_HT
= BIT(0),
1401 TDLS_PEER_VHT
= BIT(1),
1402 TDLS_PEER_WMM
= BIT(2),
1405 /* valid info in the wmm_params struct */
1406 enum wmm_params_valid_info
{
1407 WMM_PARAMS_UAPSD_QUEUES_INFO
= BIT(0),
1411 * struct wmm_params - WMM parameterss configured for this association
1412 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1413 * of the struct contain valid information.
1414 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1415 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1422 #ifdef CONFIG_MACSEC
1423 struct macsec_init_params
{
1424 Boolean always_include_sci
;
1428 #endif /* CONFIG_MACSEC */
1430 enum drv_br_port_attr
{
1431 DRV_BR_PORT_ATTR_PROXYARP
,
1432 DRV_BR_PORT_ATTR_HAIRPIN_MODE
,
1435 enum drv_br_net_param
{
1436 DRV_BR_NET_PARAM_GARP_ACCEPT
,
1439 struct drv_acs_params
{
1440 /* Selected mode (HOSTAPD_MODE_*) */
1441 enum hostapd_hw_mode hw_mode
;
1443 /* Indicates whether HT is enabled */
1446 /* Indicates whether HT40 is enabled */
1452 * struct wpa_driver_ops - Driver interface API definition
1454 * This structure defines the API that each driver interface needs to implement
1455 * for core wpa_supplicant code. All driver specific functionality is captured
1458 struct wpa_driver_ops
{
1459 /** Name of the driver interface */
1461 /** One line description of the driver interface */
1465 * get_bssid - Get the current BSSID
1466 * @priv: private driver interface data
1467 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1469 * Returns: 0 on success, -1 on failure
1471 * Query kernel driver for the current BSSID and copy it to bssid.
1472 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1475 int (*get_bssid
)(void *priv
, u8
*bssid
);
1478 * get_ssid - Get the current SSID
1479 * @priv: private driver interface data
1480 * @ssid: buffer for SSID (at least 32 bytes)
1482 * Returns: Length of the SSID on success, -1 on failure
1484 * Query kernel driver for the current SSID and copy it to ssid.
1485 * Returning zero is recommended if the STA is not associated.
1487 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1488 * can, at least in theory, contain control characters (including nul)
1489 * and as such, should be processed as binary data, not a printable
1492 int (*get_ssid
)(void *priv
, u8
*ssid
);
1495 * set_key - Configure encryption key
1496 * @ifname: Interface name (for multi-SSID/VLAN support)
1497 * @priv: private driver interface data
1498 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1499 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1500 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1501 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1502 * %WPA_ALG_BIP_CMAC_256);
1503 * %WPA_ALG_NONE clears the key.
1504 * @addr: Address of the peer STA (BSSID of the current AP when setting
1505 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1506 * broadcast keys, %NULL for default keys that are used both for
1507 * broadcast and unicast; when clearing keys, %NULL is used to
1508 * indicate that both the broadcast-only and default key of the
1509 * specified key index is to be cleared
1510 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1512 * @set_tx: configure this key as the default Tx key (only used when
1513 * driver does not support separate unicast/individual key
1514 * @seq: sequence number/packet number, seq_len octets, the next
1515 * packet number to be used for in replay protection; configured
1516 * for Rx keys (in most cases, this is only used with broadcast
1517 * keys and set to zero for unicast keys); %NULL if not set
1518 * @seq_len: length of the seq, depends on the algorithm:
1519 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1520 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1522 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1523 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1525 * Returns: 0 on success, -1 on failure
1527 * Configure the given key for the kernel driver. If the driver
1528 * supports separate individual keys (4 default keys + 1 individual),
1529 * addr can be used to determine whether the key is default or
1530 * individual. If only 4 keys are supported, the default key with key
1531 * index 0 is used as the individual key. STA must be configured to use
1532 * it as the default Tx key (set_tx is set) and accept Rx for all the
1533 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1534 * broadcast keys, so key index 0 is available for this kind of
1537 * Please note that TKIP keys include separate TX and RX MIC keys and
1538 * some drivers may expect them in different order than wpa_supplicant
1539 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1540 * will trigger Michael MIC errors. This can be fixed by changing the
1541 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1542 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1543 * example on how this can be done.
1545 int (*set_key
)(const char *ifname
, void *priv
, enum wpa_alg alg
,
1546 const u8
*addr
, int key_idx
, int set_tx
,
1547 const u8
*seq
, size_t seq_len
,
1548 const u8
*key
, size_t key_len
);
1551 * init - Initialize driver interface
1552 * @ctx: context to be used when calling wpa_supplicant functions,
1553 * e.g., wpa_supplicant_event()
1554 * @ifname: interface name, e.g., wlan0
1556 * Returns: Pointer to private data, %NULL on failure
1558 * Initialize driver interface, including event processing for kernel
1559 * driver events (e.g., associated, scan results, Michael MIC failure).
1560 * This function can allocate a private configuration data area for
1561 * @ctx, file descriptor, interface name, etc. information that may be
1562 * needed in future driver operations. If this is not used, non-NULL
1563 * value will need to be returned because %NULL is used to indicate
1564 * failure. The returned value will be used as 'void *priv' data for
1565 * all other driver_ops functions.
1567 * The main event loop (eloop.c) of wpa_supplicant can be used to
1568 * register callback for read sockets (eloop_register_read_sock()).
1570 * See below for more information about events and
1571 * wpa_supplicant_event() function.
1573 void * (*init
)(void *ctx
, const char *ifname
);
1576 * deinit - Deinitialize driver interface
1577 * @priv: private driver interface data from init()
1579 * Shut down driver interface and processing of driver events. Free
1580 * private data buffer if one was allocated in init() handler.
1582 void (*deinit
)(void *priv
);
1585 * set_param - Set driver configuration parameters
1586 * @priv: private driver interface data from init()
1587 * @param: driver specific configuration parameters
1589 * Returns: 0 on success, -1 on failure
1591 * Optional handler for notifying driver interface about configuration
1592 * parameters (driver_param).
1594 int (*set_param
)(void *priv
, const char *param
);
1597 * set_countermeasures - Enable/disable TKIP countermeasures
1598 * @priv: private driver interface data
1599 * @enabled: 1 = countermeasures enabled, 0 = disabled
1601 * Returns: 0 on success, -1 on failure
1603 * Configure TKIP countermeasures. When these are enabled, the driver
1604 * should drop all received and queued frames that are using TKIP.
1606 int (*set_countermeasures
)(void *priv
, int enabled
);
1609 * deauthenticate - Request driver to deauthenticate
1610 * @priv: private driver interface data
1611 * @addr: peer address (BSSID of the AP)
1612 * @reason_code: 16-bit reason code to be sent in the deauthentication
1615 * Returns: 0 on success, -1 on failure
1617 int (*deauthenticate
)(void *priv
, const u8
*addr
, int reason_code
);
1620 * associate - Request driver to associate
1621 * @priv: private driver interface data
1622 * @params: association parameters
1624 * Returns: 0 on success, -1 on failure
1626 int (*associate
)(void *priv
,
1627 struct wpa_driver_associate_params
*params
);
1630 * add_pmkid - Add PMKSA cache entry to the driver
1631 * @priv: private driver interface data
1632 * @bssid: BSSID for the PMKSA cache entry
1633 * @pmkid: PMKID for the PMKSA cache entry
1635 * Returns: 0 on success, -1 on failure
1637 * This function is called when a new PMK is received, as a result of
1638 * either normal authentication or RSN pre-authentication.
1640 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1641 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1642 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1643 * driver_ops function does not need to be implemented. Likewise, if
1644 * the driver does not support WPA, this function is not needed.
1646 int (*add_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
1649 * remove_pmkid - Remove PMKSA cache entry to the driver
1650 * @priv: private driver interface data
1651 * @bssid: BSSID for the PMKSA cache entry
1652 * @pmkid: PMKID for the PMKSA cache entry
1654 * Returns: 0 on success, -1 on failure
1656 * This function is called when the supplicant drops a PMKSA cache
1657 * entry for any reason.
1659 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1660 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1661 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1662 * from wpa_supplicant, this driver_ops function does not need to be
1663 * implemented. Likewise, if the driver does not support WPA, this
1664 * function is not needed.
1666 int (*remove_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
1669 * flush_pmkid - Flush PMKSA cache
1670 * @priv: private driver interface data
1672 * Returns: 0 on success, -1 on failure
1674 * This function is called when the supplicant drops all PMKSA cache
1675 * entries for any reason.
1677 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1678 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1679 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1680 * from wpa_supplicant, this driver_ops function does not need to be
1681 * implemented. Likewise, if the driver does not support WPA, this
1682 * function is not needed.
1684 int (*flush_pmkid
)(void *priv
);
1687 * get_capa - Get driver capabilities
1688 * @priv: private driver interface data
1690 * Returns: 0 on success, -1 on failure
1692 * Get driver/firmware/hardware capabilities.
1694 int (*get_capa
)(void *priv
, struct wpa_driver_capa
*capa
);
1697 * poll - Poll driver for association information
1698 * @priv: private driver interface data
1700 * This is an option callback that can be used when the driver does not
1701 * provide event mechanism for association events. This is called when
1702 * receiving WPA EAPOL-Key messages that require association
1703 * information. The driver interface is supposed to generate associnfo
1704 * event before returning from this callback function. In addition, the
1705 * driver interface should generate an association event after having
1706 * sent out associnfo.
1708 void (*poll
)(void *priv
);
1711 * get_ifname - Get interface name
1712 * @priv: private driver interface data
1714 * Returns: Pointer to the interface name. This can differ from the
1715 * interface name used in init() call. Init() is called first.
1717 * This optional function can be used to allow the driver interface to
1718 * replace the interface name with something else, e.g., based on an
1719 * interface mapping from a more descriptive name.
1721 const char * (*get_ifname
)(void *priv
);
1724 * get_mac_addr - Get own MAC address
1725 * @priv: private driver interface data
1727 * Returns: Pointer to own MAC address or %NULL on failure
1729 * This optional function can be used to get the own MAC address of the
1730 * device from the driver interface code. This is only needed if the
1731 * l2_packet implementation for the OS does not provide easy access to
1733 const u8
* (*get_mac_addr
)(void *priv
);
1736 * set_operstate - Sets device operating state to DORMANT or UP
1737 * @priv: private driver interface data
1738 * @state: 0 = dormant, 1 = up
1739 * Returns: 0 on success, -1 on failure
1741 * This is an optional function that can be used on operating systems
1742 * that support a concept of controlling network device state from user
1743 * space applications. This function, if set, gets called with
1744 * state = 1 when authentication has been completed and with state = 0
1745 * when connection is lost.
1747 int (*set_operstate
)(void *priv
, int state
);
1750 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1751 * @priv: Private driver interface data
1752 * @addr: Address of the station for which to set protection (may be
1753 * %NULL for group keys)
1754 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1755 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1756 * Returns: 0 on success, -1 on failure
1758 * This is an optional function that can be used to set the driver to
1759 * require protection for Tx and/or Rx frames. This uses the layer
1760 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1761 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1762 * set protection operation; instead, they set protection implicitly
1763 * based on configured keys.
1765 int (*mlme_setprotection
)(void *priv
, const u8
*addr
, int protect_type
,
1769 * get_hw_feature_data - Get hardware support data (channels and rates)
1770 * @priv: Private driver interface data
1771 * @num_modes: Variable for returning the number of returned modes
1772 * flags: Variable for returning hardware feature flags
1773 * Returns: Pointer to allocated hardware data on success or %NULL on
1774 * failure. Caller is responsible for freeing this.
1776 struct hostapd_hw_modes
* (*get_hw_feature_data
)(void *priv
,
1781 * send_mlme - Send management frame from MLME
1782 * @priv: Private driver interface data
1783 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1784 * @data_len: Size of the management frame
1785 * @noack: Do not wait for this frame to be acked (disable retries)
1786 * Returns: 0 on success, -1 on failure
1788 int (*send_mlme
)(void *priv
, const u8
*data
, size_t data_len
,
1792 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1793 * @priv: Private driver interface data
1794 * @md: Mobility domain (2 octets) (also included inside ies)
1795 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1796 * @ies_len: Length of FT IEs in bytes
1797 * Returns: 0 on success, -1 on failure
1799 * The supplicant uses this callback to let the driver know that keying
1800 * material for FT is available and that the driver can use the
1801 * provided IEs in the next message in FT authentication sequence.
1803 * This function is only needed for driver that support IEEE 802.11r
1804 * (Fast BSS Transition).
1806 int (*update_ft_ies
)(void *priv
, const u8
*md
, const u8
*ies
,
1810 * get_scan_results2 - Fetch the latest scan results
1811 * @priv: private driver interface data
1813 * Returns: Allocated buffer of scan results (caller is responsible for
1814 * freeing the data structure) on success, NULL on failure
1816 struct wpa_scan_results
* (*get_scan_results2
)(void *priv
);
1819 * set_country - Set country
1820 * @priv: Private driver interface data
1821 * @alpha2: country to which to switch to
1822 * Returns: 0 on success, -1 on failure
1824 * This function is for drivers which support some form
1825 * of setting a regulatory domain.
1827 int (*set_country
)(void *priv
, const char *alpha2
);
1830 * get_country - Get country
1831 * @priv: Private driver interface data
1832 * @alpha2: Buffer for returning country code (at least 3 octets)
1833 * Returns: 0 on success, -1 on failure
1835 int (*get_country
)(void *priv
, char *alpha2
);
1838 * global_init - Global driver initialization
1839 * Returns: Pointer to private data (global), %NULL on failure
1841 * This optional function is called to initialize the driver wrapper
1842 * for global data, i.e., data that applies to all interfaces. If this
1843 * function is implemented, global_deinit() will also need to be
1844 * implemented to free the private data. The driver will also likely
1845 * use init2() function instead of init() to get the pointer to global
1846 * data available to per-interface initializer.
1848 void * (*global_init
)(void);
1851 * global_deinit - Global driver deinitialization
1852 * @priv: private driver global data from global_init()
1854 * Terminate any global driver related functionality and free the
1855 * global data structure.
1857 void (*global_deinit
)(void *priv
);
1860 * init2 - Initialize driver interface (with global data)
1861 * @ctx: context to be used when calling wpa_supplicant functions,
1862 * e.g., wpa_supplicant_event()
1863 * @ifname: interface name, e.g., wlan0
1864 * @global_priv: private driver global data from global_init()
1865 * Returns: Pointer to private data, %NULL on failure
1867 * This function can be used instead of init() if the driver wrapper
1870 void * (*init2
)(void *ctx
, const char *ifname
, void *global_priv
);
1873 * get_interfaces - Get information about available interfaces
1874 * @global_priv: private driver global data from global_init()
1875 * Returns: Allocated buffer of interface information (caller is
1876 * responsible for freeing the data structure) on success, NULL on
1879 struct wpa_interface_info
* (*get_interfaces
)(void *global_priv
);
1882 * scan2 - Request the driver to initiate scan
1883 * @priv: private driver interface data
1884 * @params: Scan parameters
1886 * Returns: 0 on success, -1 on failure
1888 * Once the scan results are ready, the driver should report scan
1889 * results event for wpa_supplicant which will eventually request the
1890 * results with wpa_driver_get_scan_results2().
1892 int (*scan2
)(void *priv
, struct wpa_driver_scan_params
*params
);
1895 * authenticate - Request driver to authenticate
1896 * @priv: private driver interface data
1897 * @params: authentication parameters
1898 * Returns: 0 on success, -1 on failure
1900 * This is an optional function that can be used with drivers that
1901 * support separate authentication and association steps, i.e., when
1902 * wpa_supplicant can act as the SME. If not implemented, associate()
1903 * function is expected to take care of IEEE 802.11 authentication,
1906 int (*authenticate
)(void *priv
,
1907 struct wpa_driver_auth_params
*params
);
1910 * set_ap - Set Beacon and Probe Response information for AP mode
1911 * @priv: Private driver interface data
1912 * @params: Parameters to use in AP mode
1914 * This function is used to configure Beacon template and/or extra IEs
1915 * to add for Beacon and Probe Response frames for the driver in
1916 * AP mode. The driver is responsible for building the full Beacon
1917 * frame by concatenating the head part with TIM IE generated by the
1918 * driver/firmware and finishing with the tail part. Depending on the
1919 * driver architectue, this can be done either by using the full
1920 * template or the set of additional IEs (e.g., WPS and P2P IE).
1921 * Similarly, Probe Response processing depends on the driver design.
1922 * If the driver (or firmware) takes care of replying to Probe Request
1923 * frames, the extra IEs provided here needs to be added to the Probe
1926 * Returns: 0 on success, -1 on failure
1928 int (*set_ap
)(void *priv
, struct wpa_driver_ap_params
*params
);
1931 * set_acl - Set ACL in AP mode
1932 * @priv: Private driver interface data
1933 * @params: Parameters to configure ACL
1934 * Returns: 0 on success, -1 on failure
1936 * This is used only for the drivers which support MAC address ACL.
1938 int (*set_acl
)(void *priv
, struct hostapd_acl_params
*params
);
1941 * hapd_init - Initialize driver interface (hostapd only)
1942 * @hapd: Pointer to hostapd context
1943 * @params: Configuration for the driver wrapper
1944 * Returns: Pointer to private data, %NULL on failure
1946 * This function is used instead of init() or init2() when the driver
1947 * wrapper is used with hostapd.
1949 void * (*hapd_init
)(struct hostapd_data
*hapd
,
1950 struct wpa_init_params
*params
);
1953 * hapd_deinit - Deinitialize driver interface (hostapd only)
1954 * @priv: Private driver interface data from hapd_init()
1956 void (*hapd_deinit
)(void *priv
);
1959 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1960 * @priv: Private driver interface data
1961 * @params: BSS parameters
1962 * Returns: 0 on success, -1 on failure
1964 * This is an optional function to configure the kernel driver to
1965 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1966 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1967 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1968 * for Beacon frames.
1970 * DEPRECATED - use set_ap() instead
1972 int (*set_ieee8021x
)(void *priv
, struct wpa_bss_params
*params
);
1975 * set_privacy - Enable/disable privacy (AP only)
1976 * @priv: Private driver interface data
1977 * @enabled: 1 = privacy enabled, 0 = disabled
1978 * Returns: 0 on success, -1 on failure
1980 * This is an optional function to configure privacy field in the
1981 * kernel driver for Beacon frames. This can be left undefined (set to
1982 * %NULL) if the driver uses the Beacon template from set_ap().
1984 * DEPRECATED - use set_ap() instead
1986 int (*set_privacy
)(void *priv
, int enabled
);
1989 * get_seqnum - Fetch the current TSC/packet number (AP only)
1990 * @ifname: The interface name (main or virtual)
1991 * @priv: Private driver interface data
1992 * @addr: MAC address of the station or %NULL for group keys
1994 * @seq: Buffer for returning the latest used TSC/packet number
1995 * Returns: 0 on success, -1 on failure
1997 * This function is used to fetch the last used TSC/packet number for
1998 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1999 * keys, so there is no strict requirement on implementing support for
2000 * unicast keys (i.e., addr != %NULL).
2002 int (*get_seqnum
)(const char *ifname
, void *priv
, const u8
*addr
,
2006 * flush - Flush all association stations (AP only)
2007 * @priv: Private driver interface data
2008 * Returns: 0 on success, -1 on failure
2010 * This function requests the driver to disassociate all associated
2011 * stations. This function does not need to be implemented if the
2012 * driver does not process association frames internally.
2014 int (*flush
)(void *priv
);
2017 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2018 * @priv: Private driver interface data
2019 * @elem: Information elements
2020 * @elem_len: Length of the elem buffer in octets
2021 * Returns: 0 on success, -1 on failure
2023 * This is an optional function to add information elements in the
2024 * kernel driver for Beacon and Probe Response frames. This can be left
2025 * undefined (set to %NULL) if the driver uses the Beacon template from
2028 * DEPRECATED - use set_ap() instead
2030 int (*set_generic_elem
)(void *priv
, const u8
*elem
, size_t elem_len
);
2033 * read_sta_data - Fetch station data
2034 * @priv: Private driver interface data
2035 * @data: Buffer for returning station information
2036 * @addr: MAC address of the station
2037 * Returns: 0 on success, -1 on failure
2039 int (*read_sta_data
)(void *priv
, struct hostap_sta_driver_data
*data
,
2043 * hapd_send_eapol - Send an EAPOL packet (AP only)
2044 * @priv: private driver interface data
2045 * @addr: Destination MAC address
2046 * @data: EAPOL packet starting with IEEE 802.1X header
2047 * @data_len: Length of the EAPOL packet in octets
2048 * @encrypt: Whether the frame should be encrypted
2049 * @own_addr: Source MAC address
2050 * @flags: WPA_STA_* flags for the destination station
2052 * Returns: 0 on success, -1 on failure
2054 int (*hapd_send_eapol
)(void *priv
, const u8
*addr
, const u8
*data
,
2055 size_t data_len
, int encrypt
,
2056 const u8
*own_addr
, u32 flags
);
2059 * sta_deauth - Deauthenticate a station (AP only)
2060 * @priv: Private driver interface data
2061 * @own_addr: Source address and BSSID for the Deauthentication frame
2062 * @addr: MAC address of the station to deauthenticate
2063 * @reason: Reason code for the Deauthentiation frame
2064 * Returns: 0 on success, -1 on failure
2066 * This function requests a specific station to be deauthenticated and
2067 * a Deauthentication frame to be sent to it.
2069 int (*sta_deauth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2073 * sta_disassoc - Disassociate a station (AP only)
2074 * @priv: Private driver interface data
2075 * @own_addr: Source address and BSSID for the Disassociation frame
2076 * @addr: MAC address of the station to disassociate
2077 * @reason: Reason code for the Disassociation frame
2078 * Returns: 0 on success, -1 on failure
2080 * This function requests a specific station to be disassociated and
2081 * a Disassociation frame to be sent to it.
2083 int (*sta_disassoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2087 * sta_remove - Remove a station entry (AP only)
2088 * @priv: Private driver interface data
2089 * @addr: MAC address of the station to be removed
2090 * Returns: 0 on success, -1 on failure
2092 int (*sta_remove
)(void *priv
, const u8
*addr
);
2095 * hapd_get_ssid - Get the current SSID (AP only)
2096 * @priv: Private driver interface data
2097 * @buf: Buffer for returning the SSID
2098 * @len: Maximum length of the buffer
2099 * Returns: Length of the SSID on success, -1 on failure
2101 * This function need not be implemented if the driver uses Beacon
2102 * template from set_ap() and does not reply to Probe Request frames.
2104 int (*hapd_get_ssid
)(void *priv
, u8
*buf
, int len
);
2107 * hapd_set_ssid - Set SSID (AP only)
2108 * @priv: Private driver interface data
2110 * @len: Length of the SSID in octets
2111 * Returns: 0 on success, -1 on failure
2113 * DEPRECATED - use set_ap() instead
2115 int (*hapd_set_ssid
)(void *priv
, const u8
*buf
, int len
);
2118 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2119 * @priv: Private driver interface data
2120 * @enabled: 1 = countermeasures enabled, 0 = disabled
2121 * Returns: 0 on success, -1 on failure
2123 * This need not be implemented if the driver does not take care of
2124 * association processing.
2126 int (*hapd_set_countermeasures
)(void *priv
, int enabled
);
2129 * sta_add - Add a station entry
2130 * @priv: Private driver interface data
2131 * @params: Station parameters
2132 * Returns: 0 on success, -1 on failure
2134 * This function is used to add a station entry to the driver once the
2135 * station has completed association. This is only used if the driver
2136 * does not take care of association processing.
2138 * With TDLS, this function is also used to add or set (params->set 1)
2139 * TDLS peer entries.
2141 int (*sta_add
)(void *priv
, struct hostapd_sta_add_params
*params
);
2144 * get_inact_sec - Get station inactivity duration (AP only)
2145 * @priv: Private driver interface data
2146 * @addr: Station address
2147 * Returns: Number of seconds station has been inactive, -1 on failure
2149 int (*get_inact_sec
)(void *priv
, const u8
*addr
);
2152 * sta_clear_stats - Clear station statistics (AP only)
2153 * @priv: Private driver interface data
2154 * @addr: Station address
2155 * Returns: 0 on success, -1 on failure
2157 int (*sta_clear_stats
)(void *priv
, const u8
*addr
);
2160 * set_freq - Set channel/frequency (AP only)
2161 * @priv: Private driver interface data
2162 * @freq: Channel parameters
2163 * Returns: 0 on success, -1 on failure
2165 int (*set_freq
)(void *priv
, struct hostapd_freq_params
*freq
);
2168 * set_rts - Set RTS threshold
2169 * @priv: Private driver interface data
2170 * @rts: RTS threshold in octets
2171 * Returns: 0 on success, -1 on failure
2173 int (*set_rts
)(void *priv
, int rts
);
2176 * set_frag - Set fragmentation threshold
2177 * @priv: Private driver interface data
2178 * @frag: Fragmentation threshold in octets
2179 * Returns: 0 on success, -1 on failure
2181 int (*set_frag
)(void *priv
, int frag
);
2184 * sta_set_flags - Set station flags (AP only)
2185 * @priv: Private driver interface data
2186 * @addr: Station address
2187 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2188 * @flags_or: Bitmap of WPA_STA_* flags to add
2189 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2190 * Returns: 0 on success, -1 on failure
2192 int (*sta_set_flags
)(void *priv
, const u8
*addr
,
2193 int total_flags
, int flags_or
, int flags_and
);
2196 * set_tx_queue_params - Set TX queue parameters
2197 * @priv: Private driver interface data
2198 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2202 * @burst_time: Maximum length for bursting in 0.1 msec units
2204 int (*set_tx_queue_params
)(void *priv
, int queue
, int aifs
, int cw_min
,
2205 int cw_max
, int burst_time
);
2208 * if_add - Add a virtual interface
2209 * @priv: Private driver interface data
2210 * @type: Interface type
2211 * @ifname: Interface name for the new virtual interface
2212 * @addr: Local address to use for the interface or %NULL to use the
2213 * parent interface address
2214 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2215 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2216 * not allowed (applies only to %WPA_IF_AP_BSS type)
2217 * @force_ifname: Buffer for returning an interface name that the
2218 * driver ended up using if it differs from the requested ifname
2219 * @if_addr: Buffer for returning the allocated interface address
2220 * (this may differ from the requested addr if the driver cannot
2221 * change interface address)
2222 * @bridge: Bridge interface to use or %NULL if no bridge configured
2223 * @use_existing: Whether to allow existing interface to be used
2224 * Returns: 0 on success, -1 on failure
2226 int (*if_add
)(void *priv
, enum wpa_driver_if_type type
,
2227 const char *ifname
, const u8
*addr
, void *bss_ctx
,
2228 void **drv_priv
, char *force_ifname
, u8
*if_addr
,
2229 const char *bridge
, int use_existing
);
2232 * if_remove - Remove a virtual interface
2233 * @priv: Private driver interface data
2234 * @type: Interface type
2235 * @ifname: Interface name of the virtual interface to be removed
2236 * Returns: 0 on success, -1 on failure
2238 int (*if_remove
)(void *priv
, enum wpa_driver_if_type type
,
2239 const char *ifname
);
2242 * set_sta_vlan - Bind a station into a specific interface (AP only)
2243 * @priv: Private driver interface data
2244 * @ifname: Interface (main or virtual BSS or VLAN)
2245 * @addr: MAC address of the associated station
2247 * Returns: 0 on success, -1 on failure
2249 * This function is used to bind a station to a specific virtual
2250 * interface. It is only used if when virtual interfaces are supported,
2251 * e.g., to assign stations to different VLAN interfaces based on
2252 * information from a RADIUS server. This allows separate broadcast
2253 * domains to be used with a single BSS.
2255 int (*set_sta_vlan
)(void *priv
, const u8
*addr
, const char *ifname
,
2259 * commit - Optional commit changes handler (AP only)
2260 * @priv: driver private data
2261 * Returns: 0 on success, -1 on failure
2263 * This optional handler function can be registered if the driver
2264 * interface implementation needs to commit changes (e.g., by setting
2265 * network interface up) at the end of initial configuration. If set,
2266 * this handler will be called after initial setup has been completed.
2268 int (*commit
)(void *priv
);
2271 * send_ether - Send an ethernet packet (AP only)
2272 * @priv: private driver interface data
2273 * @dst: Destination MAC address
2274 * @src: Source MAC address
2276 * @data: EAPOL packet starting with IEEE 802.1X header
2277 * @data_len: Length of the EAPOL packet in octets
2278 * Returns: 0 on success, -1 on failure
2280 int (*send_ether
)(void *priv
, const u8
*dst
, const u8
*src
, u16 proto
,
2281 const u8
*data
, size_t data_len
);
2284 * set_radius_acl_auth - Notification of RADIUS ACL change
2285 * @priv: Private driver interface data
2286 * @mac: MAC address of the station
2287 * @accepted: Whether the station was accepted
2288 * @session_timeout: Session timeout for the station
2289 * Returns: 0 on success, -1 on failure
2291 int (*set_radius_acl_auth
)(void *priv
, const u8
*mac
, int accepted
,
2292 u32 session_timeout
);
2295 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2296 * @priv: Private driver interface data
2297 * @mac: MAC address of the station
2298 * Returns: 0 on success, -1 on failure
2300 int (*set_radius_acl_expire
)(void *priv
, const u8
*mac
);
2303 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2304 * @priv: Private driver interface data
2305 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2306 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2308 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2309 * to remove extra IE(s)
2310 * Returns: 0 on success, -1 on failure
2312 * This is an optional function to add WPS IE in the kernel driver for
2313 * Beacon and Probe Response frames. This can be left undefined (set
2314 * to %NULL) if the driver uses the Beacon template from set_ap()
2315 * and does not process Probe Request frames. If the driver takes care
2316 * of (Re)Association frame processing, the assocresp buffer includes
2317 * WPS IE(s) that need to be added to (Re)Association Response frames
2318 * whenever a (Re)Association Request frame indicated use of WPS.
2320 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2321 * frames when operating as a GO. The driver is responsible for adding
2322 * timing related attributes (e.g., NoA) in addition to the IEs
2323 * included here by appending them after these buffers. This call is
2324 * also used to provide Probe Response IEs for P2P Listen state
2325 * operations for drivers that generate the Probe Response frames
2328 * DEPRECATED - use set_ap() instead
2330 int (*set_ap_wps_ie
)(void *priv
, const struct wpabuf
*beacon
,
2331 const struct wpabuf
*proberesp
,
2332 const struct wpabuf
*assocresp
);
2335 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2336 * @priv: Private driver interface data
2337 * @authorized: Whether the port is authorized
2338 * Returns: 0 on success, -1 on failure
2340 int (*set_supp_port
)(void *priv
, int authorized
);
2343 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2344 * @priv: Private driver interface data
2345 * @addr: MAC address of the associated station
2346 * @aid: Association ID
2347 * @val: 1 = bind to 4-address WDS; 0 = unbind
2348 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2349 * to indicate that bridge is not to be used
2350 * @ifname_wds: Buffer to return the interface name for the new WDS
2351 * station or %NULL to indicate name is not returned.
2352 * Returns: 0 on success, -1 on failure
2354 int (*set_wds_sta
)(void *priv
, const u8
*addr
, int aid
, int val
,
2355 const char *bridge_ifname
, char *ifname_wds
);
2358 * send_action - Transmit an Action frame
2359 * @priv: Private driver interface data
2360 * @freq: Frequency (in MHz) of the channel
2361 * @wait: Time to wait off-channel for a response (in ms), or zero
2362 * @dst: Destination MAC address (Address 1)
2363 * @src: Source MAC address (Address 2)
2364 * @bssid: BSSID (Address 3)
2366 * @data_len: data length in octets
2367 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2368 * Returns: 0 on success, -1 on failure
2370 * This command can be used to request the driver to transmit an action
2371 * frame to the specified destination.
2373 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2374 * be transmitted on the given channel and the device will wait for a
2375 * response on that channel for the given wait time.
2377 * If the flag is not set, the wait time will be ignored. In this case,
2378 * if a remain-on-channel duration is in progress, the frame must be
2379 * transmitted on that channel; alternatively the frame may be sent on
2380 * the current operational channel (if in associated state in station
2381 * mode or while operating as an AP.)
2383 int (*send_action
)(void *priv
, unsigned int freq
, unsigned int wait
,
2384 const u8
*dst
, const u8
*src
, const u8
*bssid
,
2385 const u8
*data
, size_t data_len
, int no_cck
);
2388 * send_action_cancel_wait - Cancel action frame TX wait
2389 * @priv: Private driver interface data
2391 * This command cancels the wait time associated with sending an action
2392 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2393 * set in the driver flags.
2395 void (*send_action_cancel_wait
)(void *priv
);
2398 * remain_on_channel - Remain awake on a channel
2399 * @priv: Private driver interface data
2400 * @freq: Frequency (in MHz) of the channel
2401 * @duration: Duration in milliseconds
2402 * Returns: 0 on success, -1 on failure
2404 * This command is used to request the driver to remain awake on the
2405 * specified channel for the specified duration and report received
2406 * Action frames with EVENT_RX_MGMT events. Optionally, received
2407 * Probe Request frames may also be requested to be reported by calling
2408 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2410 * The driver may not be at the requested channel when this function
2411 * returns, i.e., the return code is only indicating whether the
2412 * request was accepted. The caller will need to wait until the
2413 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2414 * completed the channel change. This may take some time due to other
2415 * need for the radio and the caller should be prepared to timing out
2416 * its wait since there are no guarantees on when this request can be
2419 int (*remain_on_channel
)(void *priv
, unsigned int freq
,
2420 unsigned int duration
);
2423 * cancel_remain_on_channel - Cancel remain-on-channel operation
2424 * @priv: Private driver interface data
2426 * This command can be used to cancel a remain-on-channel operation
2427 * before its originally requested duration has passed. This could be
2428 * used, e.g., when remain_on_channel() is used to request extra time
2429 * to receive a response to an Action frame and the response is
2430 * received when there is still unneeded time remaining on the
2431 * remain-on-channel operation.
2433 int (*cancel_remain_on_channel
)(void *priv
);
2436 * probe_req_report - Request Probe Request frames to be indicated
2437 * @priv: Private driver interface data
2438 * @report: Whether to report received Probe Request frames
2439 * Returns: 0 on success, -1 on failure (or if not supported)
2441 * This command can be used to request the driver to indicate when
2442 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2443 * Since this operation may require extra resources, e.g., due to less
2444 * optimal hardware/firmware RX filtering, many drivers may disable
2445 * Probe Request reporting at least in station mode. This command is
2446 * used to notify the driver when the Probe Request frames need to be
2447 * reported, e.g., during remain-on-channel operations.
2449 int (*probe_req_report
)(void *priv
, int report
);
2452 * deinit_ap - Deinitialize AP mode
2453 * @priv: Private driver interface data
2454 * Returns: 0 on success, -1 on failure (or if not supported)
2456 * This optional function can be used to disable AP mode related
2457 * configuration. If the interface was not dynamically added,
2458 * change the driver mode to station mode to allow normal station
2459 * operations like scanning to be completed.
2461 int (*deinit_ap
)(void *priv
);
2464 * deinit_p2p_cli - Deinitialize P2P client mode
2465 * @priv: Private driver interface data
2466 * Returns: 0 on success, -1 on failure (or if not supported)
2468 * This optional function can be used to disable P2P client mode. If the
2469 * interface was not dynamically added, change the interface type back
2472 int (*deinit_p2p_cli
)(void *priv
);
2475 * suspend - Notification on system suspend/hibernate event
2476 * @priv: Private driver interface data
2478 void (*suspend
)(void *priv
);
2481 * resume - Notification on system resume/thaw event
2482 * @priv: Private driver interface data
2484 void (*resume
)(void *priv
);
2487 * signal_monitor - Set signal monitoring parameters
2488 * @priv: Private driver interface data
2489 * @threshold: Threshold value for signal change events; 0 = disabled
2490 * @hysteresis: Minimum change in signal strength before indicating a
2492 * Returns: 0 on success, -1 on failure (or if not supported)
2494 * This function can be used to configure monitoring of signal strength
2495 * with the current AP. Whenever signal strength drops below the
2496 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2497 * should be generated assuming the signal strength has changed at
2498 * least %hysteresis from the previously indicated signal change event.
2500 int (*signal_monitor
)(void *priv
, int threshold
, int hysteresis
);
2503 * send_frame - Send IEEE 802.11 frame (testing use only)
2504 * @priv: Private driver interface data
2505 * @data: IEEE 802.11 frame with IEEE 802.11 header
2506 * @data_len: Size of the frame
2507 * @encrypt: Whether to encrypt the frame (if keys are set)
2508 * Returns: 0 on success, -1 on failure
2510 * This function is only used for debugging purposes and is not
2511 * required to be implemented for normal operations.
2513 int (*send_frame
)(void *priv
, const u8
*data
, size_t data_len
,
2517 * shared_freq - Get operating frequency of shared interface(s)
2518 * @priv: Private driver interface data
2519 * Returns: Operating frequency in MHz, 0 if no shared operation in
2520 * use, or -1 on failure
2522 * This command can be used to request the current operating frequency
2523 * of any virtual interface that shares the same radio to provide
2524 * information for channel selection for other virtual interfaces.
2526 int (*shared_freq
)(void *priv
);
2529 * get_noa - Get current Notice of Absence attribute payload
2530 * @priv: Private driver interface data
2531 * @buf: Buffer for returning NoA
2532 * @buf_len: Buffer length in octets
2533 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2534 * advertized, or -1 on failure
2536 * This function is used to fetch the current Notice of Absence
2537 * attribute value from GO.
2539 int (*get_noa
)(void *priv
, u8
*buf
, size_t buf_len
);
2542 * set_noa - Set Notice of Absence parameters for GO (testing)
2543 * @priv: Private driver interface data
2545 * @start: Start time in ms from next TBTT
2546 * @duration: Duration in ms
2547 * Returns: 0 on success or -1 on failure
2549 * This function is used to set Notice of Absence parameters for GO. It
2550 * is used only for testing. To disable NoA, all parameters are set to
2553 int (*set_noa
)(void *priv
, u8 count
, int start
, int duration
);
2556 * set_p2p_powersave - Set P2P power save options
2557 * @priv: Private driver interface data
2558 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2559 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2560 * @ctwindow: 0.. = change (msec), -1 = no change
2561 * Returns: 0 on success or -1 on failure
2563 int (*set_p2p_powersave
)(void *priv
, int legacy_ps
, int opp_ps
,
2567 * ampdu - Enable/disable aggregation
2568 * @priv: Private driver interface data
2569 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2570 * Returns: 0 on success or -1 on failure
2572 int (*ampdu
)(void *priv
, int ampdu
);
2575 * get_radio_name - Get physical radio name for the device
2576 * @priv: Private driver interface data
2577 * Returns: Radio name or %NULL if not known
2579 * The returned data must not be modified by the caller. It is assumed
2580 * that any interface that has the same radio name as another is
2581 * sharing the same physical radio. This information can be used to
2582 * share scan results etc. information between the virtual interfaces
2583 * to speed up various operations.
2585 const char * (*get_radio_name
)(void *priv
);
2588 * send_tdls_mgmt - for sending TDLS management packets
2589 * @priv: private driver interface data
2590 * @dst: Destination (peer) MAC address
2591 * @action_code: TDLS action code for the mssage
2592 * @dialog_token: Dialog Token to use in the message (if needed)
2593 * @status_code: Status Code or Reason Code to use (if needed)
2594 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2595 * @initiator: Is the current end the TDLS link initiator
2596 * @buf: TDLS IEs to add to the message
2597 * @len: Length of buf in octets
2598 * Returns: 0 on success, negative (<0) on failure
2600 * This optional function can be used to send packet to driver which is
2601 * responsible for receiving and sending all TDLS packets.
2603 int (*send_tdls_mgmt
)(void *priv
, const u8
*dst
, u8 action_code
,
2604 u8 dialog_token
, u16 status_code
, u32 peer_capab
,
2605 int initiator
, const u8
*buf
, size_t len
);
2608 * tdls_oper - Ask the driver to perform high-level TDLS operations
2609 * @priv: Private driver interface data
2610 * @oper: TDLS high-level operation. See %enum tdls_oper
2611 * @peer: Destination (peer) MAC address
2612 * Returns: 0 on success, negative (<0) on failure
2614 * This optional function can be used to send high-level TDLS commands
2617 int (*tdls_oper
)(void *priv
, enum tdls_oper oper
, const u8
*peer
);
2620 * wnm_oper - Notify driver of the WNM frame reception
2621 * @priv: Private driver interface data
2622 * @oper: WNM operation. See %enum wnm_oper
2623 * @peer: Destination (peer) MAC address
2624 * @buf: Buffer for the driver to fill in (for getting IE)
2625 * @buf_len: Return the len of buf
2626 * Returns: 0 on success, negative (<0) on failure
2628 int (*wnm_oper
)(void *priv
, enum wnm_oper oper
, const u8
*peer
,
2629 u8
*buf
, u16
*buf_len
);
2632 * set_qos_map - Set QoS Map
2633 * @priv: Private driver interface data
2634 * @qos_map_set: QoS Map
2635 * @qos_map_set_len: Length of QoS Map
2637 int (*set_qos_map
)(void *priv
, const u8
*qos_map_set
,
2638 u8 qos_map_set_len
);
2641 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2642 * @priv: Private driver interface data
2643 * @version: IP version of the IP address, 4 or 6
2644 * @ipaddr: IP address for the neigh entry
2645 * @prefixlen: IP address prefix length
2646 * @addr: Corresponding MAC address
2647 * Returns: 0 on success, negative (<0) on failure
2649 int (*br_add_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
,
2650 int prefixlen
, const u8
*addr
);
2653 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2654 * @priv: Private driver interface data
2655 * @version: IP version of the IP address, 4 or 6
2656 * @ipaddr: IP address for the neigh entry
2657 * Returns: 0 on success, negative (<0) on failure
2659 int (*br_delete_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
);
2662 * br_port_set_attr - Set a bridge port attribute
2663 * @attr: Bridge port attribute to set
2664 * @val: Value to be set
2665 * Returns: 0 on success, negative (<0) on failure
2667 int (*br_port_set_attr
)(void *priv
, enum drv_br_port_attr attr
,
2671 * br_port_set_attr - Set a bridge network parameter
2672 * @param: Bridge parameter to set
2673 * @val: Value to be set
2674 * Returns: 0 on success, negative (<0) on failure
2676 int (*br_set_net_param
)(void *priv
, enum drv_br_net_param param
,
2680 * set_wowlan - Set wake-on-wireless triggers
2681 * @priv: Private driver interface data
2682 * @triggers: wowlan triggers
2684 int (*set_wowlan
)(void *priv
, const struct wowlan_triggers
*triggers
);
2687 * signal_poll - Get current connection information
2688 * @priv: Private driver interface data
2689 * @signal_info: Connection info structure
2691 int (*signal_poll
)(void *priv
, struct wpa_signal_info
*signal_info
);
2694 * set_authmode - Set authentication algorithm(s) for static WEP
2695 * @priv: Private driver interface data
2696 * @authmode: 1=Open System, 2=Shared Key, 3=both
2697 * Returns: 0 on success, -1 on failure
2699 * This function can be used to set authentication algorithms for AP
2700 * mode when static WEP is used. If the driver uses user space MLME/SME
2701 * implementation, there is no need to implement this function.
2703 * DEPRECATED - use set_ap() instead
2705 int (*set_authmode
)(void *priv
, int authmode
);
2709 * driver_cmd - Execute driver-specific command
2710 * @priv: Private driver interface data
2711 * @cmd: Command to execute
2712 * @buf: Return buffer
2713 * @buf_len: Buffer length
2714 * Returns: 0 on success, -1 on failure
2716 int (*driver_cmd
)(void *priv
, char *cmd
, char *buf
, size_t buf_len
);
2717 #endif /* ANDROID */
2720 * vendor_cmd - Execute vendor specific command
2721 * @priv: Private driver interface data
2722 * @vendor_id: Vendor id
2723 * @subcmd: Vendor command id
2724 * @data: Vendor command parameters (%NULL if no parameters)
2725 * @data_len: Data length
2726 * @buf: Return buffer (%NULL to ignore reply)
2727 * Returns: 0 on success, negative (<0) on failure
2729 * This function handles vendor specific commands that are passed to
2730 * the driver/device. The command is identified by vendor id and
2731 * command id. Parameters can be passed as argument to the command
2732 * in the data buffer. Reply (if any) will be filled in the supplied
2735 * The exact driver behavior is driver interface and vendor specific. As
2736 * an example, this will be converted to a vendor specific cfg80211
2737 * command in case of the nl80211 driver interface.
2739 int (*vendor_cmd
)(void *priv
, unsigned int vendor_id
,
2740 unsigned int subcmd
, const u8
*data
, size_t data_len
,
2741 struct wpabuf
*buf
);
2744 * set_rekey_info - Set rekey information
2745 * @priv: Private driver interface data
2748 * @replay_ctr: Current EAPOL-Key Replay Counter
2750 * This optional function can be used to provide information for the
2751 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2752 * while the host (including wpa_supplicant) is sleeping.
2754 void (*set_rekey_info
)(void *priv
, const u8
*kek
, const u8
*kck
,
2755 const u8
*replay_ctr
);
2758 * sta_assoc - Station association indication
2759 * @priv: Private driver interface data
2760 * @own_addr: Source address and BSSID for association frame
2761 * @addr: MAC address of the station to associate
2762 * @reassoc: flag to indicate re-association
2763 * @status: association response status code
2764 * @ie: assoc response ie buffer
2765 * @len: ie buffer length
2766 * Returns: 0 on success, -1 on failure
2768 * This function indicates the driver to send (Re)Association
2769 * Response frame to the station.
2771 int (*sta_assoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2772 int reassoc
, u16 status
, const u8
*ie
, size_t len
);
2775 * sta_auth - Station authentication indication
2776 * @priv: Private driver interface data
2777 * @own_addr: Source address and BSSID for authentication frame
2778 * @addr: MAC address of the station to associate
2779 * @seq: authentication sequence number
2780 * @status: authentication response status code
2781 * @ie: authentication frame ie buffer
2782 * @len: ie buffer length
2784 * This function indicates the driver to send Authentication frame
2787 int (*sta_auth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2788 u16 seq
, u16 status
, const u8
*ie
, size_t len
);
2791 * add_tspec - Add traffic stream
2792 * @priv: Private driver interface data
2793 * @addr: MAC address of the station to associate
2794 * @tspec_ie: tspec ie buffer
2795 * @tspec_ielen: tspec ie length
2796 * Returns: 0 on success, -1 on failure
2798 * This function adds the traffic steam for the station
2799 * and fills the medium_time in tspec_ie.
2801 int (*add_tspec
)(void *priv
, const u8
*addr
, u8
*tspec_ie
,
2802 size_t tspec_ielen
);
2805 * add_sta_node - Add a station node in the driver
2806 * @priv: Private driver interface data
2807 * @addr: MAC address of the station to add
2808 * @auth_alg: authentication algorithm used by the station
2809 * Returns: 0 on success, -1 on failure
2811 * This function adds the station node in the driver, when
2812 * the station gets added by FT-over-DS.
2814 int (*add_sta_node
)(void *priv
, const u8
*addr
, u16 auth_alg
);
2817 * sched_scan - Request the driver to initiate scheduled scan
2818 * @priv: Private driver interface data
2819 * @params: Scan parameters
2820 * @interval: Interval between scan cycles in milliseconds
2821 * Returns: 0 on success, -1 on failure
2823 * This operation should be used for scheduled scan offload to
2824 * the hardware. Every time scan results are available, the
2825 * driver should report scan results event for wpa_supplicant
2826 * which will eventually request the results with
2827 * wpa_driver_get_scan_results2(). This operation is optional
2828 * and if not provided or if it returns -1, we fall back to
2829 * normal host-scheduled scans.
2831 int (*sched_scan
)(void *priv
, struct wpa_driver_scan_params
*params
,
2835 * stop_sched_scan - Request the driver to stop a scheduled scan
2836 * @priv: Private driver interface data
2837 * Returns: 0 on success, -1 on failure
2839 * This should cause the scheduled scan to be stopped and
2840 * results should stop being sent. Must be supported if
2841 * sched_scan is supported.
2843 int (*stop_sched_scan
)(void *priv
);
2846 * poll_client - Probe (null data or such) the given station
2847 * @priv: Private driver interface data
2848 * @own_addr: MAC address of sending interface
2849 * @addr: MAC address of the station to probe
2850 * @qos: Indicates whether station is QoS station
2852 * This function is used to verify whether an associated station is
2853 * still present. This function does not need to be implemented if the
2854 * driver provides such inactivity polling mechanism.
2856 void (*poll_client
)(void *priv
, const u8
*own_addr
,
2857 const u8
*addr
, int qos
);
2860 * radio_disable - Disable/enable radio
2861 * @priv: Private driver interface data
2862 * @disabled: 1=disable 0=enable radio
2863 * Returns: 0 on success, -1 on failure
2865 * This optional command is for testing purposes. It can be used to
2866 * disable the radio on a testbed device to simulate out-of-radio-range
2869 int (*radio_disable
)(void *priv
, int disabled
);
2872 * switch_channel - Announce channel switch and migrate the GO to the
2874 * @priv: Private driver interface data
2875 * @settings: Settings for CSA period and new channel
2876 * Returns: 0 on success, -1 on failure
2878 * This function is used to move the GO to the legacy STA channel to
2879 * avoid frequency conflict in single channel concurrency.
2881 int (*switch_channel
)(void *priv
, struct csa_settings
*settings
);
2884 * add_tx_ts - Add traffic stream
2885 * @priv: Private driver interface data
2886 * @tsid: Traffic stream ID
2887 * @addr: Receiver address
2888 * @user_prio: User priority of the traffic stream
2889 * @admitted_time: Admitted time for this TS in units of
2890 * 32 microsecond periods (per second).
2891 * Returns: 0 on success, -1 on failure
2893 int (*add_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
, u8 user_prio
,
2897 * del_tx_ts - Delete traffic stream
2898 * @priv: Private driver interface data
2899 * @tsid: Traffic stream ID
2900 * @addr: Receiver address
2901 * Returns: 0 on success, -1 on failure
2903 int (*del_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
);
2906 * start_dfs_cac - Listen for radar interference on the channel
2907 * @priv: Private driver interface data
2908 * @freq: Channel parameters
2909 * Returns: 0 on success, -1 on failure
2911 int (*start_dfs_cac
)(void *priv
, struct hostapd_freq_params
*freq
);
2914 * stop_ap - Removes beacon from AP
2915 * @priv: Private driver interface data
2916 * Returns: 0 on success, -1 on failure (or if not supported)
2918 * This optional function can be used to disable AP mode related
2919 * configuration. Unlike deinit_ap, it does not change to station
2922 int (*stop_ap
)(void *priv
);
2925 * get_survey - Retrieve survey data
2926 * @priv: Private driver interface data
2927 * @freq: If set, survey data for the specified frequency is only
2928 * being requested. If not set, all survey data is requested.
2929 * Returns: 0 on success, -1 on failure
2931 * Use this to retrieve:
2933 * - the observed channel noise floor
2934 * - the amount of time we have spent on the channel
2935 * - the amount of time during which we have spent on the channel that
2936 * the radio has determined the medium is busy and we cannot
2938 * - the amount of time we have spent receiving data
2939 * - the amount of time we have spent transmitting data
2941 * This data can be used for spectrum heuristics. One example is
2942 * Automatic Channel Selection (ACS). The channel survey data is
2943 * kept on a linked list on the channel data, one entry is added
2944 * for each survey. The min_nf of the channel is updated for each
2947 int (*get_survey
)(void *priv
, unsigned int freq
);
2950 * status - Get driver interface status information
2951 * @priv: Private driver interface data
2952 * @buf: Buffer for printing tou the status information
2953 * @buflen: Maximum length of the buffer
2954 * Returns: Length of written status information or -1 on failure
2956 int (*status
)(void *priv
, char *buf
, size_t buflen
);
2959 * roaming - Set roaming policy for driver-based BSS selection
2960 * @priv: Private driver interface data
2961 * @allowed: Whether roaming within ESS is allowed
2962 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
2963 * Returns: Length of written status information or -1 on failure
2965 * This optional callback can be used to update roaming policy from the
2966 * associate() command (bssid being set there indicates that the driver
2967 * should not roam before getting this roaming() call to allow roaming.
2968 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
2969 * capability, roaming policy is handled within wpa_supplicant and there
2970 * is no need to implement or react to this callback.
2972 int (*roaming
)(void *priv
, int allowed
, const u8
*bssid
);
2975 * set_mac_addr - Set MAC address
2976 * @priv: Private driver interface data
2977 * @addr: MAC address to use or %NULL for setting back to permanent
2978 * Returns: 0 on success, -1 on failure
2980 int (*set_mac_addr
)(void *priv
, const u8
*addr
);
2982 #ifdef CONFIG_MACSEC
2983 int (*macsec_init
)(void *priv
, struct macsec_init_params
*params
);
2985 int (*macsec_deinit
)(void *priv
);
2988 * enable_protect_frames - Set protect frames status
2989 * @priv: Private driver interface data
2990 * @enabled: TRUE = protect frames enabled
2991 * FALSE = protect frames disabled
2992 * Returns: 0 on success, -1 on failure (or if not supported)
2994 int (*enable_protect_frames
)(void *priv
, Boolean enabled
);
2997 * set_replay_protect - Set replay protect status and window size
2998 * @priv: Private driver interface data
2999 * @enabled: TRUE = replay protect enabled
3000 * FALSE = replay protect disabled
3001 * @window: replay window size, valid only when replay protect enabled
3002 * Returns: 0 on success, -1 on failure (or if not supported)
3004 int (*set_replay_protect
)(void *priv
, Boolean enabled
, u32 window
);
3007 * set_current_cipher_suite - Set current cipher suite
3008 * @priv: Private driver interface data
3009 * @cs: EUI64 identifier
3010 * @cs_len: Length of the cs buffer in octets
3011 * Returns: 0 on success, -1 on failure (or if not supported)
3013 int (*set_current_cipher_suite
)(void *priv
, const u8
*cs
,
3017 * enable_controlled_port - Set controlled port status
3018 * @priv: Private driver interface data
3019 * @enabled: TRUE = controlled port enabled
3020 * FALSE = controlled port disabled
3021 * Returns: 0 on success, -1 on failure (or if not supported)
3023 int (*enable_controlled_port
)(void *priv
, Boolean enabled
);
3026 * get_receive_lowest_pn - Get receive lowest pn
3027 * @priv: Private driver interface data
3028 * @channel: secure channel
3029 * @an: association number
3030 * @lowest_pn: lowest accept pn
3031 * Returns: 0 on success, -1 on failure (or if not supported)
3033 int (*get_receive_lowest_pn
)(void *priv
, u32 channel
, u8 an
,
3037 * get_transmit_next_pn - Get transmit next pn
3038 * @priv: Private driver interface data
3039 * @channel: secure channel
3040 * @an: association number
3042 * Returns: 0 on success, -1 on failure (or if not supported)
3044 int (*get_transmit_next_pn
)(void *priv
, u32 channel
, u8 an
,
3048 * set_transmit_next_pn - Set transmit next pn
3049 * @priv: Private driver interface data
3050 * @channel: secure channel
3051 * @an: association number
3053 * Returns: 0 on success, -1 on failure (or if not supported)
3055 int (*set_transmit_next_pn
)(void *priv
, u32 channel
, u8 an
,
3059 * get_available_receive_sc - get available receive channel
3060 * @priv: Private driver interface data
3061 * @channel: secure channel
3062 * Returns: 0 on success, -1 on failure (or if not supported)
3064 int (*get_available_receive_sc
)(void *priv
, u32
*channel
);
3067 * create_receive_sc - create secure channel for receiving
3068 * @priv: Private driver interface data
3069 * @channel: secure channel
3070 * @sci_addr: secure channel identifier - address
3071 * @sci_port: secure channel identifier - port
3072 * @conf_offset: confidentiality offset (0, 30, or 50)
3073 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3075 * Returns: 0 on success, -1 on failure (or if not supported)
3077 int (*create_receive_sc
)(void *priv
, u32 channel
, const u8
*sci_addr
,
3078 u16 sci_port
, unsigned int conf_offset
,
3082 * delete_receive_sc - delete secure connection for receiving
3083 * @priv: private driver interface data from init()
3084 * @channel: secure channel
3085 * Returns: 0 on success, -1 on failure
3087 int (*delete_receive_sc
)(void *priv
, u32 channel
);
3090 * create_receive_sa - create secure association for receive
3091 * @priv: private driver interface data from init()
3092 * @channel: secure channel
3093 * @an: association number
3094 * @lowest_pn: the lowest packet number can be received
3095 * @sak: the secure association key
3096 * Returns: 0 on success, -1 on failure
3098 int (*create_receive_sa
)(void *priv
, u32 channel
, u8 an
,
3099 u32 lowest_pn
, const u8
*sak
);
3102 * enable_receive_sa - enable the SA for receive
3103 * @priv: private driver interface data from init()
3104 * @channel: secure channel
3105 * @an: association number
3106 * Returns: 0 on success, -1 on failure
3108 int (*enable_receive_sa
)(void *priv
, u32 channel
, u8 an
);
3111 * disable_receive_sa - disable SA for receive
3112 * @priv: private driver interface data from init()
3113 * @channel: secure channel index
3114 * @an: association number
3115 * Returns: 0 on success, -1 on failure
3117 int (*disable_receive_sa
)(void *priv
, u32 channel
, u8 an
);
3120 * get_available_transmit_sc - get available transmit channel
3121 * @priv: Private driver interface data
3122 * @channel: secure channel
3123 * Returns: 0 on success, -1 on failure (or if not supported)
3125 int (*get_available_transmit_sc
)(void *priv
, u32
*channel
);
3128 * create_transmit_sc - create secure connection for transmit
3129 * @priv: private driver interface data from init()
3130 * @channel: secure channel
3131 * @sci_addr: secure channel identifier - address
3132 * @sci_port: secure channel identifier - port
3133 * Returns: 0 on success, -1 on failure
3135 int (*create_transmit_sc
)(void *priv
, u32 channel
, const u8
*sci_addr
,
3136 u16 sci_port
, unsigned int conf_offset
);
3139 * delete_transmit_sc - delete secure connection for transmit
3140 * @priv: private driver interface data from init()
3141 * @channel: secure channel
3142 * Returns: 0 on success, -1 on failure
3144 int (*delete_transmit_sc
)(void *priv
, u32 channel
);
3147 * create_transmit_sa - create secure association for transmit
3148 * @priv: private driver interface data from init()
3149 * @channel: secure channel index
3150 * @an: association number
3151 * @next_pn: the packet number used as next transmit packet
3152 * @confidentiality: True if the SA is to provide confidentiality
3153 * as well as integrity
3154 * @sak: the secure association key
3155 * Returns: 0 on success, -1 on failure
3157 int (*create_transmit_sa
)(void *priv
, u32 channel
, u8 an
, u32 next_pn
,
3158 Boolean confidentiality
, const u8
*sak
);
3161 * enable_transmit_sa - enable SA for transmit
3162 * @priv: private driver interface data from init()
3163 * @channel: secure channel
3164 * @an: association number
3165 * Returns: 0 on success, -1 on failure
3167 int (*enable_transmit_sa
)(void *priv
, u32 channel
, u8 an
);
3170 * disable_transmit_sa - disable SA for transmit
3171 * @priv: private driver interface data from init()
3172 * @channel: secure channel
3173 * @an: association number
3174 * Returns: 0 on success, -1 on failure
3176 int (*disable_transmit_sa
)(void *priv
, u32 channel
, u8 an
);
3177 #endif /* CONFIG_MACSEC */
3180 * init_mesh - Driver specific initialization for mesh
3181 * @priv: Private driver interface data
3182 * Returns: 0 on success, -1 on failure
3184 int (*init_mesh
)(void *priv
);
3187 * join_mesh - Join a mesh network
3188 * @priv: Private driver interface data
3189 * @params: Mesh configuration parameters
3190 * Returns: 0 on success, -1 on failure
3192 int (*join_mesh
)(void *priv
,
3193 struct wpa_driver_mesh_join_params
*params
);
3196 * leave_mesh - Leave a mesh network
3197 * @priv: Private driver interface data
3198 * Returns 0 on success, -1 on failure
3200 int (*leave_mesh
)(void *priv
);
3203 * do_acs - Automatically select channel
3204 * @priv: Private driver interface data
3205 * @params: Parameters for ACS
3206 * Returns 0 on success, -1 on failure
3208 * This command can be used to offload ACS to the driver if the driver
3209 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3211 int (*do_acs
)(void *priv
, struct drv_acs_params
*params
);
3216 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3218 enum wpa_event_type
{
3220 * EVENT_ASSOC - Association completed
3222 * This event needs to be delivered when the driver completes IEEE
3223 * 802.11 association or reassociation successfully.
3224 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3225 * after this event has been generated. In addition, optional
3226 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3227 * more information about the association. If the driver interface gets
3228 * both of these events at the same time, it can also include the
3229 * assoc_info data in EVENT_ASSOC call.
3234 * EVENT_DISASSOC - Association lost
3236 * This event should be called when association is lost either due to
3237 * receiving deauthenticate or disassociate frame from the AP or when
3238 * sending either of these frames to the current AP. If the driver
3239 * supports separate deauthentication event, EVENT_DISASSOC should only
3240 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3241 * In AP mode, union wpa_event_data::disassoc_info is required.
3246 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3248 * This event must be delivered when a Michael MIC error is detected by
3249 * the local driver. Additional data for event processing is
3250 * provided with union wpa_event_data::michael_mic_failure. This
3251 * information is used to request new encyption key and to initiate
3252 * TKIP countermeasures if needed.
3254 EVENT_MICHAEL_MIC_FAILURE
,
3257 * EVENT_SCAN_RESULTS - Scan results available
3259 * This event must be called whenever scan results are available to be
3260 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3261 * is expected to be used some time after struct wpa_driver_ops::scan()
3262 * is called. If the driver provides an unsolicited event when the scan
3263 * has been completed, this event can be used to trigger
3264 * EVENT_SCAN_RESULTS call. If such event is not available from the
3265 * driver, the driver wrapper code is expected to use a registered
3266 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3267 * scan is expected to be completed. Optional information about
3268 * completed scan can be provided with union wpa_event_data::scan_info.
3273 * EVENT_ASSOCINFO - Report optional extra information for association
3275 * This event can be used to report extra association information for
3276 * EVENT_ASSOC processing. This extra information includes IEs from
3277 * association frames and Beacon/Probe Response frames in union
3278 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3279 * EVENT_ASSOC. Alternatively, the driver interface can include
3280 * assoc_info data in the EVENT_ASSOC call if it has all the
3281 * information available at the same point.
3286 * EVENT_INTERFACE_STATUS - Report interface status changes
3288 * This optional event can be used to report changes in interface
3289 * status (interface added/removed) using union
3290 * wpa_event_data::interface_status. This can be used to trigger
3291 * wpa_supplicant to stop and re-start processing for the interface,
3292 * e.g., when a cardbus card is ejected/inserted.
3294 EVENT_INTERFACE_STATUS
,
3297 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3299 * This event can be used to inform wpa_supplicant about candidates for
3300 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3301 * for scan request (ap_scan=2 mode), this event is required for
3302 * pre-authentication. If wpa_supplicant is performing scan request
3303 * (ap_scan=1), this event is optional since scan results can be used
3304 * to add pre-authentication candidates. union
3305 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3306 * candidate and priority of the candidate, e.g., based on the signal
3307 * strength, in order to try to pre-authenticate first with candidates
3308 * that are most likely targets for re-association.
3310 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3311 * on the candidate list. In addition, it can be called for the current
3312 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3313 * will automatically skip pre-authentication in cases where a valid
3314 * PMKSA exists. When more than one candidate exists, this event should
3315 * be generated once for each candidate.
3317 * Driver will be notified about successful pre-authentication with
3318 * struct wpa_driver_ops::add_pmkid() calls.
3320 EVENT_PMKID_CANDIDATE
,
3323 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3325 * This event can be used to inform wpa_supplicant about desire to set
3326 * up secure direct link connection between two stations as defined in
3327 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3328 * STAKey negotiation. The caller will need to set peer address for the
3334 * EVENT_TDLS - Request TDLS operation
3336 * This event can be used to request a TDLS operation to be performed.
3341 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3343 * The driver is expected to report the received FT IEs from
3344 * FT authentication sequence from the AP. The FT IEs are included in
3345 * the extra information in union wpa_event_data::ft_ies.
3350 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3352 * The driver can use this event to inform wpa_supplicant about a STA
3353 * in an IBSS with which protected frames could be exchanged. This
3354 * event starts RSN authentication with the other STA to authenticate
3355 * the STA and set up encryption keys with it.
3357 EVENT_IBSS_RSN_START
,
3360 * EVENT_AUTH - Authentication result
3362 * This event should be called when authentication attempt has been
3363 * completed. This is only used if the driver supports separate
3364 * authentication step (struct wpa_driver_ops::authenticate).
3365 * Information about authentication result is included in
3366 * union wpa_event_data::auth.
3371 * EVENT_DEAUTH - Authentication lost
3373 * This event should be called when authentication is lost either due
3374 * to receiving deauthenticate frame from the AP or when sending that
3375 * frame to the current AP.
3376 * In AP mode, union wpa_event_data::deauth_info is required.
3381 * EVENT_ASSOC_REJECT - Association rejected
3383 * This event should be called when (re)association attempt has been
3384 * rejected by the AP. Information about the association response is
3385 * included in union wpa_event_data::assoc_reject.
3390 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3392 EVENT_AUTH_TIMED_OUT
,
3395 * EVENT_ASSOC_TIMED_OUT - Association timed out
3397 EVENT_ASSOC_TIMED_OUT
,
3400 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3402 EVENT_WPS_BUTTON_PUSHED
,
3405 * EVENT_TX_STATUS - Report TX status
3410 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3412 EVENT_RX_FROM_UNKNOWN
,
3415 * EVENT_RX_MGMT - Report RX of a management frame
3420 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3422 * This event is used to indicate when the driver has started the
3423 * requested remain-on-channel duration. Information about the
3424 * operation is included in union wpa_event_data::remain_on_channel.
3426 EVENT_REMAIN_ON_CHANNEL
,
3429 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3431 * This event is used to indicate when the driver has completed
3432 * remain-on-channel duration, i.e., may noot be available on the
3433 * requested channel anymore. Information about the
3434 * operation is included in union wpa_event_data::remain_on_channel.
3436 EVENT_CANCEL_REMAIN_ON_CHANNEL
,
3439 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3441 * This event is used to indicate when a Probe Request frame has been
3442 * received. Information about the received frame is included in
3443 * union wpa_event_data::rx_probe_req. The driver is required to report
3444 * these events only after successfully completed probe_req_report()
3445 * commands to request the events (i.e., report parameter is non-zero)
3446 * in station mode. In AP mode, Probe Request frames should always be
3452 * EVENT_NEW_STA - New wired device noticed
3454 * This event is used to indicate that a new device has been detected
3455 * in a network that does not use association-like functionality (i.e.,
3456 * mainly wired Ethernet). This can be used to start EAPOL
3457 * authenticator when receiving a frame from a device. The address of
3458 * the device is included in union wpa_event_data::new_sta.
3463 * EVENT_EAPOL_RX - Report received EAPOL frame
3465 * When in AP mode with hostapd, this event is required to be used to
3466 * deliver the receive EAPOL frames from the driver.
3471 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3473 * This event is used to indicate changes in the signal strength
3474 * observed in frames received from the current AP if signal strength
3475 * monitoring has been enabled with signal_monitor().
3477 EVENT_SIGNAL_CHANGE
,
3480 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3482 * This event is used to indicate that the interface was enabled after
3483 * having been previously disabled, e.g., due to rfkill.
3485 EVENT_INTERFACE_ENABLED
,
3488 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3490 * This event is used to indicate that the interface was disabled,
3491 * e.g., due to rfkill.
3493 EVENT_INTERFACE_DISABLED
,
3496 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3498 * This event is used to indicate that the channel list has changed,
3499 * e.g., because of a regulatory domain change triggered by scan
3500 * results including an AP advertising a country code.
3502 EVENT_CHANNEL_LIST_CHANGED
,
3505 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3507 * This event is used to indicate that the driver cannot maintain this
3508 * interface in its operation mode anymore. The most likely use for
3509 * this is to indicate that AP mode operation is not available due to
3510 * operating channel would need to be changed to a DFS channel when
3511 * the driver does not support radar detection and another virtual
3512 * interfaces caused the operating channel to change. Other similar
3513 * resource conflicts could also trigger this for station mode
3514 * interfaces. This event can be propagated when channel switching
3517 EVENT_INTERFACE_UNAVAILABLE
,
3520 * EVENT_BEST_CHANNEL
3522 * Driver generates this event whenever it detects a better channel
3523 * (e.g., based on RSSI or channel use). This information can be used
3524 * to improve channel selection for a new AP/P2P group.
3529 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3531 * This event should be called when a Deauthentication frame is dropped
3532 * due to it not being protected (MFP/IEEE 802.11w).
3533 * union wpa_event_data::unprot_deauth is required to provide more
3534 * details of the frame.
3536 EVENT_UNPROT_DEAUTH
,
3539 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3541 * This event should be called when a Disassociation frame is dropped
3542 * due to it not being protected (MFP/IEEE 802.11w).
3543 * union wpa_event_data::unprot_disassoc is required to provide more
3544 * details of the frame.
3546 EVENT_UNPROT_DISASSOC
,
3549 * EVENT_STATION_LOW_ACK
3551 * Driver generates this event whenever it detected that a particular
3552 * station was lost. Detection can be through massive transmission
3553 * failures for example.
3555 EVENT_STATION_LOW_ACK
,
3558 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3560 EVENT_IBSS_PEER_LOST
,
3563 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3565 * This event carries the new replay counter to notify wpa_supplicant
3566 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3567 * completed Group Key Handshake while the host (including
3568 * wpa_supplicant was sleeping).
3570 EVENT_DRIVER_GTK_REKEY
,
3573 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3575 EVENT_SCHED_SCAN_STOPPED
,
3578 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3580 * This event indicates that the station responded to the poll
3581 * initiated with @poll_client.
3583 EVENT_DRIVER_CLIENT_POLL_OK
,
3586 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3588 EVENT_EAPOL_TX_STATUS
,
3591 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3593 * Described in wpa_event_data.ch_switch
3598 * EVENT_WNM - Request WNM operation
3600 * This event can be used to request a WNM operation to be performed.
3605 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3607 * This event indicates that the driver reported a connection failure
3608 * with the specified client (for example, max client reached, etc.) in
3611 EVENT_CONNECT_FAILED_REASON
,
3614 * EVENT_RADAR_DETECTED - Notify of radar detection
3616 * A radar has been detected on the supplied frequency, hostapd should
3617 * react accordingly (e.g., change channel).
3619 EVENT_DFS_RADAR_DETECTED
,
3622 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3624 * After a successful CAC, the channel can be marked clear and used.
3626 EVENT_DFS_CAC_FINISHED
,
3629 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3631 * The CAC was not successful, and the channel remains in the previous
3632 * state. This may happen due to a radar beeing detected or other
3633 * external influences.
3635 EVENT_DFS_CAC_ABORTED
,
3638 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3640 * The channel which was previously unavailable is now available again.
3642 EVENT_DFS_NOP_FINISHED
,
3645 * EVENT_SURVEY - Received survey data
3647 * This event gets triggered when a driver query is issued for survey
3648 * data and the requested data becomes available. The returned data is
3649 * stored in struct survey_results. The results provide at most one
3650 * survey entry for each frequency and at minimum will provide one
3651 * survey entry for one frequency. The survey data can be os_malloc()'d
3652 * and then os_free()'d, so the event callback must only copy data.
3657 * EVENT_SCAN_STARTED - Scan started
3659 * This indicates that driver has started a scan operation either based
3660 * on a request from wpa_supplicant/hostapd or from another application.
3661 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3662 * completed (either successfully or by getting cancelled).
3667 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3669 * This event indicates a set of frequency ranges that should be avoided
3670 * to reduce issues due to interference or internal co-existence
3671 * information in the driver.
3673 EVENT_AVOID_FREQUENCIES
,
3676 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3678 EVENT_NEW_PEER_CANDIDATE
,
3681 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
3683 * Indicates a pair of primary and secondary channels chosen by ACS
3686 EVENT_ACS_CHANNEL_SELECTED
,
3691 * struct freq_survey - Channel survey info
3693 * @ifidx: Interface index in which this survey was observed
3694 * @freq: Center of frequency of the surveyed channel
3695 * @nf: Channel noise floor in dBm
3696 * @channel_time: Amount of time in ms the radio spent on the channel
3697 * @channel_time_busy: Amount of time in ms the radio detected some signal
3698 * that indicated to the radio the channel was not clear
3699 * @channel_time_rx: Amount of time the radio spent receiving data
3700 * @channel_time_tx: Amount of time the radio spent transmitting data
3701 * @filled: bitmask indicating which fields have been reported, see
3702 * SURVEY_HAS_* defines.
3703 * @list: Internal list pointers
3705 struct freq_survey
{
3710 u64 channel_time_busy
;
3711 u64 channel_time_rx
;
3712 u64 channel_time_tx
;
3713 unsigned int filled
;
3714 struct dl_list list
;
3717 #define SURVEY_HAS_NF BIT(0)
3718 #define SURVEY_HAS_CHAN_TIME BIT(1)
3719 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3720 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3721 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3725 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3727 union wpa_event_data
{
3729 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3731 * This structure is optional for EVENT_ASSOC calls and required for
3732 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3733 * driver interface does not need to generate separate EVENT_ASSOCINFO
3738 * reassoc - Flag to indicate association or reassociation
3743 * req_ies - (Re)Association Request IEs
3745 * If the driver generates WPA/RSN IE, this event data must be
3746 * returned for WPA handshake to have needed information. If
3747 * wpa_supplicant-generated WPA/RSN IE is used, this
3748 * information event is optional.
3750 * This should start with the first IE (fixed fields before IEs
3751 * are not included).
3756 * req_ies_len - Length of req_ies in bytes
3761 * resp_ies - (Re)Association Response IEs
3763 * Optional association data from the driver. This data is not
3764 * required WPA, but may be useful for some protocols and as
3765 * such, should be reported if this is available to the driver
3768 * This should start with the first IE (fixed fields before IEs
3769 * are not included).
3774 * resp_ies_len - Length of resp_ies in bytes
3776 size_t resp_ies_len
;
3779 * beacon_ies - Beacon or Probe Response IEs
3781 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3782 * Probe Response frames from the current AP (i.e., the one
3783 * that the client just associated with). This information is
3784 * used to update WPA/RSN IE for the AP. If this field is not
3785 * set, the results from previous scan will be used. If no
3786 * data for the new AP is found, scan results will be requested
3787 * again (without scan request). At this point, the driver is
3788 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3791 * This should start with the first IE (fixed fields before IEs
3792 * are not included).
3794 const u8
*beacon_ies
;
3797 * beacon_ies_len - Length of beacon_ies */
3798 size_t beacon_ies_len
;
3801 * freq - Frequency of the operational channel in MHz
3806 * wmm_params - WMM parameters used in this association.
3808 struct wmm_params wmm_params
;
3811 * addr - Station address (for AP mode)
3816 * The following is the key management offload information
3819 * @key_replay_ctr_len
3827 * authorized - Status of key management offload,
3833 * key_replay_ctr - Key replay counter value last used
3834 * in a valid EAPOL-Key frame
3836 const u8
*key_replay_ctr
;
3839 * key_replay_ctr_len - The length of key_replay_ctr
3841 size_t key_replay_ctr_len
;
3844 * ptk_kck - The derived PTK KCK
3849 * ptk_kek_len - The length of ptk_kck
3854 * ptk_kek - The derived PTK KEK
3859 * ptk_kek_len - The length of ptk_kek
3865 * struct disassoc_info - Data for EVENT_DISASSOC events
3867 struct disassoc_info
{
3869 * addr - Station address (for AP mode)
3874 * reason_code - Reason Code (host byte order) used in
3875 * Deauthentication frame
3880 * ie - Optional IE(s) in Disassociation frame
3885 * ie_len - Length of ie buffer in octets
3890 * locally_generated - Whether the frame was locally generated
3892 int locally_generated
;
3896 * struct deauth_info - Data for EVENT_DEAUTH events
3898 struct deauth_info
{
3900 * addr - Station address (for AP mode)
3905 * reason_code - Reason Code (host byte order) used in
3906 * Deauthentication frame
3911 * ie - Optional IE(s) in Deauthentication frame
3916 * ie_len - Length of ie buffer in octets
3921 * locally_generated - Whether the frame was locally generated
3923 int locally_generated
;
3927 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3929 struct michael_mic_failure
{
3932 } michael_mic_failure
;
3935 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3937 struct interface_status
{
3940 EVENT_INTERFACE_ADDED
, EVENT_INTERFACE_REMOVED
3945 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3947 struct pmkid_candidate
{
3948 /** BSSID of the PMKID candidate */
3950 /** Smaller the index, higher the priority */
3952 /** Whether RSN IE includes pre-authenticate flag */
3957 * struct stkstart - Data for EVENT_STKSTART
3964 * struct tdls - Data for EVENT_TDLS
3970 TDLS_REQUEST_TEARDOWN
3972 u16 reason_code
; /* for teardown */
3976 * struct wnm - Data for EVENT_WNM
3994 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3996 * During FT (IEEE 802.11r) authentication sequence, the driver is
3997 * expected to use this event to report received FT IEs (MDIE, FTIE,
3998 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3999 * IEs for the next message will be delivered through the
4000 * struct wpa_driver_ops::update_ft_ies() callback.
4006 u8 target_ap
[ETH_ALEN
];
4007 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4009 /** Length of ric_ies buffer in octets */
4014 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4016 struct ibss_rsn_start
{
4021 * struct auth_info - Data for EVENT_AUTH events
4027 u16 auth_transaction
;
4034 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4036 struct assoc_reject
{
4038 * bssid - BSSID of the AP that rejected association
4043 * resp_ies - (Re)Association Response IEs
4045 * Optional association data from the driver. This data is not
4046 * required WPA, but may be useful for some protocols and as
4047 * such, should be reported if this is available to the driver
4050 * This should start with the first IE (fixed fields before IEs
4051 * are not included).
4056 * resp_ies_len - Length of resp_ies in bytes
4058 size_t resp_ies_len
;
4061 * status_code - Status Code from (Re)association Response
4066 struct timeout_event
{
4071 * struct tx_status - Data for EVENT_TX_STATUS events
4083 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4085 struct rx_from_unknown
{
4092 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4100 * drv_priv - Pointer to store driver private BSS information
4102 * If not set to NULL, this is used for comparison with
4103 * hostapd_data->drv_priv to determine which BSS should process
4109 * freq - Frequency (in MHz) on which the frame was received
4114 * ssi_signal - Signal strength in dBm (or 0 if not available)
4120 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4122 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4124 struct remain_on_channel
{
4126 * freq - Channel frequency in MHz
4131 * duration - Duration to remain on the channel in milliseconds
4133 unsigned int duration
;
4134 } remain_on_channel
;
4137 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4138 * @aborted: Whether the scan was aborted
4139 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4140 * @num_freqs: Number of entries in freqs array
4141 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4143 * @num_ssids: Number of entries in ssids array
4149 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
4154 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4156 struct rx_probe_req
{
4158 * sa - Source address of the received Probe Request frame
4163 * da - Destination address of the received Probe Request frame
4164 * or %NULL if not available
4169 * bssid - BSSID of the received Probe Request frame or %NULL
4175 * ie - IEs from the Probe Request body
4180 * ie_len - Length of ie buffer in octets
4185 * signal - signal strength in dBm (or 0 if not available)
4191 * struct new_sta - Data for EVENT_NEW_STA events
4198 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4207 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4209 struct wpa_signal_info signal_change
;
4212 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4213 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4214 * @freq_5: Best 5 GHz band channel frequency in MHz
4215 * @freq_overall: Best channel frequency in MHz
4217 * 0 can be used to indicate no preference in either band.
4219 struct best_channel
{
4225 struct unprot_deauth
{
4231 struct unprot_disassoc
{
4238 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4239 * @addr: station address
4246 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4248 struct ibss_peer_lost
{
4253 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4255 struct driver_gtk_rekey
{
4257 const u8
*replay_ctr
;
4261 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4262 * @addr: station address
4264 struct client_poll
{
4269 * struct eapol_tx_status
4270 * @dst: Original destination
4271 * @data: Data starting with IEEE 802.1X header (!)
4272 * @data_len: Length of data
4273 * @ack: Indicates ack or lost frame
4275 * This corresponds to hapd_send_eapol if the frame sent
4276 * there isn't just reported as EVENT_TX_STATUS.
4278 struct eapol_tx_status
{
4287 * @freq: Frequency of new channel in MHz
4288 * @ht_enabled: Whether this is an HT channel
4289 * @ch_offset: Secondary channel offset
4290 * @ch_width: Channel width
4291 * @cf1: Center frequency 1
4292 * @cf2: Center frequency 2
4298 enum chan_width ch_width
;
4304 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4305 * @addr: Remote client address
4306 * @code: Reason code for connection failure
4308 struct connect_failed_reason
{
4314 } connect_failed_reason
;
4317 * struct dfs_event - Data for radar detected events
4318 * @freq: Frequency of the channel in MHz
4324 enum chan_width chan_width
;
4330 * survey_results - Survey result data for EVENT_SURVEY
4331 * @freq_filter: Requested frequency survey filter, 0 if request
4332 * was for all survey data
4333 * @survey_list: Linked list of survey data
4335 struct survey_results
{
4336 unsigned int freq_filter
;
4337 struct dl_list survey_list
; /* struct freq_survey */
4341 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4342 * @initiator: Initiator of the regulatory change
4343 * @type: Regulatory change type
4344 * @alpha2: Country code (or "" if not available)
4346 struct channel_list_changed
{
4347 enum reg_change_initiator initiator
;
4350 } channel_list_changed
;
4353 * freq_range - List of frequency ranges
4355 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4357 struct wpa_freq_range_list freq_range
;
4362 * @peer: Peer address
4364 * @ie_len: Length of @ies
4366 * Notification of new candidate mesh peer.
4375 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4376 * @pri_channel: Selected primary channel
4377 * @sec_channel: Selected secondary channel
4379 struct acs_selected_channels
{
4382 } acs_selected_channels
;
4386 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4387 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4388 * with struct wpa_driver_ops::init()
4389 * @event: event type (defined above)
4390 * @data: possible extra data for the event
4392 * Driver wrapper code should call this function whenever an event is received
4395 void wpa_supplicant_event(void *ctx
, enum wpa_event_type event
,
4396 union wpa_event_data
*data
);
4400 * The following inline functions are provided for convenience to simplify
4401 * event indication for some of the common events.
4404 static inline void drv_event_assoc(void *ctx
, const u8
*addr
, const u8
*ie
,
4405 size_t ielen
, int reassoc
)
4407 union wpa_event_data event
;
4408 os_memset(&event
, 0, sizeof(event
));
4409 event
.assoc_info
.reassoc
= reassoc
;
4410 event
.assoc_info
.req_ies
= ie
;
4411 event
.assoc_info
.req_ies_len
= ielen
;
4412 event
.assoc_info
.addr
= addr
;
4413 wpa_supplicant_event(ctx
, EVENT_ASSOC
, &event
);
4416 static inline void drv_event_disassoc(void *ctx
, const u8
*addr
)
4418 union wpa_event_data event
;
4419 os_memset(&event
, 0, sizeof(event
));
4420 event
.disassoc_info
.addr
= addr
;
4421 wpa_supplicant_event(ctx
, EVENT_DISASSOC
, &event
);
4424 static inline void drv_event_eapol_rx(void *ctx
, const u8
*src
, const u8
*data
,
4427 union wpa_event_data event
;
4428 os_memset(&event
, 0, sizeof(event
));
4429 event
.eapol_rx
.src
= src
;
4430 event
.eapol_rx
.data
= data
;
4431 event
.eapol_rx
.data_len
= data_len
;
4432 wpa_supplicant_event(ctx
, EVENT_EAPOL_RX
, &event
);
4435 /* driver_common.c */
4436 void wpa_scan_results_free(struct wpa_scan_results
*res
);
4438 /* Convert wpa_event_type to a string for logging */
4439 const char * event_to_string(enum wpa_event_type event
);
4441 /* Convert chan_width to a string for logging and control interfaces */
4442 const char * channel_width_to_string(enum chan_width width
);
4444 int ht_supported(const struct hostapd_hw_modes
*mode
);
4445 int vht_supported(const struct hostapd_hw_modes
*mode
);
4447 struct wowlan_triggers
*
4448 wpa_get_wowlan_triggers(const char *wowlan_triggers
,
4449 const struct wpa_driver_capa
*capa
);
4451 /* NULL terminated array of linked in driver wrappers */
4452 extern struct wpa_driver_ops
*wpa_drivers
[];
4454 #endif /* DRIVER_H */