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 /* Filter gratuitous ARP */
62 #define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
63 /* Filter unsolicited Neighbor Advertisement */
64 #define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
65 /* Filter unicast IP packets encrypted using the GTK */
66 #define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)
68 #define HOSTAPD_DFS_REGION_FCC 1
69 #define HOSTAPD_DFS_REGION_ETSI 2
70 #define HOSTAPD_DFS_REGION_JP 3
73 * enum reg_change_initiator - Regulatory change initiator
75 enum reg_change_initiator
{
79 REGDOM_SET_BY_COUNTRY_IE
,
84 * enum reg_type - Regulatory change types
90 REGDOM_TYPE_CUSTOM_WORLD
,
91 REGDOM_TYPE_INTERSECTION
,
95 * struct hostapd_channel_data - Channel information
97 struct hostapd_channel_data
{
99 * chan - Channel number (IEEE 802.11)
104 * freq - Frequency in MHz
109 * flag - Channel flags (HOSTAPD_CHAN_*)
114 * max_tx_power - Regulatory transmit power limit in dBm
119 * survey_list - Linked list of surveys (struct freq_survey)
121 struct dl_list survey_list
;
124 * min_nf - Minimum observed noise floor, in dBm, based on all
125 * surveyed channel data
131 * interference_factor - Computed interference factor on this
132 * channel (used internally in src/ap/acs.c; driver wrappers do not
135 long double interference_factor
;
136 #endif /* CONFIG_ACS */
139 * dfs_cac_ms - DFS CAC time in milliseconds
141 unsigned int dfs_cac_ms
;
144 #define HE_MAX_NUM_SS 8
145 #define HE_MAX_PHY_CAPAB_SIZE 3
148 * struct he_ppe_threshold - IEEE 802.11ax HE PPE Threshold
150 struct he_ppe_threshold
{
153 u32 ppet16_ppet8_ru3_ru0
[HE_MAX_NUM_SS
];
157 * struct he_capabilities - IEEE 802.11ax HE capabilities
159 struct he_capabilities
{
161 u32 phy_cap
[HE_MAX_PHY_CAPAB_SIZE
];
164 struct he_ppe_threshold ppet
;
167 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
168 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
171 * struct hostapd_hw_modes - Supported hardware mode information
173 struct hostapd_hw_modes
{
175 * mode - Hardware mode
177 enum hostapd_hw_mode mode
;
180 * num_channels - Number of entries in the channels array
185 * channels - Array of supported channels
187 struct hostapd_channel_data
*channels
;
190 * num_rates - Number of entries in the rates array
195 * rates - Array of supported rates in 100 kbps units
200 * ht_capab - HT (IEEE 802.11n) capabilities
205 * mcs_set - MCS (IEEE 802.11n) rate parameters
210 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
215 * vht_capab - VHT (IEEE 802.11ac) capabilities
220 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
224 unsigned int flags
; /* HOSTAPD_MODE_FLAG_* */
227 * he_capab - HE (IEEE 802.11ax) capabilities
229 struct he_capabilities he_capab
;
233 #define IEEE80211_MODE_INFRA 0
234 #define IEEE80211_MODE_IBSS 1
235 #define IEEE80211_MODE_AP 2
236 #define IEEE80211_MODE_MESH 5
238 #define IEEE80211_CAP_ESS 0x0001
239 #define IEEE80211_CAP_IBSS 0x0002
240 #define IEEE80211_CAP_PRIVACY 0x0010
241 #define IEEE80211_CAP_RRM 0x1000
243 /* DMG (60 GHz) IEEE 802.11ad */
244 /* type - bits 0..1 */
245 #define IEEE80211_CAP_DMG_MASK 0x0003
246 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
247 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
248 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
250 #define WPA_SCAN_QUAL_INVALID BIT(0)
251 #define WPA_SCAN_NOISE_INVALID BIT(1)
252 #define WPA_SCAN_LEVEL_INVALID BIT(2)
253 #define WPA_SCAN_LEVEL_DBM BIT(3)
254 #define WPA_SCAN_ASSOCIATED BIT(5)
257 * struct wpa_scan_res - Scan result for an BSS/IBSS
258 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
260 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
261 * @beacon_int: beacon interval in TUs (host byte order)
262 * @caps: capability information field in host byte order
263 * @qual: signal quality
264 * @noise: noise level
265 * @level: signal level
267 * @age: Age of the information in milliseconds (i.e., how many milliseconds
268 * ago the last Beacon or Probe Response frame was received)
269 * @est_throughput: Estimated throughput in kbps (this is calculated during
270 * scan result processing if left zero by the driver wrapper)
271 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
272 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
273 * of TSF of the BSS specified by %tsf_bssid.
274 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
275 * @ie_len: length of the following IE field in octets
276 * @beacon_ie_len: length of the following Beacon IE field in octets
278 * This structure is used as a generic format for scan results from the
279 * driver. Each driver interface implementation is responsible for converting
280 * the driver or OS specific scan results into this format.
282 * If the driver does not support reporting all IEs, the IE data structure is
283 * constructed of the IEs that are available. This field will also need to
284 * include SSID in IE format. All drivers are encouraged to be extended to
285 * report all IEs to make it easier to support future additions.
287 * This structure data is followed by ie_len octets of IEs from Probe Response
288 * frame (or if the driver does not indicate source of IEs, these may also be
289 * from Beacon frame). After the first set of IEs, another set of IEs may follow
290 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
292 struct wpa_scan_res
{
303 unsigned int est_throughput
;
306 u8 tsf_bssid
[ETH_ALEN
];
308 size_t beacon_ie_len
;
309 /* Followed by ie_len + beacon_ie_len octets of IE data */
313 * struct wpa_scan_results - Scan results
314 * @res: Array of pointers to allocated variable length scan result entries
315 * @num: Number of entries in the scan result array
316 * @fetch_time: Time when the results were fetched from the driver
318 struct wpa_scan_results
{
319 struct wpa_scan_res
**res
;
321 struct os_reltime fetch_time
;
325 * struct wpa_interface_info - Network interface information
326 * @next: Pointer to the next interface or NULL if this is the last one
327 * @ifname: Interface name that can be used with init() or init2()
328 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
330 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
331 * is not an allocated copy, i.e., get_interfaces() caller will not free
334 struct wpa_interface_info
{
335 struct wpa_interface_info
*next
;
338 const char *drv_name
;
341 #define WPAS_MAX_SCAN_SSIDS 16
344 * struct wpa_driver_scan_ssid - SSIDs to scan for
345 * @ssid - specific SSID to scan for (ProbeReq)
346 * %NULL or zero-length SSID is used to indicate active scan
347 * with wildcard SSID.
348 * @ssid_len - Length of the SSID in octets
350 struct wpa_driver_scan_ssid
{
356 * struct wpa_driver_scan_params - Scan parameters
357 * Data for struct wpa_driver_ops::scan2().
359 struct wpa_driver_scan_params
{
361 * ssids - SSIDs to scan for
363 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
366 * num_ssids - Number of entries in ssids array
367 * Zero indicates a request for a passive scan.
372 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
377 * extra_ies_len - Length of extra_ies in octets
379 size_t extra_ies_len
;
382 * freqs - Array of frequencies to scan or %NULL for all frequencies
384 * The frequency is set in MHz. The array is zero-terminated.
389 * filter_ssids - Filter for reporting SSIDs
391 * This optional parameter can be used to request the driver wrapper to
392 * filter scan results to include only the specified SSIDs. %NULL
393 * indicates that no filtering is to be done. This can be used to
394 * reduce memory needs for scan results in environments that have large
395 * number of APs with different SSIDs.
397 * The driver wrapper is allowed to take this allocated buffer into its
398 * own use by setting the pointer to %NULL. In that case, the driver
399 * wrapper is responsible for freeing the buffer with os_free() once it
400 * is not needed anymore.
402 struct wpa_driver_scan_filter
{
403 u8 ssid
[SSID_MAX_LEN
];
408 * num_filter_ssids - Number of entries in filter_ssids array
410 size_t num_filter_ssids
;
413 * filter_rssi - Filter by RSSI
415 * The driver may filter scan results in firmware to reduce host
416 * wakeups and thereby save power. Specify the RSSI threshold in s32
422 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
424 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
425 * Mbps from the support rates element(s) in the Probe Request frames
426 * and not to transmit the frames at any of those rates.
428 unsigned int p2p_probe
:1;
431 * only_new_results - Request driver to report only new results
433 * This is used to request the driver to report only BSSes that have
434 * been detected after this scan request has been started, i.e., to
435 * flush old cached BSS entries.
437 unsigned int only_new_results
:1;
440 * low_priority - Requests driver to use a lower scan priority
442 * This is used to request the driver to use a lower scan priority
443 * if it supports such a thing.
445 unsigned int low_priority
:1;
448 * mac_addr_rand - Requests driver to randomize MAC address
450 unsigned int mac_addr_rand
:1;
453 * mac_addr - MAC address used with randomization. The address cannot be
454 * a multicast one, i.e., bit 0 of byte 0 should not be set.
459 * mac_addr_mask - MAC address mask used with randomization.
461 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
462 * the mask should be taken as is from mac_addr. The mask should not
463 * allow the generation of a multicast address, i.e., bit 0 of byte 0
466 const u8
*mac_addr_mask
;
469 * sched_scan_plans - Scan plans for scheduled scan
471 * Each scan plan consists of the number of iterations to scan and the
472 * interval between scans. When a scan plan finishes (i.e., it was run
473 * for the specified number of iterations), the next scan plan is
474 * executed. The scan plans are executed in the order they appear in
475 * the array (lower index first). The last scan plan will run infinitely
476 * (until requested to stop), thus must not specify the number of
477 * iterations. All other scan plans must specify the number of
480 struct sched_scan_plan
{
481 u32 interval
; /* In seconds */
482 u32 iterations
; /* Zero to run infinitely */
486 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
488 unsigned int sched_scan_plans_num
;
491 * sched_scan_start_delay - Delay to use before starting the first scan
493 * Delay (in seconds) before scheduling first scan plan cycle. The
494 * driver may ignore this parameter and start immediately (or at any
495 * other time), if this feature is not supported.
497 u32 sched_scan_start_delay
;
500 * bssid - Specific BSSID to scan for
502 * This optional parameter can be used to replace the default wildcard
503 * BSSID with a specific BSSID to scan for if results are needed from
509 * scan_cookie - Unique identification representing the scan request
511 * This scan_cookie carries a unique identification representing the
512 * scan request if the host driver/kernel supports concurrent scan
513 * requests. This cookie is returned from the corresponding driver
516 * Note: Unlike other parameters in this structure, scan_cookie is used
517 * only to return information instead of setting parameters for the
523 * duration - Dwell time on each channel
525 * This optional parameter can be used to set the dwell time on each
531 * duration_mandatory - Whether the specified duration is mandatory
533 * If this is set, the duration specified by the %duration field is
534 * mandatory (and the driver should reject the scan request if it is
535 * unable to comply with the specified duration), otherwise it is the
536 * maximum duration and the actual duration may be shorter.
538 unsigned int duration_mandatory
:1;
541 * relative_rssi_set - Whether relative RSSI parameters are set
543 unsigned int relative_rssi_set
:1;
546 * relative_rssi - Relative RSSI for reporting better BSSs
548 * Amount of RSSI by which a BSS should be better than the current
549 * connected BSS to report the new BSS to user space.
554 * relative_adjust_band - Band to which RSSI should be adjusted
556 * The relative_adjust_rssi should be added to the band specified
557 * by relative_adjust_band.
559 enum set_band relative_adjust_band
;
562 * relative_adjust_rssi - RSSI to be added to relative_adjust_band
564 * An amount of relative_band_rssi should be added to the BSSs that
565 * belong to the band specified by relative_adjust_band while comparing
566 * with other bands for BSS reporting.
568 s8 relative_adjust_rssi
;
571 * NOTE: Whenever adding new parameters here, please make sure
572 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
578 * struct wpa_driver_auth_params - Authentication parameters
579 * Data for struct wpa_driver_ops::authenticate().
581 struct wpa_driver_auth_params
{
589 const u8
*wep_key
[4];
590 size_t wep_key_len
[4];
592 int local_state_change
;
595 * p2p - Whether this connection is a P2P group
600 * auth_data - Additional elements for Authentication frame
602 * This buffer starts with the Authentication transaction sequence
603 * number field. If no special handling of such elements is needed, this
604 * pointer is %NULL. This is used with SAE and FILS.
609 * auth_data_len - Length of auth_data buffer in octets
611 size_t auth_data_len
;
615 * enum wps_mode - WPS mode
619 * WPS_MODE_NONE - No WPS provisioning being used
624 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
629 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
635 * struct hostapd_freq_params - Channel parameters
637 struct hostapd_freq_params
{
639 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
641 enum hostapd_hw_mode mode
;
644 * freq - Primary channel center frequency in MHz
649 * channel - Channel number
654 * ht_enabled - Whether HT is enabled
659 * sec_channel_offset - Secondary channel offset for HT40
662 * -1 = HT40 enabled, secondary channel below primary,
663 * 1 = HT40 enabled, secondary channel above primary
665 int sec_channel_offset
;
668 * vht_enabled - Whether VHT is enabled
673 * center_freq1 - Segment 0 center frequency in MHz
675 * Valid for both HT and VHT.
680 * center_freq2 - Segment 1 center frequency in MHz
682 * Non-zero only for bandwidth 80 and an 80+80 channel
687 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
693 * struct wpa_driver_sta_auth_params - Authentication parameters
694 * Data for struct wpa_driver_ops::sta_auth().
696 struct wpa_driver_sta_auth_params
{
699 * own_addr - Source address and BSSID for authentication frame
704 * addr - MAC address of the station to associate
709 * seq - authentication sequence number
714 * status - authentication response status code
719 * ie - authentication frame ie buffer
724 * len - ie buffer length
729 * fils_auth - Indicates whether FILS authentication is being performed
734 * fils_anonce - ANonce (required for FILS)
736 u8 fils_anonce
[WPA_NONCE_LEN
];
739 * fils_snonce - SNonce (required for FILS)
741 u8 fils_snonce
[WPA_NONCE_LEN
];
744 * fils_kek - key for encryption (required for FILS)
746 u8 fils_kek
[WPA_KEK_MAX_LEN
];
749 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
755 * struct wpa_driver_associate_params - Association parameters
756 * Data for struct wpa_driver_ops::associate().
758 struct wpa_driver_associate_params
{
760 * bssid - BSSID of the selected AP
761 * This can be %NULL, if ap_scan=2 mode is used and the driver is
762 * responsible for selecting with which BSS to associate. */
766 * bssid_hint - BSSID of a proposed AP
768 * This indicates which BSS has been found a suitable candidate for
769 * initial association for drivers that use driver/firmwate-based BSS
770 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
771 * the driver from selecting other BSSes in the ESS.
773 const u8
*bssid_hint
;
776 * ssid - The selected SSID
781 * ssid_len - Length of the SSID (1..32)
786 * freq - channel parameters
788 struct hostapd_freq_params freq
;
791 * freq_hint - Frequency of the channel the proposed AP is using
793 * This provides a channel on which a suitable BSS has been found as a
794 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
795 * limit the driver from selecting other channels for
796 * driver/firmware-based BSS selection.
801 * bg_scan_period - Background scan period in seconds, 0 to disable
802 * background scan, or -1 to indicate no change to default driver
808 * beacon_int - Beacon interval for IBSS or 0 to use driver default
813 * wpa_ie - WPA information element for (Re)Association Request
814 * WPA information element to be included in (Re)Association
815 * Request (including information element id and length). Use
816 * of this WPA IE is optional. If the driver generates the WPA
817 * IE, it can use pairwise_suite, group_suite, and
818 * key_mgmt_suite to select proper algorithms. In this case,
819 * the driver has to notify wpa_supplicant about the used WPA
820 * IE by generating an event that the interface code will
821 * convert into EVENT_ASSOCINFO data (see below).
823 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
824 * instead. The driver can determine which version is used by
825 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
828 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
833 * wpa_ie_len - length of the wpa_ie
838 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
840 unsigned int wpa_proto
;
843 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
845 * This is usually ignored if @wpa_ie is used.
847 unsigned int pairwise_suite
;
850 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
852 * This is usually ignored if @wpa_ie is used.
854 unsigned int group_suite
;
857 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
859 * This is usually ignored if @wpa_ie is used.
861 unsigned int key_mgmt_suite
;
864 * auth_alg - Allowed authentication algorithms
865 * Bit field of WPA_AUTH_ALG_*
870 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
875 * wep_key - WEP keys for static WEP configuration
877 const u8
*wep_key
[4];
880 * wep_key_len - WEP key length for static WEP configuration
882 size_t wep_key_len
[4];
885 * wep_tx_keyidx - WEP TX key index for static WEP configuration
890 * mgmt_frame_protection - IEEE 802.11w management frame protection
892 enum mfp_options mgmt_frame_protection
;
895 * passphrase - RSN passphrase for PSK
897 * This value is made available only for WPA/WPA2-Personal (PSK) and
898 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
899 * the 8..63 character ASCII passphrase, if available. Please note that
900 * this can be %NULL if passphrase was not used to generate the PSK. In
901 * that case, the psk field must be used to fetch the PSK.
903 const char *passphrase
;
906 * psk - RSN PSK (alternative for passphrase for PSK)
908 * This value is made available only for WPA/WPA2-Personal (PSK) and
909 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
910 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
911 * be prepared to handle %NULL value as an error.
916 * drop_unencrypted - Enable/disable unencrypted frame filtering
918 * Configure the driver to drop all non-EAPOL frames (both receive and
919 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
920 * still be allowed for key negotiation.
922 int drop_unencrypted
;
925 * prev_bssid - Previously used BSSID in this ESS
927 * When not %NULL, this is a request to use reassociation instead of
930 const u8
*prev_bssid
;
935 * If the driver needs to do special configuration for WPS association,
936 * this variable provides more information on what type of association
937 * is being requested. Most drivers should not need ot use this.
942 * p2p - Whether this connection is a P2P group
947 * uapsd - UAPSD parameters for the network
948 * -1 = do not change defaults
949 * AP mode: 1 = enabled, 0 = disabled
950 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
955 * fixed_bssid - Whether to force this BSSID in IBSS mode
956 * 1 = Fix this BSSID and prevent merges.
957 * 0 = Do not fix BSSID.
962 * fixed_freq - Fix control channel in IBSS mode
963 * 0 = don't fix control channel (default)
964 * 1 = fix control channel; this prevents IBSS merging with another
970 * disable_ht - Disable HT (IEEE 802.11n) for this connection
975 * htcaps - HT Capabilities over-rides
977 * Only bits set in the mask will be used, and not all values are used
978 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
980 * Pointer to struct ieee80211_ht_capabilities.
985 * htcaps_mask - HT Capabilities over-rides mask
987 * Pointer to struct ieee80211_ht_capabilities.
989 const u8
*htcaps_mask
;
991 #ifdef CONFIG_VHT_OVERRIDES
993 * disable_vht - Disable VHT for this connection
998 * VHT capability overrides.
1000 const struct ieee80211_vht_capabilities
*vhtcaps
;
1001 const struct ieee80211_vht_capabilities
*vhtcaps_mask
;
1002 #endif /* CONFIG_VHT_OVERRIDES */
1005 * req_key_mgmt_offload - Request key management offload for connection
1007 * Request key management offload for this connection if the device
1010 int req_key_mgmt_offload
;
1013 * Flag for indicating whether this association includes support for
1014 * RRM (Radio Resource Measurements)
1019 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1020 * AP as usual. Valid for DMG network only.
1025 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1030 * fils_kek_len: Length of fils_kek in bytes
1032 size_t fils_kek_len
;
1035 * fils_nonces - Nonces for FILS association frame protection
1038 const u8
*fils_nonces
;
1041 * fils_nonces_len: Length of fils_nonce in bytes
1043 size_t fils_nonces_len
;
1046 * fils_erp_username - Username part of keyName-NAI
1048 const u8
*fils_erp_username
;
1051 * fils_erp_username_len - Length of fils_erp_username in bytes
1053 size_t fils_erp_username_len
;
1056 * fils_erp_realm - Realm/domain name to use in FILS ERP
1058 const u8
*fils_erp_realm
;
1061 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1063 size_t fils_erp_realm_len
;
1066 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1069 u16 fils_erp_next_seq_num
;
1072 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1073 * specified by fils_erp_username@fils_erp_realm.
1075 const u8
*fils_erp_rrk
;
1078 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1080 size_t fils_erp_rrk_len
;
1085 HIDDEN_SSID_ZERO_LEN
,
1086 HIDDEN_SSID_ZERO_CONTENTS
1089 struct wowlan_triggers
{
1093 u8 gtk_rekey_failure
;
1094 u8 eap_identity_req
;
1095 u8 four_way_handshake
;
1099 struct wpa_driver_ap_params
{
1101 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1106 * head_len - Length of the head buffer in octets
1111 * tail - Beacon tail following TIM IE
1116 * tail_len - Length of the tail buffer in octets
1121 * dtim_period - DTIM period
1126 * beacon_int - Beacon interval
1131 * basic_rates: -1 terminated array of basic rates in 100 kbps
1133 * This parameter can be used to set a specific basic rate set for the
1134 * BSS. If %NULL, default basic rate set is used.
1139 * beacon_rate: Beacon frame data rate
1141 * This parameter can be used to set a specific Beacon frame data rate
1142 * for the BSS. The interpretation of this value depends on the
1143 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS). If
1144 * beacon_rate == 0 and rate_type == 0 (BEACON_RATE_LEGACY), the default
1145 * Beacon frame data rate is used.
1147 unsigned int beacon_rate
;
1150 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT)
1152 enum beacon_rate_type rate_type
;
1155 * proberesp - Probe Response template
1157 * This is used by drivers that reply to Probe Requests internally in
1158 * AP mode and require the full Probe Response template.
1163 * proberesp_len - Length of the proberesp buffer in octets
1165 size_t proberesp_len
;
1168 * ssid - The SSID to use in Beacon/Probe Response frames
1173 * ssid_len - Length of the SSID (1..32)
1178 * hide_ssid - Whether to hide the SSID
1180 enum hide_ssid hide_ssid
;
1183 * pairwise_ciphers - WPA_CIPHER_* bitfield
1185 unsigned int pairwise_ciphers
;
1188 * group_cipher - WPA_CIPHER_*
1190 unsigned int group_cipher
;
1193 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1195 unsigned int key_mgmt_suites
;
1198 * auth_algs - WPA_AUTH_ALG_* bitfield
1200 unsigned int auth_algs
;
1203 * wpa_version - WPA_PROTO_* bitfield
1205 unsigned int wpa_version
;
1208 * privacy - Whether privacy is used in the BSS
1213 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1215 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1216 * not use the full Beacon template.
1218 const struct wpabuf
*beacon_ies
;
1221 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1223 * This is used to add IEs like WPS IE and P2P IE by drivers that
1224 * reply to Probe Request frames internally.
1226 const struct wpabuf
*proberesp_ies
;
1229 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1231 * This is used to add IEs like WPS IE by drivers that reply to
1232 * (Re)Association Request frames internally.
1234 const struct wpabuf
*assocresp_ies
;
1237 * isolate - Whether to isolate frames between associated stations
1239 * If this is non-zero, the AP is requested to disable forwarding of
1240 * frames between associated stations.
1245 * cts_protect - Whether CTS protection is enabled
1250 * preamble - Whether short preamble is enabled
1255 * short_slot_time - Whether short slot time is enabled
1257 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1258 * not set (e.g., when 802.11g mode is not in use)
1260 int short_slot_time
;
1263 * ht_opmode - HT operation mode or -1 if HT not in use
1268 * interworking - Whether Interworking is enabled
1273 * hessid - Homogeneous ESS identifier or %NULL if not set
1278 * access_network_type - Access Network Type (0..15)
1280 * This is used for filtering Probe Request frames when Interworking is
1283 u8 access_network_type
;
1286 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1288 * This is used by driver which advertises this capability.
1290 int ap_max_inactivity
;
1293 * ctwindow - Client Traffic Window (in TUs)
1298 * smps_mode - SMPS mode
1300 * SMPS mode to be used by the AP, specified as the relevant bits of
1301 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1303 unsigned int smps_mode
;
1306 * disable_dgaf - Whether group-addressed frames are disabled
1311 * osen - Whether OSEN security is enabled
1316 * freq - Channel parameters for dynamic bandwidth changes
1318 struct hostapd_freq_params
*freq
;
1321 * reenable - Whether this is to re-enable beaconing
1326 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1327 * infrastructure BSS. Valid only for DMG network.
1332 * multicast_to_unicast - Whether to use multicast_to_unicast
1334 * If this is non-zero, the AP is requested to perform multicast to
1335 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1336 * 802.1Q). If enabled, such frames are to be sent to each station
1337 * separately, with the DA replaced by their own MAC address rather
1338 * than the group address.
1340 * Note that this may break certain expectations of the receiver, such
1341 * as the ability to drop unicast IP packets received within multicast
1342 * L2 frames, or the ability to not send ICMP destination unreachable
1343 * messages for packets received in L2 multicast (which is required,
1344 * but the receiver can't tell the difference if this new option is
1347 * This also doesn't implement the 802.11 DMS (directed multicast
1350 int multicast_to_unicast
;
1353 struct wpa_driver_mesh_bss_params
{
1354 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1355 #define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1356 #define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1357 #define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
1358 #define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010
1360 * TODO: Other mesh configuration parameters would go here.
1361 * See NL80211_MESHCONF_* for all the mesh config parameters.
1365 int peer_link_timeout
;
1371 struct wpa_driver_mesh_join_params
{
1374 const int *basic_rates
;
1377 struct hostapd_freq_params freq
;
1380 struct wpa_driver_mesh_bss_params conf
;
1381 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1382 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1383 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1384 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1389 * struct wpa_driver_capa - Driver capability information
1391 struct wpa_driver_capa
{
1392 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1393 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1394 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1395 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1396 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1397 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1398 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1399 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1400 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1401 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
1402 #define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
1403 #define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
1404 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1405 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1406 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1407 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
1408 /** Bitfield of supported key management suites */
1409 unsigned int key_mgmt
;
1411 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1412 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1413 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1414 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1415 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1416 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1417 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1418 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1419 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1420 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1421 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1422 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1423 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1424 /** Bitfield of supported cipher suites */
1427 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1428 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1429 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1430 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1433 /** Driver generated WPA/RSN IE */
1434 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1435 /** Driver needs static WEP key setup after association command */
1436 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1437 /** Driver takes care of all DFS operations */
1438 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1439 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1440 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1441 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1442 /** Driver is for a wired Ethernet interface */
1443 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1444 /** Driver provides separate commands for authentication and association (SME in
1445 * wpa_supplicant). */
1446 #define WPA_DRIVER_FLAGS_SME 0x00000020
1447 /** Driver supports AP mode */
1448 #define WPA_DRIVER_FLAGS_AP 0x00000040
1449 /** Driver needs static WEP key setup after association has been completed */
1450 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1451 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1452 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1453 /** Driver supports concurrent P2P operations */
1454 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1456 * Driver uses the initial interface as a dedicated management interface, i.e.,
1457 * it cannot be used for P2P group operations or non-P2P purposes.
1459 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1460 /** This interface is P2P capable (P2P GO or P2P Client) */
1461 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1462 /** Driver supports station and key removal when stopping an AP */
1463 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1465 * Driver uses the initial interface for P2P management interface and non-P2P
1466 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1467 * P2P group operations.
1469 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1471 * Driver is known to use sane error codes, i.e., when it indicates that
1472 * something (e.g., association) fails, there was indeed a failure and the
1473 * operation does not end up getting completed successfully later.
1475 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1476 /** Driver supports off-channel TX */
1477 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1478 /** Driver indicates TX status events for EAPOL Data frames */
1479 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1480 /** Driver indicates TX status events for Deauth/Disassoc frames */
1481 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1482 /** Driver supports roaming (BSS selection) in firmware */
1483 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1484 /** Driver supports operating as a TDLS peer */
1485 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1486 /** Driver requires external TDLS setup/teardown/discovery */
1487 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1488 /** Driver indicates support for Probe Response offloading in AP mode */
1489 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1490 /** Driver supports U-APSD in AP mode */
1491 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1492 /** Driver supports inactivity timer in AP mode */
1493 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1494 /** Driver expects user space implementation of MLME in AP mode */
1495 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1496 /** Driver supports SAE with user space SME */
1497 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1498 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1499 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1500 /** Driver supports IBSS (Ad-hoc) mode */
1501 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1502 /** Driver supports radar detection */
1503 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1504 /** Driver supports a dedicated interface for P2P Device */
1505 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1506 /** Driver supports QoS Mapping */
1507 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1508 /** Driver supports CSA in AP mode */
1509 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1510 /** Driver supports mesh */
1511 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1512 /** Driver support ACS offload */
1513 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1514 /** Driver supports key management offload */
1515 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1516 /** Driver supports TDLS channel switching */
1517 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1518 /** Driver supports IBSS with HT datarates */
1519 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
1520 /** Driver supports IBSS with VHT datarates */
1521 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
1522 /** Driver supports automatic band selection */
1523 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
1524 /** Driver supports simultaneous off-channel operations */
1525 #define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
1526 /** Driver supports full AP client state */
1527 #define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
1528 /** Driver supports P2P Listen offload */
1529 #define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
1530 /** Driver supports FILS */
1531 #define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
1532 /** Driver supports Beacon frame TX rate configuration (legacy rates) */
1533 #define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1534 /** Driver supports Beacon frame TX rate configuration (HT rates) */
1535 #define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1536 /** Driver supports Beacon frame TX rate configuration (VHT rates) */
1537 #define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
1538 /** Driver supports mgmt_tx with random TX address in non-connected state */
1539 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
1540 /** Driver supports mgmt_tx with random TX addr in connected state */
1541 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
1542 /** Driver supports better BSS reporting with sched_scan in connected mode */
1543 #define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
1544 /** Driver supports HE capabilities */
1545 #define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
1546 /** Driver supports FILS shared key offload */
1547 #define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
1548 /** Driver supports all OCE STA specific mandatory features */
1549 #define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
1550 /** Driver supports all OCE AP specific mandatory features */
1551 #define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
1553 * Driver supports all OCE STA-CFON specific mandatory features only.
1554 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
1555 * userspace shall assume that this driver may not support all OCE AP
1556 * functionality but can support only OCE STA-CFON functionality.
1558 #define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
1561 #define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1562 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1564 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1565 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1566 unsigned int smps_modes
;
1568 unsigned int wmm_ac_supported
:1;
1570 unsigned int mac_addr_rand_scan_supported
:1;
1571 unsigned int mac_addr_rand_sched_scan_supported
:1;
1573 /** Maximum number of supported active probe SSIDs */
1576 /** Maximum number of supported active probe SSIDs for sched_scan */
1577 int max_sched_scan_ssids
;
1579 /** Maximum number of supported scan plans for scheduled scan */
1580 unsigned int max_sched_scan_plans
;
1582 /** Maximum interval in a scan plan. In seconds */
1583 u32 max_sched_scan_plan_interval
;
1585 /** Maximum number of iterations in a single scan plan */
1586 u32 max_sched_scan_plan_iterations
;
1588 /** Whether sched_scan (offloaded scanning) is supported */
1589 int sched_scan_supported
;
1591 /** Maximum number of supported match sets for sched_scan */
1595 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1597 unsigned int max_remain_on_chan
;
1600 * max_stations - Maximum number of associated stations the driver
1601 * supports in AP mode
1603 unsigned int max_stations
;
1606 * probe_resp_offloads - Bitmap of supported protocols by the driver
1607 * for Probe Response offloading.
1609 /** Driver Probe Response offloading support for WPS ver. 1 */
1610 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1611 /** Driver Probe Response offloading support for WPS ver. 2 */
1612 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1613 /** Driver Probe Response offloading support for P2P */
1614 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1615 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1616 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1617 unsigned int probe_resp_offloads
;
1619 unsigned int max_acl_mac_addrs
;
1622 * Number of supported concurrent channels
1624 unsigned int num_multichan_concurrent
;
1627 * extended_capa - extended capabilities in driver/device
1629 * Must be allocated and freed by driver and the pointers must be
1630 * valid for the lifetime of the driver, i.e., freed in deinit()
1632 const u8
*extended_capa
, *extended_capa_mask
;
1633 unsigned int extended_capa_len
;
1635 struct wowlan_triggers wowlan_triggers
;
1637 /** Driver adds the DS Params Set IE in Probe Request frames */
1638 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1639 /** Driver adds the WFA TPC IE in Probe Request frames */
1640 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1641 /** Driver handles quiet period requests */
1642 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1644 * Driver is capable of inserting the current TX power value into the body of
1645 * transmitted frames.
1646 * Background: Some Action frames include a TPC Report IE. This IE contains a
1647 * TX power field, which has to be updated by lower layers. One such Action
1648 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1649 * of spectrum management). Note that this insertion takes place at a fixed
1650 * offset, namely the 6th byte in the Action frame body.
1652 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1654 * Driver supports RRM. With this support, the driver will accept to use RRM in
1655 * (Re)Association Request frames, without supporting quiet period.
1657 #define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1659 /** Driver supports setting the scan dwell time */
1660 #define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
1661 /** Driver supports Beacon Report Measurement */
1662 #define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
1666 /* Driver concurrency capabilities */
1667 unsigned int conc_capab
;
1668 /* Maximum number of concurrent channels on 2.4 GHz */
1669 unsigned int max_conc_chan_2_4
;
1670 /* Maximum number of concurrent channels on 5 GHz */
1671 unsigned int max_conc_chan_5_0
;
1673 /* Maximum number of supported CSA counters */
1674 u16 max_csa_counters
;
1678 struct hostapd_data
;
1680 struct hostap_sta_driver_data
{
1681 unsigned long rx_packets
, tx_packets
;
1682 unsigned long long rx_bytes
, tx_bytes
;
1683 int bytes_64bit
; /* whether 64-bit byte counters are supported */
1684 unsigned long current_tx_rate
;
1685 unsigned long inactive_msec
;
1686 unsigned long flags
;
1687 unsigned long num_ps_buf_frames
;
1688 unsigned long tx_retry_failed
;
1689 unsigned long tx_retry_count
;
1694 struct hostapd_sta_add_params
{
1698 const u8
*supp_rates
;
1699 size_t supp_rates_len
;
1700 u16 listen_interval
;
1701 const struct ieee80211_ht_capabilities
*ht_capabilities
;
1702 const struct ieee80211_vht_capabilities
*vht_capabilities
;
1703 int vht_opmode_enabled
;
1705 u32 flags
; /* bitmask of WPA_STA_* flags */
1706 u32 flags_mask
; /* unset bits in flags */
1708 enum mesh_plink_state plink_state
;
1710 #endif /* CONFIG_MESH */
1711 int set
; /* Set STA parameters instead of add */
1713 const u8
*ext_capab
;
1714 size_t ext_capab_len
;
1715 const u8
*supp_channels
;
1716 size_t supp_channels_len
;
1717 const u8
*supp_oper_classes
;
1718 size_t supp_oper_classes_len
;
1722 struct mac_address
{
1726 struct hostapd_acl_params
{
1728 unsigned int num_mac_acl
;
1729 struct mac_address mac_acl
[0];
1732 enum wpa_driver_if_type
{
1734 * WPA_IF_STATION - Station mode interface
1739 * WPA_IF_AP_VLAN - AP mode VLAN interface
1741 * This interface shares its address and Beacon frame with the main
1747 * WPA_IF_AP_BSS - AP mode BSS interface
1749 * This interface has its own address and Beacon frame.
1754 * WPA_IF_P2P_GO - P2P Group Owner
1759 * WPA_IF_P2P_CLIENT - P2P Client
1764 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1765 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1770 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1771 * abstracted P2P Device function in the driver
1776 * WPA_IF_MESH - Mesh interface
1781 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1786 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1791 struct wpa_init_params
{
1795 const char *driver_params
;
1796 int use_pae_group_addr
;
1800 u8
*own_addr
; /* buffer for writing own MAC address */
1804 struct wpa_bss_params
{
1805 /** Interface name (for multi-SSID/VLAN support) */
1807 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1816 enum mfp_options ieee80211w
;
1819 #define WPA_STA_AUTHORIZED BIT(0)
1820 #define WPA_STA_WMM BIT(1)
1821 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1822 #define WPA_STA_MFP BIT(3)
1823 #define WPA_STA_TDLS_PEER BIT(4)
1824 #define WPA_STA_AUTHENTICATED BIT(5)
1825 #define WPA_STA_ASSOCIATED BIT(6)
1838 WNM_SLEEP_ENTER_CONFIRM
,
1839 WNM_SLEEP_ENTER_FAIL
,
1840 WNM_SLEEP_EXIT_CONFIRM
,
1841 WNM_SLEEP_EXIT_FAIL
,
1842 WNM_SLEEP_TFS_REQ_IE_ADD
, /* STA requests driver to add TFS req IE */
1843 WNM_SLEEP_TFS_REQ_IE_NONE
, /* STA requests empty TFS req IE */
1844 WNM_SLEEP_TFS_REQ_IE_SET
, /* AP requests driver to set TFS req IE for
1846 WNM_SLEEP_TFS_RESP_IE_ADD
, /* AP requests driver to add TFS resp IE
1848 WNM_SLEEP_TFS_RESP_IE_NONE
, /* AP requests empty TFS resp IE */
1849 WNM_SLEEP_TFS_RESP_IE_SET
, /* AP requests driver to set TFS resp IE
1851 WNM_SLEEP_TFS_IE_DEL
/* AP delete the TFS IE */
1854 /* enum chan_width - Channel width definitions */
1866 * struct wpa_signal_info - Information about channel signal quality
1868 struct wpa_signal_info
{
1870 int above_threshold
;
1873 int avg_beacon_signal
;
1876 enum chan_width chanwidth
;
1882 * struct beacon_data - Beacon data
1883 * @head: Head portion of Beacon frame (before TIM IE)
1884 * @tail: Tail portion of Beacon frame (after TIM IE)
1885 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1886 * @proberesp_ies: Extra information element(s) to add into Probe Response
1888 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1889 * Response frames or %NULL
1890 * @probe_resp: Probe Response frame template
1891 * @head_len: Length of @head
1892 * @tail_len: Length of @tail
1893 * @beacon_ies_len: Length of beacon_ies in octets
1894 * @proberesp_ies_len: Length of proberesp_ies in octets
1895 * @proberesp_ies_len: Length of proberesp_ies in octets
1896 * @probe_resp_len: Length of probe response template (@probe_resp)
1898 struct beacon_data
{
1905 size_t head_len
, tail_len
;
1906 size_t beacon_ies_len
;
1907 size_t proberesp_ies_len
;
1908 size_t assocresp_ies_len
;
1909 size_t probe_resp_len
;
1913 * struct csa_settings - Settings for channel switch command
1914 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1915 * @block_tx: 1 - block transmission for CSA period
1916 * @freq_params: Next channel frequency parameter
1917 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1918 * @beacon_after: Next beacon/probe resp/asooc resp info
1919 * @counter_offset_beacon: Offset to the count field in beacon's tail
1920 * @counter_offset_presp: Offset to the count field in probe resp.
1922 struct csa_settings
{
1926 struct hostapd_freq_params freq_params
;
1927 struct beacon_data beacon_csa
;
1928 struct beacon_data beacon_after
;
1930 u16 counter_offset_beacon
[2];
1931 u16 counter_offset_presp
[2];
1934 /* TDLS peer capabilities for send_tdls_mgmt() */
1935 enum tdls_peer_capability
{
1936 TDLS_PEER_HT
= BIT(0),
1937 TDLS_PEER_VHT
= BIT(1),
1938 TDLS_PEER_WMM
= BIT(2),
1941 /* valid info in the wmm_params struct */
1942 enum wmm_params_valid_info
{
1943 WMM_PARAMS_UAPSD_QUEUES_INFO
= BIT(0),
1947 * struct wmm_params - WMM parameterss configured for this association
1948 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1949 * of the struct contain valid information.
1950 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1951 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1958 #ifdef CONFIG_MACSEC
1959 struct macsec_init_params
{
1960 Boolean always_include_sci
;
1964 #endif /* CONFIG_MACSEC */
1966 enum drv_br_port_attr
{
1967 DRV_BR_PORT_ATTR_PROXYARP
,
1968 DRV_BR_PORT_ATTR_HAIRPIN_MODE
,
1971 enum drv_br_net_param
{
1972 DRV_BR_NET_PARAM_GARP_ACCEPT
,
1973 DRV_BR_MULTICAST_SNOOPING
,
1976 struct drv_acs_params
{
1977 /* Selected mode (HOSTAPD_MODE_*) */
1978 enum hostapd_hw_mode hw_mode
;
1980 /* Indicates whether HT is enabled */
1983 /* Indicates whether HT40 is enabled */
1986 /* Indicates whether VHT is enabled */
1989 /* Configured ACS channel width */
1992 /* ACS channel list info */
1993 unsigned int ch_list_len
;
1995 const int *freq_list
;
1998 struct wpa_bss_trans_info
{
1999 u8 mbo_transition_reason
;
2004 struct wpa_bss_candidate_info
{
2006 struct candidate_list
{
2013 struct wpa_pmkid_params
{
2017 const u8
*fils_cache_id
;
2024 * struct wpa_driver_ops - Driver interface API definition
2026 * This structure defines the API that each driver interface needs to implement
2027 * for core wpa_supplicant code. All driver specific functionality is captured
2030 struct wpa_driver_ops
{
2031 /** Name of the driver interface */
2033 /** One line description of the driver interface */
2037 * get_bssid - Get the current BSSID
2038 * @priv: private driver interface data
2039 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2041 * Returns: 0 on success, -1 on failure
2043 * Query kernel driver for the current BSSID and copy it to bssid.
2044 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2047 int (*get_bssid
)(void *priv
, u8
*bssid
);
2050 * get_ssid - Get the current SSID
2051 * @priv: private driver interface data
2052 * @ssid: buffer for SSID (at least 32 bytes)
2054 * Returns: Length of the SSID on success, -1 on failure
2056 * Query kernel driver for the current SSID and copy it to ssid.
2057 * Returning zero is recommended if the STA is not associated.
2059 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2060 * can, at least in theory, contain control characters (including nul)
2061 * and as such, should be processed as binary data, not a printable
2064 int (*get_ssid
)(void *priv
, u8
*ssid
);
2067 * set_key - Configure encryption key
2068 * @ifname: Interface name (for multi-SSID/VLAN support)
2069 * @priv: private driver interface data
2070 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
2071 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
2072 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
2073 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
2074 * %WPA_ALG_BIP_CMAC_256);
2075 * %WPA_ALG_NONE clears the key.
2076 * @addr: Address of the peer STA (BSSID of the current AP when setting
2077 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
2078 * broadcast keys, %NULL for default keys that are used both for
2079 * broadcast and unicast; when clearing keys, %NULL is used to
2080 * indicate that both the broadcast-only and default key of the
2081 * specified key index is to be cleared
2082 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
2084 * @set_tx: configure this key as the default Tx key (only used when
2085 * driver does not support separate unicast/individual key
2086 * @seq: sequence number/packet number, seq_len octets, the next
2087 * packet number to be used for in replay protection; configured
2088 * for Rx keys (in most cases, this is only used with broadcast
2089 * keys and set to zero for unicast keys); %NULL if not set
2090 * @seq_len: length of the seq, depends on the algorithm:
2091 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
2092 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
2094 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
2095 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
2097 * Returns: 0 on success, -1 on failure
2099 * Configure the given key for the kernel driver. If the driver
2100 * supports separate individual keys (4 default keys + 1 individual),
2101 * addr can be used to determine whether the key is default or
2102 * individual. If only 4 keys are supported, the default key with key
2103 * index 0 is used as the individual key. STA must be configured to use
2104 * it as the default Tx key (set_tx is set) and accept Rx for all the
2105 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2106 * broadcast keys, so key index 0 is available for this kind of
2109 * Please note that TKIP keys include separate TX and RX MIC keys and
2110 * some drivers may expect them in different order than wpa_supplicant
2111 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
2112 * will trigger Michael MIC errors. This can be fixed by changing the
2113 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
2114 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2115 * example on how this can be done.
2117 int (*set_key
)(const char *ifname
, void *priv
, enum wpa_alg alg
,
2118 const u8
*addr
, int key_idx
, int set_tx
,
2119 const u8
*seq
, size_t seq_len
,
2120 const u8
*key
, size_t key_len
);
2123 * init - Initialize driver interface
2124 * @ctx: context to be used when calling wpa_supplicant functions,
2125 * e.g., wpa_supplicant_event()
2126 * @ifname: interface name, e.g., wlan0
2128 * Returns: Pointer to private data, %NULL on failure
2130 * Initialize driver interface, including event processing for kernel
2131 * driver events (e.g., associated, scan results, Michael MIC failure).
2132 * This function can allocate a private configuration data area for
2133 * @ctx, file descriptor, interface name, etc. information that may be
2134 * needed in future driver operations. If this is not used, non-NULL
2135 * value will need to be returned because %NULL is used to indicate
2136 * failure. The returned value will be used as 'void *priv' data for
2137 * all other driver_ops functions.
2139 * The main event loop (eloop.c) of wpa_supplicant can be used to
2140 * register callback for read sockets (eloop_register_read_sock()).
2142 * See below for more information about events and
2143 * wpa_supplicant_event() function.
2145 void * (*init
)(void *ctx
, const char *ifname
);
2148 * deinit - Deinitialize driver interface
2149 * @priv: private driver interface data from init()
2151 * Shut down driver interface and processing of driver events. Free
2152 * private data buffer if one was allocated in init() handler.
2154 void (*deinit
)(void *priv
);
2157 * set_param - Set driver configuration parameters
2158 * @priv: private driver interface data from init()
2159 * @param: driver specific configuration parameters
2161 * Returns: 0 on success, -1 on failure
2163 * Optional handler for notifying driver interface about configuration
2164 * parameters (driver_param).
2166 int (*set_param
)(void *priv
, const char *param
);
2169 * set_countermeasures - Enable/disable TKIP countermeasures
2170 * @priv: private driver interface data
2171 * @enabled: 1 = countermeasures enabled, 0 = disabled
2173 * Returns: 0 on success, -1 on failure
2175 * Configure TKIP countermeasures. When these are enabled, the driver
2176 * should drop all received and queued frames that are using TKIP.
2178 int (*set_countermeasures
)(void *priv
, int enabled
);
2181 * deauthenticate - Request driver to deauthenticate
2182 * @priv: private driver interface data
2183 * @addr: peer address (BSSID of the AP)
2184 * @reason_code: 16-bit reason code to be sent in the deauthentication
2187 * Returns: 0 on success, -1 on failure
2189 int (*deauthenticate
)(void *priv
, const u8
*addr
, int reason_code
);
2192 * associate - Request driver to associate
2193 * @priv: private driver interface data
2194 * @params: association parameters
2196 * Returns: 0 on success, -1 on failure
2198 int (*associate
)(void *priv
,
2199 struct wpa_driver_associate_params
*params
);
2202 * add_pmkid - Add PMKSA cache entry to the driver
2203 * @priv: private driver interface data
2204 * @params: PMKSA parameters
2206 * Returns: 0 on success, -1 on failure
2208 * This function is called when a new PMK is received, as a result of
2209 * either normal authentication or RSN pre-authentication. The PMKSA
2210 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2211 * ssid, fils_cache_id, pmkid, and pmk.
2213 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2214 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2215 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2216 * driver_ops function does not need to be implemented. Likewise, if
2217 * the driver does not support WPA, this function is not needed.
2219 int (*add_pmkid
)(void *priv
, struct wpa_pmkid_params
*params
);
2222 * remove_pmkid - Remove PMKSA cache entry to the driver
2223 * @priv: private driver interface data
2224 * @params: PMKSA parameters
2226 * Returns: 0 on success, -1 on failure
2228 * This function is called when the supplicant drops a PMKSA cache
2229 * entry for any reason. The PMKSA parameters are either a set of
2230 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
2232 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2233 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2234 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2235 * from wpa_supplicant, this driver_ops function does not need to be
2236 * implemented. Likewise, if the driver does not support WPA, this
2237 * function is not needed.
2239 int (*remove_pmkid
)(void *priv
, struct wpa_pmkid_params
*params
);
2242 * flush_pmkid - Flush PMKSA cache
2243 * @priv: private driver interface data
2245 * Returns: 0 on success, -1 on failure
2247 * This function is called when the supplicant drops all PMKSA cache
2248 * entries for any reason.
2250 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2251 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2252 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2253 * from wpa_supplicant, this driver_ops function does not need to be
2254 * implemented. Likewise, if the driver does not support WPA, this
2255 * function is not needed.
2257 int (*flush_pmkid
)(void *priv
);
2260 * get_capa - Get driver capabilities
2261 * @priv: private driver interface data
2263 * Returns: 0 on success, -1 on failure
2265 * Get driver/firmware/hardware capabilities.
2267 int (*get_capa
)(void *priv
, struct wpa_driver_capa
*capa
);
2270 * poll - Poll driver for association information
2271 * @priv: private driver interface data
2273 * This is an option callback that can be used when the driver does not
2274 * provide event mechanism for association events. This is called when
2275 * receiving WPA EAPOL-Key messages that require association
2276 * information. The driver interface is supposed to generate associnfo
2277 * event before returning from this callback function. In addition, the
2278 * driver interface should generate an association event after having
2279 * sent out associnfo.
2281 void (*poll
)(void *priv
);
2284 * get_ifindex - Get interface index
2285 * @priv: private driver interface data
2287 * Returns: Interface index
2289 unsigned int (*get_ifindex
)(void *priv
);
2292 * get_ifname - Get interface name
2293 * @priv: private driver interface data
2295 * Returns: Pointer to the interface name. This can differ from the
2296 * interface name used in init() call. Init() is called first.
2298 * This optional function can be used to allow the driver interface to
2299 * replace the interface name with something else, e.g., based on an
2300 * interface mapping from a more descriptive name.
2302 const char * (*get_ifname
)(void *priv
);
2305 * get_mac_addr - Get own MAC address
2306 * @priv: private driver interface data
2308 * Returns: Pointer to own MAC address or %NULL on failure
2310 * This optional function can be used to get the own MAC address of the
2311 * device from the driver interface code. This is only needed if the
2312 * l2_packet implementation for the OS does not provide easy access to
2314 const u8
* (*get_mac_addr
)(void *priv
);
2317 * set_operstate - Sets device operating state to DORMANT or UP
2318 * @priv: private driver interface data
2319 * @state: 0 = dormant, 1 = up
2320 * Returns: 0 on success, -1 on failure
2322 * This is an optional function that can be used on operating systems
2323 * that support a concept of controlling network device state from user
2324 * space applications. This function, if set, gets called with
2325 * state = 1 when authentication has been completed and with state = 0
2326 * when connection is lost.
2328 int (*set_operstate
)(void *priv
, int state
);
2331 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2332 * @priv: Private driver interface data
2333 * @addr: Address of the station for which to set protection (may be
2334 * %NULL for group keys)
2335 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2336 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2337 * Returns: 0 on success, -1 on failure
2339 * This is an optional function that can be used to set the driver to
2340 * require protection for Tx and/or Rx frames. This uses the layer
2341 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2342 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2343 * set protection operation; instead, they set protection implicitly
2344 * based on configured keys.
2346 int (*mlme_setprotection
)(void *priv
, const u8
*addr
, int protect_type
,
2350 * get_hw_feature_data - Get hardware support data (channels and rates)
2351 * @priv: Private driver interface data
2352 * @num_modes: Variable for returning the number of returned modes
2353 * flags: Variable for returning hardware feature flags
2354 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
2355 * Returns: Pointer to allocated hardware data on success or %NULL on
2356 * failure. Caller is responsible for freeing this.
2358 struct hostapd_hw_modes
* (*get_hw_feature_data
)(void *priv
,
2360 u16
*flags
, u8
*dfs
);
2363 * send_mlme - Send management frame from MLME
2364 * @priv: Private driver interface data
2365 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2366 * @data_len: Size of the management frame
2367 * @noack: Do not wait for this frame to be acked (disable retries)
2368 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2370 * @csa_offs: Array of CSA offsets or %NULL
2371 * @csa_offs_len: Number of elements in csa_offs
2372 * Returns: 0 on success, -1 on failure
2374 int (*send_mlme
)(void *priv
, const u8
*data
, size_t data_len
,
2375 int noack
, unsigned int freq
, const u16
*csa_offs
,
2376 size_t csa_offs_len
);
2379 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2380 * @priv: Private driver interface data
2381 * @md: Mobility domain (2 octets) (also included inside ies)
2382 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2383 * @ies_len: Length of FT IEs in bytes
2384 * Returns: 0 on success, -1 on failure
2386 * The supplicant uses this callback to let the driver know that keying
2387 * material for FT is available and that the driver can use the
2388 * provided IEs in the next message in FT authentication sequence.
2390 * This function is only needed for driver that support IEEE 802.11r
2391 * (Fast BSS Transition).
2393 int (*update_ft_ies
)(void *priv
, const u8
*md
, const u8
*ies
,
2397 * get_scan_results2 - Fetch the latest scan results
2398 * @priv: private driver interface data
2400 * Returns: Allocated buffer of scan results (caller is responsible for
2401 * freeing the data structure) on success, NULL on failure
2403 struct wpa_scan_results
* (*get_scan_results2
)(void *priv
);
2406 * set_country - Set country
2407 * @priv: Private driver interface data
2408 * @alpha2: country to which to switch to
2409 * Returns: 0 on success, -1 on failure
2411 * This function is for drivers which support some form
2412 * of setting a regulatory domain.
2414 int (*set_country
)(void *priv
, const char *alpha2
);
2417 * get_country - Get country
2418 * @priv: Private driver interface data
2419 * @alpha2: Buffer for returning country code (at least 3 octets)
2420 * Returns: 0 on success, -1 on failure
2422 int (*get_country
)(void *priv
, char *alpha2
);
2425 * global_init - Global driver initialization
2426 * @ctx: wpa_global pointer
2427 * Returns: Pointer to private data (global), %NULL on failure
2429 * This optional function is called to initialize the driver wrapper
2430 * for global data, i.e., data that applies to all interfaces. If this
2431 * function is implemented, global_deinit() will also need to be
2432 * implemented to free the private data. The driver will also likely
2433 * use init2() function instead of init() to get the pointer to global
2434 * data available to per-interface initializer.
2436 void * (*global_init
)(void *ctx
);
2439 * global_deinit - Global driver deinitialization
2440 * @priv: private driver global data from global_init()
2442 * Terminate any global driver related functionality and free the
2443 * global data structure.
2445 void (*global_deinit
)(void *priv
);
2448 * init2 - Initialize driver interface (with global data)
2449 * @ctx: context to be used when calling wpa_supplicant functions,
2450 * e.g., wpa_supplicant_event()
2451 * @ifname: interface name, e.g., wlan0
2452 * @global_priv: private driver global data from global_init()
2453 * Returns: Pointer to private data, %NULL on failure
2455 * This function can be used instead of init() if the driver wrapper
2458 void * (*init2
)(void *ctx
, const char *ifname
, void *global_priv
);
2461 * get_interfaces - Get information about available interfaces
2462 * @global_priv: private driver global data from global_init()
2463 * Returns: Allocated buffer of interface information (caller is
2464 * responsible for freeing the data structure) on success, NULL on
2467 struct wpa_interface_info
* (*get_interfaces
)(void *global_priv
);
2470 * scan2 - Request the driver to initiate scan
2471 * @priv: private driver interface data
2472 * @params: Scan parameters
2474 * Returns: 0 on success, -1 on failure
2476 * Once the scan results are ready, the driver should report scan
2477 * results event for wpa_supplicant which will eventually request the
2478 * results with wpa_driver_get_scan_results2().
2480 int (*scan2
)(void *priv
, struct wpa_driver_scan_params
*params
);
2483 * authenticate - Request driver to authenticate
2484 * @priv: private driver interface data
2485 * @params: authentication parameters
2486 * Returns: 0 on success, -1 on failure
2488 * This is an optional function that can be used with drivers that
2489 * support separate authentication and association steps, i.e., when
2490 * wpa_supplicant can act as the SME. If not implemented, associate()
2491 * function is expected to take care of IEEE 802.11 authentication,
2494 int (*authenticate
)(void *priv
,
2495 struct wpa_driver_auth_params
*params
);
2498 * set_ap - Set Beacon and Probe Response information for AP mode
2499 * @priv: Private driver interface data
2500 * @params: Parameters to use in AP mode
2502 * This function is used to configure Beacon template and/or extra IEs
2503 * to add for Beacon and Probe Response frames for the driver in
2504 * AP mode. The driver is responsible for building the full Beacon
2505 * frame by concatenating the head part with TIM IE generated by the
2506 * driver/firmware and finishing with the tail part. Depending on the
2507 * driver architectue, this can be done either by using the full
2508 * template or the set of additional IEs (e.g., WPS and P2P IE).
2509 * Similarly, Probe Response processing depends on the driver design.
2510 * If the driver (or firmware) takes care of replying to Probe Request
2511 * frames, the extra IEs provided here needs to be added to the Probe
2514 * Returns: 0 on success, -1 on failure
2516 int (*set_ap
)(void *priv
, struct wpa_driver_ap_params
*params
);
2519 * set_acl - Set ACL in AP mode
2520 * @priv: Private driver interface data
2521 * @params: Parameters to configure ACL
2522 * Returns: 0 on success, -1 on failure
2524 * This is used only for the drivers which support MAC address ACL.
2526 int (*set_acl
)(void *priv
, struct hostapd_acl_params
*params
);
2529 * hapd_init - Initialize driver interface (hostapd only)
2530 * @hapd: Pointer to hostapd context
2531 * @params: Configuration for the driver wrapper
2532 * Returns: Pointer to private data, %NULL on failure
2534 * This function is used instead of init() or init2() when the driver
2535 * wrapper is used with hostapd.
2537 void * (*hapd_init
)(struct hostapd_data
*hapd
,
2538 struct wpa_init_params
*params
);
2541 * hapd_deinit - Deinitialize driver interface (hostapd only)
2542 * @priv: Private driver interface data from hapd_init()
2544 void (*hapd_deinit
)(void *priv
);
2547 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2548 * @priv: Private driver interface data
2549 * @params: BSS parameters
2550 * Returns: 0 on success, -1 on failure
2552 * This is an optional function to configure the kernel driver to
2553 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2554 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2555 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2556 * for Beacon frames.
2558 * DEPRECATED - use set_ap() instead
2560 int (*set_ieee8021x
)(void *priv
, struct wpa_bss_params
*params
);
2563 * set_privacy - Enable/disable privacy (AP only)
2564 * @priv: Private driver interface data
2565 * @enabled: 1 = privacy enabled, 0 = disabled
2566 * Returns: 0 on success, -1 on failure
2568 * This is an optional function to configure privacy field in the
2569 * kernel driver for Beacon frames. This can be left undefined (set to
2570 * %NULL) if the driver uses the Beacon template from set_ap().
2572 * DEPRECATED - use set_ap() instead
2574 int (*set_privacy
)(void *priv
, int enabled
);
2577 * get_seqnum - Fetch the current TSC/packet number (AP only)
2578 * @ifname: The interface name (main or virtual)
2579 * @priv: Private driver interface data
2580 * @addr: MAC address of the station or %NULL for group keys
2582 * @seq: Buffer for returning the latest used TSC/packet number
2583 * Returns: 0 on success, -1 on failure
2585 * This function is used to fetch the last used TSC/packet number for
2586 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2587 * keys, so there is no strict requirement on implementing support for
2588 * unicast keys (i.e., addr != %NULL).
2590 int (*get_seqnum
)(const char *ifname
, void *priv
, const u8
*addr
,
2594 * flush - Flush all association stations (AP only)
2595 * @priv: Private driver interface data
2596 * Returns: 0 on success, -1 on failure
2598 * This function requests the driver to disassociate all associated
2599 * stations. This function does not need to be implemented if the
2600 * driver does not process association frames internally.
2602 int (*flush
)(void *priv
);
2605 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2606 * @priv: Private driver interface data
2607 * @elem: Information elements
2608 * @elem_len: Length of the elem buffer in octets
2609 * Returns: 0 on success, -1 on failure
2611 * This is an optional function to add information elements in the
2612 * kernel driver for Beacon and Probe Response frames. This can be left
2613 * undefined (set to %NULL) if the driver uses the Beacon template from
2616 * DEPRECATED - use set_ap() instead
2618 int (*set_generic_elem
)(void *priv
, const u8
*elem
, size_t elem_len
);
2621 * read_sta_data - Fetch station data
2622 * @priv: Private driver interface data
2623 * @data: Buffer for returning station information
2624 * @addr: MAC address of the station
2625 * Returns: 0 on success, -1 on failure
2627 int (*read_sta_data
)(void *priv
, struct hostap_sta_driver_data
*data
,
2631 * hapd_send_eapol - Send an EAPOL packet (AP only)
2632 * @priv: private driver interface data
2633 * @addr: Destination MAC address
2634 * @data: EAPOL packet starting with IEEE 802.1X header
2635 * @data_len: Length of the EAPOL packet in octets
2636 * @encrypt: Whether the frame should be encrypted
2637 * @own_addr: Source MAC address
2638 * @flags: WPA_STA_* flags for the destination station
2640 * Returns: 0 on success, -1 on failure
2642 int (*hapd_send_eapol
)(void *priv
, const u8
*addr
, const u8
*data
,
2643 size_t data_len
, int encrypt
,
2644 const u8
*own_addr
, u32 flags
);
2647 * sta_deauth - Deauthenticate a station (AP only)
2648 * @priv: Private driver interface data
2649 * @own_addr: Source address and BSSID for the Deauthentication frame
2650 * @addr: MAC address of the station to deauthenticate
2651 * @reason: Reason code for the Deauthentiation frame
2652 * Returns: 0 on success, -1 on failure
2654 * This function requests a specific station to be deauthenticated and
2655 * a Deauthentication frame to be sent to it.
2657 int (*sta_deauth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2661 * sta_disassoc - Disassociate a station (AP only)
2662 * @priv: Private driver interface data
2663 * @own_addr: Source address and BSSID for the Disassociation frame
2664 * @addr: MAC address of the station to disassociate
2665 * @reason: Reason code for the Disassociation frame
2666 * Returns: 0 on success, -1 on failure
2668 * This function requests a specific station to be disassociated and
2669 * a Disassociation frame to be sent to it.
2671 int (*sta_disassoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2675 * sta_remove - Remove a station entry (AP only)
2676 * @priv: Private driver interface data
2677 * @addr: MAC address of the station to be removed
2678 * Returns: 0 on success, -1 on failure
2680 int (*sta_remove
)(void *priv
, const u8
*addr
);
2683 * hapd_get_ssid - Get the current SSID (AP only)
2684 * @priv: Private driver interface data
2685 * @buf: Buffer for returning the SSID
2686 * @len: Maximum length of the buffer
2687 * Returns: Length of the SSID on success, -1 on failure
2689 * This function need not be implemented if the driver uses Beacon
2690 * template from set_ap() and does not reply to Probe Request frames.
2692 int (*hapd_get_ssid
)(void *priv
, u8
*buf
, int len
);
2695 * hapd_set_ssid - Set SSID (AP only)
2696 * @priv: Private driver interface data
2698 * @len: Length of the SSID in octets
2699 * Returns: 0 on success, -1 on failure
2701 * DEPRECATED - use set_ap() instead
2703 int (*hapd_set_ssid
)(void *priv
, const u8
*buf
, int len
);
2706 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2707 * @priv: Private driver interface data
2708 * @enabled: 1 = countermeasures enabled, 0 = disabled
2709 * Returns: 0 on success, -1 on failure
2711 * This need not be implemented if the driver does not take care of
2712 * association processing.
2714 int (*hapd_set_countermeasures
)(void *priv
, int enabled
);
2717 * sta_add - Add a station entry
2718 * @priv: Private driver interface data
2719 * @params: Station parameters
2720 * Returns: 0 on success, -1 on failure
2722 * This function is used to add or set (params->set 1) a station
2723 * entry in the driver. Adding STA entries is used only if the driver
2724 * does not take care of association processing.
2726 * With drivers that don't support full AP client state, this function
2727 * is used to add a station entry to the driver once the station has
2728 * completed association.
2730 * With TDLS, this function is used to add or set (params->set 1)
2731 * TDLS peer entries (even with drivers that do not support full AP
2734 int (*sta_add
)(void *priv
, struct hostapd_sta_add_params
*params
);
2737 * get_inact_sec - Get station inactivity duration (AP only)
2738 * @priv: Private driver interface data
2739 * @addr: Station address
2740 * Returns: Number of seconds station has been inactive, -1 on failure
2742 int (*get_inact_sec
)(void *priv
, const u8
*addr
);
2745 * sta_clear_stats - Clear station statistics (AP only)
2746 * @priv: Private driver interface data
2747 * @addr: Station address
2748 * Returns: 0 on success, -1 on failure
2750 int (*sta_clear_stats
)(void *priv
, const u8
*addr
);
2753 * set_freq - Set channel/frequency (AP only)
2754 * @priv: Private driver interface data
2755 * @freq: Channel parameters
2756 * Returns: 0 on success, -1 on failure
2758 int (*set_freq
)(void *priv
, struct hostapd_freq_params
*freq
);
2761 * set_rts - Set RTS threshold
2762 * @priv: Private driver interface data
2763 * @rts: RTS threshold in octets
2764 * Returns: 0 on success, -1 on failure
2766 int (*set_rts
)(void *priv
, int rts
);
2769 * set_frag - Set fragmentation threshold
2770 * @priv: Private driver interface data
2771 * @frag: Fragmentation threshold in octets
2772 * Returns: 0 on success, -1 on failure
2774 int (*set_frag
)(void *priv
, int frag
);
2777 * sta_set_flags - Set station flags (AP only)
2778 * @priv: Private driver interface data
2779 * @addr: Station address
2780 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2781 * @flags_or: Bitmap of WPA_STA_* flags to add
2782 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2783 * Returns: 0 on success, -1 on failure
2785 int (*sta_set_flags
)(void *priv
, const u8
*addr
,
2786 unsigned int total_flags
, unsigned int flags_or
,
2787 unsigned int flags_and
);
2790 * set_tx_queue_params - Set TX queue parameters
2791 * @priv: Private driver interface data
2792 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2796 * @burst_time: Maximum length for bursting in 0.1 msec units
2798 int (*set_tx_queue_params
)(void *priv
, int queue
, int aifs
, int cw_min
,
2799 int cw_max
, int burst_time
);
2802 * if_add - Add a virtual interface
2803 * @priv: Private driver interface data
2804 * @type: Interface type
2805 * @ifname: Interface name for the new virtual interface
2806 * @addr: Local address to use for the interface or %NULL to use the
2807 * parent interface address
2808 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2809 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2810 * not allowed (applies only to %WPA_IF_AP_BSS type)
2811 * @force_ifname: Buffer for returning an interface name that the
2812 * driver ended up using if it differs from the requested ifname
2813 * @if_addr: Buffer for returning the allocated interface address
2814 * (this may differ from the requested addr if the driver cannot
2815 * change interface address)
2816 * @bridge: Bridge interface to use or %NULL if no bridge configured
2817 * @use_existing: Whether to allow existing interface to be used
2818 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
2819 * Returns: 0 on success, -1 on failure
2821 int (*if_add
)(void *priv
, enum wpa_driver_if_type type
,
2822 const char *ifname
, const u8
*addr
, void *bss_ctx
,
2823 void **drv_priv
, char *force_ifname
, u8
*if_addr
,
2824 const char *bridge
, int use_existing
, int setup_ap
);
2827 * if_remove - Remove a virtual interface
2828 * @priv: Private driver interface data
2829 * @type: Interface type
2830 * @ifname: Interface name of the virtual interface to be removed
2831 * Returns: 0 on success, -1 on failure
2833 int (*if_remove
)(void *priv
, enum wpa_driver_if_type type
,
2834 const char *ifname
);
2837 * set_sta_vlan - Bind a station into a specific interface (AP only)
2838 * @priv: Private driver interface data
2839 * @ifname: Interface (main or virtual BSS or VLAN)
2840 * @addr: MAC address of the associated station
2842 * Returns: 0 on success, -1 on failure
2844 * This function is used to bind a station to a specific virtual
2845 * interface. It is only used if when virtual interfaces are supported,
2846 * e.g., to assign stations to different VLAN interfaces based on
2847 * information from a RADIUS server. This allows separate broadcast
2848 * domains to be used with a single BSS.
2850 int (*set_sta_vlan
)(void *priv
, const u8
*addr
, const char *ifname
,
2854 * commit - Optional commit changes handler (AP only)
2855 * @priv: driver private data
2856 * Returns: 0 on success, -1 on failure
2858 * This optional handler function can be registered if the driver
2859 * interface implementation needs to commit changes (e.g., by setting
2860 * network interface up) at the end of initial configuration. If set,
2861 * this handler will be called after initial setup has been completed.
2863 int (*commit
)(void *priv
);
2866 * send_ether - Send an ethernet packet (AP only)
2867 * @priv: private driver interface data
2868 * @dst: Destination MAC address
2869 * @src: Source MAC address
2871 * @data: EAPOL packet starting with IEEE 802.1X header
2872 * @data_len: Length of the EAPOL packet in octets
2873 * Returns: 0 on success, -1 on failure
2875 int (*send_ether
)(void *priv
, const u8
*dst
, const u8
*src
, u16 proto
,
2876 const u8
*data
, size_t data_len
);
2879 * set_radius_acl_auth - Notification of RADIUS ACL change
2880 * @priv: Private driver interface data
2881 * @mac: MAC address of the station
2882 * @accepted: Whether the station was accepted
2883 * @session_timeout: Session timeout for the station
2884 * Returns: 0 on success, -1 on failure
2886 int (*set_radius_acl_auth
)(void *priv
, const u8
*mac
, int accepted
,
2887 u32 session_timeout
);
2890 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2891 * @priv: Private driver interface data
2892 * @mac: MAC address of the station
2893 * Returns: 0 on success, -1 on failure
2895 int (*set_radius_acl_expire
)(void *priv
, const u8
*mac
);
2898 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2899 * @priv: Private driver interface data
2900 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2901 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2903 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2904 * to remove extra IE(s)
2905 * Returns: 0 on success, -1 on failure
2907 * This is an optional function to add WPS IE in the kernel driver for
2908 * Beacon and Probe Response frames. This can be left undefined (set
2909 * to %NULL) if the driver uses the Beacon template from set_ap()
2910 * and does not process Probe Request frames. If the driver takes care
2911 * of (Re)Association frame processing, the assocresp buffer includes
2912 * WPS IE(s) that need to be added to (Re)Association Response frames
2913 * whenever a (Re)Association Request frame indicated use of WPS.
2915 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2916 * frames when operating as a GO. The driver is responsible for adding
2917 * timing related attributes (e.g., NoA) in addition to the IEs
2918 * included here by appending them after these buffers. This call is
2919 * also used to provide Probe Response IEs for P2P Listen state
2920 * operations for drivers that generate the Probe Response frames
2923 * DEPRECATED - use set_ap() instead
2925 int (*set_ap_wps_ie
)(void *priv
, const struct wpabuf
*beacon
,
2926 const struct wpabuf
*proberesp
,
2927 const struct wpabuf
*assocresp
);
2930 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2931 * @priv: Private driver interface data
2932 * @authorized: Whether the port is authorized
2933 * Returns: 0 on success, -1 on failure
2935 int (*set_supp_port
)(void *priv
, int authorized
);
2938 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2939 * @priv: Private driver interface data
2940 * @addr: MAC address of the associated station
2941 * @aid: Association ID
2942 * @val: 1 = bind to 4-address WDS; 0 = unbind
2943 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2944 * to indicate that bridge is not to be used
2945 * @ifname_wds: Buffer to return the interface name for the new WDS
2946 * station or %NULL to indicate name is not returned.
2947 * Returns: 0 on success, -1 on failure
2949 int (*set_wds_sta
)(void *priv
, const u8
*addr
, int aid
, int val
,
2950 const char *bridge_ifname
, char *ifname_wds
);
2953 * send_action - Transmit an Action frame
2954 * @priv: Private driver interface data
2955 * @freq: Frequency (in MHz) of the channel
2956 * @wait: Time to wait off-channel for a response (in ms), or zero
2957 * @dst: Destination MAC address (Address 1)
2958 * @src: Source MAC address (Address 2)
2959 * @bssid: BSSID (Address 3)
2961 * @data_len: data length in octets
2962 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2963 * Returns: 0 on success, -1 on failure
2965 * This command can be used to request the driver to transmit an action
2966 * frame to the specified destination.
2968 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2969 * be transmitted on the given channel and the device will wait for a
2970 * response on that channel for the given wait time.
2972 * If the flag is not set, the wait time will be ignored. In this case,
2973 * if a remain-on-channel duration is in progress, the frame must be
2974 * transmitted on that channel; alternatively the frame may be sent on
2975 * the current operational channel (if in associated state in station
2976 * mode or while operating as an AP.)
2978 * If @src differs from the device MAC address, use of a random
2979 * transmitter address is requested for this message exchange.
2981 int (*send_action
)(void *priv
, unsigned int freq
, unsigned int wait
,
2982 const u8
*dst
, const u8
*src
, const u8
*bssid
,
2983 const u8
*data
, size_t data_len
, int no_cck
);
2986 * send_action_cancel_wait - Cancel action frame TX wait
2987 * @priv: Private driver interface data
2989 * This command cancels the wait time associated with sending an action
2990 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2991 * set in the driver flags.
2993 void (*send_action_cancel_wait
)(void *priv
);
2996 * remain_on_channel - Remain awake on a channel
2997 * @priv: Private driver interface data
2998 * @freq: Frequency (in MHz) of the channel
2999 * @duration: Duration in milliseconds
3000 * Returns: 0 on success, -1 on failure
3002 * This command is used to request the driver to remain awake on the
3003 * specified channel for the specified duration and report received
3004 * Action frames with EVENT_RX_MGMT events. Optionally, received
3005 * Probe Request frames may also be requested to be reported by calling
3006 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3008 * The driver may not be at the requested channel when this function
3009 * returns, i.e., the return code is only indicating whether the
3010 * request was accepted. The caller will need to wait until the
3011 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3012 * completed the channel change. This may take some time due to other
3013 * need for the radio and the caller should be prepared to timing out
3014 * its wait since there are no guarantees on when this request can be
3017 int (*remain_on_channel
)(void *priv
, unsigned int freq
,
3018 unsigned int duration
);
3021 * cancel_remain_on_channel - Cancel remain-on-channel operation
3022 * @priv: Private driver interface data
3024 * This command can be used to cancel a remain-on-channel operation
3025 * before its originally requested duration has passed. This could be
3026 * used, e.g., when remain_on_channel() is used to request extra time
3027 * to receive a response to an Action frame and the response is
3028 * received when there is still unneeded time remaining on the
3029 * remain-on-channel operation.
3031 int (*cancel_remain_on_channel
)(void *priv
);
3034 * probe_req_report - Request Probe Request frames to be indicated
3035 * @priv: Private driver interface data
3036 * @report: Whether to report received Probe Request frames
3037 * Returns: 0 on success, -1 on failure (or if not supported)
3039 * This command can be used to request the driver to indicate when
3040 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3041 * Since this operation may require extra resources, e.g., due to less
3042 * optimal hardware/firmware RX filtering, many drivers may disable
3043 * Probe Request reporting at least in station mode. This command is
3044 * used to notify the driver when the Probe Request frames need to be
3045 * reported, e.g., during remain-on-channel operations.
3047 int (*probe_req_report
)(void *priv
, int report
);
3050 * deinit_ap - Deinitialize AP mode
3051 * @priv: Private driver interface data
3052 * Returns: 0 on success, -1 on failure (or if not supported)
3054 * This optional function can be used to disable AP mode related
3055 * configuration. If the interface was not dynamically added,
3056 * change the driver mode to station mode to allow normal station
3057 * operations like scanning to be completed.
3059 int (*deinit_ap
)(void *priv
);
3062 * deinit_p2p_cli - Deinitialize P2P client mode
3063 * @priv: Private driver interface data
3064 * Returns: 0 on success, -1 on failure (or if not supported)
3066 * This optional function can be used to disable P2P client mode. If the
3067 * interface was not dynamically added, change the interface type back
3070 int (*deinit_p2p_cli
)(void *priv
);
3073 * suspend - Notification on system suspend/hibernate event
3074 * @priv: Private driver interface data
3076 void (*suspend
)(void *priv
);
3079 * resume - Notification on system resume/thaw event
3080 * @priv: Private driver interface data
3082 void (*resume
)(void *priv
);
3085 * signal_monitor - Set signal monitoring parameters
3086 * @priv: Private driver interface data
3087 * @threshold: Threshold value for signal change events; 0 = disabled
3088 * @hysteresis: Minimum change in signal strength before indicating a
3090 * Returns: 0 on success, -1 on failure (or if not supported)
3092 * This function can be used to configure monitoring of signal strength
3093 * with the current AP. Whenever signal strength drops below the
3094 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3095 * should be generated assuming the signal strength has changed at
3096 * least %hysteresis from the previously indicated signal change event.
3098 int (*signal_monitor
)(void *priv
, int threshold
, int hysteresis
);
3101 * send_frame - Send IEEE 802.11 frame (testing use only)
3102 * @priv: Private driver interface data
3103 * @data: IEEE 802.11 frame with IEEE 802.11 header
3104 * @data_len: Size of the frame
3105 * @encrypt: Whether to encrypt the frame (if keys are set)
3106 * Returns: 0 on success, -1 on failure
3108 * This function is only used for debugging purposes and is not
3109 * required to be implemented for normal operations.
3111 int (*send_frame
)(void *priv
, const u8
*data
, size_t data_len
,
3115 * get_noa - Get current Notice of Absence attribute payload
3116 * @priv: Private driver interface data
3117 * @buf: Buffer for returning NoA
3118 * @buf_len: Buffer length in octets
3119 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3120 * advertized, or -1 on failure
3122 * This function is used to fetch the current Notice of Absence
3123 * attribute value from GO.
3125 int (*get_noa
)(void *priv
, u8
*buf
, size_t buf_len
);
3128 * set_noa - Set Notice of Absence parameters for GO (testing)
3129 * @priv: Private driver interface data
3131 * @start: Start time in ms from next TBTT
3132 * @duration: Duration in ms
3133 * Returns: 0 on success or -1 on failure
3135 * This function is used to set Notice of Absence parameters for GO. It
3136 * is used only for testing. To disable NoA, all parameters are set to
3139 int (*set_noa
)(void *priv
, u8 count
, int start
, int duration
);
3142 * set_p2p_powersave - Set P2P power save options
3143 * @priv: Private driver interface data
3144 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3145 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3146 * @ctwindow: 0.. = change (msec), -1 = no change
3147 * Returns: 0 on success or -1 on failure
3149 int (*set_p2p_powersave
)(void *priv
, int legacy_ps
, int opp_ps
,
3153 * ampdu - Enable/disable aggregation
3154 * @priv: Private driver interface data
3155 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3156 * Returns: 0 on success or -1 on failure
3158 int (*ampdu
)(void *priv
, int ampdu
);
3161 * get_radio_name - Get physical radio name for the device
3162 * @priv: Private driver interface data
3163 * Returns: Radio name or %NULL if not known
3165 * The returned data must not be modified by the caller. It is assumed
3166 * that any interface that has the same radio name as another is
3167 * sharing the same physical radio. This information can be used to
3168 * share scan results etc. information between the virtual interfaces
3169 * to speed up various operations.
3171 const char * (*get_radio_name
)(void *priv
);
3174 * send_tdls_mgmt - for sending TDLS management packets
3175 * @priv: private driver interface data
3176 * @dst: Destination (peer) MAC address
3177 * @action_code: TDLS action code for the mssage
3178 * @dialog_token: Dialog Token to use in the message (if needed)
3179 * @status_code: Status Code or Reason Code to use (if needed)
3180 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
3181 * @initiator: Is the current end the TDLS link initiator
3182 * @buf: TDLS IEs to add to the message
3183 * @len: Length of buf in octets
3184 * Returns: 0 on success, negative (<0) on failure
3186 * This optional function can be used to send packet to driver which is
3187 * responsible for receiving and sending all TDLS packets.
3189 int (*send_tdls_mgmt
)(void *priv
, const u8
*dst
, u8 action_code
,
3190 u8 dialog_token
, u16 status_code
, u32 peer_capab
,
3191 int initiator
, const u8
*buf
, size_t len
);
3194 * tdls_oper - Ask the driver to perform high-level TDLS operations
3195 * @priv: Private driver interface data
3196 * @oper: TDLS high-level operation. See %enum tdls_oper
3197 * @peer: Destination (peer) MAC address
3198 * Returns: 0 on success, negative (<0) on failure
3200 * This optional function can be used to send high-level TDLS commands
3203 int (*tdls_oper
)(void *priv
, enum tdls_oper oper
, const u8
*peer
);
3206 * wnm_oper - Notify driver of the WNM frame reception
3207 * @priv: Private driver interface data
3208 * @oper: WNM operation. See %enum wnm_oper
3209 * @peer: Destination (peer) MAC address
3210 * @buf: Buffer for the driver to fill in (for getting IE)
3211 * @buf_len: Return the len of buf
3212 * Returns: 0 on success, negative (<0) on failure
3214 int (*wnm_oper
)(void *priv
, enum wnm_oper oper
, const u8
*peer
,
3215 u8
*buf
, u16
*buf_len
);
3218 * set_qos_map - Set QoS Map
3219 * @priv: Private driver interface data
3220 * @qos_map_set: QoS Map
3221 * @qos_map_set_len: Length of QoS Map
3223 int (*set_qos_map
)(void *priv
, const u8
*qos_map_set
,
3224 u8 qos_map_set_len
);
3227 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3228 * @priv: Private driver interface data
3229 * @version: IP version of the IP address, 4 or 6
3230 * @ipaddr: IP address for the neigh entry
3231 * @prefixlen: IP address prefix length
3232 * @addr: Corresponding MAC address
3233 * Returns: 0 on success, negative (<0) on failure
3235 int (*br_add_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
,
3236 int prefixlen
, const u8
*addr
);
3239 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3240 * @priv: Private driver interface data
3241 * @version: IP version of the IP address, 4 or 6
3242 * @ipaddr: IP address for the neigh entry
3243 * Returns: 0 on success, negative (<0) on failure
3245 int (*br_delete_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
);
3248 * br_port_set_attr - Set a bridge port attribute
3249 * @attr: Bridge port attribute to set
3250 * @val: Value to be set
3251 * Returns: 0 on success, negative (<0) on failure
3253 int (*br_port_set_attr
)(void *priv
, enum drv_br_port_attr attr
,
3257 * br_port_set_attr - Set a bridge network parameter
3258 * @param: Bridge parameter to set
3259 * @val: Value to be set
3260 * Returns: 0 on success, negative (<0) on failure
3262 int (*br_set_net_param
)(void *priv
, enum drv_br_net_param param
,
3266 * set_wowlan - Set wake-on-wireless triggers
3267 * @priv: Private driver interface data
3268 * @triggers: wowlan triggers
3270 int (*set_wowlan
)(void *priv
, const struct wowlan_triggers
*triggers
);
3273 * signal_poll - Get current connection information
3274 * @priv: Private driver interface data
3275 * @signal_info: Connection info structure
3277 int (*signal_poll
)(void *priv
, struct wpa_signal_info
*signal_info
);
3280 * set_authmode - Set authentication algorithm(s) for static WEP
3281 * @priv: Private driver interface data
3282 * @authmode: 1=Open System, 2=Shared Key, 3=both
3283 * Returns: 0 on success, -1 on failure
3285 * This function can be used to set authentication algorithms for AP
3286 * mode when static WEP is used. If the driver uses user space MLME/SME
3287 * implementation, there is no need to implement this function.
3289 * DEPRECATED - use set_ap() instead
3291 int (*set_authmode
)(void *priv
, int authmode
);
3295 * driver_cmd - Execute driver-specific command
3296 * @priv: Private driver interface data
3297 * @cmd: Command to execute
3298 * @buf: Return buffer
3299 * @buf_len: Buffer length
3300 * Returns: 0 on success, -1 on failure
3302 int (*driver_cmd
)(void *priv
, char *cmd
, char *buf
, size_t buf_len
);
3303 #endif /* ANDROID */
3306 * vendor_cmd - Execute vendor specific command
3307 * @priv: Private driver interface data
3308 * @vendor_id: Vendor id
3309 * @subcmd: Vendor command id
3310 * @data: Vendor command parameters (%NULL if no parameters)
3311 * @data_len: Data length
3312 * @buf: Return buffer (%NULL to ignore reply)
3313 * Returns: 0 on success, negative (<0) on failure
3315 * This function handles vendor specific commands that are passed to
3316 * the driver/device. The command is identified by vendor id and
3317 * command id. Parameters can be passed as argument to the command
3318 * in the data buffer. Reply (if any) will be filled in the supplied
3321 * The exact driver behavior is driver interface and vendor specific. As
3322 * an example, this will be converted to a vendor specific cfg80211
3323 * command in case of the nl80211 driver interface.
3325 int (*vendor_cmd
)(void *priv
, unsigned int vendor_id
,
3326 unsigned int subcmd
, const u8
*data
, size_t data_len
,
3327 struct wpabuf
*buf
);
3330 * set_rekey_info - Set rekey information
3331 * @priv: Private driver interface data
3333 * @kek_len: KEK length in octets
3335 * @kck_len: KCK length in octets
3336 * @replay_ctr: Current EAPOL-Key Replay Counter
3338 * This optional function can be used to provide information for the
3339 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3340 * while the host (including wpa_supplicant) is sleeping.
3342 void (*set_rekey_info
)(void *priv
, const u8
*kek
, size_t kek_len
,
3343 const u8
*kck
, size_t kck_len
,
3344 const u8
*replay_ctr
);
3347 * sta_assoc - Station association indication
3348 * @priv: Private driver interface data
3349 * @own_addr: Source address and BSSID for association frame
3350 * @addr: MAC address of the station to associate
3351 * @reassoc: flag to indicate re-association
3352 * @status: association response status code
3353 * @ie: assoc response ie buffer
3354 * @len: ie buffer length
3355 * Returns: 0 on success, -1 on failure
3357 * This function indicates the driver to send (Re)Association
3358 * Response frame to the station.
3360 int (*sta_assoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
3361 int reassoc
, u16 status
, const u8
*ie
, size_t len
);
3364 * sta_auth - Station authentication indication
3365 * @priv: private driver interface data
3366 * @params: Station authentication parameters
3368 * Returns: 0 on success, -1 on failure
3370 int (*sta_auth
)(void *priv
,
3371 struct wpa_driver_sta_auth_params
*params
);
3374 * add_tspec - Add traffic stream
3375 * @priv: Private driver interface data
3376 * @addr: MAC address of the station to associate
3377 * @tspec_ie: tspec ie buffer
3378 * @tspec_ielen: tspec ie length
3379 * Returns: 0 on success, -1 on failure
3381 * This function adds the traffic steam for the station
3382 * and fills the medium_time in tspec_ie.
3384 int (*add_tspec
)(void *priv
, const u8
*addr
, u8
*tspec_ie
,
3385 size_t tspec_ielen
);
3388 * add_sta_node - Add a station node in the driver
3389 * @priv: Private driver interface data
3390 * @addr: MAC address of the station to add
3391 * @auth_alg: authentication algorithm used by the station
3392 * Returns: 0 on success, -1 on failure
3394 * This function adds the station node in the driver, when
3395 * the station gets added by FT-over-DS.
3397 int (*add_sta_node
)(void *priv
, const u8
*addr
, u16 auth_alg
);
3400 * sched_scan - Request the driver to initiate scheduled scan
3401 * @priv: Private driver interface data
3402 * @params: Scan parameters
3403 * Returns: 0 on success, -1 on failure
3405 * This operation should be used for scheduled scan offload to
3406 * the hardware. Every time scan results are available, the
3407 * driver should report scan results event for wpa_supplicant
3408 * which will eventually request the results with
3409 * wpa_driver_get_scan_results2(). This operation is optional
3410 * and if not provided or if it returns -1, we fall back to
3411 * normal host-scheduled scans.
3413 int (*sched_scan
)(void *priv
, struct wpa_driver_scan_params
*params
);
3416 * stop_sched_scan - Request the driver to stop a scheduled scan
3417 * @priv: Private driver interface data
3418 * Returns: 0 on success, -1 on failure
3420 * This should cause the scheduled scan to be stopped and
3421 * results should stop being sent. Must be supported if
3422 * sched_scan is supported.
3424 int (*stop_sched_scan
)(void *priv
);
3427 * poll_client - Probe (null data or such) the given station
3428 * @priv: Private driver interface data
3429 * @own_addr: MAC address of sending interface
3430 * @addr: MAC address of the station to probe
3431 * @qos: Indicates whether station is QoS station
3433 * This function is used to verify whether an associated station is
3434 * still present. This function does not need to be implemented if the
3435 * driver provides such inactivity polling mechanism.
3437 void (*poll_client
)(void *priv
, const u8
*own_addr
,
3438 const u8
*addr
, int qos
);
3441 * radio_disable - Disable/enable radio
3442 * @priv: Private driver interface data
3443 * @disabled: 1=disable 0=enable radio
3444 * Returns: 0 on success, -1 on failure
3446 * This optional command is for testing purposes. It can be used to
3447 * disable the radio on a testbed device to simulate out-of-radio-range
3450 int (*radio_disable
)(void *priv
, int disabled
);
3453 * switch_channel - Announce channel switch and migrate the GO to the
3455 * @priv: Private driver interface data
3456 * @settings: Settings for CSA period and new channel
3457 * Returns: 0 on success, -1 on failure
3459 * This function is used to move the GO to the legacy STA channel to
3460 * avoid frequency conflict in single channel concurrency.
3462 int (*switch_channel
)(void *priv
, struct csa_settings
*settings
);
3465 * add_tx_ts - Add traffic stream
3466 * @priv: Private driver interface data
3467 * @tsid: Traffic stream ID
3468 * @addr: Receiver address
3469 * @user_prio: User priority of the traffic stream
3470 * @admitted_time: Admitted time for this TS in units of
3471 * 32 microsecond periods (per second).
3472 * Returns: 0 on success, -1 on failure
3474 int (*add_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
, u8 user_prio
,
3478 * del_tx_ts - Delete traffic stream
3479 * @priv: Private driver interface data
3480 * @tsid: Traffic stream ID
3481 * @addr: Receiver address
3482 * Returns: 0 on success, -1 on failure
3484 int (*del_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
);
3487 * Enable channel-switching with TDLS peer
3488 * @priv: Private driver interface data
3489 * @addr: MAC address of the TDLS peer
3490 * @oper_class: Operating class of the switch channel
3491 * @params: Channel specification
3492 * Returns: 0 on success, -1 on failure
3494 * The function indicates to driver that it can start switching to a
3495 * different channel with a specified TDLS peer. The switching is
3496 * assumed on until canceled with tdls_disable_channel_switch().
3498 int (*tdls_enable_channel_switch
)(
3499 void *priv
, const u8
*addr
, u8 oper_class
,
3500 const struct hostapd_freq_params
*params
);
3503 * Disable channel switching with TDLS peer
3504 * @priv: Private driver interface data
3505 * @addr: MAC address of the TDLS peer
3506 * Returns: 0 on success, -1 on failure
3508 * This function indicates to the driver that it should stop switching
3509 * with a given TDLS peer.
3511 int (*tdls_disable_channel_switch
)(void *priv
, const u8
*addr
);
3514 * start_dfs_cac - Listen for radar interference on the channel
3515 * @priv: Private driver interface data
3516 * @freq: Channel parameters
3517 * Returns: 0 on success, -1 on failure
3519 int (*start_dfs_cac
)(void *priv
, struct hostapd_freq_params
*freq
);
3522 * stop_ap - Removes beacon from AP
3523 * @priv: Private driver interface data
3524 * Returns: 0 on success, -1 on failure (or if not supported)
3526 * This optional function can be used to disable AP mode related
3527 * configuration. Unlike deinit_ap, it does not change to station
3530 int (*stop_ap
)(void *priv
);
3533 * get_survey - Retrieve survey data
3534 * @priv: Private driver interface data
3535 * @freq: If set, survey data for the specified frequency is only
3536 * being requested. If not set, all survey data is requested.
3537 * Returns: 0 on success, -1 on failure
3539 * Use this to retrieve:
3541 * - the observed channel noise floor
3542 * - the amount of time we have spent on the channel
3543 * - the amount of time during which we have spent on the channel that
3544 * the radio has determined the medium is busy and we cannot
3546 * - the amount of time we have spent receiving data
3547 * - the amount of time we have spent transmitting data
3549 * This data can be used for spectrum heuristics. One example is
3550 * Automatic Channel Selection (ACS). The channel survey data is
3551 * kept on a linked list on the channel data, one entry is added
3552 * for each survey. The min_nf of the channel is updated for each
3555 int (*get_survey
)(void *priv
, unsigned int freq
);
3558 * status - Get driver interface status information
3559 * @priv: Private driver interface data
3560 * @buf: Buffer for printing tou the status information
3561 * @buflen: Maximum length of the buffer
3562 * Returns: Length of written status information or -1 on failure
3564 int (*status
)(void *priv
, char *buf
, size_t buflen
);
3567 * roaming - Set roaming policy for driver-based BSS selection
3568 * @priv: Private driver interface data
3569 * @allowed: Whether roaming within ESS is allowed
3570 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3571 * Returns: Length of written status information or -1 on failure
3573 * This optional callback can be used to update roaming policy from the
3574 * associate() command (bssid being set there indicates that the driver
3575 * should not roam before getting this roaming() call to allow roaming.
3576 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3577 * capability, roaming policy is handled within wpa_supplicant and there
3578 * is no need to implement or react to this callback.
3580 int (*roaming
)(void *priv
, int allowed
, const u8
*bssid
);
3583 * set_mac_addr - Set MAC address
3584 * @priv: Private driver interface data
3585 * @addr: MAC address to use or %NULL for setting back to permanent
3586 * Returns: 0 on success, -1 on failure
3588 int (*set_mac_addr
)(void *priv
, const u8
*addr
);
3590 #ifdef CONFIG_MACSEC
3591 int (*macsec_init
)(void *priv
, struct macsec_init_params
*params
);
3593 int (*macsec_deinit
)(void *priv
);
3596 * macsec_get_capability - Inform MKA of this driver's capability
3597 * @priv: Private driver interface data
3598 * @cap: Driver's capability
3599 * Returns: 0 on success, -1 on failure
3601 int (*macsec_get_capability
)(void *priv
, enum macsec_cap
*cap
);
3604 * enable_protect_frames - Set protect frames status
3605 * @priv: Private driver interface data
3606 * @enabled: TRUE = protect frames enabled
3607 * FALSE = protect frames disabled
3608 * Returns: 0 on success, -1 on failure (or if not supported)
3610 int (*enable_protect_frames
)(void *priv
, Boolean enabled
);
3613 * enable_encrypt - Set encryption status
3614 * @priv: Private driver interface data
3615 * @enabled: TRUE = encrypt outgoing traffic
3616 * FALSE = integrity-only protection on outgoing traffic
3617 * Returns: 0 on success, -1 on failure (or if not supported)
3619 int (*enable_encrypt
)(void *priv
, Boolean enabled
);
3622 * set_replay_protect - Set replay protect status and window size
3623 * @priv: Private driver interface data
3624 * @enabled: TRUE = replay protect enabled
3625 * FALSE = replay protect disabled
3626 * @window: replay window size, valid only when replay protect enabled
3627 * Returns: 0 on success, -1 on failure (or if not supported)
3629 int (*set_replay_protect
)(void *priv
, Boolean enabled
, u32 window
);
3632 * set_current_cipher_suite - Set current cipher suite
3633 * @priv: Private driver interface data
3634 * @cs: EUI64 identifier
3635 * Returns: 0 on success, -1 on failure (or if not supported)
3637 int (*set_current_cipher_suite
)(void *priv
, u64 cs
);
3640 * enable_controlled_port - Set controlled port status
3641 * @priv: Private driver interface data
3642 * @enabled: TRUE = controlled port enabled
3643 * FALSE = controlled port disabled
3644 * Returns: 0 on success, -1 on failure (or if not supported)
3646 int (*enable_controlled_port
)(void *priv
, Boolean enabled
);
3649 * get_receive_lowest_pn - Get receive lowest pn
3650 * @priv: Private driver interface data
3651 * @sa: secure association
3652 * Returns: 0 on success, -1 on failure (or if not supported)
3654 int (*get_receive_lowest_pn
)(void *priv
, struct receive_sa
*sa
);
3657 * get_transmit_next_pn - Get transmit next pn
3658 * @priv: Private driver interface data
3659 * @sa: secure association
3660 * Returns: 0 on success, -1 on failure (or if not supported)
3662 int (*get_transmit_next_pn
)(void *priv
, struct transmit_sa
*sa
);
3665 * set_transmit_next_pn - Set transmit next pn
3666 * @priv: Private driver interface data
3667 * @sa: secure association
3668 * Returns: 0 on success, -1 on failure (or if not supported)
3670 int (*set_transmit_next_pn
)(void *priv
, struct transmit_sa
*sa
);
3673 * create_receive_sc - create secure channel for receiving
3674 * @priv: Private driver interface data
3675 * @sc: secure channel
3676 * @conf_offset: confidentiality offset (0, 30, or 50)
3677 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3679 * Returns: 0 on success, -1 on failure (or if not supported)
3681 int (*create_receive_sc
)(void *priv
, struct receive_sc
*sc
,
3682 unsigned int conf_offset
,
3686 * delete_receive_sc - delete secure connection for receiving
3687 * @priv: private driver interface data from init()
3688 * @sc: secure channel
3689 * Returns: 0 on success, -1 on failure
3691 int (*delete_receive_sc
)(void *priv
, struct receive_sc
*sc
);
3694 * create_receive_sa - create secure association for receive
3695 * @priv: private driver interface data from init()
3696 * @sa: secure association
3697 * Returns: 0 on success, -1 on failure
3699 int (*create_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3702 * delete_receive_sa - Delete secure association for receive
3703 * @priv: Private driver interface data from init()
3704 * @sa: Secure association
3705 * Returns: 0 on success, -1 on failure
3707 int (*delete_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3710 * enable_receive_sa - enable the SA for receive
3711 * @priv: private driver interface data from init()
3712 * @sa: secure association
3713 * Returns: 0 on success, -1 on failure
3715 int (*enable_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3718 * disable_receive_sa - disable SA for receive
3719 * @priv: private driver interface data from init()
3720 * @sa: secure association
3721 * Returns: 0 on success, -1 on failure
3723 int (*disable_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3726 * create_transmit_sc - create secure connection for transmit
3727 * @priv: private driver interface data from init()
3728 * @sc: secure channel
3729 * @conf_offset: confidentiality offset (0, 30, or 50)
3730 * Returns: 0 on success, -1 on failure
3732 int (*create_transmit_sc
)(void *priv
, struct transmit_sc
*sc
,
3733 unsigned int conf_offset
);
3736 * delete_transmit_sc - delete secure connection for transmit
3737 * @priv: private driver interface data from init()
3738 * @sc: secure channel
3739 * Returns: 0 on success, -1 on failure
3741 int (*delete_transmit_sc
)(void *priv
, struct transmit_sc
*sc
);
3744 * create_transmit_sa - create secure association for transmit
3745 * @priv: private driver interface data from init()
3746 * @sa: secure association
3747 * Returns: 0 on success, -1 on failure
3749 int (*create_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
3752 * delete_transmit_sa - Delete secure association for transmit
3753 * @priv: Private driver interface data from init()
3754 * @sa: Secure association
3755 * Returns: 0 on success, -1 on failure
3757 int (*delete_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
3760 * enable_transmit_sa - enable SA for transmit
3761 * @priv: private driver interface data from init()
3762 * @sa: secure association
3763 * Returns: 0 on success, -1 on failure
3765 int (*enable_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
3768 * disable_transmit_sa - disable SA for transmit
3769 * @priv: private driver interface data from init()
3770 * @sa: secure association
3771 * Returns: 0 on success, -1 on failure
3773 int (*disable_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
3774 #endif /* CONFIG_MACSEC */
3777 * init_mesh - Driver specific initialization for mesh
3778 * @priv: Private driver interface data
3779 * Returns: 0 on success, -1 on failure
3781 int (*init_mesh
)(void *priv
);
3784 * join_mesh - Join a mesh network
3785 * @priv: Private driver interface data
3786 * @params: Mesh configuration parameters
3787 * Returns: 0 on success, -1 on failure
3789 int (*join_mesh
)(void *priv
,
3790 struct wpa_driver_mesh_join_params
*params
);
3793 * leave_mesh - Leave a mesh network
3794 * @priv: Private driver interface data
3795 * Returns 0 on success, -1 on failure
3797 int (*leave_mesh
)(void *priv
);
3800 * do_acs - Automatically select channel
3801 * @priv: Private driver interface data
3802 * @params: Parameters for ACS
3803 * Returns 0 on success, -1 on failure
3805 * This command can be used to offload ACS to the driver if the driver
3806 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3808 int (*do_acs
)(void *priv
, struct drv_acs_params
*params
);
3811 * set_band - Notify driver of band selection
3812 * @priv: Private driver interface data
3813 * @band: The selected band(s)
3814 * Returns 0 on success, -1 on failure
3816 int (*set_band
)(void *priv
, enum set_band band
);
3819 * get_pref_freq_list - Get preferred frequency list for an interface
3820 * @priv: Private driver interface data
3821 * @if_type: Interface type
3822 * @num: Number of channels
3823 * @freq_list: Preferred channel frequency list encoded in MHz values
3824 * Returns 0 on success, -1 on failure
3826 * This command can be used to query the preferred frequency list from
3827 * the driver specific to a particular interface type.
3829 int (*get_pref_freq_list
)(void *priv
, enum wpa_driver_if_type if_type
,
3830 unsigned int *num
, unsigned int *freq_list
);
3833 * set_prob_oper_freq - Indicate probable P2P operating channel
3834 * @priv: Private driver interface data
3835 * @freq: Channel frequency in MHz
3836 * Returns 0 on success, -1 on failure
3838 * This command can be used to inform the driver of the operating
3839 * frequency that an ongoing P2P group formation is likely to come up
3840 * on. Local device is assuming P2P Client role.
3842 int (*set_prob_oper_freq
)(void *priv
, unsigned int freq
);
3845 * abort_scan - Request the driver to abort an ongoing scan
3846 * @priv: Private driver interface data
3847 * @scan_cookie: Cookie identifying the scan request. This is used only
3848 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
3849 * was used to trigger scan. Otherwise, 0 is used.
3850 * Returns 0 on success, -1 on failure
3852 int (*abort_scan
)(void *priv
, u64 scan_cookie
);
3855 * configure_data_frame_filters - Request to configure frame filters
3856 * @priv: Private driver interface data
3857 * @filter_flags: The type of frames to filter (bitfield of
3858 * WPA_DATA_FRAME_FILTER_FLAG_*)
3859 * Returns: 0 on success or -1 on failure
3861 int (*configure_data_frame_filters
)(void *priv
, u32 filter_flags
);
3864 * get_ext_capab - Get extended capabilities for the specified interface
3865 * @priv: Private driver interface data
3866 * @type: Interface type for which to get extended capabilities
3867 * @ext_capab: Extended capabilities fetched
3868 * @ext_capab_mask: Extended capabilities mask
3869 * @ext_capab_len: Length of the extended capabilities
3870 * Returns: 0 on success or -1 on failure
3872 int (*get_ext_capab
)(void *priv
, enum wpa_driver_if_type type
,
3873 const u8
**ext_capab
, const u8
**ext_capab_mask
,
3874 unsigned int *ext_capab_len
);
3877 * p2p_lo_start - Start offloading P2P listen to device
3878 * @priv: Private driver interface data
3879 * @freq: Listening frequency (MHz) for P2P listen
3880 * @period: Length of the listen operation in milliseconds
3881 * @interval: Interval for running the listen operation in milliseconds
3882 * @count: Number of times to run the listen operation
3883 * @device_types: Device primary and secondary types
3884 * @dev_types_len: Number of bytes for device_types
3885 * @ies: P2P IE and WSC IE for Probe Response frames
3886 * @ies_len: Length of ies in bytes
3887 * Returns: 0 on success or -1 on failure
3889 int (*p2p_lo_start
)(void *priv
, unsigned int freq
,
3890 unsigned int period
, unsigned int interval
,
3892 const u8
*device_types
, size_t dev_types_len
,
3893 const u8
*ies
, size_t ies_len
);
3896 * p2p_lo_stop - Stop P2P listen offload
3897 * @priv: Private driver interface data
3898 * Returns: 0 on success or -1 on failure
3900 int (*p2p_lo_stop
)(void *priv
);
3903 * set_default_scan_ies - Set default scan IEs
3904 * @priv: Private driver interface data
3905 * @ies: Scan default IEs buffer
3906 * @ies_len: Length of IEs in bytes
3907 * Returns: 0 on success or -1 on failure
3909 * The driver can use these by default when there are no scan IEs coming
3910 * in the subsequent scan requests. Also in case of one or more of IEs
3911 * given in set_default_scan_ies() are missing in the subsequent scan
3912 * request, the driver should merge the missing scan IEs in the scan
3913 * request from the IEs set by set_default_scan_ies() in the Probe
3914 * Request frames sent.
3916 int (*set_default_scan_ies
)(void *priv
, const u8
*ies
, size_t ies_len
);
3919 * set_tdls_mode - Set TDLS trigger mode to the host driver
3920 * @priv: Private driver interface data
3921 * @tdls_external_control: Represents if TDLS external trigger control
3922 * mode is enabled/disabled.
3924 * This optional callback can be used to configure the TDLS external
3925 * trigger control mode to the host driver.
3927 int (*set_tdls_mode
)(void *priv
, int tdls_external_control
);
3930 * get_bss_transition_status - Get candidate BSS's transition status
3931 * @priv: Private driver interface data
3932 * @params: Candidate BSS list
3934 * Get the accept or reject reason code for a list of BSS transition
3937 struct wpa_bss_candidate_info
*
3938 (*get_bss_transition_status
)(void *priv
,
3939 struct wpa_bss_trans_info
*params
);
3941 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
3942 * @priv: Private driver interface data
3943 * @ignore_disallow: 0 to not ignore, 1 to ignore
3944 * Returns: 0 on success, -1 on failure
3946 int (*ignore_assoc_disallow
)(void *priv
, int ignore_disallow
);
3949 * set_bssid_blacklist - Set blacklist of BSSIDs to the driver
3950 * @priv: Private driver interface data
3951 * @num_bssid: Number of blacklist BSSIDs
3952 * @bssids: List of blacklisted BSSIDs
3954 int (*set_bssid_blacklist
)(void *priv
, unsigned int num_bssid
,
3959 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3961 enum wpa_event_type
{
3963 * EVENT_ASSOC - Association completed
3965 * This event needs to be delivered when the driver completes IEEE
3966 * 802.11 association or reassociation successfully.
3967 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3968 * after this event has been generated. In addition, optional
3969 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3970 * more information about the association. If the driver interface gets
3971 * both of these events at the same time, it can also include the
3972 * assoc_info data in EVENT_ASSOC call.
3977 * EVENT_DISASSOC - Association lost
3979 * This event should be called when association is lost either due to
3980 * receiving deauthenticate or disassociate frame from the AP or when
3981 * sending either of these frames to the current AP. If the driver
3982 * supports separate deauthentication event, EVENT_DISASSOC should only
3983 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3984 * In AP mode, union wpa_event_data::disassoc_info is required.
3989 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3991 * This event must be delivered when a Michael MIC error is detected by
3992 * the local driver. Additional data for event processing is
3993 * provided with union wpa_event_data::michael_mic_failure. This
3994 * information is used to request new encyption key and to initiate
3995 * TKIP countermeasures if needed.
3997 EVENT_MICHAEL_MIC_FAILURE
,
4000 * EVENT_SCAN_RESULTS - Scan results available
4002 * This event must be called whenever scan results are available to be
4003 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4004 * is expected to be used some time after struct wpa_driver_ops::scan()
4005 * is called. If the driver provides an unsolicited event when the scan
4006 * has been completed, this event can be used to trigger
4007 * EVENT_SCAN_RESULTS call. If such event is not available from the
4008 * driver, the driver wrapper code is expected to use a registered
4009 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
4010 * scan is expected to be completed. Optional information about
4011 * completed scan can be provided with union wpa_event_data::scan_info.
4016 * EVENT_ASSOCINFO - Report optional extra information for association
4018 * This event can be used to report extra association information for
4019 * EVENT_ASSOC processing. This extra information includes IEs from
4020 * association frames and Beacon/Probe Response frames in union
4021 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4022 * EVENT_ASSOC. Alternatively, the driver interface can include
4023 * assoc_info data in the EVENT_ASSOC call if it has all the
4024 * information available at the same point.
4029 * EVENT_INTERFACE_STATUS - Report interface status changes
4031 * This optional event can be used to report changes in interface
4032 * status (interface added/removed) using union
4033 * wpa_event_data::interface_status. This can be used to trigger
4034 * wpa_supplicant to stop and re-start processing for the interface,
4035 * e.g., when a cardbus card is ejected/inserted.
4037 EVENT_INTERFACE_STATUS
,
4040 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4042 * This event can be used to inform wpa_supplicant about candidates for
4043 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4044 * for scan request (ap_scan=2 mode), this event is required for
4045 * pre-authentication. If wpa_supplicant is performing scan request
4046 * (ap_scan=1), this event is optional since scan results can be used
4047 * to add pre-authentication candidates. union
4048 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4049 * candidate and priority of the candidate, e.g., based on the signal
4050 * strength, in order to try to pre-authenticate first with candidates
4051 * that are most likely targets for re-association.
4053 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4054 * on the candidate list. In addition, it can be called for the current
4055 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4056 * will automatically skip pre-authentication in cases where a valid
4057 * PMKSA exists. When more than one candidate exists, this event should
4058 * be generated once for each candidate.
4060 * Driver will be notified about successful pre-authentication with
4061 * struct wpa_driver_ops::add_pmkid() calls.
4063 EVENT_PMKID_CANDIDATE
,
4066 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
4068 * This event can be used to inform wpa_supplicant about desire to set
4069 * up secure direct link connection between two stations as defined in
4070 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
4071 * STAKey negotiation. The caller will need to set peer address for the
4077 * EVENT_TDLS - Request TDLS operation
4079 * This event can be used to request a TDLS operation to be performed.
4084 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4086 * The driver is expected to report the received FT IEs from
4087 * FT authentication sequence from the AP. The FT IEs are included in
4088 * the extra information in union wpa_event_data::ft_ies.
4093 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4095 * The driver can use this event to inform wpa_supplicant about a STA
4096 * in an IBSS with which protected frames could be exchanged. This
4097 * event starts RSN authentication with the other STA to authenticate
4098 * the STA and set up encryption keys with it.
4100 EVENT_IBSS_RSN_START
,
4103 * EVENT_AUTH - Authentication result
4105 * This event should be called when authentication attempt has been
4106 * completed. This is only used if the driver supports separate
4107 * authentication step (struct wpa_driver_ops::authenticate).
4108 * Information about authentication result is included in
4109 * union wpa_event_data::auth.
4114 * EVENT_DEAUTH - Authentication lost
4116 * This event should be called when authentication is lost either due
4117 * to receiving deauthenticate frame from the AP or when sending that
4118 * frame to the current AP.
4119 * In AP mode, union wpa_event_data::deauth_info is required.
4124 * EVENT_ASSOC_REJECT - Association rejected
4126 * This event should be called when (re)association attempt has been
4127 * rejected by the AP. Information about the association response is
4128 * included in union wpa_event_data::assoc_reject.
4133 * EVENT_AUTH_TIMED_OUT - Authentication timed out
4135 EVENT_AUTH_TIMED_OUT
,
4138 * EVENT_ASSOC_TIMED_OUT - Association timed out
4140 EVENT_ASSOC_TIMED_OUT
,
4143 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
4145 EVENT_WPS_BUTTON_PUSHED
,
4148 * EVENT_TX_STATUS - Report TX status
4153 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
4155 EVENT_RX_FROM_UNKNOWN
,
4158 * EVENT_RX_MGMT - Report RX of a management frame
4163 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
4165 * This event is used to indicate when the driver has started the
4166 * requested remain-on-channel duration. Information about the
4167 * operation is included in union wpa_event_data::remain_on_channel.
4169 EVENT_REMAIN_ON_CHANNEL
,
4172 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
4174 * This event is used to indicate when the driver has completed
4175 * remain-on-channel duration, i.e., may noot be available on the
4176 * requested channel anymore. Information about the
4177 * operation is included in union wpa_event_data::remain_on_channel.
4179 EVENT_CANCEL_REMAIN_ON_CHANNEL
,
4182 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
4184 * This event is used to indicate when a Probe Request frame has been
4185 * received. Information about the received frame is included in
4186 * union wpa_event_data::rx_probe_req. The driver is required to report
4187 * these events only after successfully completed probe_req_report()
4188 * commands to request the events (i.e., report parameter is non-zero)
4189 * in station mode. In AP mode, Probe Request frames should always be
4195 * EVENT_NEW_STA - New wired device noticed
4197 * This event is used to indicate that a new device has been detected
4198 * in a network that does not use association-like functionality (i.e.,
4199 * mainly wired Ethernet). This can be used to start EAPOL
4200 * authenticator when receiving a frame from a device. The address of
4201 * the device is included in union wpa_event_data::new_sta.
4206 * EVENT_EAPOL_RX - Report received EAPOL frame
4208 * When in AP mode with hostapd, this event is required to be used to
4209 * deliver the receive EAPOL frames from the driver.
4214 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4216 * This event is used to indicate changes in the signal strength
4217 * observed in frames received from the current AP if signal strength
4218 * monitoring has been enabled with signal_monitor().
4220 EVENT_SIGNAL_CHANGE
,
4223 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4225 * This event is used to indicate that the interface was enabled after
4226 * having been previously disabled, e.g., due to rfkill.
4228 EVENT_INTERFACE_ENABLED
,
4231 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4233 * This event is used to indicate that the interface was disabled,
4234 * e.g., due to rfkill.
4236 EVENT_INTERFACE_DISABLED
,
4239 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4241 * This event is used to indicate that the channel list has changed,
4242 * e.g., because of a regulatory domain change triggered by scan
4243 * results including an AP advertising a country code.
4245 EVENT_CHANNEL_LIST_CHANGED
,
4248 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4250 * This event is used to indicate that the driver cannot maintain this
4251 * interface in its operation mode anymore. The most likely use for
4252 * this is to indicate that AP mode operation is not available due to
4253 * operating channel would need to be changed to a DFS channel when
4254 * the driver does not support radar detection and another virtual
4255 * interfaces caused the operating channel to change. Other similar
4256 * resource conflicts could also trigger this for station mode
4257 * interfaces. This event can be propagated when channel switching
4260 EVENT_INTERFACE_UNAVAILABLE
,
4263 * EVENT_BEST_CHANNEL
4265 * Driver generates this event whenever it detects a better channel
4266 * (e.g., based on RSSI or channel use). This information can be used
4267 * to improve channel selection for a new AP/P2P group.
4272 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4274 * This event should be called when a Deauthentication frame is dropped
4275 * due to it not being protected (MFP/IEEE 802.11w).
4276 * union wpa_event_data::unprot_deauth is required to provide more
4277 * details of the frame.
4279 EVENT_UNPROT_DEAUTH
,
4282 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4284 * This event should be called when a Disassociation frame is dropped
4285 * due to it not being protected (MFP/IEEE 802.11w).
4286 * union wpa_event_data::unprot_disassoc is required to provide more
4287 * details of the frame.
4289 EVENT_UNPROT_DISASSOC
,
4292 * EVENT_STATION_LOW_ACK
4294 * Driver generates this event whenever it detected that a particular
4295 * station was lost. Detection can be through massive transmission
4296 * failures for example.
4298 EVENT_STATION_LOW_ACK
,
4301 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4303 EVENT_IBSS_PEER_LOST
,
4306 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4308 * This event carries the new replay counter to notify wpa_supplicant
4309 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4310 * completed Group Key Handshake while the host (including
4311 * wpa_supplicant was sleeping).
4313 EVENT_DRIVER_GTK_REKEY
,
4316 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4318 EVENT_SCHED_SCAN_STOPPED
,
4321 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4323 * This event indicates that the station responded to the poll
4324 * initiated with @poll_client.
4326 EVENT_DRIVER_CLIENT_POLL_OK
,
4329 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4331 EVENT_EAPOL_TX_STATUS
,
4334 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4336 * Described in wpa_event_data.ch_switch
4341 * EVENT_WNM - Request WNM operation
4343 * This event can be used to request a WNM operation to be performed.
4348 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4350 * This event indicates that the driver reported a connection failure
4351 * with the specified client (for example, max client reached, etc.) in
4354 EVENT_CONNECT_FAILED_REASON
,
4357 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
4359 * A radar has been detected on the supplied frequency, hostapd should
4360 * react accordingly (e.g., change channel).
4362 EVENT_DFS_RADAR_DETECTED
,
4365 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
4367 * After a successful CAC, the channel can be marked clear and used.
4369 EVENT_DFS_CAC_FINISHED
,
4372 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
4374 * The CAC was not successful, and the channel remains in the previous
4375 * state. This may happen due to a radar being detected or other
4376 * external influences.
4378 EVENT_DFS_CAC_ABORTED
,
4381 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
4383 * The channel which was previously unavailable is now available again.
4385 EVENT_DFS_NOP_FINISHED
,
4388 * EVENT_SURVEY - Received survey data
4390 * This event gets triggered when a driver query is issued for survey
4391 * data and the requested data becomes available. The returned data is
4392 * stored in struct survey_results. The results provide at most one
4393 * survey entry for each frequency and at minimum will provide one
4394 * survey entry for one frequency. The survey data can be os_malloc()'d
4395 * and then os_free()'d, so the event callback must only copy data.
4400 * EVENT_SCAN_STARTED - Scan started
4402 * This indicates that driver has started a scan operation either based
4403 * on a request from wpa_supplicant/hostapd or from another application.
4404 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4405 * completed (either successfully or by getting cancelled).
4410 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4412 * This event indicates a set of frequency ranges that should be avoided
4413 * to reduce issues due to interference or internal co-existence
4414 * information in the driver.
4416 EVENT_AVOID_FREQUENCIES
,
4419 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4421 EVENT_NEW_PEER_CANDIDATE
,
4424 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4426 * Indicates a pair of primary and secondary channels chosen by ACS
4429 EVENT_ACS_CHANNEL_SELECTED
,
4432 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4435 * This event indicates that channel availability check has been started
4436 * on a DFS frequency by a driver that supports DFS Offload.
4438 EVENT_DFS_CAC_STARTED
,
4441 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4446 * EVENT_BEACON_LOSS - Beacon loss detected
4448 * This event indicates that no Beacon frames has been received from
4449 * the current AP. This may indicate that the AP is not anymore in
4455 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
4456 * done previously (Pre-CAC) on the channel has expired. This would
4457 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
4458 * channel will be moved from available to usable. A new CAC has to be
4459 * performed before start operating on this channel.
4461 EVENT_DFS_PRE_CAC_EXPIRED
,
4466 * struct freq_survey - Channel survey info
4468 * @ifidx: Interface index in which this survey was observed
4469 * @freq: Center of frequency of the surveyed channel
4470 * @nf: Channel noise floor in dBm
4471 * @channel_time: Amount of time in ms the radio spent on the channel
4472 * @channel_time_busy: Amount of time in ms the radio detected some signal
4473 * that indicated to the radio the channel was not clear
4474 * @channel_time_rx: Amount of time the radio spent receiving data
4475 * @channel_time_tx: Amount of time the radio spent transmitting data
4476 * @filled: bitmask indicating which fields have been reported, see
4477 * SURVEY_HAS_* defines.
4478 * @list: Internal list pointers
4480 struct freq_survey
{
4485 u64 channel_time_busy
;
4486 u64 channel_time_rx
;
4487 u64 channel_time_tx
;
4488 unsigned int filled
;
4489 struct dl_list list
;
4492 #define SURVEY_HAS_NF BIT(0)
4493 #define SURVEY_HAS_CHAN_TIME BIT(1)
4494 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4495 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4496 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4500 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4502 union wpa_event_data
{
4504 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4506 * This structure is optional for EVENT_ASSOC calls and required for
4507 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4508 * driver interface does not need to generate separate EVENT_ASSOCINFO
4513 * reassoc - Flag to indicate association or reassociation
4518 * req_ies - (Re)Association Request IEs
4520 * If the driver generates WPA/RSN IE, this event data must be
4521 * returned for WPA handshake to have needed information. If
4522 * wpa_supplicant-generated WPA/RSN IE is used, this
4523 * information event is optional.
4525 * This should start with the first IE (fixed fields before IEs
4526 * are not included).
4531 * req_ies_len - Length of req_ies in bytes
4536 * resp_ies - (Re)Association Response IEs
4538 * Optional association data from the driver. This data is not
4539 * required WPA, but may be useful for some protocols and as
4540 * such, should be reported if this is available to the driver
4543 * This should start with the first IE (fixed fields before IEs
4544 * are not included).
4549 * resp_ies_len - Length of resp_ies in bytes
4551 size_t resp_ies_len
;
4554 * resp_frame - (Re)Association Response frame
4556 const u8
*resp_frame
;
4559 * resp_frame_len - (Re)Association Response frame length
4561 size_t resp_frame_len
;
4564 * beacon_ies - Beacon or Probe Response IEs
4566 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4567 * Probe Response frames from the current AP (i.e., the one
4568 * that the client just associated with). This information is
4569 * used to update WPA/RSN IE for the AP. If this field is not
4570 * set, the results from previous scan will be used. If no
4571 * data for the new AP is found, scan results will be requested
4572 * again (without scan request). At this point, the driver is
4573 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4576 * This should start with the first IE (fixed fields before IEs
4577 * are not included).
4579 const u8
*beacon_ies
;
4582 * beacon_ies_len - Length of beacon_ies */
4583 size_t beacon_ies_len
;
4586 * freq - Frequency of the operational channel in MHz
4591 * wmm_params - WMM parameters used in this association.
4593 struct wmm_params wmm_params
;
4596 * addr - Station address (for AP mode)
4601 * The following is the key management offload information
4604 * @key_replay_ctr_len
4612 * authorized - Status of key management offload,
4618 * key_replay_ctr - Key replay counter value last used
4619 * in a valid EAPOL-Key frame
4621 const u8
*key_replay_ctr
;
4624 * key_replay_ctr_len - The length of key_replay_ctr
4626 size_t key_replay_ctr_len
;
4629 * ptk_kck - The derived PTK KCK
4634 * ptk_kek_len - The length of ptk_kck
4639 * ptk_kek - The derived PTK KEK
4640 * This is used in key management offload and also in FILS SK
4646 * ptk_kek_len - The length of ptk_kek
4651 * subnet_status - The subnet status:
4652 * 0 = unknown, 1 = unchanged, 2 = changed
4657 * The following information is used in FILS SK offload
4658 * @fils_erp_next_seq_num
4665 * fils_erp_next_seq_num - The next sequence number to use in
4668 u16 fils_erp_next_seq_num
;
4671 * fils_pmk - A new PMK if generated in case of FILS
4677 * fils_pmk_len - Length of fils_pmk
4679 size_t fils_pmk_len
;
4682 * fils_pmkid - PMKID used or generated in FILS authentication
4684 const u8
*fils_pmkid
;
4688 * struct disassoc_info - Data for EVENT_DISASSOC events
4690 struct disassoc_info
{
4692 * addr - Station address (for AP mode)
4697 * reason_code - Reason Code (host byte order) used in
4698 * Deauthentication frame
4703 * ie - Optional IE(s) in Disassociation frame
4708 * ie_len - Length of ie buffer in octets
4713 * locally_generated - Whether the frame was locally generated
4715 int locally_generated
;
4719 * struct deauth_info - Data for EVENT_DEAUTH events
4721 struct deauth_info
{
4723 * addr - Station address (for AP mode)
4728 * reason_code - Reason Code (host byte order) used in
4729 * Deauthentication frame
4734 * ie - Optional IE(s) in Deauthentication frame
4739 * ie_len - Length of ie buffer in octets
4744 * locally_generated - Whether the frame was locally generated
4746 int locally_generated
;
4750 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4752 struct michael_mic_failure
{
4755 } michael_mic_failure
;
4758 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4760 struct interface_status
{
4761 unsigned int ifindex
;
4764 EVENT_INTERFACE_ADDED
, EVENT_INTERFACE_REMOVED
4769 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4771 struct pmkid_candidate
{
4772 /** BSSID of the PMKID candidate */
4774 /** Smaller the index, higher the priority */
4776 /** Whether RSN IE includes pre-authenticate flag */
4781 * struct stkstart - Data for EVENT_STKSTART
4788 * struct tdls - Data for EVENT_TDLS
4794 TDLS_REQUEST_TEARDOWN
,
4795 TDLS_REQUEST_DISCOVER
,
4797 u16 reason_code
; /* for teardown */
4801 * struct wnm - Data for EVENT_WNM
4819 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4821 * During FT (IEEE 802.11r) authentication sequence, the driver is
4822 * expected to use this event to report received FT IEs (MDIE, FTIE,
4823 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4824 * IEs for the next message will be delivered through the
4825 * struct wpa_driver_ops::update_ft_ies() callback.
4831 u8 target_ap
[ETH_ALEN
];
4832 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4834 /** Length of ric_ies buffer in octets */
4839 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4841 struct ibss_rsn_start
{
4846 * struct auth_info - Data for EVENT_AUTH events
4852 u16 auth_transaction
;
4859 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4861 struct assoc_reject
{
4863 * bssid - BSSID of the AP that rejected association
4868 * resp_ies - (Re)Association Response IEs
4870 * Optional association data from the driver. This data is not
4871 * required WPA, but may be useful for some protocols and as
4872 * such, should be reported if this is available to the driver
4875 * This should start with the first IE (fixed fields before IEs
4876 * are not included).
4881 * resp_ies_len - Length of resp_ies in bytes
4883 size_t resp_ies_len
;
4886 * status_code - Status Code from (Re)association Response
4891 * timed_out - Whether failure is due to timeout (etc.) rather
4892 * than explicit rejection response from the AP.
4897 * timeout_reason - Reason for the timeout
4899 const char *timeout_reason
;
4902 * fils_erp_next_seq_num - The next sequence number to use in
4905 u16 fils_erp_next_seq_num
;
4908 struct timeout_event
{
4913 * struct tx_status - Data for EVENT_TX_STATUS events
4925 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4927 struct rx_from_unknown
{
4934 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4942 * drv_priv - Pointer to store driver private BSS information
4944 * If not set to NULL, this is used for comparison with
4945 * hostapd_data->drv_priv to determine which BSS should process
4951 * freq - Frequency (in MHz) on which the frame was received
4956 * ssi_signal - Signal strength in dBm (or 0 if not available)
4962 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4964 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4966 struct remain_on_channel
{
4968 * freq - Channel frequency in MHz
4973 * duration - Duration to remain on the channel in milliseconds
4975 unsigned int duration
;
4976 } remain_on_channel
;
4979 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4980 * @aborted: Whether the scan was aborted
4981 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4982 * @num_freqs: Number of entries in freqs array
4983 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4985 * @num_ssids: Number of entries in ssids array
4986 * @external_scan: Whether the scan info is for an external scan
4987 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
4988 * 0 if the source of the scan event is a vendor scan
4989 * @scan_start_tsf: Time when the scan started in terms of TSF of the
4990 * BSS that the interface that requested the scan is connected to
4992 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
4999 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
5004 u8 scan_start_tsf_bssid
[ETH_ALEN
];
5008 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
5010 struct rx_probe_req
{
5012 * sa - Source address of the received Probe Request frame
5017 * da - Destination address of the received Probe Request frame
5018 * or %NULL if not available
5023 * bssid - BSSID of the received Probe Request frame or %NULL
5029 * ie - IEs from the Probe Request body
5034 * ie_len - Length of ie buffer in octets
5039 * signal - signal strength in dBm (or 0 if not available)
5045 * struct new_sta - Data for EVENT_NEW_STA events
5052 * struct eapol_rx - Data for EVENT_EAPOL_RX events
5061 * signal_change - Data for EVENT_SIGNAL_CHANGE events
5063 struct wpa_signal_info signal_change
;
5066 * struct best_channel - Data for EVENT_BEST_CHANNEL events
5067 * @freq_24: Best 2.4 GHz band channel frequency in MHz
5068 * @freq_5: Best 5 GHz band channel frequency in MHz
5069 * @freq_overall: Best channel frequency in MHz
5071 * 0 can be used to indicate no preference in either band.
5073 struct best_channel
{
5079 struct unprot_deauth
{
5085 struct unprot_disassoc
{
5092 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
5093 * @addr: station address
5094 * @num_packets: Number of packets lost (consecutive packets not
5103 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
5105 struct ibss_peer_lost
{
5110 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
5112 struct driver_gtk_rekey
{
5114 const u8
*replay_ctr
;
5118 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
5119 * @addr: station address
5121 struct client_poll
{
5126 * struct eapol_tx_status
5127 * @dst: Original destination
5128 * @data: Data starting with IEEE 802.1X header (!)
5129 * @data_len: Length of data
5130 * @ack: Indicates ack or lost frame
5132 * This corresponds to hapd_send_eapol if the frame sent
5133 * there isn't just reported as EVENT_TX_STATUS.
5135 struct eapol_tx_status
{
5144 * @freq: Frequency of new channel in MHz
5145 * @ht_enabled: Whether this is an HT channel
5146 * @ch_offset: Secondary channel offset
5147 * @ch_width: Channel width
5148 * @cf1: Center frequency 1
5149 * @cf2: Center frequency 2
5155 enum chan_width ch_width
;
5161 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
5162 * @addr: Remote client address
5163 * @code: Reason code for connection failure
5165 struct connect_failed_reason
{
5171 } connect_failed_reason
;
5174 * struct dfs_event - Data for radar detected events
5175 * @freq: Frequency of the channel in MHz
5181 enum chan_width chan_width
;
5187 * survey_results - Survey result data for EVENT_SURVEY
5188 * @freq_filter: Requested frequency survey filter, 0 if request
5189 * was for all survey data
5190 * @survey_list: Linked list of survey data (struct freq_survey)
5192 struct survey_results
{
5193 unsigned int freq_filter
;
5194 struct dl_list survey_list
; /* struct freq_survey */
5198 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
5199 * @initiator: Initiator of the regulatory change
5200 * @type: Regulatory change type
5201 * @alpha2: Country code (or "" if not available)
5203 struct channel_list_changed
{
5204 enum reg_change_initiator initiator
;
5207 } channel_list_changed
;
5210 * freq_range - List of frequency ranges
5212 * This is used as the data with EVENT_AVOID_FREQUENCIES.
5214 struct wpa_freq_range_list freq_range
;
5219 * @peer: Peer address
5221 * @ie_len: Length of @ies
5223 * Notification of new candidate mesh peer.
5232 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
5233 * @pri_channel: Selected primary channel
5234 * @sec_channel: Selected secondary channel
5235 * @vht_seg0_center_ch: VHT mode Segment0 center channel
5236 * @vht_seg1_center_ch: VHT mode Segment1 center channel
5237 * @ch_width: Selected Channel width by driver. Driver may choose to
5238 * change hostapd configured ACS channel width due driver internal
5239 * channel restrictions.
5240 * hw_mode: Selected band (used with hw_mode=any)
5242 struct acs_selected_channels
{
5245 u8 vht_seg0_center_ch
;
5246 u8 vht_seg1_center_ch
;
5248 enum hostapd_hw_mode hw_mode
;
5249 } acs_selected_channels
;
5252 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
5253 * @reason_code: Reason for stopping offload
5254 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
5256 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
5258 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
5260 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
5261 * supported by device.
5263 struct p2p_lo_stop
{
5265 P2P_LO_STOPPED_REASON_COMPLETE
= 0,
5266 P2P_LO_STOPPED_REASON_RECV_STOP_CMD
,
5267 P2P_LO_STOPPED_REASON_INVALID_PARAM
,
5268 P2P_LO_STOPPED_REASON_NOT_SUPPORTED
,
5274 * wpa_supplicant_event - Report a driver event for wpa_supplicant
5275 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5276 * with struct wpa_driver_ops::init()
5277 * @event: event type (defined above)
5278 * @data: possible extra data for the event
5280 * Driver wrapper code should call this function whenever an event is received
5283 void wpa_supplicant_event(void *ctx
, enum wpa_event_type event
,
5284 union wpa_event_data
*data
);
5287 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
5288 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5289 * with struct wpa_driver_ops::init()
5290 * @event: event type (defined above)
5291 * @data: possible extra data for the event
5293 * Same as wpa_supplicant_event(), but we search for the interface in
5296 void wpa_supplicant_event_global(void *ctx
, enum wpa_event_type event
,
5297 union wpa_event_data
*data
);
5300 * The following inline functions are provided for convenience to simplify
5301 * event indication for some of the common events.
5304 static inline void drv_event_assoc(void *ctx
, const u8
*addr
, const u8
*ie
,
5305 size_t ielen
, int reassoc
)
5307 union wpa_event_data event
;
5308 os_memset(&event
, 0, sizeof(event
));
5309 event
.assoc_info
.reassoc
= reassoc
;
5310 event
.assoc_info
.req_ies
= ie
;
5311 event
.assoc_info
.req_ies_len
= ielen
;
5312 event
.assoc_info
.addr
= addr
;
5313 wpa_supplicant_event(ctx
, EVENT_ASSOC
, &event
);
5316 static inline void drv_event_disassoc(void *ctx
, const u8
*addr
)
5318 union wpa_event_data event
;
5319 os_memset(&event
, 0, sizeof(event
));
5320 event
.disassoc_info
.addr
= addr
;
5321 wpa_supplicant_event(ctx
, EVENT_DISASSOC
, &event
);
5324 static inline void drv_event_eapol_rx(void *ctx
, const u8
*src
, const u8
*data
,
5327 union wpa_event_data event
;
5328 os_memset(&event
, 0, sizeof(event
));
5329 event
.eapol_rx
.src
= src
;
5330 event
.eapol_rx
.data
= data
;
5331 event
.eapol_rx
.data_len
= data_len
;
5332 wpa_supplicant_event(ctx
, EVENT_EAPOL_RX
, &event
);
5335 /* driver_common.c */
5336 void wpa_scan_results_free(struct wpa_scan_results
*res
);
5338 /* Convert wpa_event_type to a string for logging */
5339 const char * event_to_string(enum wpa_event_type event
);
5341 /* Convert chan_width to a string for logging and control interfaces */
5342 const char * channel_width_to_string(enum chan_width width
);
5344 int ht_supported(const struct hostapd_hw_modes
*mode
);
5345 int vht_supported(const struct hostapd_hw_modes
*mode
);
5347 struct wowlan_triggers
*
5348 wpa_get_wowlan_triggers(const char *wowlan_triggers
,
5349 const struct wpa_driver_capa
*capa
);
5350 /* Convert driver flag to string */
5351 const char * driver_flag_to_string(u64 flag
);
5353 /* NULL terminated array of linked in driver wrappers */
5354 extern const struct wpa_driver_ops
*const wpa_drivers
[];
5357 /* Available drivers */
5359 #ifdef CONFIG_DRIVER_WEXT
5360 extern const struct wpa_driver_ops wpa_driver_wext_ops
; /* driver_wext.c */
5361 #endif /* CONFIG_DRIVER_WEXT */
5362 #ifdef CONFIG_DRIVER_NL80211
5363 /* driver_nl80211.c */
5364 extern const struct wpa_driver_ops wpa_driver_nl80211_ops
;
5365 #endif /* CONFIG_DRIVER_NL80211 */
5366 #ifdef CONFIG_DRIVER_HOSTAP
5367 extern const struct wpa_driver_ops wpa_driver_hostap_ops
; /* driver_hostap.c */
5368 #endif /* CONFIG_DRIVER_HOSTAP */
5369 #ifdef CONFIG_DRIVER_BSD
5370 extern const struct wpa_driver_ops wpa_driver_bsd_ops
; /* driver_bsd.c */
5371 #endif /* CONFIG_DRIVER_BSD */
5372 #ifdef CONFIG_DRIVER_OPENBSD
5373 /* driver_openbsd.c */
5374 extern const struct wpa_driver_ops wpa_driver_openbsd_ops
;
5375 #endif /* CONFIG_DRIVER_OPENBSD */
5376 #ifdef CONFIG_DRIVER_NDIS
5377 extern struct wpa_driver_ops wpa_driver_ndis_ops
; /* driver_ndis.c */
5378 #endif /* CONFIG_DRIVER_NDIS */
5379 #ifdef CONFIG_DRIVER_WIRED
5380 extern const struct wpa_driver_ops wpa_driver_wired_ops
; /* driver_wired.c */
5381 #endif /* CONFIG_DRIVER_WIRED */
5382 #ifdef CONFIG_DRIVER_MACSEC_QCA
5383 /* driver_macsec_qca.c */
5384 extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops
;
5385 #endif /* CONFIG_DRIVER_MACSEC_QCA */
5386 #ifdef CONFIG_DRIVER_MACSEC_LINUX
5387 /* driver_macsec_linux.c */
5388 extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops
;
5389 #endif /* CONFIG_DRIVER_MACSEC_LINUX */
5390 #ifdef CONFIG_DRIVER_ROBOSWITCH
5391 /* driver_roboswitch.c */
5392 extern const struct wpa_driver_ops wpa_driver_roboswitch_ops
;
5393 #endif /* CONFIG_DRIVER_ROBOSWITCH */
5394 #ifdef CONFIG_DRIVER_ATHEROS
5395 /* driver_atheros.c */
5396 extern const struct wpa_driver_ops wpa_driver_atheros_ops
;
5397 #endif /* CONFIG_DRIVER_ATHEROS */
5398 #ifdef CONFIG_DRIVER_NONE
5399 extern const struct wpa_driver_ops wpa_driver_none_ops
; /* driver_none.c */
5400 #endif /* CONFIG_DRIVER_NONE */
5402 #endif /* DRIVER_H */