blob: 6bbf1ec6b9b985ae1da75926e6cdb6f8a875004f [file] [log] [blame]
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001/*
2 * Driver interface definition
Paul Stewart092955c2017-02-06 09:13:09 -08003 * Copyright (c) 2003-2017, Jouni Malinen <j@w1.fi>
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004 *
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07007 *
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.
15 */
16
17#ifndef DRIVER_H
18#define DRIVER_H
19
20#define WPA_SUPPLICANT_DRIVER_VERSION 4
21
22#include "common/defs.h"
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -070023#include "common/ieee802_11_defs.h"
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070024#include "common/wpa_common.h"
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -080025#ifdef CONFIG_MACSEC
26#include "pae/ieee802_1x_kay.h"
27#endif /* CONFIG_MACSEC */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -070028#include "utils/list.h"
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070029
30#define HOSTAPD_CHAN_DISABLED 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080031#define HOSTAPD_CHAN_NO_IR 0x00000002
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070032#define HOSTAPD_CHAN_RADAR 0x00000008
33#define HOSTAPD_CHAN_HT40PLUS 0x00000010
34#define HOSTAPD_CHAN_HT40MINUS 0x00000020
35#define HOSTAPD_CHAN_HT40 0x00000040
Dmitry Shmidt391c59f2013-09-03 12:16:28 -070036#define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070037
Dmitry Shmidtea69e842013-05-13 14:52:28 -070038#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
43
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -070044#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
48
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080049#define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
50#define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
51
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -080052#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
60
Hai Shalom74f70d42019-02-11 14:42:39 -080061/* Allowed bandwidth mask */
62enum hostapd_chan_width_attr {
63 HOSTAPD_CHAN_WIDTH_10 = BIT(0),
64 HOSTAPD_CHAN_WIDTH_20 = BIT(1),
65 HOSTAPD_CHAN_WIDTH_40P = BIT(2),
66 HOSTAPD_CHAN_WIDTH_40M = BIT(3),
67 HOSTAPD_CHAN_WIDTH_80 = BIT(4),
68 HOSTAPD_CHAN_WIDTH_160 = BIT(5),
Sunil8cd6f4d2022-06-28 18:40:46 +000069 HOSTAPD_CHAN_WIDTH_320 = BIT(6),
Hai Shalom74f70d42019-02-11 14:42:39 -080070};
71
Dmitry Shmidt849734c2016-05-27 09:59:01 -070072/* Filter gratuitous ARP */
73#define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
74/* Filter unsolicited Neighbor Advertisement */
75#define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
76/* Filter unicast IP packets encrypted using the GTK */
77#define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)
78
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070079#define HOSTAPD_DFS_REGION_FCC 1
80#define HOSTAPD_DFS_REGION_ETSI 2
81#define HOSTAPD_DFS_REGION_JP 3
82
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080083/**
84 * enum reg_change_initiator - Regulatory change initiator
85 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -080086enum reg_change_initiator {
87 REGDOM_SET_BY_CORE,
88 REGDOM_SET_BY_USER,
89 REGDOM_SET_BY_DRIVER,
90 REGDOM_SET_BY_COUNTRY_IE,
Dmitry Shmidt97672262014-02-03 13:02:54 -080091 REGDOM_BEACON_HINT,
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -080092};
93
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080094/**
95 * enum reg_type - Regulatory change types
96 */
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -070097enum reg_type {
98 REGDOM_TYPE_UNKNOWN,
99 REGDOM_TYPE_COUNTRY,
100 REGDOM_TYPE_WORLD,
101 REGDOM_TYPE_CUSTOM_WORLD,
102 REGDOM_TYPE_INTERSECTION,
103};
104
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700105/**
Hai Shalom81f62d82019-07-22 12:10:00 -0700106 * struct hostapd_wmm_rule - WMM regulatory rule
107 * @min_cwmin: Lower bound of CW_min value
108 * @min_cwmax: Lower bound of CW_max value
109 * @min_aifs: Lower bound of AIFS value
110 * @max_txop: Upper bound of TXOP, value in units of 32 usec
111 */
112struct hostapd_wmm_rule {
113 int min_cwmin;
114 int min_cwmax;
115 int min_aifs;
116 int max_txop;
117};
118
119/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700120 * struct hostapd_channel_data - Channel information
121 */
122struct hostapd_channel_data {
123 /**
124 * chan - Channel number (IEEE 802.11)
125 */
126 short chan;
127
128 /**
129 * freq - Frequency in MHz
130 */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800131 int freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700132
133 /**
134 * flag - Channel flags (HOSTAPD_CHAN_*)
135 */
136 int flag;
137
138 /**
Hai Shalom74f70d42019-02-11 14:42:39 -0800139 * allowed_bw - Allowed channel width bitmask
140 *
141 * See enum hostapd_chan_width_attr.
142 */
143 u32 allowed_bw;
144
145 /**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -0700146 * max_tx_power - Regulatory transmit power limit in dBm
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700147 */
148 u8 max_tx_power;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -0700149
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800150 /**
151 * survey_list - Linked list of surveys (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -0700152 */
153 struct dl_list survey_list;
154
155 /**
156 * min_nf - Minimum observed noise floor, in dBm, based on all
157 * surveyed channel data
158 */
159 s8 min_nf;
Dmitry Shmidt391c59f2013-09-03 12:16:28 -0700160
161#ifdef CONFIG_ACS
162 /**
163 * interference_factor - Computed interference factor on this
164 * channel (used internally in src/ap/acs.c; driver wrappers do not
165 * need to set this)
166 */
167 long double interference_factor;
168#endif /* CONFIG_ACS */
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -0700169
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800170 /**
171 * dfs_cac_ms - DFS CAC time in milliseconds
172 */
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -0700173 unsigned int dfs_cac_ms;
Hai Shalom81f62d82019-07-22 12:10:00 -0700174
175 /**
176 * wmm_rules_valid - Indicates wmm_rules state
177 */
178 int wmm_rules_valid;
179
180 /**
181 * wmm_rules - WMM regulatory rules
182 */
183 struct hostapd_wmm_rule wmm_rules[WMM_AC_NUM];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700184};
185
Hai Shalomfdcde762020-04-02 11:19:20 -0700186#define HE_MAC_CAPAB_0 0
Hai Shalom81f62d82019-07-22 12:10:00 -0700187#define HE_MAX_MAC_CAPAB_SIZE 6
188#define HE_MAX_PHY_CAPAB_SIZE 11
189#define HE_MAX_MCS_CAPAB_SIZE 12
190#define HE_MAX_PPET_CAPAB_SIZE 25
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800191
192/**
193 * struct he_capabilities - IEEE 802.11ax HE capabilities
194 */
195struct he_capabilities {
196 u8 he_supported;
Hai Shalom81f62d82019-07-22 12:10:00 -0700197 u8 phy_cap[HE_MAX_PHY_CAPAB_SIZE];
198 u8 mac_cap[HE_MAX_MAC_CAPAB_SIZE];
199 u8 mcs[HE_MAX_MCS_CAPAB_SIZE];
200 u8 ppet[HE_MAX_PPET_CAPAB_SIZE];
Hai Shalom899fcc72020-10-19 14:38:18 -0700201 u16 he_6ghz_capa;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800202};
203
Sunil Ravia04bd252022-05-02 22:54:18 -0700204/* struct eht_capabilities - IEEE 802.11be EHT capabilities */
205struct eht_capabilities {
206 bool eht_supported;
207 u16 mac_cap;
208 u8 phy_cap[EHT_PHY_CAPAB_LEN];
209 u8 mcs[EHT_MCS_NSS_CAPAB_LEN];
210 u8 ppet[EHT_PPE_THRESH_CAPAB_LEN];
211};
212
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800213#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -0700214#define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800215
Hai Shalom81f62d82019-07-22 12:10:00 -0700216
217enum ieee80211_op_mode {
218 IEEE80211_MODE_INFRA = 0,
219 IEEE80211_MODE_IBSS = 1,
220 IEEE80211_MODE_AP = 2,
221 IEEE80211_MODE_MESH = 5,
222
223 /* only add new entries before IEEE80211_MODE_NUM */
224 IEEE80211_MODE_NUM
225};
226
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700227/**
Hai Shalomc3565922019-10-28 11:58:20 -0700228 * struct ieee80211_edmg_config - EDMG configuration
229 *
230 * This structure describes most essential parameters needed
231 * for IEEE 802.11ay EDMG configuration
232 *
233 * @channels: Bitmap that indicates the 2.16 GHz channel(s)
234 * that are allowed to be used for transmissions.
235 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
236 * Set to 0 to indicate EDMG not supported.
237 * @bw_config: Channel BW Configuration subfield encodes
238 * the allowed channel bandwidth configurations
239 */
240struct ieee80211_edmg_config {
241 u8 channels;
242 enum edmg_bw_config bw_config;
243};
244
245/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700246 * struct hostapd_hw_modes - Supported hardware mode information
247 */
248struct hostapd_hw_modes {
249 /**
250 * mode - Hardware mode
251 */
252 enum hostapd_hw_mode mode;
253
254 /**
255 * num_channels - Number of entries in the channels array
256 */
257 int num_channels;
258
259 /**
260 * channels - Array of supported channels
261 */
262 struct hostapd_channel_data *channels;
263
264 /**
265 * num_rates - Number of entries in the rates array
266 */
267 int num_rates;
268
269 /**
270 * rates - Array of supported rates in 100 kbps units
271 */
272 int *rates;
273
274 /**
275 * ht_capab - HT (IEEE 802.11n) capabilities
276 */
277 u16 ht_capab;
278
279 /**
280 * mcs_set - MCS (IEEE 802.11n) rate parameters
281 */
282 u8 mcs_set[16];
283
284 /**
285 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
286 */
287 u8 a_mpdu_params;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800288
Dmitry Shmidt04949592012-07-19 12:16:46 -0700289 /**
290 * vht_capab - VHT (IEEE 802.11ac) capabilities
291 */
292 u32 vht_capab;
293
294 /**
295 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
296 */
297 u8 vht_mcs_set[8];
298
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800299 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800300
301 /**
302 * he_capab - HE (IEEE 802.11ax) capabilities
303 */
Hai Shalom81f62d82019-07-22 12:10:00 -0700304 struct he_capabilities he_capab[IEEE80211_MODE_NUM];
Hai Shalomc3565922019-10-28 11:58:20 -0700305
306 /**
307 * This structure describes the most essential parameters needed
308 * for IEEE 802.11ay EDMG configuration.
309 */
310 struct ieee80211_edmg_config edmg;
Sunil Ravia04bd252022-05-02 22:54:18 -0700311
312 /**
313 * eht_capab - EHT (IEEE 802.11be) capabilities
314 */
315 struct eht_capabilities eht_capab[IEEE80211_MODE_NUM];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700316};
317
318
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700319#define IEEE80211_CAP_ESS 0x0001
320#define IEEE80211_CAP_IBSS 0x0002
321#define IEEE80211_CAP_PRIVACY 0x0010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800322#define IEEE80211_CAP_RRM 0x1000
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700323
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800324/* DMG (60 GHz) IEEE 802.11ad */
325/* type - bits 0..1 */
326#define IEEE80211_CAP_DMG_MASK 0x0003
327#define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
328#define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
329#define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
330
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700331#define WPA_SCAN_QUAL_INVALID BIT(0)
332#define WPA_SCAN_NOISE_INVALID BIT(1)
333#define WPA_SCAN_LEVEL_INVALID BIT(2)
334#define WPA_SCAN_LEVEL_DBM BIT(3)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700335#define WPA_SCAN_ASSOCIATED BIT(5)
336
337/**
338 * struct wpa_scan_res - Scan result for an BSS/IBSS
339 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
340 * @bssid: BSSID
341 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
342 * @beacon_int: beacon interval in TUs (host byte order)
343 * @caps: capability information field in host byte order
344 * @qual: signal quality
345 * @noise: noise level
346 * @level: signal level
347 * @tsf: Timestamp
348 * @age: Age of the information in milliseconds (i.e., how many milliseconds
349 * ago the last Beacon or Probe Response frame was received)
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800350 * @est_throughput: Estimated throughput in kbps (this is calculated during
351 * scan result processing if left zero by the driver wrapper)
352 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
Dmitry Shmidt29333592017-01-09 12:27:11 -0800353 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
354 * of TSF of the BSS specified by %tsf_bssid.
355 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
Sunil Ravia04bd252022-05-02 22:54:18 -0700356 * @beacon_newer: Whether the Beacon frame data is known to be newer
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700357 * @ie_len: length of the following IE field in octets
358 * @beacon_ie_len: length of the following Beacon IE field in octets
359 *
360 * This structure is used as a generic format for scan results from the
361 * driver. Each driver interface implementation is responsible for converting
362 * the driver or OS specific scan results into this format.
363 *
364 * If the driver does not support reporting all IEs, the IE data structure is
365 * constructed of the IEs that are available. This field will also need to
366 * include SSID in IE format. All drivers are encouraged to be extended to
367 * report all IEs to make it easier to support future additions.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800368 *
369 * This structure data is followed by ie_len octets of IEs from Probe Response
370 * frame (or if the driver does not indicate source of IEs, these may also be
371 * from Beacon frame). After the first set of IEs, another set of IEs may follow
372 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700373 */
374struct wpa_scan_res {
375 unsigned int flags;
376 u8 bssid[ETH_ALEN];
377 int freq;
378 u16 beacon_int;
379 u16 caps;
380 int qual;
381 int noise;
382 int level;
383 u64 tsf;
384 unsigned int age;
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800385 unsigned int est_throughput;
386 int snr;
Dmitry Shmidt29333592017-01-09 12:27:11 -0800387 u64 parent_tsf;
388 u8 tsf_bssid[ETH_ALEN];
Sunil Ravia04bd252022-05-02 22:54:18 -0700389 bool beacon_newer;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700390 size_t ie_len;
391 size_t beacon_ie_len;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800392 /* Followed by ie_len + beacon_ie_len octets of IE data */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700393};
394
395/**
396 * struct wpa_scan_results - Scan results
397 * @res: Array of pointers to allocated variable length scan result entries
398 * @num: Number of entries in the scan result array
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800399 * @fetch_time: Time when the results were fetched from the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700400 */
401struct wpa_scan_results {
402 struct wpa_scan_res **res;
403 size_t num;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800404 struct os_reltime fetch_time;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700405};
406
407/**
408 * struct wpa_interface_info - Network interface information
409 * @next: Pointer to the next interface or NULL if this is the last one
410 * @ifname: Interface name that can be used with init() or init2()
411 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
412 * not available
413 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
414 * is not an allocated copy, i.e., get_interfaces() caller will not free
415 * this)
416 */
417struct wpa_interface_info {
418 struct wpa_interface_info *next;
419 char *ifname;
420 char *desc;
421 const char *drv_name;
422};
423
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800424#define WPAS_MAX_SCAN_SSIDS 16
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700425
426/**
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800427 * struct wpa_driver_scan_ssid - SSIDs to scan for
428 * @ssid - specific SSID to scan for (ProbeReq)
429 * %NULL or zero-length SSID is used to indicate active scan
430 * with wildcard SSID.
431 * @ssid_len - Length of the SSID in octets
432 */
433struct wpa_driver_scan_ssid {
434 const u8 *ssid;
435 size_t ssid_len;
436};
437
438/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700439 * struct wpa_driver_scan_params - Scan parameters
440 * Data for struct wpa_driver_ops::scan2().
441 */
442struct wpa_driver_scan_params {
443 /**
444 * ssids - SSIDs to scan for
445 */
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800446 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700447
448 /**
449 * num_ssids - Number of entries in ssids array
450 * Zero indicates a request for a passive scan.
451 */
452 size_t num_ssids;
453
454 /**
455 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
456 */
457 const u8 *extra_ies;
458
459 /**
460 * extra_ies_len - Length of extra_ies in octets
461 */
462 size_t extra_ies_len;
463
464 /**
465 * freqs - Array of frequencies to scan or %NULL for all frequencies
466 *
467 * The frequency is set in MHz. The array is zero-terminated.
468 */
469 int *freqs;
470
471 /**
472 * filter_ssids - Filter for reporting SSIDs
473 *
474 * This optional parameter can be used to request the driver wrapper to
475 * filter scan results to include only the specified SSIDs. %NULL
476 * indicates that no filtering is to be done. This can be used to
477 * reduce memory needs for scan results in environments that have large
478 * number of APs with different SSIDs.
479 *
480 * The driver wrapper is allowed to take this allocated buffer into its
481 * own use by setting the pointer to %NULL. In that case, the driver
482 * wrapper is responsible for freeing the buffer with os_free() once it
483 * is not needed anymore.
484 */
485 struct wpa_driver_scan_filter {
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -0700486 u8 ssid[SSID_MAX_LEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700487 size_t ssid_len;
488 } *filter_ssids;
489
490 /**
491 * num_filter_ssids - Number of entries in filter_ssids array
492 */
493 size_t num_filter_ssids;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800494
495 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700496 * filter_rssi - Filter by RSSI
497 *
498 * The driver may filter scan results in firmware to reduce host
499 * wakeups and thereby save power. Specify the RSSI threshold in s32
500 * dBm.
501 */
502 s32 filter_rssi;
503
504 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800505 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
506 *
507 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
508 * Mbps from the support rates element(s) in the Probe Request frames
509 * and not to transmit the frames at any of those rates.
510 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700511 unsigned int p2p_probe:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800512
513 /**
514 * only_new_results - Request driver to report only new results
515 *
516 * This is used to request the driver to report only BSSes that have
517 * been detected after this scan request has been started, i.e., to
518 * flush old cached BSS entries.
519 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700520 unsigned int only_new_results:1;
521
522 /**
523 * low_priority - Requests driver to use a lower scan priority
524 *
525 * This is used to request the driver to use a lower scan priority
526 * if it supports such a thing.
527 */
528 unsigned int low_priority:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800529
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800530 /**
531 * mac_addr_rand - Requests driver to randomize MAC address
532 */
533 unsigned int mac_addr_rand:1;
534
535 /**
536 * mac_addr - MAC address used with randomization. The address cannot be
537 * a multicast one, i.e., bit 0 of byte 0 should not be set.
538 */
Hai Shalomc3565922019-10-28 11:58:20 -0700539 u8 *mac_addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800540
541 /**
542 * mac_addr_mask - MAC address mask used with randomization.
543 *
544 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
545 * the mask should be taken as is from mac_addr. The mask should not
546 * allow the generation of a multicast address, i.e., bit 0 of byte 0
547 * must be set.
548 */
549 const u8 *mac_addr_mask;
550
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800551 /**
552 * sched_scan_plans - Scan plans for scheduled scan
553 *
554 * Each scan plan consists of the number of iterations to scan and the
555 * interval between scans. When a scan plan finishes (i.e., it was run
556 * for the specified number of iterations), the next scan plan is
557 * executed. The scan plans are executed in the order they appear in
558 * the array (lower index first). The last scan plan will run infinitely
559 * (until requested to stop), thus must not specify the number of
560 * iterations. All other scan plans must specify the number of
561 * iterations.
562 */
563 struct sched_scan_plan {
564 u32 interval; /* In seconds */
565 u32 iterations; /* Zero to run infinitely */
566 } *sched_scan_plans;
567
568 /**
569 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
570 */
571 unsigned int sched_scan_plans_num;
572
Dmitry Shmidt9c175262016-03-03 10:20:07 -0800573 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700574 * sched_scan_start_delay - Delay to use before starting the first scan
575 *
576 * Delay (in seconds) before scheduling first scan plan cycle. The
577 * driver may ignore this parameter and start immediately (or at any
578 * other time), if this feature is not supported.
579 */
580 u32 sched_scan_start_delay;
581
582 /**
Dmitry Shmidt9c175262016-03-03 10:20:07 -0800583 * bssid - Specific BSSID to scan for
584 *
585 * This optional parameter can be used to replace the default wildcard
586 * BSSID with a specific BSSID to scan for if results are needed from
587 * only a single BSS.
588 */
589 const u8 *bssid;
590
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800591 /**
592 * scan_cookie - Unique identification representing the scan request
593 *
594 * This scan_cookie carries a unique identification representing the
595 * scan request if the host driver/kernel supports concurrent scan
596 * requests. This cookie is returned from the corresponding driver
597 * interface.
598 *
599 * Note: Unlike other parameters in this structure, scan_cookie is used
600 * only to return information instead of setting parameters for the
601 * scan.
602 */
603 u64 scan_cookie;
604
Dmitry Shmidt29333592017-01-09 12:27:11 -0800605 /**
606 * duration - Dwell time on each channel
607 *
608 * This optional parameter can be used to set the dwell time on each
609 * channel. In TUs.
610 */
611 u16 duration;
612
613 /**
614 * duration_mandatory - Whether the specified duration is mandatory
615 *
616 * If this is set, the duration specified by the %duration field is
617 * mandatory (and the driver should reject the scan request if it is
618 * unable to comply with the specified duration), otherwise it is the
619 * maximum duration and the actual duration may be shorter.
620 */
621 unsigned int duration_mandatory:1;
622
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800623 /**
624 * relative_rssi_set - Whether relative RSSI parameters are set
625 */
626 unsigned int relative_rssi_set:1;
627
628 /**
629 * relative_rssi - Relative RSSI for reporting better BSSs
630 *
631 * Amount of RSSI by which a BSS should be better than the current
632 * connected BSS to report the new BSS to user space.
633 */
634 s8 relative_rssi;
635
636 /**
637 * relative_adjust_band - Band to which RSSI should be adjusted
638 *
639 * The relative_adjust_rssi should be added to the band specified
640 * by relative_adjust_band.
641 */
642 enum set_band relative_adjust_band;
643
644 /**
645 * relative_adjust_rssi - RSSI to be added to relative_adjust_band
646 *
647 * An amount of relative_band_rssi should be added to the BSSs that
648 * belong to the band specified by relative_adjust_band while comparing
649 * with other bands for BSS reporting.
650 */
651 s8 relative_adjust_rssi;
652
Hai Shalomce48b4a2018-09-05 11:41:35 -0700653 /**
654 * oce_scan
655 *
656 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0)
657 * - Accept broadcast Probe Response frame.
658 * - Probe Request frame deferral and suppression.
659 * - Max Channel Time - driver fills FILS request params IE with
660 * Maximum Channel Time.
661 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps.
662 */
663 unsigned int oce_scan:1;
664
Hai Shalomc1a21442022-02-04 13:43:00 -0800665 /**
666 * p2p_include_6ghz - Include 6 GHz channels for P2P full scan
667 *
668 */
669 unsigned int p2p_include_6ghz:1;
670
Sunil8cd6f4d2022-06-28 18:40:46 +0000671 /**
672 * non_coloc_6ghz - Force scanning of non-PSC 6 GHz channels
673 *
674 * If this is set, the driver should scan non-PSC channels from the
675 * scan request even if neighbor reports from 2.4/5 GHz APs did not
676 * report a co-located AP on these channels. The default is to scan
677 * non-PSC channels only if a co-located AP was reported on the channel.
678 */
679 unsigned int non_coloc_6ghz:1;
680
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800681 /*
682 * NOTE: Whenever adding new parameters here, please make sure
683 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
684 * matching changes.
685 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700686};
687
688/**
689 * struct wpa_driver_auth_params - Authentication parameters
690 * Data for struct wpa_driver_ops::authenticate().
691 */
692struct wpa_driver_auth_params {
693 int freq;
694 const u8 *bssid;
695 const u8 *ssid;
696 size_t ssid_len;
697 int auth_alg;
698 const u8 *ie;
699 size_t ie_len;
700 const u8 *wep_key[4];
701 size_t wep_key_len[4];
702 int wep_tx_keyidx;
703 int local_state_change;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800704
705 /**
706 * p2p - Whether this connection is a P2P group
707 */
708 int p2p;
709
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800710 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800711 * auth_data - Additional elements for Authentication frame
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800712 *
713 * This buffer starts with the Authentication transaction sequence
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800714 * number field. If no special handling of such elements is needed, this
715 * pointer is %NULL. This is used with SAE and FILS.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800716 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800717 const u8 *auth_data;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800718
719 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800720 * auth_data_len - Length of auth_data buffer in octets
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800721 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800722 size_t auth_data_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700723};
724
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800725/**
726 * enum wps_mode - WPS mode
727 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700728enum wps_mode {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800729 /**
730 * WPS_MODE_NONE - No WPS provisioning being used
731 */
732 WPS_MODE_NONE,
733
734 /**
735 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
736 */
737 WPS_MODE_OPEN,
738
739 /**
740 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
741 */
742 WPS_MODE_PRIVACY
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700743};
744
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800745/**
746 * struct hostapd_freq_params - Channel parameters
747 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700748struct hostapd_freq_params {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800749 /**
750 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
751 */
752 enum hostapd_hw_mode mode;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700753
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800754 /**
755 * freq - Primary channel center frequency in MHz
756 */
757 int freq;
758
759 /**
760 * channel - Channel number
761 */
762 int channel;
763
764 /**
765 * ht_enabled - Whether HT is enabled
766 */
767 int ht_enabled;
768
769 /**
770 * sec_channel_offset - Secondary channel offset for HT40
771 *
772 * 0 = HT40 disabled,
773 * -1 = HT40 enabled, secondary channel below primary,
774 * 1 = HT40 enabled, secondary channel above primary
775 */
776 int sec_channel_offset;
777
778 /**
779 * vht_enabled - Whether VHT is enabled
780 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700781 int vht_enabled;
782
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800783 /**
Hai Shalom81f62d82019-07-22 12:10:00 -0700784 * he_enabled - Whether HE is enabled
785 */
786 int he_enabled;
787
788 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800789 * center_freq1 - Segment 0 center frequency in MHz
790 *
791 * Valid for both HT and VHT.
792 */
793 int center_freq1;
794
795 /**
796 * center_freq2 - Segment 1 center frequency in MHz
797 *
798 * Non-zero only for bandwidth 80 and an 80+80 channel
799 */
800 int center_freq2;
801
802 /**
803 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
804 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700805 int bandwidth;
Hai Shalomc3565922019-10-28 11:58:20 -0700806
807 /**
808 * This structure describes the most essential parameters needed
809 * for IEEE 802.11ay EDMG configuration.
810 */
811 struct ieee80211_edmg_config edmg;
Sunil Ravia04bd252022-05-02 22:54:18 -0700812
813 /**
814 * radar_background - Whether radar/CAC background is requested
815 */
816 bool radar_background;
817
818 /**
819 * eht_enabled - Whether EHT is enabled
820 */
821 bool eht_enabled;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700822};
823
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700824/**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700825 * struct wpa_driver_sta_auth_params - Authentication parameters
826 * Data for struct wpa_driver_ops::sta_auth().
827 */
828struct wpa_driver_sta_auth_params {
829
830 /**
831 * own_addr - Source address and BSSID for authentication frame
832 */
833 const u8 *own_addr;
834
835 /**
836 * addr - MAC address of the station to associate
837 */
838 const u8 *addr;
839
840 /**
841 * seq - authentication sequence number
842 */
843 u16 seq;
844
845 /**
846 * status - authentication response status code
847 */
848 u16 status;
849
850 /**
851 * ie - authentication frame ie buffer
852 */
853 const u8 *ie;
854
855 /**
856 * len - ie buffer length
857 */
858 size_t len;
859
860 /**
861 * fils_auth - Indicates whether FILS authentication is being performed
862 */
863 int fils_auth;
864
865 /**
866 * fils_anonce - ANonce (required for FILS)
867 */
868 u8 fils_anonce[WPA_NONCE_LEN];
869
870 /**
871 * fils_snonce - SNonce (required for FILS)
872 */
873 u8 fils_snonce[WPA_NONCE_LEN];
874
875 /**
876 * fils_kek - key for encryption (required for FILS)
877 */
878 u8 fils_kek[WPA_KEK_MAX_LEN];
879
880 /**
881 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
882 */
883 size_t fils_kek_len;
884};
885
886/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700887 * struct wpa_driver_associate_params - Association parameters
888 * Data for struct wpa_driver_ops::associate().
889 */
890struct wpa_driver_associate_params {
891 /**
892 * bssid - BSSID of the selected AP
893 * This can be %NULL, if ap_scan=2 mode is used and the driver is
894 * responsible for selecting with which BSS to associate. */
895 const u8 *bssid;
896
897 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800898 * bssid_hint - BSSID of a proposed AP
899 *
900 * This indicates which BSS has been found a suitable candidate for
901 * initial association for drivers that use driver/firmwate-based BSS
902 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
903 * the driver from selecting other BSSes in the ESS.
904 */
905 const u8 *bssid_hint;
906
907 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700908 * ssid - The selected SSID
909 */
910 const u8 *ssid;
911
912 /**
913 * ssid_len - Length of the SSID (1..32)
914 */
915 size_t ssid_len;
916
917 /**
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700918 * freq - channel parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700919 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700920 struct hostapd_freq_params freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700921
922 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800923 * freq_hint - Frequency of the channel the proposed AP is using
924 *
925 * This provides a channel on which a suitable BSS has been found as a
926 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
927 * limit the driver from selecting other channels for
928 * driver/firmware-based BSS selection.
929 */
930 int freq_hint;
931
932 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700933 * bg_scan_period - Background scan period in seconds, 0 to disable
934 * background scan, or -1 to indicate no change to default driver
935 * configuration
936 */
937 int bg_scan_period;
938
939 /**
Dmitry Shmidt2ac5f602014-03-07 10:08:21 -0800940 * beacon_int - Beacon interval for IBSS or 0 to use driver default
941 */
942 int beacon_int;
943
944 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700945 * wpa_ie - WPA information element for (Re)Association Request
946 * WPA information element to be included in (Re)Association
947 * Request (including information element id and length). Use
948 * of this WPA IE is optional. If the driver generates the WPA
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700949 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700950 * key_mgmt_suite to select proper algorithms. In this case,
951 * the driver has to notify wpa_supplicant about the used WPA
952 * IE by generating an event that the interface code will
953 * convert into EVENT_ASSOCINFO data (see below).
954 *
955 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
956 * instead. The driver can determine which version is used by
957 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
958 * WPA2/RSN).
959 *
960 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
961 */
962 const u8 *wpa_ie;
963
964 /**
965 * wpa_ie_len - length of the wpa_ie
966 */
967 size_t wpa_ie_len;
968
969 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800970 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
971 */
972 unsigned int wpa_proto;
973
974 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800975 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700976 *
977 * This is usually ignored if @wpa_ie is used.
978 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800979 unsigned int pairwise_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700980
981 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800982 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700983 *
984 * This is usually ignored if @wpa_ie is used.
985 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800986 unsigned int group_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700987
988 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700989 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
990 *
991 * This is usually ignored if @wpa_ie is used.
992 */
993 unsigned int mgmt_group_suite;
994
995 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800996 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700997 *
998 * This is usually ignored if @wpa_ie is used.
999 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001000 unsigned int key_mgmt_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001001
1002 /**
Sunil Ravi89eba102022-09-13 21:04:37 -07001003 * allowed_key_mgmts - Bitfield of allowed key management suites
1004 * (WPA_KEY_MGMT_*) other than @key_mgmt_suite for the current
1005 * connection
1006 *
1007 * SME in the driver may choose key_mgmt from this list for the initial
1008 * connection or roaming. The driver which doesn't support this
1009 * ignores this parameter.
1010 */
1011 unsigned int allowed_key_mgmts;
1012
1013 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001014 * auth_alg - Allowed authentication algorithms
1015 * Bit field of WPA_AUTH_ALG_*
1016 */
1017 int auth_alg;
1018
1019 /**
1020 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
1021 */
1022 int mode;
1023
1024 /**
1025 * wep_key - WEP keys for static WEP configuration
1026 */
1027 const u8 *wep_key[4];
1028
1029 /**
1030 * wep_key_len - WEP key length for static WEP configuration
1031 */
1032 size_t wep_key_len[4];
1033
1034 /**
1035 * wep_tx_keyidx - WEP TX key index for static WEP configuration
1036 */
1037 int wep_tx_keyidx;
1038
1039 /**
1040 * mgmt_frame_protection - IEEE 802.11w management frame protection
1041 */
1042 enum mfp_options mgmt_frame_protection;
1043
1044 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001045 * passphrase - RSN passphrase for PSK
1046 *
1047 * This value is made available only for WPA/WPA2-Personal (PSK) and
Hai Shalom74f70d42019-02-11 14:42:39 -08001048 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
1049 * is the 8..63 character ASCII passphrase, if available. Please note
1050 * that this can be %NULL if passphrase was not used to generate the
1051 * PSK. In that case, the psk field must be used to fetch the PSK.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001052 */
1053 const char *passphrase;
1054
1055 /**
1056 * psk - RSN PSK (alternative for passphrase for PSK)
1057 *
1058 * This value is made available only for WPA/WPA2-Personal (PSK) and
Hai Shalom74f70d42019-02-11 14:42:39 -08001059 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
1060 * is the 32-octet (256-bit) PSK, if available. The driver wrapper
1061 * should be prepared to handle %NULL value as an error.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001062 */
1063 const u8 *psk;
1064
1065 /**
1066 * drop_unencrypted - Enable/disable unencrypted frame filtering
1067 *
1068 * Configure the driver to drop all non-EAPOL frames (both receive and
1069 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
1070 * still be allowed for key negotiation.
1071 */
1072 int drop_unencrypted;
1073
1074 /**
1075 * prev_bssid - Previously used BSSID in this ESS
1076 *
1077 * When not %NULL, this is a request to use reassociation instead of
1078 * association.
1079 */
1080 const u8 *prev_bssid;
1081
1082 /**
1083 * wps - WPS mode
1084 *
1085 * If the driver needs to do special configuration for WPS association,
1086 * this variable provides more information on what type of association
Sunil Ravia04bd252022-05-02 22:54:18 -07001087 * is being requested. Most drivers should not need to use this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001088 */
1089 enum wps_mode wps;
1090
1091 /**
1092 * p2p - Whether this connection is a P2P group
1093 */
1094 int p2p;
1095
1096 /**
1097 * uapsd - UAPSD parameters for the network
1098 * -1 = do not change defaults
1099 * AP mode: 1 = enabled, 0 = disabled
1100 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
1101 */
1102 int uapsd;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001103
1104 /**
1105 * fixed_bssid - Whether to force this BSSID in IBSS mode
1106 * 1 = Fix this BSSID and prevent merges.
1107 * 0 = Do not fix BSSID.
1108 */
1109 int fixed_bssid;
1110
1111 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001112 * fixed_freq - Fix control channel in IBSS mode
1113 * 0 = don't fix control channel (default)
1114 * 1 = fix control channel; this prevents IBSS merging with another
1115 * channel
1116 */
1117 int fixed_freq;
1118
1119 /**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001120 * disable_ht - Disable HT (IEEE 802.11n) for this connection
1121 */
1122 int disable_ht;
1123
1124 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001125 * htcaps - HT Capabilities over-rides
1126 *
1127 * Only bits set in the mask will be used, and not all values are used
1128 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
1129 *
1130 * Pointer to struct ieee80211_ht_capabilities.
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001131 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001132 const u8 *htcaps;
1133
1134 /**
1135 * htcaps_mask - HT Capabilities over-rides mask
1136 *
1137 * Pointer to struct ieee80211_ht_capabilities.
1138 */
1139 const u8 *htcaps_mask;
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001140
1141#ifdef CONFIG_VHT_OVERRIDES
1142 /**
1143 * disable_vht - Disable VHT for this connection
1144 */
1145 int disable_vht;
1146
1147 /**
1148 * VHT capability overrides.
1149 */
1150 const struct ieee80211_vht_capabilities *vhtcaps;
1151 const struct ieee80211_vht_capabilities *vhtcaps_mask;
1152#endif /* CONFIG_VHT_OVERRIDES */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001153
Hai Shalomfdcde762020-04-02 11:19:20 -07001154#ifdef CONFIG_HE_OVERRIDES
1155 /**
1156 * disable_he - Disable HE for this connection
1157 */
1158 int disable_he;
1159#endif /* CONFIG_HE_OVERRIDES */
1160
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001161 /**
1162 * req_key_mgmt_offload - Request key management offload for connection
1163 *
1164 * Request key management offload for this connection if the device
1165 * supports it.
1166 */
1167 int req_key_mgmt_offload;
1168
1169 /**
Hai Shalomc3565922019-10-28 11:58:20 -07001170 * req_handshake_offload - Request EAPOL handshake offload
1171 *
1172 * Request EAPOL handshake offload for this connection if the device
1173 * supports it.
1174 */
1175 int req_handshake_offload;
1176
1177 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001178 * Flag for indicating whether this association includes support for
1179 * RRM (Radio Resource Measurements)
1180 */
1181 int rrm_used;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001182
1183 /**
1184 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1185 * AP as usual. Valid for DMG network only.
1186 */
1187 int pbss;
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001188
1189 /**
1190 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1191 */
1192 const u8 *fils_kek;
1193
1194 /**
1195 * fils_kek_len: Length of fils_kek in bytes
1196 */
1197 size_t fils_kek_len;
1198
1199 /**
1200 * fils_nonces - Nonces for FILS association frame protection
1201 * (AES-SIV AAD)
1202 */
1203 const u8 *fils_nonces;
1204
1205 /**
1206 * fils_nonces_len: Length of fils_nonce in bytes
1207 */
1208 size_t fils_nonces_len;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001209
1210 /**
1211 * fils_erp_username - Username part of keyName-NAI
1212 */
1213 const u8 *fils_erp_username;
1214
1215 /**
1216 * fils_erp_username_len - Length of fils_erp_username in bytes
1217 */
1218 size_t fils_erp_username_len;
1219
1220 /**
1221 * fils_erp_realm - Realm/domain name to use in FILS ERP
1222 */
1223 const u8 *fils_erp_realm;
1224
1225 /**
1226 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1227 */
1228 size_t fils_erp_realm_len;
1229
1230 /**
1231 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1232 * messages
1233 */
1234 u16 fils_erp_next_seq_num;
1235
1236 /**
1237 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1238 * specified by fils_erp_username@fils_erp_realm.
1239 */
1240 const u8 *fils_erp_rrk;
1241
1242 /**
1243 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1244 */
1245 size_t fils_erp_rrk_len;
Hai Shalom60840252021-02-19 19:02:11 -08001246
1247 /**
1248 * sae_pwe - SAE mechanism for PWE derivation
1249 * 0 = hunting-and-pecking loop only
1250 * 1 = hash-to-element only
1251 * 2 = both hunting-and-pecking loop and hash-to-element enabled
1252 */
1253 int sae_pwe;
Vinayak Yadawade62409f2022-01-20 12:32:07 +05301254#ifdef CONFIG_DRIVER_NL80211_BRCM
1255 /**
1256 * td_policy - Transition Disable Policy
1257 */
1258 u32 td_policy;
1259#endif /* CONFIG_DRIVER_NL80211_BRCM */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001260};
1261
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001262enum hide_ssid {
1263 NO_SSID_HIDING,
1264 HIDDEN_SSID_ZERO_LEN,
1265 HIDDEN_SSID_ZERO_CONTENTS
1266};
1267
Hai Shalom81f62d82019-07-22 12:10:00 -07001268enum ch_switch_state {
1269 CH_SW_STARTED,
1270 CH_SW_FINISHED
1271};
1272
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001273struct wowlan_triggers {
1274 u8 any;
1275 u8 disconnect;
1276 u8 magic_pkt;
1277 u8 gtk_rekey_failure;
1278 u8 eap_identity_req;
1279 u8 four_way_handshake;
1280 u8 rfkill_release;
1281};
1282
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001283struct wpa_driver_ap_params {
1284 /**
1285 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1286 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001287 u8 *head;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001288
1289 /**
1290 * head_len - Length of the head buffer in octets
1291 */
1292 size_t head_len;
1293
1294 /**
1295 * tail - Beacon tail following TIM IE
1296 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001297 u8 *tail;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001298
1299 /**
1300 * tail_len - Length of the tail buffer in octets
1301 */
1302 size_t tail_len;
1303
1304 /**
1305 * dtim_period - DTIM period
1306 */
1307 int dtim_period;
1308
1309 /**
1310 * beacon_int - Beacon interval
1311 */
1312 int beacon_int;
1313
1314 /**
1315 * basic_rates: -1 terminated array of basic rates in 100 kbps
1316 *
1317 * This parameter can be used to set a specific basic rate set for the
1318 * BSS. If %NULL, default basic rate set is used.
1319 */
1320 int *basic_rates;
1321
1322 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001323 * beacon_rate: Beacon frame data rate
1324 *
1325 * This parameter can be used to set a specific Beacon frame data rate
1326 * for the BSS. The interpretation of this value depends on the
Hai Shalom60840252021-02-19 19:02:11 -08001327 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS,
1328 * HE: HE-MCS). If beacon_rate == 0 and rate_type == 0
1329 * (BEACON_RATE_LEGACY), the default Beacon frame data rate is used.
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001330 */
1331 unsigned int beacon_rate;
1332
1333 /**
Hai Shalom60840252021-02-19 19:02:11 -08001334 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT/HE)
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001335 */
1336 enum beacon_rate_type rate_type;
1337
1338 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001339 * proberesp - Probe Response template
1340 *
1341 * This is used by drivers that reply to Probe Requests internally in
1342 * AP mode and require the full Probe Response template.
1343 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001344 u8 *proberesp;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001345
1346 /**
1347 * proberesp_len - Length of the proberesp buffer in octets
1348 */
1349 size_t proberesp_len;
1350
1351 /**
1352 * ssid - The SSID to use in Beacon/Probe Response frames
1353 */
1354 const u8 *ssid;
1355
1356 /**
1357 * ssid_len - Length of the SSID (1..32)
1358 */
1359 size_t ssid_len;
1360
1361 /**
1362 * hide_ssid - Whether to hide the SSID
1363 */
1364 enum hide_ssid hide_ssid;
1365
1366 /**
1367 * pairwise_ciphers - WPA_CIPHER_* bitfield
1368 */
1369 unsigned int pairwise_ciphers;
1370
1371 /**
1372 * group_cipher - WPA_CIPHER_*
1373 */
1374 unsigned int group_cipher;
1375
1376 /**
1377 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1378 */
1379 unsigned int key_mgmt_suites;
1380
1381 /**
1382 * auth_algs - WPA_AUTH_ALG_* bitfield
1383 */
1384 unsigned int auth_algs;
1385
1386 /**
1387 * wpa_version - WPA_PROTO_* bitfield
1388 */
1389 unsigned int wpa_version;
1390
1391 /**
1392 * privacy - Whether privacy is used in the BSS
1393 */
1394 int privacy;
1395
1396 /**
1397 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1398 *
1399 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1400 * not use the full Beacon template.
1401 */
1402 const struct wpabuf *beacon_ies;
1403
1404 /**
1405 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1406 *
1407 * This is used to add IEs like WPS IE and P2P IE by drivers that
1408 * reply to Probe Request frames internally.
1409 */
1410 const struct wpabuf *proberesp_ies;
1411
1412 /**
1413 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1414 *
1415 * This is used to add IEs like WPS IE by drivers that reply to
1416 * (Re)Association Request frames internally.
1417 */
1418 const struct wpabuf *assocresp_ies;
1419
1420 /**
1421 * isolate - Whether to isolate frames between associated stations
1422 *
1423 * If this is non-zero, the AP is requested to disable forwarding of
1424 * frames between associated stations.
1425 */
1426 int isolate;
1427
1428 /**
1429 * cts_protect - Whether CTS protection is enabled
1430 */
1431 int cts_protect;
1432
1433 /**
1434 * preamble - Whether short preamble is enabled
1435 */
1436 int preamble;
1437
1438 /**
1439 * short_slot_time - Whether short slot time is enabled
1440 *
1441 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1442 * not set (e.g., when 802.11g mode is not in use)
1443 */
1444 int short_slot_time;
1445
1446 /**
1447 * ht_opmode - HT operation mode or -1 if HT not in use
1448 */
1449 int ht_opmode;
1450
1451 /**
1452 * interworking - Whether Interworking is enabled
1453 */
1454 int interworking;
1455
1456 /**
1457 * hessid - Homogeneous ESS identifier or %NULL if not set
1458 */
1459 const u8 *hessid;
1460
1461 /**
1462 * access_network_type - Access Network Type (0..15)
1463 *
1464 * This is used for filtering Probe Request frames when Interworking is
1465 * enabled.
1466 */
1467 u8 access_network_type;
Dmitry Shmidt04949592012-07-19 12:16:46 -07001468
1469 /**
1470 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1471 *
1472 * This is used by driver which advertises this capability.
1473 */
1474 int ap_max_inactivity;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001475
1476 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001477 * ctwindow - Client Traffic Window (in TUs)
1478 */
1479 u8 p2p_go_ctwindow;
1480
1481 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001482 * disable_dgaf - Whether group-addressed frames are disabled
1483 */
1484 int disable_dgaf;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001485
1486 /**
1487 * osen - Whether OSEN security is enabled
1488 */
1489 int osen;
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001490
1491 /**
1492 * freq - Channel parameters for dynamic bandwidth changes
1493 */
1494 struct hostapd_freq_params *freq;
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001495
1496 /**
1497 * reenable - Whether this is to re-enable beaconing
1498 */
1499 int reenable;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001500
1501 /**
1502 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1503 * infrastructure BSS. Valid only for DMG network.
1504 */
1505 int pbss;
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001506
1507 /**
1508 * multicast_to_unicast - Whether to use multicast_to_unicast
1509 *
1510 * If this is non-zero, the AP is requested to perform multicast to
1511 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1512 * 802.1Q). If enabled, such frames are to be sent to each station
1513 * separately, with the DA replaced by their own MAC address rather
1514 * than the group address.
1515 *
1516 * Note that this may break certain expectations of the receiver, such
1517 * as the ability to drop unicast IP packets received within multicast
1518 * L2 frames, or the ability to not send ICMP destination unreachable
1519 * messages for packets received in L2 multicast (which is required,
1520 * but the receiver can't tell the difference if this new option is
1521 * enabled.)
1522 *
1523 * This also doesn't implement the 802.11 DMS (directed multicast
1524 * service).
1525 */
1526 int multicast_to_unicast;
Hai Shalom74f70d42019-02-11 14:42:39 -08001527
1528 /**
1529 * ftm_responder - Whether FTM responder is enabled
1530 */
1531 int ftm_responder;
1532
1533 /**
1534 * lci - Binary data, the content of an LCI report IE with type 8 as
1535 * defined in IEEE Std 802.11-2016, 9.4.2.22.10
1536 */
1537 const struct wpabuf *lci;
1538
1539 /**
1540 * civic - Binary data, the content of a measurement report IE with
1541 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
1542 */
1543 const struct wpabuf *civic;
Hai Shalomc3565922019-10-28 11:58:20 -07001544
1545 /**
Hai Shalom60840252021-02-19 19:02:11 -08001546 * he_spr_ctrl - Spatial Reuse control field of SPR element
Hai Shalomc3565922019-10-28 11:58:20 -07001547 */
Hai Shalom60840252021-02-19 19:02:11 -08001548 u8 he_spr_ctrl;
1549
1550 /**
1551 * he_spr_non_srg_obss_pd_max_offset - Non-SRG Maximum TX power offset
1552 */
1553 u8 he_spr_non_srg_obss_pd_max_offset;
Hai Shalomc3565922019-10-28 11:58:20 -07001554
1555 /**
1556 * he_spr_srg_obss_pd_min_offset - Minimum TX power offset
1557 */
Hai Shalom60840252021-02-19 19:02:11 -08001558 u8 he_spr_srg_obss_pd_min_offset;
Hai Shalomc3565922019-10-28 11:58:20 -07001559
1560 /**
1561 * he_spr_srg_obss_pd_max_offset - Maximum TX power offset
1562 */
Hai Shalom60840252021-02-19 19:02:11 -08001563 u8 he_spr_srg_obss_pd_max_offset;
1564
1565 /**
1566 * he_spr_bss_color_bitmap - BSS color values used by members of the
1567 * SRG.
1568 */
1569 u8 he_spr_bss_color_bitmap[8];
1570
1571 /**
1572 * he_spr_partial_bssid_bitmap - Partial BSSID values used by members
1573 * of the SRG.
1574 */
1575 u8 he_spr_partial_bssid_bitmap[8];
Hai Shalomfdcde762020-04-02 11:19:20 -07001576
1577 /**
1578 * he_bss_color - Whether the BSS Color is disabled
1579 */
1580 int he_bss_color_disabled;
1581
1582 /**
1583 * he_bss_color_partial - The BSS Color AID equation
1584 */
1585 int he_bss_color_partial;
1586
1587 /**
1588 * he_bss_color - The BSS Color of the AP
1589 */
1590 int he_bss_color;
1591
1592 /**
1593 * twt_responder - Whether Target Wait Time responder is enabled
1594 */
1595 int twt_responder;
Hai Shalom60840252021-02-19 19:02:11 -08001596
1597 /**
1598 * sae_pwe - SAE mechanism for PWE derivation
1599 * 0 = hunting-and-pecking loop only
1600 * 1 = hash-to-element only
1601 * 2 = both hunting-and-pecking loop and hash-to-element enabled
1602 */
1603 int sae_pwe;
1604
1605 /**
1606 * FILS Discovery frame minimum interval in TUs
1607 */
1608 u32 fd_min_int;
1609
1610 /**
1611 * FILS Discovery frame maximum interval in TUs (0 = FD frame disabled)
1612 */
1613 u32 fd_max_int;
1614
1615 /**
1616 * FILS Discovery frame template data
1617 */
1618 u8 *fd_frame_tmpl;
1619
1620 /**
1621 * FILS Discovery frame template length
1622 */
1623 size_t fd_frame_tmpl_len;
1624
1625 /**
1626 * Unsolicited broadcast Probe Response interval in TUs
1627 */
1628 unsigned int unsol_bcast_probe_resp_interval;
1629
1630 /**
1631 * Unsolicited broadcast Probe Response template data
1632 */
1633 u8 *unsol_bcast_probe_resp_tmpl;
1634
1635 /**
1636 * Unsolicited broadcast Probe Response template length
1637 */
1638 size_t unsol_bcast_probe_resp_tmpl_len;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001639};
1640
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001641struct wpa_driver_mesh_bss_params {
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001642#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1643#define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1644#define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1645#define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001646#define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010
Hai Shalomc1a21442022-02-04 13:43:00 -08001647#define WPA_DRIVER_MESH_CONF_FLAG_FORWARDING 0x00000020
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001648 /*
1649 * TODO: Other mesh configuration parameters would go here.
1650 * See NL80211_MESHCONF_* for all the mesh config parameters.
1651 */
1652 unsigned int flags;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001653 int auto_plinks;
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001654 int peer_link_timeout;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001655 int max_peer_links;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001656 int rssi_threshold;
Hai Shalomc1a21442022-02-04 13:43:00 -08001657 int forwarding;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001658 u16 ht_opmode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001659};
1660
1661struct wpa_driver_mesh_join_params {
1662 const u8 *meshid;
1663 int meshid_len;
1664 const int *basic_rates;
1665 const u8 *ies;
1666 int ie_len;
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001667 struct hostapd_freq_params freq;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001668 int beacon_int;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001669 int dtim_period;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001670 struct wpa_driver_mesh_bss_params conf;
1671#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1672#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1673#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1674#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1675 unsigned int flags;
Hai Shalom60840252021-02-19 19:02:11 -08001676 bool handle_dfs;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001677};
1678
Hai Shalomfdcde762020-04-02 11:19:20 -07001679struct wpa_driver_set_key_params {
1680 /**
1681 * ifname - Interface name (for multi-SSID/VLAN support) */
1682 const char *ifname;
1683
1684 /**
1685 * alg - Encryption algorithm
1686 *
1687 * (%WPA_ALG_NONE, %WPA_ALG_WEP, %WPA_ALG_TKIP, %WPA_ALG_CCMP,
Hai Shalom4fbc08f2020-05-18 12:37:00 -07001688 * %WPA_ALG_BIP_AES_CMAC_128, %WPA_ALG_GCMP, %WPA_ALG_GCMP_256,
1689 * %WPA_ALG_CCMP_256, %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1690 * %WPA_ALG_BIP_CMAC_256);
Hai Shalomfdcde762020-04-02 11:19:20 -07001691 * %WPA_ALG_NONE clears the key. */
1692 enum wpa_alg alg;
1693
1694 /**
1695 * addr - Address of the peer STA
1696 *
1697 * (BSSID of the current AP when setting pairwise key in station mode),
1698 * ff:ff:ff:ff:ff:ff for broadcast keys, %NULL for default keys that
1699 * are used both for broadcast and unicast; when clearing keys, %NULL
1700 * is used to indicate that both the broadcast-only and default key of
1701 * the specified key index is to be cleared */
1702 const u8 *addr;
1703
1704 /**
1705 * key_idx - Key index
1706 *
1707 * (0..3), usually 0 for unicast keys; 4..5 for IGTK; 6..7 for BIGTK */
1708 int key_idx;
1709
1710 /**
1711 * set_tx - Configure this key as the default Tx key
1712 *
1713 * Only used when driver does not support separate unicast/individual
1714 * key */
1715 int set_tx;
1716
1717 /**
1718 * seq - Sequence number/packet number
1719 *
1720 * seq_len octets, the next packet number to be used for in replay
1721 * protection; configured for Rx keys (in most cases, this is only used
1722 * with broadcast keys and set to zero for unicast keys); %NULL if not
1723 * set */
1724 const u8 *seq;
1725
1726 /**
1727 * seq_len - Length of the seq, depends on the algorithm
1728 *
1729 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets */
1730 size_t seq_len;
1731
1732 /**
1733 * key - Key buffer
1734 *
1735 * TKIP: 16-byte temporal key, 8-byte Tx Mic key, 8-byte Rx Mic Key */
1736 const u8 *key;
1737
1738 /**
1739 * key_len - Length of the key buffer in octets
1740 *
1741 * WEP: 5 or 13, TKIP: 32, CCMP/GCMP: 16, IGTK: 16 */
1742 size_t key_len;
1743
1744 /**
1745 * vlan_id - VLAN index (0..4095) for VLAN offload cases */
1746 int vlan_id;
1747
1748 /**
1749 * key_flag - Additional key flags
1750 *
1751 * %KEY_FLAG_MODIFY
1752 * Set when an already installed key must be updated.
1753 * So far the only use-case is changing RX/TX status for
1754 * pairwise keys. Must not be set when deleting a key.
1755 * %KEY_FLAG_DEFAULT
1756 * Set when the key is also a default key. Must not be set when
1757 * deleting a key.
1758 * %KEY_FLAG_RX
1759 * The key is valid for RX. Must not be set when deleting a key.
1760 * %KEY_FLAG_TX
1761 * The key is valid for TX. Must not be set when deleting a key.
1762 * %KEY_FLAG_GROUP
1763 * The key is a broadcast or group key.
1764 * %KEY_FLAG_PAIRWISE
1765 * The key is a pairwise key.
1766 * %KEY_FLAG_PMK
1767 * The key is a Pairwise Master Key (PMK).
1768 *
1769 * Valid and pre-defined combinations are:
1770 * %KEY_FLAG_GROUP_RX_TX
1771 * WEP key not to be installed as default key.
1772 * %KEY_FLAG_GROUP_RX_TX_DEFAULT
1773 * Default WEP or WPA-NONE key.
1774 * %KEY_FLAG_GROUP_RX
1775 * GTK key valid for RX only.
1776 * %KEY_FLAG_GROUP_TX_DEFAULT
1777 * GTK key valid for TX only, immediately taking over TX.
1778 * %KEY_FLAG_PAIRWISE_RX_TX
1779 * Pairwise key immediately becoming the active pairwise key.
1780 * %KEY_FLAG_PAIRWISE_RX
1781 * Pairwise key not yet valid for TX. (Only usable when Extended
1782 * Key ID is supported by the driver.)
1783 * %KEY_FLAG_PAIRWISE_RX_TX_MODIFY
1784 * Enable TX for a pairwise key installed with
1785 * KEY_FLAG_PAIRWISE_RX.
1786 *
1787 * Not a valid standalone key type but pre-defined to be combined
1788 * with other key_flags:
1789 * %KEY_FLAG_RX_TX
1790 * RX/TX key. */
1791 enum key_flag key_flag;
1792};
1793
Hai Shalom4fbc08f2020-05-18 12:37:00 -07001794enum wpa_driver_if_type {
1795 /**
1796 * WPA_IF_STATION - Station mode interface
1797 */
1798 WPA_IF_STATION,
1799
1800 /**
1801 * WPA_IF_AP_VLAN - AP mode VLAN interface
1802 *
1803 * This interface shares its address and Beacon frame with the main
1804 * BSS.
1805 */
1806 WPA_IF_AP_VLAN,
1807
1808 /**
1809 * WPA_IF_AP_BSS - AP mode BSS interface
1810 *
1811 * This interface has its own address and Beacon frame.
1812 */
1813 WPA_IF_AP_BSS,
1814
1815 /**
1816 * WPA_IF_P2P_GO - P2P Group Owner
1817 */
1818 WPA_IF_P2P_GO,
1819
1820 /**
1821 * WPA_IF_P2P_CLIENT - P2P Client
1822 */
1823 WPA_IF_P2P_CLIENT,
1824
1825 /**
1826 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1827 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1828 */
1829 WPA_IF_P2P_GROUP,
1830
1831 /**
Sunil Ravia04bd252022-05-02 22:54:18 -07001832 * WPA_IF_P2P_DEVICE - P2P Device interface is used to identify the
Hai Shalom4fbc08f2020-05-18 12:37:00 -07001833 * abstracted P2P Device function in the driver
1834 */
1835 WPA_IF_P2P_DEVICE,
1836
1837 /*
1838 * WPA_IF_MESH - Mesh interface
1839 */
1840 WPA_IF_MESH,
1841
1842 /*
1843 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1844 */
1845 WPA_IF_TDLS,
1846
1847 /*
1848 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1849 */
1850 WPA_IF_IBSS,
1851
1852 /*
1853 * WPA_IF_NAN - NAN Device
1854 */
1855 WPA_IF_NAN,
1856
1857 /* keep last */
1858 WPA_IF_MAX
1859};
1860
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001861/**
1862 * struct wpa_driver_capa - Driver capability information
1863 */
1864struct wpa_driver_capa {
1865#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1866#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1867#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1868#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1869#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1870#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1871#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001872#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001873#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1874#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001875#define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
1876#define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
1877#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1878#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1879#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1880#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
Hai Shalom74f70d42019-02-11 14:42:39 -08001881#define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000
Tanmay Garga7fd80d2020-05-18 15:52:44 +05301882#define WPA_DRIVER_CAPA_KEY_MGMT_802_1X_SHA256 0x00020000
1883#define WPA_DRIVER_CAPA_KEY_MGMT_PSK_SHA256 0x00040000
1884#define WPA_DRIVER_CAPA_KEY_MGMT_TPK_HANDSHAKE 0x00080000
1885#define WPA_DRIVER_CAPA_KEY_MGMT_FT_SAE 0x00100000
1886#define WPA_DRIVER_CAPA_KEY_MGMT_FT_802_1X_SHA384 0x00200000
1887#define WPA_DRIVER_CAPA_KEY_MGMT_CCKM 0x00400000
1888#define WPA_DRIVER_CAPA_KEY_MGMT_OSEN 0x00800000
Sunil Ravi89eba102022-09-13 21:04:37 -07001889#define WPA_DRIVER_CAPA_KEY_MGMT_SAE_EXT_KEY 0x01000000
1890#define WPA_DRIVER_CAPA_KEY_MGMT_FT_SAE_EXT_KEY 0x02000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001891 /** Bitfield of supported key management suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001892 unsigned int key_mgmt;
Hai Shalom4fbc08f2020-05-18 12:37:00 -07001893 unsigned int key_mgmt_iftype[WPA_IF_MAX];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001894
1895#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1896#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1897#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1898#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
Dmitry Shmidt04949592012-07-19 12:16:46 -07001899#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001900#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001901#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1902#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1903#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1904#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1905#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1906#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001907#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001908 /** Bitfield of supported cipher suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001909 unsigned int enc;
1910
1911#define WPA_DRIVER_AUTH_OPEN 0x00000001
1912#define WPA_DRIVER_AUTH_SHARED 0x00000002
1913#define WPA_DRIVER_AUTH_LEAP 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001914 /** Bitfield of supported IEEE 802.11 authentication algorithms */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001915 unsigned int auth;
1916
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001917/** Driver generated WPA/RSN IE */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001918#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001919/** Driver needs static WEP key setup after association command */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001920#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001921/** Driver takes care of all DFS operations */
Dmitry Shmidtd11f0192014-03-24 12:09:47 -07001922#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001923/** Driver takes care of RSN 4-way handshake internally; PMK is configured with
Hai Shalomfdcde762020-04-02 11:19:20 -07001924 * struct wpa_driver_ops::set_key using key_flag = KEY_FLAG_PMK */
Hai Shalom74f70d42019-02-11 14:42:39 -08001925#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001926/** Driver is for a wired Ethernet interface */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001927#define WPA_DRIVER_FLAGS_WIRED 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001928/** Driver provides separate commands for authentication and association (SME in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001929 * wpa_supplicant). */
1930#define WPA_DRIVER_FLAGS_SME 0x00000020
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001931/** Driver supports AP mode */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001932#define WPA_DRIVER_FLAGS_AP 0x00000040
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001933/** Driver needs static WEP key setup after association has been completed */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001934#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001935/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001936#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001937/** Driver supports concurrent P2P operations */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001938#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001939/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001940 * Driver uses the initial interface as a dedicated management interface, i.e.,
1941 * it cannot be used for P2P group operations or non-P2P purposes.
1942 */
1943#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001944/** This interface is P2P capable (P2P GO or P2P Client) */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001945#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001946/** Driver supports station and key removal when stopping an AP */
Dmitry Shmidta38abf92014-03-06 13:38:44 -08001947#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001948/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001949 * Driver uses the initial interface for P2P management interface and non-P2P
1950 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1951 * P2P group operations.
1952 */
1953#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001954/**
Hai Shalomc1a21442022-02-04 13:43:00 -08001955 * Driver is known to use valid error codes, i.e., when it indicates that
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001956 * something (e.g., association) fails, there was indeed a failure and the
1957 * operation does not end up getting completed successfully later.
1958 */
Hai Shalomc1a21442022-02-04 13:43:00 -08001959#define WPA_DRIVER_FLAGS_VALID_ERROR_CODES 0x00004000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001960/** Driver supports off-channel TX */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001961#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001962/** Driver indicates TX status events for EAPOL Data frames */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001963#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001964/** Driver indicates TX status events for Deauth/Disassoc frames */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001965#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001966/** Driver supports roaming (BSS selection) in firmware */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001967#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001968/** Driver supports operating as a TDLS peer */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001969#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001970/** Driver requires external TDLS setup/teardown/discovery */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001971#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001972/** Driver indicates support for Probe Response offloading in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001973#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001974/** Driver supports U-APSD in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001975#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001976/** Driver supports inactivity timer in AP mode */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001977#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001978/** Driver expects user space implementation of MLME in AP mode */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001979#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001980/** Driver supports SAE with user space SME */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001981#define WPA_DRIVER_FLAGS_SAE 0x02000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001982/** Driver makes use of OBSS scan mechanism in wpa_supplicant */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001983#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001984/** Driver supports IBSS (Ad-hoc) mode */
Dmitry Shmidt700a1372013-03-15 14:14:44 -07001985#define WPA_DRIVER_FLAGS_IBSS 0x08000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001986/** Driver supports radar detection */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07001987#define WPA_DRIVER_FLAGS_RADAR 0x10000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001988/** Driver supports a dedicated interface for P2P Device */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001989#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001990/** Driver supports QoS Mapping */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001991#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001992/** Driver supports CSA in AP mode */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001993#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001994/** Driver supports mesh */
1995#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1996/** Driver support ACS offload */
1997#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1998/** Driver supports key management offload */
1999#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
2000/** Driver supports TDLS channel switching */
2001#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
Dmitry Shmidtff787d52015-01-12 13:01:47 -08002002/** Driver supports IBSS with HT datarates */
2003#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
Dmitry Shmidt7f656022015-02-25 14:36:37 -08002004/** Driver supports IBSS with VHT datarates */
2005#define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07002006/** Driver supports automatic band selection */
2007#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002008/** Driver supports simultaneous off-channel operations */
2009#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002010/** Driver supports full AP client state */
2011#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07002012/** Driver supports P2P Listen offload */
2013#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08002014/** Driver supports FILS */
2015#define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08002016/** Driver supports Beacon frame TX rate configuration (legacy rates) */
2017#define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
2018/** Driver supports Beacon frame TX rate configuration (HT rates) */
2019#define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
2020/** Driver supports Beacon frame TX rate configuration (VHT rates) */
2021#define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08002022/** Driver supports mgmt_tx with random TX address in non-connected state */
2023#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
2024/** Driver supports mgmt_tx with random TX addr in connected state */
2025#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
2026/** Driver supports better BSS reporting with sched_scan in connected mode */
2027#define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
2028/** Driver supports HE capabilities */
2029#define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002030/** Driver supports FILS shared key offload */
2031#define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
2032/** Driver supports all OCE STA specific mandatory features */
2033#define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
2034/** Driver supports all OCE AP specific mandatory features */
2035#define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
2036/**
2037 * Driver supports all OCE STA-CFON specific mandatory features only.
2038 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
2039 * userspace shall assume that this driver may not support all OCE AP
2040 * functionality but can support only OCE STA-CFON functionality.
2041 */
2042#define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
Roshan Pius3a1667e2018-07-03 15:17:14 -07002043/** Driver supports MFP-optional in the connect command */
2044#define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL
Hai Shalom39ba6fc2019-01-22 12:40:38 -08002045/** Driver is a self-managed regulatory device */
2046#define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL
Hai Shalom74f70d42019-02-11 14:42:39 -08002047/** Driver supports FTM responder functionality */
2048#define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL
2049/** Driver support 4-way handshake offload for WPA-Personal */
2050#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
Hai Shalomb755a2a2020-04-23 21:49:02 -07002051/** Driver supports a separate control port TX for EAPOL frames */
Hai Shalomfdcde762020-04-02 11:19:20 -07002052#define WPA_DRIVER_FLAGS_CONTROL_PORT 0x0400000000000000ULL
2053/** Driver supports VLAN offload */
2054#define WPA_DRIVER_FLAGS_VLAN_OFFLOAD 0x0800000000000000ULL
2055/** Driver supports UPDATE_FT_IES command */
2056#define WPA_DRIVER_FLAGS_UPDATE_FT_IES 0x1000000000000000ULL
2057/** Driver can correctly rekey PTKs without Extended Key ID */
2058#define WPA_DRIVER_FLAGS_SAFE_PTK0_REKEYS 0x2000000000000000ULL
2059/** Driver supports Beacon protection */
2060#define WPA_DRIVER_FLAGS_BEACON_PROTECTION 0x4000000000000000ULL
2061/** Driver supports Extended Key ID */
2062#define WPA_DRIVER_FLAGS_EXTENDED_KEY_ID 0x8000000000000000ULL
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002063 u64 flags;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002064
Hai Shalomb755a2a2020-04-23 21:49:02 -07002065/** Driver supports a separate control port RX for EAPOL frames */
2066#define WPA_DRIVER_FLAGS2_CONTROL_PORT_RX 0x0000000000000001ULL
Hai Shalom899fcc72020-10-19 14:38:18 -07002067/** Driver supports TX status reports for EAPOL frames through control port */
2068#define WPA_DRIVER_FLAGS2_CONTROL_PORT_TX_STATUS 0x0000000000000002ULL
Sunil Ravi89eba102022-09-13 21:04:37 -07002069/** Driver supports secure LTF in AP mode */
2070#define WPA_DRIVER_FLAGS2_SEC_LTF_AP 0x0000000000000004ULL
2071/** Driver supports secure RTT measurement exchange in AP mode */
2072#define WPA_DRIVER_FLAGS2_SEC_RTT_AP 0x0000000000000008ULL
Hai Shalom60840252021-02-19 19:02:11 -08002073/**
2074 * Driver supports protection of range negotiation and measurement management
Sunil Ravi89eba102022-09-13 21:04:37 -07002075 * frames in AP mode
Hai Shalom60840252021-02-19 19:02:11 -08002076 */
Sunil Ravi89eba102022-09-13 21:04:37 -07002077#define WPA_DRIVER_FLAGS2_PROT_RANGE_NEG_AP 0x0000000000000010ULL
Hai Shalom60840252021-02-19 19:02:11 -08002078/** Driver supports Beacon frame TX rate configuration (HE rates) */
2079#define WPA_DRIVER_FLAGS2_BEACON_RATE_HE 0x0000000000000020ULL
2080/** Driver supports Beacon protection only in client mode */
2081#define WPA_DRIVER_FLAGS2_BEACON_PROTECTION_CLIENT 0x0000000000000040ULL
2082/** Driver supports Operating Channel Validation */
2083#define WPA_DRIVER_FLAGS2_OCV 0x0000000000000080ULL
2084/** Driver expects user space implementation of SME in AP mode */
2085#define WPA_DRIVER_FLAGS2_AP_SME 0x0000000000000100ULL
Sunil Ravia04bd252022-05-02 22:54:18 -07002086/** Driver handles SA Query procedures in AP mode */
2087#define WPA_DRIVER_FLAGS2_SA_QUERY_OFFLOAD_AP 0x0000000000000200ULL
2088/** Driver supports background radar/CAC detection */
2089#define WPA_DRIVER_RADAR_BACKGROUND 0x0000000000000400ULL
Sunil Ravi89eba102022-09-13 21:04:37 -07002090/** Driver supports secure LTF in STA mode */
2091#define WPA_DRIVER_FLAGS2_SEC_LTF_STA 0x0000000000000800ULL
2092/** Driver supports secure RTT measurement exchange in STA mode */
2093#define WPA_DRIVER_FLAGS2_SEC_RTT_STA 0x0000000000001000ULL
2094/**
2095 * Driver supports protection of range negotiation and measurement management
2096 * frames in STA mode
2097 */
2098#define WPA_DRIVER_FLAGS2_PROT_RANGE_NEG_STA 0x0000000000002000ULL
Hai Shalomb755a2a2020-04-23 21:49:02 -07002099 u64 flags2;
2100
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002101#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
2102 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
2103
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002104 unsigned int wmm_ac_supported:1;
2105
2106 unsigned int mac_addr_rand_scan_supported:1;
2107 unsigned int mac_addr_rand_sched_scan_supported:1;
2108
2109 /** Maximum number of supported active probe SSIDs */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002110 int max_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002111
2112 /** Maximum number of supported active probe SSIDs for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002113 int max_sched_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002114
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08002115 /** Maximum number of supported scan plans for scheduled scan */
2116 unsigned int max_sched_scan_plans;
2117
2118 /** Maximum interval in a scan plan. In seconds */
2119 u32 max_sched_scan_plan_interval;
2120
2121 /** Maximum number of iterations in a single scan plan */
2122 u32 max_sched_scan_plan_iterations;
2123
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002124 /** Whether sched_scan (offloaded scanning) is supported */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002125 int sched_scan_supported;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002126
2127 /** Maximum number of supported match sets for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002128 int max_match_sets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002129
2130 /**
2131 * max_remain_on_chan - Maximum remain-on-channel duration in msec
2132 */
2133 unsigned int max_remain_on_chan;
2134
2135 /**
2136 * max_stations - Maximum number of associated stations the driver
2137 * supports in AP mode
2138 */
2139 unsigned int max_stations;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002140
2141 /**
2142 * probe_resp_offloads - Bitmap of supported protocols by the driver
2143 * for Probe Response offloading.
2144 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002145/** Driver Probe Response offloading support for WPS ver. 1 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002146#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002147/** Driver Probe Response offloading support for WPS ver. 2 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002148#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002149/** Driver Probe Response offloading support for P2P */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002150#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002151/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002152#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
2153 unsigned int probe_resp_offloads;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07002154
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002155 unsigned int max_acl_mac_addrs;
2156
Dmitry Shmidt444d5672013-04-01 13:08:44 -07002157 /**
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07002158 * Number of supported concurrent channels
2159 */
2160 unsigned int num_multichan_concurrent;
2161
2162 /**
Dmitry Shmidt444d5672013-04-01 13:08:44 -07002163 * extended_capa - extended capabilities in driver/device
2164 *
2165 * Must be allocated and freed by driver and the pointers must be
2166 * valid for the lifetime of the driver, i.e., freed in deinit()
2167 */
2168 const u8 *extended_capa, *extended_capa_mask;
2169 unsigned int extended_capa_len;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07002170
2171 struct wowlan_triggers wowlan_triggers;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002172
2173/** Driver adds the DS Params Set IE in Probe Request frames */
2174#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
2175/** Driver adds the WFA TPC IE in Probe Request frames */
2176#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
2177/** Driver handles quiet period requests */
2178#define WPA_DRIVER_FLAGS_QUIET 0x00000004
2179/**
2180 * Driver is capable of inserting the current TX power value into the body of
2181 * transmitted frames.
2182 * Background: Some Action frames include a TPC Report IE. This IE contains a
2183 * TX power field, which has to be updated by lower layers. One such Action
2184 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
2185 * of spectrum management). Note that this insertion takes place at a fixed
2186 * offset, namely the 6th byte in the Action frame body.
2187 */
2188#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
Dmitry Shmidt849734c2016-05-27 09:59:01 -07002189/**
2190 * Driver supports RRM. With this support, the driver will accept to use RRM in
2191 * (Re)Association Request frames, without supporting quiet period.
2192 */
2193#define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
2194
Dmitry Shmidt29333592017-01-09 12:27:11 -08002195/** Driver supports setting the scan dwell time */
2196#define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
2197/** Driver supports Beacon Report Measurement */
2198#define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
2199
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002200 u32 rrm_flags;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002201
2202 /* Driver concurrency capabilities */
2203 unsigned int conc_capab;
2204 /* Maximum number of concurrent channels on 2.4 GHz */
2205 unsigned int max_conc_chan_2_4;
2206 /* Maximum number of concurrent channels on 5 GHz */
2207 unsigned int max_conc_chan_5_0;
2208
2209 /* Maximum number of supported CSA counters */
2210 u16 max_csa_counters;
Sunil Ravi89eba102022-09-13 21:04:37 -07002211
2212 /* Maximum number of supported AKM suites in commands */
2213 unsigned int max_num_akms;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002214};
2215
2216
2217struct hostapd_data;
2218
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002219#define STA_DRV_DATA_TX_MCS BIT(0)
2220#define STA_DRV_DATA_RX_MCS BIT(1)
2221#define STA_DRV_DATA_TX_VHT_MCS BIT(2)
2222#define STA_DRV_DATA_RX_VHT_MCS BIT(3)
2223#define STA_DRV_DATA_TX_VHT_NSS BIT(4)
2224#define STA_DRV_DATA_RX_VHT_NSS BIT(5)
2225#define STA_DRV_DATA_TX_SHORT_GI BIT(6)
2226#define STA_DRV_DATA_RX_SHORT_GI BIT(7)
Roshan Pius3a1667e2018-07-03 15:17:14 -07002227#define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
Hai Shalomc1a21442022-02-04 13:43:00 -08002228#define STA_DRV_DATA_CONN_TIME BIT(9)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002229
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002230struct hostap_sta_driver_data {
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002231 unsigned long rx_packets, tx_packets;
2232 unsigned long long rx_bytes, tx_bytes;
Hai Shalom81f62d82019-07-22 12:10:00 -07002233 unsigned long long rx_airtime, tx_airtime;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002234 int bytes_64bit; /* whether 64-bit byte counters are supported */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002235 unsigned long current_tx_rate;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002236 unsigned long current_rx_rate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002237 unsigned long inactive_msec;
Hai Shalomc1a21442022-02-04 13:43:00 -08002238 unsigned long connected_sec;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002239 unsigned long flags; /* bitfield of STA_DRV_DATA_* */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002240 unsigned long num_ps_buf_frames;
2241 unsigned long tx_retry_failed;
2242 unsigned long tx_retry_count;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002243 s8 last_ack_rssi;
Hai Shalom81f62d82019-07-22 12:10:00 -07002244 unsigned long backlog_packets;
2245 unsigned long backlog_bytes;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002246 s8 signal;
2247 u8 rx_vhtmcs;
2248 u8 tx_vhtmcs;
2249 u8 rx_mcs;
2250 u8 tx_mcs;
2251 u8 rx_vht_nss;
2252 u8 tx_vht_nss;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002253};
2254
2255struct hostapd_sta_add_params {
2256 const u8 *addr;
2257 u16 aid;
2258 u16 capability;
2259 const u8 *supp_rates;
2260 size_t supp_rates_len;
2261 u16 listen_interval;
2262 const struct ieee80211_ht_capabilities *ht_capabilities;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08002263 const struct ieee80211_vht_capabilities *vht_capabilities;
Dmitry Shmidtbd14a572014-02-18 10:33:49 -08002264 int vht_opmode_enabled;
2265 u8 vht_opmode;
Hai Shalom81f62d82019-07-22 12:10:00 -07002266 const struct ieee80211_he_capabilities *he_capab;
2267 size_t he_capab_len;
Hai Shalom4fbc08f2020-05-18 12:37:00 -07002268 const struct ieee80211_he_6ghz_band_cap *he_6ghz_capab;
Sunil Ravia04bd252022-05-02 22:54:18 -07002269 const struct ieee80211_eht_capabilities *eht_capab;
2270 size_t eht_capab_len;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002271 u32 flags; /* bitmask of WPA_STA_* flags */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002272 u32 flags_mask; /* unset bits in flags */
2273#ifdef CONFIG_MESH
2274 enum mesh_plink_state plink_state;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07002275 u16 peer_aid;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002276#endif /* CONFIG_MESH */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002277 int set; /* Set STA parameters instead of add */
2278 u8 qosinfo;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08002279 const u8 *ext_capab;
2280 size_t ext_capab_len;
Dmitry Shmidt344abd32014-01-14 13:17:00 -08002281 const u8 *supp_channels;
2282 size_t supp_channels_len;
2283 const u8 *supp_oper_classes;
2284 size_t supp_oper_classes_len;
Dmitry Shmidt849734c2016-05-27 09:59:01 -07002285 int support_p2p_ps;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002286};
2287
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002288struct mac_address {
2289 u8 addr[ETH_ALEN];
2290};
2291
2292struct hostapd_acl_params {
2293 u8 acl_policy;
2294 unsigned int num_mac_acl;
2295 struct mac_address mac_acl[0];
2296};
2297
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002298struct wpa_init_params {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002299 void *global_priv;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002300 const u8 *bssid;
2301 const char *ifname;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002302 const char *driver_params;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002303 int use_pae_group_addr;
2304 char **bridge;
2305 size_t num_bridge;
2306
2307 u8 *own_addr; /* buffer for writing own MAC address */
2308};
2309
2310
2311struct wpa_bss_params {
2312 /** Interface name (for multi-SSID/VLAN support) */
2313 const char *ifname;
2314 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
2315 int enabled;
2316
2317 int wpa;
2318 int ieee802_1x;
2319 int wpa_group;
2320 int wpa_pairwise;
2321 int wpa_key_mgmt;
2322 int rsn_preauth;
2323 enum mfp_options ieee80211w;
2324};
2325
2326#define WPA_STA_AUTHORIZED BIT(0)
2327#define WPA_STA_WMM BIT(1)
2328#define WPA_STA_SHORT_PREAMBLE BIT(2)
2329#define WPA_STA_MFP BIT(3)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002330#define WPA_STA_TDLS_PEER BIT(4)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002331#define WPA_STA_AUTHENTICATED BIT(5)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002332#define WPA_STA_ASSOCIATED BIT(6)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002333
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002334enum tdls_oper {
2335 TDLS_DISCOVERY_REQ,
2336 TDLS_SETUP,
2337 TDLS_TEARDOWN,
2338 TDLS_ENABLE_LINK,
2339 TDLS_DISABLE_LINK,
2340 TDLS_ENABLE,
2341 TDLS_DISABLE
2342};
2343
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002344enum wnm_oper {
2345 WNM_SLEEP_ENTER_CONFIRM,
2346 WNM_SLEEP_ENTER_FAIL,
2347 WNM_SLEEP_EXIT_CONFIRM,
2348 WNM_SLEEP_EXIT_FAIL,
2349 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
2350 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
2351 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
2352 * a STA */
2353 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
2354 * for a STA */
2355 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
2356 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
2357 * for a STA */
2358 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
2359};
2360
Roshan Pius3a1667e2018-07-03 15:17:14 -07002361/* enum smps_mode - SMPS mode definitions */
2362enum smps_mode {
2363 SMPS_AUTOMATIC,
2364 SMPS_OFF,
2365 SMPS_DYNAMIC,
2366 SMPS_STATIC,
2367
2368 /* Keep last */
2369 SMPS_INVALID,
2370};
2371
Hai Shalom74f70d42019-02-11 14:42:39 -08002372#define WPA_INVALID_NOISE 9999
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002373
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002374/**
2375 * struct wpa_signal_info - Information about channel signal quality
Hai Shalom74f70d42019-02-11 14:42:39 -08002376 * @frequency: control frequency
2377 * @above_threshold: true if the above threshold was crossed
2378 * (relevant for a CQM event)
2379 * @current_signal: in dBm
2380 * @avg_signal: in dBm
2381 * @avg_beacon_signal: in dBm
2382 * @current_noise: %WPA_INVALID_NOISE if not supported
2383 * @current_txrate: current TX rate
2384 * @chanwidth: channel width
2385 * @center_frq1: center frequency for the first segment
2386 * @center_frq2: center frequency for the second segment (if relevant)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002387 */
2388struct wpa_signal_info {
2389 u32 frequency;
2390 int above_threshold;
2391 int current_signal;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002392 int avg_signal;
Dmitry Shmidtf73259c2015-03-17 11:00:54 -07002393 int avg_beacon_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002394 int current_noise;
2395 int current_txrate;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002396 enum chan_width chanwidth;
2397 int center_frq1;
2398 int center_frq2;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002399};
2400
Sunil Ravi89eba102022-09-13 21:04:37 -07002401struct wpa_mlo_signal_info {
2402 u16 valid_links;
2403 struct wpa_signal_info links[MAX_NUM_MLD_LINKS];
2404};
2405
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002406/**
Hai Shalom74f70d42019-02-11 14:42:39 -08002407 * struct wpa_channel_info - Information about the current channel
2408 * @frequency: Center frequency of the primary 20 MHz channel
2409 * @chanwidth: Width of the current operating channel
2410 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
2411 * This field is only filled in when using a 40 MHz channel.
2412 * @center_frq1: Center frequency of frequency segment 0
2413 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
2414 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
2415 * derived from center_frq2 for convenience.
2416 */
2417struct wpa_channel_info {
2418 u32 frequency;
2419 enum chan_width chanwidth;
2420 int sec_channel;
2421 int center_frq1;
2422 int center_frq2;
2423 u8 seg1_idx;
2424};
2425
2426/**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002427 * struct beacon_data - Beacon data
2428 * @head: Head portion of Beacon frame (before TIM IE)
2429 * @tail: Tail portion of Beacon frame (after TIM IE)
2430 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2431 * @proberesp_ies: Extra information element(s) to add into Probe Response
2432 * frames or %NULL
2433 * @assocresp_ies: Extra information element(s) to add into (Re)Association
2434 * Response frames or %NULL
2435 * @probe_resp: Probe Response frame template
2436 * @head_len: Length of @head
2437 * @tail_len: Length of @tail
2438 * @beacon_ies_len: Length of beacon_ies in octets
2439 * @proberesp_ies_len: Length of proberesp_ies in octets
2440 * @proberesp_ies_len: Length of proberesp_ies in octets
2441 * @probe_resp_len: Length of probe response template (@probe_resp)
2442 */
2443struct beacon_data {
2444 u8 *head, *tail;
2445 u8 *beacon_ies;
2446 u8 *proberesp_ies;
2447 u8 *assocresp_ies;
2448 u8 *probe_resp;
2449
2450 size_t head_len, tail_len;
2451 size_t beacon_ies_len;
2452 size_t proberesp_ies_len;
2453 size_t assocresp_ies_len;
2454 size_t probe_resp_len;
2455};
2456
2457/**
2458 * struct csa_settings - Settings for channel switch command
2459 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2460 * @block_tx: 1 - block transmission for CSA period
2461 * @freq_params: Next channel frequency parameter
2462 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2463 * @beacon_after: Next beacon/probe resp/asooc resp info
2464 * @counter_offset_beacon: Offset to the count field in beacon's tail
2465 * @counter_offset_presp: Offset to the count field in probe resp.
2466 */
2467struct csa_settings {
2468 u8 cs_count;
2469 u8 block_tx;
2470
2471 struct hostapd_freq_params freq_params;
2472 struct beacon_data beacon_csa;
2473 struct beacon_data beacon_after;
2474
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002475 u16 counter_offset_beacon[2];
2476 u16 counter_offset_presp[2];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002477};
2478
Sunil Ravia04bd252022-05-02 22:54:18 -07002479/**
2480 * struct cca_settings - Settings for color switch command
2481 * @cca_count: Count in Beacon frames (TBTT) to perform the switch
2482 * @cca_color: The new color that we are switching to
2483 * @beacon_cca: Beacon/Probe Response/(Re)Association Response frame info for
2484 * color switch period
2485 * @beacon_after: Next Beacon/Probe Response/(Re)Association Response frame info
2486 * @counter_offset_beacon: Offset to the count field in Beacon frame tail
2487 * @counter_offset_presp: Offset to the count field in Probe Response frame
2488 */
2489struct cca_settings {
2490 u8 cca_count;
2491 u8 cca_color;
2492
2493 struct beacon_data beacon_cca;
2494 struct beacon_data beacon_after;
2495
2496 u16 counter_offset_beacon;
2497 u16 counter_offset_presp;
2498};
2499
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002500/* TDLS peer capabilities for send_tdls_mgmt() */
2501enum tdls_peer_capability {
2502 TDLS_PEER_HT = BIT(0),
2503 TDLS_PEER_VHT = BIT(1),
2504 TDLS_PEER_WMM = BIT(2),
Hai Shalomc1a21442022-02-04 13:43:00 -08002505 TDLS_PEER_HE = BIT(3),
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002506};
2507
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002508/* valid info in the wmm_params struct */
2509enum wmm_params_valid_info {
2510 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
2511};
2512
2513/**
2514 * struct wmm_params - WMM parameterss configured for this association
2515 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2516 * of the struct contain valid information.
2517 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2518 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2519 */
2520struct wmm_params {
2521 u8 info_bitmap;
2522 u8 uapsd_queues;
2523};
2524
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002525#ifdef CONFIG_MACSEC
2526struct macsec_init_params {
Hai Shalome21d4e82020-04-29 16:34:06 -07002527 bool always_include_sci;
2528 bool use_es;
2529 bool use_scb;
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002530};
2531#endif /* CONFIG_MACSEC */
2532
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002533enum drv_br_port_attr {
2534 DRV_BR_PORT_ATTR_PROXYARP,
2535 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
2536};
2537
2538enum drv_br_net_param {
2539 DRV_BR_NET_PARAM_GARP_ACCEPT,
Dmitry Shmidt83474442015-04-15 13:47:09 -07002540 DRV_BR_MULTICAST_SNOOPING,
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002541};
2542
2543struct drv_acs_params {
2544 /* Selected mode (HOSTAPD_MODE_*) */
2545 enum hostapd_hw_mode hw_mode;
2546
2547 /* Indicates whether HT is enabled */
2548 int ht_enabled;
2549
2550 /* Indicates whether HT40 is enabled */
2551 int ht40_enabled;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07002552
2553 /* Indicates whether VHT is enabled */
2554 int vht_enabled;
2555
2556 /* Configured ACS channel width */
2557 u16 ch_width;
2558
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08002559 /* ACS frequency list info */
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002560 const int *freq_list;
Hai Shalomfdcde762020-04-02 11:19:20 -07002561
2562 /* Indicates whether EDMG is enabled */
2563 int edmg_enabled;
Sunil Ravia04bd252022-05-02 22:54:18 -07002564
2565 /* Indicates whether EHT is enabled */
2566 bool eht_enabled;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002567};
2568
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002569struct wpa_bss_trans_info {
2570 u8 mbo_transition_reason;
2571 u8 n_candidates;
2572 u8 *bssid;
2573};
2574
2575struct wpa_bss_candidate_info {
2576 u8 num;
2577 struct candidate_list {
2578 u8 bssid[ETH_ALEN];
2579 u8 is_accept;
2580 u32 reject_reason;
2581 } *candidates;
2582};
2583
2584struct wpa_pmkid_params {
2585 const u8 *bssid;
2586 const u8 *ssid;
2587 size_t ssid_len;
2588 const u8 *fils_cache_id;
2589 const u8 *pmkid;
2590 const u8 *pmk;
2591 size_t pmk_len;
Hai Shalomfdcde762020-04-02 11:19:20 -07002592 u32 pmk_lifetime;
2593 u8 pmk_reauth_threshold;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002594};
2595
2596/* Mask used to specify which connection parameters have to be updated */
2597enum wpa_drv_update_connect_params_mask {
2598 WPA_DRV_UPDATE_ASSOC_IES = BIT(0),
2599 WPA_DRV_UPDATE_FILS_ERP_INFO = BIT(1),
2600 WPA_DRV_UPDATE_AUTH_TYPE = BIT(2),
Vinayak Yadawade62409f2022-01-20 12:32:07 +05302601#ifdef CONFIG_DRIVER_NL80211_BRCM
2602 WPA_DRV_UPDATE_TD_POLICY = BIT(3),
2603#endif /* CONFIG_DRIVER_NL80211_BRCM */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002604};
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002605
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002606/**
Roshan Pius3a1667e2018-07-03 15:17:14 -07002607 * struct external_auth - External authentication trigger parameters
2608 *
2609 * These are used across the external authentication request and event
2610 * interfaces.
2611 * @action: Action type / trigger for external authentication. Only significant
2612 * for the event interface.
2613 * @bssid: BSSID of the peer with which the authentication has to happen. Used
2614 * by both the request and event interface.
2615 * @ssid: SSID of the AP. Used by both the request and event interface.
2616 * @ssid_len: SSID length in octets.
2617 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2618 * the request interface.
2619 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2620 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2621 * the real status code for failures. Used only for the request interface
2622 * from user space to the driver.
Hai Shalom5f92bc92019-04-18 11:54:11 -07002623 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
Roshan Pius3a1667e2018-07-03 15:17:14 -07002624 */
2625struct external_auth {
2626 enum {
2627 EXT_AUTH_START,
2628 EXT_AUTH_ABORT,
2629 } action;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002630 const u8 *bssid;
2631 const u8 *ssid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002632 size_t ssid_len;
2633 unsigned int key_mgmt_suite;
2634 u16 status;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002635 const u8 *pmkid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002636};
2637
Sunil Ravi89eba102022-09-13 21:04:37 -07002638#define WPAS_MAX_PASN_PEERS 10
2639
2640enum pasn_status {
2641 PASN_STATUS_SUCCESS = 0,
2642 PASN_STATUS_FAILURE = 1,
2643};
2644
2645/**
2646 * struct pasn_peer - PASN peer parameters
2647 *
2648 * Used to process the PASN authentication event from the driver to
2649 * userspace and to send a response back.
2650 * @own_addr: Own MAC address specified by the driver to use for PASN
2651 * handshake.
2652 * @peer_addr: MAC address of the peer with which PASN authentication is to be
2653 * performed.
2654 * @network_id: Unique id for the network.
2655 * This identifier is used as a unique identifier for each network
2656 * block when using the control interface. Each network is allocated an
2657 * id when it is being created, either when reading the configuration
2658 * file or when a new network is added through the control interface.
2659 * @akmp: Authentication key management protocol type supported.
2660 * @cipher: Cipher suite.
2661 * @group: Finite cyclic group. Default group used is 19 (ECC).
2662 * @ltf_keyseed_required: Indicates whether LTF keyseed generation is required
2663 * @status: PASN response status, %PASN_STATUS_SUCCESS for successful
2664 * authentication, use %PASN_STATUS_FAILURE if PASN authentication
2665 * fails or if wpa_supplicant fails to set the security ranging context to
2666 * the driver
2667 */
2668struct pasn_peer {
2669 u8 own_addr[ETH_ALEN];
2670 u8 peer_addr[ETH_ALEN];
2671 int network_id;
2672 int akmp;
2673 int cipher;
2674 int group;
2675 bool ltf_keyseed_required;
2676 enum pasn_status status;
2677};
2678
2679/**
2680 * struct pasn_auth - PASN authentication trigger parameters
2681 *
2682 * These are used across the PASN authentication event from the driver to
2683 * userspace and to send a response to it.
2684 * @action: Action type. Only significant for the event interface.
2685 * @num_peers: The number of peers for which the PASN handshake is requested
2686 * for.
2687 * @peer: Holds the peer details.
2688 */
2689struct pasn_auth {
2690 enum {
2691 PASN_ACTION_AUTH,
2692 PASN_ACTION_DELETE_SECURE_RANGING_CONTEXT,
2693 } action;
2694 unsigned int num_peers;
2695 struct pasn_peer peer[WPAS_MAX_PASN_PEERS];
2696};
2697
2698/**
2699 * struct secure_ranging_params - Parameters required to set secure ranging
2700 * context for a peer.
2701 *
2702 * @action: Add or delete a security context to the driver.
2703 * @own_addr: Own MAC address used during key derivation.
2704 * @peer_addr: Address of the peer device.
2705 * @cipher: Cipher suite.
2706 * @tk_len: Length of temporal key.
2707 * @tk: Temporal key buffer.
2708 * @ltf_keyseed_len: Length of LTF keyseed.
2709 * @ltf_keyeed: LTF keyseed buffer.
2710 */
2711struct secure_ranging_params {
2712 u32 action;
2713 const u8 *own_addr;
2714 const u8 *peer_addr;
2715 u32 cipher;
2716 u8 tk_len;
2717 const u8 *tk;
2718 u8 ltf_keyseed_len;
2719 const u8 *ltf_keyseed;
2720};
2721
Hai Shalom60840252021-02-19 19:02:11 -08002722/* enum nested_attr - Used to specify if subcommand uses nested attributes */
2723enum nested_attr {
2724 NESTED_ATTR_NOT_USED = 0,
2725 NESTED_ATTR_USED = 1,
2726 NESTED_ATTR_UNSPECIFIED = 2,
2727};
2728
Sunil8cd6f4d2022-06-28 18:40:46 +00002729/* Preferred channel list information */
2730
2731/* GO role */
2732#define WEIGHTED_PCL_GO BIT(0)
2733/* P2P Client role */
2734#define WEIGHTED_PCL_CLI BIT(1)
2735/* Must be considered for operating channel */
2736#define WEIGHTED_PCL_MUST_CONSIDER BIT(2)
2737/* Should be excluded in GO negotiation */
2738#define WEIGHTED_PCL_EXCLUDE BIT(3)
2739
2740/* Preferred channel list with weight */
2741struct weighted_pcl {
2742 u32 freq; /* MHz */
2743 u8 weight;
2744 u32 flag; /* bitmap for WEIGHTED_PCL_* */
2745};
2746
Sunil Ravi89eba102022-09-13 21:04:37 -07002747struct driver_sta_mlo_info {
2748 u16 valid_links; /* bitmap of valid link IDs */
2749 u8 ap_mld_addr[ETH_ALEN];
2750 struct {
2751 u8 addr[ETH_ALEN];
2752 u8 bssid[ETH_ALEN];
2753 unsigned int freq;
2754 } links[MAX_NUM_MLD_LINKS];
2755};
2756
Roshan Pius3a1667e2018-07-03 15:17:14 -07002757/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002758 * struct wpa_driver_ops - Driver interface API definition
2759 *
2760 * This structure defines the API that each driver interface needs to implement
2761 * for core wpa_supplicant code. All driver specific functionality is captured
2762 * in this wrapper.
2763 */
2764struct wpa_driver_ops {
2765 /** Name of the driver interface */
2766 const char *name;
2767 /** One line description of the driver interface */
2768 const char *desc;
2769
2770 /**
2771 * get_bssid - Get the current BSSID
2772 * @priv: private driver interface data
2773 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2774 *
2775 * Returns: 0 on success, -1 on failure
2776 *
2777 * Query kernel driver for the current BSSID and copy it to bssid.
2778 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2779 * associated.
2780 */
2781 int (*get_bssid)(void *priv, u8 *bssid);
2782
2783 /**
2784 * get_ssid - Get the current SSID
2785 * @priv: private driver interface data
2786 * @ssid: buffer for SSID (at least 32 bytes)
2787 *
2788 * Returns: Length of the SSID on success, -1 on failure
2789 *
2790 * Query kernel driver for the current SSID and copy it to ssid.
2791 * Returning zero is recommended if the STA is not associated.
2792 *
2793 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2794 * can, at least in theory, contain control characters (including nul)
2795 * and as such, should be processed as binary data, not a printable
2796 * string.
2797 */
2798 int (*get_ssid)(void *priv, u8 *ssid);
2799
2800 /**
2801 * set_key - Configure encryption key
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002802 * @priv: private driver interface data
Hai Shalomfdcde762020-04-02 11:19:20 -07002803 * @params: Key parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002804 * Returns: 0 on success, -1 on failure
2805 *
2806 * Configure the given key for the kernel driver. If the driver
2807 * supports separate individual keys (4 default keys + 1 individual),
2808 * addr can be used to determine whether the key is default or
2809 * individual. If only 4 keys are supported, the default key with key
2810 * index 0 is used as the individual key. STA must be configured to use
2811 * it as the default Tx key (set_tx is set) and accept Rx for all the
2812 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2813 * broadcast keys, so key index 0 is available for this kind of
2814 * configuration.
2815 *
2816 * Please note that TKIP keys include separate TX and RX MIC keys and
2817 * some drivers may expect them in different order than wpa_supplicant
2818 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
2819 * will trigger Michael MIC errors. This can be fixed by changing the
Sunil Ravia04bd252022-05-02 22:54:18 -07002820 * order of MIC keys by swapping the bytes 16..23 and 24..31 of the key
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002821 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2822 * example on how this can be done.
2823 */
Hai Shalomfdcde762020-04-02 11:19:20 -07002824 int (*set_key)(void *priv, struct wpa_driver_set_key_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002825
2826 /**
2827 * init - Initialize driver interface
2828 * @ctx: context to be used when calling wpa_supplicant functions,
2829 * e.g., wpa_supplicant_event()
2830 * @ifname: interface name, e.g., wlan0
2831 *
2832 * Returns: Pointer to private data, %NULL on failure
2833 *
2834 * Initialize driver interface, including event processing for kernel
2835 * driver events (e.g., associated, scan results, Michael MIC failure).
2836 * This function can allocate a private configuration data area for
2837 * @ctx, file descriptor, interface name, etc. information that may be
2838 * needed in future driver operations. If this is not used, non-NULL
2839 * value will need to be returned because %NULL is used to indicate
2840 * failure. The returned value will be used as 'void *priv' data for
2841 * all other driver_ops functions.
2842 *
2843 * The main event loop (eloop.c) of wpa_supplicant can be used to
2844 * register callback for read sockets (eloop_register_read_sock()).
2845 *
2846 * See below for more information about events and
2847 * wpa_supplicant_event() function.
2848 */
2849 void * (*init)(void *ctx, const char *ifname);
2850
2851 /**
2852 * deinit - Deinitialize driver interface
2853 * @priv: private driver interface data from init()
2854 *
2855 * Shut down driver interface and processing of driver events. Free
2856 * private data buffer if one was allocated in init() handler.
2857 */
2858 void (*deinit)(void *priv);
2859
2860 /**
2861 * set_param - Set driver configuration parameters
2862 * @priv: private driver interface data from init()
2863 * @param: driver specific configuration parameters
2864 *
2865 * Returns: 0 on success, -1 on failure
2866 *
2867 * Optional handler for notifying driver interface about configuration
2868 * parameters (driver_param).
2869 */
2870 int (*set_param)(void *priv, const char *param);
2871
2872 /**
2873 * set_countermeasures - Enable/disable TKIP countermeasures
2874 * @priv: private driver interface data
2875 * @enabled: 1 = countermeasures enabled, 0 = disabled
2876 *
2877 * Returns: 0 on success, -1 on failure
2878 *
2879 * Configure TKIP countermeasures. When these are enabled, the driver
2880 * should drop all received and queued frames that are using TKIP.
2881 */
2882 int (*set_countermeasures)(void *priv, int enabled);
2883
2884 /**
2885 * deauthenticate - Request driver to deauthenticate
2886 * @priv: private driver interface data
2887 * @addr: peer address (BSSID of the AP)
2888 * @reason_code: 16-bit reason code to be sent in the deauthentication
2889 * frame
2890 *
2891 * Returns: 0 on success, -1 on failure
2892 */
Hai Shalom81f62d82019-07-22 12:10:00 -07002893 int (*deauthenticate)(void *priv, const u8 *addr, u16 reason_code);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002894
2895 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002896 * associate - Request driver to associate
2897 * @priv: private driver interface data
2898 * @params: association parameters
2899 *
2900 * Returns: 0 on success, -1 on failure
2901 */
2902 int (*associate)(void *priv,
2903 struct wpa_driver_associate_params *params);
2904
2905 /**
2906 * add_pmkid - Add PMKSA cache entry to the driver
2907 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002908 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002909 *
2910 * Returns: 0 on success, -1 on failure
2911 *
2912 * This function is called when a new PMK is received, as a result of
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002913 * either normal authentication or RSN pre-authentication. The PMKSA
2914 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2915 * ssid, fils_cache_id, pmkid, and pmk.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002916 *
2917 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2918 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2919 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2920 * driver_ops function does not need to be implemented. Likewise, if
2921 * the driver does not support WPA, this function is not needed.
2922 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002923 int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002924
2925 /**
2926 * remove_pmkid - Remove PMKSA cache entry to the driver
2927 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002928 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002929 *
2930 * Returns: 0 on success, -1 on failure
2931 *
2932 * This function is called when the supplicant drops a PMKSA cache
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002933 * entry for any reason. The PMKSA parameters are either a set of
2934 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002935 *
2936 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2937 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2938 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2939 * from wpa_supplicant, this driver_ops function does not need to be
2940 * implemented. Likewise, if the driver does not support WPA, this
2941 * function is not needed.
2942 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002943 int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002944
2945 /**
2946 * flush_pmkid - Flush PMKSA cache
2947 * @priv: private driver interface data
2948 *
2949 * Returns: 0 on success, -1 on failure
2950 *
2951 * This function is called when the supplicant drops all PMKSA cache
2952 * entries for any reason.
2953 *
2954 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2955 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2956 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2957 * from wpa_supplicant, this driver_ops function does not need to be
2958 * implemented. Likewise, if the driver does not support WPA, this
2959 * function is not needed.
2960 */
2961 int (*flush_pmkid)(void *priv);
2962
2963 /**
2964 * get_capa - Get driver capabilities
2965 * @priv: private driver interface data
2966 *
2967 * Returns: 0 on success, -1 on failure
2968 *
2969 * Get driver/firmware/hardware capabilities.
2970 */
2971 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
2972
2973 /**
2974 * poll - Poll driver for association information
2975 * @priv: private driver interface data
2976 *
2977 * This is an option callback that can be used when the driver does not
2978 * provide event mechanism for association events. This is called when
2979 * receiving WPA EAPOL-Key messages that require association
2980 * information. The driver interface is supposed to generate associnfo
2981 * event before returning from this callback function. In addition, the
2982 * driver interface should generate an association event after having
2983 * sent out associnfo.
2984 */
2985 void (*poll)(void *priv);
2986
2987 /**
Dmitry Shmidte4663042016-04-04 10:07:49 -07002988 * get_ifindex - Get interface index
2989 * @priv: private driver interface data
2990 *
2991 * Returns: Interface index
2992 */
2993 unsigned int (*get_ifindex)(void *priv);
2994
2995 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002996 * get_ifname - Get interface name
2997 * @priv: private driver interface data
2998 *
2999 * Returns: Pointer to the interface name. This can differ from the
3000 * interface name used in init() call. Init() is called first.
3001 *
3002 * This optional function can be used to allow the driver interface to
3003 * replace the interface name with something else, e.g., based on an
3004 * interface mapping from a more descriptive name.
3005 */
3006 const char * (*get_ifname)(void *priv);
3007
3008 /**
3009 * get_mac_addr - Get own MAC address
3010 * @priv: private driver interface data
3011 *
3012 * Returns: Pointer to own MAC address or %NULL on failure
3013 *
3014 * This optional function can be used to get the own MAC address of the
3015 * device from the driver interface code. This is only needed if the
3016 * l2_packet implementation for the OS does not provide easy access to
3017 * a MAC address. */
3018 const u8 * (*get_mac_addr)(void *priv);
3019
3020 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003021 * set_operstate - Sets device operating state to DORMANT or UP
3022 * @priv: private driver interface data
3023 * @state: 0 = dormant, 1 = up
3024 * Returns: 0 on success, -1 on failure
3025 *
3026 * This is an optional function that can be used on operating systems
3027 * that support a concept of controlling network device state from user
3028 * space applications. This function, if set, gets called with
3029 * state = 1 when authentication has been completed and with state = 0
3030 * when connection is lost.
3031 */
3032 int (*set_operstate)(void *priv, int state);
3033
3034 /**
3035 * mlme_setprotection - MLME-SETPROTECTION.request primitive
3036 * @priv: Private driver interface data
3037 * @addr: Address of the station for which to set protection (may be
3038 * %NULL for group keys)
3039 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
3040 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
3041 * Returns: 0 on success, -1 on failure
3042 *
3043 * This is an optional function that can be used to set the driver to
3044 * require protection for Tx and/or Rx frames. This uses the layer
3045 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
3046 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
3047 * set protection operation; instead, they set protection implicitly
3048 * based on configured keys.
3049 */
3050 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
3051 int key_type);
3052
3053 /**
3054 * get_hw_feature_data - Get hardware support data (channels and rates)
3055 * @priv: Private driver interface data
3056 * @num_modes: Variable for returning the number of returned modes
3057 * flags: Variable for returning hardware feature flags
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003058 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003059 * Returns: Pointer to allocated hardware data on success or %NULL on
3060 * failure. Caller is responsible for freeing this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003061 */
3062 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
3063 u16 *num_modes,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003064 u16 *flags, u8 *dfs);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003065
3066 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003067 * send_mlme - Send management frame from MLME
3068 * @priv: Private driver interface data
3069 * @data: IEEE 802.11 management frame with IEEE 802.11 header
3070 * @data_len: Size of the management frame
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003071 * @noack: Do not wait for this frame to be acked (disable retries)
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07003072 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
3073 * driver decide
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08003074 * @csa_offs: Array of CSA offsets or %NULL
3075 * @csa_offs_len: Number of elements in csa_offs
Hai Shalomfdcde762020-04-02 11:19:20 -07003076 * @no_encrypt: Do not encrypt frame even if appropriate key exists
3077 * (used only for testing purposes)
3078 * @wait: Time to wait off-channel for a response (in ms), or zero
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003079 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003080 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003081 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08003082 int noack, unsigned int freq, const u16 *csa_offs,
Hai Shalomfdcde762020-04-02 11:19:20 -07003083 size_t csa_offs_len, int no_encrypt,
3084 unsigned int wait);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003085
3086 /**
3087 * update_ft_ies - Update FT (IEEE 802.11r) IEs
3088 * @priv: Private driver interface data
3089 * @md: Mobility domain (2 octets) (also included inside ies)
3090 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
3091 * @ies_len: Length of FT IEs in bytes
3092 * Returns: 0 on success, -1 on failure
3093 *
3094 * The supplicant uses this callback to let the driver know that keying
3095 * material for FT is available and that the driver can use the
3096 * provided IEs in the next message in FT authentication sequence.
3097 *
3098 * This function is only needed for driver that support IEEE 802.11r
3099 * (Fast BSS Transition).
3100 */
3101 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
3102 size_t ies_len);
3103
3104 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003105 * get_scan_results2 - Fetch the latest scan results
3106 * @priv: private driver interface data
3107 *
3108 * Returns: Allocated buffer of scan results (caller is responsible for
3109 * freeing the data structure) on success, NULL on failure
3110 */
3111 struct wpa_scan_results * (*get_scan_results2)(void *priv);
3112
3113 /**
3114 * set_country - Set country
3115 * @priv: Private driver interface data
3116 * @alpha2: country to which to switch to
3117 * Returns: 0 on success, -1 on failure
3118 *
3119 * This function is for drivers which support some form
3120 * of setting a regulatory domain.
3121 */
3122 int (*set_country)(void *priv, const char *alpha2);
3123
3124 /**
Dmitry Shmidtcce06662013-11-04 18:44:24 -08003125 * get_country - Get country
3126 * @priv: Private driver interface data
3127 * @alpha2: Buffer for returning country code (at least 3 octets)
3128 * Returns: 0 on success, -1 on failure
3129 */
3130 int (*get_country)(void *priv, char *alpha2);
3131
3132 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003133 * global_init - Global driver initialization
Dmitry Shmidte4663042016-04-04 10:07:49 -07003134 * @ctx: wpa_global pointer
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003135 * Returns: Pointer to private data (global), %NULL on failure
3136 *
3137 * This optional function is called to initialize the driver wrapper
3138 * for global data, i.e., data that applies to all interfaces. If this
3139 * function is implemented, global_deinit() will also need to be
3140 * implemented to free the private data. The driver will also likely
3141 * use init2() function instead of init() to get the pointer to global
3142 * data available to per-interface initializer.
3143 */
Dmitry Shmidte4663042016-04-04 10:07:49 -07003144 void * (*global_init)(void *ctx);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003145
3146 /**
3147 * global_deinit - Global driver deinitialization
3148 * @priv: private driver global data from global_init()
3149 *
3150 * Terminate any global driver related functionality and free the
3151 * global data structure.
3152 */
3153 void (*global_deinit)(void *priv);
3154
3155 /**
3156 * init2 - Initialize driver interface (with global data)
3157 * @ctx: context to be used when calling wpa_supplicant functions,
3158 * e.g., wpa_supplicant_event()
3159 * @ifname: interface name, e.g., wlan0
3160 * @global_priv: private driver global data from global_init()
3161 * Returns: Pointer to private data, %NULL on failure
3162 *
3163 * This function can be used instead of init() if the driver wrapper
3164 * uses global data.
3165 */
3166 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
3167
3168 /**
3169 * get_interfaces - Get information about available interfaces
3170 * @global_priv: private driver global data from global_init()
3171 * Returns: Allocated buffer of interface information (caller is
3172 * responsible for freeing the data structure) on success, NULL on
3173 * failure
3174 */
3175 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
3176
3177 /**
3178 * scan2 - Request the driver to initiate scan
3179 * @priv: private driver interface data
3180 * @params: Scan parameters
3181 *
3182 * Returns: 0 on success, -1 on failure
3183 *
3184 * Once the scan results are ready, the driver should report scan
3185 * results event for wpa_supplicant which will eventually request the
3186 * results with wpa_driver_get_scan_results2().
3187 */
3188 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
3189
3190 /**
3191 * authenticate - Request driver to authenticate
3192 * @priv: private driver interface data
3193 * @params: authentication parameters
3194 * Returns: 0 on success, -1 on failure
3195 *
3196 * This is an optional function that can be used with drivers that
3197 * support separate authentication and association steps, i.e., when
3198 * wpa_supplicant can act as the SME. If not implemented, associate()
3199 * function is expected to take care of IEEE 802.11 authentication,
3200 * too.
3201 */
3202 int (*authenticate)(void *priv,
3203 struct wpa_driver_auth_params *params);
3204
3205 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003206 * set_ap - Set Beacon and Probe Response information for AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003207 * @priv: Private driver interface data
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003208 * @params: Parameters to use in AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003209 *
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003210 * This function is used to configure Beacon template and/or extra IEs
3211 * to add for Beacon and Probe Response frames for the driver in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003212 * AP mode. The driver is responsible for building the full Beacon
3213 * frame by concatenating the head part with TIM IE generated by the
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003214 * driver/firmware and finishing with the tail part. Depending on the
3215 * driver architectue, this can be done either by using the full
3216 * template or the set of additional IEs (e.g., WPS and P2P IE).
3217 * Similarly, Probe Response processing depends on the driver design.
3218 * If the driver (or firmware) takes care of replying to Probe Request
3219 * frames, the extra IEs provided here needs to be added to the Probe
3220 * Response frames.
3221 *
3222 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003223 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003224 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003225
3226 /**
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07003227 * set_acl - Set ACL in AP mode
3228 * @priv: Private driver interface data
3229 * @params: Parameters to configure ACL
3230 * Returns: 0 on success, -1 on failure
3231 *
3232 * This is used only for the drivers which support MAC address ACL.
3233 */
3234 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
3235
3236 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003237 * hapd_init - Initialize driver interface (hostapd only)
3238 * @hapd: Pointer to hostapd context
3239 * @params: Configuration for the driver wrapper
3240 * Returns: Pointer to private data, %NULL on failure
3241 *
3242 * This function is used instead of init() or init2() when the driver
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003243 * wrapper is used with hostapd.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003244 */
3245 void * (*hapd_init)(struct hostapd_data *hapd,
3246 struct wpa_init_params *params);
3247
3248 /**
3249 * hapd_deinit - Deinitialize driver interface (hostapd only)
3250 * @priv: Private driver interface data from hapd_init()
3251 */
3252 void (*hapd_deinit)(void *priv);
3253
3254 /**
3255 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
3256 * @priv: Private driver interface data
3257 * @params: BSS parameters
3258 * Returns: 0 on success, -1 on failure
3259 *
3260 * This is an optional function to configure the kernel driver to
3261 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
3262 * can be left undefined (set to %NULL) if IEEE 802.1X support is
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003263 * always enabled and the driver uses set_ap() to set WPA/RSN IE
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003264 * for Beacon frames.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003265 *
3266 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003267 */
3268 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
3269
3270 /**
3271 * set_privacy - Enable/disable privacy (AP only)
3272 * @priv: Private driver interface data
3273 * @enabled: 1 = privacy enabled, 0 = disabled
3274 * Returns: 0 on success, -1 on failure
3275 *
3276 * This is an optional function to configure privacy field in the
3277 * kernel driver for Beacon frames. This can be left undefined (set to
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003278 * %NULL) if the driver uses the Beacon template from set_ap().
3279 *
3280 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003281 */
3282 int (*set_privacy)(void *priv, int enabled);
3283
3284 /**
3285 * get_seqnum - Fetch the current TSC/packet number (AP only)
3286 * @ifname: The interface name (main or virtual)
3287 * @priv: Private driver interface data
3288 * @addr: MAC address of the station or %NULL for group keys
3289 * @idx: Key index
3290 * @seq: Buffer for returning the latest used TSC/packet number
3291 * Returns: 0 on success, -1 on failure
3292 *
3293 * This function is used to fetch the last used TSC/packet number for
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07003294 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
3295 * keys, so there is no strict requirement on implementing support for
3296 * unicast keys (i.e., addr != %NULL).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003297 */
3298 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
3299 int idx, u8 *seq);
3300
3301 /**
3302 * flush - Flush all association stations (AP only)
3303 * @priv: Private driver interface data
3304 * Returns: 0 on success, -1 on failure
3305 *
3306 * This function requests the driver to disassociate all associated
3307 * stations. This function does not need to be implemented if the
3308 * driver does not process association frames internally.
3309 */
3310 int (*flush)(void *priv);
3311
3312 /**
3313 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
3314 * @priv: Private driver interface data
3315 * @elem: Information elements
3316 * @elem_len: Length of the elem buffer in octets
3317 * Returns: 0 on success, -1 on failure
3318 *
3319 * This is an optional function to add information elements in the
3320 * kernel driver for Beacon and Probe Response frames. This can be left
3321 * undefined (set to %NULL) if the driver uses the Beacon template from
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003322 * set_ap().
3323 *
3324 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003325 */
3326 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
3327
3328 /**
Jouni Malinen1e6c57f2012-09-05 17:07:03 +03003329 * read_sta_data - Fetch station data
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003330 * @priv: Private driver interface data
3331 * @data: Buffer for returning station information
3332 * @addr: MAC address of the station
3333 * Returns: 0 on success, -1 on failure
3334 */
3335 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
3336 const u8 *addr);
3337
3338 /**
Hai Shalomfdcde762020-04-02 11:19:20 -07003339 * tx_control_port - Send a frame over the 802.1X controlled port
3340 * @priv: Private driver interface data
3341 * @dest: Destination MAC address
3342 * @proto: Ethertype in host byte order
3343 * @buf: Frame payload starting from IEEE 802.1X header
3344 * @len: Frame payload length
3345 * @no_encrypt: Do not encrypt frame
3346 *
3347 * Returns 0 on success, else an error
3348 *
3349 * This is like a normal Ethernet send except that the driver is aware
3350 * (by other means than the Ethertype) that this frame is special,
3351 * and more importantly it gains an ordering between the transmission of
3352 * the frame and other driver management operations such as key
3353 * installations. This can be used to work around known limitations in
3354 * IEEE 802.11 protocols such as race conditions between rekeying 4-way
3355 * handshake message 4/4 and a PTK being overwritten.
3356 *
3357 * This function is only used for a given interface if the driver
3358 * instance reports WPA_DRIVER_FLAGS_CONTROL_PORT capability. Otherwise,
3359 * API users will fall back to sending the frame via a normal socket.
3360 */
3361 int (*tx_control_port)(void *priv, const u8 *dest,
3362 u16 proto, const u8 *buf, size_t len,
3363 int no_encrypt);
3364
3365 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003366 * hapd_send_eapol - Send an EAPOL packet (AP only)
3367 * @priv: private driver interface data
3368 * @addr: Destination MAC address
3369 * @data: EAPOL packet starting with IEEE 802.1X header
3370 * @data_len: Length of the EAPOL packet in octets
3371 * @encrypt: Whether the frame should be encrypted
3372 * @own_addr: Source MAC address
3373 * @flags: WPA_STA_* flags for the destination station
3374 *
3375 * Returns: 0 on success, -1 on failure
3376 */
3377 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
3378 size_t data_len, int encrypt,
3379 const u8 *own_addr, u32 flags);
3380
3381 /**
3382 * sta_deauth - Deauthenticate a station (AP only)
3383 * @priv: Private driver interface data
3384 * @own_addr: Source address and BSSID for the Deauthentication frame
3385 * @addr: MAC address of the station to deauthenticate
3386 * @reason: Reason code for the Deauthentiation frame
3387 * Returns: 0 on success, -1 on failure
3388 *
3389 * This function requests a specific station to be deauthenticated and
3390 * a Deauthentication frame to be sent to it.
3391 */
3392 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07003393 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003394
3395 /**
3396 * sta_disassoc - Disassociate a station (AP only)
3397 * @priv: Private driver interface data
3398 * @own_addr: Source address and BSSID for the Disassociation frame
3399 * @addr: MAC address of the station to disassociate
3400 * @reason: Reason code for the Disassociation frame
3401 * Returns: 0 on success, -1 on failure
3402 *
3403 * This function requests a specific station to be disassociated and
3404 * a Disassociation frame to be sent to it.
3405 */
3406 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07003407 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003408
3409 /**
3410 * sta_remove - Remove a station entry (AP only)
3411 * @priv: Private driver interface data
3412 * @addr: MAC address of the station to be removed
3413 * Returns: 0 on success, -1 on failure
3414 */
3415 int (*sta_remove)(void *priv, const u8 *addr);
3416
3417 /**
3418 * hapd_get_ssid - Get the current SSID (AP only)
3419 * @priv: Private driver interface data
3420 * @buf: Buffer for returning the SSID
3421 * @len: Maximum length of the buffer
3422 * Returns: Length of the SSID on success, -1 on failure
3423 *
3424 * This function need not be implemented if the driver uses Beacon
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003425 * template from set_ap() and does not reply to Probe Request frames.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003426 */
3427 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
3428
3429 /**
3430 * hapd_set_ssid - Set SSID (AP only)
3431 * @priv: Private driver interface data
3432 * @buf: SSID
3433 * @len: Length of the SSID in octets
3434 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003435 *
3436 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003437 */
3438 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
3439
3440 /**
3441 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
3442 * @priv: Private driver interface data
3443 * @enabled: 1 = countermeasures enabled, 0 = disabled
3444 * Returns: 0 on success, -1 on failure
3445 *
3446 * This need not be implemented if the driver does not take care of
3447 * association processing.
3448 */
3449 int (*hapd_set_countermeasures)(void *priv, int enabled);
3450
3451 /**
3452 * sta_add - Add a station entry
3453 * @priv: Private driver interface data
3454 * @params: Station parameters
3455 * Returns: 0 on success, -1 on failure
3456 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08003457 * This function is used to add or set (params->set 1) a station
3458 * entry in the driver. Adding STA entries is used only if the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003459 * does not take care of association processing.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003460 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08003461 * With drivers that don't support full AP client state, this function
3462 * is used to add a station entry to the driver once the station has
3463 * completed association.
3464 *
3465 * With TDLS, this function is used to add or set (params->set 1)
3466 * TDLS peer entries (even with drivers that do not support full AP
3467 * client state).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003468 */
3469 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
3470
3471 /**
3472 * get_inact_sec - Get station inactivity duration (AP only)
3473 * @priv: Private driver interface data
3474 * @addr: Station address
3475 * Returns: Number of seconds station has been inactive, -1 on failure
3476 */
3477 int (*get_inact_sec)(void *priv, const u8 *addr);
3478
3479 /**
3480 * sta_clear_stats - Clear station statistics (AP only)
3481 * @priv: Private driver interface data
3482 * @addr: Station address
3483 * Returns: 0 on success, -1 on failure
3484 */
3485 int (*sta_clear_stats)(void *priv, const u8 *addr);
3486
3487 /**
3488 * set_freq - Set channel/frequency (AP only)
3489 * @priv: Private driver interface data
3490 * @freq: Channel parameters
3491 * Returns: 0 on success, -1 on failure
3492 */
3493 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
3494
3495 /**
3496 * set_rts - Set RTS threshold
3497 * @priv: Private driver interface data
3498 * @rts: RTS threshold in octets
3499 * Returns: 0 on success, -1 on failure
3500 */
3501 int (*set_rts)(void *priv, int rts);
3502
3503 /**
3504 * set_frag - Set fragmentation threshold
3505 * @priv: Private driver interface data
3506 * @frag: Fragmentation threshold in octets
3507 * Returns: 0 on success, -1 on failure
3508 */
3509 int (*set_frag)(void *priv, int frag);
3510
3511 /**
3512 * sta_set_flags - Set station flags (AP only)
3513 * @priv: Private driver interface data
3514 * @addr: Station address
3515 * @total_flags: Bitmap of all WPA_STA_* flags currently set
3516 * @flags_or: Bitmap of WPA_STA_* flags to add
3517 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
3518 * Returns: 0 on success, -1 on failure
3519 */
3520 int (*sta_set_flags)(void *priv, const u8 *addr,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08003521 unsigned int total_flags, unsigned int flags_or,
3522 unsigned int flags_and);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003523
3524 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07003525 * sta_set_airtime_weight - Set station airtime weight (AP only)
3526 * @priv: Private driver interface data
3527 * @addr: Station address
3528 * @weight: New weight for station airtime assignment
3529 * Returns: 0 on success, -1 on failure
3530 */
3531 int (*sta_set_airtime_weight)(void *priv, const u8 *addr,
3532 unsigned int weight);
3533
3534 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003535 * set_tx_queue_params - Set TX queue parameters
3536 * @priv: Private driver interface data
3537 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
3538 * @aifs: AIFS
3539 * @cw_min: cwMin
3540 * @cw_max: cwMax
3541 * @burst_time: Maximum length for bursting in 0.1 msec units
3542 */
3543 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
3544 int cw_max, int burst_time);
3545
3546 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003547 * if_add - Add a virtual interface
3548 * @priv: Private driver interface data
3549 * @type: Interface type
3550 * @ifname: Interface name for the new virtual interface
3551 * @addr: Local address to use for the interface or %NULL to use the
3552 * parent interface address
3553 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
3554 * @drv_priv: Pointer for overwriting the driver context or %NULL if
3555 * not allowed (applies only to %WPA_IF_AP_BSS type)
3556 * @force_ifname: Buffer for returning an interface name that the
3557 * driver ended up using if it differs from the requested ifname
3558 * @if_addr: Buffer for returning the allocated interface address
3559 * (this may differ from the requested addr if the driver cannot
3560 * change interface address)
3561 * @bridge: Bridge interface to use or %NULL if no bridge configured
Dmitry Shmidtcce06662013-11-04 18:44:24 -08003562 * @use_existing: Whether to allow existing interface to be used
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003563 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003564 * Returns: 0 on success, -1 on failure
3565 */
3566 int (*if_add)(void *priv, enum wpa_driver_if_type type,
3567 const char *ifname, const u8 *addr, void *bss_ctx,
3568 void **drv_priv, char *force_ifname, u8 *if_addr,
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003569 const char *bridge, int use_existing, int setup_ap);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003570
3571 /**
3572 * if_remove - Remove a virtual interface
3573 * @priv: Private driver interface data
3574 * @type: Interface type
3575 * @ifname: Interface name of the virtual interface to be removed
3576 * Returns: 0 on success, -1 on failure
3577 */
3578 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
3579 const char *ifname);
3580
3581 /**
3582 * set_sta_vlan - Bind a station into a specific interface (AP only)
3583 * @priv: Private driver interface data
3584 * @ifname: Interface (main or virtual BSS or VLAN)
3585 * @addr: MAC address of the associated station
3586 * @vlan_id: VLAN ID
3587 * Returns: 0 on success, -1 on failure
3588 *
3589 * This function is used to bind a station to a specific virtual
3590 * interface. It is only used if when virtual interfaces are supported,
3591 * e.g., to assign stations to different VLAN interfaces based on
3592 * information from a RADIUS server. This allows separate broadcast
3593 * domains to be used with a single BSS.
3594 */
3595 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
3596 int vlan_id);
3597
3598 /**
3599 * commit - Optional commit changes handler (AP only)
3600 * @priv: driver private data
3601 * Returns: 0 on success, -1 on failure
3602 *
3603 * This optional handler function can be registered if the driver
3604 * interface implementation needs to commit changes (e.g., by setting
3605 * network interface up) at the end of initial configuration. If set,
3606 * this handler will be called after initial setup has been completed.
3607 */
3608 int (*commit)(void *priv);
3609
3610 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003611 * set_radius_acl_auth - Notification of RADIUS ACL change
3612 * @priv: Private driver interface data
3613 * @mac: MAC address of the station
3614 * @accepted: Whether the station was accepted
3615 * @session_timeout: Session timeout for the station
3616 * Returns: 0 on success, -1 on failure
3617 */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003618 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003619 u32 session_timeout);
3620
3621 /**
3622 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3623 * @priv: Private driver interface data
3624 * @mac: MAC address of the station
3625 * Returns: 0 on success, -1 on failure
3626 */
3627 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
3628
3629 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003630 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
3631 * @priv: Private driver interface data
3632 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3633 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3634 * extra IE(s)
3635 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3636 * to remove extra IE(s)
3637 * Returns: 0 on success, -1 on failure
3638 *
3639 * This is an optional function to add WPS IE in the kernel driver for
3640 * Beacon and Probe Response frames. This can be left undefined (set
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003641 * to %NULL) if the driver uses the Beacon template from set_ap()
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003642 * and does not process Probe Request frames. If the driver takes care
3643 * of (Re)Association frame processing, the assocresp buffer includes
3644 * WPS IE(s) that need to be added to (Re)Association Response frames
3645 * whenever a (Re)Association Request frame indicated use of WPS.
3646 *
3647 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3648 * frames when operating as a GO. The driver is responsible for adding
3649 * timing related attributes (e.g., NoA) in addition to the IEs
3650 * included here by appending them after these buffers. This call is
3651 * also used to provide Probe Response IEs for P2P Listen state
3652 * operations for drivers that generate the Probe Response frames
3653 * internally.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003654 *
3655 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003656 */
3657 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
3658 const struct wpabuf *proberesp,
3659 const struct wpabuf *assocresp);
3660
3661 /**
3662 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3663 * @priv: Private driver interface data
3664 * @authorized: Whether the port is authorized
3665 * Returns: 0 on success, -1 on failure
3666 */
3667 int (*set_supp_port)(void *priv, int authorized);
3668
3669 /**
3670 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3671 * @priv: Private driver interface data
3672 * @addr: MAC address of the associated station
3673 * @aid: Association ID
3674 * @val: 1 = bind to 4-address WDS; 0 = unbind
3675 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3676 * to indicate that bridge is not to be used
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07003677 * @ifname_wds: Buffer to return the interface name for the new WDS
3678 * station or %NULL to indicate name is not returned.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003679 * Returns: 0 on success, -1 on failure
3680 */
3681 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003682 const char *bridge_ifname, char *ifname_wds);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003683
3684 /**
3685 * send_action - Transmit an Action frame
3686 * @priv: Private driver interface data
3687 * @freq: Frequency (in MHz) of the channel
3688 * @wait: Time to wait off-channel for a response (in ms), or zero
3689 * @dst: Destination MAC address (Address 1)
3690 * @src: Source MAC address (Address 2)
3691 * @bssid: BSSID (Address 3)
3692 * @data: Frame body
3693 * @data_len: data length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003694 @ @no_cck: Whether CCK rates must not be used to transmit this frame
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003695 * Returns: 0 on success, -1 on failure
3696 *
3697 * This command can be used to request the driver to transmit an action
3698 * frame to the specified destination.
3699 *
3700 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3701 * be transmitted on the given channel and the device will wait for a
3702 * response on that channel for the given wait time.
3703 *
3704 * If the flag is not set, the wait time will be ignored. In this case,
3705 * if a remain-on-channel duration is in progress, the frame must be
3706 * transmitted on that channel; alternatively the frame may be sent on
3707 * the current operational channel (if in associated state in station
3708 * mode or while operating as an AP.)
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08003709 *
3710 * If @src differs from the device MAC address, use of a random
3711 * transmitter address is requested for this message exchange.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003712 */
3713 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
3714 const u8 *dst, const u8 *src, const u8 *bssid,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003715 const u8 *data, size_t data_len, int no_cck);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003716
3717 /**
3718 * send_action_cancel_wait - Cancel action frame TX wait
3719 * @priv: Private driver interface data
3720 *
3721 * This command cancels the wait time associated with sending an action
3722 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3723 * set in the driver flags.
3724 */
3725 void (*send_action_cancel_wait)(void *priv);
3726
3727 /**
3728 * remain_on_channel - Remain awake on a channel
3729 * @priv: Private driver interface data
3730 * @freq: Frequency (in MHz) of the channel
3731 * @duration: Duration in milliseconds
3732 * Returns: 0 on success, -1 on failure
3733 *
3734 * This command is used to request the driver to remain awake on the
3735 * specified channel for the specified duration and report received
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08003736 * Action frames with EVENT_RX_MGMT events. Optionally, received
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003737 * Probe Request frames may also be requested to be reported by calling
3738 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3739 *
3740 * The driver may not be at the requested channel when this function
3741 * returns, i.e., the return code is only indicating whether the
3742 * request was accepted. The caller will need to wait until the
3743 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3744 * completed the channel change. This may take some time due to other
3745 * need for the radio and the caller should be prepared to timing out
3746 * its wait since there are no guarantees on when this request can be
3747 * executed.
3748 */
3749 int (*remain_on_channel)(void *priv, unsigned int freq,
3750 unsigned int duration);
3751
3752 /**
3753 * cancel_remain_on_channel - Cancel remain-on-channel operation
3754 * @priv: Private driver interface data
3755 *
3756 * This command can be used to cancel a remain-on-channel operation
3757 * before its originally requested duration has passed. This could be
3758 * used, e.g., when remain_on_channel() is used to request extra time
3759 * to receive a response to an Action frame and the response is
3760 * received when there is still unneeded time remaining on the
3761 * remain-on-channel operation.
3762 */
3763 int (*cancel_remain_on_channel)(void *priv);
3764
3765 /**
3766 * probe_req_report - Request Probe Request frames to be indicated
3767 * @priv: Private driver interface data
3768 * @report: Whether to report received Probe Request frames
3769 * Returns: 0 on success, -1 on failure (or if not supported)
3770 *
3771 * This command can be used to request the driver to indicate when
3772 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3773 * Since this operation may require extra resources, e.g., due to less
3774 * optimal hardware/firmware RX filtering, many drivers may disable
3775 * Probe Request reporting at least in station mode. This command is
3776 * used to notify the driver when the Probe Request frames need to be
3777 * reported, e.g., during remain-on-channel operations.
3778 */
3779 int (*probe_req_report)(void *priv, int report);
3780
3781 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003782 * deinit_ap - Deinitialize AP mode
3783 * @priv: Private driver interface data
3784 * Returns: 0 on success, -1 on failure (or if not supported)
3785 *
3786 * This optional function can be used to disable AP mode related
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003787 * configuration. If the interface was not dynamically added,
3788 * change the driver mode to station mode to allow normal station
3789 * operations like scanning to be completed.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003790 */
3791 int (*deinit_ap)(void *priv);
3792
3793 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003794 * deinit_p2p_cli - Deinitialize P2P client mode
3795 * @priv: Private driver interface data
3796 * Returns: 0 on success, -1 on failure (or if not supported)
3797 *
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003798 * This optional function can be used to disable P2P client mode. If the
3799 * interface was not dynamically added, change the interface type back
3800 * to station mode.
Dmitry Shmidt04949592012-07-19 12:16:46 -07003801 */
3802 int (*deinit_p2p_cli)(void *priv);
3803
3804 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003805 * suspend - Notification on system suspend/hibernate event
3806 * @priv: Private driver interface data
3807 */
3808 void (*suspend)(void *priv);
3809
3810 /**
3811 * resume - Notification on system resume/thaw event
3812 * @priv: Private driver interface data
3813 */
3814 void (*resume)(void *priv);
3815
3816 /**
3817 * signal_monitor - Set signal monitoring parameters
3818 * @priv: Private driver interface data
3819 * @threshold: Threshold value for signal change events; 0 = disabled
3820 * @hysteresis: Minimum change in signal strength before indicating a
3821 * new event
3822 * Returns: 0 on success, -1 on failure (or if not supported)
3823 *
3824 * This function can be used to configure monitoring of signal strength
3825 * with the current AP. Whenever signal strength drops below the
3826 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3827 * should be generated assuming the signal strength has changed at
3828 * least %hysteresis from the previously indicated signal change event.
3829 */
3830 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
3831
3832 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003833 * get_noa - Get current Notice of Absence attribute payload
3834 * @priv: Private driver interface data
3835 * @buf: Buffer for returning NoA
3836 * @buf_len: Buffer length in octets
3837 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3838 * advertized, or -1 on failure
3839 *
3840 * This function is used to fetch the current Notice of Absence
3841 * attribute value from GO.
3842 */
3843 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
3844
3845 /**
3846 * set_noa - Set Notice of Absence parameters for GO (testing)
3847 * @priv: Private driver interface data
3848 * @count: Count
3849 * @start: Start time in ms from next TBTT
3850 * @duration: Duration in ms
3851 * Returns: 0 on success or -1 on failure
3852 *
3853 * This function is used to set Notice of Absence parameters for GO. It
3854 * is used only for testing. To disable NoA, all parameters are set to
3855 * 0.
3856 */
3857 int (*set_noa)(void *priv, u8 count, int start, int duration);
3858
3859 /**
3860 * set_p2p_powersave - Set P2P power save options
3861 * @priv: Private driver interface data
3862 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3863 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3864 * @ctwindow: 0.. = change (msec), -1 = no change
3865 * Returns: 0 on success or -1 on failure
3866 */
3867 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
3868 int ctwindow);
3869
3870 /**
3871 * ampdu - Enable/disable aggregation
3872 * @priv: Private driver interface data
3873 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3874 * Returns: 0 on success or -1 on failure
3875 */
3876 int (*ampdu)(void *priv, int ampdu);
3877
3878 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003879 * get_radio_name - Get physical radio name for the device
3880 * @priv: Private driver interface data
3881 * Returns: Radio name or %NULL if not known
3882 *
3883 * The returned data must not be modified by the caller. It is assumed
3884 * that any interface that has the same radio name as another is
3885 * sharing the same physical radio. This information can be used to
3886 * share scan results etc. information between the virtual interfaces
3887 * to speed up various operations.
3888 */
3889 const char * (*get_radio_name)(void *priv);
3890
3891 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003892 * send_tdls_mgmt - for sending TDLS management packets
3893 * @priv: private driver interface data
3894 * @dst: Destination (peer) MAC address
3895 * @action_code: TDLS action code for the mssage
3896 * @dialog_token: Dialog Token to use in the message (if needed)
3897 * @status_code: Status Code or Reason Code to use (if needed)
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003898 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003899 * @initiator: Is the current end the TDLS link initiator
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003900 * @buf: TDLS IEs to add to the message
3901 * @len: Length of buf in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003902 * Returns: 0 on success, negative (<0) on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003903 *
3904 * This optional function can be used to send packet to driver which is
3905 * responsible for receiving and sending all TDLS packets.
3906 */
3907 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003908 u8 dialog_token, u16 status_code, u32 peer_capab,
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003909 int initiator, const u8 *buf, size_t len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003910
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003911 /**
3912 * tdls_oper - Ask the driver to perform high-level TDLS operations
3913 * @priv: Private driver interface data
3914 * @oper: TDLS high-level operation. See %enum tdls_oper
3915 * @peer: Destination (peer) MAC address
3916 * Returns: 0 on success, negative (<0) on failure
3917 *
3918 * This optional function can be used to send high-level TDLS commands
3919 * to the driver.
3920 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003921 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
3922
3923 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07003924 * wnm_oper - Notify driver of the WNM frame reception
3925 * @priv: Private driver interface data
3926 * @oper: WNM operation. See %enum wnm_oper
3927 * @peer: Destination (peer) MAC address
3928 * @buf: Buffer for the driver to fill in (for getting IE)
3929 * @buf_len: Return the len of buf
3930 * Returns: 0 on success, negative (<0) on failure
3931 */
3932 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
3933 u8 *buf, u16 *buf_len);
3934
3935 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -07003936 * set_qos_map - Set QoS Map
3937 * @priv: Private driver interface data
3938 * @qos_map_set: QoS Map
3939 * @qos_map_set_len: Length of QoS Map
3940 */
3941 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
3942 u8 qos_map_set_len);
3943
3944 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003945 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3946 * @priv: Private driver interface data
3947 * @version: IP version of the IP address, 4 or 6
3948 * @ipaddr: IP address for the neigh entry
3949 * @prefixlen: IP address prefix length
3950 * @addr: Corresponding MAC address
3951 * Returns: 0 on success, negative (<0) on failure
3952 */
3953 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
3954 int prefixlen, const u8 *addr);
3955
3956 /**
3957 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3958 * @priv: Private driver interface data
3959 * @version: IP version of the IP address, 4 or 6
3960 * @ipaddr: IP address for the neigh entry
3961 * Returns: 0 on success, negative (<0) on failure
3962 */
3963 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
3964
3965 /**
3966 * br_port_set_attr - Set a bridge port attribute
3967 * @attr: Bridge port attribute to set
3968 * @val: Value to be set
3969 * Returns: 0 on success, negative (<0) on failure
3970 */
3971 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
3972 unsigned int val);
3973
3974 /**
3975 * br_port_set_attr - Set a bridge network parameter
3976 * @param: Bridge parameter to set
3977 * @val: Value to be set
3978 * Returns: 0 on success, negative (<0) on failure
3979 */
3980 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
3981 unsigned int val);
3982
3983 /**
Hai Shalomfdcde762020-04-02 11:19:20 -07003984 * get_wowlan - Get wake-on-wireless status
3985 * @priv: Private driver interface data
3986 */
3987 int (*get_wowlan)(void *priv);
3988
3989 /**
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07003990 * set_wowlan - Set wake-on-wireless triggers
3991 * @priv: Private driver interface data
3992 * @triggers: wowlan triggers
3993 */
3994 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
3995
3996 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003997 * signal_poll - Get current connection information
3998 * @priv: Private driver interface data
3999 * @signal_info: Connection info structure
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07004000 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004001 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07004002
4003 /**
Sunil Ravi89eba102022-09-13 21:04:37 -07004004 * mlo_signal_poll - Get current MLO connection information
4005 * @priv: Private driver interface data
4006 * @mlo_signal_info: MLO connection info structure
4007 */
4008 int (*mlo_signal_poll)(void *priv,
4009 struct wpa_mlo_signal_info *mlo_signal_info);
4010
4011 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08004012 * channel_info - Get parameters of the current operating channel
4013 * @priv: Private driver interface data
4014 * @channel_info: Channel info structure
4015 * Returns: 0 on success, negative (<0) on failure
4016 */
4017 int (*channel_info)(void *priv, struct wpa_channel_info *channel_info);
4018
4019 /**
Jouni Malinen75ecf522011-06-27 15:19:46 -07004020 * set_authmode - Set authentication algorithm(s) for static WEP
4021 * @priv: Private driver interface data
4022 * @authmode: 1=Open System, 2=Shared Key, 3=both
4023 * Returns: 0 on success, -1 on failure
4024 *
4025 * This function can be used to set authentication algorithms for AP
4026 * mode when static WEP is used. If the driver uses user space MLME/SME
4027 * implementation, there is no need to implement this function.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004028 *
4029 * DEPRECATED - use set_ap() instead
Jouni Malinen75ecf522011-06-27 15:19:46 -07004030 */
4031 int (*set_authmode)(void *priv, int authmode);
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08004032
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004033#ifdef ANDROID
Jouni Malinen75ecf522011-06-27 15:19:46 -07004034 /**
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08004035 * driver_cmd - Execute driver-specific command
4036 * @priv: Private driver interface data
4037 * @cmd: Command to execute
4038 * @buf: Return buffer
4039 * @buf_len: Buffer length
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07004040 * Returns: 0 on success, -1 on failure
4041 */
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08004042 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
4043#endif /* ANDROID */
4044
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004045 /**
Dmitry Shmidta38abf92014-03-06 13:38:44 -08004046 * vendor_cmd - Execute vendor specific command
4047 * @priv: Private driver interface data
4048 * @vendor_id: Vendor id
4049 * @subcmd: Vendor command id
Hai Shalom60840252021-02-19 19:02:11 -08004050 * @nested_attr_flag: Specifies if vendor subcommand uses nested
4051 * attributes or not
Dmitry Shmidta38abf92014-03-06 13:38:44 -08004052 * @data: Vendor command parameters (%NULL if no parameters)
4053 * @data_len: Data length
4054 * @buf: Return buffer (%NULL to ignore reply)
4055 * Returns: 0 on success, negative (<0) on failure
4056 *
4057 * This function handles vendor specific commands that are passed to
4058 * the driver/device. The command is identified by vendor id and
Hai Shalom60840252021-02-19 19:02:11 -08004059 * command id. The nested_attr_flag specifies whether the subcommand
4060 * uses nested attributes or not. Parameters can be passed
4061 * as argument to the command in the data buffer. Reply (if any) will be
4062 * filled in the supplied return buffer.
Dmitry Shmidta38abf92014-03-06 13:38:44 -08004063 *
4064 * The exact driver behavior is driver interface and vendor specific. As
4065 * an example, this will be converted to a vendor specific cfg80211
4066 * command in case of the nl80211 driver interface.
4067 */
4068 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
4069 unsigned int subcmd, const u8 *data, size_t data_len,
Hai Shalom60840252021-02-19 19:02:11 -08004070 enum nested_attr nested_attr_flag,
Dmitry Shmidta38abf92014-03-06 13:38:44 -08004071 struct wpabuf *buf);
4072
4073 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004074 * set_rekey_info - Set rekey information
4075 * @priv: Private driver interface data
4076 * @kek: Current KEK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08004077 * @kek_len: KEK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004078 * @kck: Current KCK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08004079 * @kck_len: KCK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004080 * @replay_ctr: Current EAPOL-Key Replay Counter
4081 *
4082 * This optional function can be used to provide information for the
4083 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
4084 * while the host (including wpa_supplicant) is sleeping.
4085 */
Dmitry Shmidt807291d2015-01-27 13:40:23 -08004086 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
4087 const u8 *kck, size_t kck_len,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004088 const u8 *replay_ctr);
4089
4090 /**
4091 * sta_assoc - Station association indication
4092 * @priv: Private driver interface data
4093 * @own_addr: Source address and BSSID for association frame
4094 * @addr: MAC address of the station to associate
4095 * @reassoc: flag to indicate re-association
4096 * @status: association response status code
4097 * @ie: assoc response ie buffer
4098 * @len: ie buffer length
4099 * Returns: 0 on success, -1 on failure
4100 *
4101 * This function indicates the driver to send (Re)Association
4102 * Response frame to the station.
4103 */
4104 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
4105 int reassoc, u16 status, const u8 *ie, size_t len);
4106
4107 /**
4108 * sta_auth - Station authentication indication
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004109 * @priv: private driver interface data
4110 * @params: Station authentication parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004111 *
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004112 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004113 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004114 int (*sta_auth)(void *priv,
4115 struct wpa_driver_sta_auth_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004116
4117 /**
4118 * add_tspec - Add traffic stream
4119 * @priv: Private driver interface data
4120 * @addr: MAC address of the station to associate
4121 * @tspec_ie: tspec ie buffer
4122 * @tspec_ielen: tspec ie length
4123 * Returns: 0 on success, -1 on failure
4124 *
4125 * This function adds the traffic steam for the station
4126 * and fills the medium_time in tspec_ie.
4127 */
4128 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
4129 size_t tspec_ielen);
4130
4131 /**
4132 * add_sta_node - Add a station node in the driver
4133 * @priv: Private driver interface data
4134 * @addr: MAC address of the station to add
4135 * @auth_alg: authentication algorithm used by the station
4136 * Returns: 0 on success, -1 on failure
4137 *
4138 * This function adds the station node in the driver, when
4139 * the station gets added by FT-over-DS.
4140 */
4141 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
4142
4143 /**
4144 * sched_scan - Request the driver to initiate scheduled scan
4145 * @priv: Private driver interface data
4146 * @params: Scan parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004147 * Returns: 0 on success, -1 on failure
4148 *
4149 * This operation should be used for scheduled scan offload to
4150 * the hardware. Every time scan results are available, the
4151 * driver should report scan results event for wpa_supplicant
4152 * which will eventually request the results with
4153 * wpa_driver_get_scan_results2(). This operation is optional
4154 * and if not provided or if it returns -1, we fall back to
4155 * normal host-scheduled scans.
4156 */
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004157 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004158
4159 /**
4160 * stop_sched_scan - Request the driver to stop a scheduled scan
4161 * @priv: Private driver interface data
4162 * Returns: 0 on success, -1 on failure
4163 *
4164 * This should cause the scheduled scan to be stopped and
4165 * results should stop being sent. Must be supported if
4166 * sched_scan is supported.
4167 */
4168 int (*stop_sched_scan)(void *priv);
4169
4170 /**
4171 * poll_client - Probe (null data or such) the given station
4172 * @priv: Private driver interface data
4173 * @own_addr: MAC address of sending interface
4174 * @addr: MAC address of the station to probe
4175 * @qos: Indicates whether station is QoS station
4176 *
4177 * This function is used to verify whether an associated station is
4178 * still present. This function does not need to be implemented if the
4179 * driver provides such inactivity polling mechanism.
4180 */
4181 void (*poll_client)(void *priv, const u8 *own_addr,
4182 const u8 *addr, int qos);
Dmitry Shmidt04949592012-07-19 12:16:46 -07004183
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004184 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07004185 * radio_disable - Disable/enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004186 * @priv: Private driver interface data
Dmitry Shmidt04949592012-07-19 12:16:46 -07004187 * @disabled: 1=disable 0=enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004188 * Returns: 0 on success, -1 on failure
4189 *
Dmitry Shmidt04949592012-07-19 12:16:46 -07004190 * This optional command is for testing purposes. It can be used to
4191 * disable the radio on a testbed device to simulate out-of-radio-range
4192 * conditions.
4193 */
4194 int (*radio_disable)(void *priv, int disabled);
4195
4196 /**
4197 * switch_channel - Announce channel switch and migrate the GO to the
4198 * given frequency
4199 * @priv: Private driver interface data
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08004200 * @settings: Settings for CSA period and new channel
Dmitry Shmidt04949592012-07-19 12:16:46 -07004201 * Returns: 0 on success, -1 on failure
4202 *
4203 * This function is used to move the GO to the legacy STA channel to
4204 * avoid frequency conflict in single channel concurrency.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004205 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08004206 int (*switch_channel)(void *priv, struct csa_settings *settings);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004207
4208 /**
Sunil Ravia04bd252022-05-02 22:54:18 -07004209 * switch_color - Announce color switch and migrate the BSS to the
4210 * given color
4211 * @priv: Private driver interface data
4212 * @settings: Settings for CCA period and new color
4213 * Returns: 0 on success, -1 on failure
4214 *
4215 * This function is used to move the BSS to its new color.
4216 */
4217 int (*switch_color)(void *priv, struct cca_settings *settings);
4218
4219 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004220 * add_tx_ts - Add traffic stream
4221 * @priv: Private driver interface data
4222 * @tsid: Traffic stream ID
4223 * @addr: Receiver address
4224 * @user_prio: User priority of the traffic stream
4225 * @admitted_time: Admitted time for this TS in units of
4226 * 32 microsecond periods (per second).
4227 * Returns: 0 on success, -1 on failure
4228 */
4229 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
4230 u16 admitted_time);
4231
4232 /**
4233 * del_tx_ts - Delete traffic stream
4234 * @priv: Private driver interface data
4235 * @tsid: Traffic stream ID
4236 * @addr: Receiver address
4237 * Returns: 0 on success, -1 on failure
4238 */
4239 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
4240
4241 /**
4242 * Enable channel-switching with TDLS peer
4243 * @priv: Private driver interface data
4244 * @addr: MAC address of the TDLS peer
4245 * @oper_class: Operating class of the switch channel
4246 * @params: Channel specification
4247 * Returns: 0 on success, -1 on failure
4248 *
4249 * The function indicates to driver that it can start switching to a
4250 * different channel with a specified TDLS peer. The switching is
4251 * assumed on until canceled with tdls_disable_channel_switch().
4252 */
4253 int (*tdls_enable_channel_switch)(
4254 void *priv, const u8 *addr, u8 oper_class,
4255 const struct hostapd_freq_params *params);
4256
4257 /**
4258 * Disable channel switching with TDLS peer
4259 * @priv: Private driver interface data
4260 * @addr: MAC address of the TDLS peer
4261 * Returns: 0 on success, -1 on failure
4262 *
4263 * This function indicates to the driver that it should stop switching
4264 * with a given TDLS peer.
4265 */
4266 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
4267
4268 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004269 * start_dfs_cac - Listen for radar interference on the channel
4270 * @priv: Private driver interface data
Dmitry Shmidt051af732013-10-22 13:52:46 -07004271 * @freq: Channel parameters
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004272 * Returns: 0 on success, -1 on failure
4273 */
Dmitry Shmidt051af732013-10-22 13:52:46 -07004274 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004275
4276 /**
4277 * stop_ap - Removes beacon from AP
4278 * @priv: Private driver interface data
4279 * Returns: 0 on success, -1 on failure (or if not supported)
4280 *
4281 * This optional function can be used to disable AP mode related
4282 * configuration. Unlike deinit_ap, it does not change to station
4283 * mode.
4284 */
4285 int (*stop_ap)(void *priv);
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004286
4287 /**
4288 * get_survey - Retrieve survey data
4289 * @priv: Private driver interface data
4290 * @freq: If set, survey data for the specified frequency is only
4291 * being requested. If not set, all survey data is requested.
4292 * Returns: 0 on success, -1 on failure
4293 *
4294 * Use this to retrieve:
4295 *
4296 * - the observed channel noise floor
4297 * - the amount of time we have spent on the channel
4298 * - the amount of time during which we have spent on the channel that
4299 * the radio has determined the medium is busy and we cannot
4300 * transmit
4301 * - the amount of time we have spent receiving data
4302 * - the amount of time we have spent transmitting data
4303 *
4304 * This data can be used for spectrum heuristics. One example is
4305 * Automatic Channel Selection (ACS). The channel survey data is
4306 * kept on a linked list on the channel data, one entry is added
4307 * for each survey. The min_nf of the channel is updated for each
4308 * survey.
4309 */
4310 int (*get_survey)(void *priv, unsigned int freq);
Dmitry Shmidt56052862013-10-04 10:23:25 -07004311
4312 /**
4313 * status - Get driver interface status information
4314 * @priv: Private driver interface data
Hai Shalom74f70d42019-02-11 14:42:39 -08004315 * @buf: Buffer for printing the status information
Dmitry Shmidt56052862013-10-04 10:23:25 -07004316 * @buflen: Maximum length of the buffer
4317 * Returns: Length of written status information or -1 on failure
4318 */
4319 int (*status)(void *priv, char *buf, size_t buflen);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004320
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07004321 /**
4322 * roaming - Set roaming policy for driver-based BSS selection
4323 * @priv: Private driver interface data
4324 * @allowed: Whether roaming within ESS is allowed
4325 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
4326 * Returns: Length of written status information or -1 on failure
4327 *
4328 * This optional callback can be used to update roaming policy from the
4329 * associate() command (bssid being set there indicates that the driver
4330 * should not roam before getting this roaming() call to allow roaming.
4331 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
4332 * capability, roaming policy is handled within wpa_supplicant and there
4333 * is no need to implement or react to this callback.
4334 */
4335 int (*roaming)(void *priv, int allowed, const u8 *bssid);
4336
4337 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -07004338 * disable_fils - Enable/disable FILS feature
4339 * @priv: Private driver interface data
4340 * @disable: 0-enable and 1-disable FILS feature
4341 * Returns: 0 on success, -1 on failure
4342 *
4343 * This callback can be used to configure driver and below layers to
4344 * enable/disable all FILS features.
4345 */
4346 int (*disable_fils)(void *priv, int disable);
4347
4348 /**
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07004349 * set_mac_addr - Set MAC address
4350 * @priv: Private driver interface data
4351 * @addr: MAC address to use or %NULL for setting back to permanent
4352 * Returns: 0 on success, -1 on failure
4353 */
4354 int (*set_mac_addr)(void *priv, const u8 *addr);
4355
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004356#ifdef CONFIG_MACSEC
4357 int (*macsec_init)(void *priv, struct macsec_init_params *params);
4358
4359 int (*macsec_deinit)(void *priv);
4360
4361 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004362 * macsec_get_capability - Inform MKA of this driver's capability
4363 * @priv: Private driver interface data
4364 * @cap: Driver's capability
4365 * Returns: 0 on success, -1 on failure
4366 */
4367 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);
4368
4369 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004370 * enable_protect_frames - Set protect frames status
4371 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004372 * @enabled: true = protect frames enabled
4373 * false = protect frames disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004374 * Returns: 0 on success, -1 on failure (or if not supported)
4375 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004376 int (*enable_protect_frames)(void *priv, bool enabled);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004377
4378 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004379 * enable_encrypt - Set encryption status
4380 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004381 * @enabled: true = encrypt outgoing traffic
4382 * false = integrity-only protection on outgoing traffic
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004383 * Returns: 0 on success, -1 on failure (or if not supported)
4384 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004385 int (*enable_encrypt)(void *priv, bool enabled);
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004386
4387 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004388 * set_replay_protect - Set replay protect status and window size
4389 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004390 * @enabled: true = replay protect enabled
4391 * false = replay protect disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004392 * @window: replay window size, valid only when replay protect enabled
4393 * Returns: 0 on success, -1 on failure (or if not supported)
4394 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004395 int (*set_replay_protect)(void *priv, bool enabled, u32 window);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004396
4397 /**
4398 * set_current_cipher_suite - Set current cipher suite
4399 * @priv: Private driver interface data
4400 * @cs: EUI64 identifier
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004401 * Returns: 0 on success, -1 on failure (or if not supported)
4402 */
Dmitry Shmidt7d175302016-09-06 13:11:34 -07004403 int (*set_current_cipher_suite)(void *priv, u64 cs);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004404
4405 /**
4406 * enable_controlled_port - Set controlled port status
4407 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004408 * @enabled: true = controlled port enabled
4409 * false = controlled port disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004410 * Returns: 0 on success, -1 on failure (or if not supported)
4411 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004412 int (*enable_controlled_port)(void *priv, bool enabled);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004413
4414 /**
4415 * get_receive_lowest_pn - Get receive lowest pn
4416 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004417 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004418 * Returns: 0 on success, -1 on failure (or if not supported)
4419 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004420 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004421
4422 /**
4423 * get_transmit_next_pn - Get transmit next pn
4424 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004425 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004426 * Returns: 0 on success, -1 on failure (or if not supported)
4427 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004428 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004429
4430 /**
4431 * set_transmit_next_pn - Set transmit next pn
4432 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004433 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004434 * Returns: 0 on success, -1 on failure (or if not supported)
4435 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004436 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004437
4438 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08004439 * set_receive_lowest_pn - Set receive lowest PN
4440 * @priv: Private driver interface data
4441 * @sa: secure association
4442 * Returns: 0 on success, -1 on failure (or if not supported)
4443 */
4444 int (*set_receive_lowest_pn)(void *priv, struct receive_sa *sa);
4445
4446 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004447 * create_receive_sc - create secure channel for receiving
4448 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004449 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004450 * @conf_offset: confidentiality offset (0, 30, or 50)
4451 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
4452 * 2 = Strict)
4453 * Returns: 0 on success, -1 on failure (or if not supported)
4454 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004455 int (*create_receive_sc)(void *priv, struct receive_sc *sc,
4456 unsigned int conf_offset,
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004457 int validation);
4458
4459 /**
4460 * delete_receive_sc - delete secure connection for receiving
4461 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004462 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004463 * Returns: 0 on success, -1 on failure
4464 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004465 int (*delete_receive_sc)(void *priv, struct receive_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004466
4467 /**
4468 * create_receive_sa - create secure association for receive
4469 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004470 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004471 * Returns: 0 on success, -1 on failure
4472 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004473 int (*create_receive_sa)(void *priv, struct receive_sa *sa);
4474
4475 /**
4476 * delete_receive_sa - Delete secure association for receive
4477 * @priv: Private driver interface data from init()
4478 * @sa: Secure association
4479 * Returns: 0 on success, -1 on failure
4480 */
4481 int (*delete_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004482
4483 /**
4484 * enable_receive_sa - enable the SA for receive
4485 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004486 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004487 * Returns: 0 on success, -1 on failure
4488 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004489 int (*enable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004490
4491 /**
4492 * disable_receive_sa - disable SA for receive
4493 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004494 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004495 * Returns: 0 on success, -1 on failure
4496 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004497 int (*disable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004498
4499 /**
4500 * create_transmit_sc - create secure connection for transmit
4501 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004502 * @sc: secure channel
4503 * @conf_offset: confidentiality offset (0, 30, or 50)
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004504 * Returns: 0 on success, -1 on failure
4505 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004506 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
4507 unsigned int conf_offset);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004508
4509 /**
4510 * delete_transmit_sc - delete secure connection for transmit
4511 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004512 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004513 * Returns: 0 on success, -1 on failure
4514 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004515 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004516
4517 /**
4518 * create_transmit_sa - create secure association for transmit
4519 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004520 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004521 * Returns: 0 on success, -1 on failure
4522 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004523 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);
4524
4525 /**
4526 * delete_transmit_sa - Delete secure association for transmit
4527 * @priv: Private driver interface data from init()
4528 * @sa: Secure association
4529 * Returns: 0 on success, -1 on failure
4530 */
4531 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004532
4533 /**
4534 * enable_transmit_sa - enable SA for transmit
4535 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004536 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004537 * Returns: 0 on success, -1 on failure
4538 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004539 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004540
4541 /**
4542 * disable_transmit_sa - disable SA for transmit
4543 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004544 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004545 * Returns: 0 on success, -1 on failure
4546 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004547 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004548#endif /* CONFIG_MACSEC */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004549
4550 /**
4551 * init_mesh - Driver specific initialization for mesh
4552 * @priv: Private driver interface data
4553 * Returns: 0 on success, -1 on failure
4554 */
4555 int (*init_mesh)(void *priv);
4556
4557 /**
4558 * join_mesh - Join a mesh network
4559 * @priv: Private driver interface data
4560 * @params: Mesh configuration parameters
4561 * Returns: 0 on success, -1 on failure
4562 */
4563 int (*join_mesh)(void *priv,
4564 struct wpa_driver_mesh_join_params *params);
4565
4566 /**
4567 * leave_mesh - Leave a mesh network
4568 * @priv: Private driver interface data
4569 * Returns 0 on success, -1 on failure
4570 */
4571 int (*leave_mesh)(void *priv);
4572
4573 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07004574 * probe_mesh_link - Inject a frame over direct mesh link to a given
4575 * peer skipping the next_hop lookup from mpath table.
4576 * @priv: Private driver interface data
4577 * @addr: Peer MAC address
4578 * @eth: Ethernet frame to be sent
4579 * @len: Ethernet frame lengtn in bytes
4580 * Returns 0 on success, -1 on failure
4581 */
4582 int (*probe_mesh_link)(void *priv, const u8 *addr, const u8 *eth,
4583 size_t len);
4584
4585 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004586 * do_acs - Automatically select channel
4587 * @priv: Private driver interface data
4588 * @params: Parameters for ACS
4589 * Returns 0 on success, -1 on failure
4590 *
4591 * This command can be used to offload ACS to the driver if the driver
4592 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
4593 */
4594 int (*do_acs)(void *priv, struct drv_acs_params *params);
Ravi Joshie6ccb162015-07-16 17:45:41 -07004595
4596 /**
Hai Shalom60840252021-02-19 19:02:11 -08004597 * set_band - Notify driver of band(s) selection
Ravi Joshie6ccb162015-07-16 17:45:41 -07004598 * @priv: Private driver interface data
Hai Shalom60840252021-02-19 19:02:11 -08004599 * @band_mask: The selected band(s) bit mask (from enum set_band)
Ravi Joshie6ccb162015-07-16 17:45:41 -07004600 * Returns 0 on success, -1 on failure
4601 */
Hai Shalom60840252021-02-19 19:02:11 -08004602 int (*set_band)(void *priv, u32 band_mask);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004603
4604 /**
4605 * get_pref_freq_list - Get preferred frequency list for an interface
4606 * @priv: Private driver interface data
4607 * @if_type: Interface type
4608 * @num: Number of channels
Sunil8cd6f4d2022-06-28 18:40:46 +00004609 * @freq_list: Weighted preferred channel list
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004610 * Returns 0 on success, -1 on failure
4611 *
4612 * This command can be used to query the preferred frequency list from
Sunil8cd6f4d2022-06-28 18:40:46 +00004613 * the driver specific to a particular interface type. The freq_list
4614 * array needs to have room for *num entries. *num will be updated to
4615 * indicate the number of entries fetched from the driver.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004616 */
4617 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
Sunil8cd6f4d2022-06-28 18:40:46 +00004618 unsigned int *num,
4619 struct weighted_pcl *freq_list);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004620
4621 /**
4622 * set_prob_oper_freq - Indicate probable P2P operating channel
4623 * @priv: Private driver interface data
4624 * @freq: Channel frequency in MHz
4625 * Returns 0 on success, -1 on failure
4626 *
4627 * This command can be used to inform the driver of the operating
4628 * frequency that an ongoing P2P group formation is likely to come up
4629 * on. Local device is assuming P2P Client role.
4630 */
4631 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004632
4633 /**
4634 * abort_scan - Request the driver to abort an ongoing scan
4635 * @priv: Private driver interface data
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004636 * @scan_cookie: Cookie identifying the scan request. This is used only
4637 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4638 * was used to trigger scan. Otherwise, 0 is used.
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004639 * Returns 0 on success, -1 on failure
4640 */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004641 int (*abort_scan)(void *priv, u64 scan_cookie);
Dmitry Shmidt849734c2016-05-27 09:59:01 -07004642
4643 /**
4644 * configure_data_frame_filters - Request to configure frame filters
4645 * @priv: Private driver interface data
4646 * @filter_flags: The type of frames to filter (bitfield of
4647 * WPA_DATA_FRAME_FILTER_FLAG_*)
4648 * Returns: 0 on success or -1 on failure
4649 */
4650 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07004651
4652 /**
4653 * get_ext_capab - Get extended capabilities for the specified interface
4654 * @priv: Private driver interface data
4655 * @type: Interface type for which to get extended capabilities
4656 * @ext_capab: Extended capabilities fetched
4657 * @ext_capab_mask: Extended capabilities mask
4658 * @ext_capab_len: Length of the extended capabilities
4659 * Returns: 0 on success or -1 on failure
4660 */
4661 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
4662 const u8 **ext_capab, const u8 **ext_capab_mask,
4663 unsigned int *ext_capab_len);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004664
4665 /**
4666 * p2p_lo_start - Start offloading P2P listen to device
4667 * @priv: Private driver interface data
4668 * @freq: Listening frequency (MHz) for P2P listen
4669 * @period: Length of the listen operation in milliseconds
4670 * @interval: Interval for running the listen operation in milliseconds
4671 * @count: Number of times to run the listen operation
4672 * @device_types: Device primary and secondary types
4673 * @dev_types_len: Number of bytes for device_types
4674 * @ies: P2P IE and WSC IE for Probe Response frames
4675 * @ies_len: Length of ies in bytes
4676 * Returns: 0 on success or -1 on failure
4677 */
4678 int (*p2p_lo_start)(void *priv, unsigned int freq,
4679 unsigned int period, unsigned int interval,
4680 unsigned int count,
4681 const u8 *device_types, size_t dev_types_len,
4682 const u8 *ies, size_t ies_len);
4683
4684 /**
4685 * p2p_lo_stop - Stop P2P listen offload
4686 * @priv: Private driver interface data
4687 * Returns: 0 on success or -1 on failure
4688 */
4689 int (*p2p_lo_stop)(void *priv);
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07004690
4691 /**
4692 * set_default_scan_ies - Set default scan IEs
4693 * @priv: Private driver interface data
4694 * @ies: Scan default IEs buffer
4695 * @ies_len: Length of IEs in bytes
4696 * Returns: 0 on success or -1 on failure
4697 *
4698 * The driver can use these by default when there are no scan IEs coming
4699 * in the subsequent scan requests. Also in case of one or more of IEs
4700 * given in set_default_scan_ies() are missing in the subsequent scan
4701 * request, the driver should merge the missing scan IEs in the scan
4702 * request from the IEs set by set_default_scan_ies() in the Probe
4703 * Request frames sent.
4704 */
4705 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
4706
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004707 /**
4708 * set_tdls_mode - Set TDLS trigger mode to the host driver
4709 * @priv: Private driver interface data
4710 * @tdls_external_control: Represents if TDLS external trigger control
4711 * mode is enabled/disabled.
4712 *
4713 * This optional callback can be used to configure the TDLS external
4714 * trigger control mode to the host driver.
4715 */
4716 int (*set_tdls_mode)(void *priv, int tdls_external_control);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004717
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004718 /**
4719 * get_bss_transition_status - Get candidate BSS's transition status
4720 * @priv: Private driver interface data
4721 * @params: Candidate BSS list
4722 *
4723 * Get the accept or reject reason code for a list of BSS transition
4724 * candidates.
4725 */
4726 struct wpa_bss_candidate_info *
4727 (*get_bss_transition_status)(void *priv,
4728 struct wpa_bss_trans_info *params);
4729 /**
4730 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
4731 * @priv: Private driver interface data
4732 * @ignore_disallow: 0 to not ignore, 1 to ignore
4733 * Returns: 0 on success, -1 on failure
4734 */
4735 int (*ignore_assoc_disallow)(void *priv, int ignore_disallow);
4736
4737 /**
Hai Shalom899fcc72020-10-19 14:38:18 -07004738 * set_bssid_tmp_disallow - Set disallowed BSSIDs to the driver
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004739 * @priv: Private driver interface data
Hai Shalom899fcc72020-10-19 14:38:18 -07004740 * @num_bssid: Number of temporarily disallowed BSSIDs
4741 * @bssids: List of temporarily disallowed BSSIDs
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004742 */
Hai Shalom899fcc72020-10-19 14:38:18 -07004743 int (*set_bssid_tmp_disallow)(void *priv, unsigned int num_bssid,
4744 const u8 *bssid);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004745
4746 /**
4747 * update_connect_params - Update the connection parameters
4748 * @priv: Private driver interface data
4749 * @params: Association parameters
4750 * @mask: Bit mask indicating which parameters in @params have to be
4751 * updated
4752 * Returns: 0 on success, -1 on failure
4753 *
4754 * Update the connection parameters when in connected state so that the
4755 * driver uses the updated parameters for subsequent roaming. This is
4756 * used only with drivers that implement internal BSS selection and
4757 * roaming.
4758 */
4759 int (*update_connect_params)(
4760 void *priv, struct wpa_driver_associate_params *params,
4761 enum wpa_drv_update_connect_params_mask mask);
Roshan Pius3a1667e2018-07-03 15:17:14 -07004762
4763 /**
4764 * send_external_auth_status - Indicate the status of external
4765 * authentication processing to the host driver.
4766 * @priv: Private driver interface data
4767 * @params: Status of authentication processing.
4768 * Returns: 0 on success, -1 on failure
4769 */
4770 int (*send_external_auth_status)(void *priv,
4771 struct external_auth *params);
Hai Shalom74f70d42019-02-11 14:42:39 -08004772
4773 /**
4774 * set_4addr_mode - Set 4-address mode
4775 * @priv: Private driver interface data
4776 * @bridge_ifname: Bridge interface name
4777 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
4778 * Returns: 0 on success, < 0 on failure
4779 */
4780 int (*set_4addr_mode)(void *priv, const char *bridge_ifname, int val);
Hai Shalom81f62d82019-07-22 12:10:00 -07004781
4782 /**
4783 * update_dh_ie - Update DH IE
4784 * @priv: Private driver interface data
4785 * @peer_mac: Peer MAC address
4786 * @reason_code: Reacon code
4787 * @ie: DH IE
4788 * @ie_len: DH IE length in bytes
4789 * Returns: 0 on success, -1 on failure
4790 *
4791 * This callback is used to let the driver know the DH processing result
4792 * and DH IE for a pending association.
4793 */
4794 int (*update_dh_ie)(void *priv, const u8 *peer_mac, u16 reason_code,
4795 const u8 *ie, size_t ie_len);
Hai Shalomb755a2a2020-04-23 21:49:02 -07004796
4797 /**
4798 * dpp_listen - Notify driver about start/stop of DPP listen
4799 * @priv: Private driver interface data
4800 * @enable: Whether listen state is enabled (or disabled)
4801 * Returns: 0 on success, -1 on failure
4802 *
4803 * This optional callback can be used to update RX frame filtering to
4804 * explicitly allow reception of broadcast Public Action frames.
4805 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004806 int (*dpp_listen)(void *priv, bool enable);
Hai Shalomc1a21442022-02-04 13:43:00 -08004807
Sunil Ravi89eba102022-09-13 21:04:37 -07004808 /**
4809 * set_secure_ranging_ctx - Add or delete secure ranging parameters of
4810 * the specified peer to the driver.
4811 * @priv: Private driver interface data
4812 * @params: Secure ranging parameters
4813 * Returns: 0 on success, -1 on failure
4814 *
4815 */
4816 int (*set_secure_ranging_ctx)(void *priv,
4817 struct secure_ranging_params *params);
4818
4819 /**
4820 * send_pasn_resp - Send PASN response for a set of peers to the
4821 * driver.
4822 * @priv: Private driver interface data
4823 * @params: Parameters holding peers and respective status.
4824 * Returns: 0 on success, -1 on failure
4825 */
4826 int (*send_pasn_resp)(void *priv, struct pasn_auth *params);
4827
4828 /**
4829 * get_sta_mlo_info - Get the current multi-link association info
4830 * @priv: Private driver interface data
4831 * @mlo: Pointer to fill multi-link association info
4832 * Returns: 0 on success, -1 on failure
4833 *
4834 * This callback is used to fetch multi-link of the current association.
4835 */
4836 int (*get_sta_mlo_info)(void *priv,
4837 struct driver_sta_mlo_info *mlo_info);
4838
Hai Shalomc1a21442022-02-04 13:43:00 -08004839#ifdef CONFIG_TESTING_OPTIONS
4840 int (*register_frame)(void *priv, u16 type,
4841 const u8 *match, size_t match_len,
4842 bool multicast);
4843#endif /* CONFIG_TESTING_OPTIONS */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004844};
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004845
4846/**
4847 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
4848 */
4849enum wpa_event_type {
4850 /**
4851 * EVENT_ASSOC - Association completed
4852 *
4853 * This event needs to be delivered when the driver completes IEEE
4854 * 802.11 association or reassociation successfully.
4855 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
4856 * after this event has been generated. In addition, optional
4857 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
4858 * more information about the association. If the driver interface gets
4859 * both of these events at the same time, it can also include the
4860 * assoc_info data in EVENT_ASSOC call.
4861 */
4862 EVENT_ASSOC,
4863
4864 /**
4865 * EVENT_DISASSOC - Association lost
4866 *
4867 * This event should be called when association is lost either due to
4868 * receiving deauthenticate or disassociate frame from the AP or when
4869 * sending either of these frames to the current AP. If the driver
4870 * supports separate deauthentication event, EVENT_DISASSOC should only
4871 * be used for disassociation and EVENT_DEAUTH for deauthentication.
4872 * In AP mode, union wpa_event_data::disassoc_info is required.
4873 */
4874 EVENT_DISASSOC,
4875
4876 /**
4877 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
4878 *
4879 * This event must be delivered when a Michael MIC error is detected by
4880 * the local driver. Additional data for event processing is
4881 * provided with union wpa_event_data::michael_mic_failure. This
Sunil Ravia04bd252022-05-02 22:54:18 -07004882 * information is used to request new encryption key and to initiate
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004883 * TKIP countermeasures if needed.
4884 */
4885 EVENT_MICHAEL_MIC_FAILURE,
4886
4887 /**
4888 * EVENT_SCAN_RESULTS - Scan results available
4889 *
4890 * This event must be called whenever scan results are available to be
4891 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4892 * is expected to be used some time after struct wpa_driver_ops::scan()
4893 * is called. If the driver provides an unsolicited event when the scan
4894 * has been completed, this event can be used to trigger
4895 * EVENT_SCAN_RESULTS call. If such event is not available from the
4896 * driver, the driver wrapper code is expected to use a registered
4897 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
4898 * scan is expected to be completed. Optional information about
4899 * completed scan can be provided with union wpa_event_data::scan_info.
4900 */
4901 EVENT_SCAN_RESULTS,
4902
4903 /**
4904 * EVENT_ASSOCINFO - Report optional extra information for association
4905 *
4906 * This event can be used to report extra association information for
4907 * EVENT_ASSOC processing. This extra information includes IEs from
4908 * association frames and Beacon/Probe Response frames in union
4909 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4910 * EVENT_ASSOC. Alternatively, the driver interface can include
4911 * assoc_info data in the EVENT_ASSOC call if it has all the
4912 * information available at the same point.
4913 */
4914 EVENT_ASSOCINFO,
4915
4916 /**
4917 * EVENT_INTERFACE_STATUS - Report interface status changes
4918 *
4919 * This optional event can be used to report changes in interface
4920 * status (interface added/removed) using union
4921 * wpa_event_data::interface_status. This can be used to trigger
4922 * wpa_supplicant to stop and re-start processing for the interface,
4923 * e.g., when a cardbus card is ejected/inserted.
4924 */
4925 EVENT_INTERFACE_STATUS,
4926
4927 /**
4928 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4929 *
4930 * This event can be used to inform wpa_supplicant about candidates for
4931 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4932 * for scan request (ap_scan=2 mode), this event is required for
4933 * pre-authentication. If wpa_supplicant is performing scan request
4934 * (ap_scan=1), this event is optional since scan results can be used
4935 * to add pre-authentication candidates. union
4936 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4937 * candidate and priority of the candidate, e.g., based on the signal
4938 * strength, in order to try to pre-authenticate first with candidates
4939 * that are most likely targets for re-association.
4940 *
4941 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4942 * on the candidate list. In addition, it can be called for the current
4943 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4944 * will automatically skip pre-authentication in cases where a valid
4945 * PMKSA exists. When more than one candidate exists, this event should
4946 * be generated once for each candidate.
4947 *
4948 * Driver will be notified about successful pre-authentication with
4949 * struct wpa_driver_ops::add_pmkid() calls.
4950 */
4951 EVENT_PMKID_CANDIDATE,
4952
4953 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004954 * EVENT_TDLS - Request TDLS operation
4955 *
4956 * This event can be used to request a TDLS operation to be performed.
4957 */
4958 EVENT_TDLS,
4959
4960 /**
4961 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4962 *
4963 * The driver is expected to report the received FT IEs from
4964 * FT authentication sequence from the AP. The FT IEs are included in
4965 * the extra information in union wpa_event_data::ft_ies.
4966 */
4967 EVENT_FT_RESPONSE,
4968
4969 /**
4970 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4971 *
4972 * The driver can use this event to inform wpa_supplicant about a STA
4973 * in an IBSS with which protected frames could be exchanged. This
4974 * event starts RSN authentication with the other STA to authenticate
4975 * the STA and set up encryption keys with it.
4976 */
4977 EVENT_IBSS_RSN_START,
4978
4979 /**
4980 * EVENT_AUTH - Authentication result
4981 *
4982 * This event should be called when authentication attempt has been
4983 * completed. This is only used if the driver supports separate
4984 * authentication step (struct wpa_driver_ops::authenticate).
4985 * Information about authentication result is included in
4986 * union wpa_event_data::auth.
4987 */
4988 EVENT_AUTH,
4989
4990 /**
4991 * EVENT_DEAUTH - Authentication lost
4992 *
4993 * This event should be called when authentication is lost either due
4994 * to receiving deauthenticate frame from the AP or when sending that
4995 * frame to the current AP.
4996 * In AP mode, union wpa_event_data::deauth_info is required.
4997 */
4998 EVENT_DEAUTH,
4999
5000 /**
5001 * EVENT_ASSOC_REJECT - Association rejected
5002 *
5003 * This event should be called when (re)association attempt has been
5004 * rejected by the AP. Information about the association response is
5005 * included in union wpa_event_data::assoc_reject.
5006 */
5007 EVENT_ASSOC_REJECT,
5008
5009 /**
5010 * EVENT_AUTH_TIMED_OUT - Authentication timed out
5011 */
5012 EVENT_AUTH_TIMED_OUT,
5013
5014 /**
5015 * EVENT_ASSOC_TIMED_OUT - Association timed out
5016 */
5017 EVENT_ASSOC_TIMED_OUT,
5018
5019 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005020 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
5021 */
5022 EVENT_WPS_BUTTON_PUSHED,
5023
5024 /**
5025 * EVENT_TX_STATUS - Report TX status
5026 */
5027 EVENT_TX_STATUS,
5028
5029 /**
5030 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
5031 */
5032 EVENT_RX_FROM_UNKNOWN,
5033
5034 /**
5035 * EVENT_RX_MGMT - Report RX of a management frame
5036 */
5037 EVENT_RX_MGMT,
5038
5039 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005040 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
5041 *
5042 * This event is used to indicate when the driver has started the
5043 * requested remain-on-channel duration. Information about the
5044 * operation is included in union wpa_event_data::remain_on_channel.
5045 */
5046 EVENT_REMAIN_ON_CHANNEL,
5047
5048 /**
5049 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
5050 *
5051 * This event is used to indicate when the driver has completed
5052 * remain-on-channel duration, i.e., may noot be available on the
5053 * requested channel anymore. Information about the
5054 * operation is included in union wpa_event_data::remain_on_channel.
5055 */
5056 EVENT_CANCEL_REMAIN_ON_CHANNEL,
5057
5058 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005059 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
5060 *
5061 * This event is used to indicate when a Probe Request frame has been
5062 * received. Information about the received frame is included in
5063 * union wpa_event_data::rx_probe_req. The driver is required to report
5064 * these events only after successfully completed probe_req_report()
5065 * commands to request the events (i.e., report parameter is non-zero)
5066 * in station mode. In AP mode, Probe Request frames should always be
5067 * reported.
5068 */
5069 EVENT_RX_PROBE_REQ,
5070
5071 /**
5072 * EVENT_NEW_STA - New wired device noticed
5073 *
5074 * This event is used to indicate that a new device has been detected
5075 * in a network that does not use association-like functionality (i.e.,
5076 * mainly wired Ethernet). This can be used to start EAPOL
5077 * authenticator when receiving a frame from a device. The address of
5078 * the device is included in union wpa_event_data::new_sta.
5079 */
5080 EVENT_NEW_STA,
5081
5082 /**
5083 * EVENT_EAPOL_RX - Report received EAPOL frame
5084 *
5085 * When in AP mode with hostapd, this event is required to be used to
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005086 * deliver the receive EAPOL frames from the driver.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005087 */
5088 EVENT_EAPOL_RX,
5089
5090 /**
5091 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
5092 *
5093 * This event is used to indicate changes in the signal strength
5094 * observed in frames received from the current AP if signal strength
5095 * monitoring has been enabled with signal_monitor().
5096 */
5097 EVENT_SIGNAL_CHANGE,
5098
5099 /**
5100 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
5101 *
5102 * This event is used to indicate that the interface was enabled after
5103 * having been previously disabled, e.g., due to rfkill.
5104 */
5105 EVENT_INTERFACE_ENABLED,
5106
5107 /**
5108 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
5109 *
5110 * This event is used to indicate that the interface was disabled,
5111 * e.g., due to rfkill.
5112 */
5113 EVENT_INTERFACE_DISABLED,
5114
5115 /**
5116 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
5117 *
5118 * This event is used to indicate that the channel list has changed,
5119 * e.g., because of a regulatory domain change triggered by scan
5120 * results including an AP advertising a country code.
5121 */
5122 EVENT_CHANNEL_LIST_CHANGED,
5123
5124 /**
5125 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
5126 *
5127 * This event is used to indicate that the driver cannot maintain this
5128 * interface in its operation mode anymore. The most likely use for
5129 * this is to indicate that AP mode operation is not available due to
5130 * operating channel would need to be changed to a DFS channel when
5131 * the driver does not support radar detection and another virtual
5132 * interfaces caused the operating channel to change. Other similar
5133 * resource conflicts could also trigger this for station mode
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07005134 * interfaces. This event can be propagated when channel switching
5135 * fails.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005136 */
5137 EVENT_INTERFACE_UNAVAILABLE,
5138
5139 /**
5140 * EVENT_BEST_CHANNEL
5141 *
5142 * Driver generates this event whenever it detects a better channel
5143 * (e.g., based on RSSI or channel use). This information can be used
5144 * to improve channel selection for a new AP/P2P group.
5145 */
5146 EVENT_BEST_CHANNEL,
5147
5148 /**
5149 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
5150 *
5151 * This event should be called when a Deauthentication frame is dropped
5152 * due to it not being protected (MFP/IEEE 802.11w).
5153 * union wpa_event_data::unprot_deauth is required to provide more
5154 * details of the frame.
5155 */
5156 EVENT_UNPROT_DEAUTH,
5157
5158 /**
5159 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
5160 *
5161 * This event should be called when a Disassociation frame is dropped
5162 * due to it not being protected (MFP/IEEE 802.11w).
5163 * union wpa_event_data::unprot_disassoc is required to provide more
5164 * details of the frame.
5165 */
5166 EVENT_UNPROT_DISASSOC,
5167
5168 /**
5169 * EVENT_STATION_LOW_ACK
5170 *
5171 * Driver generates this event whenever it detected that a particular
5172 * station was lost. Detection can be through massive transmission
5173 * failures for example.
5174 */
5175 EVENT_STATION_LOW_ACK,
5176
5177 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005178 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
5179 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005180 EVENT_IBSS_PEER_LOST,
5181
5182 /**
5183 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
5184 *
5185 * This event carries the new replay counter to notify wpa_supplicant
5186 * of the current EAPOL-Key Replay Counter in case the driver/firmware
5187 * completed Group Key Handshake while the host (including
5188 * wpa_supplicant was sleeping).
5189 */
5190 EVENT_DRIVER_GTK_REKEY,
5191
5192 /**
5193 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
5194 */
5195 EVENT_SCHED_SCAN_STOPPED,
5196
5197 /**
5198 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
5199 *
5200 * This event indicates that the station responded to the poll
5201 * initiated with @poll_client.
5202 */
5203 EVENT_DRIVER_CLIENT_POLL_OK,
5204
5205 /**
5206 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
5207 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07005208 EVENT_EAPOL_TX_STATUS,
5209
5210 /**
5211 * EVENT_CH_SWITCH - AP or GO decided to switch channels
5212 *
5213 * Described in wpa_event_data.ch_switch
5214 * */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07005215 EVENT_CH_SWITCH,
5216
5217 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07005218 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
5219 *
5220 * This is a pre-switch event indicating the shortly following switch
5221 * of operating channels.
5222 *
5223 * Described in wpa_event_data.ch_switch
5224 */
5225 EVENT_CH_SWITCH_STARTED,
5226 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07005227 * EVENT_WNM - Request WNM operation
5228 *
5229 * This event can be used to request a WNM operation to be performed.
5230 */
Dmitry Shmidtf8623282013-02-20 14:34:59 -08005231 EVENT_WNM,
5232
5233 /**
5234 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
5235 *
5236 * This event indicates that the driver reported a connection failure
5237 * with the specified client (for example, max client reached, etc.) in
5238 * AP mode.
5239 */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005240 EVENT_CONNECT_FAILED_REASON,
5241
5242 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08005243 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005244 *
5245 * A radar has been detected on the supplied frequency, hostapd should
5246 * react accordingly (e.g., change channel).
5247 */
5248 EVENT_DFS_RADAR_DETECTED,
5249
5250 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08005251 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005252 *
5253 * After a successful CAC, the channel can be marked clear and used.
5254 */
5255 EVENT_DFS_CAC_FINISHED,
5256
5257 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08005258 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005259 *
5260 * The CAC was not successful, and the channel remains in the previous
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08005261 * state. This may happen due to a radar being detected or other
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005262 * external influences.
5263 */
5264 EVENT_DFS_CAC_ABORTED,
5265
5266 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08005267 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005268 *
5269 * The channel which was previously unavailable is now available again.
5270 */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005271 EVENT_DFS_NOP_FINISHED,
5272
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005273 /**
5274 * EVENT_SURVEY - Received survey data
5275 *
5276 * This event gets triggered when a driver query is issued for survey
5277 * data and the requested data becomes available. The returned data is
5278 * stored in struct survey_results. The results provide at most one
5279 * survey entry for each frequency and at minimum will provide one
5280 * survey entry for one frequency. The survey data can be os_malloc()'d
5281 * and then os_free()'d, so the event callback must only copy data.
5282 */
5283 EVENT_SURVEY,
5284
5285 /**
5286 * EVENT_SCAN_STARTED - Scan started
5287 *
5288 * This indicates that driver has started a scan operation either based
5289 * on a request from wpa_supplicant/hostapd or from another application.
5290 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
5291 * completed (either successfully or by getting cancelled).
5292 */
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08005293 EVENT_SCAN_STARTED,
5294
5295 /**
5296 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
5297 *
5298 * This event indicates a set of frequency ranges that should be avoided
5299 * to reduce issues due to interference or internal co-existence
5300 * information in the driver.
5301 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005302 EVENT_AVOID_FREQUENCIES,
5303
5304 /**
5305 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
5306 */
5307 EVENT_NEW_PEER_CANDIDATE,
5308
5309 /**
5310 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
5311 *
5312 * Indicates a pair of primary and secondary channels chosen by ACS
5313 * in device.
5314 */
5315 EVENT_ACS_CHANNEL_SELECTED,
Dmitry Shmidt7f656022015-02-25 14:36:37 -08005316
5317 /**
5318 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
5319 * been started.
5320 *
5321 * This event indicates that channel availability check has been started
5322 * on a DFS frequency by a driver that supports DFS Offload.
5323 */
5324 EVENT_DFS_CAC_STARTED,
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005325
5326 /**
5327 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
5328 */
5329 EVENT_P2P_LO_STOP,
Paul Stewart092955c2017-02-06 09:13:09 -08005330
5331 /**
5332 * EVENT_BEACON_LOSS - Beacon loss detected
5333 *
5334 * This event indicates that no Beacon frames has been received from
5335 * the current AP. This may indicate that the AP is not anymore in
5336 * range.
5337 */
5338 EVENT_BEACON_LOSS,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005339
5340 /**
5341 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
5342 * done previously (Pre-CAC) on the channel has expired. This would
5343 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
5344 * channel will be moved from available to usable. A new CAC has to be
5345 * performed before start operating on this channel.
5346 */
5347 EVENT_DFS_PRE_CAC_EXPIRED,
Roshan Pius3a1667e2018-07-03 15:17:14 -07005348
5349 /**
5350 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
5351 * that do not define separate commands for authentication and
5352 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
5353 * authentication to wpa_supplicant. This event carries all the
5354 * necessary information from the host driver for the authentication to
5355 * happen.
5356 */
5357 EVENT_EXTERNAL_AUTH,
5358
5359 /**
5360 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
5361 *
5362 * This event should be indicated when the driver completes the 4-way
5363 * handshake. This event should be preceded by an EVENT_ASSOC that
5364 * indicates the completion of IEEE 802.11 association.
5365 */
5366 EVENT_PORT_AUTHORIZED,
5367
5368 /**
5369 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
5370 * change event.
5371 */
5372 EVENT_STATION_OPMODE_CHANGED,
5373
5374 /**
5375 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
5376 *
5377 * This event is emitted when the MAC changes while the interface is
5378 * enabled. When an interface was disabled and becomes enabled, it
5379 * must be always assumed that the MAC possibly changed.
5380 */
5381 EVENT_INTERFACE_MAC_CHANGED,
5382
5383 /**
5384 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
5385 *
5386 * This event is emitted when an interface is added/removed for WDS STA.
5387 */
5388 EVENT_WDS_STA_INTERFACE_STATUS,
Hai Shalom81f62d82019-07-22 12:10:00 -07005389
5390 /**
5391 * EVENT_UPDATE_DH - Notification of updated DH information
5392 */
5393 EVENT_UPDATE_DH,
Hai Shalomfdcde762020-04-02 11:19:20 -07005394
5395 /**
5396 * EVENT_UNPROT_BEACON - Unprotected Beacon frame received
5397 *
5398 * This event should be called when a Beacon frame is dropped due to it
5399 * not being protected correctly. union wpa_event_data::unprot_beacon
5400 * is required to provide more details of the frame.
5401 */
5402 EVENT_UNPROT_BEACON,
Hai Shalomc1a21442022-02-04 13:43:00 -08005403
5404 /**
5405 * EVENT_TX_WAIT_EXPIRE - TX wait timed out
5406 *
5407 * This event is used to indicate when the driver has completed
5408 * wait for a response frame based on a TX request that specified a
5409 * non-zero wait time and that has not been explicitly cancelled.
5410 */
5411 EVENT_TX_WAIT_EXPIRE,
Sunil Ravia04bd252022-05-02 22:54:18 -07005412
5413 /**
5414 * EVENT_BSS_COLOR_COLLISION - Notification of a BSS color collision
5415 */
5416 EVENT_BSS_COLOR_COLLISION,
5417
5418 /**
5419 * EVENT_CCA_STARTED_NOTIFY - Notification that CCA has started
5420 */
5421 EVENT_CCA_STARTED_NOTIFY,
5422
5423 /**
5424 * EVENT_CCA_ABORTED_NOTIFY - Notification that CCA has aborted
5425 */
5426 EVENT_CCA_ABORTED_NOTIFY,
5427
5428 /**
5429 * EVENT_CCA_NOTIFY - Notification that CCA has completed
5430 */
5431 EVENT_CCA_NOTIFY,
Sunil Ravi89eba102022-09-13 21:04:37 -07005432
5433 /**
5434 * EVENT_PASN_AUTH - This event is used by the driver that requests
5435 * PASN authentication and secure ranging context for multiple peers.
5436 */
5437 EVENT_PASN_AUTH,
5438
5439 /**
5440 * EVENT_LINK_CH_SWITCH - MLD AP link decided to switch channels
5441 *
5442 * Described in wpa_event_data.ch_switch.
5443 *
5444 */
5445 EVENT_LINK_CH_SWITCH,
5446
5447 /**
5448 * EVENT_LINK_CH_SWITCH_STARTED - MLD AP link started to switch channels
5449 *
5450 * This is a pre-switch event indicating the shortly following switch
5451 * of operating channels.
5452 *
5453 * Described in wpa_event_data.ch_switch.
5454 */
5455 EVENT_LINK_CH_SWITCH_STARTED,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005456};
5457
5458
5459/**
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005460 * struct freq_survey - Channel survey info
5461 *
5462 * @ifidx: Interface index in which this survey was observed
5463 * @freq: Center of frequency of the surveyed channel
5464 * @nf: Channel noise floor in dBm
5465 * @channel_time: Amount of time in ms the radio spent on the channel
5466 * @channel_time_busy: Amount of time in ms the radio detected some signal
5467 * that indicated to the radio the channel was not clear
5468 * @channel_time_rx: Amount of time the radio spent receiving data
5469 * @channel_time_tx: Amount of time the radio spent transmitting data
5470 * @filled: bitmask indicating which fields have been reported, see
5471 * SURVEY_HAS_* defines.
5472 * @list: Internal list pointers
5473 */
5474struct freq_survey {
5475 u32 ifidx;
5476 unsigned int freq;
5477 s8 nf;
5478 u64 channel_time;
5479 u64 channel_time_busy;
5480 u64 channel_time_rx;
5481 u64 channel_time_tx;
5482 unsigned int filled;
5483 struct dl_list list;
5484};
5485
5486#define SURVEY_HAS_NF BIT(0)
5487#define SURVEY_HAS_CHAN_TIME BIT(1)
5488#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
5489#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
5490#define SURVEY_HAS_CHAN_TIME_TX BIT(4)
5491
Hai Shalom60840252021-02-19 19:02:11 -08005492/**
5493 * enum sta_connect_fail_reason_codes - STA connect failure reason code values
5494 * @STA_CONNECT_FAIL_REASON_UNSPECIFIED: No reason code specified for
5495 * connection failure.
5496 * @STA_CONNECT_FAIL_REASON_NO_BSS_FOUND: No Probe Response frame received
5497 * for unicast Probe Request frame.
5498 * @STA_CONNECT_FAIL_REASON_AUTH_TX_FAIL: STA failed to send auth request.
5499 * @STA_CONNECT_FAIL_REASON_AUTH_NO_ACK_RECEIVED: AP didn't send ACK for
5500 * auth request.
5501 * @STA_CONNECT_FAIL_REASON_AUTH_NO_RESP_RECEIVED: Auth response is not
5502 * received from AP.
5503 * @STA_CONNECT_FAIL_REASON_ASSOC_REQ_TX_FAIL: STA failed to send
5504 * Association Request frame.
5505 * @STA_CONNECT_FAIL_REASON_ASSOC_NO_ACK_RECEIVED: AP didn't send ACK for
5506 * Association Request frame.
5507 * @STA_CONNECT_FAIL_REASON_ASSOC_NO_RESP_RECEIVED: Association Response
5508 * frame is not received from AP.
5509 */
5510enum sta_connect_fail_reason_codes {
5511 STA_CONNECT_FAIL_REASON_UNSPECIFIED = 0,
5512 STA_CONNECT_FAIL_REASON_NO_BSS_FOUND = 1,
5513 STA_CONNECT_FAIL_REASON_AUTH_TX_FAIL = 2,
5514 STA_CONNECT_FAIL_REASON_AUTH_NO_ACK_RECEIVED = 3,
5515 STA_CONNECT_FAIL_REASON_AUTH_NO_RESP_RECEIVED = 4,
5516 STA_CONNECT_FAIL_REASON_ASSOC_REQ_TX_FAIL = 5,
5517 STA_CONNECT_FAIL_REASON_ASSOC_NO_ACK_RECEIVED = 6,
5518 STA_CONNECT_FAIL_REASON_ASSOC_NO_RESP_RECEIVED = 7,
5519};
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005520
5521/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005522 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
5523 */
5524union wpa_event_data {
5525 /**
5526 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
5527 *
5528 * This structure is optional for EVENT_ASSOC calls and required for
5529 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
5530 * driver interface does not need to generate separate EVENT_ASSOCINFO
5531 * calls.
5532 */
5533 struct assoc_info {
5534 /**
5535 * reassoc - Flag to indicate association or reassociation
5536 */
5537 int reassoc;
5538
5539 /**
5540 * req_ies - (Re)Association Request IEs
5541 *
5542 * If the driver generates WPA/RSN IE, this event data must be
5543 * returned for WPA handshake to have needed information. If
5544 * wpa_supplicant-generated WPA/RSN IE is used, this
5545 * information event is optional.
5546 *
5547 * This should start with the first IE (fixed fields before IEs
5548 * are not included).
5549 */
5550 const u8 *req_ies;
5551
5552 /**
5553 * req_ies_len - Length of req_ies in bytes
5554 */
5555 size_t req_ies_len;
5556
5557 /**
5558 * resp_ies - (Re)Association Response IEs
5559 *
5560 * Optional association data from the driver. This data is not
5561 * required WPA, but may be useful for some protocols and as
5562 * such, should be reported if this is available to the driver
5563 * interface.
5564 *
5565 * This should start with the first IE (fixed fields before IEs
5566 * are not included).
5567 */
5568 const u8 *resp_ies;
5569
5570 /**
5571 * resp_ies_len - Length of resp_ies in bytes
5572 */
5573 size_t resp_ies_len;
5574
5575 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08005576 * resp_frame - (Re)Association Response frame
5577 */
5578 const u8 *resp_frame;
5579
5580 /**
5581 * resp_frame_len - (Re)Association Response frame length
5582 */
5583 size_t resp_frame_len;
5584
5585 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005586 * beacon_ies - Beacon or Probe Response IEs
5587 *
5588 * Optional Beacon/ProbeResp data: IEs included in Beacon or
5589 * Probe Response frames from the current AP (i.e., the one
5590 * that the client just associated with). This information is
5591 * used to update WPA/RSN IE for the AP. If this field is not
5592 * set, the results from previous scan will be used. If no
5593 * data for the new AP is found, scan results will be requested
5594 * again (without scan request). At this point, the driver is
5595 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
5596 * used).
5597 *
5598 * This should start with the first IE (fixed fields before IEs
5599 * are not included).
5600 */
5601 const u8 *beacon_ies;
5602
5603 /**
5604 * beacon_ies_len - Length of beacon_ies */
5605 size_t beacon_ies_len;
5606
5607 /**
5608 * freq - Frequency of the operational channel in MHz
5609 */
5610 unsigned int freq;
5611
5612 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005613 * wmm_params - WMM parameters used in this association.
5614 */
5615 struct wmm_params wmm_params;
5616
5617 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005618 * addr - Station address (for AP mode)
5619 */
5620 const u8 *addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005621
5622 /**
5623 * The following is the key management offload information
5624 * @authorized
5625 * @key_replay_ctr
5626 * @key_replay_ctr_len
5627 * @ptk_kck
5628 * @ptk_kek_len
5629 * @ptk_kek
5630 * @ptk_kek_len
5631 */
5632
5633 /**
5634 * authorized - Status of key management offload,
5635 * 1 = successful
5636 */
5637 int authorized;
5638
5639 /**
5640 * key_replay_ctr - Key replay counter value last used
5641 * in a valid EAPOL-Key frame
5642 */
5643 const u8 *key_replay_ctr;
5644
5645 /**
5646 * key_replay_ctr_len - The length of key_replay_ctr
5647 */
5648 size_t key_replay_ctr_len;
5649
5650 /**
5651 * ptk_kck - The derived PTK KCK
5652 */
5653 const u8 *ptk_kck;
5654
5655 /**
5656 * ptk_kek_len - The length of ptk_kck
5657 */
5658 size_t ptk_kck_len;
5659
5660 /**
5661 * ptk_kek - The derived PTK KEK
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005662 * This is used in key management offload and also in FILS SK
5663 * offload.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005664 */
5665 const u8 *ptk_kek;
5666
5667 /**
5668 * ptk_kek_len - The length of ptk_kek
5669 */
5670 size_t ptk_kek_len;
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08005671
5672 /**
5673 * subnet_status - The subnet status:
5674 * 0 = unknown, 1 = unchanged, 2 = changed
5675 */
5676 u8 subnet_status;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005677
5678 /**
5679 * The following information is used in FILS SK offload
5680 * @fils_erp_next_seq_num
5681 * @fils_pmk
5682 * @fils_pmk_len
5683 * @fils_pmkid
5684 */
5685
5686 /**
5687 * fils_erp_next_seq_num - The next sequence number to use in
5688 * FILS ERP messages
5689 */
5690 u16 fils_erp_next_seq_num;
5691
5692 /**
5693 * fils_pmk - A new PMK if generated in case of FILS
5694 * authentication
5695 */
5696 const u8 *fils_pmk;
5697
5698 /**
5699 * fils_pmk_len - Length of fils_pmk
5700 */
5701 size_t fils_pmk_len;
5702
5703 /**
5704 * fils_pmkid - PMKID used or generated in FILS authentication
5705 */
5706 const u8 *fils_pmkid;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005707 } assoc_info;
5708
5709 /**
5710 * struct disassoc_info - Data for EVENT_DISASSOC events
5711 */
5712 struct disassoc_info {
5713 /**
5714 * addr - Station address (for AP mode)
5715 */
5716 const u8 *addr;
5717
5718 /**
5719 * reason_code - Reason Code (host byte order) used in
5720 * Deauthentication frame
5721 */
5722 u16 reason_code;
5723
5724 /**
5725 * ie - Optional IE(s) in Disassociation frame
5726 */
5727 const u8 *ie;
5728
5729 /**
5730 * ie_len - Length of ie buffer in octets
5731 */
5732 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005733
5734 /**
5735 * locally_generated - Whether the frame was locally generated
5736 */
5737 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005738 } disassoc_info;
5739
5740 /**
5741 * struct deauth_info - Data for EVENT_DEAUTH events
5742 */
5743 struct deauth_info {
5744 /**
5745 * addr - Station address (for AP mode)
5746 */
5747 const u8 *addr;
5748
5749 /**
5750 * reason_code - Reason Code (host byte order) used in
5751 * Deauthentication frame
5752 */
5753 u16 reason_code;
5754
5755 /**
5756 * ie - Optional IE(s) in Deauthentication frame
5757 */
5758 const u8 *ie;
5759
5760 /**
5761 * ie_len - Length of ie buffer in octets
5762 */
5763 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005764
5765 /**
5766 * locally_generated - Whether the frame was locally generated
5767 */
5768 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005769 } deauth_info;
5770
5771 /**
5772 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
5773 */
5774 struct michael_mic_failure {
5775 int unicast;
5776 const u8 *src;
5777 } michael_mic_failure;
5778
5779 /**
5780 * struct interface_status - Data for EVENT_INTERFACE_STATUS
5781 */
5782 struct interface_status {
Dmitry Shmidte4663042016-04-04 10:07:49 -07005783 unsigned int ifindex;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005784 char ifname[100];
5785 enum {
5786 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
5787 } ievent;
5788 } interface_status;
5789
5790 /**
5791 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
5792 */
5793 struct pmkid_candidate {
5794 /** BSSID of the PMKID candidate */
5795 u8 bssid[ETH_ALEN];
5796 /** Smaller the index, higher the priority */
5797 int index;
5798 /** Whether RSN IE includes pre-authenticate flag */
5799 int preauth;
5800 } pmkid_candidate;
5801
5802 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005803 * struct tdls - Data for EVENT_TDLS
5804 */
5805 struct tdls {
5806 u8 peer[ETH_ALEN];
5807 enum {
5808 TDLS_REQUEST_SETUP,
Dmitry Shmidt4dd28dc2015-03-10 11:21:43 -07005809 TDLS_REQUEST_TEARDOWN,
5810 TDLS_REQUEST_DISCOVER,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005811 } oper;
5812 u16 reason_code; /* for teardown */
5813 } tdls;
5814
5815 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07005816 * struct wnm - Data for EVENT_WNM
5817 */
5818 struct wnm {
5819 u8 addr[ETH_ALEN];
5820 enum {
5821 WNM_OPER_SLEEP,
5822 } oper;
5823 enum {
5824 WNM_SLEEP_ENTER,
5825 WNM_SLEEP_EXIT
5826 } sleep_action;
5827 int sleep_intval;
5828 u16 reason_code;
5829 u8 *buf;
5830 u16 buf_len;
5831 } wnm;
5832
5833 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005834 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
5835 *
5836 * During FT (IEEE 802.11r) authentication sequence, the driver is
5837 * expected to use this event to report received FT IEs (MDIE, FTIE,
5838 * RSN IE, TIE, possible resource request) to the supplicant. The FT
5839 * IEs for the next message will be delivered through the
5840 * struct wpa_driver_ops::update_ft_ies() callback.
5841 */
5842 struct ft_ies {
5843 const u8 *ies;
5844 size_t ies_len;
5845 int ft_action;
5846 u8 target_ap[ETH_ALEN];
5847 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
5848 const u8 *ric_ies;
5849 /** Length of ric_ies buffer in octets */
5850 size_t ric_ies_len;
5851 } ft_ies;
5852
5853 /**
5854 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
5855 */
5856 struct ibss_rsn_start {
5857 u8 peer[ETH_ALEN];
5858 } ibss_rsn_start;
5859
5860 /**
5861 * struct auth_info - Data for EVENT_AUTH events
5862 */
5863 struct auth_info {
5864 u8 peer[ETH_ALEN];
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005865 u8 bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005866 u16 auth_type;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005867 u16 auth_transaction;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005868 u16 status_code;
5869 const u8 *ies;
5870 size_t ies_len;
5871 } auth;
5872
5873 /**
5874 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
5875 */
5876 struct assoc_reject {
5877 /**
5878 * bssid - BSSID of the AP that rejected association
5879 */
5880 const u8 *bssid;
5881
5882 /**
5883 * resp_ies - (Re)Association Response IEs
5884 *
5885 * Optional association data from the driver. This data is not
5886 * required WPA, but may be useful for some protocols and as
5887 * such, should be reported if this is available to the driver
5888 * interface.
5889 *
5890 * This should start with the first IE (fixed fields before IEs
5891 * are not included).
5892 */
5893 const u8 *resp_ies;
5894
5895 /**
5896 * resp_ies_len - Length of resp_ies in bytes
5897 */
5898 size_t resp_ies_len;
5899
5900 /**
5901 * status_code - Status Code from (Re)association Response
5902 */
5903 u16 status_code;
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07005904
5905 /**
5906 * timed_out - Whether failure is due to timeout (etc.) rather
5907 * than explicit rejection response from the AP.
5908 */
5909 int timed_out;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08005910
5911 /**
5912 * timeout_reason - Reason for the timeout
5913 */
5914 const char *timeout_reason;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005915
5916 /**
5917 * fils_erp_next_seq_num - The next sequence number to use in
5918 * FILS ERP messages
5919 */
5920 u16 fils_erp_next_seq_num;
Hai Shalom60840252021-02-19 19:02:11 -08005921
5922 /**
5923 * reason_code - Connection failure reason code from the driver
5924 */
5925 enum sta_connect_fail_reason_codes reason_code;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005926 } assoc_reject;
5927
5928 struct timeout_event {
5929 u8 addr[ETH_ALEN];
5930 } timeout_event;
5931
5932 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005933 * struct tx_status - Data for EVENT_TX_STATUS events
5934 */
5935 struct tx_status {
5936 u16 type;
5937 u16 stype;
5938 const u8 *dst;
5939 const u8 *data;
5940 size_t data_len;
5941 int ack;
5942 } tx_status;
5943
5944 /**
5945 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
5946 */
5947 struct rx_from_unknown {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005948 const u8 *bssid;
5949 const u8 *addr;
5950 int wds;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005951 } rx_from_unknown;
5952
5953 /**
5954 * struct rx_mgmt - Data for EVENT_RX_MGMT events
5955 */
5956 struct rx_mgmt {
5957 const u8 *frame;
5958 size_t frame_len;
5959 u32 datarate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005960
5961 /**
Dmitry Shmidt98660862014-03-11 17:26:21 -07005962 * drv_priv - Pointer to store driver private BSS information
5963 *
5964 * If not set to NULL, this is used for comparison with
5965 * hostapd_data->drv_priv to determine which BSS should process
5966 * the frame.
5967 */
5968 void *drv_priv;
5969
5970 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005971 * freq - Frequency (in MHz) on which the frame was received
5972 */
5973 int freq;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005974
5975 /**
5976 * ssi_signal - Signal strength in dBm (or 0 if not available)
5977 */
5978 int ssi_signal;
5979 } rx_mgmt;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005980
5981 /**
5982 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
5983 *
5984 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
5985 */
5986 struct remain_on_channel {
5987 /**
5988 * freq - Channel frequency in MHz
5989 */
5990 unsigned int freq;
5991
5992 /**
5993 * duration - Duration to remain on the channel in milliseconds
5994 */
5995 unsigned int duration;
5996 } remain_on_channel;
5997
5998 /**
5999 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
6000 * @aborted: Whether the scan was aborted
6001 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
6002 * @num_freqs: Number of entries in freqs array
6003 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
6004 * SSID)
6005 * @num_ssids: Number of entries in ssids array
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08006006 * @external_scan: Whether the scan info is for an external scan
6007 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
6008 * 0 if the source of the scan event is a vendor scan
Dmitry Shmidt29333592017-01-09 12:27:11 -08006009 * @scan_start_tsf: Time when the scan started in terms of TSF of the
6010 * BSS that the interface that requested the scan is connected to
6011 * (if available).
6012 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
6013 * is set.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006014 */
6015 struct scan_info {
6016 int aborted;
6017 const int *freqs;
6018 size_t num_freqs;
6019 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
6020 size_t num_ssids;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08006021 int external_scan;
6022 int nl_scan_event;
Dmitry Shmidt29333592017-01-09 12:27:11 -08006023 u64 scan_start_tsf;
6024 u8 scan_start_tsf_bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006025 } scan_info;
6026
6027 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006028 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
6029 */
6030 struct rx_probe_req {
6031 /**
6032 * sa - Source address of the received Probe Request frame
6033 */
6034 const u8 *sa;
6035
6036 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08006037 * da - Destination address of the received Probe Request frame
6038 * or %NULL if not available
6039 */
6040 const u8 *da;
6041
6042 /**
6043 * bssid - BSSID of the received Probe Request frame or %NULL
6044 * if not available
6045 */
6046 const u8 *bssid;
6047
6048 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006049 * ie - IEs from the Probe Request body
6050 */
6051 const u8 *ie;
6052
6053 /**
6054 * ie_len - Length of ie buffer in octets
6055 */
6056 size_t ie_len;
Dmitry Shmidt04949592012-07-19 12:16:46 -07006057
6058 /**
6059 * signal - signal strength in dBm (or 0 if not available)
6060 */
6061 int ssi_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006062 } rx_probe_req;
6063
6064 /**
6065 * struct new_sta - Data for EVENT_NEW_STA events
6066 */
6067 struct new_sta {
6068 const u8 *addr;
6069 } new_sta;
6070
6071 /**
6072 * struct eapol_rx - Data for EVENT_EAPOL_RX events
6073 */
6074 struct eapol_rx {
6075 const u8 *src;
6076 const u8 *data;
6077 size_t data_len;
Sunil8cd6f4d2022-06-28 18:40:46 +00006078 enum frame_encryption encrypted;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006079 } eapol_rx;
6080
6081 /**
6082 * signal_change - Data for EVENT_SIGNAL_CHANGE events
6083 */
6084 struct wpa_signal_info signal_change;
6085
6086 /**
6087 * struct best_channel - Data for EVENT_BEST_CHANNEL events
6088 * @freq_24: Best 2.4 GHz band channel frequency in MHz
6089 * @freq_5: Best 5 GHz band channel frequency in MHz
6090 * @freq_overall: Best channel frequency in MHz
6091 *
6092 * 0 can be used to indicate no preference in either band.
6093 */
6094 struct best_channel {
6095 int freq_24;
6096 int freq_5;
6097 int freq_overall;
6098 } best_chan;
6099
6100 struct unprot_deauth {
6101 const u8 *sa;
6102 const u8 *da;
6103 u16 reason_code;
6104 } unprot_deauth;
6105
6106 struct unprot_disassoc {
6107 const u8 *sa;
6108 const u8 *da;
6109 u16 reason_code;
6110 } unprot_disassoc;
6111
6112 /**
6113 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
6114 * @addr: station address
Paul Stewart092955c2017-02-06 09:13:09 -08006115 * @num_packets: Number of packets lost (consecutive packets not
6116 * acknowledged)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006117 */
6118 struct low_ack {
6119 u8 addr[ETH_ALEN];
Paul Stewart092955c2017-02-06 09:13:09 -08006120 u32 num_packets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006121 } low_ack;
6122
6123 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006124 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
6125 */
6126 struct ibss_peer_lost {
6127 u8 peer[ETH_ALEN];
6128 } ibss_peer_lost;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08006129
6130 /**
6131 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
6132 */
6133 struct driver_gtk_rekey {
6134 const u8 *bssid;
6135 const u8 *replay_ctr;
6136 } driver_gtk_rekey;
6137
6138 /**
6139 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
6140 * @addr: station address
6141 */
6142 struct client_poll {
6143 u8 addr[ETH_ALEN];
6144 } client_poll;
6145
6146 /**
6147 * struct eapol_tx_status
6148 * @dst: Original destination
6149 * @data: Data starting with IEEE 802.1X header (!)
6150 * @data_len: Length of data
6151 * @ack: Indicates ack or lost frame
6152 *
6153 * This corresponds to hapd_send_eapol if the frame sent
6154 * there isn't just reported as EVENT_TX_STATUS.
6155 */
6156 struct eapol_tx_status {
6157 const u8 *dst;
6158 const u8 *data;
6159 int data_len;
6160 int ack;
6161 } eapol_tx_status;
Dmitry Shmidt04949592012-07-19 12:16:46 -07006162
6163 /**
6164 * struct ch_switch
6165 * @freq: Frequency of new channel in MHz
6166 * @ht_enabled: Whether this is an HT channel
6167 * @ch_offset: Secondary channel offset
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08006168 * @ch_width: Channel width
6169 * @cf1: Center frequency 1
6170 * @cf2: Center frequency 2
Sunil Ravi89eba102022-09-13 21:04:37 -07006171 * @link_id: Link ID of the MLO link
Dmitry Shmidt04949592012-07-19 12:16:46 -07006172 */
6173 struct ch_switch {
6174 int freq;
6175 int ht_enabled;
6176 int ch_offset;
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08006177 enum chan_width ch_width;
6178 int cf1;
6179 int cf2;
Sunil Ravi89eba102022-09-13 21:04:37 -07006180 int link_id;
Dmitry Shmidt04949592012-07-19 12:16:46 -07006181 } ch_switch;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08006182
6183 /**
6184 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
6185 * @addr: Remote client address
6186 * @code: Reason code for connection failure
6187 */
6188 struct connect_failed_reason {
6189 u8 addr[ETH_ALEN];
6190 enum {
6191 MAX_CLIENT_REACHED,
6192 BLOCKED_CLIENT
6193 } code;
6194 } connect_failed_reason;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07006195
6196 /**
6197 * struct dfs_event - Data for radar detected events
6198 * @freq: Frequency of the channel in MHz
6199 */
6200 struct dfs_event {
6201 int freq;
Dmitry Shmidt051af732013-10-22 13:52:46 -07006202 int ht_enabled;
6203 int chan_offset;
6204 enum chan_width chan_width;
6205 int cf1;
6206 int cf2;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07006207 } dfs_event;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07006208
6209 /**
6210 * survey_results - Survey result data for EVENT_SURVEY
6211 * @freq_filter: Requested frequency survey filter, 0 if request
6212 * was for all survey data
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08006213 * @survey_list: Linked list of survey data (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07006214 */
6215 struct survey_results {
6216 unsigned int freq_filter;
6217 struct dl_list survey_list; /* struct freq_survey */
6218 } survey_results;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08006219
6220 /**
6221 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
6222 * @initiator: Initiator of the regulatory change
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07006223 * @type: Regulatory change type
6224 * @alpha2: Country code (or "" if not available)
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08006225 */
6226 struct channel_list_changed {
6227 enum reg_change_initiator initiator;
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07006228 enum reg_type type;
6229 char alpha2[3];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08006230 } channel_list_changed;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08006231
6232 /**
6233 * freq_range - List of frequency ranges
6234 *
6235 * This is used as the data with EVENT_AVOID_FREQUENCIES.
6236 */
6237 struct wpa_freq_range_list freq_range;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08006238
6239 /**
6240 * struct mesh_peer
6241 *
6242 * @peer: Peer address
6243 * @ies: Beacon IEs
6244 * @ie_len: Length of @ies
6245 *
6246 * Notification of new candidate mesh peer.
6247 */
6248 struct mesh_peer {
6249 const u8 *peer;
6250 const u8 *ies;
6251 size_t ie_len;
6252 } mesh_peer;
6253
6254 /**
6255 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08006256 * @pri_freq: Selected primary frequency
6257 * @sec_freq: Selected secondary frequency
Hai Shalomfdcde762020-04-02 11:19:20 -07006258 * @edmg_channel: Selected EDMG channel
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07006259 * @vht_seg0_center_ch: VHT mode Segment0 center channel
Hai Shalomfdcde762020-04-02 11:19:20 -07006260 * The value is the index of the channel center frequency for
6261 * 20 MHz, 40 MHz, and 80 MHz channels. The value is the center
6262 * frequency index of the primary 80 MHz segment for 160 MHz and
6263 * 80+80 MHz channels.
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07006264 * @vht_seg1_center_ch: VHT mode Segment1 center channel
Hai Shalomfdcde762020-04-02 11:19:20 -07006265 * The value is zero for 20 MHz, 40 MHz, and 80 MHz channels. The
6266 * value is the index of the channel center frequency for 160 MHz
6267 * channels and the center frequency index of the secondary 80 MHz
6268 * segment for 80+80 MHz channels.
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07006269 * @ch_width: Selected Channel width by driver. Driver may choose to
6270 * change hostapd configured ACS channel width due driver internal
6271 * channel restrictions.
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07006272 * hw_mode: Selected band (used with hw_mode=any)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08006273 */
6274 struct acs_selected_channels {
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08006275 unsigned int pri_freq;
6276 unsigned int sec_freq;
Hai Shalomfdcde762020-04-02 11:19:20 -07006277 u8 edmg_channel;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07006278 u8 vht_seg0_center_ch;
6279 u8 vht_seg1_center_ch;
6280 u16 ch_width;
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07006281 enum hostapd_hw_mode hw_mode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08006282 } acs_selected_channels;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07006283
6284 /**
6285 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
6286 * @reason_code: Reason for stopping offload
6287 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
6288 * scheduled.
6289 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
6290 * be stopped.
6291 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
6292 * parameters.
6293 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
6294 * supported by device.
6295 */
6296 struct p2p_lo_stop {
6297 enum {
6298 P2P_LO_STOPPED_REASON_COMPLETE = 0,
6299 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
6300 P2P_LO_STOPPED_REASON_INVALID_PARAM,
6301 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
6302 } reason_code;
6303 } p2p_lo_stop;
Roshan Pius3a1667e2018-07-03 15:17:14 -07006304
6305 /* For EVENT_EXTERNAL_AUTH */
6306 struct external_auth external_auth;
6307
6308 /**
6309 * struct sta_opmode - Station's operation mode change event
6310 * @addr: The station MAC address
6311 * @smps_mode: SMPS mode of the station
6312 * @chan_width: Channel width of the station
6313 * @rx_nss: RX_NSS of the station
6314 *
6315 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
6316 */
6317 struct sta_opmode {
6318 const u8 *addr;
6319 enum smps_mode smps_mode;
6320 enum chan_width chan_width;
6321 u8 rx_nss;
6322 } sta_opmode;
6323
6324 /**
6325 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
6326 */
6327 struct wds_sta_interface {
6328 const u8 *sta_addr;
6329 const char *ifname;
6330 enum {
6331 INTERFACE_ADDED,
6332 INTERFACE_REMOVED
6333 } istatus;
6334 } wds_sta_interface;
Hai Shalom81f62d82019-07-22 12:10:00 -07006335
6336 /**
6337 * struct update_dh - Data for EVENT_UPDATE_DH
6338 */
6339 struct update_dh {
6340 const u8 *peer;
6341 const u8 *ie;
6342 size_t ie_len;
6343 } update_dh;
Hai Shalomfdcde762020-04-02 11:19:20 -07006344
6345 /**
6346 * struct unprot_beacon - Data for EVENT_UNPROT_BEACON
6347 */
6348 struct unprot_beacon {
6349 const u8 *sa;
6350 } unprot_beacon;
Sunil Ravia04bd252022-05-02 22:54:18 -07006351
6352 /**
6353 * struct bss_color_collision - Data for EVENT_BSS_COLOR_COLLISION
6354 */
6355 struct bss_color_collision {
6356 u64 bitmap;
6357 } bss_color_collision;
Sunil Ravi89eba102022-09-13 21:04:37 -07006358
6359 /**
6360 * struct pasn_auth - Data for EVENT_PASN_AUTH
6361 */
6362 struct pasn_auth pasn_auth;
6363
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006364};
6365
6366/**
6367 * wpa_supplicant_event - Report a driver event for wpa_supplicant
6368 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
6369 * with struct wpa_driver_ops::init()
6370 * @event: event type (defined above)
6371 * @data: possible extra data for the event
6372 *
6373 * Driver wrapper code should call this function whenever an event is received
6374 * from the driver.
6375 */
6376void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
6377 union wpa_event_data *data);
6378
Dmitry Shmidte4663042016-04-04 10:07:49 -07006379/**
6380 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
6381 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
6382 * with struct wpa_driver_ops::init()
6383 * @event: event type (defined above)
6384 * @data: possible extra data for the event
6385 *
6386 * Same as wpa_supplicant_event(), but we search for the interface in
6387 * wpa_global.
6388 */
6389void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
6390 union wpa_event_data *data);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006391
6392/*
6393 * The following inline functions are provided for convenience to simplify
6394 * event indication for some of the common events.
6395 */
6396
6397static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
6398 size_t ielen, int reassoc)
6399{
6400 union wpa_event_data event;
6401 os_memset(&event, 0, sizeof(event));
6402 event.assoc_info.reassoc = reassoc;
6403 event.assoc_info.req_ies = ie;
6404 event.assoc_info.req_ies_len = ielen;
6405 event.assoc_info.addr = addr;
6406 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
6407}
6408
6409static inline void drv_event_disassoc(void *ctx, const u8 *addr)
6410{
6411 union wpa_event_data event;
6412 os_memset(&event, 0, sizeof(event));
6413 event.disassoc_info.addr = addr;
6414 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
6415}
6416
6417static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
6418 size_t data_len)
6419{
6420 union wpa_event_data event;
6421 os_memset(&event, 0, sizeof(event));
6422 event.eapol_rx.src = src;
6423 event.eapol_rx.data = data;
6424 event.eapol_rx.data_len = data_len;
Sunil8cd6f4d2022-06-28 18:40:46 +00006425 event.eapol_rx.encrypted = FRAME_ENCRYPTION_UNKNOWN;
6426 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
6427}
6428
6429static inline void drv_event_eapol_rx2(void *ctx, const u8 *src, const u8 *data,
6430 size_t data_len,
6431 enum frame_encryption encrypted)
6432{
6433 union wpa_event_data event;
6434 os_memset(&event, 0, sizeof(event));
6435 event.eapol_rx.src = src;
6436 event.eapol_rx.data = data;
6437 event.eapol_rx.data_len = data_len;
6438 event.eapol_rx.encrypted = encrypted;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006439 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
6440}
6441
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08006442/* driver_common.c */
6443void wpa_scan_results_free(struct wpa_scan_results *res);
6444
6445/* Convert wpa_event_type to a string for logging */
6446const char * event_to_string(enum wpa_event_type event);
6447
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07006448/* Convert chan_width to a string for logging and control interfaces */
6449const char * channel_width_to_string(enum chan_width width);
6450
Hai Shalom74f70d42019-02-11 14:42:39 -08006451int channel_width_to_int(enum chan_width width);
6452
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08006453int ht_supported(const struct hostapd_hw_modes *mode);
6454int vht_supported(const struct hostapd_hw_modes *mode);
6455
6456struct wowlan_triggers *
6457wpa_get_wowlan_triggers(const char *wowlan_triggers,
6458 const struct wpa_driver_capa *capa);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07006459/* Convert driver flag to string */
6460const char * driver_flag_to_string(u64 flag);
Hai Shalomb755a2a2020-04-23 21:49:02 -07006461const char * driver_flag2_to_string(u64 flag2);
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08006462
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08006463/* NULL terminated array of linked in driver wrappers */
Dmitry Shmidt1d755d02015-04-28 10:34:29 -07006464extern const struct wpa_driver_ops *const wpa_drivers[];
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08006465
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07006466
6467/* Available drivers */
6468
6469#ifdef CONFIG_DRIVER_WEXT
6470extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
6471#endif /* CONFIG_DRIVER_WEXT */
6472#ifdef CONFIG_DRIVER_NL80211
6473/* driver_nl80211.c */
6474extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
6475#endif /* CONFIG_DRIVER_NL80211 */
6476#ifdef CONFIG_DRIVER_HOSTAP
6477extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
6478#endif /* CONFIG_DRIVER_HOSTAP */
6479#ifdef CONFIG_DRIVER_BSD
6480extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
6481#endif /* CONFIG_DRIVER_BSD */
6482#ifdef CONFIG_DRIVER_OPENBSD
6483/* driver_openbsd.c */
6484extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
6485#endif /* CONFIG_DRIVER_OPENBSD */
6486#ifdef CONFIG_DRIVER_NDIS
6487extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
6488#endif /* CONFIG_DRIVER_NDIS */
6489#ifdef CONFIG_DRIVER_WIRED
6490extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
6491#endif /* CONFIG_DRIVER_WIRED */
6492#ifdef CONFIG_DRIVER_MACSEC_QCA
6493/* driver_macsec_qca.c */
6494extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
6495#endif /* CONFIG_DRIVER_MACSEC_QCA */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08006496#ifdef CONFIG_DRIVER_MACSEC_LINUX
6497/* driver_macsec_linux.c */
6498extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops;
6499#endif /* CONFIG_DRIVER_MACSEC_LINUX */
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07006500#ifdef CONFIG_DRIVER_ROBOSWITCH
6501/* driver_roboswitch.c */
6502extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
6503#endif /* CONFIG_DRIVER_ROBOSWITCH */
6504#ifdef CONFIG_DRIVER_ATHEROS
6505/* driver_atheros.c */
6506extern const struct wpa_driver_ops wpa_driver_atheros_ops;
6507#endif /* CONFIG_DRIVER_ATHEROS */
6508#ifdef CONFIG_DRIVER_NONE
6509extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
6510#endif /* CONFIG_DRIVER_NONE */
6511
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006512#endif /* DRIVER_H */