2 * Driver interface definition
3 * Copyright (c) 2003-2014, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
8 * This file defines a driver interface used by both %wpa_supplicant and
9 * hostapd. The first part of the file defines data structures used in various
10 * driver operations. This is followed by the struct wpa_driver_ops that each
11 * driver wrapper will beed to define with callback functions for requesting
12 * driver operations. After this, there are definitions for driver event
13 * reporting with wpa_supplicant_event() and some convenience helper functions
14 * that can be used to report events.
20 #define WPA_SUPPLICANT_DRIVER_VERSION 4
22 #include "common/defs.h"
23 #include "utils/list.h"
25 #define HOSTAPD_CHAN_DISABLED 0x00000001
26 #define HOSTAPD_CHAN_NO_IR 0x00000002
27 #define HOSTAPD_CHAN_RADAR 0x00000008
28 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
29 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
30 #define HOSTAPD_CHAN_HT40 0x00000040
31 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
33 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
34 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
35 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
36 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
37 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
39 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
40 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
41 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
42 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
44 #define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
45 #define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
48 * enum reg_change_initiator - Regulatory change initiator
50 enum reg_change_initiator {
54 REGDOM_SET_BY_COUNTRY_IE,
59 * enum reg_type - Regulatory change types
65 REGDOM_TYPE_CUSTOM_WORLD,
66 REGDOM_TYPE_INTERSECTION,
70 * struct hostapd_channel_data - Channel information
72 struct hostapd_channel_data {
74 * chan - Channel number (IEEE 802.11)
79 * freq - Frequency in MHz
84 * flag - Channel flags (HOSTAPD_CHAN_*)
89 * max_tx_power - Regulatory transmit power limit in dBm
94 * survey_list - Linked list of surveys (struct freq_survey)
96 struct dl_list survey_list;
99 * min_nf - Minimum observed noise floor, in dBm, based on all
100 * surveyed channel data
106 * interference_factor - Computed interference factor on this
107 * channel (used internally in src/ap/acs.c; driver wrappers do not
110 long double interference_factor;
111 #endif /* CONFIG_ACS */
114 * dfs_cac_ms - DFS CAC time in milliseconds
116 unsigned int dfs_cac_ms;
119 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
120 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
123 * struct hostapd_hw_modes - Supported hardware mode information
125 struct hostapd_hw_modes {
127 * mode - Hardware mode
129 enum hostapd_hw_mode mode;
132 * num_channels - Number of entries in the channels array
137 * channels - Array of supported channels
139 struct hostapd_channel_data *channels;
142 * num_rates - Number of entries in the rates array
147 * rates - Array of supported rates in 100 kbps units
152 * ht_capab - HT (IEEE 802.11n) capabilities
157 * mcs_set - MCS (IEEE 802.11n) rate parameters
162 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
167 * vht_capab - VHT (IEEE 802.11ac) capabilities
172 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
176 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
180 #define IEEE80211_MODE_INFRA 0
181 #define IEEE80211_MODE_IBSS 1
182 #define IEEE80211_MODE_AP 2
183 #define IEEE80211_MODE_MESH 5
185 #define IEEE80211_CAP_ESS 0x0001
186 #define IEEE80211_CAP_IBSS 0x0002
187 #define IEEE80211_CAP_PRIVACY 0x0010
188 #define IEEE80211_CAP_RRM 0x1000
190 /* DMG (60 GHz) IEEE 802.11ad */
191 /* type - bits 0..1 */
192 #define IEEE80211_CAP_DMG_MASK 0x0003
193 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
194 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
195 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
197 #define WPA_SCAN_QUAL_INVALID BIT(0)
198 #define WPA_SCAN_NOISE_INVALID BIT(1)
199 #define WPA_SCAN_LEVEL_INVALID BIT(2)
200 #define WPA_SCAN_LEVEL_DBM BIT(3)
201 #define WPA_SCAN_ASSOCIATED BIT(5)
204 * struct wpa_scan_res - Scan result for an BSS/IBSS
205 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
207 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
208 * @beacon_int: beacon interval in TUs (host byte order)
209 * @caps: capability information field in host byte order
210 * @qual: signal quality
211 * @noise: noise level
212 * @level: signal level
214 * @age: Age of the information in milliseconds (i.e., how many milliseconds
215 * ago the last Beacon or Probe Response frame was received)
216 * @ie_len: length of the following IE field in octets
217 * @beacon_ie_len: length of the following Beacon IE field in octets
219 * This structure is used as a generic format for scan results from the
220 * driver. Each driver interface implementation is responsible for converting
221 * the driver or OS specific scan results into this format.
223 * If the driver does not support reporting all IEs, the IE data structure is
224 * constructed of the IEs that are available. This field will also need to
225 * include SSID in IE format. All drivers are encouraged to be extended to
226 * report all IEs to make it easier to support future additions.
228 * This structure data is followed by ie_len octets of IEs from Probe Response
229 * frame (or if the driver does not indicate source of IEs, these may also be
230 * from Beacon frame). After the first set of IEs, another set of IEs may follow
231 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
233 struct wpa_scan_res {
245 size_t beacon_ie_len;
246 /* Followed by ie_len + beacon_ie_len octets of IE data */
250 * struct wpa_scan_results - Scan results
251 * @res: Array of pointers to allocated variable length scan result entries
252 * @num: Number of entries in the scan result array
253 * @fetch_time: Time when the results were fetched from the driver
255 struct wpa_scan_results {
256 struct wpa_scan_res **res;
258 struct os_reltime fetch_time;
262 * struct wpa_interface_info - Network interface information
263 * @next: Pointer to the next interface or NULL if this is the last one
264 * @ifname: Interface name that can be used with init() or init2()
265 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
267 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
268 * is not an allocated copy, i.e., get_interfaces() caller will not free
271 struct wpa_interface_info {
272 struct wpa_interface_info *next;
275 const char *drv_name;
278 #define WPAS_MAX_SCAN_SSIDS 16
281 * struct wpa_driver_scan_params - Scan parameters
282 * Data for struct wpa_driver_ops::scan2().
284 struct wpa_driver_scan_params {
286 * ssids - SSIDs to scan for
288 struct wpa_driver_scan_ssid {
290 * ssid - specific SSID to scan for (ProbeReq)
291 * %NULL or zero-length SSID is used to indicate active scan
292 * with wildcard SSID.
296 * ssid_len: Length of the SSID in octets
299 } ssids[WPAS_MAX_SCAN_SSIDS];
302 * num_ssids - Number of entries in ssids array
303 * Zero indicates a request for a passive scan.
308 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
313 * extra_ies_len - Length of extra_ies in octets
315 size_t extra_ies_len;
318 * freqs - Array of frequencies to scan or %NULL for all frequencies
320 * The frequency is set in MHz. The array is zero-terminated.
325 * filter_ssids - Filter for reporting SSIDs
327 * This optional parameter can be used to request the driver wrapper to
328 * filter scan results to include only the specified SSIDs. %NULL
329 * indicates that no filtering is to be done. This can be used to
330 * reduce memory needs for scan results in environments that have large
331 * number of APs with different SSIDs.
333 * The driver wrapper is allowed to take this allocated buffer into its
334 * own use by setting the pointer to %NULL. In that case, the driver
335 * wrapper is responsible for freeing the buffer with os_free() once it
336 * is not needed anymore.
338 struct wpa_driver_scan_filter {
344 * num_filter_ssids - Number of entries in filter_ssids array
346 size_t num_filter_ssids;
349 * filter_rssi - Filter by RSSI
351 * The driver may filter scan results in firmware to reduce host
352 * wakeups and thereby save power. Specify the RSSI threshold in s32
358 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
360 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
361 * Mbps from the support rates element(s) in the Probe Request frames
362 * and not to transmit the frames at any of those rates.
364 unsigned int p2p_probe:1;
367 * only_new_results - Request driver to report only new results
369 * This is used to request the driver to report only BSSes that have
370 * been detected after this scan request has been started, i.e., to
371 * flush old cached BSS entries.
373 unsigned int only_new_results:1;
376 * low_priority - Requests driver to use a lower scan priority
378 * This is used to request the driver to use a lower scan priority
379 * if it supports such a thing.
381 unsigned int low_priority:1;
384 * mac_addr_rand - Requests driver to randomize MAC address
386 unsigned int mac_addr_rand:1;
389 * mac_addr - MAC address used with randomization. The address cannot be
390 * a multicast one, i.e., bit 0 of byte 0 should not be set.
395 * mac_addr_mask - MAC address mask used with randomization.
397 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
398 * the mask should be taken as is from mac_addr. The mask should not
399 * allow the generation of a multicast address, i.e., bit 0 of byte 0
402 const u8 *mac_addr_mask;
405 * NOTE: Whenever adding new parameters here, please make sure
406 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
412 * struct wpa_driver_auth_params - Authentication parameters
413 * Data for struct wpa_driver_ops::authenticate().
415 struct wpa_driver_auth_params {
423 const u8 *wep_key[4];
424 size_t wep_key_len[4];
426 int local_state_change;
429 * p2p - Whether this connection is a P2P group
434 * sae_data - SAE elements for Authentication frame
436 * This buffer starts with the Authentication transaction sequence
437 * number field. If SAE is not used, this pointer is %NULL.
442 * sae_data_len - Length of sae_data buffer in octets
448 * enum wps_mode - WPS mode
452 * WPS_MODE_NONE - No WPS provisioning being used
457 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
462 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
468 * struct hostapd_freq_params - Channel parameters
470 struct hostapd_freq_params {
472 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
474 enum hostapd_hw_mode mode;
477 * freq - Primary channel center frequency in MHz
482 * channel - Channel number
487 * ht_enabled - Whether HT is enabled
492 * sec_channel_offset - Secondary channel offset for HT40
495 * -1 = HT40 enabled, secondary channel below primary,
496 * 1 = HT40 enabled, secondary channel above primary
498 int sec_channel_offset;
501 * vht_enabled - Whether VHT is enabled
506 * center_freq1 - Segment 0 center frequency in MHz
508 * Valid for both HT and VHT.
513 * center_freq2 - Segment 1 center frequency in MHz
515 * Non-zero only for bandwidth 80 and an 80+80 channel
520 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
526 * struct wpa_driver_associate_params - Association parameters
527 * Data for struct wpa_driver_ops::associate().
529 struct wpa_driver_associate_params {
531 * bssid - BSSID of the selected AP
532 * This can be %NULL, if ap_scan=2 mode is used and the driver is
533 * responsible for selecting with which BSS to associate. */
537 * bssid_hint - BSSID of a proposed AP
539 * This indicates which BSS has been found a suitable candidate for
540 * initial association for drivers that use driver/firmwate-based BSS
541 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
542 * the driver from selecting other BSSes in the ESS.
544 const u8 *bssid_hint;
547 * ssid - The selected SSID
552 * ssid_len - Length of the SSID (1..32)
557 * freq - channel parameters
559 struct hostapd_freq_params freq;
562 * freq_hint - Frequency of the channel the proposed AP is using
564 * This provides a channel on which a suitable BSS has been found as a
565 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
566 * limit the driver from selecting other channels for
567 * driver/firmware-based BSS selection.
572 * bg_scan_period - Background scan period in seconds, 0 to disable
573 * background scan, or -1 to indicate no change to default driver
579 * beacon_int - Beacon interval for IBSS or 0 to use driver default
584 * wpa_ie - WPA information element for (Re)Association Request
585 * WPA information element to be included in (Re)Association
586 * Request (including information element id and length). Use
587 * of this WPA IE is optional. If the driver generates the WPA
588 * IE, it can use pairwise_suite, group_suite, and
589 * key_mgmt_suite to select proper algorithms. In this case,
590 * the driver has to notify wpa_supplicant about the used WPA
591 * IE by generating an event that the interface code will
592 * convert into EVENT_ASSOCINFO data (see below).
594 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
595 * instead. The driver can determine which version is used by
596 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
599 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
604 * wpa_ie_len - length of the wpa_ie
609 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
611 unsigned int wpa_proto;
614 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
616 * This is usually ignored if @wpa_ie is used.
618 unsigned int pairwise_suite;
621 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
623 * This is usually ignored if @wpa_ie is used.
625 unsigned int group_suite;
628 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
630 * This is usually ignored if @wpa_ie is used.
632 unsigned int key_mgmt_suite;
635 * auth_alg - Allowed authentication algorithms
636 * Bit field of WPA_AUTH_ALG_*
641 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
646 * wep_key - WEP keys for static WEP configuration
648 const u8 *wep_key[4];
651 * wep_key_len - WEP key length for static WEP configuration
653 size_t wep_key_len[4];
656 * wep_tx_keyidx - WEP TX key index for static WEP configuration
661 * mgmt_frame_protection - IEEE 802.11w management frame protection
663 enum mfp_options mgmt_frame_protection;
666 * ft_ies - IEEE 802.11r / FT information elements
667 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
668 * for fast transition, this parameter is set to include the IEs that
669 * are to be sent in the next FT Authentication Request message.
670 * update_ft_ies() handler is called to update the IEs for further
671 * FT messages in the sequence.
673 * The driver should use these IEs only if the target AP is advertising
674 * the same mobility domain as the one included in the MDIE here.
676 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
677 * AP after the initial association. These IEs can only be used if the
678 * target AP is advertising support for FT and is using the same MDIE
679 * and SSID as the current AP.
681 * The driver is responsible for reporting the FT IEs received from the
682 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
683 * type. update_ft_ies() handler will then be called with the FT IEs to
684 * include in the next frame in the authentication sequence.
689 * ft_ies_len - Length of ft_ies in bytes
694 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
696 * This value is provided to allow the driver interface easier access
697 * to the current mobility domain. This value is set to %NULL if no
698 * mobility domain is currently active.
703 * passphrase - RSN passphrase for PSK
705 * This value is made available only for WPA/WPA2-Personal (PSK) and
706 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
707 * the 8..63 character ASCII passphrase, if available. Please note that
708 * this can be %NULL if passphrase was not used to generate the PSK. In
709 * that case, the psk field must be used to fetch the PSK.
711 const char *passphrase;
714 * psk - RSN PSK (alternative for passphrase for PSK)
716 * This value is made available only for WPA/WPA2-Personal (PSK) and
717 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
718 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
719 * be prepared to handle %NULL value as an error.
724 * drop_unencrypted - Enable/disable unencrypted frame filtering
726 * Configure the driver to drop all non-EAPOL frames (both receive and
727 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
728 * still be allowed for key negotiation.
730 int drop_unencrypted;
733 * prev_bssid - Previously used BSSID in this ESS
735 * When not %NULL, this is a request to use reassociation instead of
738 const u8 *prev_bssid;
743 * If the driver needs to do special configuration for WPS association,
744 * this variable provides more information on what type of association
745 * is being requested. Most drivers should not need ot use this.
750 * p2p - Whether this connection is a P2P group
755 * uapsd - UAPSD parameters for the network
756 * -1 = do not change defaults
757 * AP mode: 1 = enabled, 0 = disabled
758 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
763 * fixed_bssid - Whether to force this BSSID in IBSS mode
764 * 1 = Fix this BSSID and prevent merges.
765 * 0 = Do not fix BSSID.
770 * disable_ht - Disable HT (IEEE 802.11n) for this connection
775 * htcaps - HT Capabilities over-rides
777 * Only bits set in the mask will be used, and not all values are used
778 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
780 * Pointer to struct ieee80211_ht_capabilities.
785 * htcaps_mask - HT Capabilities over-rides mask
787 * Pointer to struct ieee80211_ht_capabilities.
789 const u8 *htcaps_mask;
791 #ifdef CONFIG_VHT_OVERRIDES
793 * disable_vht - Disable VHT for this connection
798 * VHT capability overrides.
800 const struct ieee80211_vht_capabilities *vhtcaps;
801 const struct ieee80211_vht_capabilities *vhtcaps_mask;
802 #endif /* CONFIG_VHT_OVERRIDES */
805 * req_key_mgmt_offload - Request key management offload for connection
807 * Request key management offload for this connection if the device
810 int req_key_mgmt_offload;
813 * Flag for indicating whether this association includes support for
814 * RRM (Radio Resource Measurements)
821 HIDDEN_SSID_ZERO_LEN,
822 HIDDEN_SSID_ZERO_CONTENTS
825 struct wowlan_triggers {
829 u8 gtk_rekey_failure;
831 u8 four_way_handshake;
835 struct wpa_driver_ap_params {
837 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
842 * head_len - Length of the head buffer in octets
847 * tail - Beacon tail following TIM IE
852 * tail_len - Length of the tail buffer in octets
857 * dtim_period - DTIM period
862 * beacon_int - Beacon interval
867 * basic_rates: -1 terminated array of basic rates in 100 kbps
869 * This parameter can be used to set a specific basic rate set for the
870 * BSS. If %NULL, default basic rate set is used.
875 * proberesp - Probe Response template
877 * This is used by drivers that reply to Probe Requests internally in
878 * AP mode and require the full Probe Response template.
883 * proberesp_len - Length of the proberesp buffer in octets
885 size_t proberesp_len;
888 * ssid - The SSID to use in Beacon/Probe Response frames
893 * ssid_len - Length of the SSID (1..32)
898 * hide_ssid - Whether to hide the SSID
900 enum hide_ssid hide_ssid;
903 * pairwise_ciphers - WPA_CIPHER_* bitfield
905 unsigned int pairwise_ciphers;
908 * group_cipher - WPA_CIPHER_*
910 unsigned int group_cipher;
913 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
915 unsigned int key_mgmt_suites;
918 * auth_algs - WPA_AUTH_ALG_* bitfield
920 unsigned int auth_algs;
923 * wpa_version - WPA_PROTO_* bitfield
925 unsigned int wpa_version;
928 * privacy - Whether privacy is used in the BSS
933 * beacon_ies - WPS/P2P IE(s) for Beacon frames
935 * This is used to add IEs like WPS IE and P2P IE by drivers that do
936 * not use the full Beacon template.
938 const struct wpabuf *beacon_ies;
941 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
943 * This is used to add IEs like WPS IE and P2P IE by drivers that
944 * reply to Probe Request frames internally.
946 const struct wpabuf *proberesp_ies;
949 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
951 * This is used to add IEs like WPS IE by drivers that reply to
952 * (Re)Association Request frames internally.
954 const struct wpabuf *assocresp_ies;
957 * isolate - Whether to isolate frames between associated stations
959 * If this is non-zero, the AP is requested to disable forwarding of
960 * frames between associated stations.
965 * cts_protect - Whether CTS protection is enabled
970 * preamble - Whether short preamble is enabled
975 * short_slot_time - Whether short slot time is enabled
977 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
978 * not set (e.g., when 802.11g mode is not in use)
983 * ht_opmode - HT operation mode or -1 if HT not in use
988 * interworking - Whether Interworking is enabled
993 * hessid - Homogeneous ESS identifier or %NULL if not set
998 * access_network_type - Access Network Type (0..15)
1000 * This is used for filtering Probe Request frames when Interworking is
1003 u8 access_network_type;
1006 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1008 * This is used by driver which advertises this capability.
1010 int ap_max_inactivity;
1013 * smps_mode - SMPS mode
1015 * SMPS mode to be used by the AP, specified as the relevant bits of
1016 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1018 unsigned int smps_mode;
1021 * disable_dgaf - Whether group-addressed frames are disabled
1026 * osen - Whether OSEN security is enabled
1031 * freq - Channel parameters for dynamic bandwidth changes
1033 struct hostapd_freq_params *freq;
1036 struct wpa_driver_mesh_bss_params {
1037 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1039 * TODO: Other mesh configuration parameters would go here.
1040 * See NL80211_MESHCONF_* for all the mesh config parameters.
1045 struct wpa_driver_mesh_join_params {
1048 const int *basic_rates;
1054 enum ht_mode ht_mode;
1055 struct wpa_driver_mesh_bss_params conf;
1056 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1057 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1058 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1059 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1064 * struct wpa_driver_capa - Driver capability information
1066 struct wpa_driver_capa {
1067 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1068 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1069 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1070 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1071 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1072 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1073 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1074 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1075 /** Bitfield of supported key management suites */
1076 unsigned int key_mgmt;
1078 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1079 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1080 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1081 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1082 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1083 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1084 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1085 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1086 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1087 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1088 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1089 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1090 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1091 /** Bitfield of supported cipher suites */
1094 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1095 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1096 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1097 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1100 /** Driver generated WPA/RSN IE */
1101 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1102 /** Driver needs static WEP key setup after association command */
1103 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1104 /** Driver takes care of all DFS operations */
1105 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1106 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1107 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1108 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1109 /** Driver is for a wired Ethernet interface */
1110 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1111 /** Driver provides separate commands for authentication and association (SME in
1112 * wpa_supplicant). */
1113 #define WPA_DRIVER_FLAGS_SME 0x00000020
1114 /** Driver supports AP mode */
1115 #define WPA_DRIVER_FLAGS_AP 0x00000040
1116 /** Driver needs static WEP key setup after association has been completed */
1117 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1118 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1119 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1120 /** Driver supports concurrent P2P operations */
1121 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1123 * Driver uses the initial interface as a dedicated management interface, i.e.,
1124 * it cannot be used for P2P group operations or non-P2P purposes.
1126 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1127 /** This interface is P2P capable (P2P GO or P2P Client) */
1128 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1129 /** Driver supports station and key removal when stopping an AP */
1130 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1132 * Driver uses the initial interface for P2P management interface and non-P2P
1133 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1134 * P2P group operations.
1136 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1138 * Driver is known to use sane error codes, i.e., when it indicates that
1139 * something (e.g., association) fails, there was indeed a failure and the
1140 * operation does not end up getting completed successfully later.
1142 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1143 /** Driver supports off-channel TX */
1144 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1145 /** Driver indicates TX status events for EAPOL Data frames */
1146 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1147 /** Driver indicates TX status events for Deauth/Disassoc frames */
1148 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1149 /** Driver supports roaming (BSS selection) in firmware */
1150 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1151 /** Driver supports operating as a TDLS peer */
1152 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1153 /** Driver requires external TDLS setup/teardown/discovery */
1154 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1155 /** Driver indicates support for Probe Response offloading in AP mode */
1156 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1157 /** Driver supports U-APSD in AP mode */
1158 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1159 /** Driver supports inactivity timer in AP mode */
1160 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1161 /** Driver expects user space implementation of MLME in AP mode */
1162 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1163 /** Driver supports SAE with user space SME */
1164 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1165 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1166 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1167 /** Driver supports IBSS (Ad-hoc) mode */
1168 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1169 /** Driver supports radar detection */
1170 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1171 /** Driver supports a dedicated interface for P2P Device */
1172 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1173 /** Driver supports QoS Mapping */
1174 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1175 /** Driver supports CSA in AP mode */
1176 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1177 /** Driver supports mesh */
1178 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1179 /** Driver support ACS offload */
1180 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1181 /** Driver supports key management offload */
1182 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1183 /** Driver supports TDLS channel switching */
1184 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1187 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1188 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1189 unsigned int smps_modes;
1191 unsigned int wmm_ac_supported:1;
1193 unsigned int mac_addr_rand_scan_supported:1;
1194 unsigned int mac_addr_rand_sched_scan_supported:1;
1196 /** Maximum number of supported active probe SSIDs */
1199 /** Maximum number of supported active probe SSIDs for sched_scan */
1200 int max_sched_scan_ssids;
1202 /** Whether sched_scan (offloaded scanning) is supported */
1203 int sched_scan_supported;
1205 /** Maximum number of supported match sets for sched_scan */
1209 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1211 unsigned int max_remain_on_chan;
1214 * max_stations - Maximum number of associated stations the driver
1215 * supports in AP mode
1217 unsigned int max_stations;
1220 * probe_resp_offloads - Bitmap of supported protocols by the driver
1221 * for Probe Response offloading.
1223 /** Driver Probe Response offloading support for WPS ver. 1 */
1224 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1225 /** Driver Probe Response offloading support for WPS ver. 2 */
1226 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1227 /** Driver Probe Response offloading support for P2P */
1228 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1229 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1230 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1231 unsigned int probe_resp_offloads;
1233 unsigned int max_acl_mac_addrs;
1236 * Number of supported concurrent channels
1238 unsigned int num_multichan_concurrent;
1241 * extended_capa - extended capabilities in driver/device
1243 * Must be allocated and freed by driver and the pointers must be
1244 * valid for the lifetime of the driver, i.e., freed in deinit()
1246 const u8 *extended_capa, *extended_capa_mask;
1247 unsigned int extended_capa_len;
1249 struct wowlan_triggers wowlan_triggers;
1251 /** Driver adds the DS Params Set IE in Probe Request frames */
1252 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1253 /** Driver adds the WFA TPC IE in Probe Request frames */
1254 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1255 /** Driver handles quiet period requests */
1256 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1258 * Driver is capable of inserting the current TX power value into the body of
1259 * transmitted frames.
1260 * Background: Some Action frames include a TPC Report IE. This IE contains a
1261 * TX power field, which has to be updated by lower layers. One such Action
1262 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1263 * of spectrum management). Note that this insertion takes place at a fixed
1264 * offset, namely the 6th byte in the Action frame body.
1266 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1271 struct hostapd_data;
1273 struct hostap_sta_driver_data {
1274 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1275 unsigned long current_tx_rate;
1276 unsigned long inactive_msec;
1277 unsigned long flags;
1278 unsigned long num_ps_buf_frames;
1279 unsigned long tx_retry_failed;
1280 unsigned long tx_retry_count;
1285 struct hostapd_sta_add_params {
1289 const u8 *supp_rates;
1290 size_t supp_rates_len;
1291 u16 listen_interval;
1292 const struct ieee80211_ht_capabilities *ht_capabilities;
1293 const struct ieee80211_vht_capabilities *vht_capabilities;
1294 int vht_opmode_enabled;
1296 u32 flags; /* bitmask of WPA_STA_* flags */
1297 u32 flags_mask; /* unset bits in flags */
1299 enum mesh_plink_state plink_state;
1300 #endif /* CONFIG_MESH */
1301 int set; /* Set STA parameters instead of add */
1303 const u8 *ext_capab;
1304 size_t ext_capab_len;
1305 const u8 *supp_channels;
1306 size_t supp_channels_len;
1307 const u8 *supp_oper_classes;
1308 size_t supp_oper_classes_len;
1311 struct mac_address {
1315 struct hostapd_acl_params {
1317 unsigned int num_mac_acl;
1318 struct mac_address mac_acl[0];
1321 enum wpa_driver_if_type {
1323 * WPA_IF_STATION - Station mode interface
1328 * WPA_IF_AP_VLAN - AP mode VLAN interface
1330 * This interface shares its address and Beacon frame with the main
1336 * WPA_IF_AP_BSS - AP mode BSS interface
1338 * This interface has its own address and Beacon frame.
1343 * WPA_IF_P2P_GO - P2P Group Owner
1348 * WPA_IF_P2P_CLIENT - P2P Client
1353 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1354 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1359 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1360 * abstracted P2P Device function in the driver
1365 * WPA_IF_MESH - Mesh interface
1370 struct wpa_init_params {
1374 const char *driver_params;
1375 int use_pae_group_addr;
1379 u8 *own_addr; /* buffer for writing own MAC address */
1383 struct wpa_bss_params {
1384 /** Interface name (for multi-SSID/VLAN support) */
1386 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1395 enum mfp_options ieee80211w;
1398 #define WPA_STA_AUTHORIZED BIT(0)
1399 #define WPA_STA_WMM BIT(1)
1400 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1401 #define WPA_STA_MFP BIT(3)
1402 #define WPA_STA_TDLS_PEER BIT(4)
1403 #define WPA_STA_AUTHENTICATED BIT(5)
1416 WNM_SLEEP_ENTER_CONFIRM,
1417 WNM_SLEEP_ENTER_FAIL,
1418 WNM_SLEEP_EXIT_CONFIRM,
1419 WNM_SLEEP_EXIT_FAIL,
1420 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1421 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1422 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1424 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1426 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1427 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1429 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1432 /* enum chan_width - Channel width definitions */
1444 * struct wpa_signal_info - Information about channel signal quality
1446 struct wpa_signal_info {
1448 int above_threshold;
1453 enum chan_width chanwidth;
1459 * struct beacon_data - Beacon data
1460 * @head: Head portion of Beacon frame (before TIM IE)
1461 * @tail: Tail portion of Beacon frame (after TIM IE)
1462 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1463 * @proberesp_ies: Extra information element(s) to add into Probe Response
1465 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1466 * Response frames or %NULL
1467 * @probe_resp: Probe Response frame template
1468 * @head_len: Length of @head
1469 * @tail_len: Length of @tail
1470 * @beacon_ies_len: Length of beacon_ies in octets
1471 * @proberesp_ies_len: Length of proberesp_ies in octets
1472 * @proberesp_ies_len: Length of proberesp_ies in octets
1473 * @probe_resp_len: Length of probe response template (@probe_resp)
1475 struct beacon_data {
1482 size_t head_len, tail_len;
1483 size_t beacon_ies_len;
1484 size_t proberesp_ies_len;
1485 size_t assocresp_ies_len;
1486 size_t probe_resp_len;
1490 * struct csa_settings - Settings for channel switch command
1491 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1492 * @block_tx: 1 - block transmission for CSA period
1493 * @freq_params: Next channel frequency parameter
1494 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1495 * @beacon_after: Next beacon/probe resp/asooc resp info
1496 * @counter_offset_beacon: Offset to the count field in beacon's tail
1497 * @counter_offset_presp: Offset to the count field in probe resp.
1499 struct csa_settings {
1503 struct hostapd_freq_params freq_params;
1504 struct beacon_data beacon_csa;
1505 struct beacon_data beacon_after;
1507 u16 counter_offset_beacon;
1508 u16 counter_offset_presp;
1511 /* TDLS peer capabilities for send_tdls_mgmt() */
1512 enum tdls_peer_capability {
1513 TDLS_PEER_HT = BIT(0),
1514 TDLS_PEER_VHT = BIT(1),
1515 TDLS_PEER_WMM = BIT(2),
1518 /* valid info in the wmm_params struct */
1519 enum wmm_params_valid_info {
1520 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1524 * struct wmm_params - WMM parameterss configured for this association
1525 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1526 * of the struct contain valid information.
1527 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1528 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1535 #ifdef CONFIG_MACSEC
1536 struct macsec_init_params {
1537 Boolean always_include_sci;
1541 #endif /* CONFIG_MACSEC */
1543 enum drv_br_port_attr {
1544 DRV_BR_PORT_ATTR_PROXYARP,
1545 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1548 enum drv_br_net_param {
1549 DRV_BR_NET_PARAM_GARP_ACCEPT,
1552 struct drv_acs_params {
1553 /* Selected mode (HOSTAPD_MODE_*) */
1554 enum hostapd_hw_mode hw_mode;
1556 /* Indicates whether HT is enabled */
1559 /* Indicates whether HT40 is enabled */
1565 * struct wpa_driver_ops - Driver interface API definition
1567 * This structure defines the API that each driver interface needs to implement
1568 * for core wpa_supplicant code. All driver specific functionality is captured
1571 struct wpa_driver_ops {
1572 /** Name of the driver interface */
1574 /** One line description of the driver interface */
1578 * get_bssid - Get the current BSSID
1579 * @priv: private driver interface data
1580 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1582 * Returns: 0 on success, -1 on failure
1584 * Query kernel driver for the current BSSID and copy it to bssid.
1585 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1588 int (*get_bssid)(void *priv, u8 *bssid);
1591 * get_ssid - Get the current SSID
1592 * @priv: private driver interface data
1593 * @ssid: buffer for SSID (at least 32 bytes)
1595 * Returns: Length of the SSID on success, -1 on failure
1597 * Query kernel driver for the current SSID and copy it to ssid.
1598 * Returning zero is recommended if the STA is not associated.
1600 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1601 * can, at least in theory, contain control characters (including nul)
1602 * and as such, should be processed as binary data, not a printable
1605 int (*get_ssid)(void *priv, u8 *ssid);
1608 * set_key - Configure encryption key
1609 * @ifname: Interface name (for multi-SSID/VLAN support)
1610 * @priv: private driver interface data
1611 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1612 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1613 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1614 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1615 * %WPA_ALG_BIP_CMAC_256);
1616 * %WPA_ALG_NONE clears the key.
1617 * @addr: Address of the peer STA (BSSID of the current AP when setting
1618 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1619 * broadcast keys, %NULL for default keys that are used both for
1620 * broadcast and unicast; when clearing keys, %NULL is used to
1621 * indicate that both the broadcast-only and default key of the
1622 * specified key index is to be cleared
1623 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1625 * @set_tx: configure this key as the default Tx key (only used when
1626 * driver does not support separate unicast/individual key
1627 * @seq: sequence number/packet number, seq_len octets, the next
1628 * packet number to be used for in replay protection; configured
1629 * for Rx keys (in most cases, this is only used with broadcast
1630 * keys and set to zero for unicast keys); %NULL if not set
1631 * @seq_len: length of the seq, depends on the algorithm:
1632 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1633 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1635 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1636 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1638 * Returns: 0 on success, -1 on failure
1640 * Configure the given key for the kernel driver. If the driver
1641 * supports separate individual keys (4 default keys + 1 individual),
1642 * addr can be used to determine whether the key is default or
1643 * individual. If only 4 keys are supported, the default key with key
1644 * index 0 is used as the individual key. STA must be configured to use
1645 * it as the default Tx key (set_tx is set) and accept Rx for all the
1646 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1647 * broadcast keys, so key index 0 is available for this kind of
1650 * Please note that TKIP keys include separate TX and RX MIC keys and
1651 * some drivers may expect them in different order than wpa_supplicant
1652 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1653 * will trigger Michael MIC errors. This can be fixed by changing the
1654 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1655 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1656 * example on how this can be done.
1658 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1659 const u8 *addr, int key_idx, int set_tx,
1660 const u8 *seq, size_t seq_len,
1661 const u8 *key, size_t key_len);
1664 * init - Initialize driver interface
1665 * @ctx: context to be used when calling wpa_supplicant functions,
1666 * e.g., wpa_supplicant_event()
1667 * @ifname: interface name, e.g., wlan0
1669 * Returns: Pointer to private data, %NULL on failure
1671 * Initialize driver interface, including event processing for kernel
1672 * driver events (e.g., associated, scan results, Michael MIC failure).
1673 * This function can allocate a private configuration data area for
1674 * @ctx, file descriptor, interface name, etc. information that may be
1675 * needed in future driver operations. If this is not used, non-NULL
1676 * value will need to be returned because %NULL is used to indicate
1677 * failure. The returned value will be used as 'void *priv' data for
1678 * all other driver_ops functions.
1680 * The main event loop (eloop.c) of wpa_supplicant can be used to
1681 * register callback for read sockets (eloop_register_read_sock()).
1683 * See below for more information about events and
1684 * wpa_supplicant_event() function.
1686 void * (*init)(void *ctx, const char *ifname);
1689 * deinit - Deinitialize driver interface
1690 * @priv: private driver interface data from init()
1692 * Shut down driver interface and processing of driver events. Free
1693 * private data buffer if one was allocated in init() handler.
1695 void (*deinit)(void *priv);
1698 * set_param - Set driver configuration parameters
1699 * @priv: private driver interface data from init()
1700 * @param: driver specific configuration parameters
1702 * Returns: 0 on success, -1 on failure
1704 * Optional handler for notifying driver interface about configuration
1705 * parameters (driver_param).
1707 int (*set_param)(void *priv, const char *param);
1710 * set_countermeasures - Enable/disable TKIP countermeasures
1711 * @priv: private driver interface data
1712 * @enabled: 1 = countermeasures enabled, 0 = disabled
1714 * Returns: 0 on success, -1 on failure
1716 * Configure TKIP countermeasures. When these are enabled, the driver
1717 * should drop all received and queued frames that are using TKIP.
1719 int (*set_countermeasures)(void *priv, int enabled);
1722 * deauthenticate - Request driver to deauthenticate
1723 * @priv: private driver interface data
1724 * @addr: peer address (BSSID of the AP)
1725 * @reason_code: 16-bit reason code to be sent in the deauthentication
1728 * Returns: 0 on success, -1 on failure
1730 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1733 * associate - Request driver to associate
1734 * @priv: private driver interface data
1735 * @params: association parameters
1737 * Returns: 0 on success, -1 on failure
1739 int (*associate)(void *priv,
1740 struct wpa_driver_associate_params *params);
1743 * add_pmkid - Add PMKSA cache entry to the driver
1744 * @priv: private driver interface data
1745 * @bssid: BSSID for the PMKSA cache entry
1746 * @pmkid: PMKID for the PMKSA cache entry
1748 * Returns: 0 on success, -1 on failure
1750 * This function is called when a new PMK is received, as a result of
1751 * either normal authentication or RSN pre-authentication.
1753 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1754 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1755 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1756 * driver_ops function does not need to be implemented. Likewise, if
1757 * the driver does not support WPA, this function is not needed.
1759 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1762 * remove_pmkid - Remove PMKSA cache entry to the driver
1763 * @priv: private driver interface data
1764 * @bssid: BSSID for the PMKSA cache entry
1765 * @pmkid: PMKID for the PMKSA cache entry
1767 * Returns: 0 on success, -1 on failure
1769 * This function is called when the supplicant drops a PMKSA cache
1770 * entry for any reason.
1772 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1773 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1774 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1775 * from wpa_supplicant, this driver_ops function does not need to be
1776 * implemented. Likewise, if the driver does not support WPA, this
1777 * function is not needed.
1779 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1782 * flush_pmkid - Flush PMKSA cache
1783 * @priv: private driver interface data
1785 * Returns: 0 on success, -1 on failure
1787 * This function is called when the supplicant drops all PMKSA cache
1788 * entries for any reason.
1790 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1791 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1792 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1793 * from wpa_supplicant, this driver_ops function does not need to be
1794 * implemented. Likewise, if the driver does not support WPA, this
1795 * function is not needed.
1797 int (*flush_pmkid)(void *priv);
1800 * get_capa - Get driver capabilities
1801 * @priv: private driver interface data
1803 * Returns: 0 on success, -1 on failure
1805 * Get driver/firmware/hardware capabilities.
1807 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1810 * poll - Poll driver for association information
1811 * @priv: private driver interface data
1813 * This is an option callback that can be used when the driver does not
1814 * provide event mechanism for association events. This is called when
1815 * receiving WPA EAPOL-Key messages that require association
1816 * information. The driver interface is supposed to generate associnfo
1817 * event before returning from this callback function. In addition, the
1818 * driver interface should generate an association event after having
1819 * sent out associnfo.
1821 void (*poll)(void *priv);
1824 * get_ifname - Get interface name
1825 * @priv: private driver interface data
1827 * Returns: Pointer to the interface name. This can differ from the
1828 * interface name used in init() call. Init() is called first.
1830 * This optional function can be used to allow the driver interface to
1831 * replace the interface name with something else, e.g., based on an
1832 * interface mapping from a more descriptive name.
1834 const char * (*get_ifname)(void *priv);
1837 * get_mac_addr - Get own MAC address
1838 * @priv: private driver interface data
1840 * Returns: Pointer to own MAC address or %NULL on failure
1842 * This optional function can be used to get the own MAC address of the
1843 * device from the driver interface code. This is only needed if the
1844 * l2_packet implementation for the OS does not provide easy access to
1846 const u8 * (*get_mac_addr)(void *priv);
1849 * set_operstate - Sets device operating state to DORMANT or UP
1850 * @priv: private driver interface data
1851 * @state: 0 = dormant, 1 = up
1852 * Returns: 0 on success, -1 on failure
1854 * This is an optional function that can be used on operating systems
1855 * that support a concept of controlling network device state from user
1856 * space applications. This function, if set, gets called with
1857 * state = 1 when authentication has been completed and with state = 0
1858 * when connection is lost.
1860 int (*set_operstate)(void *priv, int state);
1863 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1864 * @priv: Private driver interface data
1865 * @addr: Address of the station for which to set protection (may be
1866 * %NULL for group keys)
1867 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1868 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1869 * Returns: 0 on success, -1 on failure
1871 * This is an optional function that can be used to set the driver to
1872 * require protection for Tx and/or Rx frames. This uses the layer
1873 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1874 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1875 * set protection operation; instead, they set protection implicitly
1876 * based on configured keys.
1878 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1882 * get_hw_feature_data - Get hardware support data (channels and rates)
1883 * @priv: Private driver interface data
1884 * @num_modes: Variable for returning the number of returned modes
1885 * flags: Variable for returning hardware feature flags
1886 * Returns: Pointer to allocated hardware data on success or %NULL on
1887 * failure. Caller is responsible for freeing this.
1889 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1894 * send_mlme - Send management frame from MLME
1895 * @priv: Private driver interface data
1896 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1897 * @data_len: Size of the management frame
1898 * @noack: Do not wait for this frame to be acked (disable retries)
1899 * Returns: 0 on success, -1 on failure
1901 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1905 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1906 * @priv: Private driver interface data
1907 * @md: Mobility domain (2 octets) (also included inside ies)
1908 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1909 * @ies_len: Length of FT IEs in bytes
1910 * Returns: 0 on success, -1 on failure
1912 * The supplicant uses this callback to let the driver know that keying
1913 * material for FT is available and that the driver can use the
1914 * provided IEs in the next message in FT authentication sequence.
1916 * This function is only needed for driver that support IEEE 802.11r
1917 * (Fast BSS Transition).
1919 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1923 * get_scan_results2 - Fetch the latest scan results
1924 * @priv: private driver interface data
1926 * Returns: Allocated buffer of scan results (caller is responsible for
1927 * freeing the data structure) on success, NULL on failure
1929 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1932 * set_country - Set country
1933 * @priv: Private driver interface data
1934 * @alpha2: country to which to switch to
1935 * Returns: 0 on success, -1 on failure
1937 * This function is for drivers which support some form
1938 * of setting a regulatory domain.
1940 int (*set_country)(void *priv, const char *alpha2);
1943 * get_country - Get country
1944 * @priv: Private driver interface data
1945 * @alpha2: Buffer for returning country code (at least 3 octets)
1946 * Returns: 0 on success, -1 on failure
1948 int (*get_country)(void *priv, char *alpha2);
1951 * global_init - Global driver initialization
1952 * Returns: Pointer to private data (global), %NULL on failure
1954 * This optional function is called to initialize the driver wrapper
1955 * for global data, i.e., data that applies to all interfaces. If this
1956 * function is implemented, global_deinit() will also need to be
1957 * implemented to free the private data. The driver will also likely
1958 * use init2() function instead of init() to get the pointer to global
1959 * data available to per-interface initializer.
1961 void * (*global_init)(void);
1964 * global_deinit - Global driver deinitialization
1965 * @priv: private driver global data from global_init()
1967 * Terminate any global driver related functionality and free the
1968 * global data structure.
1970 void (*global_deinit)(void *priv);
1973 * init2 - Initialize driver interface (with global data)
1974 * @ctx: context to be used when calling wpa_supplicant functions,
1975 * e.g., wpa_supplicant_event()
1976 * @ifname: interface name, e.g., wlan0
1977 * @global_priv: private driver global data from global_init()
1978 * Returns: Pointer to private data, %NULL on failure
1980 * This function can be used instead of init() if the driver wrapper
1983 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1986 * get_interfaces - Get information about available interfaces
1987 * @global_priv: private driver global data from global_init()
1988 * Returns: Allocated buffer of interface information (caller is
1989 * responsible for freeing the data structure) on success, NULL on
1992 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1995 * scan2 - Request the driver to initiate scan
1996 * @priv: private driver interface data
1997 * @params: Scan parameters
1999 * Returns: 0 on success, -1 on failure
2001 * Once the scan results are ready, the driver should report scan
2002 * results event for wpa_supplicant which will eventually request the
2003 * results with wpa_driver_get_scan_results2().
2005 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2008 * authenticate - Request driver to authenticate
2009 * @priv: private driver interface data
2010 * @params: authentication parameters
2011 * Returns: 0 on success, -1 on failure
2013 * This is an optional function that can be used with drivers that
2014 * support separate authentication and association steps, i.e., when
2015 * wpa_supplicant can act as the SME. If not implemented, associate()
2016 * function is expected to take care of IEEE 802.11 authentication,
2019 int (*authenticate)(void *priv,
2020 struct wpa_driver_auth_params *params);
2023 * set_ap - Set Beacon and Probe Response information for AP mode
2024 * @priv: Private driver interface data
2025 * @params: Parameters to use in AP mode
2027 * This function is used to configure Beacon template and/or extra IEs
2028 * to add for Beacon and Probe Response frames for the driver in
2029 * AP mode. The driver is responsible for building the full Beacon
2030 * frame by concatenating the head part with TIM IE generated by the
2031 * driver/firmware and finishing with the tail part. Depending on the
2032 * driver architectue, this can be done either by using the full
2033 * template or the set of additional IEs (e.g., WPS and P2P IE).
2034 * Similarly, Probe Response processing depends on the driver design.
2035 * If the driver (or firmware) takes care of replying to Probe Request
2036 * frames, the extra IEs provided here needs to be added to the Probe
2039 * Returns: 0 on success, -1 on failure
2041 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
2044 * set_acl - Set ACL in AP mode
2045 * @priv: Private driver interface data
2046 * @params: Parameters to configure ACL
2047 * Returns: 0 on success, -1 on failure
2049 * This is used only for the drivers which support MAC address ACL.
2051 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2054 * hapd_init - Initialize driver interface (hostapd only)
2055 * @hapd: Pointer to hostapd context
2056 * @params: Configuration for the driver wrapper
2057 * Returns: Pointer to private data, %NULL on failure
2059 * This function is used instead of init() or init2() when the driver
2060 * wrapper is used with hostapd.
2062 void * (*hapd_init)(struct hostapd_data *hapd,
2063 struct wpa_init_params *params);
2066 * hapd_deinit - Deinitialize driver interface (hostapd only)
2067 * @priv: Private driver interface data from hapd_init()
2069 void (*hapd_deinit)(void *priv);
2072 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2073 * @priv: Private driver interface data
2074 * @params: BSS parameters
2075 * Returns: 0 on success, -1 on failure
2077 * This is an optional function to configure the kernel driver to
2078 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2079 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2080 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2081 * for Beacon frames.
2083 * DEPRECATED - use set_ap() instead
2085 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2088 * set_privacy - Enable/disable privacy (AP only)
2089 * @priv: Private driver interface data
2090 * @enabled: 1 = privacy enabled, 0 = disabled
2091 * Returns: 0 on success, -1 on failure
2093 * This is an optional function to configure privacy field in the
2094 * kernel driver for Beacon frames. This can be left undefined (set to
2095 * %NULL) if the driver uses the Beacon template from set_ap().
2097 * DEPRECATED - use set_ap() instead
2099 int (*set_privacy)(void *priv, int enabled);
2102 * get_seqnum - Fetch the current TSC/packet number (AP only)
2103 * @ifname: The interface name (main or virtual)
2104 * @priv: Private driver interface data
2105 * @addr: MAC address of the station or %NULL for group keys
2107 * @seq: Buffer for returning the latest used TSC/packet number
2108 * Returns: 0 on success, -1 on failure
2110 * This function is used to fetch the last used TSC/packet number for
2111 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2112 * keys, so there is no strict requirement on implementing support for
2113 * unicast keys (i.e., addr != %NULL).
2115 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2119 * flush - Flush all association stations (AP only)
2120 * @priv: Private driver interface data
2121 * Returns: 0 on success, -1 on failure
2123 * This function requests the driver to disassociate all associated
2124 * stations. This function does not need to be implemented if the
2125 * driver does not process association frames internally.
2127 int (*flush)(void *priv);
2130 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2131 * @priv: Private driver interface data
2132 * @elem: Information elements
2133 * @elem_len: Length of the elem buffer in octets
2134 * Returns: 0 on success, -1 on failure
2136 * This is an optional function to add information elements in the
2137 * kernel driver for Beacon and Probe Response frames. This can be left
2138 * undefined (set to %NULL) if the driver uses the Beacon template from
2141 * DEPRECATED - use set_ap() instead
2143 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2146 * read_sta_data - Fetch station data
2147 * @priv: Private driver interface data
2148 * @data: Buffer for returning station information
2149 * @addr: MAC address of the station
2150 * Returns: 0 on success, -1 on failure
2152 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2156 * hapd_send_eapol - Send an EAPOL packet (AP only)
2157 * @priv: private driver interface data
2158 * @addr: Destination MAC address
2159 * @data: EAPOL packet starting with IEEE 802.1X header
2160 * @data_len: Length of the EAPOL packet in octets
2161 * @encrypt: Whether the frame should be encrypted
2162 * @own_addr: Source MAC address
2163 * @flags: WPA_STA_* flags for the destination station
2165 * Returns: 0 on success, -1 on failure
2167 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2168 size_t data_len, int encrypt,
2169 const u8 *own_addr, u32 flags);
2172 * sta_deauth - Deauthenticate a station (AP only)
2173 * @priv: Private driver interface data
2174 * @own_addr: Source address and BSSID for the Deauthentication frame
2175 * @addr: MAC address of the station to deauthenticate
2176 * @reason: Reason code for the Deauthentiation frame
2177 * Returns: 0 on success, -1 on failure
2179 * This function requests a specific station to be deauthenticated and
2180 * a Deauthentication frame to be sent to it.
2182 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2186 * sta_disassoc - Disassociate a station (AP only)
2187 * @priv: Private driver interface data
2188 * @own_addr: Source address and BSSID for the Disassociation frame
2189 * @addr: MAC address of the station to disassociate
2190 * @reason: Reason code for the Disassociation frame
2191 * Returns: 0 on success, -1 on failure
2193 * This function requests a specific station to be disassociated and
2194 * a Disassociation frame to be sent to it.
2196 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2200 * sta_remove - Remove a station entry (AP only)
2201 * @priv: Private driver interface data
2202 * @addr: MAC address of the station to be removed
2203 * Returns: 0 on success, -1 on failure
2205 int (*sta_remove)(void *priv, const u8 *addr);
2208 * hapd_get_ssid - Get the current SSID (AP only)
2209 * @priv: Private driver interface data
2210 * @buf: Buffer for returning the SSID
2211 * @len: Maximum length of the buffer
2212 * Returns: Length of the SSID on success, -1 on failure
2214 * This function need not be implemented if the driver uses Beacon
2215 * template from set_ap() and does not reply to Probe Request frames.
2217 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2220 * hapd_set_ssid - Set SSID (AP only)
2221 * @priv: Private driver interface data
2223 * @len: Length of the SSID in octets
2224 * Returns: 0 on success, -1 on failure
2226 * DEPRECATED - use set_ap() instead
2228 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2231 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2232 * @priv: Private driver interface data
2233 * @enabled: 1 = countermeasures enabled, 0 = disabled
2234 * Returns: 0 on success, -1 on failure
2236 * This need not be implemented if the driver does not take care of
2237 * association processing.
2239 int (*hapd_set_countermeasures)(void *priv, int enabled);
2242 * sta_add - Add a station entry
2243 * @priv: Private driver interface data
2244 * @params: Station parameters
2245 * Returns: 0 on success, -1 on failure
2247 * This function is used to add a station entry to the driver once the
2248 * station has completed association. This is only used if the driver
2249 * does not take care of association processing.
2251 * With TDLS, this function is also used to add or set (params->set 1)
2252 * TDLS peer entries.
2254 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2257 * get_inact_sec - Get station inactivity duration (AP only)
2258 * @priv: Private driver interface data
2259 * @addr: Station address
2260 * Returns: Number of seconds station has been inactive, -1 on failure
2262 int (*get_inact_sec)(void *priv, const u8 *addr);
2265 * sta_clear_stats - Clear station statistics (AP only)
2266 * @priv: Private driver interface data
2267 * @addr: Station address
2268 * Returns: 0 on success, -1 on failure
2270 int (*sta_clear_stats)(void *priv, const u8 *addr);
2273 * set_freq - Set channel/frequency (AP only)
2274 * @priv: Private driver interface data
2275 * @freq: Channel parameters
2276 * Returns: 0 on success, -1 on failure
2278 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2281 * set_rts - Set RTS threshold
2282 * @priv: Private driver interface data
2283 * @rts: RTS threshold in octets
2284 * Returns: 0 on success, -1 on failure
2286 int (*set_rts)(void *priv, int rts);
2289 * set_frag - Set fragmentation threshold
2290 * @priv: Private driver interface data
2291 * @frag: Fragmentation threshold in octets
2292 * Returns: 0 on success, -1 on failure
2294 int (*set_frag)(void *priv, int frag);
2297 * sta_set_flags - Set station flags (AP only)
2298 * @priv: Private driver interface data
2299 * @addr: Station address
2300 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2301 * @flags_or: Bitmap of WPA_STA_* flags to add
2302 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2303 * Returns: 0 on success, -1 on failure
2305 int (*sta_set_flags)(void *priv, const u8 *addr,
2306 int total_flags, int flags_or, int flags_and);
2309 * set_tx_queue_params - Set TX queue parameters
2310 * @priv: Private driver interface data
2311 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2315 * @burst_time: Maximum length for bursting in 0.1 msec units
2317 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2318 int cw_max, int burst_time);
2321 * if_add - Add a virtual interface
2322 * @priv: Private driver interface data
2323 * @type: Interface type
2324 * @ifname: Interface name for the new virtual interface
2325 * @addr: Local address to use for the interface or %NULL to use the
2326 * parent interface address
2327 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2328 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2329 * not allowed (applies only to %WPA_IF_AP_BSS type)
2330 * @force_ifname: Buffer for returning an interface name that the
2331 * driver ended up using if it differs from the requested ifname
2332 * @if_addr: Buffer for returning the allocated interface address
2333 * (this may differ from the requested addr if the driver cannot
2334 * change interface address)
2335 * @bridge: Bridge interface to use or %NULL if no bridge configured
2336 * @use_existing: Whether to allow existing interface to be used
2337 * Returns: 0 on success, -1 on failure
2339 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2340 const char *ifname, const u8 *addr, void *bss_ctx,
2341 void **drv_priv, char *force_ifname, u8 *if_addr,
2342 const char *bridge, int use_existing);
2345 * if_remove - Remove a virtual interface
2346 * @priv: Private driver interface data
2347 * @type: Interface type
2348 * @ifname: Interface name of the virtual interface to be removed
2349 * Returns: 0 on success, -1 on failure
2351 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2352 const char *ifname);
2355 * set_sta_vlan - Bind a station into a specific interface (AP only)
2356 * @priv: Private driver interface data
2357 * @ifname: Interface (main or virtual BSS or VLAN)
2358 * @addr: MAC address of the associated station
2360 * Returns: 0 on success, -1 on failure
2362 * This function is used to bind a station to a specific virtual
2363 * interface. It is only used if when virtual interfaces are supported,
2364 * e.g., to assign stations to different VLAN interfaces based on
2365 * information from a RADIUS server. This allows separate broadcast
2366 * domains to be used with a single BSS.
2368 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2372 * commit - Optional commit changes handler (AP only)
2373 * @priv: driver private data
2374 * Returns: 0 on success, -1 on failure
2376 * This optional handler function can be registered if the driver
2377 * interface implementation needs to commit changes (e.g., by setting
2378 * network interface up) at the end of initial configuration. If set,
2379 * this handler will be called after initial setup has been completed.
2381 int (*commit)(void *priv);
2384 * send_ether - Send an ethernet packet (AP only)
2385 * @priv: private driver interface data
2386 * @dst: Destination MAC address
2387 * @src: Source MAC address
2389 * @data: EAPOL packet starting with IEEE 802.1X header
2390 * @data_len: Length of the EAPOL packet in octets
2391 * Returns: 0 on success, -1 on failure
2393 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2394 const u8 *data, size_t data_len);
2397 * set_radius_acl_auth - Notification of RADIUS ACL change
2398 * @priv: Private driver interface data
2399 * @mac: MAC address of the station
2400 * @accepted: Whether the station was accepted
2401 * @session_timeout: Session timeout for the station
2402 * Returns: 0 on success, -1 on failure
2404 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2405 u32 session_timeout);
2408 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2409 * @priv: Private driver interface data
2410 * @mac: MAC address of the station
2411 * Returns: 0 on success, -1 on failure
2413 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2416 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2417 * @priv: Private driver interface data
2418 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2419 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2421 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2422 * to remove extra IE(s)
2423 * Returns: 0 on success, -1 on failure
2425 * This is an optional function to add WPS IE in the kernel driver for
2426 * Beacon and Probe Response frames. This can be left undefined (set
2427 * to %NULL) if the driver uses the Beacon template from set_ap()
2428 * and does not process Probe Request frames. If the driver takes care
2429 * of (Re)Association frame processing, the assocresp buffer includes
2430 * WPS IE(s) that need to be added to (Re)Association Response frames
2431 * whenever a (Re)Association Request frame indicated use of WPS.
2433 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2434 * frames when operating as a GO. The driver is responsible for adding
2435 * timing related attributes (e.g., NoA) in addition to the IEs
2436 * included here by appending them after these buffers. This call is
2437 * also used to provide Probe Response IEs for P2P Listen state
2438 * operations for drivers that generate the Probe Response frames
2441 * DEPRECATED - use set_ap() instead
2443 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2444 const struct wpabuf *proberesp,
2445 const struct wpabuf *assocresp);
2448 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2449 * @priv: Private driver interface data
2450 * @authorized: Whether the port is authorized
2451 * Returns: 0 on success, -1 on failure
2453 int (*set_supp_port)(void *priv, int authorized);
2456 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2457 * @priv: Private driver interface data
2458 * @addr: MAC address of the associated station
2459 * @aid: Association ID
2460 * @val: 1 = bind to 4-address WDS; 0 = unbind
2461 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2462 * to indicate that bridge is not to be used
2463 * @ifname_wds: Buffer to return the interface name for the new WDS
2464 * station or %NULL to indicate name is not returned.
2465 * Returns: 0 on success, -1 on failure
2467 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2468 const char *bridge_ifname, char *ifname_wds);
2471 * send_action - Transmit an Action frame
2472 * @priv: Private driver interface data
2473 * @freq: Frequency (in MHz) of the channel
2474 * @wait: Time to wait off-channel for a response (in ms), or zero
2475 * @dst: Destination MAC address (Address 1)
2476 * @src: Source MAC address (Address 2)
2477 * @bssid: BSSID (Address 3)
2479 * @data_len: data length in octets
2480 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2481 * Returns: 0 on success, -1 on failure
2483 * This command can be used to request the driver to transmit an action
2484 * frame to the specified destination.
2486 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2487 * be transmitted on the given channel and the device will wait for a
2488 * response on that channel for the given wait time.
2490 * If the flag is not set, the wait time will be ignored. In this case,
2491 * if a remain-on-channel duration is in progress, the frame must be
2492 * transmitted on that channel; alternatively the frame may be sent on
2493 * the current operational channel (if in associated state in station
2494 * mode or while operating as an AP.)
2496 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2497 const u8 *dst, const u8 *src, const u8 *bssid,
2498 const u8 *data, size_t data_len, int no_cck);
2501 * send_action_cancel_wait - Cancel action frame TX wait
2502 * @priv: Private driver interface data
2504 * This command cancels the wait time associated with sending an action
2505 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2506 * set in the driver flags.
2508 void (*send_action_cancel_wait)(void *priv);
2511 * remain_on_channel - Remain awake on a channel
2512 * @priv: Private driver interface data
2513 * @freq: Frequency (in MHz) of the channel
2514 * @duration: Duration in milliseconds
2515 * Returns: 0 on success, -1 on failure
2517 * This command is used to request the driver to remain awake on the
2518 * specified channel for the specified duration and report received
2519 * Action frames with EVENT_RX_MGMT events. Optionally, received
2520 * Probe Request frames may also be requested to be reported by calling
2521 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2523 * The driver may not be at the requested channel when this function
2524 * returns, i.e., the return code is only indicating whether the
2525 * request was accepted. The caller will need to wait until the
2526 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2527 * completed the channel change. This may take some time due to other
2528 * need for the radio and the caller should be prepared to timing out
2529 * its wait since there are no guarantees on when this request can be
2532 int (*remain_on_channel)(void *priv, unsigned int freq,
2533 unsigned int duration);
2536 * cancel_remain_on_channel - Cancel remain-on-channel operation
2537 * @priv: Private driver interface data
2539 * This command can be used to cancel a remain-on-channel operation
2540 * before its originally requested duration has passed. This could be
2541 * used, e.g., when remain_on_channel() is used to request extra time
2542 * to receive a response to an Action frame and the response is
2543 * received when there is still unneeded time remaining on the
2544 * remain-on-channel operation.
2546 int (*cancel_remain_on_channel)(void *priv);
2549 * probe_req_report - Request Probe Request frames to be indicated
2550 * @priv: Private driver interface data
2551 * @report: Whether to report received Probe Request frames
2552 * Returns: 0 on success, -1 on failure (or if not supported)
2554 * This command can be used to request the driver to indicate when
2555 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2556 * Since this operation may require extra resources, e.g., due to less
2557 * optimal hardware/firmware RX filtering, many drivers may disable
2558 * Probe Request reporting at least in station mode. This command is
2559 * used to notify the driver when the Probe Request frames need to be
2560 * reported, e.g., during remain-on-channel operations.
2562 int (*probe_req_report)(void *priv, int report);
2565 * deinit_ap - Deinitialize AP mode
2566 * @priv: Private driver interface data
2567 * Returns: 0 on success, -1 on failure (or if not supported)
2569 * This optional function can be used to disable AP mode related
2570 * configuration. If the interface was not dynamically added,
2571 * change the driver mode to station mode to allow normal station
2572 * operations like scanning to be completed.
2574 int (*deinit_ap)(void *priv);
2577 * deinit_p2p_cli - Deinitialize P2P client mode
2578 * @priv: Private driver interface data
2579 * Returns: 0 on success, -1 on failure (or if not supported)
2581 * This optional function can be used to disable P2P client mode. If the
2582 * interface was not dynamically added, change the interface type back
2585 int (*deinit_p2p_cli)(void *priv);
2588 * suspend - Notification on system suspend/hibernate event
2589 * @priv: Private driver interface data
2591 void (*suspend)(void *priv);
2594 * resume - Notification on system resume/thaw event
2595 * @priv: Private driver interface data
2597 void (*resume)(void *priv);
2600 * signal_monitor - Set signal monitoring parameters
2601 * @priv: Private driver interface data
2602 * @threshold: Threshold value for signal change events; 0 = disabled
2603 * @hysteresis: Minimum change in signal strength before indicating a
2605 * Returns: 0 on success, -1 on failure (or if not supported)
2607 * This function can be used to configure monitoring of signal strength
2608 * with the current AP. Whenever signal strength drops below the
2609 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2610 * should be generated assuming the signal strength has changed at
2611 * least %hysteresis from the previously indicated signal change event.
2613 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2616 * send_frame - Send IEEE 802.11 frame (testing use only)
2617 * @priv: Private driver interface data
2618 * @data: IEEE 802.11 frame with IEEE 802.11 header
2619 * @data_len: Size of the frame
2620 * @encrypt: Whether to encrypt the frame (if keys are set)
2621 * Returns: 0 on success, -1 on failure
2623 * This function is only used for debugging purposes and is not
2624 * required to be implemented for normal operations.
2626 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2630 * shared_freq - Get operating frequency of shared interface(s)
2631 * @priv: Private driver interface data
2632 * Returns: Operating frequency in MHz, 0 if no shared operation in
2633 * use, or -1 on failure
2635 * This command can be used to request the current operating frequency
2636 * of any virtual interface that shares the same radio to provide
2637 * information for channel selection for other virtual interfaces.
2639 int (*shared_freq)(void *priv);
2642 * get_noa - Get current Notice of Absence attribute payload
2643 * @priv: Private driver interface data
2644 * @buf: Buffer for returning NoA
2645 * @buf_len: Buffer length in octets
2646 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2647 * advertized, or -1 on failure
2649 * This function is used to fetch the current Notice of Absence
2650 * attribute value from GO.
2652 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2655 * set_noa - Set Notice of Absence parameters for GO (testing)
2656 * @priv: Private driver interface data
2658 * @start: Start time in ms from next TBTT
2659 * @duration: Duration in ms
2660 * Returns: 0 on success or -1 on failure
2662 * This function is used to set Notice of Absence parameters for GO. It
2663 * is used only for testing. To disable NoA, all parameters are set to
2666 int (*set_noa)(void *priv, u8 count, int start, int duration);
2669 * set_p2p_powersave - Set P2P power save options
2670 * @priv: Private driver interface data
2671 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2672 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2673 * @ctwindow: 0.. = change (msec), -1 = no change
2674 * Returns: 0 on success or -1 on failure
2676 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2680 * ampdu - Enable/disable aggregation
2681 * @priv: Private driver interface data
2682 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2683 * Returns: 0 on success or -1 on failure
2685 int (*ampdu)(void *priv, int ampdu);
2688 * get_radio_name - Get physical radio name for the device
2689 * @priv: Private driver interface data
2690 * Returns: Radio name or %NULL if not known
2692 * The returned data must not be modified by the caller. It is assumed
2693 * that any interface that has the same radio name as another is
2694 * sharing the same physical radio. This information can be used to
2695 * share scan results etc. information between the virtual interfaces
2696 * to speed up various operations.
2698 const char * (*get_radio_name)(void *priv);
2701 * send_tdls_mgmt - for sending TDLS management packets
2702 * @priv: private driver interface data
2703 * @dst: Destination (peer) MAC address
2704 * @action_code: TDLS action code for the mssage
2705 * @dialog_token: Dialog Token to use in the message (if needed)
2706 * @status_code: Status Code or Reason Code to use (if needed)
2707 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2708 * @initiator: Is the current end the TDLS link initiator
2709 * @buf: TDLS IEs to add to the message
2710 * @len: Length of buf in octets
2711 * Returns: 0 on success, negative (<0) on failure
2713 * This optional function can be used to send packet to driver which is
2714 * responsible for receiving and sending all TDLS packets.
2716 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2717 u8 dialog_token, u16 status_code, u32 peer_capab,
2718 int initiator, const u8 *buf, size_t len);
2721 * tdls_oper - Ask the driver to perform high-level TDLS operations
2722 * @priv: Private driver interface data
2723 * @oper: TDLS high-level operation. See %enum tdls_oper
2724 * @peer: Destination (peer) MAC address
2725 * Returns: 0 on success, negative (<0) on failure
2727 * This optional function can be used to send high-level TDLS commands
2730 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2733 * wnm_oper - Notify driver of the WNM frame reception
2734 * @priv: Private driver interface data
2735 * @oper: WNM operation. See %enum wnm_oper
2736 * @peer: Destination (peer) MAC address
2737 * @buf: Buffer for the driver to fill in (for getting IE)
2738 * @buf_len: Return the len of buf
2739 * Returns: 0 on success, negative (<0) on failure
2741 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2742 u8 *buf, u16 *buf_len);
2745 * set_qos_map - Set QoS Map
2746 * @priv: Private driver interface data
2747 * @qos_map_set: QoS Map
2748 * @qos_map_set_len: Length of QoS Map
2750 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2751 u8 qos_map_set_len);
2754 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2755 * @priv: Private driver interface data
2756 * @version: IP version of the IP address, 4 or 6
2757 * @ipaddr: IP address for the neigh entry
2758 * @prefixlen: IP address prefix length
2759 * @addr: Corresponding MAC address
2760 * Returns: 0 on success, negative (<0) on failure
2762 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2763 int prefixlen, const u8 *addr);
2766 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2767 * @priv: Private driver interface data
2768 * @version: IP version of the IP address, 4 or 6
2769 * @ipaddr: IP address for the neigh entry
2770 * Returns: 0 on success, negative (<0) on failure
2772 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2775 * br_port_set_attr - Set a bridge port attribute
2776 * @attr: Bridge port attribute to set
2777 * @val: Value to be set
2778 * Returns: 0 on success, negative (<0) on failure
2780 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2784 * br_port_set_attr - Set a bridge network parameter
2785 * @param: Bridge parameter to set
2786 * @val: Value to be set
2787 * Returns: 0 on success, negative (<0) on failure
2789 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2793 * set_wowlan - Set wake-on-wireless triggers
2794 * @priv: Private driver interface data
2795 * @triggers: wowlan triggers
2797 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2800 * signal_poll - Get current connection information
2801 * @priv: Private driver interface data
2802 * @signal_info: Connection info structure
2804 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2807 * set_authmode - Set authentication algorithm(s) for static WEP
2808 * @priv: Private driver interface data
2809 * @authmode: 1=Open System, 2=Shared Key, 3=both
2810 * Returns: 0 on success, -1 on failure
2812 * This function can be used to set authentication algorithms for AP
2813 * mode when static WEP is used. If the driver uses user space MLME/SME
2814 * implementation, there is no need to implement this function.
2816 * DEPRECATED - use set_ap() instead
2818 int (*set_authmode)(void *priv, int authmode);
2822 * driver_cmd - Execute driver-specific command
2823 * @priv: Private driver interface data
2824 * @cmd: Command to execute
2825 * @buf: Return buffer
2826 * @buf_len: Buffer length
2827 * Returns: 0 on success, -1 on failure
2829 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2830 #endif /* ANDROID */
2833 * vendor_cmd - Execute vendor specific command
2834 * @priv: Private driver interface data
2835 * @vendor_id: Vendor id
2836 * @subcmd: Vendor command id
2837 * @data: Vendor command parameters (%NULL if no parameters)
2838 * @data_len: Data length
2839 * @buf: Return buffer (%NULL to ignore reply)
2840 * Returns: 0 on success, negative (<0) on failure
2842 * This function handles vendor specific commands that are passed to
2843 * the driver/device. The command is identified by vendor id and
2844 * command id. Parameters can be passed as argument to the command
2845 * in the data buffer. Reply (if any) will be filled in the supplied
2848 * The exact driver behavior is driver interface and vendor specific. As
2849 * an example, this will be converted to a vendor specific cfg80211
2850 * command in case of the nl80211 driver interface.
2852 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2853 unsigned int subcmd, const u8 *data, size_t data_len,
2854 struct wpabuf *buf);
2857 * set_rekey_info - Set rekey information
2858 * @priv: Private driver interface data
2861 * @replay_ctr: Current EAPOL-Key Replay Counter
2863 * This optional function can be used to provide information for the
2864 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2865 * while the host (including wpa_supplicant) is sleeping.
2867 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2868 const u8 *replay_ctr);
2871 * sta_assoc - Station association indication
2872 * @priv: Private driver interface data
2873 * @own_addr: Source address and BSSID for association frame
2874 * @addr: MAC address of the station to associate
2875 * @reassoc: flag to indicate re-association
2876 * @status: association response status code
2877 * @ie: assoc response ie buffer
2878 * @len: ie buffer length
2879 * Returns: 0 on success, -1 on failure
2881 * This function indicates the driver to send (Re)Association
2882 * Response frame to the station.
2884 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2885 int reassoc, u16 status, const u8 *ie, size_t len);
2888 * sta_auth - Station authentication indication
2889 * @priv: Private driver interface data
2890 * @own_addr: Source address and BSSID for authentication frame
2891 * @addr: MAC address of the station to associate
2892 * @seq: authentication sequence number
2893 * @status: authentication response status code
2894 * @ie: authentication frame ie buffer
2895 * @len: ie buffer length
2897 * This function indicates the driver to send Authentication frame
2900 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2901 u16 seq, u16 status, const u8 *ie, size_t len);
2904 * add_tspec - Add traffic stream
2905 * @priv: Private driver interface data
2906 * @addr: MAC address of the station to associate
2907 * @tspec_ie: tspec ie buffer
2908 * @tspec_ielen: tspec ie length
2909 * Returns: 0 on success, -1 on failure
2911 * This function adds the traffic steam for the station
2912 * and fills the medium_time in tspec_ie.
2914 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2915 size_t tspec_ielen);
2918 * add_sta_node - Add a station node in the driver
2919 * @priv: Private driver interface data
2920 * @addr: MAC address of the station to add
2921 * @auth_alg: authentication algorithm used by the station
2922 * Returns: 0 on success, -1 on failure
2924 * This function adds the station node in the driver, when
2925 * the station gets added by FT-over-DS.
2927 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2930 * sched_scan - Request the driver to initiate scheduled scan
2931 * @priv: Private driver interface data
2932 * @params: Scan parameters
2933 * @interval: Interval between scan cycles in milliseconds
2934 * Returns: 0 on success, -1 on failure
2936 * This operation should be used for scheduled scan offload to
2937 * the hardware. Every time scan results are available, the
2938 * driver should report scan results event for wpa_supplicant
2939 * which will eventually request the results with
2940 * wpa_driver_get_scan_results2(). This operation is optional
2941 * and if not provided or if it returns -1, we fall back to
2942 * normal host-scheduled scans.
2944 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2948 * stop_sched_scan - Request the driver to stop a scheduled scan
2949 * @priv: Private driver interface data
2950 * Returns: 0 on success, -1 on failure
2952 * This should cause the scheduled scan to be stopped and
2953 * results should stop being sent. Must be supported if
2954 * sched_scan is supported.
2956 int (*stop_sched_scan)(void *priv);
2959 * poll_client - Probe (null data or such) the given station
2960 * @priv: Private driver interface data
2961 * @own_addr: MAC address of sending interface
2962 * @addr: MAC address of the station to probe
2963 * @qos: Indicates whether station is QoS station
2965 * This function is used to verify whether an associated station is
2966 * still present. This function does not need to be implemented if the
2967 * driver provides such inactivity polling mechanism.
2969 void (*poll_client)(void *priv, const u8 *own_addr,
2970 const u8 *addr, int qos);
2973 * radio_disable - Disable/enable radio
2974 * @priv: Private driver interface data
2975 * @disabled: 1=disable 0=enable radio
2976 * Returns: 0 on success, -1 on failure
2978 * This optional command is for testing purposes. It can be used to
2979 * disable the radio on a testbed device to simulate out-of-radio-range
2982 int (*radio_disable)(void *priv, int disabled);
2985 * switch_channel - Announce channel switch and migrate the GO to the
2987 * @priv: Private driver interface data
2988 * @settings: Settings for CSA period and new channel
2989 * Returns: 0 on success, -1 on failure
2991 * This function is used to move the GO to the legacy STA channel to
2992 * avoid frequency conflict in single channel concurrency.
2994 int (*switch_channel)(void *priv, struct csa_settings *settings);
2997 * add_tx_ts - Add traffic stream
2998 * @priv: Private driver interface data
2999 * @tsid: Traffic stream ID
3000 * @addr: Receiver address
3001 * @user_prio: User priority of the traffic stream
3002 * @admitted_time: Admitted time for this TS in units of
3003 * 32 microsecond periods (per second).
3004 * Returns: 0 on success, -1 on failure
3006 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3010 * del_tx_ts - Delete traffic stream
3011 * @priv: Private driver interface data
3012 * @tsid: Traffic stream ID
3013 * @addr: Receiver address
3014 * Returns: 0 on success, -1 on failure
3016 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3019 * Enable channel-switching with TDLS peer
3020 * @priv: Private driver interface data
3021 * @addr: MAC address of the TDLS peer
3022 * @oper_class: Operating class of the switch channel
3023 * @params: Channel specification
3024 * Returns: 0 on success, -1 on failure
3026 * The function indicates to driver that it can start switching to a
3027 * different channel with a specified TDLS peer. The switching is
3028 * assumed on until canceled with tdls_disable_channel_switch().
3030 int (*tdls_enable_channel_switch)(
3031 void *priv, const u8 *addr, u8 oper_class,
3032 const struct hostapd_freq_params *params);
3035 * Disable channel switching with TDLS peer
3036 * @priv: Private driver interface data
3037 * @addr: MAC address of the TDLS peer
3038 * Returns: 0 on success, -1 on failure
3040 * This function indicates to the driver that it should stop switching
3041 * with a given TDLS peer.
3043 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3046 * start_dfs_cac - Listen for radar interference on the channel
3047 * @priv: Private driver interface data
3048 * @freq: Channel parameters
3049 * Returns: 0 on success, -1 on failure
3051 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
3054 * stop_ap - Removes beacon from AP
3055 * @priv: Private driver interface data
3056 * Returns: 0 on success, -1 on failure (or if not supported)
3058 * This optional function can be used to disable AP mode related
3059 * configuration. Unlike deinit_ap, it does not change to station
3062 int (*stop_ap)(void *priv);
3065 * get_survey - Retrieve survey data
3066 * @priv: Private driver interface data
3067 * @freq: If set, survey data for the specified frequency is only
3068 * being requested. If not set, all survey data is requested.
3069 * Returns: 0 on success, -1 on failure
3071 * Use this to retrieve:
3073 * - the observed channel noise floor
3074 * - the amount of time we have spent on the channel
3075 * - the amount of time during which we have spent on the channel that
3076 * the radio has determined the medium is busy and we cannot
3078 * - the amount of time we have spent receiving data
3079 * - the amount of time we have spent transmitting data
3081 * This data can be used for spectrum heuristics. One example is
3082 * Automatic Channel Selection (ACS). The channel survey data is
3083 * kept on a linked list on the channel data, one entry is added
3084 * for each survey. The min_nf of the channel is updated for each
3087 int (*get_survey)(void *priv, unsigned int freq);
3090 * status - Get driver interface status information
3091 * @priv: Private driver interface data
3092 * @buf: Buffer for printing tou the status information
3093 * @buflen: Maximum length of the buffer
3094 * Returns: Length of written status information or -1 on failure
3096 int (*status)(void *priv, char *buf, size_t buflen);
3099 * roaming - Set roaming policy for driver-based BSS selection
3100 * @priv: Private driver interface data
3101 * @allowed: Whether roaming within ESS is allowed
3102 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3103 * Returns: Length of written status information or -1 on failure
3105 * This optional callback can be used to update roaming policy from the
3106 * associate() command (bssid being set there indicates that the driver
3107 * should not roam before getting this roaming() call to allow roaming.
3108 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3109 * capability, roaming policy is handled within wpa_supplicant and there
3110 * is no need to implement or react to this callback.
3112 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3115 * set_mac_addr - Set MAC address
3116 * @priv: Private driver interface data
3117 * @addr: MAC address to use or %NULL for setting back to permanent
3118 * Returns: 0 on success, -1 on failure
3120 int (*set_mac_addr)(void *priv, const u8 *addr);
3122 #ifdef CONFIG_MACSEC
3123 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3125 int (*macsec_deinit)(void *priv);
3128 * enable_protect_frames - Set protect frames status
3129 * @priv: Private driver interface data
3130 * @enabled: TRUE = protect frames enabled
3131 * FALSE = protect frames disabled
3132 * Returns: 0 on success, -1 on failure (or if not supported)
3134 int (*enable_protect_frames)(void *priv, Boolean enabled);
3137 * set_replay_protect - Set replay protect status and window size
3138 * @priv: Private driver interface data
3139 * @enabled: TRUE = replay protect enabled
3140 * FALSE = replay protect disabled
3141 * @window: replay window size, valid only when replay protect enabled
3142 * Returns: 0 on success, -1 on failure (or if not supported)
3144 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3147 * set_current_cipher_suite - Set current cipher suite
3148 * @priv: Private driver interface data
3149 * @cs: EUI64 identifier
3150 * @cs_len: Length of the cs buffer in octets
3151 * Returns: 0 on success, -1 on failure (or if not supported)
3153 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3157 * enable_controlled_port - Set controlled port status
3158 * @priv: Private driver interface data
3159 * @enabled: TRUE = controlled port enabled
3160 * FALSE = controlled port disabled
3161 * Returns: 0 on success, -1 on failure (or if not supported)
3163 int (*enable_controlled_port)(void *priv, Boolean enabled);
3166 * get_receive_lowest_pn - Get receive lowest pn
3167 * @priv: Private driver interface data
3168 * @channel: secure channel
3169 * @an: association number
3170 * @lowest_pn: lowest accept pn
3171 * Returns: 0 on success, -1 on failure (or if not supported)
3173 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3177 * get_transmit_next_pn - Get transmit next pn
3178 * @priv: Private driver interface data
3179 * @channel: secure channel
3180 * @an: association number
3182 * Returns: 0 on success, -1 on failure (or if not supported)
3184 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3188 * set_transmit_next_pn - Set transmit next pn
3189 * @priv: Private driver interface data
3190 * @channel: secure channel
3191 * @an: association number
3193 * Returns: 0 on success, -1 on failure (or if not supported)
3195 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3199 * get_available_receive_sc - get available receive channel
3200 * @priv: Private driver interface data
3201 * @channel: secure channel
3202 * Returns: 0 on success, -1 on failure (or if not supported)
3204 int (*get_available_receive_sc)(void *priv, u32 *channel);
3207 * create_receive_sc - create secure channel for receiving
3208 * @priv: Private driver interface data
3209 * @channel: secure channel
3210 * @sci_addr: secure channel identifier - address
3211 * @sci_port: secure channel identifier - port
3212 * @conf_offset: confidentiality offset (0, 30, or 50)
3213 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3215 * Returns: 0 on success, -1 on failure (or if not supported)
3217 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3218 u16 sci_port, unsigned int conf_offset,
3222 * delete_receive_sc - delete secure connection for receiving
3223 * @priv: private driver interface data from init()
3224 * @channel: secure channel
3225 * Returns: 0 on success, -1 on failure
3227 int (*delete_receive_sc)(void *priv, u32 channel);
3230 * create_receive_sa - create secure association for receive
3231 * @priv: private driver interface data from init()
3232 * @channel: secure channel
3233 * @an: association number
3234 * @lowest_pn: the lowest packet number can be received
3235 * @sak: the secure association key
3236 * Returns: 0 on success, -1 on failure
3238 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3239 u32 lowest_pn, const u8 *sak);
3242 * enable_receive_sa - enable the SA for receive
3243 * @priv: private driver interface data from init()
3244 * @channel: secure channel
3245 * @an: association number
3246 * Returns: 0 on success, -1 on failure
3248 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3251 * disable_receive_sa - disable SA for receive
3252 * @priv: private driver interface data from init()
3253 * @channel: secure channel index
3254 * @an: association number
3255 * Returns: 0 on success, -1 on failure
3257 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3260 * get_available_transmit_sc - get available transmit channel
3261 * @priv: Private driver interface data
3262 * @channel: secure channel
3263 * Returns: 0 on success, -1 on failure (or if not supported)
3265 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3268 * create_transmit_sc - create secure connection for transmit
3269 * @priv: private driver interface data from init()
3270 * @channel: secure channel
3271 * @sci_addr: secure channel identifier - address
3272 * @sci_port: secure channel identifier - port
3273 * Returns: 0 on success, -1 on failure
3275 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3276 u16 sci_port, unsigned int conf_offset);
3279 * delete_transmit_sc - delete secure connection for transmit
3280 * @priv: private driver interface data from init()
3281 * @channel: secure channel
3282 * Returns: 0 on success, -1 on failure
3284 int (*delete_transmit_sc)(void *priv, u32 channel);
3287 * create_transmit_sa - create secure association for transmit
3288 * @priv: private driver interface data from init()
3289 * @channel: secure channel index
3290 * @an: association number
3291 * @next_pn: the packet number used as next transmit packet
3292 * @confidentiality: True if the SA is to provide confidentiality
3293 * as well as integrity
3294 * @sak: the secure association key
3295 * Returns: 0 on success, -1 on failure
3297 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3298 Boolean confidentiality, const u8 *sak);
3301 * enable_transmit_sa - enable SA for transmit
3302 * @priv: private driver interface data from init()
3303 * @channel: secure channel
3304 * @an: association number
3305 * Returns: 0 on success, -1 on failure
3307 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3310 * disable_transmit_sa - disable SA for transmit
3311 * @priv: private driver interface data from init()
3312 * @channel: secure channel
3313 * @an: association number
3314 * Returns: 0 on success, -1 on failure
3316 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3317 #endif /* CONFIG_MACSEC */
3320 * init_mesh - Driver specific initialization for mesh
3321 * @priv: Private driver interface data
3322 * Returns: 0 on success, -1 on failure
3324 int (*init_mesh)(void *priv);
3327 * join_mesh - Join a mesh network
3328 * @priv: Private driver interface data
3329 * @params: Mesh configuration parameters
3330 * Returns: 0 on success, -1 on failure
3332 int (*join_mesh)(void *priv,
3333 struct wpa_driver_mesh_join_params *params);
3336 * leave_mesh - Leave a mesh network
3337 * @priv: Private driver interface data
3338 * Returns 0 on success, -1 on failure
3340 int (*leave_mesh)(void *priv);
3343 * do_acs - Automatically select channel
3344 * @priv: Private driver interface data
3345 * @params: Parameters for ACS
3346 * Returns 0 on success, -1 on failure
3348 * This command can be used to offload ACS to the driver if the driver
3349 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3351 int (*do_acs)(void *priv, struct drv_acs_params *params);
3356 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3358 enum wpa_event_type {
3360 * EVENT_ASSOC - Association completed
3362 * This event needs to be delivered when the driver completes IEEE
3363 * 802.11 association or reassociation successfully.
3364 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3365 * after this event has been generated. In addition, optional
3366 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3367 * more information about the association. If the driver interface gets
3368 * both of these events at the same time, it can also include the
3369 * assoc_info data in EVENT_ASSOC call.
3374 * EVENT_DISASSOC - Association lost
3376 * This event should be called when association is lost either due to
3377 * receiving deauthenticate or disassociate frame from the AP or when
3378 * sending either of these frames to the current AP. If the driver
3379 * supports separate deauthentication event, EVENT_DISASSOC should only
3380 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3381 * In AP mode, union wpa_event_data::disassoc_info is required.
3386 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3388 * This event must be delivered when a Michael MIC error is detected by
3389 * the local driver. Additional data for event processing is
3390 * provided with union wpa_event_data::michael_mic_failure. This
3391 * information is used to request new encyption key and to initiate
3392 * TKIP countermeasures if needed.
3394 EVENT_MICHAEL_MIC_FAILURE,
3397 * EVENT_SCAN_RESULTS - Scan results available
3399 * This event must be called whenever scan results are available to be
3400 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3401 * is expected to be used some time after struct wpa_driver_ops::scan()
3402 * is called. If the driver provides an unsolicited event when the scan
3403 * has been completed, this event can be used to trigger
3404 * EVENT_SCAN_RESULTS call. If such event is not available from the
3405 * driver, the driver wrapper code is expected to use a registered
3406 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3407 * scan is expected to be completed. Optional information about
3408 * completed scan can be provided with union wpa_event_data::scan_info.
3413 * EVENT_ASSOCINFO - Report optional extra information for association
3415 * This event can be used to report extra association information for
3416 * EVENT_ASSOC processing. This extra information includes IEs from
3417 * association frames and Beacon/Probe Response frames in union
3418 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3419 * EVENT_ASSOC. Alternatively, the driver interface can include
3420 * assoc_info data in the EVENT_ASSOC call if it has all the
3421 * information available at the same point.
3426 * EVENT_INTERFACE_STATUS - Report interface status changes
3428 * This optional event can be used to report changes in interface
3429 * status (interface added/removed) using union
3430 * wpa_event_data::interface_status. This can be used to trigger
3431 * wpa_supplicant to stop and re-start processing for the interface,
3432 * e.g., when a cardbus card is ejected/inserted.
3434 EVENT_INTERFACE_STATUS,
3437 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3439 * This event can be used to inform wpa_supplicant about candidates for
3440 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3441 * for scan request (ap_scan=2 mode), this event is required for
3442 * pre-authentication. If wpa_supplicant is performing scan request
3443 * (ap_scan=1), this event is optional since scan results can be used
3444 * to add pre-authentication candidates. union
3445 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3446 * candidate and priority of the candidate, e.g., based on the signal
3447 * strength, in order to try to pre-authenticate first with candidates
3448 * that are most likely targets for re-association.
3450 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3451 * on the candidate list. In addition, it can be called for the current
3452 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3453 * will automatically skip pre-authentication in cases where a valid
3454 * PMKSA exists. When more than one candidate exists, this event should
3455 * be generated once for each candidate.
3457 * Driver will be notified about successful pre-authentication with
3458 * struct wpa_driver_ops::add_pmkid() calls.
3460 EVENT_PMKID_CANDIDATE,
3463 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3465 * This event can be used to inform wpa_supplicant about desire to set
3466 * up secure direct link connection between two stations as defined in
3467 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3468 * STAKey negotiation. The caller will need to set peer address for the
3474 * EVENT_TDLS - Request TDLS operation
3476 * This event can be used to request a TDLS operation to be performed.
3481 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3483 * The driver is expected to report the received FT IEs from
3484 * FT authentication sequence from the AP. The FT IEs are included in
3485 * the extra information in union wpa_event_data::ft_ies.
3490 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3492 * The driver can use this event to inform wpa_supplicant about a STA
3493 * in an IBSS with which protected frames could be exchanged. This
3494 * event starts RSN authentication with the other STA to authenticate
3495 * the STA and set up encryption keys with it.
3497 EVENT_IBSS_RSN_START,
3500 * EVENT_AUTH - Authentication result
3502 * This event should be called when authentication attempt has been
3503 * completed. This is only used if the driver supports separate
3504 * authentication step (struct wpa_driver_ops::authenticate).
3505 * Information about authentication result is included in
3506 * union wpa_event_data::auth.
3511 * EVENT_DEAUTH - Authentication lost
3513 * This event should be called when authentication is lost either due
3514 * to receiving deauthenticate frame from the AP or when sending that
3515 * frame to the current AP.
3516 * In AP mode, union wpa_event_data::deauth_info is required.
3521 * EVENT_ASSOC_REJECT - Association rejected
3523 * This event should be called when (re)association attempt has been
3524 * rejected by the AP. Information about the association response is
3525 * included in union wpa_event_data::assoc_reject.
3530 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3532 EVENT_AUTH_TIMED_OUT,
3535 * EVENT_ASSOC_TIMED_OUT - Association timed out
3537 EVENT_ASSOC_TIMED_OUT,
3540 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3542 EVENT_WPS_BUTTON_PUSHED,
3545 * EVENT_TX_STATUS - Report TX status
3550 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3552 EVENT_RX_FROM_UNKNOWN,
3555 * EVENT_RX_MGMT - Report RX of a management frame
3560 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3562 * This event is used to indicate when the driver has started the
3563 * requested remain-on-channel duration. Information about the
3564 * operation is included in union wpa_event_data::remain_on_channel.
3566 EVENT_REMAIN_ON_CHANNEL,
3569 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3571 * This event is used to indicate when the driver has completed
3572 * remain-on-channel duration, i.e., may noot be available on the
3573 * requested channel anymore. Information about the
3574 * operation is included in union wpa_event_data::remain_on_channel.
3576 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3579 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3581 * This event is used to indicate when a Probe Request frame has been
3582 * received. Information about the received frame is included in
3583 * union wpa_event_data::rx_probe_req. The driver is required to report
3584 * these events only after successfully completed probe_req_report()
3585 * commands to request the events (i.e., report parameter is non-zero)
3586 * in station mode. In AP mode, Probe Request frames should always be
3592 * EVENT_NEW_STA - New wired device noticed
3594 * This event is used to indicate that a new device has been detected
3595 * in a network that does not use association-like functionality (i.e.,
3596 * mainly wired Ethernet). This can be used to start EAPOL
3597 * authenticator when receiving a frame from a device. The address of
3598 * the device is included in union wpa_event_data::new_sta.
3603 * EVENT_EAPOL_RX - Report received EAPOL frame
3605 * When in AP mode with hostapd, this event is required to be used to
3606 * deliver the receive EAPOL frames from the driver.
3611 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3613 * This event is used to indicate changes in the signal strength
3614 * observed in frames received from the current AP if signal strength
3615 * monitoring has been enabled with signal_monitor().
3617 EVENT_SIGNAL_CHANGE,
3620 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3622 * This event is used to indicate that the interface was enabled after
3623 * having been previously disabled, e.g., due to rfkill.
3625 EVENT_INTERFACE_ENABLED,
3628 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3630 * This event is used to indicate that the interface was disabled,
3631 * e.g., due to rfkill.
3633 EVENT_INTERFACE_DISABLED,
3636 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3638 * This event is used to indicate that the channel list has changed,
3639 * e.g., because of a regulatory domain change triggered by scan
3640 * results including an AP advertising a country code.
3642 EVENT_CHANNEL_LIST_CHANGED,
3645 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3647 * This event is used to indicate that the driver cannot maintain this
3648 * interface in its operation mode anymore. The most likely use for
3649 * this is to indicate that AP mode operation is not available due to
3650 * operating channel would need to be changed to a DFS channel when
3651 * the driver does not support radar detection and another virtual
3652 * interfaces caused the operating channel to change. Other similar
3653 * resource conflicts could also trigger this for station mode
3654 * interfaces. This event can be propagated when channel switching
3657 EVENT_INTERFACE_UNAVAILABLE,
3660 * EVENT_BEST_CHANNEL
3662 * Driver generates this event whenever it detects a better channel
3663 * (e.g., based on RSSI or channel use). This information can be used
3664 * to improve channel selection for a new AP/P2P group.
3669 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3671 * This event should be called when a Deauthentication frame is dropped
3672 * due to it not being protected (MFP/IEEE 802.11w).
3673 * union wpa_event_data::unprot_deauth is required to provide more
3674 * details of the frame.
3676 EVENT_UNPROT_DEAUTH,
3679 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3681 * This event should be called when a Disassociation frame is dropped
3682 * due to it not being protected (MFP/IEEE 802.11w).
3683 * union wpa_event_data::unprot_disassoc is required to provide more
3684 * details of the frame.
3686 EVENT_UNPROT_DISASSOC,
3689 * EVENT_STATION_LOW_ACK
3691 * Driver generates this event whenever it detected that a particular
3692 * station was lost. Detection can be through massive transmission
3693 * failures for example.
3695 EVENT_STATION_LOW_ACK,
3698 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3700 EVENT_IBSS_PEER_LOST,
3703 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3705 * This event carries the new replay counter to notify wpa_supplicant
3706 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3707 * completed Group Key Handshake while the host (including
3708 * wpa_supplicant was sleeping).
3710 EVENT_DRIVER_GTK_REKEY,
3713 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3715 EVENT_SCHED_SCAN_STOPPED,
3718 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3720 * This event indicates that the station responded to the poll
3721 * initiated with @poll_client.
3723 EVENT_DRIVER_CLIENT_POLL_OK,
3726 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3728 EVENT_EAPOL_TX_STATUS,
3731 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3733 * Described in wpa_event_data.ch_switch
3738 * EVENT_WNM - Request WNM operation
3740 * This event can be used to request a WNM operation to be performed.
3745 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3747 * This event indicates that the driver reported a connection failure
3748 * with the specified client (for example, max client reached, etc.) in
3751 EVENT_CONNECT_FAILED_REASON,
3754 * EVENT_RADAR_DETECTED - Notify of radar detection
3756 * A radar has been detected on the supplied frequency, hostapd should
3757 * react accordingly (e.g., change channel).
3759 EVENT_DFS_RADAR_DETECTED,
3762 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3764 * After a successful CAC, the channel can be marked clear and used.
3766 EVENT_DFS_CAC_FINISHED,
3769 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3771 * The CAC was not successful, and the channel remains in the previous
3772 * state. This may happen due to a radar beeing detected or other
3773 * external influences.
3775 EVENT_DFS_CAC_ABORTED,
3778 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3780 * The channel which was previously unavailable is now available again.
3782 EVENT_DFS_NOP_FINISHED,
3785 * EVENT_SURVEY - Received survey data
3787 * This event gets triggered when a driver query is issued for survey
3788 * data and the requested data becomes available. The returned data is
3789 * stored in struct survey_results. The results provide at most one
3790 * survey entry for each frequency and at minimum will provide one
3791 * survey entry for one frequency. The survey data can be os_malloc()'d
3792 * and then os_free()'d, so the event callback must only copy data.
3797 * EVENT_SCAN_STARTED - Scan started
3799 * This indicates that driver has started a scan operation either based
3800 * on a request from wpa_supplicant/hostapd or from another application.
3801 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3802 * completed (either successfully or by getting cancelled).
3807 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3809 * This event indicates a set of frequency ranges that should be avoided
3810 * to reduce issues due to interference or internal co-existence
3811 * information in the driver.
3813 EVENT_AVOID_FREQUENCIES,
3816 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3818 EVENT_NEW_PEER_CANDIDATE,
3821 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
3823 * Indicates a pair of primary and secondary channels chosen by ACS
3826 EVENT_ACS_CHANNEL_SELECTED,
3831 * struct freq_survey - Channel survey info
3833 * @ifidx: Interface index in which this survey was observed
3834 * @freq: Center of frequency of the surveyed channel
3835 * @nf: Channel noise floor in dBm
3836 * @channel_time: Amount of time in ms the radio spent on the channel
3837 * @channel_time_busy: Amount of time in ms the radio detected some signal
3838 * that indicated to the radio the channel was not clear
3839 * @channel_time_rx: Amount of time the radio spent receiving data
3840 * @channel_time_tx: Amount of time the radio spent transmitting data
3841 * @filled: bitmask indicating which fields have been reported, see
3842 * SURVEY_HAS_* defines.
3843 * @list: Internal list pointers
3845 struct freq_survey {
3850 u64 channel_time_busy;
3851 u64 channel_time_rx;
3852 u64 channel_time_tx;
3853 unsigned int filled;
3854 struct dl_list list;
3857 #define SURVEY_HAS_NF BIT(0)
3858 #define SURVEY_HAS_CHAN_TIME BIT(1)
3859 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3860 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3861 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3865 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3867 union wpa_event_data {
3869 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3871 * This structure is optional for EVENT_ASSOC calls and required for
3872 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3873 * driver interface does not need to generate separate EVENT_ASSOCINFO
3878 * reassoc - Flag to indicate association or reassociation
3883 * req_ies - (Re)Association Request IEs
3885 * If the driver generates WPA/RSN IE, this event data must be
3886 * returned for WPA handshake to have needed information. If
3887 * wpa_supplicant-generated WPA/RSN IE is used, this
3888 * information event is optional.
3890 * This should start with the first IE (fixed fields before IEs
3891 * are not included).
3896 * req_ies_len - Length of req_ies in bytes
3901 * resp_ies - (Re)Association Response IEs
3903 * Optional association data from the driver. This data is not
3904 * required WPA, but may be useful for some protocols and as
3905 * such, should be reported if this is available to the driver
3908 * This should start with the first IE (fixed fields before IEs
3909 * are not included).
3914 * resp_ies_len - Length of resp_ies in bytes
3916 size_t resp_ies_len;
3919 * beacon_ies - Beacon or Probe Response IEs
3921 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3922 * Probe Response frames from the current AP (i.e., the one
3923 * that the client just associated with). This information is
3924 * used to update WPA/RSN IE for the AP. If this field is not
3925 * set, the results from previous scan will be used. If no
3926 * data for the new AP is found, scan results will be requested
3927 * again (without scan request). At this point, the driver is
3928 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3931 * This should start with the first IE (fixed fields before IEs
3932 * are not included).
3934 const u8 *beacon_ies;
3937 * beacon_ies_len - Length of beacon_ies */
3938 size_t beacon_ies_len;
3941 * freq - Frequency of the operational channel in MHz
3946 * wmm_params - WMM parameters used in this association.
3948 struct wmm_params wmm_params;
3951 * addr - Station address (for AP mode)
3956 * The following is the key management offload information
3959 * @key_replay_ctr_len
3967 * authorized - Status of key management offload,
3973 * key_replay_ctr - Key replay counter value last used
3974 * in a valid EAPOL-Key frame
3976 const u8 *key_replay_ctr;
3979 * key_replay_ctr_len - The length of key_replay_ctr
3981 size_t key_replay_ctr_len;
3984 * ptk_kck - The derived PTK KCK
3989 * ptk_kek_len - The length of ptk_kck
3994 * ptk_kek - The derived PTK KEK
3999 * ptk_kek_len - The length of ptk_kek
4005 * struct disassoc_info - Data for EVENT_DISASSOC events
4007 struct disassoc_info {
4009 * addr - Station address (for AP mode)
4014 * reason_code - Reason Code (host byte order) used in
4015 * Deauthentication frame
4020 * ie - Optional IE(s) in Disassociation frame
4025 * ie_len - Length of ie buffer in octets
4030 * locally_generated - Whether the frame was locally generated
4032 int locally_generated;
4036 * struct deauth_info - Data for EVENT_DEAUTH events
4038 struct deauth_info {
4040 * addr - Station address (for AP mode)
4045 * reason_code - Reason Code (host byte order) used in
4046 * Deauthentication frame
4051 * ie - Optional IE(s) in Deauthentication frame
4056 * ie_len - Length of ie buffer in octets
4061 * locally_generated - Whether the frame was locally generated
4063 int locally_generated;
4067 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4069 struct michael_mic_failure {
4072 } michael_mic_failure;
4075 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4077 struct interface_status {
4080 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4085 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4087 struct pmkid_candidate {
4088 /** BSSID of the PMKID candidate */
4090 /** Smaller the index, higher the priority */
4092 /** Whether RSN IE includes pre-authenticate flag */
4097 * struct stkstart - Data for EVENT_STKSTART
4104 * struct tdls - Data for EVENT_TDLS
4110 TDLS_REQUEST_TEARDOWN
4112 u16 reason_code; /* for teardown */
4116 * struct wnm - Data for EVENT_WNM
4134 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4136 * During FT (IEEE 802.11r) authentication sequence, the driver is
4137 * expected to use this event to report received FT IEs (MDIE, FTIE,
4138 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4139 * IEs for the next message will be delivered through the
4140 * struct wpa_driver_ops::update_ft_ies() callback.
4146 u8 target_ap[ETH_ALEN];
4147 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4149 /** Length of ric_ies buffer in octets */
4154 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4156 struct ibss_rsn_start {
4161 * struct auth_info - Data for EVENT_AUTH events
4167 u16 auth_transaction;
4174 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4176 struct assoc_reject {
4178 * bssid - BSSID of the AP that rejected association
4183 * resp_ies - (Re)Association Response IEs
4185 * Optional association data from the driver. This data is not
4186 * required WPA, but may be useful for some protocols and as
4187 * such, should be reported if this is available to the driver
4190 * This should start with the first IE (fixed fields before IEs
4191 * are not included).
4196 * resp_ies_len - Length of resp_ies in bytes
4198 size_t resp_ies_len;
4201 * status_code - Status Code from (Re)association Response
4206 struct timeout_event {
4211 * struct tx_status - Data for EVENT_TX_STATUS events
4223 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4225 struct rx_from_unknown {
4232 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4240 * drv_priv - Pointer to store driver private BSS information
4242 * If not set to NULL, this is used for comparison with
4243 * hostapd_data->drv_priv to determine which BSS should process
4249 * freq - Frequency (in MHz) on which the frame was received
4254 * ssi_signal - Signal strength in dBm (or 0 if not available)
4260 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4262 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4264 struct remain_on_channel {
4266 * freq - Channel frequency in MHz
4271 * duration - Duration to remain on the channel in milliseconds
4273 unsigned int duration;
4274 } remain_on_channel;
4277 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4278 * @aborted: Whether the scan was aborted
4279 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4280 * @num_freqs: Number of entries in freqs array
4281 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4283 * @num_ssids: Number of entries in ssids array
4289 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4294 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4296 struct rx_probe_req {
4298 * sa - Source address of the received Probe Request frame
4303 * da - Destination address of the received Probe Request frame
4304 * or %NULL if not available
4309 * bssid - BSSID of the received Probe Request frame or %NULL
4315 * ie - IEs from the Probe Request body
4320 * ie_len - Length of ie buffer in octets
4325 * signal - signal strength in dBm (or 0 if not available)
4331 * struct new_sta - Data for EVENT_NEW_STA events
4338 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4347 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4349 struct wpa_signal_info signal_change;
4352 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4353 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4354 * @freq_5: Best 5 GHz band channel frequency in MHz
4355 * @freq_overall: Best channel frequency in MHz
4357 * 0 can be used to indicate no preference in either band.
4359 struct best_channel {
4365 struct unprot_deauth {
4371 struct unprot_disassoc {
4378 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4379 * @addr: station address
4386 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4388 struct ibss_peer_lost {
4393 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4395 struct driver_gtk_rekey {
4397 const u8 *replay_ctr;
4401 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4402 * @addr: station address
4404 struct client_poll {
4409 * struct eapol_tx_status
4410 * @dst: Original destination
4411 * @data: Data starting with IEEE 802.1X header (!)
4412 * @data_len: Length of data
4413 * @ack: Indicates ack or lost frame
4415 * This corresponds to hapd_send_eapol if the frame sent
4416 * there isn't just reported as EVENT_TX_STATUS.
4418 struct eapol_tx_status {
4427 * @freq: Frequency of new channel in MHz
4428 * @ht_enabled: Whether this is an HT channel
4429 * @ch_offset: Secondary channel offset
4430 * @ch_width: Channel width
4431 * @cf1: Center frequency 1
4432 * @cf2: Center frequency 2
4438 enum chan_width ch_width;
4444 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4445 * @addr: Remote client address
4446 * @code: Reason code for connection failure
4448 struct connect_failed_reason {
4454 } connect_failed_reason;
4457 * struct dfs_event - Data for radar detected events
4458 * @freq: Frequency of the channel in MHz
4464 enum chan_width chan_width;
4470 * survey_results - Survey result data for EVENT_SURVEY
4471 * @freq_filter: Requested frequency survey filter, 0 if request
4472 * was for all survey data
4473 * @survey_list: Linked list of survey data (struct freq_survey)
4475 struct survey_results {
4476 unsigned int freq_filter;
4477 struct dl_list survey_list; /* struct freq_survey */
4481 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4482 * @initiator: Initiator of the regulatory change
4483 * @type: Regulatory change type
4484 * @alpha2: Country code (or "" if not available)
4486 struct channel_list_changed {
4487 enum reg_change_initiator initiator;
4490 } channel_list_changed;
4493 * freq_range - List of frequency ranges
4495 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4497 struct wpa_freq_range_list freq_range;
4502 * @peer: Peer address
4504 * @ie_len: Length of @ies
4506 * Notification of new candidate mesh peer.
4515 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4516 * @pri_channel: Selected primary channel
4517 * @sec_channel: Selected secondary channel
4519 struct acs_selected_channels {
4522 } acs_selected_channels;
4526 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4527 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4528 * with struct wpa_driver_ops::init()
4529 * @event: event type (defined above)
4530 * @data: possible extra data for the event
4532 * Driver wrapper code should call this function whenever an event is received
4535 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4536 union wpa_event_data *data);
4540 * The following inline functions are provided for convenience to simplify
4541 * event indication for some of the common events.
4544 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4545 size_t ielen, int reassoc)
4547 union wpa_event_data event;
4548 os_memset(&event, 0, sizeof(event));
4549 event.assoc_info.reassoc = reassoc;
4550 event.assoc_info.req_ies = ie;
4551 event.assoc_info.req_ies_len = ielen;
4552 event.assoc_info.addr = addr;
4553 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4556 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4558 union wpa_event_data event;
4559 os_memset(&event, 0, sizeof(event));
4560 event.disassoc_info.addr = addr;
4561 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4564 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4567 union wpa_event_data event;
4568 os_memset(&event, 0, sizeof(event));
4569 event.eapol_rx.src = src;
4570 event.eapol_rx.data = data;
4571 event.eapol_rx.data_len = data_len;
4572 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4575 /* driver_common.c */
4576 void wpa_scan_results_free(struct wpa_scan_results *res);
4578 /* Convert wpa_event_type to a string for logging */
4579 const char * event_to_string(enum wpa_event_type event);
4581 /* Convert chan_width to a string for logging and control interfaces */
4582 const char * channel_width_to_string(enum chan_width width);
4584 int ht_supported(const struct hostapd_hw_modes *mode);
4585 int vht_supported(const struct hostapd_hw_modes *mode);
4587 struct wowlan_triggers *
4588 wpa_get_wowlan_triggers(const char *wowlan_triggers,
4589 const struct wpa_driver_capa *capa);
4591 /* NULL terminated array of linked in driver wrappers */
4592 extern struct wpa_driver_ops *wpa_drivers[];
4594 #endif /* DRIVER_H */