2 * Driver interface definition
3 * Copyright (c) 2003-2017, 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"
24 #include "common/wpa_common.h"
26 #include "pae/ieee802_1x_kay.h"
27 #endif /* CONFIG_MACSEC */
28 #include "utils/list.h"
30 #define HOSTAPD_CHAN_DISABLED 0x00000001
31 #define HOSTAPD_CHAN_NO_IR 0x00000002
32 #define HOSTAPD_CHAN_RADAR 0x00000008
33 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
34 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
35 #define HOSTAPD_CHAN_HT40 0x00000040
36 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
38 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
39 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
40 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
41 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
42 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
44 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
45 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
46 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
47 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
49 #define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
50 #define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
52 #define HOSTAPD_CHAN_VHT_10_150 0x00100000
53 #define HOSTAPD_CHAN_VHT_30_130 0x00200000
54 #define HOSTAPD_CHAN_VHT_50_110 0x00400000
55 #define HOSTAPD_CHAN_VHT_70_90 0x00800000
56 #define HOSTAPD_CHAN_VHT_90_70 0x01000000
57 #define HOSTAPD_CHAN_VHT_110_50 0x02000000
58 #define HOSTAPD_CHAN_VHT_130_30 0x04000000
59 #define HOSTAPD_CHAN_VHT_150_10 0x08000000
61 /* Allowed bandwidth mask */
62 enum hostapd_chan_width_attr
{
63 HOSTAPD_CHAN_WIDTH_10
= BIT(0),
64 HOSTAPD_CHAN_WIDTH_20
= BIT(1),
65 HOSTAPD_CHAN_WIDTH_40P
= BIT(2),
66 HOSTAPD_CHAN_WIDTH_40M
= BIT(3),
67 HOSTAPD_CHAN_WIDTH_80
= BIT(4),
68 HOSTAPD_CHAN_WIDTH_160
= BIT(5),
71 /* Filter gratuitous ARP */
72 #define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
73 /* Filter unsolicited Neighbor Advertisement */
74 #define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
75 /* Filter unicast IP packets encrypted using the GTK */
76 #define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)
78 #define HOSTAPD_DFS_REGION_FCC 1
79 #define HOSTAPD_DFS_REGION_ETSI 2
80 #define HOSTAPD_DFS_REGION_JP 3
83 * enum reg_change_initiator - Regulatory change initiator
85 enum reg_change_initiator
{
89 REGDOM_SET_BY_COUNTRY_IE
,
94 * enum reg_type - Regulatory change types
100 REGDOM_TYPE_CUSTOM_WORLD
,
101 REGDOM_TYPE_INTERSECTION
,
105 * struct hostapd_wmm_rule - WMM regulatory rule
106 * @min_cwmin: Lower bound of CW_min value
107 * @min_cwmax: Lower bound of CW_max value
108 * @min_aifs: Lower bound of AIFS value
109 * @max_txop: Upper bound of TXOP, value in units of 32 usec
111 struct hostapd_wmm_rule
{
119 * struct hostapd_channel_data - Channel information
121 struct hostapd_channel_data
{
123 * chan - Channel number (IEEE 802.11)
128 * freq - Frequency in MHz
133 * flag - Channel flags (HOSTAPD_CHAN_*)
138 * allowed_bw - Allowed channel width bitmask
140 * See enum hostapd_chan_width_attr.
145 * max_tx_power - Regulatory transmit power limit in dBm
150 * survey_list - Linked list of surveys (struct freq_survey)
152 struct dl_list survey_list
;
155 * min_nf - Minimum observed noise floor, in dBm, based on all
156 * surveyed channel data
162 * interference_factor - Computed interference factor on this
163 * channel (used internally in src/ap/acs.c; driver wrappers do not
166 long double interference_factor
;
167 #endif /* CONFIG_ACS */
170 * dfs_cac_ms - DFS CAC time in milliseconds
172 unsigned int dfs_cac_ms
;
175 * wmm_rules_valid - Indicates wmm_rules state
180 * wmm_rules - WMM regulatory rules
182 struct hostapd_wmm_rule wmm_rules
[WMM_AC_NUM
];
185 #define HE_MAX_MAC_CAPAB_SIZE 6
186 #define HE_MAX_PHY_CAPAB_SIZE 11
187 #define HE_MAX_MCS_CAPAB_SIZE 12
188 #define HE_MAX_PPET_CAPAB_SIZE 25
191 * struct he_capabilities - IEEE 802.11ax HE capabilities
193 struct he_capabilities
{
195 u8 phy_cap
[HE_MAX_PHY_CAPAB_SIZE
];
196 u8 mac_cap
[HE_MAX_MAC_CAPAB_SIZE
];
197 u8 mcs
[HE_MAX_MCS_CAPAB_SIZE
];
198 u8 ppet
[HE_MAX_PPET_CAPAB_SIZE
];
201 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
202 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
205 enum ieee80211_op_mode
{
206 IEEE80211_MODE_INFRA
= 0,
207 IEEE80211_MODE_IBSS
= 1,
208 IEEE80211_MODE_AP
= 2,
209 IEEE80211_MODE_MESH
= 5,
211 /* only add new entries before IEEE80211_MODE_NUM */
216 * struct ieee80211_edmg_config - EDMG configuration
218 * This structure describes most essential parameters needed
219 * for IEEE 802.11ay EDMG configuration
221 * @channels: Bitmap that indicates the 2.16 GHz channel(s)
222 * that are allowed to be used for transmissions.
223 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
224 * Set to 0 to indicate EDMG not supported.
225 * @bw_config: Channel BW Configuration subfield encodes
226 * the allowed channel bandwidth configurations
228 struct ieee80211_edmg_config
{
230 enum edmg_bw_config bw_config
;
234 * struct hostapd_hw_modes - Supported hardware mode information
236 struct hostapd_hw_modes
{
238 * mode - Hardware mode
240 enum hostapd_hw_mode mode
;
243 * num_channels - Number of entries in the channels array
248 * channels - Array of supported channels
250 struct hostapd_channel_data
*channels
;
253 * num_rates - Number of entries in the rates array
258 * rates - Array of supported rates in 100 kbps units
263 * ht_capab - HT (IEEE 802.11n) capabilities
268 * mcs_set - MCS (IEEE 802.11n) rate parameters
273 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
278 * vht_capab - VHT (IEEE 802.11ac) capabilities
283 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
287 unsigned int flags
; /* HOSTAPD_MODE_FLAG_* */
290 * he_capab - HE (IEEE 802.11ax) capabilities
292 struct he_capabilities he_capab
[IEEE80211_MODE_NUM
];
295 * This structure describes the most essential parameters needed
296 * for IEEE 802.11ay EDMG configuration.
298 struct ieee80211_edmg_config edmg
;
302 #define IEEE80211_CAP_ESS 0x0001
303 #define IEEE80211_CAP_IBSS 0x0002
304 #define IEEE80211_CAP_PRIVACY 0x0010
305 #define IEEE80211_CAP_RRM 0x1000
307 /* DMG (60 GHz) IEEE 802.11ad */
308 /* type - bits 0..1 */
309 #define IEEE80211_CAP_DMG_MASK 0x0003
310 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
311 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
312 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
314 #define WPA_SCAN_QUAL_INVALID BIT(0)
315 #define WPA_SCAN_NOISE_INVALID BIT(1)
316 #define WPA_SCAN_LEVEL_INVALID BIT(2)
317 #define WPA_SCAN_LEVEL_DBM BIT(3)
318 #define WPA_SCAN_ASSOCIATED BIT(5)
321 * struct wpa_scan_res - Scan result for an BSS/IBSS
322 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
324 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
325 * @beacon_int: beacon interval in TUs (host byte order)
326 * @caps: capability information field in host byte order
327 * @qual: signal quality
328 * @noise: noise level
329 * @level: signal level
331 * @age: Age of the information in milliseconds (i.e., how many milliseconds
332 * ago the last Beacon or Probe Response frame was received)
333 * @est_throughput: Estimated throughput in kbps (this is calculated during
334 * scan result processing if left zero by the driver wrapper)
335 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
336 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
337 * of TSF of the BSS specified by %tsf_bssid.
338 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
339 * @ie_len: length of the following IE field in octets
340 * @beacon_ie_len: length of the following Beacon IE field in octets
342 * This structure is used as a generic format for scan results from the
343 * driver. Each driver interface implementation is responsible for converting
344 * the driver or OS specific scan results into this format.
346 * If the driver does not support reporting all IEs, the IE data structure is
347 * constructed of the IEs that are available. This field will also need to
348 * include SSID in IE format. All drivers are encouraged to be extended to
349 * report all IEs to make it easier to support future additions.
351 * This structure data is followed by ie_len octets of IEs from Probe Response
352 * frame (or if the driver does not indicate source of IEs, these may also be
353 * from Beacon frame). After the first set of IEs, another set of IEs may follow
354 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
356 struct wpa_scan_res
{
367 unsigned int est_throughput
;
370 u8 tsf_bssid
[ETH_ALEN
];
372 size_t beacon_ie_len
;
373 /* Followed by ie_len + beacon_ie_len octets of IE data */
377 * struct wpa_scan_results - Scan results
378 * @res: Array of pointers to allocated variable length scan result entries
379 * @num: Number of entries in the scan result array
380 * @fetch_time: Time when the results were fetched from the driver
382 struct wpa_scan_results
{
383 struct wpa_scan_res
**res
;
385 struct os_reltime fetch_time
;
389 * struct wpa_interface_info - Network interface information
390 * @next: Pointer to the next interface or NULL if this is the last one
391 * @ifname: Interface name that can be used with init() or init2()
392 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
394 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
395 * is not an allocated copy, i.e., get_interfaces() caller will not free
398 struct wpa_interface_info
{
399 struct wpa_interface_info
*next
;
402 const char *drv_name
;
405 #define WPAS_MAX_SCAN_SSIDS 16
408 * struct wpa_driver_scan_ssid - SSIDs to scan for
409 * @ssid - specific SSID to scan for (ProbeReq)
410 * %NULL or zero-length SSID is used to indicate active scan
411 * with wildcard SSID.
412 * @ssid_len - Length of the SSID in octets
414 struct wpa_driver_scan_ssid
{
420 * struct wpa_driver_scan_params - Scan parameters
421 * Data for struct wpa_driver_ops::scan2().
423 struct wpa_driver_scan_params
{
425 * ssids - SSIDs to scan for
427 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
430 * num_ssids - Number of entries in ssids array
431 * Zero indicates a request for a passive scan.
436 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
441 * extra_ies_len - Length of extra_ies in octets
443 size_t extra_ies_len
;
446 * freqs - Array of frequencies to scan or %NULL for all frequencies
448 * The frequency is set in MHz. The array is zero-terminated.
453 * filter_ssids - Filter for reporting SSIDs
455 * This optional parameter can be used to request the driver wrapper to
456 * filter scan results to include only the specified SSIDs. %NULL
457 * indicates that no filtering is to be done. This can be used to
458 * reduce memory needs for scan results in environments that have large
459 * number of APs with different SSIDs.
461 * The driver wrapper is allowed to take this allocated buffer into its
462 * own use by setting the pointer to %NULL. In that case, the driver
463 * wrapper is responsible for freeing the buffer with os_free() once it
464 * is not needed anymore.
466 struct wpa_driver_scan_filter
{
467 u8 ssid
[SSID_MAX_LEN
];
472 * num_filter_ssids - Number of entries in filter_ssids array
474 size_t num_filter_ssids
;
477 * filter_rssi - Filter by RSSI
479 * The driver may filter scan results in firmware to reduce host
480 * wakeups and thereby save power. Specify the RSSI threshold in s32
486 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
488 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
489 * Mbps from the support rates element(s) in the Probe Request frames
490 * and not to transmit the frames at any of those rates.
492 unsigned int p2p_probe
:1;
495 * only_new_results - Request driver to report only new results
497 * This is used to request the driver to report only BSSes that have
498 * been detected after this scan request has been started, i.e., to
499 * flush old cached BSS entries.
501 unsigned int only_new_results
:1;
504 * low_priority - Requests driver to use a lower scan priority
506 * This is used to request the driver to use a lower scan priority
507 * if it supports such a thing.
509 unsigned int low_priority
:1;
512 * mac_addr_rand - Requests driver to randomize MAC address
514 unsigned int mac_addr_rand
:1;
517 * mac_addr - MAC address used with randomization. The address cannot be
518 * a multicast one, i.e., bit 0 of byte 0 should not be set.
523 * mac_addr_mask - MAC address mask used with randomization.
525 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
526 * the mask should be taken as is from mac_addr. The mask should not
527 * allow the generation of a multicast address, i.e., bit 0 of byte 0
530 const u8
*mac_addr_mask
;
533 * sched_scan_plans - Scan plans for scheduled scan
535 * Each scan plan consists of the number of iterations to scan and the
536 * interval between scans. When a scan plan finishes (i.e., it was run
537 * for the specified number of iterations), the next scan plan is
538 * executed. The scan plans are executed in the order they appear in
539 * the array (lower index first). The last scan plan will run infinitely
540 * (until requested to stop), thus must not specify the number of
541 * iterations. All other scan plans must specify the number of
544 struct sched_scan_plan
{
545 u32 interval
; /* In seconds */
546 u32 iterations
; /* Zero to run infinitely */
550 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
552 unsigned int sched_scan_plans_num
;
555 * sched_scan_start_delay - Delay to use before starting the first scan
557 * Delay (in seconds) before scheduling first scan plan cycle. The
558 * driver may ignore this parameter and start immediately (or at any
559 * other time), if this feature is not supported.
561 u32 sched_scan_start_delay
;
564 * bssid - Specific BSSID to scan for
566 * This optional parameter can be used to replace the default wildcard
567 * BSSID with a specific BSSID to scan for if results are needed from
573 * scan_cookie - Unique identification representing the scan request
575 * This scan_cookie carries a unique identification representing the
576 * scan request if the host driver/kernel supports concurrent scan
577 * requests. This cookie is returned from the corresponding driver
580 * Note: Unlike other parameters in this structure, scan_cookie is used
581 * only to return information instead of setting parameters for the
587 * duration - Dwell time on each channel
589 * This optional parameter can be used to set the dwell time on each
595 * duration_mandatory - Whether the specified duration is mandatory
597 * If this is set, the duration specified by the %duration field is
598 * mandatory (and the driver should reject the scan request if it is
599 * unable to comply with the specified duration), otherwise it is the
600 * maximum duration and the actual duration may be shorter.
602 unsigned int duration_mandatory
:1;
605 * relative_rssi_set - Whether relative RSSI parameters are set
607 unsigned int relative_rssi_set
:1;
610 * relative_rssi - Relative RSSI for reporting better BSSs
612 * Amount of RSSI by which a BSS should be better than the current
613 * connected BSS to report the new BSS to user space.
618 * relative_adjust_band - Band to which RSSI should be adjusted
620 * The relative_adjust_rssi should be added to the band specified
621 * by relative_adjust_band.
623 enum set_band relative_adjust_band
;
626 * relative_adjust_rssi - RSSI to be added to relative_adjust_band
628 * An amount of relative_band_rssi should be added to the BSSs that
629 * belong to the band specified by relative_adjust_band while comparing
630 * with other bands for BSS reporting.
632 s8 relative_adjust_rssi
;
637 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0)
638 * - Accept broadcast Probe Response frame.
639 * - Probe Request frame deferral and suppression.
640 * - Max Channel Time - driver fills FILS request params IE with
641 * Maximum Channel Time.
642 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps.
644 unsigned int oce_scan
:1;
647 * NOTE: Whenever adding new parameters here, please make sure
648 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
654 * struct wpa_driver_auth_params - Authentication parameters
655 * Data for struct wpa_driver_ops::authenticate().
657 struct wpa_driver_auth_params
{
665 const u8
*wep_key
[4];
666 size_t wep_key_len
[4];
668 int local_state_change
;
671 * p2p - Whether this connection is a P2P group
676 * auth_data - Additional elements for Authentication frame
678 * This buffer starts with the Authentication transaction sequence
679 * number field. If no special handling of such elements is needed, this
680 * pointer is %NULL. This is used with SAE and FILS.
685 * auth_data_len - Length of auth_data buffer in octets
687 size_t auth_data_len
;
691 * enum wps_mode - WPS mode
695 * WPS_MODE_NONE - No WPS provisioning being used
700 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
705 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
711 * struct hostapd_freq_params - Channel parameters
713 struct hostapd_freq_params
{
715 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
717 enum hostapd_hw_mode mode
;
720 * freq - Primary channel center frequency in MHz
725 * channel - Channel number
730 * ht_enabled - Whether HT is enabled
735 * sec_channel_offset - Secondary channel offset for HT40
738 * -1 = HT40 enabled, secondary channel below primary,
739 * 1 = HT40 enabled, secondary channel above primary
741 int sec_channel_offset
;
744 * vht_enabled - Whether VHT is enabled
749 * he_enabled - Whether HE is enabled
754 * center_freq1 - Segment 0 center frequency in MHz
756 * Valid for both HT and VHT.
761 * center_freq2 - Segment 1 center frequency in MHz
763 * Non-zero only for bandwidth 80 and an 80+80 channel
768 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
773 * This structure describes the most essential parameters needed
774 * for IEEE 802.11ay EDMG configuration.
776 struct ieee80211_edmg_config edmg
;
780 * struct wpa_driver_sta_auth_params - Authentication parameters
781 * Data for struct wpa_driver_ops::sta_auth().
783 struct wpa_driver_sta_auth_params
{
786 * own_addr - Source address and BSSID for authentication frame
791 * addr - MAC address of the station to associate
796 * seq - authentication sequence number
801 * status - authentication response status code
806 * ie - authentication frame ie buffer
811 * len - ie buffer length
816 * fils_auth - Indicates whether FILS authentication is being performed
821 * fils_anonce - ANonce (required for FILS)
823 u8 fils_anonce
[WPA_NONCE_LEN
];
826 * fils_snonce - SNonce (required for FILS)
828 u8 fils_snonce
[WPA_NONCE_LEN
];
831 * fils_kek - key for encryption (required for FILS)
833 u8 fils_kek
[WPA_KEK_MAX_LEN
];
836 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
842 * struct wpa_driver_associate_params - Association parameters
843 * Data for struct wpa_driver_ops::associate().
845 struct wpa_driver_associate_params
{
847 * bssid - BSSID of the selected AP
848 * This can be %NULL, if ap_scan=2 mode is used and the driver is
849 * responsible for selecting with which BSS to associate. */
853 * bssid_hint - BSSID of a proposed AP
855 * This indicates which BSS has been found a suitable candidate for
856 * initial association for drivers that use driver/firmwate-based BSS
857 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
858 * the driver from selecting other BSSes in the ESS.
860 const u8
*bssid_hint
;
863 * ssid - The selected SSID
868 * ssid_len - Length of the SSID (1..32)
873 * freq - channel parameters
875 struct hostapd_freq_params freq
;
878 * freq_hint - Frequency of the channel the proposed AP is using
880 * This provides a channel on which a suitable BSS has been found as a
881 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
882 * limit the driver from selecting other channels for
883 * driver/firmware-based BSS selection.
888 * bg_scan_period - Background scan period in seconds, 0 to disable
889 * background scan, or -1 to indicate no change to default driver
895 * beacon_int - Beacon interval for IBSS or 0 to use driver default
900 * wpa_ie - WPA information element for (Re)Association Request
901 * WPA information element to be included in (Re)Association
902 * Request (including information element id and length). Use
903 * of this WPA IE is optional. If the driver generates the WPA
904 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
905 * key_mgmt_suite to select proper algorithms. In this case,
906 * the driver has to notify wpa_supplicant about the used WPA
907 * IE by generating an event that the interface code will
908 * convert into EVENT_ASSOCINFO data (see below).
910 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
911 * instead. The driver can determine which version is used by
912 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
915 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
920 * wpa_ie_len - length of the wpa_ie
925 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
927 unsigned int wpa_proto
;
930 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
932 * This is usually ignored if @wpa_ie is used.
934 unsigned int pairwise_suite
;
937 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
939 * This is usually ignored if @wpa_ie is used.
941 unsigned int group_suite
;
944 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
946 * This is usually ignored if @wpa_ie is used.
948 unsigned int mgmt_group_suite
;
951 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
953 * This is usually ignored if @wpa_ie is used.
955 unsigned int key_mgmt_suite
;
958 * auth_alg - Allowed authentication algorithms
959 * Bit field of WPA_AUTH_ALG_*
964 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
969 * wep_key - WEP keys for static WEP configuration
971 const u8
*wep_key
[4];
974 * wep_key_len - WEP key length for static WEP configuration
976 size_t wep_key_len
[4];
979 * wep_tx_keyidx - WEP TX key index for static WEP configuration
984 * mgmt_frame_protection - IEEE 802.11w management frame protection
986 enum mfp_options mgmt_frame_protection
;
989 * passphrase - RSN passphrase for PSK
991 * This value is made available only for WPA/WPA2-Personal (PSK) and
992 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
993 * is the 8..63 character ASCII passphrase, if available. Please note
994 * that this can be %NULL if passphrase was not used to generate the
995 * PSK. In that case, the psk field must be used to fetch the PSK.
997 const char *passphrase
;
1000 * psk - RSN PSK (alternative for passphrase for PSK)
1002 * This value is made available only for WPA/WPA2-Personal (PSK) and
1003 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
1004 * is the 32-octet (256-bit) PSK, if available. The driver wrapper
1005 * should be prepared to handle %NULL value as an error.
1010 * drop_unencrypted - Enable/disable unencrypted frame filtering
1012 * Configure the driver to drop all non-EAPOL frames (both receive and
1013 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
1014 * still be allowed for key negotiation.
1016 int drop_unencrypted
;
1019 * prev_bssid - Previously used BSSID in this ESS
1021 * When not %NULL, this is a request to use reassociation instead of
1024 const u8
*prev_bssid
;
1029 * If the driver needs to do special configuration for WPS association,
1030 * this variable provides more information on what type of association
1031 * is being requested. Most drivers should not need ot use this.
1036 * p2p - Whether this connection is a P2P group
1041 * uapsd - UAPSD parameters for the network
1042 * -1 = do not change defaults
1043 * AP mode: 1 = enabled, 0 = disabled
1044 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
1049 * fixed_bssid - Whether to force this BSSID in IBSS mode
1050 * 1 = Fix this BSSID and prevent merges.
1051 * 0 = Do not fix BSSID.
1056 * fixed_freq - Fix control channel in IBSS mode
1057 * 0 = don't fix control channel (default)
1058 * 1 = fix control channel; this prevents IBSS merging with another
1064 * disable_ht - Disable HT (IEEE 802.11n) for this connection
1069 * htcaps - HT Capabilities over-rides
1071 * Only bits set in the mask will be used, and not all values are used
1072 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
1074 * Pointer to struct ieee80211_ht_capabilities.
1079 * htcaps_mask - HT Capabilities over-rides mask
1081 * Pointer to struct ieee80211_ht_capabilities.
1083 const u8
*htcaps_mask
;
1085 #ifdef CONFIG_VHT_OVERRIDES
1087 * disable_vht - Disable VHT for this connection
1092 * VHT capability overrides.
1094 const struct ieee80211_vht_capabilities
*vhtcaps
;
1095 const struct ieee80211_vht_capabilities
*vhtcaps_mask
;
1096 #endif /* CONFIG_VHT_OVERRIDES */
1099 * req_key_mgmt_offload - Request key management offload for connection
1101 * Request key management offload for this connection if the device
1104 int req_key_mgmt_offload
;
1107 * req_handshake_offload - Request EAPOL handshake offload
1109 * Request EAPOL handshake offload for this connection if the device
1112 int req_handshake_offload
;
1115 * Flag for indicating whether this association includes support for
1116 * RRM (Radio Resource Measurements)
1121 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1122 * AP as usual. Valid for DMG network only.
1127 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1132 * fils_kek_len: Length of fils_kek in bytes
1134 size_t fils_kek_len
;
1137 * fils_nonces - Nonces for FILS association frame protection
1140 const u8
*fils_nonces
;
1143 * fils_nonces_len: Length of fils_nonce in bytes
1145 size_t fils_nonces_len
;
1148 * fils_erp_username - Username part of keyName-NAI
1150 const u8
*fils_erp_username
;
1153 * fils_erp_username_len - Length of fils_erp_username in bytes
1155 size_t fils_erp_username_len
;
1158 * fils_erp_realm - Realm/domain name to use in FILS ERP
1160 const u8
*fils_erp_realm
;
1163 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1165 size_t fils_erp_realm_len
;
1168 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1171 u16 fils_erp_next_seq_num
;
1174 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1175 * specified by fils_erp_username@fils_erp_realm.
1177 const u8
*fils_erp_rrk
;
1180 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1182 size_t fils_erp_rrk_len
;
1187 HIDDEN_SSID_ZERO_LEN
,
1188 HIDDEN_SSID_ZERO_CONTENTS
1191 enum ch_switch_state
{
1196 struct wowlan_triggers
{
1200 u8 gtk_rekey_failure
;
1201 u8 eap_identity_req
;
1202 u8 four_way_handshake
;
1206 struct wpa_driver_ap_params
{
1208 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1213 * head_len - Length of the head buffer in octets
1218 * tail - Beacon tail following TIM IE
1223 * tail_len - Length of the tail buffer in octets
1228 * dtim_period - DTIM period
1233 * beacon_int - Beacon interval
1238 * basic_rates: -1 terminated array of basic rates in 100 kbps
1240 * This parameter can be used to set a specific basic rate set for the
1241 * BSS. If %NULL, default basic rate set is used.
1246 * beacon_rate: Beacon frame data rate
1248 * This parameter can be used to set a specific Beacon frame data rate
1249 * for the BSS. The interpretation of this value depends on the
1250 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS). If
1251 * beacon_rate == 0 and rate_type == 0 (BEACON_RATE_LEGACY), the default
1252 * Beacon frame data rate is used.
1254 unsigned int beacon_rate
;
1257 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT)
1259 enum beacon_rate_type rate_type
;
1262 * proberesp - Probe Response template
1264 * This is used by drivers that reply to Probe Requests internally in
1265 * AP mode and require the full Probe Response template.
1270 * proberesp_len - Length of the proberesp buffer in octets
1272 size_t proberesp_len
;
1275 * ssid - The SSID to use in Beacon/Probe Response frames
1280 * ssid_len - Length of the SSID (1..32)
1285 * hide_ssid - Whether to hide the SSID
1287 enum hide_ssid hide_ssid
;
1290 * pairwise_ciphers - WPA_CIPHER_* bitfield
1292 unsigned int pairwise_ciphers
;
1295 * group_cipher - WPA_CIPHER_*
1297 unsigned int group_cipher
;
1300 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1302 unsigned int key_mgmt_suites
;
1305 * auth_algs - WPA_AUTH_ALG_* bitfield
1307 unsigned int auth_algs
;
1310 * wpa_version - WPA_PROTO_* bitfield
1312 unsigned int wpa_version
;
1315 * privacy - Whether privacy is used in the BSS
1320 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1322 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1323 * not use the full Beacon template.
1325 const struct wpabuf
*beacon_ies
;
1328 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1330 * This is used to add IEs like WPS IE and P2P IE by drivers that
1331 * reply to Probe Request frames internally.
1333 const struct wpabuf
*proberesp_ies
;
1336 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1338 * This is used to add IEs like WPS IE by drivers that reply to
1339 * (Re)Association Request frames internally.
1341 const struct wpabuf
*assocresp_ies
;
1344 * isolate - Whether to isolate frames between associated stations
1346 * If this is non-zero, the AP is requested to disable forwarding of
1347 * frames between associated stations.
1352 * cts_protect - Whether CTS protection is enabled
1357 * preamble - Whether short preamble is enabled
1362 * short_slot_time - Whether short slot time is enabled
1364 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1365 * not set (e.g., when 802.11g mode is not in use)
1367 int short_slot_time
;
1370 * ht_opmode - HT operation mode or -1 if HT not in use
1375 * interworking - Whether Interworking is enabled
1380 * hessid - Homogeneous ESS identifier or %NULL if not set
1385 * access_network_type - Access Network Type (0..15)
1387 * This is used for filtering Probe Request frames when Interworking is
1390 u8 access_network_type
;
1393 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1395 * This is used by driver which advertises this capability.
1397 int ap_max_inactivity
;
1400 * ctwindow - Client Traffic Window (in TUs)
1405 * smps_mode - SMPS mode
1407 * SMPS mode to be used by the AP, specified as the relevant bits of
1408 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1410 unsigned int smps_mode
;
1413 * disable_dgaf - Whether group-addressed frames are disabled
1418 * osen - Whether OSEN security is enabled
1423 * freq - Channel parameters for dynamic bandwidth changes
1425 struct hostapd_freq_params
*freq
;
1428 * reenable - Whether this is to re-enable beaconing
1433 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1434 * infrastructure BSS. Valid only for DMG network.
1439 * multicast_to_unicast - Whether to use multicast_to_unicast
1441 * If this is non-zero, the AP is requested to perform multicast to
1442 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1443 * 802.1Q). If enabled, such frames are to be sent to each station
1444 * separately, with the DA replaced by their own MAC address rather
1445 * than the group address.
1447 * Note that this may break certain expectations of the receiver, such
1448 * as the ability to drop unicast IP packets received within multicast
1449 * L2 frames, or the ability to not send ICMP destination unreachable
1450 * messages for packets received in L2 multicast (which is required,
1451 * but the receiver can't tell the difference if this new option is
1454 * This also doesn't implement the 802.11 DMS (directed multicast
1457 int multicast_to_unicast
;
1460 * ftm_responder - Whether FTM responder is enabled
1465 * lci - Binary data, the content of an LCI report IE with type 8 as
1466 * defined in IEEE Std 802.11-2016, 9.4.2.22.10
1468 const struct wpabuf
*lci
;
1471 * civic - Binary data, the content of a measurement report IE with
1472 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
1474 const struct wpabuf
*civic
;
1477 * he_spr - Whether Spatial Reuse is enabled
1482 * he_spr_srg_obss_pd_min_offset - Minimum TX power offset
1484 int he_spr_srg_obss_pd_min_offset
;
1487 * he_spr_srg_obss_pd_max_offset - Maximum TX power offset
1489 int he_spr_srg_obss_pd_max_offset
;
1492 struct wpa_driver_mesh_bss_params
{
1493 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1494 #define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1495 #define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1496 #define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
1497 #define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010
1499 * TODO: Other mesh configuration parameters would go here.
1500 * See NL80211_MESHCONF_* for all the mesh config parameters.
1504 int peer_link_timeout
;
1510 struct wpa_driver_mesh_join_params
{
1513 const int *basic_rates
;
1516 struct hostapd_freq_params freq
;
1519 struct wpa_driver_mesh_bss_params conf
;
1520 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1521 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1522 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1523 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1528 * struct wpa_driver_capa - Driver capability information
1530 struct wpa_driver_capa
{
1531 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1532 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1533 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1534 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1535 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1536 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1537 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1538 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1539 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1540 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
1541 #define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
1542 #define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
1543 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1544 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1545 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1546 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
1547 #define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000
1548 /** Bitfield of supported key management suites */
1549 unsigned int key_mgmt
;
1551 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1552 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1553 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1554 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1555 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1556 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1557 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1558 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1559 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1560 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1561 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1562 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1563 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1564 /** Bitfield of supported cipher suites */
1567 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1568 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1569 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1570 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1573 /** Driver generated WPA/RSN IE */
1574 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1575 /** Driver needs static WEP key setup after association command */
1576 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1577 /** Driver takes care of all DFS operations */
1578 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1579 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1580 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1581 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008
1582 /** Driver is for a wired Ethernet interface */
1583 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1584 /** Driver provides separate commands for authentication and association (SME in
1585 * wpa_supplicant). */
1586 #define WPA_DRIVER_FLAGS_SME 0x00000020
1587 /** Driver supports AP mode */
1588 #define WPA_DRIVER_FLAGS_AP 0x00000040
1589 /** Driver needs static WEP key setup after association has been completed */
1590 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1591 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1592 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1593 /** Driver supports concurrent P2P operations */
1594 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1596 * Driver uses the initial interface as a dedicated management interface, i.e.,
1597 * it cannot be used for P2P group operations or non-P2P purposes.
1599 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1600 /** This interface is P2P capable (P2P GO or P2P Client) */
1601 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1602 /** Driver supports station and key removal when stopping an AP */
1603 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1605 * Driver uses the initial interface for P2P management interface and non-P2P
1606 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1607 * P2P group operations.
1609 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1611 * Driver is known to use sane error codes, i.e., when it indicates that
1612 * something (e.g., association) fails, there was indeed a failure and the
1613 * operation does not end up getting completed successfully later.
1615 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1616 /** Driver supports off-channel TX */
1617 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1618 /** Driver indicates TX status events for EAPOL Data frames */
1619 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1620 /** Driver indicates TX status events for Deauth/Disassoc frames */
1621 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1622 /** Driver supports roaming (BSS selection) in firmware */
1623 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1624 /** Driver supports operating as a TDLS peer */
1625 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1626 /** Driver requires external TDLS setup/teardown/discovery */
1627 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1628 /** Driver indicates support for Probe Response offloading in AP mode */
1629 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1630 /** Driver supports U-APSD in AP mode */
1631 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1632 /** Driver supports inactivity timer in AP mode */
1633 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1634 /** Driver expects user space implementation of MLME in AP mode */
1635 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1636 /** Driver supports SAE with user space SME */
1637 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1638 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1639 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1640 /** Driver supports IBSS (Ad-hoc) mode */
1641 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1642 /** Driver supports radar detection */
1643 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1644 /** Driver supports a dedicated interface for P2P Device */
1645 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1646 /** Driver supports QoS Mapping */
1647 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1648 /** Driver supports CSA in AP mode */
1649 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1650 /** Driver supports mesh */
1651 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1652 /** Driver support ACS offload */
1653 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1654 /** Driver supports key management offload */
1655 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1656 /** Driver supports TDLS channel switching */
1657 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1658 /** Driver supports IBSS with HT datarates */
1659 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
1660 /** Driver supports IBSS with VHT datarates */
1661 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
1662 /** Driver supports automatic band selection */
1663 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
1664 /** Driver supports simultaneous off-channel operations */
1665 #define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
1666 /** Driver supports full AP client state */
1667 #define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
1668 /** Driver supports P2P Listen offload */
1669 #define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
1670 /** Driver supports FILS */
1671 #define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
1672 /** Driver supports Beacon frame TX rate configuration (legacy rates) */
1673 #define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1674 /** Driver supports Beacon frame TX rate configuration (HT rates) */
1675 #define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1676 /** Driver supports Beacon frame TX rate configuration (VHT rates) */
1677 #define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
1678 /** Driver supports mgmt_tx with random TX address in non-connected state */
1679 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
1680 /** Driver supports mgmt_tx with random TX addr in connected state */
1681 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
1682 /** Driver supports better BSS reporting with sched_scan in connected mode */
1683 #define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
1684 /** Driver supports HE capabilities */
1685 #define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
1686 /** Driver supports FILS shared key offload */
1687 #define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
1688 /** Driver supports all OCE STA specific mandatory features */
1689 #define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
1690 /** Driver supports all OCE AP specific mandatory features */
1691 #define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
1693 * Driver supports all OCE STA-CFON specific mandatory features only.
1694 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
1695 * userspace shall assume that this driver may not support all OCE AP
1696 * functionality but can support only OCE STA-CFON functionality.
1698 #define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
1699 /** Driver supports MFP-optional in the connect command */
1700 #define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL
1701 /** Driver is a self-managed regulatory device */
1702 #define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL
1703 /** Driver supports FTM responder functionality */
1704 #define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL
1705 /** Driver support 4-way handshake offload for WPA-Personal */
1706 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
1709 #define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1710 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1712 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1713 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1714 unsigned int smps_modes
;
1716 unsigned int wmm_ac_supported
:1;
1718 unsigned int mac_addr_rand_scan_supported
:1;
1719 unsigned int mac_addr_rand_sched_scan_supported
:1;
1721 /** Maximum number of supported active probe SSIDs */
1724 /** Maximum number of supported active probe SSIDs for sched_scan */
1725 int max_sched_scan_ssids
;
1727 /** Maximum number of supported scan plans for scheduled scan */
1728 unsigned int max_sched_scan_plans
;
1730 /** Maximum interval in a scan plan. In seconds */
1731 u32 max_sched_scan_plan_interval
;
1733 /** Maximum number of iterations in a single scan plan */
1734 u32 max_sched_scan_plan_iterations
;
1736 /** Whether sched_scan (offloaded scanning) is supported */
1737 int sched_scan_supported
;
1739 /** Maximum number of supported match sets for sched_scan */
1743 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1745 unsigned int max_remain_on_chan
;
1748 * max_stations - Maximum number of associated stations the driver
1749 * supports in AP mode
1751 unsigned int max_stations
;
1754 * probe_resp_offloads - Bitmap of supported protocols by the driver
1755 * for Probe Response offloading.
1757 /** Driver Probe Response offloading support for WPS ver. 1 */
1758 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1759 /** Driver Probe Response offloading support for WPS ver. 2 */
1760 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1761 /** Driver Probe Response offloading support for P2P */
1762 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1763 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1764 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1765 unsigned int probe_resp_offloads
;
1767 unsigned int max_acl_mac_addrs
;
1770 * Number of supported concurrent channels
1772 unsigned int num_multichan_concurrent
;
1775 * extended_capa - extended capabilities in driver/device
1777 * Must be allocated and freed by driver and the pointers must be
1778 * valid for the lifetime of the driver, i.e., freed in deinit()
1780 const u8
*extended_capa
, *extended_capa_mask
;
1781 unsigned int extended_capa_len
;
1783 struct wowlan_triggers wowlan_triggers
;
1785 /** Driver adds the DS Params Set IE in Probe Request frames */
1786 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1787 /** Driver adds the WFA TPC IE in Probe Request frames */
1788 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1789 /** Driver handles quiet period requests */
1790 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1792 * Driver is capable of inserting the current TX power value into the body of
1793 * transmitted frames.
1794 * Background: Some Action frames include a TPC Report IE. This IE contains a
1795 * TX power field, which has to be updated by lower layers. One such Action
1796 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1797 * of spectrum management). Note that this insertion takes place at a fixed
1798 * offset, namely the 6th byte in the Action frame body.
1800 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1802 * Driver supports RRM. With this support, the driver will accept to use RRM in
1803 * (Re)Association Request frames, without supporting quiet period.
1805 #define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1807 /** Driver supports setting the scan dwell time */
1808 #define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
1809 /** Driver supports Beacon Report Measurement */
1810 #define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
1814 /* Driver concurrency capabilities */
1815 unsigned int conc_capab
;
1816 /* Maximum number of concurrent channels on 2.4 GHz */
1817 unsigned int max_conc_chan_2_4
;
1818 /* Maximum number of concurrent channels on 5 GHz */
1819 unsigned int max_conc_chan_5_0
;
1821 /* Maximum number of supported CSA counters */
1822 u16 max_csa_counters
;
1826 struct hostapd_data
;
1828 #define STA_DRV_DATA_TX_MCS BIT(0)
1829 #define STA_DRV_DATA_RX_MCS BIT(1)
1830 #define STA_DRV_DATA_TX_VHT_MCS BIT(2)
1831 #define STA_DRV_DATA_RX_VHT_MCS BIT(3)
1832 #define STA_DRV_DATA_TX_VHT_NSS BIT(4)
1833 #define STA_DRV_DATA_RX_VHT_NSS BIT(5)
1834 #define STA_DRV_DATA_TX_SHORT_GI BIT(6)
1835 #define STA_DRV_DATA_RX_SHORT_GI BIT(7)
1836 #define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
1838 struct hostap_sta_driver_data
{
1839 unsigned long rx_packets
, tx_packets
;
1840 unsigned long long rx_bytes
, tx_bytes
;
1841 unsigned long long rx_airtime
, tx_airtime
;
1842 int bytes_64bit
; /* whether 64-bit byte counters are supported */
1843 unsigned long current_tx_rate
;
1844 unsigned long current_rx_rate
;
1845 unsigned long inactive_msec
;
1846 unsigned long flags
; /* bitfield of STA_DRV_DATA_* */
1847 unsigned long num_ps_buf_frames
;
1848 unsigned long tx_retry_failed
;
1849 unsigned long tx_retry_count
;
1851 unsigned long backlog_packets
;
1852 unsigned long backlog_bytes
;
1862 struct hostapd_sta_add_params
{
1866 const u8
*supp_rates
;
1867 size_t supp_rates_len
;
1868 u16 listen_interval
;
1869 const struct ieee80211_ht_capabilities
*ht_capabilities
;
1870 const struct ieee80211_vht_capabilities
*vht_capabilities
;
1871 int vht_opmode_enabled
;
1873 const struct ieee80211_he_capabilities
*he_capab
;
1874 size_t he_capab_len
;
1875 u32 flags
; /* bitmask of WPA_STA_* flags */
1876 u32 flags_mask
; /* unset bits in flags */
1878 enum mesh_plink_state plink_state
;
1880 #endif /* CONFIG_MESH */
1881 int set
; /* Set STA parameters instead of add */
1883 const u8
*ext_capab
;
1884 size_t ext_capab_len
;
1885 const u8
*supp_channels
;
1886 size_t supp_channels_len
;
1887 const u8
*supp_oper_classes
;
1888 size_t supp_oper_classes_len
;
1892 struct mac_address
{
1896 struct hostapd_acl_params
{
1898 unsigned int num_mac_acl
;
1899 struct mac_address mac_acl
[0];
1902 enum wpa_driver_if_type
{
1904 * WPA_IF_STATION - Station mode interface
1909 * WPA_IF_AP_VLAN - AP mode VLAN interface
1911 * This interface shares its address and Beacon frame with the main
1917 * WPA_IF_AP_BSS - AP mode BSS interface
1919 * This interface has its own address and Beacon frame.
1924 * WPA_IF_P2P_GO - P2P Group Owner
1929 * WPA_IF_P2P_CLIENT - P2P Client
1934 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1935 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1940 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1941 * abstracted P2P Device function in the driver
1946 * WPA_IF_MESH - Mesh interface
1951 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1956 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1961 struct wpa_init_params
{
1965 const char *driver_params
;
1966 int use_pae_group_addr
;
1970 u8
*own_addr
; /* buffer for writing own MAC address */
1974 struct wpa_bss_params
{
1975 /** Interface name (for multi-SSID/VLAN support) */
1977 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1986 enum mfp_options ieee80211w
;
1989 #define WPA_STA_AUTHORIZED BIT(0)
1990 #define WPA_STA_WMM BIT(1)
1991 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1992 #define WPA_STA_MFP BIT(3)
1993 #define WPA_STA_TDLS_PEER BIT(4)
1994 #define WPA_STA_AUTHENTICATED BIT(5)
1995 #define WPA_STA_ASSOCIATED BIT(6)
2008 WNM_SLEEP_ENTER_CONFIRM
,
2009 WNM_SLEEP_ENTER_FAIL
,
2010 WNM_SLEEP_EXIT_CONFIRM
,
2011 WNM_SLEEP_EXIT_FAIL
,
2012 WNM_SLEEP_TFS_REQ_IE_ADD
, /* STA requests driver to add TFS req IE */
2013 WNM_SLEEP_TFS_REQ_IE_NONE
, /* STA requests empty TFS req IE */
2014 WNM_SLEEP_TFS_REQ_IE_SET
, /* AP requests driver to set TFS req IE for
2016 WNM_SLEEP_TFS_RESP_IE_ADD
, /* AP requests driver to add TFS resp IE
2018 WNM_SLEEP_TFS_RESP_IE_NONE
, /* AP requests empty TFS resp IE */
2019 WNM_SLEEP_TFS_RESP_IE_SET
, /* AP requests driver to set TFS resp IE
2021 WNM_SLEEP_TFS_IE_DEL
/* AP delete the TFS IE */
2024 /* enum smps_mode - SMPS mode definitions */
2035 #define WPA_INVALID_NOISE 9999
2038 * struct wpa_signal_info - Information about channel signal quality
2039 * @frequency: control frequency
2040 * @above_threshold: true if the above threshold was crossed
2041 * (relevant for a CQM event)
2042 * @current_signal: in dBm
2043 * @avg_signal: in dBm
2044 * @avg_beacon_signal: in dBm
2045 * @current_noise: %WPA_INVALID_NOISE if not supported
2046 * @current_txrate: current TX rate
2047 * @chanwidth: channel width
2048 * @center_frq1: center frequency for the first segment
2049 * @center_frq2: center frequency for the second segment (if relevant)
2051 struct wpa_signal_info
{
2053 int above_threshold
;
2056 int avg_beacon_signal
;
2059 enum chan_width chanwidth
;
2065 * struct wpa_channel_info - Information about the current channel
2066 * @frequency: Center frequency of the primary 20 MHz channel
2067 * @chanwidth: Width of the current operating channel
2068 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
2069 * This field is only filled in when using a 40 MHz channel.
2070 * @center_frq1: Center frequency of frequency segment 0
2071 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
2072 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
2073 * derived from center_frq2 for convenience.
2075 struct wpa_channel_info
{
2077 enum chan_width chanwidth
;
2085 * struct beacon_data - Beacon data
2086 * @head: Head portion of Beacon frame (before TIM IE)
2087 * @tail: Tail portion of Beacon frame (after TIM IE)
2088 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2089 * @proberesp_ies: Extra information element(s) to add into Probe Response
2091 * @assocresp_ies: Extra information element(s) to add into (Re)Association
2092 * Response frames or %NULL
2093 * @probe_resp: Probe Response frame template
2094 * @head_len: Length of @head
2095 * @tail_len: Length of @tail
2096 * @beacon_ies_len: Length of beacon_ies in octets
2097 * @proberesp_ies_len: Length of proberesp_ies in octets
2098 * @proberesp_ies_len: Length of proberesp_ies in octets
2099 * @probe_resp_len: Length of probe response template (@probe_resp)
2101 struct beacon_data
{
2108 size_t head_len
, tail_len
;
2109 size_t beacon_ies_len
;
2110 size_t proberesp_ies_len
;
2111 size_t assocresp_ies_len
;
2112 size_t probe_resp_len
;
2116 * struct csa_settings - Settings for channel switch command
2117 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2118 * @block_tx: 1 - block transmission for CSA period
2119 * @freq_params: Next channel frequency parameter
2120 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2121 * @beacon_after: Next beacon/probe resp/asooc resp info
2122 * @counter_offset_beacon: Offset to the count field in beacon's tail
2123 * @counter_offset_presp: Offset to the count field in probe resp.
2125 struct csa_settings
{
2129 struct hostapd_freq_params freq_params
;
2130 struct beacon_data beacon_csa
;
2131 struct beacon_data beacon_after
;
2133 u16 counter_offset_beacon
[2];
2134 u16 counter_offset_presp
[2];
2137 /* TDLS peer capabilities for send_tdls_mgmt() */
2138 enum tdls_peer_capability
{
2139 TDLS_PEER_HT
= BIT(0),
2140 TDLS_PEER_VHT
= BIT(1),
2141 TDLS_PEER_WMM
= BIT(2),
2144 /* valid info in the wmm_params struct */
2145 enum wmm_params_valid_info
{
2146 WMM_PARAMS_UAPSD_QUEUES_INFO
= BIT(0),
2150 * struct wmm_params - WMM parameterss configured for this association
2151 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2152 * of the struct contain valid information.
2153 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2154 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2161 #ifdef CONFIG_MACSEC
2162 struct macsec_init_params
{
2163 Boolean always_include_sci
;
2167 #endif /* CONFIG_MACSEC */
2169 enum drv_br_port_attr
{
2170 DRV_BR_PORT_ATTR_PROXYARP
,
2171 DRV_BR_PORT_ATTR_HAIRPIN_MODE
,
2174 enum drv_br_net_param
{
2175 DRV_BR_NET_PARAM_GARP_ACCEPT
,
2176 DRV_BR_MULTICAST_SNOOPING
,
2179 struct drv_acs_params
{
2180 /* Selected mode (HOSTAPD_MODE_*) */
2181 enum hostapd_hw_mode hw_mode
;
2183 /* Indicates whether HT is enabled */
2186 /* Indicates whether HT40 is enabled */
2189 /* Indicates whether VHT is enabled */
2192 /* Configured ACS channel width */
2195 /* ACS frequency list info */
2196 const int *freq_list
;
2199 struct wpa_bss_trans_info
{
2200 u8 mbo_transition_reason
;
2205 struct wpa_bss_candidate_info
{
2207 struct candidate_list
{
2214 struct wpa_pmkid_params
{
2218 const u8
*fils_cache_id
;
2224 /* Mask used to specify which connection parameters have to be updated */
2225 enum wpa_drv_update_connect_params_mask
{
2226 WPA_DRV_UPDATE_ASSOC_IES
= BIT(0),
2227 WPA_DRV_UPDATE_FILS_ERP_INFO
= BIT(1),
2228 WPA_DRV_UPDATE_AUTH_TYPE
= BIT(2),
2232 * struct external_auth - External authentication trigger parameters
2234 * These are used across the external authentication request and event
2236 * @action: Action type / trigger for external authentication. Only significant
2237 * for the event interface.
2238 * @bssid: BSSID of the peer with which the authentication has to happen. Used
2239 * by both the request and event interface.
2240 * @ssid: SSID of the AP. Used by both the request and event interface.
2241 * @ssid_len: SSID length in octets.
2242 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2243 * the request interface.
2244 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2245 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2246 * the real status code for failures. Used only for the request interface
2247 * from user space to the driver.
2248 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
2250 struct external_auth
{
2258 unsigned int key_mgmt_suite
;
2264 * struct wpa_driver_ops - Driver interface API definition
2266 * This structure defines the API that each driver interface needs to implement
2267 * for core wpa_supplicant code. All driver specific functionality is captured
2270 struct wpa_driver_ops
{
2271 /** Name of the driver interface */
2273 /** One line description of the driver interface */
2277 * get_bssid - Get the current BSSID
2278 * @priv: private driver interface data
2279 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2281 * Returns: 0 on success, -1 on failure
2283 * Query kernel driver for the current BSSID and copy it to bssid.
2284 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2287 int (*get_bssid
)(void *priv
, u8
*bssid
);
2290 * get_ssid - Get the current SSID
2291 * @priv: private driver interface data
2292 * @ssid: buffer for SSID (at least 32 bytes)
2294 * Returns: Length of the SSID on success, -1 on failure
2296 * Query kernel driver for the current SSID and copy it to ssid.
2297 * Returning zero is recommended if the STA is not associated.
2299 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2300 * can, at least in theory, contain control characters (including nul)
2301 * and as such, should be processed as binary data, not a printable
2304 int (*get_ssid
)(void *priv
, u8
*ssid
);
2307 * set_key - Configure encryption key
2308 * @ifname: Interface name (for multi-SSID/VLAN support)
2309 * @priv: private driver interface data
2310 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
2311 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
2312 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
2313 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
2314 * %WPA_ALG_BIP_CMAC_256);
2315 * %WPA_ALG_NONE clears the key.
2316 * @addr: Address of the peer STA (BSSID of the current AP when setting
2317 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
2318 * broadcast keys, %NULL for default keys that are used both for
2319 * broadcast and unicast; when clearing keys, %NULL is used to
2320 * indicate that both the broadcast-only and default key of the
2321 * specified key index is to be cleared
2322 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
2324 * @set_tx: configure this key as the default Tx key (only used when
2325 * driver does not support separate unicast/individual key
2326 * @seq: sequence number/packet number, seq_len octets, the next
2327 * packet number to be used for in replay protection; configured
2328 * for Rx keys (in most cases, this is only used with broadcast
2329 * keys and set to zero for unicast keys); %NULL if not set
2330 * @seq_len: length of the seq, depends on the algorithm:
2331 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
2332 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
2334 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
2335 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
2337 * Returns: 0 on success, -1 on failure
2339 * Configure the given key for the kernel driver. If the driver
2340 * supports separate individual keys (4 default keys + 1 individual),
2341 * addr can be used to determine whether the key is default or
2342 * individual. If only 4 keys are supported, the default key with key
2343 * index 0 is used as the individual key. STA must be configured to use
2344 * it as the default Tx key (set_tx is set) and accept Rx for all the
2345 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2346 * broadcast keys, so key index 0 is available for this kind of
2349 * Please note that TKIP keys include separate TX and RX MIC keys and
2350 * some drivers may expect them in different order than wpa_supplicant
2351 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
2352 * will trigger Michael MIC errors. This can be fixed by changing the
2353 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
2354 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2355 * example on how this can be done.
2357 int (*set_key
)(const char *ifname
, void *priv
, enum wpa_alg alg
,
2358 const u8
*addr
, int key_idx
, int set_tx
,
2359 const u8
*seq
, size_t seq_len
,
2360 const u8
*key
, size_t key_len
);
2363 * init - Initialize driver interface
2364 * @ctx: context to be used when calling wpa_supplicant functions,
2365 * e.g., wpa_supplicant_event()
2366 * @ifname: interface name, e.g., wlan0
2368 * Returns: Pointer to private data, %NULL on failure
2370 * Initialize driver interface, including event processing for kernel
2371 * driver events (e.g., associated, scan results, Michael MIC failure).
2372 * This function can allocate a private configuration data area for
2373 * @ctx, file descriptor, interface name, etc. information that may be
2374 * needed in future driver operations. If this is not used, non-NULL
2375 * value will need to be returned because %NULL is used to indicate
2376 * failure. The returned value will be used as 'void *priv' data for
2377 * all other driver_ops functions.
2379 * The main event loop (eloop.c) of wpa_supplicant can be used to
2380 * register callback for read sockets (eloop_register_read_sock()).
2382 * See below for more information about events and
2383 * wpa_supplicant_event() function.
2385 void * (*init
)(void *ctx
, const char *ifname
);
2388 * deinit - Deinitialize driver interface
2389 * @priv: private driver interface data from init()
2391 * Shut down driver interface and processing of driver events. Free
2392 * private data buffer if one was allocated in init() handler.
2394 void (*deinit
)(void *priv
);
2397 * set_param - Set driver configuration parameters
2398 * @priv: private driver interface data from init()
2399 * @param: driver specific configuration parameters
2401 * Returns: 0 on success, -1 on failure
2403 * Optional handler for notifying driver interface about configuration
2404 * parameters (driver_param).
2406 int (*set_param
)(void *priv
, const char *param
);
2409 * set_countermeasures - Enable/disable TKIP countermeasures
2410 * @priv: private driver interface data
2411 * @enabled: 1 = countermeasures enabled, 0 = disabled
2413 * Returns: 0 on success, -1 on failure
2415 * Configure TKIP countermeasures. When these are enabled, the driver
2416 * should drop all received and queued frames that are using TKIP.
2418 int (*set_countermeasures
)(void *priv
, int enabled
);
2421 * deauthenticate - Request driver to deauthenticate
2422 * @priv: private driver interface data
2423 * @addr: peer address (BSSID of the AP)
2424 * @reason_code: 16-bit reason code to be sent in the deauthentication
2427 * Returns: 0 on success, -1 on failure
2429 int (*deauthenticate
)(void *priv
, const u8
*addr
, u16 reason_code
);
2432 * associate - Request driver to associate
2433 * @priv: private driver interface data
2434 * @params: association parameters
2436 * Returns: 0 on success, -1 on failure
2438 int (*associate
)(void *priv
,
2439 struct wpa_driver_associate_params
*params
);
2442 * add_pmkid - Add PMKSA cache entry to the driver
2443 * @priv: private driver interface data
2444 * @params: PMKSA parameters
2446 * Returns: 0 on success, -1 on failure
2448 * This function is called when a new PMK is received, as a result of
2449 * either normal authentication or RSN pre-authentication. The PMKSA
2450 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2451 * ssid, fils_cache_id, pmkid, and pmk.
2453 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2454 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2455 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2456 * driver_ops function does not need to be implemented. Likewise, if
2457 * the driver does not support WPA, this function is not needed.
2459 int (*add_pmkid
)(void *priv
, struct wpa_pmkid_params
*params
);
2462 * remove_pmkid - Remove PMKSA cache entry to the driver
2463 * @priv: private driver interface data
2464 * @params: PMKSA parameters
2466 * Returns: 0 on success, -1 on failure
2468 * This function is called when the supplicant drops a PMKSA cache
2469 * entry for any reason. The PMKSA parameters are either a set of
2470 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
2472 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2473 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2474 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2475 * from wpa_supplicant, this driver_ops function does not need to be
2476 * implemented. Likewise, if the driver does not support WPA, this
2477 * function is not needed.
2479 int (*remove_pmkid
)(void *priv
, struct wpa_pmkid_params
*params
);
2482 * flush_pmkid - Flush PMKSA cache
2483 * @priv: private driver interface data
2485 * Returns: 0 on success, -1 on failure
2487 * This function is called when the supplicant drops all PMKSA cache
2488 * entries for any reason.
2490 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2491 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2492 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2493 * from wpa_supplicant, this driver_ops function does not need to be
2494 * implemented. Likewise, if the driver does not support WPA, this
2495 * function is not needed.
2497 int (*flush_pmkid
)(void *priv
);
2500 * get_capa - Get driver capabilities
2501 * @priv: private driver interface data
2503 * Returns: 0 on success, -1 on failure
2505 * Get driver/firmware/hardware capabilities.
2507 int (*get_capa
)(void *priv
, struct wpa_driver_capa
*capa
);
2510 * poll - Poll driver for association information
2511 * @priv: private driver interface data
2513 * This is an option callback that can be used when the driver does not
2514 * provide event mechanism for association events. This is called when
2515 * receiving WPA EAPOL-Key messages that require association
2516 * information. The driver interface is supposed to generate associnfo
2517 * event before returning from this callback function. In addition, the
2518 * driver interface should generate an association event after having
2519 * sent out associnfo.
2521 void (*poll
)(void *priv
);
2524 * get_ifindex - Get interface index
2525 * @priv: private driver interface data
2527 * Returns: Interface index
2529 unsigned int (*get_ifindex
)(void *priv
);
2532 * get_ifname - Get interface name
2533 * @priv: private driver interface data
2535 * Returns: Pointer to the interface name. This can differ from the
2536 * interface name used in init() call. Init() is called first.
2538 * This optional function can be used to allow the driver interface to
2539 * replace the interface name with something else, e.g., based on an
2540 * interface mapping from a more descriptive name.
2542 const char * (*get_ifname
)(void *priv
);
2545 * get_mac_addr - Get own MAC address
2546 * @priv: private driver interface data
2548 * Returns: Pointer to own MAC address or %NULL on failure
2550 * This optional function can be used to get the own MAC address of the
2551 * device from the driver interface code. This is only needed if the
2552 * l2_packet implementation for the OS does not provide easy access to
2554 const u8
* (*get_mac_addr
)(void *priv
);
2557 * set_operstate - Sets device operating state to DORMANT or UP
2558 * @priv: private driver interface data
2559 * @state: 0 = dormant, 1 = up
2560 * Returns: 0 on success, -1 on failure
2562 * This is an optional function that can be used on operating systems
2563 * that support a concept of controlling network device state from user
2564 * space applications. This function, if set, gets called with
2565 * state = 1 when authentication has been completed and with state = 0
2566 * when connection is lost.
2568 int (*set_operstate
)(void *priv
, int state
);
2571 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2572 * @priv: Private driver interface data
2573 * @addr: Address of the station for which to set protection (may be
2574 * %NULL for group keys)
2575 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2576 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2577 * Returns: 0 on success, -1 on failure
2579 * This is an optional function that can be used to set the driver to
2580 * require protection for Tx and/or Rx frames. This uses the layer
2581 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2582 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2583 * set protection operation; instead, they set protection implicitly
2584 * based on configured keys.
2586 int (*mlme_setprotection
)(void *priv
, const u8
*addr
, int protect_type
,
2590 * get_hw_feature_data - Get hardware support data (channels and rates)
2591 * @priv: Private driver interface data
2592 * @num_modes: Variable for returning the number of returned modes
2593 * flags: Variable for returning hardware feature flags
2594 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
2595 * Returns: Pointer to allocated hardware data on success or %NULL on
2596 * failure. Caller is responsible for freeing this.
2598 struct hostapd_hw_modes
* (*get_hw_feature_data
)(void *priv
,
2600 u16
*flags
, u8
*dfs
);
2603 * send_mlme - Send management frame from MLME
2604 * @priv: Private driver interface data
2605 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2606 * @data_len: Size of the management frame
2607 * @noack: Do not wait for this frame to be acked (disable retries)
2608 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2610 * @csa_offs: Array of CSA offsets or %NULL
2611 * @csa_offs_len: Number of elements in csa_offs
2612 * Returns: 0 on success, -1 on failure
2614 int (*send_mlme
)(void *priv
, const u8
*data
, size_t data_len
,
2615 int noack
, unsigned int freq
, const u16
*csa_offs
,
2616 size_t csa_offs_len
);
2619 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2620 * @priv: Private driver interface data
2621 * @md: Mobility domain (2 octets) (also included inside ies)
2622 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2623 * @ies_len: Length of FT IEs in bytes
2624 * Returns: 0 on success, -1 on failure
2626 * The supplicant uses this callback to let the driver know that keying
2627 * material for FT is available and that the driver can use the
2628 * provided IEs in the next message in FT authentication sequence.
2630 * This function is only needed for driver that support IEEE 802.11r
2631 * (Fast BSS Transition).
2633 int (*update_ft_ies
)(void *priv
, const u8
*md
, const u8
*ies
,
2637 * get_scan_results2 - Fetch the latest scan results
2638 * @priv: private driver interface data
2640 * Returns: Allocated buffer of scan results (caller is responsible for
2641 * freeing the data structure) on success, NULL on failure
2643 struct wpa_scan_results
* (*get_scan_results2
)(void *priv
);
2646 * set_country - Set country
2647 * @priv: Private driver interface data
2648 * @alpha2: country to which to switch to
2649 * Returns: 0 on success, -1 on failure
2651 * This function is for drivers which support some form
2652 * of setting a regulatory domain.
2654 int (*set_country
)(void *priv
, const char *alpha2
);
2657 * get_country - Get country
2658 * @priv: Private driver interface data
2659 * @alpha2: Buffer for returning country code (at least 3 octets)
2660 * Returns: 0 on success, -1 on failure
2662 int (*get_country
)(void *priv
, char *alpha2
);
2665 * global_init - Global driver initialization
2666 * @ctx: wpa_global pointer
2667 * Returns: Pointer to private data (global), %NULL on failure
2669 * This optional function is called to initialize the driver wrapper
2670 * for global data, i.e., data that applies to all interfaces. If this
2671 * function is implemented, global_deinit() will also need to be
2672 * implemented to free the private data. The driver will also likely
2673 * use init2() function instead of init() to get the pointer to global
2674 * data available to per-interface initializer.
2676 void * (*global_init
)(void *ctx
);
2679 * global_deinit - Global driver deinitialization
2680 * @priv: private driver global data from global_init()
2682 * Terminate any global driver related functionality and free the
2683 * global data structure.
2685 void (*global_deinit
)(void *priv
);
2688 * init2 - Initialize driver interface (with global data)
2689 * @ctx: context to be used when calling wpa_supplicant functions,
2690 * e.g., wpa_supplicant_event()
2691 * @ifname: interface name, e.g., wlan0
2692 * @global_priv: private driver global data from global_init()
2693 * Returns: Pointer to private data, %NULL on failure
2695 * This function can be used instead of init() if the driver wrapper
2698 void * (*init2
)(void *ctx
, const char *ifname
, void *global_priv
);
2701 * get_interfaces - Get information about available interfaces
2702 * @global_priv: private driver global data from global_init()
2703 * Returns: Allocated buffer of interface information (caller is
2704 * responsible for freeing the data structure) on success, NULL on
2707 struct wpa_interface_info
* (*get_interfaces
)(void *global_priv
);
2710 * scan2 - Request the driver to initiate scan
2711 * @priv: private driver interface data
2712 * @params: Scan parameters
2714 * Returns: 0 on success, -1 on failure
2716 * Once the scan results are ready, the driver should report scan
2717 * results event for wpa_supplicant which will eventually request the
2718 * results with wpa_driver_get_scan_results2().
2720 int (*scan2
)(void *priv
, struct wpa_driver_scan_params
*params
);
2723 * authenticate - Request driver to authenticate
2724 * @priv: private driver interface data
2725 * @params: authentication parameters
2726 * Returns: 0 on success, -1 on failure
2728 * This is an optional function that can be used with drivers that
2729 * support separate authentication and association steps, i.e., when
2730 * wpa_supplicant can act as the SME. If not implemented, associate()
2731 * function is expected to take care of IEEE 802.11 authentication,
2734 int (*authenticate
)(void *priv
,
2735 struct wpa_driver_auth_params
*params
);
2738 * set_ap - Set Beacon and Probe Response information for AP mode
2739 * @priv: Private driver interface data
2740 * @params: Parameters to use in AP mode
2742 * This function is used to configure Beacon template and/or extra IEs
2743 * to add for Beacon and Probe Response frames for the driver in
2744 * AP mode. The driver is responsible for building the full Beacon
2745 * frame by concatenating the head part with TIM IE generated by the
2746 * driver/firmware and finishing with the tail part. Depending on the
2747 * driver architectue, this can be done either by using the full
2748 * template or the set of additional IEs (e.g., WPS and P2P IE).
2749 * Similarly, Probe Response processing depends on the driver design.
2750 * If the driver (or firmware) takes care of replying to Probe Request
2751 * frames, the extra IEs provided here needs to be added to the Probe
2754 * Returns: 0 on success, -1 on failure
2756 int (*set_ap
)(void *priv
, struct wpa_driver_ap_params
*params
);
2759 * set_acl - Set ACL in AP mode
2760 * @priv: Private driver interface data
2761 * @params: Parameters to configure ACL
2762 * Returns: 0 on success, -1 on failure
2764 * This is used only for the drivers which support MAC address ACL.
2766 int (*set_acl
)(void *priv
, struct hostapd_acl_params
*params
);
2769 * hapd_init - Initialize driver interface (hostapd only)
2770 * @hapd: Pointer to hostapd context
2771 * @params: Configuration for the driver wrapper
2772 * Returns: Pointer to private data, %NULL on failure
2774 * This function is used instead of init() or init2() when the driver
2775 * wrapper is used with hostapd.
2777 void * (*hapd_init
)(struct hostapd_data
*hapd
,
2778 struct wpa_init_params
*params
);
2781 * hapd_deinit - Deinitialize driver interface (hostapd only)
2782 * @priv: Private driver interface data from hapd_init()
2784 void (*hapd_deinit
)(void *priv
);
2787 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2788 * @priv: Private driver interface data
2789 * @params: BSS parameters
2790 * Returns: 0 on success, -1 on failure
2792 * This is an optional function to configure the kernel driver to
2793 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2794 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2795 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2796 * for Beacon frames.
2798 * DEPRECATED - use set_ap() instead
2800 int (*set_ieee8021x
)(void *priv
, struct wpa_bss_params
*params
);
2803 * set_privacy - Enable/disable privacy (AP only)
2804 * @priv: Private driver interface data
2805 * @enabled: 1 = privacy enabled, 0 = disabled
2806 * Returns: 0 on success, -1 on failure
2808 * This is an optional function to configure privacy field in the
2809 * kernel driver for Beacon frames. This can be left undefined (set to
2810 * %NULL) if the driver uses the Beacon template from set_ap().
2812 * DEPRECATED - use set_ap() instead
2814 int (*set_privacy
)(void *priv
, int enabled
);
2817 * get_seqnum - Fetch the current TSC/packet number (AP only)
2818 * @ifname: The interface name (main or virtual)
2819 * @priv: Private driver interface data
2820 * @addr: MAC address of the station or %NULL for group keys
2822 * @seq: Buffer for returning the latest used TSC/packet number
2823 * Returns: 0 on success, -1 on failure
2825 * This function is used to fetch the last used TSC/packet number for
2826 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2827 * keys, so there is no strict requirement on implementing support for
2828 * unicast keys (i.e., addr != %NULL).
2830 int (*get_seqnum
)(const char *ifname
, void *priv
, const u8
*addr
,
2834 * flush - Flush all association stations (AP only)
2835 * @priv: Private driver interface data
2836 * Returns: 0 on success, -1 on failure
2838 * This function requests the driver to disassociate all associated
2839 * stations. This function does not need to be implemented if the
2840 * driver does not process association frames internally.
2842 int (*flush
)(void *priv
);
2845 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2846 * @priv: Private driver interface data
2847 * @elem: Information elements
2848 * @elem_len: Length of the elem buffer in octets
2849 * Returns: 0 on success, -1 on failure
2851 * This is an optional function to add information elements in the
2852 * kernel driver for Beacon and Probe Response frames. This can be left
2853 * undefined (set to %NULL) if the driver uses the Beacon template from
2856 * DEPRECATED - use set_ap() instead
2858 int (*set_generic_elem
)(void *priv
, const u8
*elem
, size_t elem_len
);
2861 * read_sta_data - Fetch station data
2862 * @priv: Private driver interface data
2863 * @data: Buffer for returning station information
2864 * @addr: MAC address of the station
2865 * Returns: 0 on success, -1 on failure
2867 int (*read_sta_data
)(void *priv
, struct hostap_sta_driver_data
*data
,
2871 * hapd_send_eapol - Send an EAPOL packet (AP only)
2872 * @priv: private driver interface data
2873 * @addr: Destination MAC address
2874 * @data: EAPOL packet starting with IEEE 802.1X header
2875 * @data_len: Length of the EAPOL packet in octets
2876 * @encrypt: Whether the frame should be encrypted
2877 * @own_addr: Source MAC address
2878 * @flags: WPA_STA_* flags for the destination station
2880 * Returns: 0 on success, -1 on failure
2882 int (*hapd_send_eapol
)(void *priv
, const u8
*addr
, const u8
*data
,
2883 size_t data_len
, int encrypt
,
2884 const u8
*own_addr
, u32 flags
);
2887 * sta_deauth - Deauthenticate a station (AP only)
2888 * @priv: Private driver interface data
2889 * @own_addr: Source address and BSSID for the Deauthentication frame
2890 * @addr: MAC address of the station to deauthenticate
2891 * @reason: Reason code for the Deauthentiation frame
2892 * Returns: 0 on success, -1 on failure
2894 * This function requests a specific station to be deauthenticated and
2895 * a Deauthentication frame to be sent to it.
2897 int (*sta_deauth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2901 * sta_disassoc - Disassociate a station (AP only)
2902 * @priv: Private driver interface data
2903 * @own_addr: Source address and BSSID for the Disassociation frame
2904 * @addr: MAC address of the station to disassociate
2905 * @reason: Reason code for the Disassociation frame
2906 * Returns: 0 on success, -1 on failure
2908 * This function requests a specific station to be disassociated and
2909 * a Disassociation frame to be sent to it.
2911 int (*sta_disassoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2915 * sta_remove - Remove a station entry (AP only)
2916 * @priv: Private driver interface data
2917 * @addr: MAC address of the station to be removed
2918 * Returns: 0 on success, -1 on failure
2920 int (*sta_remove
)(void *priv
, const u8
*addr
);
2923 * hapd_get_ssid - Get the current SSID (AP only)
2924 * @priv: Private driver interface data
2925 * @buf: Buffer for returning the SSID
2926 * @len: Maximum length of the buffer
2927 * Returns: Length of the SSID on success, -1 on failure
2929 * This function need not be implemented if the driver uses Beacon
2930 * template from set_ap() and does not reply to Probe Request frames.
2932 int (*hapd_get_ssid
)(void *priv
, u8
*buf
, int len
);
2935 * hapd_set_ssid - Set SSID (AP only)
2936 * @priv: Private driver interface data
2938 * @len: Length of the SSID in octets
2939 * Returns: 0 on success, -1 on failure
2941 * DEPRECATED - use set_ap() instead
2943 int (*hapd_set_ssid
)(void *priv
, const u8
*buf
, int len
);
2946 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2947 * @priv: Private driver interface data
2948 * @enabled: 1 = countermeasures enabled, 0 = disabled
2949 * Returns: 0 on success, -1 on failure
2951 * This need not be implemented if the driver does not take care of
2952 * association processing.
2954 int (*hapd_set_countermeasures
)(void *priv
, int enabled
);
2957 * sta_add - Add a station entry
2958 * @priv: Private driver interface data
2959 * @params: Station parameters
2960 * Returns: 0 on success, -1 on failure
2962 * This function is used to add or set (params->set 1) a station
2963 * entry in the driver. Adding STA entries is used only if the driver
2964 * does not take care of association processing.
2966 * With drivers that don't support full AP client state, this function
2967 * is used to add a station entry to the driver once the station has
2968 * completed association.
2970 * With TDLS, this function is used to add or set (params->set 1)
2971 * TDLS peer entries (even with drivers that do not support full AP
2974 int (*sta_add
)(void *priv
, struct hostapd_sta_add_params
*params
);
2977 * get_inact_sec - Get station inactivity duration (AP only)
2978 * @priv: Private driver interface data
2979 * @addr: Station address
2980 * Returns: Number of seconds station has been inactive, -1 on failure
2982 int (*get_inact_sec
)(void *priv
, const u8
*addr
);
2985 * sta_clear_stats - Clear station statistics (AP only)
2986 * @priv: Private driver interface data
2987 * @addr: Station address
2988 * Returns: 0 on success, -1 on failure
2990 int (*sta_clear_stats
)(void *priv
, const u8
*addr
);
2993 * set_freq - Set channel/frequency (AP only)
2994 * @priv: Private driver interface data
2995 * @freq: Channel parameters
2996 * Returns: 0 on success, -1 on failure
2998 int (*set_freq
)(void *priv
, struct hostapd_freq_params
*freq
);
3001 * set_rts - Set RTS threshold
3002 * @priv: Private driver interface data
3003 * @rts: RTS threshold in octets
3004 * Returns: 0 on success, -1 on failure
3006 int (*set_rts
)(void *priv
, int rts
);
3009 * set_frag - Set fragmentation threshold
3010 * @priv: Private driver interface data
3011 * @frag: Fragmentation threshold in octets
3012 * Returns: 0 on success, -1 on failure
3014 int (*set_frag
)(void *priv
, int frag
);
3017 * sta_set_flags - Set station flags (AP only)
3018 * @priv: Private driver interface data
3019 * @addr: Station address
3020 * @total_flags: Bitmap of all WPA_STA_* flags currently set
3021 * @flags_or: Bitmap of WPA_STA_* flags to add
3022 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
3023 * Returns: 0 on success, -1 on failure
3025 int (*sta_set_flags
)(void *priv
, const u8
*addr
,
3026 unsigned int total_flags
, unsigned int flags_or
,
3027 unsigned int flags_and
);
3030 * sta_set_airtime_weight - Set station airtime weight (AP only)
3031 * @priv: Private driver interface data
3032 * @addr: Station address
3033 * @weight: New weight for station airtime assignment
3034 * Returns: 0 on success, -1 on failure
3036 int (*sta_set_airtime_weight
)(void *priv
, const u8
*addr
,
3037 unsigned int weight
);
3040 * set_tx_queue_params - Set TX queue parameters
3041 * @priv: Private driver interface data
3042 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
3046 * @burst_time: Maximum length for bursting in 0.1 msec units
3048 int (*set_tx_queue_params
)(void *priv
, int queue
, int aifs
, int cw_min
,
3049 int cw_max
, int burst_time
);
3052 * if_add - Add a virtual interface
3053 * @priv: Private driver interface data
3054 * @type: Interface type
3055 * @ifname: Interface name for the new virtual interface
3056 * @addr: Local address to use for the interface or %NULL to use the
3057 * parent interface address
3058 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
3059 * @drv_priv: Pointer for overwriting the driver context or %NULL if
3060 * not allowed (applies only to %WPA_IF_AP_BSS type)
3061 * @force_ifname: Buffer for returning an interface name that the
3062 * driver ended up using if it differs from the requested ifname
3063 * @if_addr: Buffer for returning the allocated interface address
3064 * (this may differ from the requested addr if the driver cannot
3065 * change interface address)
3066 * @bridge: Bridge interface to use or %NULL if no bridge configured
3067 * @use_existing: Whether to allow existing interface to be used
3068 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
3069 * Returns: 0 on success, -1 on failure
3071 int (*if_add
)(void *priv
, enum wpa_driver_if_type type
,
3072 const char *ifname
, const u8
*addr
, void *bss_ctx
,
3073 void **drv_priv
, char *force_ifname
, u8
*if_addr
,
3074 const char *bridge
, int use_existing
, int setup_ap
);
3077 * if_remove - Remove a virtual interface
3078 * @priv: Private driver interface data
3079 * @type: Interface type
3080 * @ifname: Interface name of the virtual interface to be removed
3081 * Returns: 0 on success, -1 on failure
3083 int (*if_remove
)(void *priv
, enum wpa_driver_if_type type
,
3084 const char *ifname
);
3087 * set_sta_vlan - Bind a station into a specific interface (AP only)
3088 * @priv: Private driver interface data
3089 * @ifname: Interface (main or virtual BSS or VLAN)
3090 * @addr: MAC address of the associated station
3092 * Returns: 0 on success, -1 on failure
3094 * This function is used to bind a station to a specific virtual
3095 * interface. It is only used if when virtual interfaces are supported,
3096 * e.g., to assign stations to different VLAN interfaces based on
3097 * information from a RADIUS server. This allows separate broadcast
3098 * domains to be used with a single BSS.
3100 int (*set_sta_vlan
)(void *priv
, const u8
*addr
, const char *ifname
,
3104 * commit - Optional commit changes handler (AP only)
3105 * @priv: driver private data
3106 * Returns: 0 on success, -1 on failure
3108 * This optional handler function can be registered if the driver
3109 * interface implementation needs to commit changes (e.g., by setting
3110 * network interface up) at the end of initial configuration. If set,
3111 * this handler will be called after initial setup has been completed.
3113 int (*commit
)(void *priv
);
3116 * send_ether - Send an ethernet packet (AP only)
3117 * @priv: private driver interface data
3118 * @dst: Destination MAC address
3119 * @src: Source MAC address
3121 * @data: EAPOL packet starting with IEEE 802.1X header
3122 * @data_len: Length of the EAPOL packet in octets
3123 * Returns: 0 on success, -1 on failure
3125 int (*send_ether
)(void *priv
, const u8
*dst
, const u8
*src
, u16 proto
,
3126 const u8
*data
, size_t data_len
);
3129 * set_radius_acl_auth - Notification of RADIUS ACL change
3130 * @priv: Private driver interface data
3131 * @mac: MAC address of the station
3132 * @accepted: Whether the station was accepted
3133 * @session_timeout: Session timeout for the station
3134 * Returns: 0 on success, -1 on failure
3136 int (*set_radius_acl_auth
)(void *priv
, const u8
*mac
, int accepted
,
3137 u32 session_timeout
);
3140 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3141 * @priv: Private driver interface data
3142 * @mac: MAC address of the station
3143 * Returns: 0 on success, -1 on failure
3145 int (*set_radius_acl_expire
)(void *priv
, const u8
*mac
);
3148 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
3149 * @priv: Private driver interface data
3150 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3151 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3153 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3154 * to remove extra IE(s)
3155 * Returns: 0 on success, -1 on failure
3157 * This is an optional function to add WPS IE in the kernel driver for
3158 * Beacon and Probe Response frames. This can be left undefined (set
3159 * to %NULL) if the driver uses the Beacon template from set_ap()
3160 * and does not process Probe Request frames. If the driver takes care
3161 * of (Re)Association frame processing, the assocresp buffer includes
3162 * WPS IE(s) that need to be added to (Re)Association Response frames
3163 * whenever a (Re)Association Request frame indicated use of WPS.
3165 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3166 * frames when operating as a GO. The driver is responsible for adding
3167 * timing related attributes (e.g., NoA) in addition to the IEs
3168 * included here by appending them after these buffers. This call is
3169 * also used to provide Probe Response IEs for P2P Listen state
3170 * operations for drivers that generate the Probe Response frames
3173 * DEPRECATED - use set_ap() instead
3175 int (*set_ap_wps_ie
)(void *priv
, const struct wpabuf
*beacon
,
3176 const struct wpabuf
*proberesp
,
3177 const struct wpabuf
*assocresp
);
3180 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3181 * @priv: Private driver interface data
3182 * @authorized: Whether the port is authorized
3183 * Returns: 0 on success, -1 on failure
3185 int (*set_supp_port
)(void *priv
, int authorized
);
3188 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3189 * @priv: Private driver interface data
3190 * @addr: MAC address of the associated station
3191 * @aid: Association ID
3192 * @val: 1 = bind to 4-address WDS; 0 = unbind
3193 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3194 * to indicate that bridge is not to be used
3195 * @ifname_wds: Buffer to return the interface name for the new WDS
3196 * station or %NULL to indicate name is not returned.
3197 * Returns: 0 on success, -1 on failure
3199 int (*set_wds_sta
)(void *priv
, const u8
*addr
, int aid
, int val
,
3200 const char *bridge_ifname
, char *ifname_wds
);
3203 * send_action - Transmit an Action frame
3204 * @priv: Private driver interface data
3205 * @freq: Frequency (in MHz) of the channel
3206 * @wait: Time to wait off-channel for a response (in ms), or zero
3207 * @dst: Destination MAC address (Address 1)
3208 * @src: Source MAC address (Address 2)
3209 * @bssid: BSSID (Address 3)
3211 * @data_len: data length in octets
3212 @ @no_cck: Whether CCK rates must not be used to transmit this frame
3213 * Returns: 0 on success, -1 on failure
3215 * This command can be used to request the driver to transmit an action
3216 * frame to the specified destination.
3218 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3219 * be transmitted on the given channel and the device will wait for a
3220 * response on that channel for the given wait time.
3222 * If the flag is not set, the wait time will be ignored. In this case,
3223 * if a remain-on-channel duration is in progress, the frame must be
3224 * transmitted on that channel; alternatively the frame may be sent on
3225 * the current operational channel (if in associated state in station
3226 * mode or while operating as an AP.)
3228 * If @src differs from the device MAC address, use of a random
3229 * transmitter address is requested for this message exchange.
3231 int (*send_action
)(void *priv
, unsigned int freq
, unsigned int wait
,
3232 const u8
*dst
, const u8
*src
, const u8
*bssid
,
3233 const u8
*data
, size_t data_len
, int no_cck
);
3236 * send_action_cancel_wait - Cancel action frame TX wait
3237 * @priv: Private driver interface data
3239 * This command cancels the wait time associated with sending an action
3240 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3241 * set in the driver flags.
3243 void (*send_action_cancel_wait
)(void *priv
);
3246 * remain_on_channel - Remain awake on a channel
3247 * @priv: Private driver interface data
3248 * @freq: Frequency (in MHz) of the channel
3249 * @duration: Duration in milliseconds
3250 * Returns: 0 on success, -1 on failure
3252 * This command is used to request the driver to remain awake on the
3253 * specified channel for the specified duration and report received
3254 * Action frames with EVENT_RX_MGMT events. Optionally, received
3255 * Probe Request frames may also be requested to be reported by calling
3256 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3258 * The driver may not be at the requested channel when this function
3259 * returns, i.e., the return code is only indicating whether the
3260 * request was accepted. The caller will need to wait until the
3261 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3262 * completed the channel change. This may take some time due to other
3263 * need for the radio and the caller should be prepared to timing out
3264 * its wait since there are no guarantees on when this request can be
3267 int (*remain_on_channel
)(void *priv
, unsigned int freq
,
3268 unsigned int duration
);
3271 * cancel_remain_on_channel - Cancel remain-on-channel operation
3272 * @priv: Private driver interface data
3274 * This command can be used to cancel a remain-on-channel operation
3275 * before its originally requested duration has passed. This could be
3276 * used, e.g., when remain_on_channel() is used to request extra time
3277 * to receive a response to an Action frame and the response is
3278 * received when there is still unneeded time remaining on the
3279 * remain-on-channel operation.
3281 int (*cancel_remain_on_channel
)(void *priv
);
3284 * probe_req_report - Request Probe Request frames to be indicated
3285 * @priv: Private driver interface data
3286 * @report: Whether to report received Probe Request frames
3287 * Returns: 0 on success, -1 on failure (or if not supported)
3289 * This command can be used to request the driver to indicate when
3290 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3291 * Since this operation may require extra resources, e.g., due to less
3292 * optimal hardware/firmware RX filtering, many drivers may disable
3293 * Probe Request reporting at least in station mode. This command is
3294 * used to notify the driver when the Probe Request frames need to be
3295 * reported, e.g., during remain-on-channel operations.
3297 int (*probe_req_report
)(void *priv
, int report
);
3300 * deinit_ap - Deinitialize AP mode
3301 * @priv: Private driver interface data
3302 * Returns: 0 on success, -1 on failure (or if not supported)
3304 * This optional function can be used to disable AP mode related
3305 * configuration. If the interface was not dynamically added,
3306 * change the driver mode to station mode to allow normal station
3307 * operations like scanning to be completed.
3309 int (*deinit_ap
)(void *priv
);
3312 * deinit_p2p_cli - Deinitialize P2P client mode
3313 * @priv: Private driver interface data
3314 * Returns: 0 on success, -1 on failure (or if not supported)
3316 * This optional function can be used to disable P2P client mode. If the
3317 * interface was not dynamically added, change the interface type back
3320 int (*deinit_p2p_cli
)(void *priv
);
3323 * suspend - Notification on system suspend/hibernate event
3324 * @priv: Private driver interface data
3326 void (*suspend
)(void *priv
);
3329 * resume - Notification on system resume/thaw event
3330 * @priv: Private driver interface data
3332 void (*resume
)(void *priv
);
3335 * signal_monitor - Set signal monitoring parameters
3336 * @priv: Private driver interface data
3337 * @threshold: Threshold value for signal change events; 0 = disabled
3338 * @hysteresis: Minimum change in signal strength before indicating a
3340 * Returns: 0 on success, -1 on failure (or if not supported)
3342 * This function can be used to configure monitoring of signal strength
3343 * with the current AP. Whenever signal strength drops below the
3344 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3345 * should be generated assuming the signal strength has changed at
3346 * least %hysteresis from the previously indicated signal change event.
3348 int (*signal_monitor
)(void *priv
, int threshold
, int hysteresis
);
3351 * send_frame - Send IEEE 802.11 frame (testing use only)
3352 * @priv: Private driver interface data
3353 * @data: IEEE 802.11 frame with IEEE 802.11 header
3354 * @data_len: Size of the frame
3355 * @encrypt: Whether to encrypt the frame (if keys are set)
3356 * Returns: 0 on success, -1 on failure
3358 * This function is only used for debugging purposes and is not
3359 * required to be implemented for normal operations.
3361 int (*send_frame
)(void *priv
, const u8
*data
, size_t data_len
,
3365 * get_noa - Get current Notice of Absence attribute payload
3366 * @priv: Private driver interface data
3367 * @buf: Buffer for returning NoA
3368 * @buf_len: Buffer length in octets
3369 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3370 * advertized, or -1 on failure
3372 * This function is used to fetch the current Notice of Absence
3373 * attribute value from GO.
3375 int (*get_noa
)(void *priv
, u8
*buf
, size_t buf_len
);
3378 * set_noa - Set Notice of Absence parameters for GO (testing)
3379 * @priv: Private driver interface data
3381 * @start: Start time in ms from next TBTT
3382 * @duration: Duration in ms
3383 * Returns: 0 on success or -1 on failure
3385 * This function is used to set Notice of Absence parameters for GO. It
3386 * is used only for testing. To disable NoA, all parameters are set to
3389 int (*set_noa
)(void *priv
, u8 count
, int start
, int duration
);
3392 * set_p2p_powersave - Set P2P power save options
3393 * @priv: Private driver interface data
3394 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3395 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3396 * @ctwindow: 0.. = change (msec), -1 = no change
3397 * Returns: 0 on success or -1 on failure
3399 int (*set_p2p_powersave
)(void *priv
, int legacy_ps
, int opp_ps
,
3403 * ampdu - Enable/disable aggregation
3404 * @priv: Private driver interface data
3405 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3406 * Returns: 0 on success or -1 on failure
3408 int (*ampdu
)(void *priv
, int ampdu
);
3411 * get_radio_name - Get physical radio name for the device
3412 * @priv: Private driver interface data
3413 * Returns: Radio name or %NULL if not known
3415 * The returned data must not be modified by the caller. It is assumed
3416 * that any interface that has the same radio name as another is
3417 * sharing the same physical radio. This information can be used to
3418 * share scan results etc. information between the virtual interfaces
3419 * to speed up various operations.
3421 const char * (*get_radio_name
)(void *priv
);
3424 * send_tdls_mgmt - for sending TDLS management packets
3425 * @priv: private driver interface data
3426 * @dst: Destination (peer) MAC address
3427 * @action_code: TDLS action code for the mssage
3428 * @dialog_token: Dialog Token to use in the message (if needed)
3429 * @status_code: Status Code or Reason Code to use (if needed)
3430 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
3431 * @initiator: Is the current end the TDLS link initiator
3432 * @buf: TDLS IEs to add to the message
3433 * @len: Length of buf in octets
3434 * Returns: 0 on success, negative (<0) on failure
3436 * This optional function can be used to send packet to driver which is
3437 * responsible for receiving and sending all TDLS packets.
3439 int (*send_tdls_mgmt
)(void *priv
, const u8
*dst
, u8 action_code
,
3440 u8 dialog_token
, u16 status_code
, u32 peer_capab
,
3441 int initiator
, const u8
*buf
, size_t len
);
3444 * tdls_oper - Ask the driver to perform high-level TDLS operations
3445 * @priv: Private driver interface data
3446 * @oper: TDLS high-level operation. See %enum tdls_oper
3447 * @peer: Destination (peer) MAC address
3448 * Returns: 0 on success, negative (<0) on failure
3450 * This optional function can be used to send high-level TDLS commands
3453 int (*tdls_oper
)(void *priv
, enum tdls_oper oper
, const u8
*peer
);
3456 * wnm_oper - Notify driver of the WNM frame reception
3457 * @priv: Private driver interface data
3458 * @oper: WNM operation. See %enum wnm_oper
3459 * @peer: Destination (peer) MAC address
3460 * @buf: Buffer for the driver to fill in (for getting IE)
3461 * @buf_len: Return the len of buf
3462 * Returns: 0 on success, negative (<0) on failure
3464 int (*wnm_oper
)(void *priv
, enum wnm_oper oper
, const u8
*peer
,
3465 u8
*buf
, u16
*buf_len
);
3468 * set_qos_map - Set QoS Map
3469 * @priv: Private driver interface data
3470 * @qos_map_set: QoS Map
3471 * @qos_map_set_len: Length of QoS Map
3473 int (*set_qos_map
)(void *priv
, const u8
*qos_map_set
,
3474 u8 qos_map_set_len
);
3477 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3478 * @priv: Private driver interface data
3479 * @version: IP version of the IP address, 4 or 6
3480 * @ipaddr: IP address for the neigh entry
3481 * @prefixlen: IP address prefix length
3482 * @addr: Corresponding MAC address
3483 * Returns: 0 on success, negative (<0) on failure
3485 int (*br_add_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
,
3486 int prefixlen
, const u8
*addr
);
3489 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3490 * @priv: Private driver interface data
3491 * @version: IP version of the IP address, 4 or 6
3492 * @ipaddr: IP address for the neigh entry
3493 * Returns: 0 on success, negative (<0) on failure
3495 int (*br_delete_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
);
3498 * br_port_set_attr - Set a bridge port attribute
3499 * @attr: Bridge port attribute to set
3500 * @val: Value to be set
3501 * Returns: 0 on success, negative (<0) on failure
3503 int (*br_port_set_attr
)(void *priv
, enum drv_br_port_attr attr
,
3507 * br_port_set_attr - Set a bridge network parameter
3508 * @param: Bridge parameter to set
3509 * @val: Value to be set
3510 * Returns: 0 on success, negative (<0) on failure
3512 int (*br_set_net_param
)(void *priv
, enum drv_br_net_param param
,
3516 * get_wowlan - Get wake-on-wireless status
3517 * @priv: Private driver interface data
3519 int (*get_wowlan
)(void *priv
);
3522 * set_wowlan - Set wake-on-wireless triggers
3523 * @priv: Private driver interface data
3524 * @triggers: wowlan triggers
3526 int (*set_wowlan
)(void *priv
, const struct wowlan_triggers
*triggers
);
3529 * signal_poll - Get current connection information
3530 * @priv: Private driver interface data
3531 * @signal_info: Connection info structure
3533 int (*signal_poll
)(void *priv
, struct wpa_signal_info
*signal_info
);
3536 * channel_info - Get parameters of the current operating channel
3537 * @priv: Private driver interface data
3538 * @channel_info: Channel info structure
3539 * Returns: 0 on success, negative (<0) on failure
3541 int (*channel_info
)(void *priv
, struct wpa_channel_info
*channel_info
);
3544 * set_authmode - Set authentication algorithm(s) for static WEP
3545 * @priv: Private driver interface data
3546 * @authmode: 1=Open System, 2=Shared Key, 3=both
3547 * Returns: 0 on success, -1 on failure
3549 * This function can be used to set authentication algorithms for AP
3550 * mode when static WEP is used. If the driver uses user space MLME/SME
3551 * implementation, there is no need to implement this function.
3553 * DEPRECATED - use set_ap() instead
3555 int (*set_authmode
)(void *priv
, int authmode
);
3559 * driver_cmd - Execute driver-specific command
3560 * @priv: Private driver interface data
3561 * @cmd: Command to execute
3562 * @buf: Return buffer
3563 * @buf_len: Buffer length
3564 * Returns: 0 on success, -1 on failure
3566 int (*driver_cmd
)(void *priv
, char *cmd
, char *buf
, size_t buf_len
);
3567 #endif /* ANDROID */
3570 * vendor_cmd - Execute vendor specific command
3571 * @priv: Private driver interface data
3572 * @vendor_id: Vendor id
3573 * @subcmd: Vendor command id
3574 * @data: Vendor command parameters (%NULL if no parameters)
3575 * @data_len: Data length
3576 * @buf: Return buffer (%NULL to ignore reply)
3577 * Returns: 0 on success, negative (<0) on failure
3579 * This function handles vendor specific commands that are passed to
3580 * the driver/device. The command is identified by vendor id and
3581 * command id. Parameters can be passed as argument to the command
3582 * in the data buffer. Reply (if any) will be filled in the supplied
3585 * The exact driver behavior is driver interface and vendor specific. As
3586 * an example, this will be converted to a vendor specific cfg80211
3587 * command in case of the nl80211 driver interface.
3589 int (*vendor_cmd
)(void *priv
, unsigned int vendor_id
,
3590 unsigned int subcmd
, const u8
*data
, size_t data_len
,
3591 struct wpabuf
*buf
);
3594 * set_rekey_info - Set rekey information
3595 * @priv: Private driver interface data
3597 * @kek_len: KEK length in octets
3599 * @kck_len: KCK length in octets
3600 * @replay_ctr: Current EAPOL-Key Replay Counter
3602 * This optional function can be used to provide information for the
3603 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3604 * while the host (including wpa_supplicant) is sleeping.
3606 void (*set_rekey_info
)(void *priv
, const u8
*kek
, size_t kek_len
,
3607 const u8
*kck
, size_t kck_len
,
3608 const u8
*replay_ctr
);
3611 * sta_assoc - Station association indication
3612 * @priv: Private driver interface data
3613 * @own_addr: Source address and BSSID for association frame
3614 * @addr: MAC address of the station to associate
3615 * @reassoc: flag to indicate re-association
3616 * @status: association response status code
3617 * @ie: assoc response ie buffer
3618 * @len: ie buffer length
3619 * Returns: 0 on success, -1 on failure
3621 * This function indicates the driver to send (Re)Association
3622 * Response frame to the station.
3624 int (*sta_assoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
3625 int reassoc
, u16 status
, const u8
*ie
, size_t len
);
3628 * sta_auth - Station authentication indication
3629 * @priv: private driver interface data
3630 * @params: Station authentication parameters
3632 * Returns: 0 on success, -1 on failure
3634 int (*sta_auth
)(void *priv
,
3635 struct wpa_driver_sta_auth_params
*params
);
3638 * add_tspec - Add traffic stream
3639 * @priv: Private driver interface data
3640 * @addr: MAC address of the station to associate
3641 * @tspec_ie: tspec ie buffer
3642 * @tspec_ielen: tspec ie length
3643 * Returns: 0 on success, -1 on failure
3645 * This function adds the traffic steam for the station
3646 * and fills the medium_time in tspec_ie.
3648 int (*add_tspec
)(void *priv
, const u8
*addr
, u8
*tspec_ie
,
3649 size_t tspec_ielen
);
3652 * add_sta_node - Add a station node in the driver
3653 * @priv: Private driver interface data
3654 * @addr: MAC address of the station to add
3655 * @auth_alg: authentication algorithm used by the station
3656 * Returns: 0 on success, -1 on failure
3658 * This function adds the station node in the driver, when
3659 * the station gets added by FT-over-DS.
3661 int (*add_sta_node
)(void *priv
, const u8
*addr
, u16 auth_alg
);
3664 * sched_scan - Request the driver to initiate scheduled scan
3665 * @priv: Private driver interface data
3666 * @params: Scan parameters
3667 * Returns: 0 on success, -1 on failure
3669 * This operation should be used for scheduled scan offload to
3670 * the hardware. Every time scan results are available, the
3671 * driver should report scan results event for wpa_supplicant
3672 * which will eventually request the results with
3673 * wpa_driver_get_scan_results2(). This operation is optional
3674 * and if not provided or if it returns -1, we fall back to
3675 * normal host-scheduled scans.
3677 int (*sched_scan
)(void *priv
, struct wpa_driver_scan_params
*params
);
3680 * stop_sched_scan - Request the driver to stop a scheduled scan
3681 * @priv: Private driver interface data
3682 * Returns: 0 on success, -1 on failure
3684 * This should cause the scheduled scan to be stopped and
3685 * results should stop being sent. Must be supported if
3686 * sched_scan is supported.
3688 int (*stop_sched_scan
)(void *priv
);
3691 * poll_client - Probe (null data or such) the given station
3692 * @priv: Private driver interface data
3693 * @own_addr: MAC address of sending interface
3694 * @addr: MAC address of the station to probe
3695 * @qos: Indicates whether station is QoS station
3697 * This function is used to verify whether an associated station is
3698 * still present. This function does not need to be implemented if the
3699 * driver provides such inactivity polling mechanism.
3701 void (*poll_client
)(void *priv
, const u8
*own_addr
,
3702 const u8
*addr
, int qos
);
3705 * radio_disable - Disable/enable radio
3706 * @priv: Private driver interface data
3707 * @disabled: 1=disable 0=enable radio
3708 * Returns: 0 on success, -1 on failure
3710 * This optional command is for testing purposes. It can be used to
3711 * disable the radio on a testbed device to simulate out-of-radio-range
3714 int (*radio_disable
)(void *priv
, int disabled
);
3717 * switch_channel - Announce channel switch and migrate the GO to the
3719 * @priv: Private driver interface data
3720 * @settings: Settings for CSA period and new channel
3721 * Returns: 0 on success, -1 on failure
3723 * This function is used to move the GO to the legacy STA channel to
3724 * avoid frequency conflict in single channel concurrency.
3726 int (*switch_channel
)(void *priv
, struct csa_settings
*settings
);
3729 * add_tx_ts - Add traffic stream
3730 * @priv: Private driver interface data
3731 * @tsid: Traffic stream ID
3732 * @addr: Receiver address
3733 * @user_prio: User priority of the traffic stream
3734 * @admitted_time: Admitted time for this TS in units of
3735 * 32 microsecond periods (per second).
3736 * Returns: 0 on success, -1 on failure
3738 int (*add_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
, u8 user_prio
,
3742 * del_tx_ts - Delete traffic stream
3743 * @priv: Private driver interface data
3744 * @tsid: Traffic stream ID
3745 * @addr: Receiver address
3746 * Returns: 0 on success, -1 on failure
3748 int (*del_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
);
3751 * Enable channel-switching with TDLS peer
3752 * @priv: Private driver interface data
3753 * @addr: MAC address of the TDLS peer
3754 * @oper_class: Operating class of the switch channel
3755 * @params: Channel specification
3756 * Returns: 0 on success, -1 on failure
3758 * The function indicates to driver that it can start switching to a
3759 * different channel with a specified TDLS peer. The switching is
3760 * assumed on until canceled with tdls_disable_channel_switch().
3762 int (*tdls_enable_channel_switch
)(
3763 void *priv
, const u8
*addr
, u8 oper_class
,
3764 const struct hostapd_freq_params
*params
);
3767 * Disable channel switching with TDLS peer
3768 * @priv: Private driver interface data
3769 * @addr: MAC address of the TDLS peer
3770 * Returns: 0 on success, -1 on failure
3772 * This function indicates to the driver that it should stop switching
3773 * with a given TDLS peer.
3775 int (*tdls_disable_channel_switch
)(void *priv
, const u8
*addr
);
3778 * start_dfs_cac - Listen for radar interference on the channel
3779 * @priv: Private driver interface data
3780 * @freq: Channel parameters
3781 * Returns: 0 on success, -1 on failure
3783 int (*start_dfs_cac
)(void *priv
, struct hostapd_freq_params
*freq
);
3786 * stop_ap - Removes beacon from AP
3787 * @priv: Private driver interface data
3788 * Returns: 0 on success, -1 on failure (or if not supported)
3790 * This optional function can be used to disable AP mode related
3791 * configuration. Unlike deinit_ap, it does not change to station
3794 int (*stop_ap
)(void *priv
);
3797 * get_survey - Retrieve survey data
3798 * @priv: Private driver interface data
3799 * @freq: If set, survey data for the specified frequency is only
3800 * being requested. If not set, all survey data is requested.
3801 * Returns: 0 on success, -1 on failure
3803 * Use this to retrieve:
3805 * - the observed channel noise floor
3806 * - the amount of time we have spent on the channel
3807 * - the amount of time during which we have spent on the channel that
3808 * the radio has determined the medium is busy and we cannot
3810 * - the amount of time we have spent receiving data
3811 * - the amount of time we have spent transmitting data
3813 * This data can be used for spectrum heuristics. One example is
3814 * Automatic Channel Selection (ACS). The channel survey data is
3815 * kept on a linked list on the channel data, one entry is added
3816 * for each survey. The min_nf of the channel is updated for each
3819 int (*get_survey
)(void *priv
, unsigned int freq
);
3822 * status - Get driver interface status information
3823 * @priv: Private driver interface data
3824 * @buf: Buffer for printing the status information
3825 * @buflen: Maximum length of the buffer
3826 * Returns: Length of written status information or -1 on failure
3828 int (*status
)(void *priv
, char *buf
, size_t buflen
);
3831 * roaming - Set roaming policy for driver-based BSS selection
3832 * @priv: Private driver interface data
3833 * @allowed: Whether roaming within ESS is allowed
3834 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3835 * Returns: Length of written status information or -1 on failure
3837 * This optional callback can be used to update roaming policy from the
3838 * associate() command (bssid being set there indicates that the driver
3839 * should not roam before getting this roaming() call to allow roaming.
3840 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3841 * capability, roaming policy is handled within wpa_supplicant and there
3842 * is no need to implement or react to this callback.
3844 int (*roaming
)(void *priv
, int allowed
, const u8
*bssid
);
3847 * disable_fils - Enable/disable FILS feature
3848 * @priv: Private driver interface data
3849 * @disable: 0-enable and 1-disable FILS feature
3850 * Returns: 0 on success, -1 on failure
3852 * This callback can be used to configure driver and below layers to
3853 * enable/disable all FILS features.
3855 int (*disable_fils
)(void *priv
, int disable
);
3858 * set_mac_addr - Set MAC address
3859 * @priv: Private driver interface data
3860 * @addr: MAC address to use or %NULL for setting back to permanent
3861 * Returns: 0 on success, -1 on failure
3863 int (*set_mac_addr
)(void *priv
, const u8
*addr
);
3865 #ifdef CONFIG_MACSEC
3866 int (*macsec_init
)(void *priv
, struct macsec_init_params
*params
);
3868 int (*macsec_deinit
)(void *priv
);
3871 * macsec_get_capability - Inform MKA of this driver's capability
3872 * @priv: Private driver interface data
3873 * @cap: Driver's capability
3874 * Returns: 0 on success, -1 on failure
3876 int (*macsec_get_capability
)(void *priv
, enum macsec_cap
*cap
);
3879 * enable_protect_frames - Set protect frames status
3880 * @priv: Private driver interface data
3881 * @enabled: TRUE = protect frames enabled
3882 * FALSE = protect frames disabled
3883 * Returns: 0 on success, -1 on failure (or if not supported)
3885 int (*enable_protect_frames
)(void *priv
, Boolean enabled
);
3888 * enable_encrypt - Set encryption status
3889 * @priv: Private driver interface data
3890 * @enabled: TRUE = encrypt outgoing traffic
3891 * FALSE = integrity-only protection on outgoing traffic
3892 * Returns: 0 on success, -1 on failure (or if not supported)
3894 int (*enable_encrypt
)(void *priv
, Boolean enabled
);
3897 * set_replay_protect - Set replay protect status and window size
3898 * @priv: Private driver interface data
3899 * @enabled: TRUE = replay protect enabled
3900 * FALSE = replay protect disabled
3901 * @window: replay window size, valid only when replay protect enabled
3902 * Returns: 0 on success, -1 on failure (or if not supported)
3904 int (*set_replay_protect
)(void *priv
, Boolean enabled
, u32 window
);
3907 * set_current_cipher_suite - Set current cipher suite
3908 * @priv: Private driver interface data
3909 * @cs: EUI64 identifier
3910 * Returns: 0 on success, -1 on failure (or if not supported)
3912 int (*set_current_cipher_suite
)(void *priv
, u64 cs
);
3915 * enable_controlled_port - Set controlled port status
3916 * @priv: Private driver interface data
3917 * @enabled: TRUE = controlled port enabled
3918 * FALSE = controlled port disabled
3919 * Returns: 0 on success, -1 on failure (or if not supported)
3921 int (*enable_controlled_port
)(void *priv
, Boolean enabled
);
3924 * get_receive_lowest_pn - Get receive lowest pn
3925 * @priv: Private driver interface data
3926 * @sa: secure association
3927 * Returns: 0 on success, -1 on failure (or if not supported)
3929 int (*get_receive_lowest_pn
)(void *priv
, struct receive_sa
*sa
);
3932 * get_transmit_next_pn - Get transmit next pn
3933 * @priv: Private driver interface data
3934 * @sa: secure association
3935 * Returns: 0 on success, -1 on failure (or if not supported)
3937 int (*get_transmit_next_pn
)(void *priv
, struct transmit_sa
*sa
);
3940 * set_transmit_next_pn - Set transmit next pn
3941 * @priv: Private driver interface data
3942 * @sa: secure association
3943 * Returns: 0 on success, -1 on failure (or if not supported)
3945 int (*set_transmit_next_pn
)(void *priv
, struct transmit_sa
*sa
);
3948 * set_receive_lowest_pn - Set receive lowest PN
3949 * @priv: Private driver interface data
3950 * @sa: secure association
3951 * Returns: 0 on success, -1 on failure (or if not supported)
3953 int (*set_receive_lowest_pn
)(void *priv
, struct receive_sa
*sa
);
3956 * create_receive_sc - create secure channel for receiving
3957 * @priv: Private driver interface data
3958 * @sc: secure channel
3959 * @conf_offset: confidentiality offset (0, 30, or 50)
3960 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3962 * Returns: 0 on success, -1 on failure (or if not supported)
3964 int (*create_receive_sc
)(void *priv
, struct receive_sc
*sc
,
3965 unsigned int conf_offset
,
3969 * delete_receive_sc - delete secure connection for receiving
3970 * @priv: private driver interface data from init()
3971 * @sc: secure channel
3972 * Returns: 0 on success, -1 on failure
3974 int (*delete_receive_sc
)(void *priv
, struct receive_sc
*sc
);
3977 * create_receive_sa - create secure association for receive
3978 * @priv: private driver interface data from init()
3979 * @sa: secure association
3980 * Returns: 0 on success, -1 on failure
3982 int (*create_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3985 * delete_receive_sa - Delete secure association for receive
3986 * @priv: Private driver interface data from init()
3987 * @sa: Secure association
3988 * Returns: 0 on success, -1 on failure
3990 int (*delete_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3993 * enable_receive_sa - enable the SA for receive
3994 * @priv: private driver interface data from init()
3995 * @sa: secure association
3996 * Returns: 0 on success, -1 on failure
3998 int (*enable_receive_sa
)(void *priv
, struct receive_sa
*sa
);
4001 * disable_receive_sa - disable SA for receive
4002 * @priv: private driver interface data from init()
4003 * @sa: secure association
4004 * Returns: 0 on success, -1 on failure
4006 int (*disable_receive_sa
)(void *priv
, struct receive_sa
*sa
);
4009 * create_transmit_sc - create secure connection for transmit
4010 * @priv: private driver interface data from init()
4011 * @sc: secure channel
4012 * @conf_offset: confidentiality offset (0, 30, or 50)
4013 * Returns: 0 on success, -1 on failure
4015 int (*create_transmit_sc
)(void *priv
, struct transmit_sc
*sc
,
4016 unsigned int conf_offset
);
4019 * delete_transmit_sc - delete secure connection for transmit
4020 * @priv: private driver interface data from init()
4021 * @sc: secure channel
4022 * Returns: 0 on success, -1 on failure
4024 int (*delete_transmit_sc
)(void *priv
, struct transmit_sc
*sc
);
4027 * create_transmit_sa - create secure association for transmit
4028 * @priv: private driver interface data from init()
4029 * @sa: secure association
4030 * Returns: 0 on success, -1 on failure
4032 int (*create_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
4035 * delete_transmit_sa - Delete secure association for transmit
4036 * @priv: Private driver interface data from init()
4037 * @sa: Secure association
4038 * Returns: 0 on success, -1 on failure
4040 int (*delete_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
4043 * enable_transmit_sa - enable SA for transmit
4044 * @priv: private driver interface data from init()
4045 * @sa: secure association
4046 * Returns: 0 on success, -1 on failure
4048 int (*enable_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
4051 * disable_transmit_sa - disable SA for transmit
4052 * @priv: private driver interface data from init()
4053 * @sa: secure association
4054 * Returns: 0 on success, -1 on failure
4056 int (*disable_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
4057 #endif /* CONFIG_MACSEC */
4060 * init_mesh - Driver specific initialization for mesh
4061 * @priv: Private driver interface data
4062 * Returns: 0 on success, -1 on failure
4064 int (*init_mesh
)(void *priv
);
4067 * join_mesh - Join a mesh network
4068 * @priv: Private driver interface data
4069 * @params: Mesh configuration parameters
4070 * Returns: 0 on success, -1 on failure
4072 int (*join_mesh
)(void *priv
,
4073 struct wpa_driver_mesh_join_params
*params
);
4076 * leave_mesh - Leave a mesh network
4077 * @priv: Private driver interface data
4078 * Returns 0 on success, -1 on failure
4080 int (*leave_mesh
)(void *priv
);
4083 * probe_mesh_link - Inject a frame over direct mesh link to a given
4084 * peer skipping the next_hop lookup from mpath table.
4085 * @priv: Private driver interface data
4086 * @addr: Peer MAC address
4087 * @eth: Ethernet frame to be sent
4088 * @len: Ethernet frame lengtn in bytes
4089 * Returns 0 on success, -1 on failure
4091 int (*probe_mesh_link
)(void *priv
, const u8
*addr
, const u8
*eth
,
4095 * do_acs - Automatically select channel
4096 * @priv: Private driver interface data
4097 * @params: Parameters for ACS
4098 * Returns 0 on success, -1 on failure
4100 * This command can be used to offload ACS to the driver if the driver
4101 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
4103 int (*do_acs
)(void *priv
, struct drv_acs_params
*params
);
4106 * set_band - Notify driver of band selection
4107 * @priv: Private driver interface data
4108 * @band: The selected band(s)
4109 * Returns 0 on success, -1 on failure
4111 int (*set_band
)(void *priv
, enum set_band band
);
4114 * get_pref_freq_list - Get preferred frequency list for an interface
4115 * @priv: Private driver interface data
4116 * @if_type: Interface type
4117 * @num: Number of channels
4118 * @freq_list: Preferred channel frequency list encoded in MHz values
4119 * Returns 0 on success, -1 on failure
4121 * This command can be used to query the preferred frequency list from
4122 * the driver specific to a particular interface type.
4124 int (*get_pref_freq_list
)(void *priv
, enum wpa_driver_if_type if_type
,
4125 unsigned int *num
, unsigned int *freq_list
);
4128 * set_prob_oper_freq - Indicate probable P2P operating channel
4129 * @priv: Private driver interface data
4130 * @freq: Channel frequency in MHz
4131 * Returns 0 on success, -1 on failure
4133 * This command can be used to inform the driver of the operating
4134 * frequency that an ongoing P2P group formation is likely to come up
4135 * on. Local device is assuming P2P Client role.
4137 int (*set_prob_oper_freq
)(void *priv
, unsigned int freq
);
4140 * abort_scan - Request the driver to abort an ongoing scan
4141 * @priv: Private driver interface data
4142 * @scan_cookie: Cookie identifying the scan request. This is used only
4143 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4144 * was used to trigger scan. Otherwise, 0 is used.
4145 * Returns 0 on success, -1 on failure
4147 int (*abort_scan
)(void *priv
, u64 scan_cookie
);
4150 * configure_data_frame_filters - Request to configure frame filters
4151 * @priv: Private driver interface data
4152 * @filter_flags: The type of frames to filter (bitfield of
4153 * WPA_DATA_FRAME_FILTER_FLAG_*)
4154 * Returns: 0 on success or -1 on failure
4156 int (*configure_data_frame_filters
)(void *priv
, u32 filter_flags
);
4159 * get_ext_capab - Get extended capabilities for the specified interface
4160 * @priv: Private driver interface data
4161 * @type: Interface type for which to get extended capabilities
4162 * @ext_capab: Extended capabilities fetched
4163 * @ext_capab_mask: Extended capabilities mask
4164 * @ext_capab_len: Length of the extended capabilities
4165 * Returns: 0 on success or -1 on failure
4167 int (*get_ext_capab
)(void *priv
, enum wpa_driver_if_type type
,
4168 const u8
**ext_capab
, const u8
**ext_capab_mask
,
4169 unsigned int *ext_capab_len
);
4172 * p2p_lo_start - Start offloading P2P listen to device
4173 * @priv: Private driver interface data
4174 * @freq: Listening frequency (MHz) for P2P listen
4175 * @period: Length of the listen operation in milliseconds
4176 * @interval: Interval for running the listen operation in milliseconds
4177 * @count: Number of times to run the listen operation
4178 * @device_types: Device primary and secondary types
4179 * @dev_types_len: Number of bytes for device_types
4180 * @ies: P2P IE and WSC IE for Probe Response frames
4181 * @ies_len: Length of ies in bytes
4182 * Returns: 0 on success or -1 on failure
4184 int (*p2p_lo_start
)(void *priv
, unsigned int freq
,
4185 unsigned int period
, unsigned int interval
,
4187 const u8
*device_types
, size_t dev_types_len
,
4188 const u8
*ies
, size_t ies_len
);
4191 * p2p_lo_stop - Stop P2P listen offload
4192 * @priv: Private driver interface data
4193 * Returns: 0 on success or -1 on failure
4195 int (*p2p_lo_stop
)(void *priv
);
4198 * set_default_scan_ies - Set default scan IEs
4199 * @priv: Private driver interface data
4200 * @ies: Scan default IEs buffer
4201 * @ies_len: Length of IEs in bytes
4202 * Returns: 0 on success or -1 on failure
4204 * The driver can use these by default when there are no scan IEs coming
4205 * in the subsequent scan requests. Also in case of one or more of IEs
4206 * given in set_default_scan_ies() are missing in the subsequent scan
4207 * request, the driver should merge the missing scan IEs in the scan
4208 * request from the IEs set by set_default_scan_ies() in the Probe
4209 * Request frames sent.
4211 int (*set_default_scan_ies
)(void *priv
, const u8
*ies
, size_t ies_len
);
4214 * set_tdls_mode - Set TDLS trigger mode to the host driver
4215 * @priv: Private driver interface data
4216 * @tdls_external_control: Represents if TDLS external trigger control
4217 * mode is enabled/disabled.
4219 * This optional callback can be used to configure the TDLS external
4220 * trigger control mode to the host driver.
4222 int (*set_tdls_mode
)(void *priv
, int tdls_external_control
);
4225 * get_bss_transition_status - Get candidate BSS's transition status
4226 * @priv: Private driver interface data
4227 * @params: Candidate BSS list
4229 * Get the accept or reject reason code for a list of BSS transition
4232 struct wpa_bss_candidate_info
*
4233 (*get_bss_transition_status
)(void *priv
,
4234 struct wpa_bss_trans_info
*params
);
4236 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
4237 * @priv: Private driver interface data
4238 * @ignore_disallow: 0 to not ignore, 1 to ignore
4239 * Returns: 0 on success, -1 on failure
4241 int (*ignore_assoc_disallow
)(void *priv
, int ignore_disallow
);
4244 * set_bssid_blacklist - Set blacklist of BSSIDs to the driver
4245 * @priv: Private driver interface data
4246 * @num_bssid: Number of blacklist BSSIDs
4247 * @bssids: List of blacklisted BSSIDs
4249 int (*set_bssid_blacklist
)(void *priv
, unsigned int num_bssid
,
4253 * update_connect_params - Update the connection parameters
4254 * @priv: Private driver interface data
4255 * @params: Association parameters
4256 * @mask: Bit mask indicating which parameters in @params have to be
4258 * Returns: 0 on success, -1 on failure
4260 * Update the connection parameters when in connected state so that the
4261 * driver uses the updated parameters for subsequent roaming. This is
4262 * used only with drivers that implement internal BSS selection and
4265 int (*update_connect_params
)(
4266 void *priv
, struct wpa_driver_associate_params
*params
,
4267 enum wpa_drv_update_connect_params_mask mask
);
4270 * send_external_auth_status - Indicate the status of external
4271 * authentication processing to the host driver.
4272 * @priv: Private driver interface data
4273 * @params: Status of authentication processing.
4274 * Returns: 0 on success, -1 on failure
4276 int (*send_external_auth_status
)(void *priv
,
4277 struct external_auth
*params
);
4280 * set_4addr_mode - Set 4-address mode
4281 * @priv: Private driver interface data
4282 * @bridge_ifname: Bridge interface name
4283 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
4284 * Returns: 0 on success, < 0 on failure
4286 int (*set_4addr_mode
)(void *priv
, const char *bridge_ifname
, int val
);
4289 * update_dh_ie - Update DH IE
4290 * @priv: Private driver interface data
4291 * @peer_mac: Peer MAC address
4292 * @reason_code: Reacon code
4294 * @ie_len: DH IE length in bytes
4295 * Returns: 0 on success, -1 on failure
4297 * This callback is used to let the driver know the DH processing result
4298 * and DH IE for a pending association.
4300 int (*update_dh_ie
)(void *priv
, const u8
*peer_mac
, u16 reason_code
,
4301 const u8
*ie
, size_t ie_len
);
4305 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
4307 enum wpa_event_type
{
4309 * EVENT_ASSOC - Association completed
4311 * This event needs to be delivered when the driver completes IEEE
4312 * 802.11 association or reassociation successfully.
4313 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
4314 * after this event has been generated. In addition, optional
4315 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
4316 * more information about the association. If the driver interface gets
4317 * both of these events at the same time, it can also include the
4318 * assoc_info data in EVENT_ASSOC call.
4323 * EVENT_DISASSOC - Association lost
4325 * This event should be called when association is lost either due to
4326 * receiving deauthenticate or disassociate frame from the AP or when
4327 * sending either of these frames to the current AP. If the driver
4328 * supports separate deauthentication event, EVENT_DISASSOC should only
4329 * be used for disassociation and EVENT_DEAUTH for deauthentication.
4330 * In AP mode, union wpa_event_data::disassoc_info is required.
4335 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
4337 * This event must be delivered when a Michael MIC error is detected by
4338 * the local driver. Additional data for event processing is
4339 * provided with union wpa_event_data::michael_mic_failure. This
4340 * information is used to request new encyption key and to initiate
4341 * TKIP countermeasures if needed.
4343 EVENT_MICHAEL_MIC_FAILURE
,
4346 * EVENT_SCAN_RESULTS - Scan results available
4348 * This event must be called whenever scan results are available to be
4349 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4350 * is expected to be used some time after struct wpa_driver_ops::scan()
4351 * is called. If the driver provides an unsolicited event when the scan
4352 * has been completed, this event can be used to trigger
4353 * EVENT_SCAN_RESULTS call. If such event is not available from the
4354 * driver, the driver wrapper code is expected to use a registered
4355 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
4356 * scan is expected to be completed. Optional information about
4357 * completed scan can be provided with union wpa_event_data::scan_info.
4362 * EVENT_ASSOCINFO - Report optional extra information for association
4364 * This event can be used to report extra association information for
4365 * EVENT_ASSOC processing. This extra information includes IEs from
4366 * association frames and Beacon/Probe Response frames in union
4367 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4368 * EVENT_ASSOC. Alternatively, the driver interface can include
4369 * assoc_info data in the EVENT_ASSOC call if it has all the
4370 * information available at the same point.
4375 * EVENT_INTERFACE_STATUS - Report interface status changes
4377 * This optional event can be used to report changes in interface
4378 * status (interface added/removed) using union
4379 * wpa_event_data::interface_status. This can be used to trigger
4380 * wpa_supplicant to stop and re-start processing for the interface,
4381 * e.g., when a cardbus card is ejected/inserted.
4383 EVENT_INTERFACE_STATUS
,
4386 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4388 * This event can be used to inform wpa_supplicant about candidates for
4389 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4390 * for scan request (ap_scan=2 mode), this event is required for
4391 * pre-authentication. If wpa_supplicant is performing scan request
4392 * (ap_scan=1), this event is optional since scan results can be used
4393 * to add pre-authentication candidates. union
4394 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4395 * candidate and priority of the candidate, e.g., based on the signal
4396 * strength, in order to try to pre-authenticate first with candidates
4397 * that are most likely targets for re-association.
4399 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4400 * on the candidate list. In addition, it can be called for the current
4401 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4402 * will automatically skip pre-authentication in cases where a valid
4403 * PMKSA exists. When more than one candidate exists, this event should
4404 * be generated once for each candidate.
4406 * Driver will be notified about successful pre-authentication with
4407 * struct wpa_driver_ops::add_pmkid() calls.
4409 EVENT_PMKID_CANDIDATE
,
4412 * EVENT_TDLS - Request TDLS operation
4414 * This event can be used to request a TDLS operation to be performed.
4419 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4421 * The driver is expected to report the received FT IEs from
4422 * FT authentication sequence from the AP. The FT IEs are included in
4423 * the extra information in union wpa_event_data::ft_ies.
4428 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4430 * The driver can use this event to inform wpa_supplicant about a STA
4431 * in an IBSS with which protected frames could be exchanged. This
4432 * event starts RSN authentication with the other STA to authenticate
4433 * the STA and set up encryption keys with it.
4435 EVENT_IBSS_RSN_START
,
4438 * EVENT_AUTH - Authentication result
4440 * This event should be called when authentication attempt has been
4441 * completed. This is only used if the driver supports separate
4442 * authentication step (struct wpa_driver_ops::authenticate).
4443 * Information about authentication result is included in
4444 * union wpa_event_data::auth.
4449 * EVENT_DEAUTH - Authentication lost
4451 * This event should be called when authentication is lost either due
4452 * to receiving deauthenticate frame from the AP or when sending that
4453 * frame to the current AP.
4454 * In AP mode, union wpa_event_data::deauth_info is required.
4459 * EVENT_ASSOC_REJECT - Association rejected
4461 * This event should be called when (re)association attempt has been
4462 * rejected by the AP. Information about the association response is
4463 * included in union wpa_event_data::assoc_reject.
4468 * EVENT_AUTH_TIMED_OUT - Authentication timed out
4470 EVENT_AUTH_TIMED_OUT
,
4473 * EVENT_ASSOC_TIMED_OUT - Association timed out
4475 EVENT_ASSOC_TIMED_OUT
,
4478 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
4480 EVENT_WPS_BUTTON_PUSHED
,
4483 * EVENT_TX_STATUS - Report TX status
4488 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
4490 EVENT_RX_FROM_UNKNOWN
,
4493 * EVENT_RX_MGMT - Report RX of a management frame
4498 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
4500 * This event is used to indicate when the driver has started the
4501 * requested remain-on-channel duration. Information about the
4502 * operation is included in union wpa_event_data::remain_on_channel.
4504 EVENT_REMAIN_ON_CHANNEL
,
4507 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
4509 * This event is used to indicate when the driver has completed
4510 * remain-on-channel duration, i.e., may noot be available on the
4511 * requested channel anymore. Information about the
4512 * operation is included in union wpa_event_data::remain_on_channel.
4514 EVENT_CANCEL_REMAIN_ON_CHANNEL
,
4517 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
4519 * This event is used to indicate when a Probe Request frame has been
4520 * received. Information about the received frame is included in
4521 * union wpa_event_data::rx_probe_req. The driver is required to report
4522 * these events only after successfully completed probe_req_report()
4523 * commands to request the events (i.e., report parameter is non-zero)
4524 * in station mode. In AP mode, Probe Request frames should always be
4530 * EVENT_NEW_STA - New wired device noticed
4532 * This event is used to indicate that a new device has been detected
4533 * in a network that does not use association-like functionality (i.e.,
4534 * mainly wired Ethernet). This can be used to start EAPOL
4535 * authenticator when receiving a frame from a device. The address of
4536 * the device is included in union wpa_event_data::new_sta.
4541 * EVENT_EAPOL_RX - Report received EAPOL frame
4543 * When in AP mode with hostapd, this event is required to be used to
4544 * deliver the receive EAPOL frames from the driver.
4549 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4551 * This event is used to indicate changes in the signal strength
4552 * observed in frames received from the current AP if signal strength
4553 * monitoring has been enabled with signal_monitor().
4555 EVENT_SIGNAL_CHANGE
,
4558 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4560 * This event is used to indicate that the interface was enabled after
4561 * having been previously disabled, e.g., due to rfkill.
4563 EVENT_INTERFACE_ENABLED
,
4566 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4568 * This event is used to indicate that the interface was disabled,
4569 * e.g., due to rfkill.
4571 EVENT_INTERFACE_DISABLED
,
4574 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4576 * This event is used to indicate that the channel list has changed,
4577 * e.g., because of a regulatory domain change triggered by scan
4578 * results including an AP advertising a country code.
4580 EVENT_CHANNEL_LIST_CHANGED
,
4583 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4585 * This event is used to indicate that the driver cannot maintain this
4586 * interface in its operation mode anymore. The most likely use for
4587 * this is to indicate that AP mode operation is not available due to
4588 * operating channel would need to be changed to a DFS channel when
4589 * the driver does not support radar detection and another virtual
4590 * interfaces caused the operating channel to change. Other similar
4591 * resource conflicts could also trigger this for station mode
4592 * interfaces. This event can be propagated when channel switching
4595 EVENT_INTERFACE_UNAVAILABLE
,
4598 * EVENT_BEST_CHANNEL
4600 * Driver generates this event whenever it detects a better channel
4601 * (e.g., based on RSSI or channel use). This information can be used
4602 * to improve channel selection for a new AP/P2P group.
4607 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4609 * This event should be called when a Deauthentication frame is dropped
4610 * due to it not being protected (MFP/IEEE 802.11w).
4611 * union wpa_event_data::unprot_deauth is required to provide more
4612 * details of the frame.
4614 EVENT_UNPROT_DEAUTH
,
4617 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4619 * This event should be called when a Disassociation frame is dropped
4620 * due to it not being protected (MFP/IEEE 802.11w).
4621 * union wpa_event_data::unprot_disassoc is required to provide more
4622 * details of the frame.
4624 EVENT_UNPROT_DISASSOC
,
4627 * EVENT_STATION_LOW_ACK
4629 * Driver generates this event whenever it detected that a particular
4630 * station was lost. Detection can be through massive transmission
4631 * failures for example.
4633 EVENT_STATION_LOW_ACK
,
4636 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4638 EVENT_IBSS_PEER_LOST
,
4641 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4643 * This event carries the new replay counter to notify wpa_supplicant
4644 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4645 * completed Group Key Handshake while the host (including
4646 * wpa_supplicant was sleeping).
4648 EVENT_DRIVER_GTK_REKEY
,
4651 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4653 EVENT_SCHED_SCAN_STOPPED
,
4656 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4658 * This event indicates that the station responded to the poll
4659 * initiated with @poll_client.
4661 EVENT_DRIVER_CLIENT_POLL_OK
,
4664 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4666 EVENT_EAPOL_TX_STATUS
,
4669 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4671 * Described in wpa_event_data.ch_switch
4676 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
4678 * This is a pre-switch event indicating the shortly following switch
4679 * of operating channels.
4681 * Described in wpa_event_data.ch_switch
4683 EVENT_CH_SWITCH_STARTED
,
4685 * EVENT_WNM - Request WNM operation
4687 * This event can be used to request a WNM operation to be performed.
4692 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4694 * This event indicates that the driver reported a connection failure
4695 * with the specified client (for example, max client reached, etc.) in
4698 EVENT_CONNECT_FAILED_REASON
,
4701 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
4703 * A radar has been detected on the supplied frequency, hostapd should
4704 * react accordingly (e.g., change channel).
4706 EVENT_DFS_RADAR_DETECTED
,
4709 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
4711 * After a successful CAC, the channel can be marked clear and used.
4713 EVENT_DFS_CAC_FINISHED
,
4716 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
4718 * The CAC was not successful, and the channel remains in the previous
4719 * state. This may happen due to a radar being detected or other
4720 * external influences.
4722 EVENT_DFS_CAC_ABORTED
,
4725 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
4727 * The channel which was previously unavailable is now available again.
4729 EVENT_DFS_NOP_FINISHED
,
4732 * EVENT_SURVEY - Received survey data
4734 * This event gets triggered when a driver query is issued for survey
4735 * data and the requested data becomes available. The returned data is
4736 * stored in struct survey_results. The results provide at most one
4737 * survey entry for each frequency and at minimum will provide one
4738 * survey entry for one frequency. The survey data can be os_malloc()'d
4739 * and then os_free()'d, so the event callback must only copy data.
4744 * EVENT_SCAN_STARTED - Scan started
4746 * This indicates that driver has started a scan operation either based
4747 * on a request from wpa_supplicant/hostapd or from another application.
4748 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4749 * completed (either successfully or by getting cancelled).
4754 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4756 * This event indicates a set of frequency ranges that should be avoided
4757 * to reduce issues due to interference or internal co-existence
4758 * information in the driver.
4760 EVENT_AVOID_FREQUENCIES
,
4763 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4765 EVENT_NEW_PEER_CANDIDATE
,
4768 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4770 * Indicates a pair of primary and secondary channels chosen by ACS
4773 EVENT_ACS_CHANNEL_SELECTED
,
4776 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4779 * This event indicates that channel availability check has been started
4780 * on a DFS frequency by a driver that supports DFS Offload.
4782 EVENT_DFS_CAC_STARTED
,
4785 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4790 * EVENT_BEACON_LOSS - Beacon loss detected
4792 * This event indicates that no Beacon frames has been received from
4793 * the current AP. This may indicate that the AP is not anymore in
4799 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
4800 * done previously (Pre-CAC) on the channel has expired. This would
4801 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
4802 * channel will be moved from available to usable. A new CAC has to be
4803 * performed before start operating on this channel.
4805 EVENT_DFS_PRE_CAC_EXPIRED
,
4808 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
4809 * that do not define separate commands for authentication and
4810 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
4811 * authentication to wpa_supplicant. This event carries all the
4812 * necessary information from the host driver for the authentication to
4815 EVENT_EXTERNAL_AUTH
,
4818 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
4820 * This event should be indicated when the driver completes the 4-way
4821 * handshake. This event should be preceded by an EVENT_ASSOC that
4822 * indicates the completion of IEEE 802.11 association.
4824 EVENT_PORT_AUTHORIZED
,
4827 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
4830 EVENT_STATION_OPMODE_CHANGED
,
4833 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
4835 * This event is emitted when the MAC changes while the interface is
4836 * enabled. When an interface was disabled and becomes enabled, it
4837 * must be always assumed that the MAC possibly changed.
4839 EVENT_INTERFACE_MAC_CHANGED
,
4842 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
4844 * This event is emitted when an interface is added/removed for WDS STA.
4846 EVENT_WDS_STA_INTERFACE_STATUS
,
4849 * EVENT_UPDATE_DH - Notification of updated DH information
4856 * struct freq_survey - Channel survey info
4858 * @ifidx: Interface index in which this survey was observed
4859 * @freq: Center of frequency of the surveyed channel
4860 * @nf: Channel noise floor in dBm
4861 * @channel_time: Amount of time in ms the radio spent on the channel
4862 * @channel_time_busy: Amount of time in ms the radio detected some signal
4863 * that indicated to the radio the channel was not clear
4864 * @channel_time_rx: Amount of time the radio spent receiving data
4865 * @channel_time_tx: Amount of time the radio spent transmitting data
4866 * @filled: bitmask indicating which fields have been reported, see
4867 * SURVEY_HAS_* defines.
4868 * @list: Internal list pointers
4870 struct freq_survey
{
4875 u64 channel_time_busy
;
4876 u64 channel_time_rx
;
4877 u64 channel_time_tx
;
4878 unsigned int filled
;
4879 struct dl_list list
;
4882 #define SURVEY_HAS_NF BIT(0)
4883 #define SURVEY_HAS_CHAN_TIME BIT(1)
4884 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4885 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4886 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4890 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4892 union wpa_event_data
{
4894 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4896 * This structure is optional for EVENT_ASSOC calls and required for
4897 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4898 * driver interface does not need to generate separate EVENT_ASSOCINFO
4903 * reassoc - Flag to indicate association or reassociation
4908 * req_ies - (Re)Association Request IEs
4910 * If the driver generates WPA/RSN IE, this event data must be
4911 * returned for WPA handshake to have needed information. If
4912 * wpa_supplicant-generated WPA/RSN IE is used, this
4913 * information event is optional.
4915 * This should start with the first IE (fixed fields before IEs
4916 * are not included).
4921 * req_ies_len - Length of req_ies in bytes
4926 * resp_ies - (Re)Association Response IEs
4928 * Optional association data from the driver. This data is not
4929 * required WPA, but may be useful for some protocols and as
4930 * such, should be reported if this is available to the driver
4933 * This should start with the first IE (fixed fields before IEs
4934 * are not included).
4939 * resp_ies_len - Length of resp_ies in bytes
4941 size_t resp_ies_len
;
4944 * resp_frame - (Re)Association Response frame
4946 const u8
*resp_frame
;
4949 * resp_frame_len - (Re)Association Response frame length
4951 size_t resp_frame_len
;
4954 * beacon_ies - Beacon or Probe Response IEs
4956 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4957 * Probe Response frames from the current AP (i.e., the one
4958 * that the client just associated with). This information is
4959 * used to update WPA/RSN IE for the AP. If this field is not
4960 * set, the results from previous scan will be used. If no
4961 * data for the new AP is found, scan results will be requested
4962 * again (without scan request). At this point, the driver is
4963 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4966 * This should start with the first IE (fixed fields before IEs
4967 * are not included).
4969 const u8
*beacon_ies
;
4972 * beacon_ies_len - Length of beacon_ies */
4973 size_t beacon_ies_len
;
4976 * freq - Frequency of the operational channel in MHz
4981 * wmm_params - WMM parameters used in this association.
4983 struct wmm_params wmm_params
;
4986 * addr - Station address (for AP mode)
4991 * The following is the key management offload information
4994 * @key_replay_ctr_len
5002 * authorized - Status of key management offload,
5008 * key_replay_ctr - Key replay counter value last used
5009 * in a valid EAPOL-Key frame
5011 const u8
*key_replay_ctr
;
5014 * key_replay_ctr_len - The length of key_replay_ctr
5016 size_t key_replay_ctr_len
;
5019 * ptk_kck - The derived PTK KCK
5024 * ptk_kek_len - The length of ptk_kck
5029 * ptk_kek - The derived PTK KEK
5030 * This is used in key management offload and also in FILS SK
5036 * ptk_kek_len - The length of ptk_kek
5041 * subnet_status - The subnet status:
5042 * 0 = unknown, 1 = unchanged, 2 = changed
5047 * The following information is used in FILS SK offload
5048 * @fils_erp_next_seq_num
5055 * fils_erp_next_seq_num - The next sequence number to use in
5058 u16 fils_erp_next_seq_num
;
5061 * fils_pmk - A new PMK if generated in case of FILS
5067 * fils_pmk_len - Length of fils_pmk
5069 size_t fils_pmk_len
;
5072 * fils_pmkid - PMKID used or generated in FILS authentication
5074 const u8
*fils_pmkid
;
5078 * struct disassoc_info - Data for EVENT_DISASSOC events
5080 struct disassoc_info
{
5082 * addr - Station address (for AP mode)
5087 * reason_code - Reason Code (host byte order) used in
5088 * Deauthentication frame
5093 * ie - Optional IE(s) in Disassociation frame
5098 * ie_len - Length of ie buffer in octets
5103 * locally_generated - Whether the frame was locally generated
5105 int locally_generated
;
5109 * struct deauth_info - Data for EVENT_DEAUTH events
5111 struct deauth_info
{
5113 * addr - Station address (for AP mode)
5118 * reason_code - Reason Code (host byte order) used in
5119 * Deauthentication frame
5124 * ie - Optional IE(s) in Deauthentication frame
5129 * ie_len - Length of ie buffer in octets
5134 * locally_generated - Whether the frame was locally generated
5136 int locally_generated
;
5140 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
5142 struct michael_mic_failure
{
5145 } michael_mic_failure
;
5148 * struct interface_status - Data for EVENT_INTERFACE_STATUS
5150 struct interface_status
{
5151 unsigned int ifindex
;
5154 EVENT_INTERFACE_ADDED
, EVENT_INTERFACE_REMOVED
5159 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
5161 struct pmkid_candidate
{
5162 /** BSSID of the PMKID candidate */
5164 /** Smaller the index, higher the priority */
5166 /** Whether RSN IE includes pre-authenticate flag */
5171 * struct tdls - Data for EVENT_TDLS
5177 TDLS_REQUEST_TEARDOWN
,
5178 TDLS_REQUEST_DISCOVER
,
5180 u16 reason_code
; /* for teardown */
5184 * struct wnm - Data for EVENT_WNM
5202 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
5204 * During FT (IEEE 802.11r) authentication sequence, the driver is
5205 * expected to use this event to report received FT IEs (MDIE, FTIE,
5206 * RSN IE, TIE, possible resource request) to the supplicant. The FT
5207 * IEs for the next message will be delivered through the
5208 * struct wpa_driver_ops::update_ft_ies() callback.
5214 u8 target_ap
[ETH_ALEN
];
5215 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
5217 /** Length of ric_ies buffer in octets */
5222 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
5224 struct ibss_rsn_start
{
5229 * struct auth_info - Data for EVENT_AUTH events
5235 u16 auth_transaction
;
5242 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
5244 struct assoc_reject
{
5246 * bssid - BSSID of the AP that rejected association
5251 * resp_ies - (Re)Association Response IEs
5253 * Optional association data from the driver. This data is not
5254 * required WPA, but may be useful for some protocols and as
5255 * such, should be reported if this is available to the driver
5258 * This should start with the first IE (fixed fields before IEs
5259 * are not included).
5264 * resp_ies_len - Length of resp_ies in bytes
5266 size_t resp_ies_len
;
5269 * status_code - Status Code from (Re)association Response
5274 * timed_out - Whether failure is due to timeout (etc.) rather
5275 * than explicit rejection response from the AP.
5280 * timeout_reason - Reason for the timeout
5282 const char *timeout_reason
;
5285 * fils_erp_next_seq_num - The next sequence number to use in
5288 u16 fils_erp_next_seq_num
;
5291 struct timeout_event
{
5296 * struct tx_status - Data for EVENT_TX_STATUS events
5308 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
5310 struct rx_from_unknown
{
5317 * struct rx_mgmt - Data for EVENT_RX_MGMT events
5325 * drv_priv - Pointer to store driver private BSS information
5327 * If not set to NULL, this is used for comparison with
5328 * hostapd_data->drv_priv to determine which BSS should process
5334 * freq - Frequency (in MHz) on which the frame was received
5339 * ssi_signal - Signal strength in dBm (or 0 if not available)
5345 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
5347 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
5349 struct remain_on_channel
{
5351 * freq - Channel frequency in MHz
5356 * duration - Duration to remain on the channel in milliseconds
5358 unsigned int duration
;
5359 } remain_on_channel
;
5362 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
5363 * @aborted: Whether the scan was aborted
5364 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
5365 * @num_freqs: Number of entries in freqs array
5366 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
5368 * @num_ssids: Number of entries in ssids array
5369 * @external_scan: Whether the scan info is for an external scan
5370 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
5371 * 0 if the source of the scan event is a vendor scan
5372 * @scan_start_tsf: Time when the scan started in terms of TSF of the
5373 * BSS that the interface that requested the scan is connected to
5375 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
5382 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
5387 u8 scan_start_tsf_bssid
[ETH_ALEN
];
5391 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
5393 struct rx_probe_req
{
5395 * sa - Source address of the received Probe Request frame
5400 * da - Destination address of the received Probe Request frame
5401 * or %NULL if not available
5406 * bssid - BSSID of the received Probe Request frame or %NULL
5412 * ie - IEs from the Probe Request body
5417 * ie_len - Length of ie buffer in octets
5422 * signal - signal strength in dBm (or 0 if not available)
5428 * struct new_sta - Data for EVENT_NEW_STA events
5435 * struct eapol_rx - Data for EVENT_EAPOL_RX events
5444 * signal_change - Data for EVENT_SIGNAL_CHANGE events
5446 struct wpa_signal_info signal_change
;
5449 * struct best_channel - Data for EVENT_BEST_CHANNEL events
5450 * @freq_24: Best 2.4 GHz band channel frequency in MHz
5451 * @freq_5: Best 5 GHz band channel frequency in MHz
5452 * @freq_overall: Best channel frequency in MHz
5454 * 0 can be used to indicate no preference in either band.
5456 struct best_channel
{
5462 struct unprot_deauth
{
5468 struct unprot_disassoc
{
5475 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
5476 * @addr: station address
5477 * @num_packets: Number of packets lost (consecutive packets not
5486 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
5488 struct ibss_peer_lost
{
5493 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
5495 struct driver_gtk_rekey
{
5497 const u8
*replay_ctr
;
5501 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
5502 * @addr: station address
5504 struct client_poll
{
5509 * struct eapol_tx_status
5510 * @dst: Original destination
5511 * @data: Data starting with IEEE 802.1X header (!)
5512 * @data_len: Length of data
5513 * @ack: Indicates ack or lost frame
5515 * This corresponds to hapd_send_eapol if the frame sent
5516 * there isn't just reported as EVENT_TX_STATUS.
5518 struct eapol_tx_status
{
5527 * @freq: Frequency of new channel in MHz
5528 * @ht_enabled: Whether this is an HT channel
5529 * @ch_offset: Secondary channel offset
5530 * @ch_width: Channel width
5531 * @cf1: Center frequency 1
5532 * @cf2: Center frequency 2
5538 enum chan_width ch_width
;
5544 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
5545 * @addr: Remote client address
5546 * @code: Reason code for connection failure
5548 struct connect_failed_reason
{
5554 } connect_failed_reason
;
5557 * struct dfs_event - Data for radar detected events
5558 * @freq: Frequency of the channel in MHz
5564 enum chan_width chan_width
;
5570 * survey_results - Survey result data for EVENT_SURVEY
5571 * @freq_filter: Requested frequency survey filter, 0 if request
5572 * was for all survey data
5573 * @survey_list: Linked list of survey data (struct freq_survey)
5575 struct survey_results
{
5576 unsigned int freq_filter
;
5577 struct dl_list survey_list
; /* struct freq_survey */
5581 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
5582 * @initiator: Initiator of the regulatory change
5583 * @type: Regulatory change type
5584 * @alpha2: Country code (or "" if not available)
5586 struct channel_list_changed
{
5587 enum reg_change_initiator initiator
;
5590 } channel_list_changed
;
5593 * freq_range - List of frequency ranges
5595 * This is used as the data with EVENT_AVOID_FREQUENCIES.
5597 struct wpa_freq_range_list freq_range
;
5602 * @peer: Peer address
5604 * @ie_len: Length of @ies
5606 * Notification of new candidate mesh peer.
5615 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
5616 * @pri_freq: Selected primary frequency
5617 * @sec_freq: Selected secondary frequency
5618 * @vht_seg0_center_ch: VHT mode Segment0 center channel
5619 * @vht_seg1_center_ch: VHT mode Segment1 center channel
5620 * @ch_width: Selected Channel width by driver. Driver may choose to
5621 * change hostapd configured ACS channel width due driver internal
5622 * channel restrictions.
5623 * hw_mode: Selected band (used with hw_mode=any)
5625 struct acs_selected_channels
{
5626 unsigned int pri_freq
;
5627 unsigned int sec_freq
;
5628 u8 vht_seg0_center_ch
;
5629 u8 vht_seg1_center_ch
;
5631 enum hostapd_hw_mode hw_mode
;
5632 } acs_selected_channels
;
5635 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
5636 * @reason_code: Reason for stopping offload
5637 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
5639 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
5641 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
5643 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
5644 * supported by device.
5646 struct p2p_lo_stop
{
5648 P2P_LO_STOPPED_REASON_COMPLETE
= 0,
5649 P2P_LO_STOPPED_REASON_RECV_STOP_CMD
,
5650 P2P_LO_STOPPED_REASON_INVALID_PARAM
,
5651 P2P_LO_STOPPED_REASON_NOT_SUPPORTED
,
5655 /* For EVENT_EXTERNAL_AUTH */
5656 struct external_auth external_auth
;
5659 * struct sta_opmode - Station's operation mode change event
5660 * @addr: The station MAC address
5661 * @smps_mode: SMPS mode of the station
5662 * @chan_width: Channel width of the station
5663 * @rx_nss: RX_NSS of the station
5665 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
5669 enum smps_mode smps_mode
;
5670 enum chan_width chan_width
;
5675 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
5677 struct wds_sta_interface
{
5684 } wds_sta_interface
;
5687 * struct update_dh - Data for EVENT_UPDATE_DH
5697 * wpa_supplicant_event - Report a driver event for wpa_supplicant
5698 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5699 * with struct wpa_driver_ops::init()
5700 * @event: event type (defined above)
5701 * @data: possible extra data for the event
5703 * Driver wrapper code should call this function whenever an event is received
5706 void wpa_supplicant_event(void *ctx
, enum wpa_event_type event
,
5707 union wpa_event_data
*data
);
5710 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
5711 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5712 * with struct wpa_driver_ops::init()
5713 * @event: event type (defined above)
5714 * @data: possible extra data for the event
5716 * Same as wpa_supplicant_event(), but we search for the interface in
5719 void wpa_supplicant_event_global(void *ctx
, enum wpa_event_type event
,
5720 union wpa_event_data
*data
);
5723 * The following inline functions are provided for convenience to simplify
5724 * event indication for some of the common events.
5727 static inline void drv_event_assoc(void *ctx
, const u8
*addr
, const u8
*ie
,
5728 size_t ielen
, int reassoc
)
5730 union wpa_event_data event
;
5731 os_memset(&event
, 0, sizeof(event
));
5732 event
.assoc_info
.reassoc
= reassoc
;
5733 event
.assoc_info
.req_ies
= ie
;
5734 event
.assoc_info
.req_ies_len
= ielen
;
5735 event
.assoc_info
.addr
= addr
;
5736 wpa_supplicant_event(ctx
, EVENT_ASSOC
, &event
);
5739 static inline void drv_event_disassoc(void *ctx
, const u8
*addr
)
5741 union wpa_event_data event
;
5742 os_memset(&event
, 0, sizeof(event
));
5743 event
.disassoc_info
.addr
= addr
;
5744 wpa_supplicant_event(ctx
, EVENT_DISASSOC
, &event
);
5747 static inline void drv_event_eapol_rx(void *ctx
, const u8
*src
, const u8
*data
,
5750 union wpa_event_data event
;
5751 os_memset(&event
, 0, sizeof(event
));
5752 event
.eapol_rx
.src
= src
;
5753 event
.eapol_rx
.data
= data
;
5754 event
.eapol_rx
.data_len
= data_len
;
5755 wpa_supplicant_event(ctx
, EVENT_EAPOL_RX
, &event
);
5758 /* driver_common.c */
5759 void wpa_scan_results_free(struct wpa_scan_results
*res
);
5761 /* Convert wpa_event_type to a string for logging */
5762 const char * event_to_string(enum wpa_event_type event
);
5764 /* Convert chan_width to a string for logging and control interfaces */
5765 const char * channel_width_to_string(enum chan_width width
);
5767 int channel_width_to_int(enum chan_width width
);
5769 int ht_supported(const struct hostapd_hw_modes
*mode
);
5770 int vht_supported(const struct hostapd_hw_modes
*mode
);
5772 struct wowlan_triggers
*
5773 wpa_get_wowlan_triggers(const char *wowlan_triggers
,
5774 const struct wpa_driver_capa
*capa
);
5775 /* Convert driver flag to string */
5776 const char * driver_flag_to_string(u64 flag
);
5778 /* NULL terminated array of linked in driver wrappers */
5779 extern const struct wpa_driver_ops
*const wpa_drivers
[];
5782 /* Available drivers */
5784 #ifdef CONFIG_DRIVER_WEXT
5785 extern const struct wpa_driver_ops wpa_driver_wext_ops
; /* driver_wext.c */
5786 #endif /* CONFIG_DRIVER_WEXT */
5787 #ifdef CONFIG_DRIVER_NL80211
5788 /* driver_nl80211.c */
5789 extern const struct wpa_driver_ops wpa_driver_nl80211_ops
;
5790 #endif /* CONFIG_DRIVER_NL80211 */
5791 #ifdef CONFIG_DRIVER_HOSTAP
5792 extern const struct wpa_driver_ops wpa_driver_hostap_ops
; /* driver_hostap.c */
5793 #endif /* CONFIG_DRIVER_HOSTAP */
5794 #ifdef CONFIG_DRIVER_BSD
5795 extern const struct wpa_driver_ops wpa_driver_bsd_ops
; /* driver_bsd.c */
5796 #endif /* CONFIG_DRIVER_BSD */
5797 #ifdef CONFIG_DRIVER_OPENBSD
5798 /* driver_openbsd.c */
5799 extern const struct wpa_driver_ops wpa_driver_openbsd_ops
;
5800 #endif /* CONFIG_DRIVER_OPENBSD */
5801 #ifdef CONFIG_DRIVER_NDIS
5802 extern struct wpa_driver_ops wpa_driver_ndis_ops
; /* driver_ndis.c */
5803 #endif /* CONFIG_DRIVER_NDIS */
5804 #ifdef CONFIG_DRIVER_WIRED
5805 extern const struct wpa_driver_ops wpa_driver_wired_ops
; /* driver_wired.c */
5806 #endif /* CONFIG_DRIVER_WIRED */
5807 #ifdef CONFIG_DRIVER_MACSEC_QCA
5808 /* driver_macsec_qca.c */
5809 extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops
;
5810 #endif /* CONFIG_DRIVER_MACSEC_QCA */
5811 #ifdef CONFIG_DRIVER_MACSEC_LINUX
5812 /* driver_macsec_linux.c */
5813 extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops
;
5814 #endif /* CONFIG_DRIVER_MACSEC_LINUX */
5815 #ifdef CONFIG_DRIVER_ROBOSWITCH
5816 /* driver_roboswitch.c */
5817 extern const struct wpa_driver_ops wpa_driver_roboswitch_ops
;
5818 #endif /* CONFIG_DRIVER_ROBOSWITCH */
5819 #ifdef CONFIG_DRIVER_ATHEROS
5820 /* driver_atheros.c */
5821 extern const struct wpa_driver_ops wpa_driver_atheros_ops
;
5822 #endif /* CONFIG_DRIVER_ATHEROS */
5823 #ifdef CONFIG_DRIVER_NONE
5824 extern const struct wpa_driver_ops wpa_driver_none_ops
; /* driver_none.c */
5825 #endif /* CONFIG_DRIVER_NONE */
5827 #endif /* DRIVER_H */