2 * Driver interface definition
3 * Copyright (c) 2003-2015, 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 "common/ieee802_11_defs.h"
25 #include "pae/ieee802_1x_kay.h"
26 #endif /* CONFIG_MACSEC */
27 #include "utils/list.h"
29 #define HOSTAPD_CHAN_DISABLED 0x00000001
30 #define HOSTAPD_CHAN_NO_IR 0x00000002
31 #define HOSTAPD_CHAN_RADAR 0x00000008
32 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
33 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
34 #define HOSTAPD_CHAN_HT40 0x00000040
35 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
37 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
38 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
39 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
40 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
41 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
43 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
44 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
45 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
46 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
48 #define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
49 #define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
51 #define HOSTAPD_CHAN_VHT_10_150 0x00100000
52 #define HOSTAPD_CHAN_VHT_30_130 0x00200000
53 #define HOSTAPD_CHAN_VHT_50_110 0x00400000
54 #define HOSTAPD_CHAN_VHT_70_90 0x00800000
55 #define HOSTAPD_CHAN_VHT_90_70 0x01000000
56 #define HOSTAPD_CHAN_VHT_110_50 0x02000000
57 #define HOSTAPD_CHAN_VHT_130_30 0x04000000
58 #define HOSTAPD_CHAN_VHT_150_10 0x08000000
60 /* Filter gratuitous ARP */
61 #define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
62 /* Filter unsolicited Neighbor Advertisement */
63 #define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
64 /* Filter unicast IP packets encrypted using the GTK */
65 #define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)
68 * enum reg_change_initiator - Regulatory change initiator
70 enum reg_change_initiator
{
74 REGDOM_SET_BY_COUNTRY_IE
,
79 * enum reg_type - Regulatory change types
85 REGDOM_TYPE_CUSTOM_WORLD
,
86 REGDOM_TYPE_INTERSECTION
,
90 * struct hostapd_channel_data - Channel information
92 struct hostapd_channel_data
{
94 * chan - Channel number (IEEE 802.11)
99 * freq - Frequency in MHz
104 * flag - Channel flags (HOSTAPD_CHAN_*)
109 * max_tx_power - Regulatory transmit power limit in dBm
114 * survey_list - Linked list of surveys (struct freq_survey)
116 struct dl_list survey_list
;
119 * min_nf - Minimum observed noise floor, in dBm, based on all
120 * surveyed channel data
126 * interference_factor - Computed interference factor on this
127 * channel (used internally in src/ap/acs.c; driver wrappers do not
130 long double interference_factor
;
131 #endif /* CONFIG_ACS */
134 * dfs_cac_ms - DFS CAC time in milliseconds
136 unsigned int dfs_cac_ms
;
139 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
140 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
143 * struct hostapd_hw_modes - Supported hardware mode information
145 struct hostapd_hw_modes
{
147 * mode - Hardware mode
149 enum hostapd_hw_mode mode
;
152 * num_channels - Number of entries in the channels array
157 * channels - Array of supported channels
159 struct hostapd_channel_data
*channels
;
162 * num_rates - Number of entries in the rates array
167 * rates - Array of supported rates in 100 kbps units
172 * ht_capab - HT (IEEE 802.11n) capabilities
177 * mcs_set - MCS (IEEE 802.11n) rate parameters
182 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
187 * vht_capab - VHT (IEEE 802.11ac) capabilities
192 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
196 unsigned int flags
; /* HOSTAPD_MODE_FLAG_* */
200 #define IEEE80211_MODE_INFRA 0
201 #define IEEE80211_MODE_IBSS 1
202 #define IEEE80211_MODE_AP 2
203 #define IEEE80211_MODE_MESH 5
205 #define IEEE80211_CAP_ESS 0x0001
206 #define IEEE80211_CAP_IBSS 0x0002
207 #define IEEE80211_CAP_PRIVACY 0x0010
208 #define IEEE80211_CAP_RRM 0x1000
210 /* DMG (60 GHz) IEEE 802.11ad */
211 /* type - bits 0..1 */
212 #define IEEE80211_CAP_DMG_MASK 0x0003
213 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
214 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
215 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
217 #define WPA_SCAN_QUAL_INVALID BIT(0)
218 #define WPA_SCAN_NOISE_INVALID BIT(1)
219 #define WPA_SCAN_LEVEL_INVALID BIT(2)
220 #define WPA_SCAN_LEVEL_DBM BIT(3)
221 #define WPA_SCAN_ASSOCIATED BIT(5)
224 * struct wpa_scan_res - Scan result for an BSS/IBSS
225 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
227 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
228 * @beacon_int: beacon interval in TUs (host byte order)
229 * @caps: capability information field in host byte order
230 * @qual: signal quality
231 * @noise: noise level
232 * @level: signal level
234 * @age: Age of the information in milliseconds (i.e., how many milliseconds
235 * ago the last Beacon or Probe Response frame was received)
236 * @est_throughput: Estimated throughput in kbps (this is calculated during
237 * scan result processing if left zero by the driver wrapper)
238 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
239 * @ie_len: length of the following IE field in octets
240 * @beacon_ie_len: length of the following Beacon IE field in octets
242 * This structure is used as a generic format for scan results from the
243 * driver. Each driver interface implementation is responsible for converting
244 * the driver or OS specific scan results into this format.
246 * If the driver does not support reporting all IEs, the IE data structure is
247 * constructed of the IEs that are available. This field will also need to
248 * include SSID in IE format. All drivers are encouraged to be extended to
249 * report all IEs to make it easier to support future additions.
251 * This structure data is followed by ie_len octets of IEs from Probe Response
252 * frame (or if the driver does not indicate source of IEs, these may also be
253 * from Beacon frame). After the first set of IEs, another set of IEs may follow
254 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
256 struct wpa_scan_res
{
267 unsigned int est_throughput
;
270 size_t beacon_ie_len
;
271 /* Followed by ie_len + beacon_ie_len octets of IE data */
275 * struct wpa_scan_results - Scan results
276 * @res: Array of pointers to allocated variable length scan result entries
277 * @num: Number of entries in the scan result array
278 * @fetch_time: Time when the results were fetched from the driver
280 struct wpa_scan_results
{
281 struct wpa_scan_res
**res
;
283 struct os_reltime fetch_time
;
287 * struct wpa_interface_info - Network interface information
288 * @next: Pointer to the next interface or NULL if this is the last one
289 * @ifname: Interface name that can be used with init() or init2()
290 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
292 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
293 * is not an allocated copy, i.e., get_interfaces() caller will not free
296 struct wpa_interface_info
{
297 struct wpa_interface_info
*next
;
300 const char *drv_name
;
303 #define WPAS_MAX_SCAN_SSIDS 16
306 * struct wpa_driver_scan_ssid - SSIDs to scan for
307 * @ssid - specific SSID to scan for (ProbeReq)
308 * %NULL or zero-length SSID is used to indicate active scan
309 * with wildcard SSID.
310 * @ssid_len - Length of the SSID in octets
312 struct wpa_driver_scan_ssid
{
318 * struct wpa_driver_scan_params - Scan parameters
319 * Data for struct wpa_driver_ops::scan2().
321 struct wpa_driver_scan_params
{
323 * ssids - SSIDs to scan for
325 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
328 * num_ssids - Number of entries in ssids array
329 * Zero indicates a request for a passive scan.
334 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
339 * extra_ies_len - Length of extra_ies in octets
341 size_t extra_ies_len
;
344 * freqs - Array of frequencies to scan or %NULL for all frequencies
346 * The frequency is set in MHz. The array is zero-terminated.
351 * filter_ssids - Filter for reporting SSIDs
353 * This optional parameter can be used to request the driver wrapper to
354 * filter scan results to include only the specified SSIDs. %NULL
355 * indicates that no filtering is to be done. This can be used to
356 * reduce memory needs for scan results in environments that have large
357 * number of APs with different SSIDs.
359 * The driver wrapper is allowed to take this allocated buffer into its
360 * own use by setting the pointer to %NULL. In that case, the driver
361 * wrapper is responsible for freeing the buffer with os_free() once it
362 * is not needed anymore.
364 struct wpa_driver_scan_filter
{
365 u8 ssid
[SSID_MAX_LEN
];
370 * num_filter_ssids - Number of entries in filter_ssids array
372 size_t num_filter_ssids
;
375 * filter_rssi - Filter by RSSI
377 * The driver may filter scan results in firmware to reduce host
378 * wakeups and thereby save power. Specify the RSSI threshold in s32
384 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
386 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
387 * Mbps from the support rates element(s) in the Probe Request frames
388 * and not to transmit the frames at any of those rates.
390 unsigned int p2p_probe
:1;
393 * only_new_results - Request driver to report only new results
395 * This is used to request the driver to report only BSSes that have
396 * been detected after this scan request has been started, i.e., to
397 * flush old cached BSS entries.
399 unsigned int only_new_results
:1;
402 * low_priority - Requests driver to use a lower scan priority
404 * This is used to request the driver to use a lower scan priority
405 * if it supports such a thing.
407 unsigned int low_priority
:1;
410 * mac_addr_rand - Requests driver to randomize MAC address
412 unsigned int mac_addr_rand
:1;
415 * mac_addr - MAC address used with randomization. The address cannot be
416 * a multicast one, i.e., bit 0 of byte 0 should not be set.
421 * mac_addr_mask - MAC address mask used with randomization.
423 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
424 * the mask should be taken as is from mac_addr. The mask should not
425 * allow the generation of a multicast address, i.e., bit 0 of byte 0
428 const u8
*mac_addr_mask
;
431 * sched_scan_plans - Scan plans for scheduled scan
433 * Each scan plan consists of the number of iterations to scan and the
434 * interval between scans. When a scan plan finishes (i.e., it was run
435 * for the specified number of iterations), the next scan plan is
436 * executed. The scan plans are executed in the order they appear in
437 * the array (lower index first). The last scan plan will run infinitely
438 * (until requested to stop), thus must not specify the number of
439 * iterations. All other scan plans must specify the number of
442 struct sched_scan_plan
{
443 u32 interval
; /* In seconds */
444 u32 iterations
; /* Zero to run infinitely */
448 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
450 unsigned int sched_scan_plans_num
;
453 * bssid - Specific BSSID to scan for
455 * This optional parameter can be used to replace the default wildcard
456 * BSSID with a specific BSSID to scan for if results are needed from
462 * NOTE: Whenever adding new parameters here, please make sure
463 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
469 * struct wpa_driver_auth_params - Authentication parameters
470 * Data for struct wpa_driver_ops::authenticate().
472 struct wpa_driver_auth_params
{
480 const u8
*wep_key
[4];
481 size_t wep_key_len
[4];
483 int local_state_change
;
486 * p2p - Whether this connection is a P2P group
491 * sae_data - SAE elements for Authentication frame
493 * This buffer starts with the Authentication transaction sequence
494 * number field. If SAE is not used, this pointer is %NULL.
499 * sae_data_len - Length of sae_data buffer in octets
505 * enum wps_mode - WPS mode
509 * WPS_MODE_NONE - No WPS provisioning being used
514 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
519 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
525 * struct hostapd_freq_params - Channel parameters
527 struct hostapd_freq_params
{
529 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
531 enum hostapd_hw_mode mode
;
534 * freq - Primary channel center frequency in MHz
539 * channel - Channel number
544 * ht_enabled - Whether HT is enabled
549 * sec_channel_offset - Secondary channel offset for HT40
552 * -1 = HT40 enabled, secondary channel below primary,
553 * 1 = HT40 enabled, secondary channel above primary
555 int sec_channel_offset
;
558 * vht_enabled - Whether VHT is enabled
563 * center_freq1 - Segment 0 center frequency in MHz
565 * Valid for both HT and VHT.
570 * center_freq2 - Segment 1 center frequency in MHz
572 * Non-zero only for bandwidth 80 and an 80+80 channel
577 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
583 * struct wpa_driver_associate_params - Association parameters
584 * Data for struct wpa_driver_ops::associate().
586 struct wpa_driver_associate_params
{
588 * bssid - BSSID of the selected AP
589 * This can be %NULL, if ap_scan=2 mode is used and the driver is
590 * responsible for selecting with which BSS to associate. */
594 * bssid_hint - BSSID of a proposed AP
596 * This indicates which BSS has been found a suitable candidate for
597 * initial association for drivers that use driver/firmwate-based BSS
598 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
599 * the driver from selecting other BSSes in the ESS.
601 const u8
*bssid_hint
;
604 * ssid - The selected SSID
609 * ssid_len - Length of the SSID (1..32)
614 * freq - channel parameters
616 struct hostapd_freq_params freq
;
619 * freq_hint - Frequency of the channel the proposed AP is using
621 * This provides a channel on which a suitable BSS has been found as a
622 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
623 * limit the driver from selecting other channels for
624 * driver/firmware-based BSS selection.
629 * bg_scan_period - Background scan period in seconds, 0 to disable
630 * background scan, or -1 to indicate no change to default driver
636 * beacon_int - Beacon interval for IBSS or 0 to use driver default
641 * wpa_ie - WPA information element for (Re)Association Request
642 * WPA information element to be included in (Re)Association
643 * Request (including information element id and length). Use
644 * of this WPA IE is optional. If the driver generates the WPA
645 * IE, it can use pairwise_suite, group_suite, and
646 * key_mgmt_suite to select proper algorithms. In this case,
647 * the driver has to notify wpa_supplicant about the used WPA
648 * IE by generating an event that the interface code will
649 * convert into EVENT_ASSOCINFO data (see below).
651 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
652 * instead. The driver can determine which version is used by
653 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
656 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
661 * wpa_ie_len - length of the wpa_ie
666 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
668 unsigned int wpa_proto
;
671 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
673 * This is usually ignored if @wpa_ie is used.
675 unsigned int pairwise_suite
;
678 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
680 * This is usually ignored if @wpa_ie is used.
682 unsigned int group_suite
;
685 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
687 * This is usually ignored if @wpa_ie is used.
689 unsigned int key_mgmt_suite
;
692 * auth_alg - Allowed authentication algorithms
693 * Bit field of WPA_AUTH_ALG_*
698 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
703 * wep_key - WEP keys for static WEP configuration
705 const u8
*wep_key
[4];
708 * wep_key_len - WEP key length for static WEP configuration
710 size_t wep_key_len
[4];
713 * wep_tx_keyidx - WEP TX key index for static WEP configuration
718 * mgmt_frame_protection - IEEE 802.11w management frame protection
720 enum mfp_options mgmt_frame_protection
;
723 * ft_ies - IEEE 802.11r / FT information elements
724 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
725 * for fast transition, this parameter is set to include the IEs that
726 * are to be sent in the next FT Authentication Request message.
727 * update_ft_ies() handler is called to update the IEs for further
728 * FT messages in the sequence.
730 * The driver should use these IEs only if the target AP is advertising
731 * the same mobility domain as the one included in the MDIE here.
733 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
734 * AP after the initial association. These IEs can only be used if the
735 * target AP is advertising support for FT and is using the same MDIE
736 * and SSID as the current AP.
738 * The driver is responsible for reporting the FT IEs received from the
739 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
740 * type. update_ft_ies() handler will then be called with the FT IEs to
741 * include in the next frame in the authentication sequence.
746 * ft_ies_len - Length of ft_ies in bytes
751 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
753 * This value is provided to allow the driver interface easier access
754 * to the current mobility domain. This value is set to %NULL if no
755 * mobility domain is currently active.
760 * passphrase - RSN passphrase for PSK
762 * This value is made available only for WPA/WPA2-Personal (PSK) and
763 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
764 * the 8..63 character ASCII passphrase, if available. Please note that
765 * this can be %NULL if passphrase was not used to generate the PSK. In
766 * that case, the psk field must be used to fetch the PSK.
768 const char *passphrase
;
771 * psk - RSN PSK (alternative for passphrase for PSK)
773 * This value is made available only for WPA/WPA2-Personal (PSK) and
774 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
775 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
776 * be prepared to handle %NULL value as an error.
781 * drop_unencrypted - Enable/disable unencrypted frame filtering
783 * Configure the driver to drop all non-EAPOL frames (both receive and
784 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
785 * still be allowed for key negotiation.
787 int drop_unencrypted
;
790 * prev_bssid - Previously used BSSID in this ESS
792 * When not %NULL, this is a request to use reassociation instead of
795 const u8
*prev_bssid
;
800 * If the driver needs to do special configuration for WPS association,
801 * this variable provides more information on what type of association
802 * is being requested. Most drivers should not need ot use this.
807 * p2p - Whether this connection is a P2P group
812 * uapsd - UAPSD parameters for the network
813 * -1 = do not change defaults
814 * AP mode: 1 = enabled, 0 = disabled
815 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
820 * fixed_bssid - Whether to force this BSSID in IBSS mode
821 * 1 = Fix this BSSID and prevent merges.
822 * 0 = Do not fix BSSID.
827 * fixed_freq - Fix control channel in IBSS mode
828 * 0 = don't fix control channel (default)
829 * 1 = fix control channel; this prevents IBSS merging with another
835 * disable_ht - Disable HT (IEEE 802.11n) for this connection
840 * htcaps - HT Capabilities over-rides
842 * Only bits set in the mask will be used, and not all values are used
843 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
845 * Pointer to struct ieee80211_ht_capabilities.
850 * htcaps_mask - HT Capabilities over-rides mask
852 * Pointer to struct ieee80211_ht_capabilities.
854 const u8
*htcaps_mask
;
856 #ifdef CONFIG_VHT_OVERRIDES
858 * disable_vht - Disable VHT for this connection
863 * VHT capability overrides.
865 const struct ieee80211_vht_capabilities
*vhtcaps
;
866 const struct ieee80211_vht_capabilities
*vhtcaps_mask
;
867 #endif /* CONFIG_VHT_OVERRIDES */
870 * req_key_mgmt_offload - Request key management offload for connection
872 * Request key management offload for this connection if the device
875 int req_key_mgmt_offload
;
878 * Flag for indicating whether this association includes support for
879 * RRM (Radio Resource Measurements)
884 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
885 * AP as usual. Valid for DMG network only.
892 HIDDEN_SSID_ZERO_LEN
,
893 HIDDEN_SSID_ZERO_CONTENTS
896 struct wowlan_triggers
{
900 u8 gtk_rekey_failure
;
902 u8 four_way_handshake
;
906 struct wpa_driver_ap_params
{
908 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
913 * head_len - Length of the head buffer in octets
918 * tail - Beacon tail following TIM IE
923 * tail_len - Length of the tail buffer in octets
928 * dtim_period - DTIM period
933 * beacon_int - Beacon interval
938 * basic_rates: -1 terminated array of basic rates in 100 kbps
940 * This parameter can be used to set a specific basic rate set for the
941 * BSS. If %NULL, default basic rate set is used.
946 * proberesp - Probe Response template
948 * This is used by drivers that reply to Probe Requests internally in
949 * AP mode and require the full Probe Response template.
954 * proberesp_len - Length of the proberesp buffer in octets
956 size_t proberesp_len
;
959 * ssid - The SSID to use in Beacon/Probe Response frames
964 * ssid_len - Length of the SSID (1..32)
969 * hide_ssid - Whether to hide the SSID
971 enum hide_ssid hide_ssid
;
974 * pairwise_ciphers - WPA_CIPHER_* bitfield
976 unsigned int pairwise_ciphers
;
979 * group_cipher - WPA_CIPHER_*
981 unsigned int group_cipher
;
984 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
986 unsigned int key_mgmt_suites
;
989 * auth_algs - WPA_AUTH_ALG_* bitfield
991 unsigned int auth_algs
;
994 * wpa_version - WPA_PROTO_* bitfield
996 unsigned int wpa_version
;
999 * privacy - Whether privacy is used in the BSS
1004 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1006 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1007 * not use the full Beacon template.
1009 const struct wpabuf
*beacon_ies
;
1012 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1014 * This is used to add IEs like WPS IE and P2P IE by drivers that
1015 * reply to Probe Request frames internally.
1017 const struct wpabuf
*proberesp_ies
;
1020 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1022 * This is used to add IEs like WPS IE by drivers that reply to
1023 * (Re)Association Request frames internally.
1025 const struct wpabuf
*assocresp_ies
;
1028 * isolate - Whether to isolate frames between associated stations
1030 * If this is non-zero, the AP is requested to disable forwarding of
1031 * frames between associated stations.
1036 * cts_protect - Whether CTS protection is enabled
1041 * preamble - Whether short preamble is enabled
1046 * short_slot_time - Whether short slot time is enabled
1048 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1049 * not set (e.g., when 802.11g mode is not in use)
1051 int short_slot_time
;
1054 * ht_opmode - HT operation mode or -1 if HT not in use
1059 * interworking - Whether Interworking is enabled
1064 * hessid - Homogeneous ESS identifier or %NULL if not set
1069 * access_network_type - Access Network Type (0..15)
1071 * This is used for filtering Probe Request frames when Interworking is
1074 u8 access_network_type
;
1077 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1079 * This is used by driver which advertises this capability.
1081 int ap_max_inactivity
;
1084 * ctwindow - Client Traffic Window (in TUs)
1089 * smps_mode - SMPS mode
1091 * SMPS mode to be used by the AP, specified as the relevant bits of
1092 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1094 unsigned int smps_mode
;
1097 * disable_dgaf - Whether group-addressed frames are disabled
1102 * osen - Whether OSEN security is enabled
1107 * freq - Channel parameters for dynamic bandwidth changes
1109 struct hostapd_freq_params
*freq
;
1112 * reenable - Whether this is to re-enable beaconing
1117 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1118 * infrastructure BSS. Valid only for DMG network.
1123 struct wpa_driver_mesh_bss_params
{
1124 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1125 #define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1126 #define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1127 #define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
1129 * TODO: Other mesh configuration parameters would go here.
1130 * See NL80211_MESHCONF_* for all the mesh config parameters.
1134 int peer_link_timeout
;
1139 struct wpa_driver_mesh_join_params
{
1142 const int *basic_rates
;
1145 struct hostapd_freq_params freq
;
1148 struct wpa_driver_mesh_bss_params conf
;
1149 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1150 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1151 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1152 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1157 * struct wpa_driver_capa - Driver capability information
1159 struct wpa_driver_capa
{
1160 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1161 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1162 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1163 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1164 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1165 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1166 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1167 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1168 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1169 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
1170 /** Bitfield of supported key management suites */
1171 unsigned int key_mgmt
;
1173 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1174 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1175 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1176 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1177 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1178 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1179 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1180 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1181 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1182 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1183 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1184 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1185 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1186 /** Bitfield of supported cipher suites */
1189 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1190 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1191 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1192 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1195 /** Driver generated WPA/RSN IE */
1196 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1197 /** Driver needs static WEP key setup after association command */
1198 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1199 /** Driver takes care of all DFS operations */
1200 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1201 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1202 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1203 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1204 /** Driver is for a wired Ethernet interface */
1205 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1206 /** Driver provides separate commands for authentication and association (SME in
1207 * wpa_supplicant). */
1208 #define WPA_DRIVER_FLAGS_SME 0x00000020
1209 /** Driver supports AP mode */
1210 #define WPA_DRIVER_FLAGS_AP 0x00000040
1211 /** Driver needs static WEP key setup after association has been completed */
1212 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1213 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1214 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1215 /** Driver supports concurrent P2P operations */
1216 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1218 * Driver uses the initial interface as a dedicated management interface, i.e.,
1219 * it cannot be used for P2P group operations or non-P2P purposes.
1221 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1222 /** This interface is P2P capable (P2P GO or P2P Client) */
1223 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1224 /** Driver supports station and key removal when stopping an AP */
1225 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1227 * Driver uses the initial interface for P2P management interface and non-P2P
1228 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1229 * P2P group operations.
1231 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1233 * Driver is known to use sane error codes, i.e., when it indicates that
1234 * something (e.g., association) fails, there was indeed a failure and the
1235 * operation does not end up getting completed successfully later.
1237 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1238 /** Driver supports off-channel TX */
1239 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1240 /** Driver indicates TX status events for EAPOL Data frames */
1241 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1242 /** Driver indicates TX status events for Deauth/Disassoc frames */
1243 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1244 /** Driver supports roaming (BSS selection) in firmware */
1245 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1246 /** Driver supports operating as a TDLS peer */
1247 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1248 /** Driver requires external TDLS setup/teardown/discovery */
1249 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1250 /** Driver indicates support for Probe Response offloading in AP mode */
1251 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1252 /** Driver supports U-APSD in AP mode */
1253 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1254 /** Driver supports inactivity timer in AP mode */
1255 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1256 /** Driver expects user space implementation of MLME in AP mode */
1257 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1258 /** Driver supports SAE with user space SME */
1259 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1260 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1261 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1262 /** Driver supports IBSS (Ad-hoc) mode */
1263 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1264 /** Driver supports radar detection */
1265 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1266 /** Driver supports a dedicated interface for P2P Device */
1267 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1268 /** Driver supports QoS Mapping */
1269 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1270 /** Driver supports CSA in AP mode */
1271 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1272 /** Driver supports mesh */
1273 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1274 /** Driver support ACS offload */
1275 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1276 /** Driver supports key management offload */
1277 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1278 /** Driver supports TDLS channel switching */
1279 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1280 /** Driver supports IBSS with HT datarates */
1281 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
1282 /** Driver supports IBSS with VHT datarates */
1283 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
1284 /** Driver supports automatic band selection */
1285 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
1286 /** Driver supports simultaneous off-channel operations */
1287 #define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
1288 /** Driver supports full AP client state */
1289 #define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
1290 /** Driver supports P2P Listen offload */
1291 #define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
1294 #define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1295 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1297 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1298 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1299 unsigned int smps_modes
;
1301 unsigned int wmm_ac_supported
:1;
1303 unsigned int mac_addr_rand_scan_supported
:1;
1304 unsigned int mac_addr_rand_sched_scan_supported
:1;
1306 /** Maximum number of supported active probe SSIDs */
1309 /** Maximum number of supported active probe SSIDs for sched_scan */
1310 int max_sched_scan_ssids
;
1312 /** Maximum number of supported scan plans for scheduled scan */
1313 unsigned int max_sched_scan_plans
;
1315 /** Maximum interval in a scan plan. In seconds */
1316 u32 max_sched_scan_plan_interval
;
1318 /** Maximum number of iterations in a single scan plan */
1319 u32 max_sched_scan_plan_iterations
;
1321 /** Whether sched_scan (offloaded scanning) is supported */
1322 int sched_scan_supported
;
1324 /** Maximum number of supported match sets for sched_scan */
1328 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1330 unsigned int max_remain_on_chan
;
1333 * max_stations - Maximum number of associated stations the driver
1334 * supports in AP mode
1336 unsigned int max_stations
;
1339 * probe_resp_offloads - Bitmap of supported protocols by the driver
1340 * for Probe Response offloading.
1342 /** Driver Probe Response offloading support for WPS ver. 1 */
1343 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1344 /** Driver Probe Response offloading support for WPS ver. 2 */
1345 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1346 /** Driver Probe Response offloading support for P2P */
1347 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1348 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1349 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1350 unsigned int probe_resp_offloads
;
1352 unsigned int max_acl_mac_addrs
;
1355 * Number of supported concurrent channels
1357 unsigned int num_multichan_concurrent
;
1360 * extended_capa - extended capabilities in driver/device
1362 * Must be allocated and freed by driver and the pointers must be
1363 * valid for the lifetime of the driver, i.e., freed in deinit()
1365 const u8
*extended_capa
, *extended_capa_mask
;
1366 unsigned int extended_capa_len
;
1368 struct wowlan_triggers wowlan_triggers
;
1370 /** Driver adds the DS Params Set IE in Probe Request frames */
1371 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1372 /** Driver adds the WFA TPC IE in Probe Request frames */
1373 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1374 /** Driver handles quiet period requests */
1375 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1377 * Driver is capable of inserting the current TX power value into the body of
1378 * transmitted frames.
1379 * Background: Some Action frames include a TPC Report IE. This IE contains a
1380 * TX power field, which has to be updated by lower layers. One such Action
1381 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1382 * of spectrum management). Note that this insertion takes place at a fixed
1383 * offset, namely the 6th byte in the Action frame body.
1385 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1387 * Driver supports RRM. With this support, the driver will accept to use RRM in
1388 * (Re)Association Request frames, without supporting quiet period.
1390 #define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1394 /* Driver concurrency capabilities */
1395 unsigned int conc_capab
;
1396 /* Maximum number of concurrent channels on 2.4 GHz */
1397 unsigned int max_conc_chan_2_4
;
1398 /* Maximum number of concurrent channels on 5 GHz */
1399 unsigned int max_conc_chan_5_0
;
1401 /* Maximum number of supported CSA counters */
1402 u16 max_csa_counters
;
1406 struct hostapd_data
;
1408 struct hostap_sta_driver_data
{
1409 unsigned long rx_packets
, tx_packets
;
1410 unsigned long long rx_bytes
, tx_bytes
;
1411 int bytes_64bit
; /* whether 64-bit byte counters are supported */
1412 unsigned long current_tx_rate
;
1413 unsigned long inactive_msec
;
1414 unsigned long flags
;
1415 unsigned long num_ps_buf_frames
;
1416 unsigned long tx_retry_failed
;
1417 unsigned long tx_retry_count
;
1422 struct hostapd_sta_add_params
{
1426 const u8
*supp_rates
;
1427 size_t supp_rates_len
;
1428 u16 listen_interval
;
1429 const struct ieee80211_ht_capabilities
*ht_capabilities
;
1430 const struct ieee80211_vht_capabilities
*vht_capabilities
;
1431 int vht_opmode_enabled
;
1433 u32 flags
; /* bitmask of WPA_STA_* flags */
1434 u32 flags_mask
; /* unset bits in flags */
1436 enum mesh_plink_state plink_state
;
1438 #endif /* CONFIG_MESH */
1439 int set
; /* Set STA parameters instead of add */
1441 const u8
*ext_capab
;
1442 size_t ext_capab_len
;
1443 const u8
*supp_channels
;
1444 size_t supp_channels_len
;
1445 const u8
*supp_oper_classes
;
1446 size_t supp_oper_classes_len
;
1450 struct mac_address
{
1454 struct hostapd_acl_params
{
1456 unsigned int num_mac_acl
;
1457 struct mac_address mac_acl
[0];
1460 enum wpa_driver_if_type
{
1462 * WPA_IF_STATION - Station mode interface
1467 * WPA_IF_AP_VLAN - AP mode VLAN interface
1469 * This interface shares its address and Beacon frame with the main
1475 * WPA_IF_AP_BSS - AP mode BSS interface
1477 * This interface has its own address and Beacon frame.
1482 * WPA_IF_P2P_GO - P2P Group Owner
1487 * WPA_IF_P2P_CLIENT - P2P Client
1492 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1493 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1498 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1499 * abstracted P2P Device function in the driver
1504 * WPA_IF_MESH - Mesh interface
1509 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1514 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1519 struct wpa_init_params
{
1523 const char *driver_params
;
1524 int use_pae_group_addr
;
1528 u8
*own_addr
; /* buffer for writing own MAC address */
1532 struct wpa_bss_params
{
1533 /** Interface name (for multi-SSID/VLAN support) */
1535 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1544 enum mfp_options ieee80211w
;
1547 #define WPA_STA_AUTHORIZED BIT(0)
1548 #define WPA_STA_WMM BIT(1)
1549 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1550 #define WPA_STA_MFP BIT(3)
1551 #define WPA_STA_TDLS_PEER BIT(4)
1552 #define WPA_STA_AUTHENTICATED BIT(5)
1553 #define WPA_STA_ASSOCIATED BIT(6)
1566 WNM_SLEEP_ENTER_CONFIRM
,
1567 WNM_SLEEP_ENTER_FAIL
,
1568 WNM_SLEEP_EXIT_CONFIRM
,
1569 WNM_SLEEP_EXIT_FAIL
,
1570 WNM_SLEEP_TFS_REQ_IE_ADD
, /* STA requests driver to add TFS req IE */
1571 WNM_SLEEP_TFS_REQ_IE_NONE
, /* STA requests empty TFS req IE */
1572 WNM_SLEEP_TFS_REQ_IE_SET
, /* AP requests driver to set TFS req IE for
1574 WNM_SLEEP_TFS_RESP_IE_ADD
, /* AP requests driver to add TFS resp IE
1576 WNM_SLEEP_TFS_RESP_IE_NONE
, /* AP requests empty TFS resp IE */
1577 WNM_SLEEP_TFS_RESP_IE_SET
, /* AP requests driver to set TFS resp IE
1579 WNM_SLEEP_TFS_IE_DEL
/* AP delete the TFS IE */
1582 /* enum chan_width - Channel width definitions */
1594 * struct wpa_signal_info - Information about channel signal quality
1596 struct wpa_signal_info
{
1598 int above_threshold
;
1601 int avg_beacon_signal
;
1604 enum chan_width chanwidth
;
1610 * struct beacon_data - Beacon data
1611 * @head: Head portion of Beacon frame (before TIM IE)
1612 * @tail: Tail portion of Beacon frame (after TIM IE)
1613 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1614 * @proberesp_ies: Extra information element(s) to add into Probe Response
1616 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1617 * Response frames or %NULL
1618 * @probe_resp: Probe Response frame template
1619 * @head_len: Length of @head
1620 * @tail_len: Length of @tail
1621 * @beacon_ies_len: Length of beacon_ies in octets
1622 * @proberesp_ies_len: Length of proberesp_ies in octets
1623 * @proberesp_ies_len: Length of proberesp_ies in octets
1624 * @probe_resp_len: Length of probe response template (@probe_resp)
1626 struct beacon_data
{
1633 size_t head_len
, tail_len
;
1634 size_t beacon_ies_len
;
1635 size_t proberesp_ies_len
;
1636 size_t assocresp_ies_len
;
1637 size_t probe_resp_len
;
1641 * struct csa_settings - Settings for channel switch command
1642 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1643 * @block_tx: 1 - block transmission for CSA period
1644 * @freq_params: Next channel frequency parameter
1645 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1646 * @beacon_after: Next beacon/probe resp/asooc resp info
1647 * @counter_offset_beacon: Offset to the count field in beacon's tail
1648 * @counter_offset_presp: Offset to the count field in probe resp.
1650 struct csa_settings
{
1654 struct hostapd_freq_params freq_params
;
1655 struct beacon_data beacon_csa
;
1656 struct beacon_data beacon_after
;
1658 u16 counter_offset_beacon
[2];
1659 u16 counter_offset_presp
[2];
1662 /* TDLS peer capabilities for send_tdls_mgmt() */
1663 enum tdls_peer_capability
{
1664 TDLS_PEER_HT
= BIT(0),
1665 TDLS_PEER_VHT
= BIT(1),
1666 TDLS_PEER_WMM
= BIT(2),
1669 /* valid info in the wmm_params struct */
1670 enum wmm_params_valid_info
{
1671 WMM_PARAMS_UAPSD_QUEUES_INFO
= BIT(0),
1675 * struct wmm_params - WMM parameterss configured for this association
1676 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1677 * of the struct contain valid information.
1678 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1679 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1686 #ifdef CONFIG_MACSEC
1687 struct macsec_init_params
{
1688 Boolean always_include_sci
;
1692 #endif /* CONFIG_MACSEC */
1694 enum drv_br_port_attr
{
1695 DRV_BR_PORT_ATTR_PROXYARP
,
1696 DRV_BR_PORT_ATTR_HAIRPIN_MODE
,
1699 enum drv_br_net_param
{
1700 DRV_BR_NET_PARAM_GARP_ACCEPT
,
1701 DRV_BR_MULTICAST_SNOOPING
,
1704 struct drv_acs_params
{
1705 /* Selected mode (HOSTAPD_MODE_*) */
1706 enum hostapd_hw_mode hw_mode
;
1708 /* Indicates whether HT is enabled */
1711 /* Indicates whether HT40 is enabled */
1714 /* Indicates whether VHT is enabled */
1717 /* Configured ACS channel width */
1720 /* ACS channel list info */
1721 unsigned int ch_list_len
;
1723 const int *freq_list
;
1728 * struct wpa_driver_ops - Driver interface API definition
1730 * This structure defines the API that each driver interface needs to implement
1731 * for core wpa_supplicant code. All driver specific functionality is captured
1734 struct wpa_driver_ops
{
1735 /** Name of the driver interface */
1737 /** One line description of the driver interface */
1741 * get_bssid - Get the current BSSID
1742 * @priv: private driver interface data
1743 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1745 * Returns: 0 on success, -1 on failure
1747 * Query kernel driver for the current BSSID and copy it to bssid.
1748 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1751 int (*get_bssid
)(void *priv
, u8
*bssid
);
1754 * get_ssid - Get the current SSID
1755 * @priv: private driver interface data
1756 * @ssid: buffer for SSID (at least 32 bytes)
1758 * Returns: Length of the SSID on success, -1 on failure
1760 * Query kernel driver for the current SSID and copy it to ssid.
1761 * Returning zero is recommended if the STA is not associated.
1763 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1764 * can, at least in theory, contain control characters (including nul)
1765 * and as such, should be processed as binary data, not a printable
1768 int (*get_ssid
)(void *priv
, u8
*ssid
);
1771 * set_key - Configure encryption key
1772 * @ifname: Interface name (for multi-SSID/VLAN support)
1773 * @priv: private driver interface data
1774 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1775 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1776 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1777 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1778 * %WPA_ALG_BIP_CMAC_256);
1779 * %WPA_ALG_NONE clears the key.
1780 * @addr: Address of the peer STA (BSSID of the current AP when setting
1781 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1782 * broadcast keys, %NULL for default keys that are used both for
1783 * broadcast and unicast; when clearing keys, %NULL is used to
1784 * indicate that both the broadcast-only and default key of the
1785 * specified key index is to be cleared
1786 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1788 * @set_tx: configure this key as the default Tx key (only used when
1789 * driver does not support separate unicast/individual key
1790 * @seq: sequence number/packet number, seq_len octets, the next
1791 * packet number to be used for in replay protection; configured
1792 * for Rx keys (in most cases, this is only used with broadcast
1793 * keys and set to zero for unicast keys); %NULL if not set
1794 * @seq_len: length of the seq, depends on the algorithm:
1795 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1796 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1798 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1799 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1801 * Returns: 0 on success, -1 on failure
1803 * Configure the given key for the kernel driver. If the driver
1804 * supports separate individual keys (4 default keys + 1 individual),
1805 * addr can be used to determine whether the key is default or
1806 * individual. If only 4 keys are supported, the default key with key
1807 * index 0 is used as the individual key. STA must be configured to use
1808 * it as the default Tx key (set_tx is set) and accept Rx for all the
1809 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1810 * broadcast keys, so key index 0 is available for this kind of
1813 * Please note that TKIP keys include separate TX and RX MIC keys and
1814 * some drivers may expect them in different order than wpa_supplicant
1815 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1816 * will trigger Michael MIC errors. This can be fixed by changing the
1817 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1818 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1819 * example on how this can be done.
1821 int (*set_key
)(const char *ifname
, void *priv
, enum wpa_alg alg
,
1822 const u8
*addr
, int key_idx
, int set_tx
,
1823 const u8
*seq
, size_t seq_len
,
1824 const u8
*key
, size_t key_len
);
1827 * init - Initialize driver interface
1828 * @ctx: context to be used when calling wpa_supplicant functions,
1829 * e.g., wpa_supplicant_event()
1830 * @ifname: interface name, e.g., wlan0
1832 * Returns: Pointer to private data, %NULL on failure
1834 * Initialize driver interface, including event processing for kernel
1835 * driver events (e.g., associated, scan results, Michael MIC failure).
1836 * This function can allocate a private configuration data area for
1837 * @ctx, file descriptor, interface name, etc. information that may be
1838 * needed in future driver operations. If this is not used, non-NULL
1839 * value will need to be returned because %NULL is used to indicate
1840 * failure. The returned value will be used as 'void *priv' data for
1841 * all other driver_ops functions.
1843 * The main event loop (eloop.c) of wpa_supplicant can be used to
1844 * register callback for read sockets (eloop_register_read_sock()).
1846 * See below for more information about events and
1847 * wpa_supplicant_event() function.
1849 void * (*init
)(void *ctx
, const char *ifname
);
1852 * deinit - Deinitialize driver interface
1853 * @priv: private driver interface data from init()
1855 * Shut down driver interface and processing of driver events. Free
1856 * private data buffer if one was allocated in init() handler.
1858 void (*deinit
)(void *priv
);
1861 * set_param - Set driver configuration parameters
1862 * @priv: private driver interface data from init()
1863 * @param: driver specific configuration parameters
1865 * Returns: 0 on success, -1 on failure
1867 * Optional handler for notifying driver interface about configuration
1868 * parameters (driver_param).
1870 int (*set_param
)(void *priv
, const char *param
);
1873 * set_countermeasures - Enable/disable TKIP countermeasures
1874 * @priv: private driver interface data
1875 * @enabled: 1 = countermeasures enabled, 0 = disabled
1877 * Returns: 0 on success, -1 on failure
1879 * Configure TKIP countermeasures. When these are enabled, the driver
1880 * should drop all received and queued frames that are using TKIP.
1882 int (*set_countermeasures
)(void *priv
, int enabled
);
1885 * deauthenticate - Request driver to deauthenticate
1886 * @priv: private driver interface data
1887 * @addr: peer address (BSSID of the AP)
1888 * @reason_code: 16-bit reason code to be sent in the deauthentication
1891 * Returns: 0 on success, -1 on failure
1893 int (*deauthenticate
)(void *priv
, const u8
*addr
, int reason_code
);
1896 * associate - Request driver to associate
1897 * @priv: private driver interface data
1898 * @params: association parameters
1900 * Returns: 0 on success, -1 on failure
1902 int (*associate
)(void *priv
,
1903 struct wpa_driver_associate_params
*params
);
1906 * add_pmkid - Add PMKSA cache entry to the driver
1907 * @priv: private driver interface data
1908 * @bssid: BSSID for the PMKSA cache entry
1909 * @pmkid: PMKID for the PMKSA cache entry
1911 * Returns: 0 on success, -1 on failure
1913 * This function is called when a new PMK is received, as a result of
1914 * either normal authentication or RSN pre-authentication.
1916 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1917 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1918 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1919 * driver_ops function does not need to be implemented. Likewise, if
1920 * the driver does not support WPA, this function is not needed.
1922 int (*add_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
1925 * remove_pmkid - Remove PMKSA cache entry to the driver
1926 * @priv: private driver interface data
1927 * @bssid: BSSID for the PMKSA cache entry
1928 * @pmkid: PMKID for the PMKSA cache entry
1930 * Returns: 0 on success, -1 on failure
1932 * This function is called when the supplicant drops a PMKSA cache
1933 * entry for any reason.
1935 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1936 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1937 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1938 * from wpa_supplicant, this driver_ops function does not need to be
1939 * implemented. Likewise, if the driver does not support WPA, this
1940 * function is not needed.
1942 int (*remove_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
1945 * flush_pmkid - Flush PMKSA cache
1946 * @priv: private driver interface data
1948 * Returns: 0 on success, -1 on failure
1950 * This function is called when the supplicant drops all PMKSA cache
1951 * entries for any reason.
1953 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1954 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1955 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1956 * from wpa_supplicant, this driver_ops function does not need to be
1957 * implemented. Likewise, if the driver does not support WPA, this
1958 * function is not needed.
1960 int (*flush_pmkid
)(void *priv
);
1963 * get_capa - Get driver capabilities
1964 * @priv: private driver interface data
1966 * Returns: 0 on success, -1 on failure
1968 * Get driver/firmware/hardware capabilities.
1970 int (*get_capa
)(void *priv
, struct wpa_driver_capa
*capa
);
1973 * poll - Poll driver for association information
1974 * @priv: private driver interface data
1976 * This is an option callback that can be used when the driver does not
1977 * provide event mechanism for association events. This is called when
1978 * receiving WPA EAPOL-Key messages that require association
1979 * information. The driver interface is supposed to generate associnfo
1980 * event before returning from this callback function. In addition, the
1981 * driver interface should generate an association event after having
1982 * sent out associnfo.
1984 void (*poll
)(void *priv
);
1987 * get_ifindex - Get interface index
1988 * @priv: private driver interface data
1990 * Returns: Interface index
1992 unsigned int (*get_ifindex
)(void *priv
);
1995 * get_ifname - Get interface name
1996 * @priv: private driver interface data
1998 * Returns: Pointer to the interface name. This can differ from the
1999 * interface name used in init() call. Init() is called first.
2001 * This optional function can be used to allow the driver interface to
2002 * replace the interface name with something else, e.g., based on an
2003 * interface mapping from a more descriptive name.
2005 const char * (*get_ifname
)(void *priv
);
2008 * get_mac_addr - Get own MAC address
2009 * @priv: private driver interface data
2011 * Returns: Pointer to own MAC address or %NULL on failure
2013 * This optional function can be used to get the own MAC address of the
2014 * device from the driver interface code. This is only needed if the
2015 * l2_packet implementation for the OS does not provide easy access to
2017 const u8
* (*get_mac_addr
)(void *priv
);
2020 * set_operstate - Sets device operating state to DORMANT or UP
2021 * @priv: private driver interface data
2022 * @state: 0 = dormant, 1 = up
2023 * Returns: 0 on success, -1 on failure
2025 * This is an optional function that can be used on operating systems
2026 * that support a concept of controlling network device state from user
2027 * space applications. This function, if set, gets called with
2028 * state = 1 when authentication has been completed and with state = 0
2029 * when connection is lost.
2031 int (*set_operstate
)(void *priv
, int state
);
2034 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2035 * @priv: Private driver interface data
2036 * @addr: Address of the station for which to set protection (may be
2037 * %NULL for group keys)
2038 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2039 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2040 * Returns: 0 on success, -1 on failure
2042 * This is an optional function that can be used to set the driver to
2043 * require protection for Tx and/or Rx frames. This uses the layer
2044 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2045 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2046 * set protection operation; instead, they set protection implicitly
2047 * based on configured keys.
2049 int (*mlme_setprotection
)(void *priv
, const u8
*addr
, int protect_type
,
2053 * get_hw_feature_data - Get hardware support data (channels and rates)
2054 * @priv: Private driver interface data
2055 * @num_modes: Variable for returning the number of returned modes
2056 * flags: Variable for returning hardware feature flags
2057 * Returns: Pointer to allocated hardware data on success or %NULL on
2058 * failure. Caller is responsible for freeing this.
2060 struct hostapd_hw_modes
* (*get_hw_feature_data
)(void *priv
,
2065 * send_mlme - Send management frame from MLME
2066 * @priv: Private driver interface data
2067 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2068 * @data_len: Size of the management frame
2069 * @noack: Do not wait for this frame to be acked (disable retries)
2070 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2072 * @csa_offs: Array of CSA offsets or %NULL
2073 * @csa_offs_len: Number of elements in csa_offs
2074 * Returns: 0 on success, -1 on failure
2076 int (*send_mlme
)(void *priv
, const u8
*data
, size_t data_len
,
2077 int noack
, unsigned int freq
, const u16
*csa_offs
,
2078 size_t csa_offs_len
);
2081 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2082 * @priv: Private driver interface data
2083 * @md: Mobility domain (2 octets) (also included inside ies)
2084 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2085 * @ies_len: Length of FT IEs in bytes
2086 * Returns: 0 on success, -1 on failure
2088 * The supplicant uses this callback to let the driver know that keying
2089 * material for FT is available and that the driver can use the
2090 * provided IEs in the next message in FT authentication sequence.
2092 * This function is only needed for driver that support IEEE 802.11r
2093 * (Fast BSS Transition).
2095 int (*update_ft_ies
)(void *priv
, const u8
*md
, const u8
*ies
,
2099 * get_scan_results2 - Fetch the latest scan results
2100 * @priv: private driver interface data
2102 * Returns: Allocated buffer of scan results (caller is responsible for
2103 * freeing the data structure) on success, NULL on failure
2105 struct wpa_scan_results
* (*get_scan_results2
)(void *priv
);
2108 * set_country - Set country
2109 * @priv: Private driver interface data
2110 * @alpha2: country to which to switch to
2111 * Returns: 0 on success, -1 on failure
2113 * This function is for drivers which support some form
2114 * of setting a regulatory domain.
2116 int (*set_country
)(void *priv
, const char *alpha2
);
2119 * get_country - Get country
2120 * @priv: Private driver interface data
2121 * @alpha2: Buffer for returning country code (at least 3 octets)
2122 * Returns: 0 on success, -1 on failure
2124 int (*get_country
)(void *priv
, char *alpha2
);
2127 * global_init - Global driver initialization
2128 * @ctx: wpa_global pointer
2129 * Returns: Pointer to private data (global), %NULL on failure
2131 * This optional function is called to initialize the driver wrapper
2132 * for global data, i.e., data that applies to all interfaces. If this
2133 * function is implemented, global_deinit() will also need to be
2134 * implemented to free the private data. The driver will also likely
2135 * use init2() function instead of init() to get the pointer to global
2136 * data available to per-interface initializer.
2138 void * (*global_init
)(void *ctx
);
2141 * global_deinit - Global driver deinitialization
2142 * @priv: private driver global data from global_init()
2144 * Terminate any global driver related functionality and free the
2145 * global data structure.
2147 void (*global_deinit
)(void *priv
);
2150 * init2 - Initialize driver interface (with global data)
2151 * @ctx: context to be used when calling wpa_supplicant functions,
2152 * e.g., wpa_supplicant_event()
2153 * @ifname: interface name, e.g., wlan0
2154 * @global_priv: private driver global data from global_init()
2155 * Returns: Pointer to private data, %NULL on failure
2157 * This function can be used instead of init() if the driver wrapper
2160 void * (*init2
)(void *ctx
, const char *ifname
, void *global_priv
);
2163 * get_interfaces - Get information about available interfaces
2164 * @global_priv: private driver global data from global_init()
2165 * Returns: Allocated buffer of interface information (caller is
2166 * responsible for freeing the data structure) on success, NULL on
2169 struct wpa_interface_info
* (*get_interfaces
)(void *global_priv
);
2172 * scan2 - Request the driver to initiate scan
2173 * @priv: private driver interface data
2174 * @params: Scan parameters
2176 * Returns: 0 on success, -1 on failure
2178 * Once the scan results are ready, the driver should report scan
2179 * results event for wpa_supplicant which will eventually request the
2180 * results with wpa_driver_get_scan_results2().
2182 int (*scan2
)(void *priv
, struct wpa_driver_scan_params
*params
);
2185 * authenticate - Request driver to authenticate
2186 * @priv: private driver interface data
2187 * @params: authentication parameters
2188 * Returns: 0 on success, -1 on failure
2190 * This is an optional function that can be used with drivers that
2191 * support separate authentication and association steps, i.e., when
2192 * wpa_supplicant can act as the SME. If not implemented, associate()
2193 * function is expected to take care of IEEE 802.11 authentication,
2196 int (*authenticate
)(void *priv
,
2197 struct wpa_driver_auth_params
*params
);
2200 * set_ap - Set Beacon and Probe Response information for AP mode
2201 * @priv: Private driver interface data
2202 * @params: Parameters to use in AP mode
2204 * This function is used to configure Beacon template and/or extra IEs
2205 * to add for Beacon and Probe Response frames for the driver in
2206 * AP mode. The driver is responsible for building the full Beacon
2207 * frame by concatenating the head part with TIM IE generated by the
2208 * driver/firmware and finishing with the tail part. Depending on the
2209 * driver architectue, this can be done either by using the full
2210 * template or the set of additional IEs (e.g., WPS and P2P IE).
2211 * Similarly, Probe Response processing depends on the driver design.
2212 * If the driver (or firmware) takes care of replying to Probe Request
2213 * frames, the extra IEs provided here needs to be added to the Probe
2216 * Returns: 0 on success, -1 on failure
2218 int (*set_ap
)(void *priv
, struct wpa_driver_ap_params
*params
);
2221 * set_acl - Set ACL in AP mode
2222 * @priv: Private driver interface data
2223 * @params: Parameters to configure ACL
2224 * Returns: 0 on success, -1 on failure
2226 * This is used only for the drivers which support MAC address ACL.
2228 int (*set_acl
)(void *priv
, struct hostapd_acl_params
*params
);
2231 * hapd_init - Initialize driver interface (hostapd only)
2232 * @hapd: Pointer to hostapd context
2233 * @params: Configuration for the driver wrapper
2234 * Returns: Pointer to private data, %NULL on failure
2236 * This function is used instead of init() or init2() when the driver
2237 * wrapper is used with hostapd.
2239 void * (*hapd_init
)(struct hostapd_data
*hapd
,
2240 struct wpa_init_params
*params
);
2243 * hapd_deinit - Deinitialize driver interface (hostapd only)
2244 * @priv: Private driver interface data from hapd_init()
2246 void (*hapd_deinit
)(void *priv
);
2249 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2250 * @priv: Private driver interface data
2251 * @params: BSS parameters
2252 * Returns: 0 on success, -1 on failure
2254 * This is an optional function to configure the kernel driver to
2255 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2256 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2257 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2258 * for Beacon frames.
2260 * DEPRECATED - use set_ap() instead
2262 int (*set_ieee8021x
)(void *priv
, struct wpa_bss_params
*params
);
2265 * set_privacy - Enable/disable privacy (AP only)
2266 * @priv: Private driver interface data
2267 * @enabled: 1 = privacy enabled, 0 = disabled
2268 * Returns: 0 on success, -1 on failure
2270 * This is an optional function to configure privacy field in the
2271 * kernel driver for Beacon frames. This can be left undefined (set to
2272 * %NULL) if the driver uses the Beacon template from set_ap().
2274 * DEPRECATED - use set_ap() instead
2276 int (*set_privacy
)(void *priv
, int enabled
);
2279 * get_seqnum - Fetch the current TSC/packet number (AP only)
2280 * @ifname: The interface name (main or virtual)
2281 * @priv: Private driver interface data
2282 * @addr: MAC address of the station or %NULL for group keys
2284 * @seq: Buffer for returning the latest used TSC/packet number
2285 * Returns: 0 on success, -1 on failure
2287 * This function is used to fetch the last used TSC/packet number for
2288 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2289 * keys, so there is no strict requirement on implementing support for
2290 * unicast keys (i.e., addr != %NULL).
2292 int (*get_seqnum
)(const char *ifname
, void *priv
, const u8
*addr
,
2296 * flush - Flush all association stations (AP only)
2297 * @priv: Private driver interface data
2298 * Returns: 0 on success, -1 on failure
2300 * This function requests the driver to disassociate all associated
2301 * stations. This function does not need to be implemented if the
2302 * driver does not process association frames internally.
2304 int (*flush
)(void *priv
);
2307 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2308 * @priv: Private driver interface data
2309 * @elem: Information elements
2310 * @elem_len: Length of the elem buffer in octets
2311 * Returns: 0 on success, -1 on failure
2313 * This is an optional function to add information elements in the
2314 * kernel driver for Beacon and Probe Response frames. This can be left
2315 * undefined (set to %NULL) if the driver uses the Beacon template from
2318 * DEPRECATED - use set_ap() instead
2320 int (*set_generic_elem
)(void *priv
, const u8
*elem
, size_t elem_len
);
2323 * read_sta_data - Fetch station data
2324 * @priv: Private driver interface data
2325 * @data: Buffer for returning station information
2326 * @addr: MAC address of the station
2327 * Returns: 0 on success, -1 on failure
2329 int (*read_sta_data
)(void *priv
, struct hostap_sta_driver_data
*data
,
2333 * hapd_send_eapol - Send an EAPOL packet (AP only)
2334 * @priv: private driver interface data
2335 * @addr: Destination MAC address
2336 * @data: EAPOL packet starting with IEEE 802.1X header
2337 * @data_len: Length of the EAPOL packet in octets
2338 * @encrypt: Whether the frame should be encrypted
2339 * @own_addr: Source MAC address
2340 * @flags: WPA_STA_* flags for the destination station
2342 * Returns: 0 on success, -1 on failure
2344 int (*hapd_send_eapol
)(void *priv
, const u8
*addr
, const u8
*data
,
2345 size_t data_len
, int encrypt
,
2346 const u8
*own_addr
, u32 flags
);
2349 * sta_deauth - Deauthenticate a station (AP only)
2350 * @priv: Private driver interface data
2351 * @own_addr: Source address and BSSID for the Deauthentication frame
2352 * @addr: MAC address of the station to deauthenticate
2353 * @reason: Reason code for the Deauthentiation frame
2354 * Returns: 0 on success, -1 on failure
2356 * This function requests a specific station to be deauthenticated and
2357 * a Deauthentication frame to be sent to it.
2359 int (*sta_deauth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2363 * sta_disassoc - Disassociate a station (AP only)
2364 * @priv: Private driver interface data
2365 * @own_addr: Source address and BSSID for the Disassociation frame
2366 * @addr: MAC address of the station to disassociate
2367 * @reason: Reason code for the Disassociation frame
2368 * Returns: 0 on success, -1 on failure
2370 * This function requests a specific station to be disassociated and
2371 * a Disassociation frame to be sent to it.
2373 int (*sta_disassoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2377 * sta_remove - Remove a station entry (AP only)
2378 * @priv: Private driver interface data
2379 * @addr: MAC address of the station to be removed
2380 * Returns: 0 on success, -1 on failure
2382 int (*sta_remove
)(void *priv
, const u8
*addr
);
2385 * hapd_get_ssid - Get the current SSID (AP only)
2386 * @priv: Private driver interface data
2387 * @buf: Buffer for returning the SSID
2388 * @len: Maximum length of the buffer
2389 * Returns: Length of the SSID on success, -1 on failure
2391 * This function need not be implemented if the driver uses Beacon
2392 * template from set_ap() and does not reply to Probe Request frames.
2394 int (*hapd_get_ssid
)(void *priv
, u8
*buf
, int len
);
2397 * hapd_set_ssid - Set SSID (AP only)
2398 * @priv: Private driver interface data
2400 * @len: Length of the SSID in octets
2401 * Returns: 0 on success, -1 on failure
2403 * DEPRECATED - use set_ap() instead
2405 int (*hapd_set_ssid
)(void *priv
, const u8
*buf
, int len
);
2408 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2409 * @priv: Private driver interface data
2410 * @enabled: 1 = countermeasures enabled, 0 = disabled
2411 * Returns: 0 on success, -1 on failure
2413 * This need not be implemented if the driver does not take care of
2414 * association processing.
2416 int (*hapd_set_countermeasures
)(void *priv
, int enabled
);
2419 * sta_add - Add a station entry
2420 * @priv: Private driver interface data
2421 * @params: Station parameters
2422 * Returns: 0 on success, -1 on failure
2424 * This function is used to add or set (params->set 1) a station
2425 * entry in the driver. Adding STA entries is used only if the driver
2426 * does not take care of association processing.
2428 * With drivers that don't support full AP client state, this function
2429 * is used to add a station entry to the driver once the station has
2430 * completed association.
2432 * With TDLS, this function is used to add or set (params->set 1)
2433 * TDLS peer entries (even with drivers that do not support full AP
2436 int (*sta_add
)(void *priv
, struct hostapd_sta_add_params
*params
);
2439 * get_inact_sec - Get station inactivity duration (AP only)
2440 * @priv: Private driver interface data
2441 * @addr: Station address
2442 * Returns: Number of seconds station has been inactive, -1 on failure
2444 int (*get_inact_sec
)(void *priv
, const u8
*addr
);
2447 * sta_clear_stats - Clear station statistics (AP only)
2448 * @priv: Private driver interface data
2449 * @addr: Station address
2450 * Returns: 0 on success, -1 on failure
2452 int (*sta_clear_stats
)(void *priv
, const u8
*addr
);
2455 * set_freq - Set channel/frequency (AP only)
2456 * @priv: Private driver interface data
2457 * @freq: Channel parameters
2458 * Returns: 0 on success, -1 on failure
2460 int (*set_freq
)(void *priv
, struct hostapd_freq_params
*freq
);
2463 * set_rts - Set RTS threshold
2464 * @priv: Private driver interface data
2465 * @rts: RTS threshold in octets
2466 * Returns: 0 on success, -1 on failure
2468 int (*set_rts
)(void *priv
, int rts
);
2471 * set_frag - Set fragmentation threshold
2472 * @priv: Private driver interface data
2473 * @frag: Fragmentation threshold in octets
2474 * Returns: 0 on success, -1 on failure
2476 int (*set_frag
)(void *priv
, int frag
);
2479 * sta_set_flags - Set station flags (AP only)
2480 * @priv: Private driver interface data
2481 * @addr: Station address
2482 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2483 * @flags_or: Bitmap of WPA_STA_* flags to add
2484 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2485 * Returns: 0 on success, -1 on failure
2487 int (*sta_set_flags
)(void *priv
, const u8
*addr
,
2488 unsigned int total_flags
, unsigned int flags_or
,
2489 unsigned int flags_and
);
2492 * set_tx_queue_params - Set TX queue parameters
2493 * @priv: Private driver interface data
2494 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2498 * @burst_time: Maximum length for bursting in 0.1 msec units
2500 int (*set_tx_queue_params
)(void *priv
, int queue
, int aifs
, int cw_min
,
2501 int cw_max
, int burst_time
);
2504 * if_add - Add a virtual interface
2505 * @priv: Private driver interface data
2506 * @type: Interface type
2507 * @ifname: Interface name for the new virtual interface
2508 * @addr: Local address to use for the interface or %NULL to use the
2509 * parent interface address
2510 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2511 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2512 * not allowed (applies only to %WPA_IF_AP_BSS type)
2513 * @force_ifname: Buffer for returning an interface name that the
2514 * driver ended up using if it differs from the requested ifname
2515 * @if_addr: Buffer for returning the allocated interface address
2516 * (this may differ from the requested addr if the driver cannot
2517 * change interface address)
2518 * @bridge: Bridge interface to use or %NULL if no bridge configured
2519 * @use_existing: Whether to allow existing interface to be used
2520 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
2521 * Returns: 0 on success, -1 on failure
2523 int (*if_add
)(void *priv
, enum wpa_driver_if_type type
,
2524 const char *ifname
, const u8
*addr
, void *bss_ctx
,
2525 void **drv_priv
, char *force_ifname
, u8
*if_addr
,
2526 const char *bridge
, int use_existing
, int setup_ap
);
2529 * if_remove - Remove a virtual interface
2530 * @priv: Private driver interface data
2531 * @type: Interface type
2532 * @ifname: Interface name of the virtual interface to be removed
2533 * Returns: 0 on success, -1 on failure
2535 int (*if_remove
)(void *priv
, enum wpa_driver_if_type type
,
2536 const char *ifname
);
2539 * set_sta_vlan - Bind a station into a specific interface (AP only)
2540 * @priv: Private driver interface data
2541 * @ifname: Interface (main or virtual BSS or VLAN)
2542 * @addr: MAC address of the associated station
2544 * Returns: 0 on success, -1 on failure
2546 * This function is used to bind a station to a specific virtual
2547 * interface. It is only used if when virtual interfaces are supported,
2548 * e.g., to assign stations to different VLAN interfaces based on
2549 * information from a RADIUS server. This allows separate broadcast
2550 * domains to be used with a single BSS.
2552 int (*set_sta_vlan
)(void *priv
, const u8
*addr
, const char *ifname
,
2556 * commit - Optional commit changes handler (AP only)
2557 * @priv: driver private data
2558 * Returns: 0 on success, -1 on failure
2560 * This optional handler function can be registered if the driver
2561 * interface implementation needs to commit changes (e.g., by setting
2562 * network interface up) at the end of initial configuration. If set,
2563 * this handler will be called after initial setup has been completed.
2565 int (*commit
)(void *priv
);
2568 * send_ether - Send an ethernet packet (AP only)
2569 * @priv: private driver interface data
2570 * @dst: Destination MAC address
2571 * @src: Source MAC address
2573 * @data: EAPOL packet starting with IEEE 802.1X header
2574 * @data_len: Length of the EAPOL packet in octets
2575 * Returns: 0 on success, -1 on failure
2577 int (*send_ether
)(void *priv
, const u8
*dst
, const u8
*src
, u16 proto
,
2578 const u8
*data
, size_t data_len
);
2581 * set_radius_acl_auth - Notification of RADIUS ACL change
2582 * @priv: Private driver interface data
2583 * @mac: MAC address of the station
2584 * @accepted: Whether the station was accepted
2585 * @session_timeout: Session timeout for the station
2586 * Returns: 0 on success, -1 on failure
2588 int (*set_radius_acl_auth
)(void *priv
, const u8
*mac
, int accepted
,
2589 u32 session_timeout
);
2592 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2593 * @priv: Private driver interface data
2594 * @mac: MAC address of the station
2595 * Returns: 0 on success, -1 on failure
2597 int (*set_radius_acl_expire
)(void *priv
, const u8
*mac
);
2600 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2601 * @priv: Private driver interface data
2602 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2603 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2605 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2606 * to remove extra IE(s)
2607 * Returns: 0 on success, -1 on failure
2609 * This is an optional function to add WPS IE in the kernel driver for
2610 * Beacon and Probe Response frames. This can be left undefined (set
2611 * to %NULL) if the driver uses the Beacon template from set_ap()
2612 * and does not process Probe Request frames. If the driver takes care
2613 * of (Re)Association frame processing, the assocresp buffer includes
2614 * WPS IE(s) that need to be added to (Re)Association Response frames
2615 * whenever a (Re)Association Request frame indicated use of WPS.
2617 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2618 * frames when operating as a GO. The driver is responsible for adding
2619 * timing related attributes (e.g., NoA) in addition to the IEs
2620 * included here by appending them after these buffers. This call is
2621 * also used to provide Probe Response IEs for P2P Listen state
2622 * operations for drivers that generate the Probe Response frames
2625 * DEPRECATED - use set_ap() instead
2627 int (*set_ap_wps_ie
)(void *priv
, const struct wpabuf
*beacon
,
2628 const struct wpabuf
*proberesp
,
2629 const struct wpabuf
*assocresp
);
2632 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2633 * @priv: Private driver interface data
2634 * @authorized: Whether the port is authorized
2635 * Returns: 0 on success, -1 on failure
2637 int (*set_supp_port
)(void *priv
, int authorized
);
2640 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2641 * @priv: Private driver interface data
2642 * @addr: MAC address of the associated station
2643 * @aid: Association ID
2644 * @val: 1 = bind to 4-address WDS; 0 = unbind
2645 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2646 * to indicate that bridge is not to be used
2647 * @ifname_wds: Buffer to return the interface name for the new WDS
2648 * station or %NULL to indicate name is not returned.
2649 * Returns: 0 on success, -1 on failure
2651 int (*set_wds_sta
)(void *priv
, const u8
*addr
, int aid
, int val
,
2652 const char *bridge_ifname
, char *ifname_wds
);
2655 * send_action - Transmit an Action frame
2656 * @priv: Private driver interface data
2657 * @freq: Frequency (in MHz) of the channel
2658 * @wait: Time to wait off-channel for a response (in ms), or zero
2659 * @dst: Destination MAC address (Address 1)
2660 * @src: Source MAC address (Address 2)
2661 * @bssid: BSSID (Address 3)
2663 * @data_len: data length in octets
2664 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2665 * Returns: 0 on success, -1 on failure
2667 * This command can be used to request the driver to transmit an action
2668 * frame to the specified destination.
2670 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2671 * be transmitted on the given channel and the device will wait for a
2672 * response on that channel for the given wait time.
2674 * If the flag is not set, the wait time will be ignored. In this case,
2675 * if a remain-on-channel duration is in progress, the frame must be
2676 * transmitted on that channel; alternatively the frame may be sent on
2677 * the current operational channel (if in associated state in station
2678 * mode or while operating as an AP.)
2680 int (*send_action
)(void *priv
, unsigned int freq
, unsigned int wait
,
2681 const u8
*dst
, const u8
*src
, const u8
*bssid
,
2682 const u8
*data
, size_t data_len
, int no_cck
);
2685 * send_action_cancel_wait - Cancel action frame TX wait
2686 * @priv: Private driver interface data
2688 * This command cancels the wait time associated with sending an action
2689 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2690 * set in the driver flags.
2692 void (*send_action_cancel_wait
)(void *priv
);
2695 * remain_on_channel - Remain awake on a channel
2696 * @priv: Private driver interface data
2697 * @freq: Frequency (in MHz) of the channel
2698 * @duration: Duration in milliseconds
2699 * Returns: 0 on success, -1 on failure
2701 * This command is used to request the driver to remain awake on the
2702 * specified channel for the specified duration and report received
2703 * Action frames with EVENT_RX_MGMT events. Optionally, received
2704 * Probe Request frames may also be requested to be reported by calling
2705 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2707 * The driver may not be at the requested channel when this function
2708 * returns, i.e., the return code is only indicating whether the
2709 * request was accepted. The caller will need to wait until the
2710 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2711 * completed the channel change. This may take some time due to other
2712 * need for the radio and the caller should be prepared to timing out
2713 * its wait since there are no guarantees on when this request can be
2716 int (*remain_on_channel
)(void *priv
, unsigned int freq
,
2717 unsigned int duration
);
2720 * cancel_remain_on_channel - Cancel remain-on-channel operation
2721 * @priv: Private driver interface data
2723 * This command can be used to cancel a remain-on-channel operation
2724 * before its originally requested duration has passed. This could be
2725 * used, e.g., when remain_on_channel() is used to request extra time
2726 * to receive a response to an Action frame and the response is
2727 * received when there is still unneeded time remaining on the
2728 * remain-on-channel operation.
2730 int (*cancel_remain_on_channel
)(void *priv
);
2733 * probe_req_report - Request Probe Request frames to be indicated
2734 * @priv: Private driver interface data
2735 * @report: Whether to report received Probe Request frames
2736 * Returns: 0 on success, -1 on failure (or if not supported)
2738 * This command can be used to request the driver to indicate when
2739 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2740 * Since this operation may require extra resources, e.g., due to less
2741 * optimal hardware/firmware RX filtering, many drivers may disable
2742 * Probe Request reporting at least in station mode. This command is
2743 * used to notify the driver when the Probe Request frames need to be
2744 * reported, e.g., during remain-on-channel operations.
2746 int (*probe_req_report
)(void *priv
, int report
);
2749 * deinit_ap - Deinitialize AP mode
2750 * @priv: Private driver interface data
2751 * Returns: 0 on success, -1 on failure (or if not supported)
2753 * This optional function can be used to disable AP mode related
2754 * configuration. If the interface was not dynamically added,
2755 * change the driver mode to station mode to allow normal station
2756 * operations like scanning to be completed.
2758 int (*deinit_ap
)(void *priv
);
2761 * deinit_p2p_cli - Deinitialize P2P client mode
2762 * @priv: Private driver interface data
2763 * Returns: 0 on success, -1 on failure (or if not supported)
2765 * This optional function can be used to disable P2P client mode. If the
2766 * interface was not dynamically added, change the interface type back
2769 int (*deinit_p2p_cli
)(void *priv
);
2772 * suspend - Notification on system suspend/hibernate event
2773 * @priv: Private driver interface data
2775 void (*suspend
)(void *priv
);
2778 * resume - Notification on system resume/thaw event
2779 * @priv: Private driver interface data
2781 void (*resume
)(void *priv
);
2784 * signal_monitor - Set signal monitoring parameters
2785 * @priv: Private driver interface data
2786 * @threshold: Threshold value for signal change events; 0 = disabled
2787 * @hysteresis: Minimum change in signal strength before indicating a
2789 * Returns: 0 on success, -1 on failure (or if not supported)
2791 * This function can be used to configure monitoring of signal strength
2792 * with the current AP. Whenever signal strength drops below the
2793 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2794 * should be generated assuming the signal strength has changed at
2795 * least %hysteresis from the previously indicated signal change event.
2797 int (*signal_monitor
)(void *priv
, int threshold
, int hysteresis
);
2800 * send_frame - Send IEEE 802.11 frame (testing use only)
2801 * @priv: Private driver interface data
2802 * @data: IEEE 802.11 frame with IEEE 802.11 header
2803 * @data_len: Size of the frame
2804 * @encrypt: Whether to encrypt the frame (if keys are set)
2805 * Returns: 0 on success, -1 on failure
2807 * This function is only used for debugging purposes and is not
2808 * required to be implemented for normal operations.
2810 int (*send_frame
)(void *priv
, const u8
*data
, size_t data_len
,
2814 * get_noa - Get current Notice of Absence attribute payload
2815 * @priv: Private driver interface data
2816 * @buf: Buffer for returning NoA
2817 * @buf_len: Buffer length in octets
2818 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2819 * advertized, or -1 on failure
2821 * This function is used to fetch the current Notice of Absence
2822 * attribute value from GO.
2824 int (*get_noa
)(void *priv
, u8
*buf
, size_t buf_len
);
2827 * set_noa - Set Notice of Absence parameters for GO (testing)
2828 * @priv: Private driver interface data
2830 * @start: Start time in ms from next TBTT
2831 * @duration: Duration in ms
2832 * Returns: 0 on success or -1 on failure
2834 * This function is used to set Notice of Absence parameters for GO. It
2835 * is used only for testing. To disable NoA, all parameters are set to
2838 int (*set_noa
)(void *priv
, u8 count
, int start
, int duration
);
2841 * set_p2p_powersave - Set P2P power save options
2842 * @priv: Private driver interface data
2843 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2844 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2845 * @ctwindow: 0.. = change (msec), -1 = no change
2846 * Returns: 0 on success or -1 on failure
2848 int (*set_p2p_powersave
)(void *priv
, int legacy_ps
, int opp_ps
,
2852 * ampdu - Enable/disable aggregation
2853 * @priv: Private driver interface data
2854 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2855 * Returns: 0 on success or -1 on failure
2857 int (*ampdu
)(void *priv
, int ampdu
);
2860 * get_radio_name - Get physical radio name for the device
2861 * @priv: Private driver interface data
2862 * Returns: Radio name or %NULL if not known
2864 * The returned data must not be modified by the caller. It is assumed
2865 * that any interface that has the same radio name as another is
2866 * sharing the same physical radio. This information can be used to
2867 * share scan results etc. information between the virtual interfaces
2868 * to speed up various operations.
2870 const char * (*get_radio_name
)(void *priv
);
2873 * send_tdls_mgmt - for sending TDLS management packets
2874 * @priv: private driver interface data
2875 * @dst: Destination (peer) MAC address
2876 * @action_code: TDLS action code for the mssage
2877 * @dialog_token: Dialog Token to use in the message (if needed)
2878 * @status_code: Status Code or Reason Code to use (if needed)
2879 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2880 * @initiator: Is the current end the TDLS link initiator
2881 * @buf: TDLS IEs to add to the message
2882 * @len: Length of buf in octets
2883 * Returns: 0 on success, negative (<0) on failure
2885 * This optional function can be used to send packet to driver which is
2886 * responsible for receiving and sending all TDLS packets.
2888 int (*send_tdls_mgmt
)(void *priv
, const u8
*dst
, u8 action_code
,
2889 u8 dialog_token
, u16 status_code
, u32 peer_capab
,
2890 int initiator
, const u8
*buf
, size_t len
);
2893 * tdls_oper - Ask the driver to perform high-level TDLS operations
2894 * @priv: Private driver interface data
2895 * @oper: TDLS high-level operation. See %enum tdls_oper
2896 * @peer: Destination (peer) MAC address
2897 * Returns: 0 on success, negative (<0) on failure
2899 * This optional function can be used to send high-level TDLS commands
2902 int (*tdls_oper
)(void *priv
, enum tdls_oper oper
, const u8
*peer
);
2905 * wnm_oper - Notify driver of the WNM frame reception
2906 * @priv: Private driver interface data
2907 * @oper: WNM operation. See %enum wnm_oper
2908 * @peer: Destination (peer) MAC address
2909 * @buf: Buffer for the driver to fill in (for getting IE)
2910 * @buf_len: Return the len of buf
2911 * Returns: 0 on success, negative (<0) on failure
2913 int (*wnm_oper
)(void *priv
, enum wnm_oper oper
, const u8
*peer
,
2914 u8
*buf
, u16
*buf_len
);
2917 * set_qos_map - Set QoS Map
2918 * @priv: Private driver interface data
2919 * @qos_map_set: QoS Map
2920 * @qos_map_set_len: Length of QoS Map
2922 int (*set_qos_map
)(void *priv
, const u8
*qos_map_set
,
2923 u8 qos_map_set_len
);
2926 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2927 * @priv: Private driver interface data
2928 * @version: IP version of the IP address, 4 or 6
2929 * @ipaddr: IP address for the neigh entry
2930 * @prefixlen: IP address prefix length
2931 * @addr: Corresponding MAC address
2932 * Returns: 0 on success, negative (<0) on failure
2934 int (*br_add_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
,
2935 int prefixlen
, const u8
*addr
);
2938 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2939 * @priv: Private driver interface data
2940 * @version: IP version of the IP address, 4 or 6
2941 * @ipaddr: IP address for the neigh entry
2942 * Returns: 0 on success, negative (<0) on failure
2944 int (*br_delete_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
);
2947 * br_port_set_attr - Set a bridge port attribute
2948 * @attr: Bridge port attribute to set
2949 * @val: Value to be set
2950 * Returns: 0 on success, negative (<0) on failure
2952 int (*br_port_set_attr
)(void *priv
, enum drv_br_port_attr attr
,
2956 * br_port_set_attr - Set a bridge network parameter
2957 * @param: Bridge parameter to set
2958 * @val: Value to be set
2959 * Returns: 0 on success, negative (<0) on failure
2961 int (*br_set_net_param
)(void *priv
, enum drv_br_net_param param
,
2965 * set_wowlan - Set wake-on-wireless triggers
2966 * @priv: Private driver interface data
2967 * @triggers: wowlan triggers
2969 int (*set_wowlan
)(void *priv
, const struct wowlan_triggers
*triggers
);
2972 * signal_poll - Get current connection information
2973 * @priv: Private driver interface data
2974 * @signal_info: Connection info structure
2976 int (*signal_poll
)(void *priv
, struct wpa_signal_info
*signal_info
);
2979 * set_authmode - Set authentication algorithm(s) for static WEP
2980 * @priv: Private driver interface data
2981 * @authmode: 1=Open System, 2=Shared Key, 3=both
2982 * Returns: 0 on success, -1 on failure
2984 * This function can be used to set authentication algorithms for AP
2985 * mode when static WEP is used. If the driver uses user space MLME/SME
2986 * implementation, there is no need to implement this function.
2988 * DEPRECATED - use set_ap() instead
2990 int (*set_authmode
)(void *priv
, int authmode
);
2994 * driver_cmd - Execute driver-specific command
2995 * @priv: Private driver interface data
2996 * @cmd: Command to execute
2997 * @buf: Return buffer
2998 * @buf_len: Buffer length
2999 * Returns: 0 on success, -1 on failure
3001 int (*driver_cmd
)(void *priv
, char *cmd
, char *buf
, size_t buf_len
);
3002 #endif /* ANDROID */
3005 * vendor_cmd - Execute vendor specific command
3006 * @priv: Private driver interface data
3007 * @vendor_id: Vendor id
3008 * @subcmd: Vendor command id
3009 * @data: Vendor command parameters (%NULL if no parameters)
3010 * @data_len: Data length
3011 * @buf: Return buffer (%NULL to ignore reply)
3012 * Returns: 0 on success, negative (<0) on failure
3014 * This function handles vendor specific commands that are passed to
3015 * the driver/device. The command is identified by vendor id and
3016 * command id. Parameters can be passed as argument to the command
3017 * in the data buffer. Reply (if any) will be filled in the supplied
3020 * The exact driver behavior is driver interface and vendor specific. As
3021 * an example, this will be converted to a vendor specific cfg80211
3022 * command in case of the nl80211 driver interface.
3024 int (*vendor_cmd
)(void *priv
, unsigned int vendor_id
,
3025 unsigned int subcmd
, const u8
*data
, size_t data_len
,
3026 struct wpabuf
*buf
);
3029 * set_rekey_info - Set rekey information
3030 * @priv: Private driver interface data
3032 * @kek_len: KEK length in octets
3034 * @kck_len: KCK length in octets
3035 * @replay_ctr: Current EAPOL-Key Replay Counter
3037 * This optional function can be used to provide information for the
3038 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3039 * while the host (including wpa_supplicant) is sleeping.
3041 void (*set_rekey_info
)(void *priv
, const u8
*kek
, size_t kek_len
,
3042 const u8
*kck
, size_t kck_len
,
3043 const u8
*replay_ctr
);
3046 * sta_assoc - Station association indication
3047 * @priv: Private driver interface data
3048 * @own_addr: Source address and BSSID for association frame
3049 * @addr: MAC address of the station to associate
3050 * @reassoc: flag to indicate re-association
3051 * @status: association response status code
3052 * @ie: assoc response ie buffer
3053 * @len: ie buffer length
3054 * Returns: 0 on success, -1 on failure
3056 * This function indicates the driver to send (Re)Association
3057 * Response frame to the station.
3059 int (*sta_assoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
3060 int reassoc
, u16 status
, const u8
*ie
, size_t len
);
3063 * sta_auth - Station authentication indication
3064 * @priv: Private driver interface data
3065 * @own_addr: Source address and BSSID for authentication frame
3066 * @addr: MAC address of the station to associate
3067 * @seq: authentication sequence number
3068 * @status: authentication response status code
3069 * @ie: authentication frame ie buffer
3070 * @len: ie buffer length
3072 * This function indicates the driver to send Authentication frame
3075 int (*sta_auth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
3076 u16 seq
, u16 status
, const u8
*ie
, size_t len
);
3079 * add_tspec - Add traffic stream
3080 * @priv: Private driver interface data
3081 * @addr: MAC address of the station to associate
3082 * @tspec_ie: tspec ie buffer
3083 * @tspec_ielen: tspec ie length
3084 * Returns: 0 on success, -1 on failure
3086 * This function adds the traffic steam for the station
3087 * and fills the medium_time in tspec_ie.
3089 int (*add_tspec
)(void *priv
, const u8
*addr
, u8
*tspec_ie
,
3090 size_t tspec_ielen
);
3093 * add_sta_node - Add a station node in the driver
3094 * @priv: Private driver interface data
3095 * @addr: MAC address of the station to add
3096 * @auth_alg: authentication algorithm used by the station
3097 * Returns: 0 on success, -1 on failure
3099 * This function adds the station node in the driver, when
3100 * the station gets added by FT-over-DS.
3102 int (*add_sta_node
)(void *priv
, const u8
*addr
, u16 auth_alg
);
3105 * sched_scan - Request the driver to initiate scheduled scan
3106 * @priv: Private driver interface data
3107 * @params: Scan parameters
3108 * Returns: 0 on success, -1 on failure
3110 * This operation should be used for scheduled scan offload to
3111 * the hardware. Every time scan results are available, the
3112 * driver should report scan results event for wpa_supplicant
3113 * which will eventually request the results with
3114 * wpa_driver_get_scan_results2(). This operation is optional
3115 * and if not provided or if it returns -1, we fall back to
3116 * normal host-scheduled scans.
3118 int (*sched_scan
)(void *priv
, struct wpa_driver_scan_params
*params
);
3121 * stop_sched_scan - Request the driver to stop a scheduled scan
3122 * @priv: Private driver interface data
3123 * Returns: 0 on success, -1 on failure
3125 * This should cause the scheduled scan to be stopped and
3126 * results should stop being sent. Must be supported if
3127 * sched_scan is supported.
3129 int (*stop_sched_scan
)(void *priv
);
3132 * poll_client - Probe (null data or such) the given station
3133 * @priv: Private driver interface data
3134 * @own_addr: MAC address of sending interface
3135 * @addr: MAC address of the station to probe
3136 * @qos: Indicates whether station is QoS station
3138 * This function is used to verify whether an associated station is
3139 * still present. This function does not need to be implemented if the
3140 * driver provides such inactivity polling mechanism.
3142 void (*poll_client
)(void *priv
, const u8
*own_addr
,
3143 const u8
*addr
, int qos
);
3146 * radio_disable - Disable/enable radio
3147 * @priv: Private driver interface data
3148 * @disabled: 1=disable 0=enable radio
3149 * Returns: 0 on success, -1 on failure
3151 * This optional command is for testing purposes. It can be used to
3152 * disable the radio on a testbed device to simulate out-of-radio-range
3155 int (*radio_disable
)(void *priv
, int disabled
);
3158 * switch_channel - Announce channel switch and migrate the GO to the
3160 * @priv: Private driver interface data
3161 * @settings: Settings for CSA period and new channel
3162 * Returns: 0 on success, -1 on failure
3164 * This function is used to move the GO to the legacy STA channel to
3165 * avoid frequency conflict in single channel concurrency.
3167 int (*switch_channel
)(void *priv
, struct csa_settings
*settings
);
3170 * add_tx_ts - Add traffic stream
3171 * @priv: Private driver interface data
3172 * @tsid: Traffic stream ID
3173 * @addr: Receiver address
3174 * @user_prio: User priority of the traffic stream
3175 * @admitted_time: Admitted time for this TS in units of
3176 * 32 microsecond periods (per second).
3177 * Returns: 0 on success, -1 on failure
3179 int (*add_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
, u8 user_prio
,
3183 * del_tx_ts - Delete traffic stream
3184 * @priv: Private driver interface data
3185 * @tsid: Traffic stream ID
3186 * @addr: Receiver address
3187 * Returns: 0 on success, -1 on failure
3189 int (*del_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
);
3192 * Enable channel-switching with TDLS peer
3193 * @priv: Private driver interface data
3194 * @addr: MAC address of the TDLS peer
3195 * @oper_class: Operating class of the switch channel
3196 * @params: Channel specification
3197 * Returns: 0 on success, -1 on failure
3199 * The function indicates to driver that it can start switching to a
3200 * different channel with a specified TDLS peer. The switching is
3201 * assumed on until canceled with tdls_disable_channel_switch().
3203 int (*tdls_enable_channel_switch
)(
3204 void *priv
, const u8
*addr
, u8 oper_class
,
3205 const struct hostapd_freq_params
*params
);
3208 * Disable channel switching with TDLS peer
3209 * @priv: Private driver interface data
3210 * @addr: MAC address of the TDLS peer
3211 * Returns: 0 on success, -1 on failure
3213 * This function indicates to the driver that it should stop switching
3214 * with a given TDLS peer.
3216 int (*tdls_disable_channel_switch
)(void *priv
, const u8
*addr
);
3219 * start_dfs_cac - Listen for radar interference on the channel
3220 * @priv: Private driver interface data
3221 * @freq: Channel parameters
3222 * Returns: 0 on success, -1 on failure
3224 int (*start_dfs_cac
)(void *priv
, struct hostapd_freq_params
*freq
);
3227 * stop_ap - Removes beacon from AP
3228 * @priv: Private driver interface data
3229 * Returns: 0 on success, -1 on failure (or if not supported)
3231 * This optional function can be used to disable AP mode related
3232 * configuration. Unlike deinit_ap, it does not change to station
3235 int (*stop_ap
)(void *priv
);
3238 * get_survey - Retrieve survey data
3239 * @priv: Private driver interface data
3240 * @freq: If set, survey data for the specified frequency is only
3241 * being requested. If not set, all survey data is requested.
3242 * Returns: 0 on success, -1 on failure
3244 * Use this to retrieve:
3246 * - the observed channel noise floor
3247 * - the amount of time we have spent on the channel
3248 * - the amount of time during which we have spent on the channel that
3249 * the radio has determined the medium is busy and we cannot
3251 * - the amount of time we have spent receiving data
3252 * - the amount of time we have spent transmitting data
3254 * This data can be used for spectrum heuristics. One example is
3255 * Automatic Channel Selection (ACS). The channel survey data is
3256 * kept on a linked list on the channel data, one entry is added
3257 * for each survey. The min_nf of the channel is updated for each
3260 int (*get_survey
)(void *priv
, unsigned int freq
);
3263 * status - Get driver interface status information
3264 * @priv: Private driver interface data
3265 * @buf: Buffer for printing tou the status information
3266 * @buflen: Maximum length of the buffer
3267 * Returns: Length of written status information or -1 on failure
3269 int (*status
)(void *priv
, char *buf
, size_t buflen
);
3272 * roaming - Set roaming policy for driver-based BSS selection
3273 * @priv: Private driver interface data
3274 * @allowed: Whether roaming within ESS is allowed
3275 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3276 * Returns: Length of written status information or -1 on failure
3278 * This optional callback can be used to update roaming policy from the
3279 * associate() command (bssid being set there indicates that the driver
3280 * should not roam before getting this roaming() call to allow roaming.
3281 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3282 * capability, roaming policy is handled within wpa_supplicant and there
3283 * is no need to implement or react to this callback.
3285 int (*roaming
)(void *priv
, int allowed
, const u8
*bssid
);
3288 * set_mac_addr - Set MAC address
3289 * @priv: Private driver interface data
3290 * @addr: MAC address to use or %NULL for setting back to permanent
3291 * Returns: 0 on success, -1 on failure
3293 int (*set_mac_addr
)(void *priv
, const u8
*addr
);
3295 #ifdef CONFIG_MACSEC
3296 int (*macsec_init
)(void *priv
, struct macsec_init_params
*params
);
3298 int (*macsec_deinit
)(void *priv
);
3301 * enable_protect_frames - Set protect frames status
3302 * @priv: Private driver interface data
3303 * @enabled: TRUE = protect frames enabled
3304 * FALSE = protect frames disabled
3305 * Returns: 0 on success, -1 on failure (or if not supported)
3307 int (*enable_protect_frames
)(void *priv
, Boolean enabled
);
3310 * set_replay_protect - Set replay protect status and window size
3311 * @priv: Private driver interface data
3312 * @enabled: TRUE = replay protect enabled
3313 * FALSE = replay protect disabled
3314 * @window: replay window size, valid only when replay protect enabled
3315 * Returns: 0 on success, -1 on failure (or if not supported)
3317 int (*set_replay_protect
)(void *priv
, Boolean enabled
, u32 window
);
3320 * set_current_cipher_suite - Set current cipher suite
3321 * @priv: Private driver interface data
3322 * @cs: EUI64 identifier
3323 * Returns: 0 on success, -1 on failure (or if not supported)
3325 int (*set_current_cipher_suite
)(void *priv
, u64 cs
);
3328 * enable_controlled_port - Set controlled port status
3329 * @priv: Private driver interface data
3330 * @enabled: TRUE = controlled port enabled
3331 * FALSE = controlled port disabled
3332 * Returns: 0 on success, -1 on failure (or if not supported)
3334 int (*enable_controlled_port
)(void *priv
, Boolean enabled
);
3337 * get_receive_lowest_pn - Get receive lowest pn
3338 * @priv: Private driver interface data
3339 * @sa: secure association
3340 * Returns: 0 on success, -1 on failure (or if not supported)
3342 int (*get_receive_lowest_pn
)(void *priv
, struct receive_sa
*sa
);
3345 * get_transmit_next_pn - Get transmit next pn
3346 * @priv: Private driver interface data
3347 * @sa: secure association
3348 * Returns: 0 on success, -1 on failure (or if not supported)
3350 int (*get_transmit_next_pn
)(void *priv
, struct transmit_sa
*sa
);
3353 * set_transmit_next_pn - Set transmit next pn
3354 * @priv: Private driver interface data
3355 * @sa: secure association
3356 * Returns: 0 on success, -1 on failure (or if not supported)
3358 int (*set_transmit_next_pn
)(void *priv
, struct transmit_sa
*sa
);
3361 * get_available_receive_sc - get available receive channel
3362 * @priv: Private driver interface data
3363 * @channel: secure channel
3364 * Returns: 0 on success, -1 on failure (or if not supported)
3366 int (*get_available_receive_sc
)(void *priv
, u32
*channel
);
3369 * create_receive_sc - create secure channel for receiving
3370 * @priv: Private driver interface data
3371 * @channel: secure channel
3372 * @sci_addr: secure channel identifier - address
3373 * @sci_port: secure channel identifier - port
3374 * @conf_offset: confidentiality offset (0, 30, or 50)
3375 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3377 * Returns: 0 on success, -1 on failure (or if not supported)
3379 int (*create_receive_sc
)(void *priv
, u32 channel
, const u8
*sci_addr
,
3380 u16 sci_port
, unsigned int conf_offset
,
3384 * delete_receive_sc - delete secure connection for receiving
3385 * @priv: private driver interface data from init()
3386 * @channel: secure channel
3387 * Returns: 0 on success, -1 on failure
3389 int (*delete_receive_sc
)(void *priv
, u32 channel
);
3392 * create_receive_sa - create secure association for receive
3393 * @priv: private driver interface data from init()
3394 * @channel: secure channel
3395 * @an: association number
3396 * @lowest_pn: the lowest packet number can be received
3397 * @sak: the secure association key
3398 * Returns: 0 on success, -1 on failure
3400 int (*create_receive_sa
)(void *priv
, u32 channel
, u8 an
,
3401 u32 lowest_pn
, const u8
*sak
);
3404 * enable_receive_sa - enable the SA for receive
3405 * @priv: private driver interface data from init()
3406 * @channel: secure channel
3407 * @an: association number
3408 * Returns: 0 on success, -1 on failure
3410 int (*enable_receive_sa
)(void *priv
, u32 channel
, u8 an
);
3413 * disable_receive_sa - disable SA for receive
3414 * @priv: private driver interface data from init()
3415 * @channel: secure channel index
3416 * @an: association number
3417 * Returns: 0 on success, -1 on failure
3419 int (*disable_receive_sa
)(void *priv
, u32 channel
, u8 an
);
3422 * get_available_transmit_sc - get available transmit channel
3423 * @priv: Private driver interface data
3424 * @channel: secure channel
3425 * Returns: 0 on success, -1 on failure (or if not supported)
3427 int (*get_available_transmit_sc
)(void *priv
, u32
*channel
);
3430 * create_transmit_sc - create secure connection for transmit
3431 * @priv: private driver interface data from init()
3432 * @channel: secure channel
3433 * @sci_addr: secure channel identifier - address
3434 * @sci_port: secure channel identifier - port
3435 * Returns: 0 on success, -1 on failure
3437 int (*create_transmit_sc
)(void *priv
, u32 channel
, const u8
*sci_addr
,
3438 u16 sci_port
, unsigned int conf_offset
);
3441 * delete_transmit_sc - delete secure connection for transmit
3442 * @priv: private driver interface data from init()
3443 * @channel: secure channel
3444 * Returns: 0 on success, -1 on failure
3446 int (*delete_transmit_sc
)(void *priv
, u32 channel
);
3449 * create_transmit_sa - create secure association for transmit
3450 * @priv: private driver interface data from init()
3451 * @channel: secure channel index
3452 * @an: association number
3453 * @next_pn: the packet number used as next transmit packet
3454 * @confidentiality: True if the SA is to provide confidentiality
3455 * as well as integrity
3456 * @sak: the secure association key
3457 * Returns: 0 on success, -1 on failure
3459 int (*create_transmit_sa
)(void *priv
, u32 channel
, u8 an
, u32 next_pn
,
3460 Boolean confidentiality
, const u8
*sak
);
3463 * enable_transmit_sa - enable SA for transmit
3464 * @priv: private driver interface data from init()
3465 * @channel: secure channel
3466 * @an: association number
3467 * Returns: 0 on success, -1 on failure
3469 int (*enable_transmit_sa
)(void *priv
, u32 channel
, u8 an
);
3472 * disable_transmit_sa - disable SA for transmit
3473 * @priv: private driver interface data from init()
3474 * @channel: secure channel
3475 * @an: association number
3476 * Returns: 0 on success, -1 on failure
3478 int (*disable_transmit_sa
)(void *priv
, u32 channel
, u8 an
);
3479 #endif /* CONFIG_MACSEC */
3482 * init_mesh - Driver specific initialization for mesh
3483 * @priv: Private driver interface data
3484 * Returns: 0 on success, -1 on failure
3486 int (*init_mesh
)(void *priv
);
3489 * join_mesh - Join a mesh network
3490 * @priv: Private driver interface data
3491 * @params: Mesh configuration parameters
3492 * Returns: 0 on success, -1 on failure
3494 int (*join_mesh
)(void *priv
,
3495 struct wpa_driver_mesh_join_params
*params
);
3498 * leave_mesh - Leave a mesh network
3499 * @priv: Private driver interface data
3500 * Returns 0 on success, -1 on failure
3502 int (*leave_mesh
)(void *priv
);
3505 * do_acs - Automatically select channel
3506 * @priv: Private driver interface data
3507 * @params: Parameters for ACS
3508 * Returns 0 on success, -1 on failure
3510 * This command can be used to offload ACS to the driver if the driver
3511 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3513 int (*do_acs
)(void *priv
, struct drv_acs_params
*params
);
3516 * set_band - Notify driver of band selection
3517 * @priv: Private driver interface data
3518 * @band: The selected band(s)
3519 * Returns 0 on success, -1 on failure
3521 int (*set_band
)(void *priv
, enum set_band band
);
3524 * get_pref_freq_list - Get preferred frequency list for an interface
3525 * @priv: Private driver interface data
3526 * @if_type: Interface type
3527 * @num: Number of channels
3528 * @freq_list: Preferred channel frequency list encoded in MHz values
3529 * Returns 0 on success, -1 on failure
3531 * This command can be used to query the preferred frequency list from
3532 * the driver specific to a particular interface type.
3534 int (*get_pref_freq_list
)(void *priv
, enum wpa_driver_if_type if_type
,
3535 unsigned int *num
, unsigned int *freq_list
);
3538 * set_prob_oper_freq - Indicate probable P2P operating channel
3539 * @priv: Private driver interface data
3540 * @freq: Channel frequency in MHz
3541 * Returns 0 on success, -1 on failure
3543 * This command can be used to inform the driver of the operating
3544 * frequency that an ongoing P2P group formation is likely to come up
3545 * on. Local device is assuming P2P Client role.
3547 int (*set_prob_oper_freq
)(void *priv
, unsigned int freq
);
3550 * abort_scan - Request the driver to abort an ongoing scan
3551 * @priv: Private driver interface data
3552 * Returns 0 on success, -1 on failure
3554 int (*abort_scan
)(void *priv
);
3557 * configure_data_frame_filters - Request to configure frame filters
3558 * @priv: Private driver interface data
3559 * @filter_flags: The type of frames to filter (bitfield of
3560 * WPA_DATA_FRAME_FILTER_FLAG_*)
3561 * Returns: 0 on success or -1 on failure
3563 int (*configure_data_frame_filters
)(void *priv
, u32 filter_flags
);
3566 * get_ext_capab - Get extended capabilities for the specified interface
3567 * @priv: Private driver interface data
3568 * @type: Interface type for which to get extended capabilities
3569 * @ext_capab: Extended capabilities fetched
3570 * @ext_capab_mask: Extended capabilities mask
3571 * @ext_capab_len: Length of the extended capabilities
3572 * Returns: 0 on success or -1 on failure
3574 int (*get_ext_capab
)(void *priv
, enum wpa_driver_if_type type
,
3575 const u8
**ext_capab
, const u8
**ext_capab_mask
,
3576 unsigned int *ext_capab_len
);
3579 * p2p_lo_start - Start offloading P2P listen to device
3580 * @priv: Private driver interface data
3581 * @freq: Listening frequency (MHz) for P2P listen
3582 * @period: Length of the listen operation in milliseconds
3583 * @interval: Interval for running the listen operation in milliseconds
3584 * @count: Number of times to run the listen operation
3585 * @device_types: Device primary and secondary types
3586 * @dev_types_len: Number of bytes for device_types
3587 * @ies: P2P IE and WSC IE for Probe Response frames
3588 * @ies_len: Length of ies in bytes
3589 * Returns: 0 on success or -1 on failure
3591 int (*p2p_lo_start
)(void *priv
, unsigned int freq
,
3592 unsigned int period
, unsigned int interval
,
3594 const u8
*device_types
, size_t dev_types_len
,
3595 const u8
*ies
, size_t ies_len
);
3598 * p2p_lo_stop - Stop P2P listen offload
3599 * @priv: Private driver interface data
3600 * Returns: 0 on success or -1 on failure
3602 int (*p2p_lo_stop
)(void *priv
);
3605 * set_default_scan_ies - Set default scan IEs
3606 * @priv: Private driver interface data
3607 * @ies: Scan default IEs buffer
3608 * @ies_len: Length of IEs in bytes
3609 * Returns: 0 on success or -1 on failure
3611 * The driver can use these by default when there are no scan IEs coming
3612 * in the subsequent scan requests. Also in case of one or more of IEs
3613 * given in set_default_scan_ies() are missing in the subsequent scan
3614 * request, the driver should merge the missing scan IEs in the scan
3615 * request from the IEs set by set_default_scan_ies() in the Probe
3616 * Request frames sent.
3618 int (*set_default_scan_ies
)(void *priv
, const u8
*ies
, size_t ies_len
);
3624 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3626 enum wpa_event_type
{
3628 * EVENT_ASSOC - Association completed
3630 * This event needs to be delivered when the driver completes IEEE
3631 * 802.11 association or reassociation successfully.
3632 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3633 * after this event has been generated. In addition, optional
3634 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3635 * more information about the association. If the driver interface gets
3636 * both of these events at the same time, it can also include the
3637 * assoc_info data in EVENT_ASSOC call.
3642 * EVENT_DISASSOC - Association lost
3644 * This event should be called when association is lost either due to
3645 * receiving deauthenticate or disassociate frame from the AP or when
3646 * sending either of these frames to the current AP. If the driver
3647 * supports separate deauthentication event, EVENT_DISASSOC should only
3648 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3649 * In AP mode, union wpa_event_data::disassoc_info is required.
3654 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3656 * This event must be delivered when a Michael MIC error is detected by
3657 * the local driver. Additional data for event processing is
3658 * provided with union wpa_event_data::michael_mic_failure. This
3659 * information is used to request new encyption key and to initiate
3660 * TKIP countermeasures if needed.
3662 EVENT_MICHAEL_MIC_FAILURE
,
3665 * EVENT_SCAN_RESULTS - Scan results available
3667 * This event must be called whenever scan results are available to be
3668 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3669 * is expected to be used some time after struct wpa_driver_ops::scan()
3670 * is called. If the driver provides an unsolicited event when the scan
3671 * has been completed, this event can be used to trigger
3672 * EVENT_SCAN_RESULTS call. If such event is not available from the
3673 * driver, the driver wrapper code is expected to use a registered
3674 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3675 * scan is expected to be completed. Optional information about
3676 * completed scan can be provided with union wpa_event_data::scan_info.
3681 * EVENT_ASSOCINFO - Report optional extra information for association
3683 * This event can be used to report extra association information for
3684 * EVENT_ASSOC processing. This extra information includes IEs from
3685 * association frames and Beacon/Probe Response frames in union
3686 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3687 * EVENT_ASSOC. Alternatively, the driver interface can include
3688 * assoc_info data in the EVENT_ASSOC call if it has all the
3689 * information available at the same point.
3694 * EVENT_INTERFACE_STATUS - Report interface status changes
3696 * This optional event can be used to report changes in interface
3697 * status (interface added/removed) using union
3698 * wpa_event_data::interface_status. This can be used to trigger
3699 * wpa_supplicant to stop and re-start processing for the interface,
3700 * e.g., when a cardbus card is ejected/inserted.
3702 EVENT_INTERFACE_STATUS
,
3705 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3707 * This event can be used to inform wpa_supplicant about candidates for
3708 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3709 * for scan request (ap_scan=2 mode), this event is required for
3710 * pre-authentication. If wpa_supplicant is performing scan request
3711 * (ap_scan=1), this event is optional since scan results can be used
3712 * to add pre-authentication candidates. union
3713 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3714 * candidate and priority of the candidate, e.g., based on the signal
3715 * strength, in order to try to pre-authenticate first with candidates
3716 * that are most likely targets for re-association.
3718 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3719 * on the candidate list. In addition, it can be called for the current
3720 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3721 * will automatically skip pre-authentication in cases where a valid
3722 * PMKSA exists. When more than one candidate exists, this event should
3723 * be generated once for each candidate.
3725 * Driver will be notified about successful pre-authentication with
3726 * struct wpa_driver_ops::add_pmkid() calls.
3728 EVENT_PMKID_CANDIDATE
,
3731 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3733 * This event can be used to inform wpa_supplicant about desire to set
3734 * up secure direct link connection between two stations as defined in
3735 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3736 * STAKey negotiation. The caller will need to set peer address for the
3742 * EVENT_TDLS - Request TDLS operation
3744 * This event can be used to request a TDLS operation to be performed.
3749 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3751 * The driver is expected to report the received FT IEs from
3752 * FT authentication sequence from the AP. The FT IEs are included in
3753 * the extra information in union wpa_event_data::ft_ies.
3758 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3760 * The driver can use this event to inform wpa_supplicant about a STA
3761 * in an IBSS with which protected frames could be exchanged. This
3762 * event starts RSN authentication with the other STA to authenticate
3763 * the STA and set up encryption keys with it.
3765 EVENT_IBSS_RSN_START
,
3768 * EVENT_AUTH - Authentication result
3770 * This event should be called when authentication attempt has been
3771 * completed. This is only used if the driver supports separate
3772 * authentication step (struct wpa_driver_ops::authenticate).
3773 * Information about authentication result is included in
3774 * union wpa_event_data::auth.
3779 * EVENT_DEAUTH - Authentication lost
3781 * This event should be called when authentication is lost either due
3782 * to receiving deauthenticate frame from the AP or when sending that
3783 * frame to the current AP.
3784 * In AP mode, union wpa_event_data::deauth_info is required.
3789 * EVENT_ASSOC_REJECT - Association rejected
3791 * This event should be called when (re)association attempt has been
3792 * rejected by the AP. Information about the association response is
3793 * included in union wpa_event_data::assoc_reject.
3798 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3800 EVENT_AUTH_TIMED_OUT
,
3803 * EVENT_ASSOC_TIMED_OUT - Association timed out
3805 EVENT_ASSOC_TIMED_OUT
,
3808 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3810 EVENT_WPS_BUTTON_PUSHED
,
3813 * EVENT_TX_STATUS - Report TX status
3818 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3820 EVENT_RX_FROM_UNKNOWN
,
3823 * EVENT_RX_MGMT - Report RX of a management frame
3828 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3830 * This event is used to indicate when the driver has started the
3831 * requested remain-on-channel duration. Information about the
3832 * operation is included in union wpa_event_data::remain_on_channel.
3834 EVENT_REMAIN_ON_CHANNEL
,
3837 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3839 * This event is used to indicate when the driver has completed
3840 * remain-on-channel duration, i.e., may noot be available on the
3841 * requested channel anymore. Information about the
3842 * operation is included in union wpa_event_data::remain_on_channel.
3844 EVENT_CANCEL_REMAIN_ON_CHANNEL
,
3847 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3849 * This event is used to indicate when a Probe Request frame has been
3850 * received. Information about the received frame is included in
3851 * union wpa_event_data::rx_probe_req. The driver is required to report
3852 * these events only after successfully completed probe_req_report()
3853 * commands to request the events (i.e., report parameter is non-zero)
3854 * in station mode. In AP mode, Probe Request frames should always be
3860 * EVENT_NEW_STA - New wired device noticed
3862 * This event is used to indicate that a new device has been detected
3863 * in a network that does not use association-like functionality (i.e.,
3864 * mainly wired Ethernet). This can be used to start EAPOL
3865 * authenticator when receiving a frame from a device. The address of
3866 * the device is included in union wpa_event_data::new_sta.
3871 * EVENT_EAPOL_RX - Report received EAPOL frame
3873 * When in AP mode with hostapd, this event is required to be used to
3874 * deliver the receive EAPOL frames from the driver.
3879 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3881 * This event is used to indicate changes in the signal strength
3882 * observed in frames received from the current AP if signal strength
3883 * monitoring has been enabled with signal_monitor().
3885 EVENT_SIGNAL_CHANGE
,
3888 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3890 * This event is used to indicate that the interface was enabled after
3891 * having been previously disabled, e.g., due to rfkill.
3893 EVENT_INTERFACE_ENABLED
,
3896 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3898 * This event is used to indicate that the interface was disabled,
3899 * e.g., due to rfkill.
3901 EVENT_INTERFACE_DISABLED
,
3904 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3906 * This event is used to indicate that the channel list has changed,
3907 * e.g., because of a regulatory domain change triggered by scan
3908 * results including an AP advertising a country code.
3910 EVENT_CHANNEL_LIST_CHANGED
,
3913 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3915 * This event is used to indicate that the driver cannot maintain this
3916 * interface in its operation mode anymore. The most likely use for
3917 * this is to indicate that AP mode operation is not available due to
3918 * operating channel would need to be changed to a DFS channel when
3919 * the driver does not support radar detection and another virtual
3920 * interfaces caused the operating channel to change. Other similar
3921 * resource conflicts could also trigger this for station mode
3922 * interfaces. This event can be propagated when channel switching
3925 EVENT_INTERFACE_UNAVAILABLE
,
3928 * EVENT_BEST_CHANNEL
3930 * Driver generates this event whenever it detects a better channel
3931 * (e.g., based on RSSI or channel use). This information can be used
3932 * to improve channel selection for a new AP/P2P group.
3937 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3939 * This event should be called when a Deauthentication frame is dropped
3940 * due to it not being protected (MFP/IEEE 802.11w).
3941 * union wpa_event_data::unprot_deauth is required to provide more
3942 * details of the frame.
3944 EVENT_UNPROT_DEAUTH
,
3947 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3949 * This event should be called when a Disassociation frame is dropped
3950 * due to it not being protected (MFP/IEEE 802.11w).
3951 * union wpa_event_data::unprot_disassoc is required to provide more
3952 * details of the frame.
3954 EVENT_UNPROT_DISASSOC
,
3957 * EVENT_STATION_LOW_ACK
3959 * Driver generates this event whenever it detected that a particular
3960 * station was lost. Detection can be through massive transmission
3961 * failures for example.
3963 EVENT_STATION_LOW_ACK
,
3966 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3968 EVENT_IBSS_PEER_LOST
,
3971 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3973 * This event carries the new replay counter to notify wpa_supplicant
3974 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3975 * completed Group Key Handshake while the host (including
3976 * wpa_supplicant was sleeping).
3978 EVENT_DRIVER_GTK_REKEY
,
3981 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3983 EVENT_SCHED_SCAN_STOPPED
,
3986 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3988 * This event indicates that the station responded to the poll
3989 * initiated with @poll_client.
3991 EVENT_DRIVER_CLIENT_POLL_OK
,
3994 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3996 EVENT_EAPOL_TX_STATUS
,
3999 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4001 * Described in wpa_event_data.ch_switch
4006 * EVENT_WNM - Request WNM operation
4008 * This event can be used to request a WNM operation to be performed.
4013 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4015 * This event indicates that the driver reported a connection failure
4016 * with the specified client (for example, max client reached, etc.) in
4019 EVENT_CONNECT_FAILED_REASON
,
4022 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
4024 * A radar has been detected on the supplied frequency, hostapd should
4025 * react accordingly (e.g., change channel).
4027 EVENT_DFS_RADAR_DETECTED
,
4030 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
4032 * After a successful CAC, the channel can be marked clear and used.
4034 EVENT_DFS_CAC_FINISHED
,
4037 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
4039 * The CAC was not successful, and the channel remains in the previous
4040 * state. This may happen due to a radar beeing detected or other
4041 * external influences.
4043 EVENT_DFS_CAC_ABORTED
,
4046 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
4048 * The channel which was previously unavailable is now available again.
4050 EVENT_DFS_NOP_FINISHED
,
4053 * EVENT_SURVEY - Received survey data
4055 * This event gets triggered when a driver query is issued for survey
4056 * data and the requested data becomes available. The returned data is
4057 * stored in struct survey_results. The results provide at most one
4058 * survey entry for each frequency and at minimum will provide one
4059 * survey entry for one frequency. The survey data can be os_malloc()'d
4060 * and then os_free()'d, so the event callback must only copy data.
4065 * EVENT_SCAN_STARTED - Scan started
4067 * This indicates that driver has started a scan operation either based
4068 * on a request from wpa_supplicant/hostapd or from another application.
4069 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4070 * completed (either successfully or by getting cancelled).
4075 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4077 * This event indicates a set of frequency ranges that should be avoided
4078 * to reduce issues due to interference or internal co-existence
4079 * information in the driver.
4081 EVENT_AVOID_FREQUENCIES
,
4084 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4086 EVENT_NEW_PEER_CANDIDATE
,
4089 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4091 * Indicates a pair of primary and secondary channels chosen by ACS
4094 EVENT_ACS_CHANNEL_SELECTED
,
4097 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4100 * This event indicates that channel availability check has been started
4101 * on a DFS frequency by a driver that supports DFS Offload.
4103 EVENT_DFS_CAC_STARTED
,
4106 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4113 * struct freq_survey - Channel survey info
4115 * @ifidx: Interface index in which this survey was observed
4116 * @freq: Center of frequency of the surveyed channel
4117 * @nf: Channel noise floor in dBm
4118 * @channel_time: Amount of time in ms the radio spent on the channel
4119 * @channel_time_busy: Amount of time in ms the radio detected some signal
4120 * that indicated to the radio the channel was not clear
4121 * @channel_time_rx: Amount of time the radio spent receiving data
4122 * @channel_time_tx: Amount of time the radio spent transmitting data
4123 * @filled: bitmask indicating which fields have been reported, see
4124 * SURVEY_HAS_* defines.
4125 * @list: Internal list pointers
4127 struct freq_survey
{
4132 u64 channel_time_busy
;
4133 u64 channel_time_rx
;
4134 u64 channel_time_tx
;
4135 unsigned int filled
;
4136 struct dl_list list
;
4139 #define SURVEY_HAS_NF BIT(0)
4140 #define SURVEY_HAS_CHAN_TIME BIT(1)
4141 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4142 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4143 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4147 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4149 union wpa_event_data
{
4151 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4153 * This structure is optional for EVENT_ASSOC calls and required for
4154 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4155 * driver interface does not need to generate separate EVENT_ASSOCINFO
4160 * reassoc - Flag to indicate association or reassociation
4165 * req_ies - (Re)Association Request IEs
4167 * If the driver generates WPA/RSN IE, this event data must be
4168 * returned for WPA handshake to have needed information. If
4169 * wpa_supplicant-generated WPA/RSN IE is used, this
4170 * information event is optional.
4172 * This should start with the first IE (fixed fields before IEs
4173 * are not included).
4178 * req_ies_len - Length of req_ies in bytes
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 * beacon_ies - Beacon or Probe Response IEs
4203 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4204 * Probe Response frames from the current AP (i.e., the one
4205 * that the client just associated with). This information is
4206 * used to update WPA/RSN IE for the AP. If this field is not
4207 * set, the results from previous scan will be used. If no
4208 * data for the new AP is found, scan results will be requested
4209 * again (without scan request). At this point, the driver is
4210 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4213 * This should start with the first IE (fixed fields before IEs
4214 * are not included).
4216 const u8
*beacon_ies
;
4219 * beacon_ies_len - Length of beacon_ies */
4220 size_t beacon_ies_len
;
4223 * freq - Frequency of the operational channel in MHz
4228 * wmm_params - WMM parameters used in this association.
4230 struct wmm_params wmm_params
;
4233 * addr - Station address (for AP mode)
4238 * The following is the key management offload information
4241 * @key_replay_ctr_len
4249 * authorized - Status of key management offload,
4255 * key_replay_ctr - Key replay counter value last used
4256 * in a valid EAPOL-Key frame
4258 const u8
*key_replay_ctr
;
4261 * key_replay_ctr_len - The length of key_replay_ctr
4263 size_t key_replay_ctr_len
;
4266 * ptk_kck - The derived PTK KCK
4271 * ptk_kek_len - The length of ptk_kck
4276 * ptk_kek - The derived PTK KEK
4281 * ptk_kek_len - The length of ptk_kek
4286 * subnet_status - The subnet status:
4287 * 0 = unknown, 1 = unchanged, 2 = changed
4293 * struct disassoc_info - Data for EVENT_DISASSOC events
4295 struct disassoc_info
{
4297 * addr - Station address (for AP mode)
4302 * reason_code - Reason Code (host byte order) used in
4303 * Deauthentication frame
4308 * ie - Optional IE(s) in Disassociation frame
4313 * ie_len - Length of ie buffer in octets
4318 * locally_generated - Whether the frame was locally generated
4320 int locally_generated
;
4324 * struct deauth_info - Data for EVENT_DEAUTH events
4326 struct deauth_info
{
4328 * addr - Station address (for AP mode)
4333 * reason_code - Reason Code (host byte order) used in
4334 * Deauthentication frame
4339 * ie - Optional IE(s) in Deauthentication frame
4344 * ie_len - Length of ie buffer in octets
4349 * locally_generated - Whether the frame was locally generated
4351 int locally_generated
;
4355 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4357 struct michael_mic_failure
{
4360 } michael_mic_failure
;
4363 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4365 struct interface_status
{
4366 unsigned int ifindex
;
4369 EVENT_INTERFACE_ADDED
, EVENT_INTERFACE_REMOVED
4374 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4376 struct pmkid_candidate
{
4377 /** BSSID of the PMKID candidate */
4379 /** Smaller the index, higher the priority */
4381 /** Whether RSN IE includes pre-authenticate flag */
4386 * struct stkstart - Data for EVENT_STKSTART
4393 * struct tdls - Data for EVENT_TDLS
4399 TDLS_REQUEST_TEARDOWN
,
4400 TDLS_REQUEST_DISCOVER
,
4402 u16 reason_code
; /* for teardown */
4406 * struct wnm - Data for EVENT_WNM
4424 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4426 * During FT (IEEE 802.11r) authentication sequence, the driver is
4427 * expected to use this event to report received FT IEs (MDIE, FTIE,
4428 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4429 * IEs for the next message will be delivered through the
4430 * struct wpa_driver_ops::update_ft_ies() callback.
4436 u8 target_ap
[ETH_ALEN
];
4437 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4439 /** Length of ric_ies buffer in octets */
4444 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4446 struct ibss_rsn_start
{
4451 * struct auth_info - Data for EVENT_AUTH events
4457 u16 auth_transaction
;
4464 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4466 struct assoc_reject
{
4468 * bssid - BSSID of the AP that rejected association
4473 * resp_ies - (Re)Association Response IEs
4475 * Optional association data from the driver. This data is not
4476 * required WPA, but may be useful for some protocols and as
4477 * such, should be reported if this is available to the driver
4480 * This should start with the first IE (fixed fields before IEs
4481 * are not included).
4486 * resp_ies_len - Length of resp_ies in bytes
4488 size_t resp_ies_len
;
4491 * status_code - Status Code from (Re)association Response
4496 * timed_out - Whether failure is due to timeout (etc.) rather
4497 * than explicit rejection response from the AP.
4502 struct timeout_event
{
4507 * struct tx_status - Data for EVENT_TX_STATUS events
4519 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4521 struct rx_from_unknown
{
4528 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4536 * drv_priv - Pointer to store driver private BSS information
4538 * If not set to NULL, this is used for comparison with
4539 * hostapd_data->drv_priv to determine which BSS should process
4545 * freq - Frequency (in MHz) on which the frame was received
4550 * ssi_signal - Signal strength in dBm (or 0 if not available)
4556 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4558 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4560 struct remain_on_channel
{
4562 * freq - Channel frequency in MHz
4567 * duration - Duration to remain on the channel in milliseconds
4569 unsigned int duration
;
4570 } remain_on_channel
;
4573 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4574 * @aborted: Whether the scan was aborted
4575 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4576 * @num_freqs: Number of entries in freqs array
4577 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4579 * @num_ssids: Number of entries in ssids array
4580 * @external_scan: Whether the scan info is for an external scan
4581 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
4582 * 0 if the source of the scan event is a vendor scan
4588 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
4595 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4597 struct rx_probe_req
{
4599 * sa - Source address of the received Probe Request frame
4604 * da - Destination address of the received Probe Request frame
4605 * or %NULL if not available
4610 * bssid - BSSID of the received Probe Request frame or %NULL
4616 * ie - IEs from the Probe Request body
4621 * ie_len - Length of ie buffer in octets
4626 * signal - signal strength in dBm (or 0 if not available)
4632 * struct new_sta - Data for EVENT_NEW_STA events
4639 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4648 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4650 struct wpa_signal_info signal_change
;
4653 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4654 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4655 * @freq_5: Best 5 GHz band channel frequency in MHz
4656 * @freq_overall: Best channel frequency in MHz
4658 * 0 can be used to indicate no preference in either band.
4660 struct best_channel
{
4666 struct unprot_deauth
{
4672 struct unprot_disassoc
{
4679 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4680 * @addr: station address
4687 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4689 struct ibss_peer_lost
{
4694 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4696 struct driver_gtk_rekey
{
4698 const u8
*replay_ctr
;
4702 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4703 * @addr: station address
4705 struct client_poll
{
4710 * struct eapol_tx_status
4711 * @dst: Original destination
4712 * @data: Data starting with IEEE 802.1X header (!)
4713 * @data_len: Length of data
4714 * @ack: Indicates ack or lost frame
4716 * This corresponds to hapd_send_eapol if the frame sent
4717 * there isn't just reported as EVENT_TX_STATUS.
4719 struct eapol_tx_status
{
4728 * @freq: Frequency of new channel in MHz
4729 * @ht_enabled: Whether this is an HT channel
4730 * @ch_offset: Secondary channel offset
4731 * @ch_width: Channel width
4732 * @cf1: Center frequency 1
4733 * @cf2: Center frequency 2
4739 enum chan_width ch_width
;
4745 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4746 * @addr: Remote client address
4747 * @code: Reason code for connection failure
4749 struct connect_failed_reason
{
4755 } connect_failed_reason
;
4758 * struct dfs_event - Data for radar detected events
4759 * @freq: Frequency of the channel in MHz
4765 enum chan_width chan_width
;
4771 * survey_results - Survey result data for EVENT_SURVEY
4772 * @freq_filter: Requested frequency survey filter, 0 if request
4773 * was for all survey data
4774 * @survey_list: Linked list of survey data (struct freq_survey)
4776 struct survey_results
{
4777 unsigned int freq_filter
;
4778 struct dl_list survey_list
; /* struct freq_survey */
4782 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4783 * @initiator: Initiator of the regulatory change
4784 * @type: Regulatory change type
4785 * @alpha2: Country code (or "" if not available)
4787 struct channel_list_changed
{
4788 enum reg_change_initiator initiator
;
4791 } channel_list_changed
;
4794 * freq_range - List of frequency ranges
4796 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4798 struct wpa_freq_range_list freq_range
;
4803 * @peer: Peer address
4805 * @ie_len: Length of @ies
4807 * Notification of new candidate mesh peer.
4816 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4817 * @pri_channel: Selected primary channel
4818 * @sec_channel: Selected secondary channel
4819 * @vht_seg0_center_ch: VHT mode Segment0 center channel
4820 * @vht_seg1_center_ch: VHT mode Segment1 center channel
4821 * @ch_width: Selected Channel width by driver. Driver may choose to
4822 * change hostapd configured ACS channel width due driver internal
4823 * channel restrictions.
4824 * hw_mode: Selected band (used with hw_mode=any)
4826 struct acs_selected_channels
{
4829 u8 vht_seg0_center_ch
;
4830 u8 vht_seg1_center_ch
;
4832 enum hostapd_hw_mode hw_mode
;
4833 } acs_selected_channels
;
4836 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
4837 * @reason_code: Reason for stopping offload
4838 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
4840 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
4842 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
4844 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
4845 * supported by device.
4847 struct p2p_lo_stop
{
4849 P2P_LO_STOPPED_REASON_COMPLETE
= 0,
4850 P2P_LO_STOPPED_REASON_RECV_STOP_CMD
,
4851 P2P_LO_STOPPED_REASON_INVALID_PARAM
,
4852 P2P_LO_STOPPED_REASON_NOT_SUPPORTED
,
4858 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4859 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4860 * with struct wpa_driver_ops::init()
4861 * @event: event type (defined above)
4862 * @data: possible extra data for the event
4864 * Driver wrapper code should call this function whenever an event is received
4867 void wpa_supplicant_event(void *ctx
, enum wpa_event_type event
,
4868 union wpa_event_data
*data
);
4871 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
4872 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4873 * with struct wpa_driver_ops::init()
4874 * @event: event type (defined above)
4875 * @data: possible extra data for the event
4877 * Same as wpa_supplicant_event(), but we search for the interface in
4880 void wpa_supplicant_event_global(void *ctx
, enum wpa_event_type event
,
4881 union wpa_event_data
*data
);
4884 * The following inline functions are provided for convenience to simplify
4885 * event indication for some of the common events.
4888 static inline void drv_event_assoc(void *ctx
, const u8
*addr
, const u8
*ie
,
4889 size_t ielen
, int reassoc
)
4891 union wpa_event_data event
;
4892 os_memset(&event
, 0, sizeof(event
));
4893 event
.assoc_info
.reassoc
= reassoc
;
4894 event
.assoc_info
.req_ies
= ie
;
4895 event
.assoc_info
.req_ies_len
= ielen
;
4896 event
.assoc_info
.addr
= addr
;
4897 wpa_supplicant_event(ctx
, EVENT_ASSOC
, &event
);
4900 static inline void drv_event_disassoc(void *ctx
, const u8
*addr
)
4902 union wpa_event_data event
;
4903 os_memset(&event
, 0, sizeof(event
));
4904 event
.disassoc_info
.addr
= addr
;
4905 wpa_supplicant_event(ctx
, EVENT_DISASSOC
, &event
);
4908 static inline void drv_event_eapol_rx(void *ctx
, const u8
*src
, const u8
*data
,
4911 union wpa_event_data event
;
4912 os_memset(&event
, 0, sizeof(event
));
4913 event
.eapol_rx
.src
= src
;
4914 event
.eapol_rx
.data
= data
;
4915 event
.eapol_rx
.data_len
= data_len
;
4916 wpa_supplicant_event(ctx
, EVENT_EAPOL_RX
, &event
);
4919 /* driver_common.c */
4920 void wpa_scan_results_free(struct wpa_scan_results
*res
);
4922 /* Convert wpa_event_type to a string for logging */
4923 const char * event_to_string(enum wpa_event_type event
);
4925 /* Convert chan_width to a string for logging and control interfaces */
4926 const char * channel_width_to_string(enum chan_width width
);
4928 int ht_supported(const struct hostapd_hw_modes
*mode
);
4929 int vht_supported(const struct hostapd_hw_modes
*mode
);
4931 struct wowlan_triggers
*
4932 wpa_get_wowlan_triggers(const char *wowlan_triggers
,
4933 const struct wpa_driver_capa
*capa
);
4934 /* Convert driver flag to string */
4935 const char * driver_flag_to_string(u64 flag
);
4937 /* NULL terminated array of linked in driver wrappers */
4938 extern const struct wpa_driver_ops
*const wpa_drivers
[];
4941 /* Available drivers */
4943 #ifdef CONFIG_DRIVER_WEXT
4944 extern const struct wpa_driver_ops wpa_driver_wext_ops
; /* driver_wext.c */
4945 #endif /* CONFIG_DRIVER_WEXT */
4946 #ifdef CONFIG_DRIVER_NL80211
4947 /* driver_nl80211.c */
4948 extern const struct wpa_driver_ops wpa_driver_nl80211_ops
;
4949 #endif /* CONFIG_DRIVER_NL80211 */
4950 #ifdef CONFIG_DRIVER_HOSTAP
4951 extern const struct wpa_driver_ops wpa_driver_hostap_ops
; /* driver_hostap.c */
4952 #endif /* CONFIG_DRIVER_HOSTAP */
4953 #ifdef CONFIG_DRIVER_BSD
4954 extern const struct wpa_driver_ops wpa_driver_bsd_ops
; /* driver_bsd.c */
4955 #endif /* CONFIG_DRIVER_BSD */
4956 #ifdef CONFIG_DRIVER_OPENBSD
4957 /* driver_openbsd.c */
4958 extern const struct wpa_driver_ops wpa_driver_openbsd_ops
;
4959 #endif /* CONFIG_DRIVER_OPENBSD */
4960 #ifdef CONFIG_DRIVER_NDIS
4961 extern struct wpa_driver_ops wpa_driver_ndis_ops
; /* driver_ndis.c */
4962 #endif /* CONFIG_DRIVER_NDIS */
4963 #ifdef CONFIG_DRIVER_WIRED
4964 extern const struct wpa_driver_ops wpa_driver_wired_ops
; /* driver_wired.c */
4965 #endif /* CONFIG_DRIVER_WIRED */
4966 #ifdef CONFIG_DRIVER_MACSEC_QCA
4967 /* driver_macsec_qca.c */
4968 extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops
;
4969 #endif /* CONFIG_DRIVER_MACSEC_QCA */
4970 #ifdef CONFIG_DRIVER_ROBOSWITCH
4971 /* driver_roboswitch.c */
4972 extern const struct wpa_driver_ops wpa_driver_roboswitch_ops
;
4973 #endif /* CONFIG_DRIVER_ROBOSWITCH */
4974 #ifdef CONFIG_DRIVER_ATHEROS
4975 /* driver_atheros.c */
4976 extern const struct wpa_driver_ops wpa_driver_atheros_ops
;
4977 #endif /* CONFIG_DRIVER_ATHEROS */
4978 #ifdef CONFIG_DRIVER_NONE
4979 extern const struct wpa_driver_ops wpa_driver_none_ops
; /* driver_none.c */
4980 #endif /* CONFIG_DRIVER_NONE */
4982 #endif /* DRIVER_H */