blob: ad68a076596a9cf8b6b8a7f35b197fc4c32cf13f [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),
69};
70
Dmitry Shmidt849734c2016-05-27 09:59:01 -070071/* Filter gratuitous ARP */
72#define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
73/* Filter unsolicited Neighbor Advertisement */
74#define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
75/* Filter unicast IP packets encrypted using the GTK */
76#define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)
77
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070078#define HOSTAPD_DFS_REGION_FCC 1
79#define HOSTAPD_DFS_REGION_ETSI 2
80#define HOSTAPD_DFS_REGION_JP 3
81
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080082/**
83 * enum reg_change_initiator - Regulatory change initiator
84 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -080085enum reg_change_initiator {
86 REGDOM_SET_BY_CORE,
87 REGDOM_SET_BY_USER,
88 REGDOM_SET_BY_DRIVER,
89 REGDOM_SET_BY_COUNTRY_IE,
Dmitry Shmidt97672262014-02-03 13:02:54 -080090 REGDOM_BEACON_HINT,
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -080091};
92
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080093/**
94 * enum reg_type - Regulatory change types
95 */
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -070096enum reg_type {
97 REGDOM_TYPE_UNKNOWN,
98 REGDOM_TYPE_COUNTRY,
99 REGDOM_TYPE_WORLD,
100 REGDOM_TYPE_CUSTOM_WORLD,
101 REGDOM_TYPE_INTERSECTION,
102};
103
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700104/**
Hai Shalom81f62d82019-07-22 12:10:00 -0700105 * struct hostapd_wmm_rule - WMM regulatory rule
106 * @min_cwmin: Lower bound of CW_min value
107 * @min_cwmax: Lower bound of CW_max value
108 * @min_aifs: Lower bound of AIFS value
109 * @max_txop: Upper bound of TXOP, value in units of 32 usec
110 */
111struct hostapd_wmm_rule {
112 int min_cwmin;
113 int min_cwmax;
114 int min_aifs;
115 int max_txop;
116};
117
118/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700119 * struct hostapd_channel_data - Channel information
120 */
121struct hostapd_channel_data {
122 /**
123 * chan - Channel number (IEEE 802.11)
124 */
125 short chan;
126
127 /**
128 * freq - Frequency in MHz
129 */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800130 int freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700131
132 /**
133 * flag - Channel flags (HOSTAPD_CHAN_*)
134 */
135 int flag;
136
137 /**
Hai Shalom74f70d42019-02-11 14:42:39 -0800138 * allowed_bw - Allowed channel width bitmask
139 *
140 * See enum hostapd_chan_width_attr.
141 */
142 u32 allowed_bw;
143
144 /**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -0700145 * max_tx_power - Regulatory transmit power limit in dBm
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700146 */
147 u8 max_tx_power;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -0700148
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800149 /**
150 * survey_list - Linked list of surveys (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -0700151 */
152 struct dl_list survey_list;
153
154 /**
155 * min_nf - Minimum observed noise floor, in dBm, based on all
156 * surveyed channel data
157 */
158 s8 min_nf;
Dmitry Shmidt391c59f2013-09-03 12:16:28 -0700159
160#ifdef CONFIG_ACS
161 /**
162 * interference_factor - Computed interference factor on this
163 * channel (used internally in src/ap/acs.c; driver wrappers do not
164 * need to set this)
165 */
166 long double interference_factor;
167#endif /* CONFIG_ACS */
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -0700168
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800169 /**
170 * dfs_cac_ms - DFS CAC time in milliseconds
171 */
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -0700172 unsigned int dfs_cac_ms;
Hai Shalom81f62d82019-07-22 12:10:00 -0700173
174 /**
175 * wmm_rules_valid - Indicates wmm_rules state
176 */
177 int wmm_rules_valid;
178
179 /**
180 * wmm_rules - WMM regulatory rules
181 */
182 struct hostapd_wmm_rule wmm_rules[WMM_AC_NUM];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700183};
184
Hai Shalom81f62d82019-07-22 12:10:00 -0700185#define HE_MAX_MAC_CAPAB_SIZE 6
186#define HE_MAX_PHY_CAPAB_SIZE 11
187#define HE_MAX_MCS_CAPAB_SIZE 12
188#define HE_MAX_PPET_CAPAB_SIZE 25
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800189
190/**
191 * struct he_capabilities - IEEE 802.11ax HE capabilities
192 */
193struct he_capabilities {
194 u8 he_supported;
Hai Shalom81f62d82019-07-22 12:10:00 -0700195 u8 phy_cap[HE_MAX_PHY_CAPAB_SIZE];
196 u8 mac_cap[HE_MAX_MAC_CAPAB_SIZE];
197 u8 mcs[HE_MAX_MCS_CAPAB_SIZE];
198 u8 ppet[HE_MAX_PPET_CAPAB_SIZE];
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800199};
200
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800201#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -0700202#define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800203
Hai Shalom81f62d82019-07-22 12:10:00 -0700204
205enum ieee80211_op_mode {
206 IEEE80211_MODE_INFRA = 0,
207 IEEE80211_MODE_IBSS = 1,
208 IEEE80211_MODE_AP = 2,
209 IEEE80211_MODE_MESH = 5,
210
211 /* only add new entries before IEEE80211_MODE_NUM */
212 IEEE80211_MODE_NUM
213};
214
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700215/**
Hai Shalomc3565922019-10-28 11:58:20 -0700216 * struct ieee80211_edmg_config - EDMG configuration
217 *
218 * This structure describes most essential parameters needed
219 * for IEEE 802.11ay EDMG configuration
220 *
221 * @channels: Bitmap that indicates the 2.16 GHz channel(s)
222 * that are allowed to be used for transmissions.
223 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
224 * Set to 0 to indicate EDMG not supported.
225 * @bw_config: Channel BW Configuration subfield encodes
226 * the allowed channel bandwidth configurations
227 */
228struct ieee80211_edmg_config {
229 u8 channels;
230 enum edmg_bw_config bw_config;
231};
232
233/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700234 * struct hostapd_hw_modes - Supported hardware mode information
235 */
236struct hostapd_hw_modes {
237 /**
238 * mode - Hardware mode
239 */
240 enum hostapd_hw_mode mode;
241
242 /**
243 * num_channels - Number of entries in the channels array
244 */
245 int num_channels;
246
247 /**
248 * channels - Array of supported channels
249 */
250 struct hostapd_channel_data *channels;
251
252 /**
253 * num_rates - Number of entries in the rates array
254 */
255 int num_rates;
256
257 /**
258 * rates - Array of supported rates in 100 kbps units
259 */
260 int *rates;
261
262 /**
263 * ht_capab - HT (IEEE 802.11n) capabilities
264 */
265 u16 ht_capab;
266
267 /**
268 * mcs_set - MCS (IEEE 802.11n) rate parameters
269 */
270 u8 mcs_set[16];
271
272 /**
273 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
274 */
275 u8 a_mpdu_params;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800276
Dmitry Shmidt04949592012-07-19 12:16:46 -0700277 /**
278 * vht_capab - VHT (IEEE 802.11ac) capabilities
279 */
280 u32 vht_capab;
281
282 /**
283 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
284 */
285 u8 vht_mcs_set[8];
286
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800287 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800288
289 /**
290 * he_capab - HE (IEEE 802.11ax) capabilities
291 */
Hai Shalom81f62d82019-07-22 12:10:00 -0700292 struct he_capabilities he_capab[IEEE80211_MODE_NUM];
Hai Shalomc3565922019-10-28 11:58:20 -0700293
294 /**
295 * This structure describes the most essential parameters needed
296 * for IEEE 802.11ay EDMG configuration.
297 */
298 struct ieee80211_edmg_config edmg;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700299};
300
301
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700302#define IEEE80211_CAP_ESS 0x0001
303#define IEEE80211_CAP_IBSS 0x0002
304#define IEEE80211_CAP_PRIVACY 0x0010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800305#define IEEE80211_CAP_RRM 0x1000
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700306
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800307/* DMG (60 GHz) IEEE 802.11ad */
308/* type - bits 0..1 */
309#define IEEE80211_CAP_DMG_MASK 0x0003
310#define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
311#define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
312#define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
313
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700314#define WPA_SCAN_QUAL_INVALID BIT(0)
315#define WPA_SCAN_NOISE_INVALID BIT(1)
316#define WPA_SCAN_LEVEL_INVALID BIT(2)
317#define WPA_SCAN_LEVEL_DBM BIT(3)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700318#define WPA_SCAN_ASSOCIATED BIT(5)
319
320/**
321 * struct wpa_scan_res - Scan result for an BSS/IBSS
322 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
323 * @bssid: BSSID
324 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
325 * @beacon_int: beacon interval in TUs (host byte order)
326 * @caps: capability information field in host byte order
327 * @qual: signal quality
328 * @noise: noise level
329 * @level: signal level
330 * @tsf: Timestamp
331 * @age: Age of the information in milliseconds (i.e., how many milliseconds
332 * ago the last Beacon or Probe Response frame was received)
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800333 * @est_throughput: Estimated throughput in kbps (this is calculated during
334 * scan result processing if left zero by the driver wrapper)
335 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
Dmitry Shmidt29333592017-01-09 12:27:11 -0800336 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
337 * of TSF of the BSS specified by %tsf_bssid.
338 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700339 * @ie_len: length of the following IE field in octets
340 * @beacon_ie_len: length of the following Beacon IE field in octets
341 *
342 * This structure is used as a generic format for scan results from the
343 * driver. Each driver interface implementation is responsible for converting
344 * the driver or OS specific scan results into this format.
345 *
346 * If the driver does not support reporting all IEs, the IE data structure is
347 * constructed of the IEs that are available. This field will also need to
348 * include SSID in IE format. All drivers are encouraged to be extended to
349 * report all IEs to make it easier to support future additions.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800350 *
351 * This structure data is followed by ie_len octets of IEs from Probe Response
352 * frame (or if the driver does not indicate source of IEs, these may also be
353 * from Beacon frame). After the first set of IEs, another set of IEs may follow
354 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700355 */
356struct wpa_scan_res {
357 unsigned int flags;
358 u8 bssid[ETH_ALEN];
359 int freq;
360 u16 beacon_int;
361 u16 caps;
362 int qual;
363 int noise;
364 int level;
365 u64 tsf;
366 unsigned int age;
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800367 unsigned int est_throughput;
368 int snr;
Dmitry Shmidt29333592017-01-09 12:27:11 -0800369 u64 parent_tsf;
370 u8 tsf_bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700371 size_t ie_len;
372 size_t beacon_ie_len;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800373 /* Followed by ie_len + beacon_ie_len octets of IE data */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700374};
375
376/**
377 * struct wpa_scan_results - Scan results
378 * @res: Array of pointers to allocated variable length scan result entries
379 * @num: Number of entries in the scan result array
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800380 * @fetch_time: Time when the results were fetched from the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700381 */
382struct wpa_scan_results {
383 struct wpa_scan_res **res;
384 size_t num;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800385 struct os_reltime fetch_time;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700386};
387
388/**
389 * struct wpa_interface_info - Network interface information
390 * @next: Pointer to the next interface or NULL if this is the last one
391 * @ifname: Interface name that can be used with init() or init2()
392 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
393 * not available
394 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
395 * is not an allocated copy, i.e., get_interfaces() caller will not free
396 * this)
397 */
398struct wpa_interface_info {
399 struct wpa_interface_info *next;
400 char *ifname;
401 char *desc;
402 const char *drv_name;
403};
404
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800405#define WPAS_MAX_SCAN_SSIDS 16
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700406
407/**
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800408 * struct wpa_driver_scan_ssid - SSIDs to scan for
409 * @ssid - specific SSID to scan for (ProbeReq)
410 * %NULL or zero-length SSID is used to indicate active scan
411 * with wildcard SSID.
412 * @ssid_len - Length of the SSID in octets
413 */
414struct wpa_driver_scan_ssid {
415 const u8 *ssid;
416 size_t ssid_len;
417};
418
419/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700420 * struct wpa_driver_scan_params - Scan parameters
421 * Data for struct wpa_driver_ops::scan2().
422 */
423struct wpa_driver_scan_params {
424 /**
425 * ssids - SSIDs to scan for
426 */
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800427 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700428
429 /**
430 * num_ssids - Number of entries in ssids array
431 * Zero indicates a request for a passive scan.
432 */
433 size_t num_ssids;
434
435 /**
436 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
437 */
438 const u8 *extra_ies;
439
440 /**
441 * extra_ies_len - Length of extra_ies in octets
442 */
443 size_t extra_ies_len;
444
445 /**
446 * freqs - Array of frequencies to scan or %NULL for all frequencies
447 *
448 * The frequency is set in MHz. The array is zero-terminated.
449 */
450 int *freqs;
451
452 /**
453 * filter_ssids - Filter for reporting SSIDs
454 *
455 * This optional parameter can be used to request the driver wrapper to
456 * filter scan results to include only the specified SSIDs. %NULL
457 * indicates that no filtering is to be done. This can be used to
458 * reduce memory needs for scan results in environments that have large
459 * number of APs with different SSIDs.
460 *
461 * The driver wrapper is allowed to take this allocated buffer into its
462 * own use by setting the pointer to %NULL. In that case, the driver
463 * wrapper is responsible for freeing the buffer with os_free() once it
464 * is not needed anymore.
465 */
466 struct wpa_driver_scan_filter {
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -0700467 u8 ssid[SSID_MAX_LEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700468 size_t ssid_len;
469 } *filter_ssids;
470
471 /**
472 * num_filter_ssids - Number of entries in filter_ssids array
473 */
474 size_t num_filter_ssids;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800475
476 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700477 * filter_rssi - Filter by RSSI
478 *
479 * The driver may filter scan results in firmware to reduce host
480 * wakeups and thereby save power. Specify the RSSI threshold in s32
481 * dBm.
482 */
483 s32 filter_rssi;
484
485 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800486 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
487 *
488 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
489 * Mbps from the support rates element(s) in the Probe Request frames
490 * and not to transmit the frames at any of those rates.
491 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700492 unsigned int p2p_probe:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800493
494 /**
495 * only_new_results - Request driver to report only new results
496 *
497 * This is used to request the driver to report only BSSes that have
498 * been detected after this scan request has been started, i.e., to
499 * flush old cached BSS entries.
500 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700501 unsigned int only_new_results:1;
502
503 /**
504 * low_priority - Requests driver to use a lower scan priority
505 *
506 * This is used to request the driver to use a lower scan priority
507 * if it supports such a thing.
508 */
509 unsigned int low_priority:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800510
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800511 /**
512 * mac_addr_rand - Requests driver to randomize MAC address
513 */
514 unsigned int mac_addr_rand:1;
515
516 /**
517 * mac_addr - MAC address used with randomization. The address cannot be
518 * a multicast one, i.e., bit 0 of byte 0 should not be set.
519 */
Hai Shalomc3565922019-10-28 11:58:20 -0700520 u8 *mac_addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800521
522 /**
523 * mac_addr_mask - MAC address mask used with randomization.
524 *
525 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
526 * the mask should be taken as is from mac_addr. The mask should not
527 * allow the generation of a multicast address, i.e., bit 0 of byte 0
528 * must be set.
529 */
530 const u8 *mac_addr_mask;
531
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800532 /**
533 * sched_scan_plans - Scan plans for scheduled scan
534 *
535 * Each scan plan consists of the number of iterations to scan and the
536 * interval between scans. When a scan plan finishes (i.e., it was run
537 * for the specified number of iterations), the next scan plan is
538 * executed. The scan plans are executed in the order they appear in
539 * the array (lower index first). The last scan plan will run infinitely
540 * (until requested to stop), thus must not specify the number of
541 * iterations. All other scan plans must specify the number of
542 * iterations.
543 */
544 struct sched_scan_plan {
545 u32 interval; /* In seconds */
546 u32 iterations; /* Zero to run infinitely */
547 } *sched_scan_plans;
548
549 /**
550 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
551 */
552 unsigned int sched_scan_plans_num;
553
Dmitry Shmidt9c175262016-03-03 10:20:07 -0800554 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700555 * sched_scan_start_delay - Delay to use before starting the first scan
556 *
557 * Delay (in seconds) before scheduling first scan plan cycle. The
558 * driver may ignore this parameter and start immediately (or at any
559 * other time), if this feature is not supported.
560 */
561 u32 sched_scan_start_delay;
562
563 /**
Dmitry Shmidt9c175262016-03-03 10:20:07 -0800564 * bssid - Specific BSSID to scan for
565 *
566 * This optional parameter can be used to replace the default wildcard
567 * BSSID with a specific BSSID to scan for if results are needed from
568 * only a single BSS.
569 */
570 const u8 *bssid;
571
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800572 /**
573 * scan_cookie - Unique identification representing the scan request
574 *
575 * This scan_cookie carries a unique identification representing the
576 * scan request if the host driver/kernel supports concurrent scan
577 * requests. This cookie is returned from the corresponding driver
578 * interface.
579 *
580 * Note: Unlike other parameters in this structure, scan_cookie is used
581 * only to return information instead of setting parameters for the
582 * scan.
583 */
584 u64 scan_cookie;
585
Dmitry Shmidt29333592017-01-09 12:27:11 -0800586 /**
587 * duration - Dwell time on each channel
588 *
589 * This optional parameter can be used to set the dwell time on each
590 * channel. In TUs.
591 */
592 u16 duration;
593
594 /**
595 * duration_mandatory - Whether the specified duration is mandatory
596 *
597 * If this is set, the duration specified by the %duration field is
598 * mandatory (and the driver should reject the scan request if it is
599 * unable to comply with the specified duration), otherwise it is the
600 * maximum duration and the actual duration may be shorter.
601 */
602 unsigned int duration_mandatory:1;
603
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800604 /**
605 * relative_rssi_set - Whether relative RSSI parameters are set
606 */
607 unsigned int relative_rssi_set:1;
608
609 /**
610 * relative_rssi - Relative RSSI for reporting better BSSs
611 *
612 * Amount of RSSI by which a BSS should be better than the current
613 * connected BSS to report the new BSS to user space.
614 */
615 s8 relative_rssi;
616
617 /**
618 * relative_adjust_band - Band to which RSSI should be adjusted
619 *
620 * The relative_adjust_rssi should be added to the band specified
621 * by relative_adjust_band.
622 */
623 enum set_band relative_adjust_band;
624
625 /**
626 * relative_adjust_rssi - RSSI to be added to relative_adjust_band
627 *
628 * An amount of relative_band_rssi should be added to the BSSs that
629 * belong to the band specified by relative_adjust_band while comparing
630 * with other bands for BSS reporting.
631 */
632 s8 relative_adjust_rssi;
633
Hai Shalomce48b4a2018-09-05 11:41:35 -0700634 /**
635 * oce_scan
636 *
637 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0)
638 * - Accept broadcast Probe Response frame.
639 * - Probe Request frame deferral and suppression.
640 * - Max Channel Time - driver fills FILS request params IE with
641 * Maximum Channel Time.
642 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps.
643 */
644 unsigned int oce_scan:1;
645
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800646 /*
647 * NOTE: Whenever adding new parameters here, please make sure
648 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
649 * matching changes.
650 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700651};
652
653/**
654 * struct wpa_driver_auth_params - Authentication parameters
655 * Data for struct wpa_driver_ops::authenticate().
656 */
657struct wpa_driver_auth_params {
658 int freq;
659 const u8 *bssid;
660 const u8 *ssid;
661 size_t ssid_len;
662 int auth_alg;
663 const u8 *ie;
664 size_t ie_len;
665 const u8 *wep_key[4];
666 size_t wep_key_len[4];
667 int wep_tx_keyidx;
668 int local_state_change;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800669
670 /**
671 * p2p - Whether this connection is a P2P group
672 */
673 int p2p;
674
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800675 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800676 * auth_data - Additional elements for Authentication frame
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800677 *
678 * This buffer starts with the Authentication transaction sequence
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800679 * number field. If no special handling of such elements is needed, this
680 * pointer is %NULL. This is used with SAE and FILS.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800681 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800682 const u8 *auth_data;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800683
684 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800685 * auth_data_len - Length of auth_data buffer in octets
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800686 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800687 size_t auth_data_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700688};
689
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800690/**
691 * enum wps_mode - WPS mode
692 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700693enum wps_mode {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800694 /**
695 * WPS_MODE_NONE - No WPS provisioning being used
696 */
697 WPS_MODE_NONE,
698
699 /**
700 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
701 */
702 WPS_MODE_OPEN,
703
704 /**
705 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
706 */
707 WPS_MODE_PRIVACY
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700708};
709
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800710/**
711 * struct hostapd_freq_params - Channel parameters
712 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700713struct hostapd_freq_params {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800714 /**
715 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
716 */
717 enum hostapd_hw_mode mode;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700718
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800719 /**
720 * freq - Primary channel center frequency in MHz
721 */
722 int freq;
723
724 /**
725 * channel - Channel number
726 */
727 int channel;
728
729 /**
730 * ht_enabled - Whether HT is enabled
731 */
732 int ht_enabled;
733
734 /**
735 * sec_channel_offset - Secondary channel offset for HT40
736 *
737 * 0 = HT40 disabled,
738 * -1 = HT40 enabled, secondary channel below primary,
739 * 1 = HT40 enabled, secondary channel above primary
740 */
741 int sec_channel_offset;
742
743 /**
744 * vht_enabled - Whether VHT is enabled
745 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700746 int vht_enabled;
747
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800748 /**
Hai Shalom81f62d82019-07-22 12:10:00 -0700749 * he_enabled - Whether HE is enabled
750 */
751 int he_enabled;
752
753 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800754 * center_freq1 - Segment 0 center frequency in MHz
755 *
756 * Valid for both HT and VHT.
757 */
758 int center_freq1;
759
760 /**
761 * center_freq2 - Segment 1 center frequency in MHz
762 *
763 * Non-zero only for bandwidth 80 and an 80+80 channel
764 */
765 int center_freq2;
766
767 /**
768 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
769 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700770 int bandwidth;
Hai Shalomc3565922019-10-28 11:58:20 -0700771
772 /**
773 * This structure describes the most essential parameters needed
774 * for IEEE 802.11ay EDMG configuration.
775 */
776 struct ieee80211_edmg_config edmg;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700777};
778
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700779/**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700780 * struct wpa_driver_sta_auth_params - Authentication parameters
781 * Data for struct wpa_driver_ops::sta_auth().
782 */
783struct wpa_driver_sta_auth_params {
784
785 /**
786 * own_addr - Source address and BSSID for authentication frame
787 */
788 const u8 *own_addr;
789
790 /**
791 * addr - MAC address of the station to associate
792 */
793 const u8 *addr;
794
795 /**
796 * seq - authentication sequence number
797 */
798 u16 seq;
799
800 /**
801 * status - authentication response status code
802 */
803 u16 status;
804
805 /**
806 * ie - authentication frame ie buffer
807 */
808 const u8 *ie;
809
810 /**
811 * len - ie buffer length
812 */
813 size_t len;
814
815 /**
816 * fils_auth - Indicates whether FILS authentication is being performed
817 */
818 int fils_auth;
819
820 /**
821 * fils_anonce - ANonce (required for FILS)
822 */
823 u8 fils_anonce[WPA_NONCE_LEN];
824
825 /**
826 * fils_snonce - SNonce (required for FILS)
827 */
828 u8 fils_snonce[WPA_NONCE_LEN];
829
830 /**
831 * fils_kek - key for encryption (required for FILS)
832 */
833 u8 fils_kek[WPA_KEK_MAX_LEN];
834
835 /**
836 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
837 */
838 size_t fils_kek_len;
839};
840
841/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700842 * struct wpa_driver_associate_params - Association parameters
843 * Data for struct wpa_driver_ops::associate().
844 */
845struct wpa_driver_associate_params {
846 /**
847 * bssid - BSSID of the selected AP
848 * This can be %NULL, if ap_scan=2 mode is used and the driver is
849 * responsible for selecting with which BSS to associate. */
850 const u8 *bssid;
851
852 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800853 * bssid_hint - BSSID of a proposed AP
854 *
855 * This indicates which BSS has been found a suitable candidate for
856 * initial association for drivers that use driver/firmwate-based BSS
857 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
858 * the driver from selecting other BSSes in the ESS.
859 */
860 const u8 *bssid_hint;
861
862 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700863 * ssid - The selected SSID
864 */
865 const u8 *ssid;
866
867 /**
868 * ssid_len - Length of the SSID (1..32)
869 */
870 size_t ssid_len;
871
872 /**
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700873 * freq - channel parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700874 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700875 struct hostapd_freq_params freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700876
877 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800878 * freq_hint - Frequency of the channel the proposed AP is using
879 *
880 * This provides a channel on which a suitable BSS has been found as a
881 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
882 * limit the driver from selecting other channels for
883 * driver/firmware-based BSS selection.
884 */
885 int freq_hint;
886
887 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700888 * bg_scan_period - Background scan period in seconds, 0 to disable
889 * background scan, or -1 to indicate no change to default driver
890 * configuration
891 */
892 int bg_scan_period;
893
894 /**
Dmitry Shmidt2ac5f602014-03-07 10:08:21 -0800895 * beacon_int - Beacon interval for IBSS or 0 to use driver default
896 */
897 int beacon_int;
898
899 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700900 * wpa_ie - WPA information element for (Re)Association Request
901 * WPA information element to be included in (Re)Association
902 * Request (including information element id and length). Use
903 * of this WPA IE is optional. If the driver generates the WPA
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700904 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700905 * key_mgmt_suite to select proper algorithms. In this case,
906 * the driver has to notify wpa_supplicant about the used WPA
907 * IE by generating an event that the interface code will
908 * convert into EVENT_ASSOCINFO data (see below).
909 *
910 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
911 * instead. The driver can determine which version is used by
912 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
913 * WPA2/RSN).
914 *
915 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
916 */
917 const u8 *wpa_ie;
918
919 /**
920 * wpa_ie_len - length of the wpa_ie
921 */
922 size_t wpa_ie_len;
923
924 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800925 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
926 */
927 unsigned int wpa_proto;
928
929 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800930 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700931 *
932 * This is usually ignored if @wpa_ie is used.
933 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800934 unsigned int pairwise_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700935
936 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800937 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700938 *
939 * This is usually ignored if @wpa_ie is used.
940 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800941 unsigned int group_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700942
943 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700944 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
945 *
946 * This is usually ignored if @wpa_ie is used.
947 */
948 unsigned int mgmt_group_suite;
949
950 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800951 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700952 *
953 * This is usually ignored if @wpa_ie is used.
954 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800955 unsigned int key_mgmt_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700956
957 /**
958 * auth_alg - Allowed authentication algorithms
959 * Bit field of WPA_AUTH_ALG_*
960 */
961 int auth_alg;
962
963 /**
964 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
965 */
966 int mode;
967
968 /**
969 * wep_key - WEP keys for static WEP configuration
970 */
971 const u8 *wep_key[4];
972
973 /**
974 * wep_key_len - WEP key length for static WEP configuration
975 */
976 size_t wep_key_len[4];
977
978 /**
979 * wep_tx_keyidx - WEP TX key index for static WEP configuration
980 */
981 int wep_tx_keyidx;
982
983 /**
984 * mgmt_frame_protection - IEEE 802.11w management frame protection
985 */
986 enum mfp_options mgmt_frame_protection;
987
988 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700989 * passphrase - RSN passphrase for PSK
990 *
991 * This value is made available only for WPA/WPA2-Personal (PSK) and
Hai Shalom74f70d42019-02-11 14:42:39 -0800992 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
993 * is the 8..63 character ASCII passphrase, if available. Please note
994 * that this can be %NULL if passphrase was not used to generate the
995 * PSK. In that case, the psk field must be used to fetch the PSK.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700996 */
997 const char *passphrase;
998
999 /**
1000 * psk - RSN PSK (alternative for passphrase for PSK)
1001 *
1002 * This value is made available only for WPA/WPA2-Personal (PSK) and
Hai Shalom74f70d42019-02-11 14:42:39 -08001003 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
1004 * is the 32-octet (256-bit) PSK, if available. The driver wrapper
1005 * should be prepared to handle %NULL value as an error.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001006 */
1007 const u8 *psk;
1008
1009 /**
1010 * drop_unencrypted - Enable/disable unencrypted frame filtering
1011 *
1012 * Configure the driver to drop all non-EAPOL frames (both receive and
1013 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
1014 * still be allowed for key negotiation.
1015 */
1016 int drop_unencrypted;
1017
1018 /**
1019 * prev_bssid - Previously used BSSID in this ESS
1020 *
1021 * When not %NULL, this is a request to use reassociation instead of
1022 * association.
1023 */
1024 const u8 *prev_bssid;
1025
1026 /**
1027 * wps - WPS mode
1028 *
1029 * If the driver needs to do special configuration for WPS association,
1030 * this variable provides more information on what type of association
1031 * is being requested. Most drivers should not need ot use this.
1032 */
1033 enum wps_mode wps;
1034
1035 /**
1036 * p2p - Whether this connection is a P2P group
1037 */
1038 int p2p;
1039
1040 /**
1041 * uapsd - UAPSD parameters for the network
1042 * -1 = do not change defaults
1043 * AP mode: 1 = enabled, 0 = disabled
1044 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
1045 */
1046 int uapsd;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001047
1048 /**
1049 * fixed_bssid - Whether to force this BSSID in IBSS mode
1050 * 1 = Fix this BSSID and prevent merges.
1051 * 0 = Do not fix BSSID.
1052 */
1053 int fixed_bssid;
1054
1055 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001056 * fixed_freq - Fix control channel in IBSS mode
1057 * 0 = don't fix control channel (default)
1058 * 1 = fix control channel; this prevents IBSS merging with another
1059 * channel
1060 */
1061 int fixed_freq;
1062
1063 /**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001064 * disable_ht - Disable HT (IEEE 802.11n) for this connection
1065 */
1066 int disable_ht;
1067
1068 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001069 * htcaps - HT Capabilities over-rides
1070 *
1071 * Only bits set in the mask will be used, and not all values are used
1072 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
1073 *
1074 * Pointer to struct ieee80211_ht_capabilities.
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001075 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001076 const u8 *htcaps;
1077
1078 /**
1079 * htcaps_mask - HT Capabilities over-rides mask
1080 *
1081 * Pointer to struct ieee80211_ht_capabilities.
1082 */
1083 const u8 *htcaps_mask;
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001084
1085#ifdef CONFIG_VHT_OVERRIDES
1086 /**
1087 * disable_vht - Disable VHT for this connection
1088 */
1089 int disable_vht;
1090
1091 /**
1092 * VHT capability overrides.
1093 */
1094 const struct ieee80211_vht_capabilities *vhtcaps;
1095 const struct ieee80211_vht_capabilities *vhtcaps_mask;
1096#endif /* CONFIG_VHT_OVERRIDES */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001097
1098 /**
1099 * req_key_mgmt_offload - Request key management offload for connection
1100 *
1101 * Request key management offload for this connection if the device
1102 * supports it.
1103 */
1104 int req_key_mgmt_offload;
1105
1106 /**
Hai Shalomc3565922019-10-28 11:58:20 -07001107 * req_handshake_offload - Request EAPOL handshake offload
1108 *
1109 * Request EAPOL handshake offload for this connection if the device
1110 * supports it.
1111 */
1112 int req_handshake_offload;
1113
1114 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001115 * Flag for indicating whether this association includes support for
1116 * RRM (Radio Resource Measurements)
1117 */
1118 int rrm_used;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001119
1120 /**
1121 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1122 * AP as usual. Valid for DMG network only.
1123 */
1124 int pbss;
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001125
1126 /**
1127 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1128 */
1129 const u8 *fils_kek;
1130
1131 /**
1132 * fils_kek_len: Length of fils_kek in bytes
1133 */
1134 size_t fils_kek_len;
1135
1136 /**
1137 * fils_nonces - Nonces for FILS association frame protection
1138 * (AES-SIV AAD)
1139 */
1140 const u8 *fils_nonces;
1141
1142 /**
1143 * fils_nonces_len: Length of fils_nonce in bytes
1144 */
1145 size_t fils_nonces_len;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001146
1147 /**
1148 * fils_erp_username - Username part of keyName-NAI
1149 */
1150 const u8 *fils_erp_username;
1151
1152 /**
1153 * fils_erp_username_len - Length of fils_erp_username in bytes
1154 */
1155 size_t fils_erp_username_len;
1156
1157 /**
1158 * fils_erp_realm - Realm/domain name to use in FILS ERP
1159 */
1160 const u8 *fils_erp_realm;
1161
1162 /**
1163 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1164 */
1165 size_t fils_erp_realm_len;
1166
1167 /**
1168 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1169 * messages
1170 */
1171 u16 fils_erp_next_seq_num;
1172
1173 /**
1174 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1175 * specified by fils_erp_username@fils_erp_realm.
1176 */
1177 const u8 *fils_erp_rrk;
1178
1179 /**
1180 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1181 */
1182 size_t fils_erp_rrk_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001183};
1184
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001185enum hide_ssid {
1186 NO_SSID_HIDING,
1187 HIDDEN_SSID_ZERO_LEN,
1188 HIDDEN_SSID_ZERO_CONTENTS
1189};
1190
Hai Shalom81f62d82019-07-22 12:10:00 -07001191enum ch_switch_state {
1192 CH_SW_STARTED,
1193 CH_SW_FINISHED
1194};
1195
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001196struct wowlan_triggers {
1197 u8 any;
1198 u8 disconnect;
1199 u8 magic_pkt;
1200 u8 gtk_rekey_failure;
1201 u8 eap_identity_req;
1202 u8 four_way_handshake;
1203 u8 rfkill_release;
1204};
1205
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001206struct wpa_driver_ap_params {
1207 /**
1208 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1209 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001210 u8 *head;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001211
1212 /**
1213 * head_len - Length of the head buffer in octets
1214 */
1215 size_t head_len;
1216
1217 /**
1218 * tail - Beacon tail following TIM IE
1219 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001220 u8 *tail;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001221
1222 /**
1223 * tail_len - Length of the tail buffer in octets
1224 */
1225 size_t tail_len;
1226
1227 /**
1228 * dtim_period - DTIM period
1229 */
1230 int dtim_period;
1231
1232 /**
1233 * beacon_int - Beacon interval
1234 */
1235 int beacon_int;
1236
1237 /**
1238 * basic_rates: -1 terminated array of basic rates in 100 kbps
1239 *
1240 * This parameter can be used to set a specific basic rate set for the
1241 * BSS. If %NULL, default basic rate set is used.
1242 */
1243 int *basic_rates;
1244
1245 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001246 * beacon_rate: Beacon frame data rate
1247 *
1248 * This parameter can be used to set a specific Beacon frame data rate
1249 * for the BSS. The interpretation of this value depends on the
1250 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS). If
1251 * beacon_rate == 0 and rate_type == 0 (BEACON_RATE_LEGACY), the default
1252 * Beacon frame data rate is used.
1253 */
1254 unsigned int beacon_rate;
1255
1256 /**
1257 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT)
1258 */
1259 enum beacon_rate_type rate_type;
1260
1261 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001262 * proberesp - Probe Response template
1263 *
1264 * This is used by drivers that reply to Probe Requests internally in
1265 * AP mode and require the full Probe Response template.
1266 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001267 u8 *proberesp;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001268
1269 /**
1270 * proberesp_len - Length of the proberesp buffer in octets
1271 */
1272 size_t proberesp_len;
1273
1274 /**
1275 * ssid - The SSID to use in Beacon/Probe Response frames
1276 */
1277 const u8 *ssid;
1278
1279 /**
1280 * ssid_len - Length of the SSID (1..32)
1281 */
1282 size_t ssid_len;
1283
1284 /**
1285 * hide_ssid - Whether to hide the SSID
1286 */
1287 enum hide_ssid hide_ssid;
1288
1289 /**
1290 * pairwise_ciphers - WPA_CIPHER_* bitfield
1291 */
1292 unsigned int pairwise_ciphers;
1293
1294 /**
1295 * group_cipher - WPA_CIPHER_*
1296 */
1297 unsigned int group_cipher;
1298
1299 /**
1300 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1301 */
1302 unsigned int key_mgmt_suites;
1303
1304 /**
1305 * auth_algs - WPA_AUTH_ALG_* bitfield
1306 */
1307 unsigned int auth_algs;
1308
1309 /**
1310 * wpa_version - WPA_PROTO_* bitfield
1311 */
1312 unsigned int wpa_version;
1313
1314 /**
1315 * privacy - Whether privacy is used in the BSS
1316 */
1317 int privacy;
1318
1319 /**
1320 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1321 *
1322 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1323 * not use the full Beacon template.
1324 */
1325 const struct wpabuf *beacon_ies;
1326
1327 /**
1328 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1329 *
1330 * This is used to add IEs like WPS IE and P2P IE by drivers that
1331 * reply to Probe Request frames internally.
1332 */
1333 const struct wpabuf *proberesp_ies;
1334
1335 /**
1336 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1337 *
1338 * This is used to add IEs like WPS IE by drivers that reply to
1339 * (Re)Association Request frames internally.
1340 */
1341 const struct wpabuf *assocresp_ies;
1342
1343 /**
1344 * isolate - Whether to isolate frames between associated stations
1345 *
1346 * If this is non-zero, the AP is requested to disable forwarding of
1347 * frames between associated stations.
1348 */
1349 int isolate;
1350
1351 /**
1352 * cts_protect - Whether CTS protection is enabled
1353 */
1354 int cts_protect;
1355
1356 /**
1357 * preamble - Whether short preamble is enabled
1358 */
1359 int preamble;
1360
1361 /**
1362 * short_slot_time - Whether short slot time is enabled
1363 *
1364 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1365 * not set (e.g., when 802.11g mode is not in use)
1366 */
1367 int short_slot_time;
1368
1369 /**
1370 * ht_opmode - HT operation mode or -1 if HT not in use
1371 */
1372 int ht_opmode;
1373
1374 /**
1375 * interworking - Whether Interworking is enabled
1376 */
1377 int interworking;
1378
1379 /**
1380 * hessid - Homogeneous ESS identifier or %NULL if not set
1381 */
1382 const u8 *hessid;
1383
1384 /**
1385 * access_network_type - Access Network Type (0..15)
1386 *
1387 * This is used for filtering Probe Request frames when Interworking is
1388 * enabled.
1389 */
1390 u8 access_network_type;
Dmitry Shmidt04949592012-07-19 12:16:46 -07001391
1392 /**
1393 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1394 *
1395 * This is used by driver which advertises this capability.
1396 */
1397 int ap_max_inactivity;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001398
1399 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001400 * ctwindow - Client Traffic Window (in TUs)
1401 */
1402 u8 p2p_go_ctwindow;
1403
1404 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001405 * smps_mode - SMPS mode
1406 *
1407 * SMPS mode to be used by the AP, specified as the relevant bits of
1408 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1409 */
1410 unsigned int smps_mode;
1411
1412 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001413 * disable_dgaf - Whether group-addressed frames are disabled
1414 */
1415 int disable_dgaf;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001416
1417 /**
1418 * osen - Whether OSEN security is enabled
1419 */
1420 int osen;
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001421
1422 /**
1423 * freq - Channel parameters for dynamic bandwidth changes
1424 */
1425 struct hostapd_freq_params *freq;
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001426
1427 /**
1428 * reenable - Whether this is to re-enable beaconing
1429 */
1430 int reenable;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001431
1432 /**
1433 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1434 * infrastructure BSS. Valid only for DMG network.
1435 */
1436 int pbss;
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001437
1438 /**
1439 * multicast_to_unicast - Whether to use multicast_to_unicast
1440 *
1441 * If this is non-zero, the AP is requested to perform multicast to
1442 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1443 * 802.1Q). If enabled, such frames are to be sent to each station
1444 * separately, with the DA replaced by their own MAC address rather
1445 * than the group address.
1446 *
1447 * Note that this may break certain expectations of the receiver, such
1448 * as the ability to drop unicast IP packets received within multicast
1449 * L2 frames, or the ability to not send ICMP destination unreachable
1450 * messages for packets received in L2 multicast (which is required,
1451 * but the receiver can't tell the difference if this new option is
1452 * enabled.)
1453 *
1454 * This also doesn't implement the 802.11 DMS (directed multicast
1455 * service).
1456 */
1457 int multicast_to_unicast;
Hai Shalom74f70d42019-02-11 14:42:39 -08001458
1459 /**
1460 * ftm_responder - Whether FTM responder is enabled
1461 */
1462 int ftm_responder;
1463
1464 /**
1465 * lci - Binary data, the content of an LCI report IE with type 8 as
1466 * defined in IEEE Std 802.11-2016, 9.4.2.22.10
1467 */
1468 const struct wpabuf *lci;
1469
1470 /**
1471 * civic - Binary data, the content of a measurement report IE with
1472 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
1473 */
1474 const struct wpabuf *civic;
Hai Shalomc3565922019-10-28 11:58:20 -07001475
1476 /**
1477 * he_spr - Whether Spatial Reuse is enabled
1478 */
1479 int he_spr;
1480
1481 /**
1482 * he_spr_srg_obss_pd_min_offset - Minimum TX power offset
1483 */
1484 int he_spr_srg_obss_pd_min_offset;
1485
1486 /**
1487 * he_spr_srg_obss_pd_max_offset - Maximum TX power offset
1488 */
1489 int he_spr_srg_obss_pd_max_offset;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001490};
1491
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001492struct wpa_driver_mesh_bss_params {
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001493#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1494#define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1495#define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1496#define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001497#define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001498 /*
1499 * TODO: Other mesh configuration parameters would go here.
1500 * See NL80211_MESHCONF_* for all the mesh config parameters.
1501 */
1502 unsigned int flags;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001503 int auto_plinks;
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001504 int peer_link_timeout;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001505 int max_peer_links;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001506 int rssi_threshold;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001507 u16 ht_opmode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001508};
1509
1510struct wpa_driver_mesh_join_params {
1511 const u8 *meshid;
1512 int meshid_len;
1513 const int *basic_rates;
1514 const u8 *ies;
1515 int ie_len;
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001516 struct hostapd_freq_params freq;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001517 int beacon_int;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001518 int dtim_period;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001519 struct wpa_driver_mesh_bss_params conf;
1520#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1521#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1522#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1523#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1524 unsigned int flags;
1525};
1526
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001527/**
1528 * struct wpa_driver_capa - Driver capability information
1529 */
1530struct wpa_driver_capa {
1531#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1532#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1533#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1534#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1535#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1536#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1537#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001538#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001539#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1540#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001541#define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
1542#define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
1543#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1544#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1545#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1546#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
Hai Shalom74f70d42019-02-11 14:42:39 -08001547#define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001548 /** Bitfield of supported key management suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001549 unsigned int key_mgmt;
1550
1551#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1552#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1553#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1554#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
Dmitry Shmidt04949592012-07-19 12:16:46 -07001555#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001556#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001557#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1558#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1559#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1560#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1561#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1562#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001563#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001564 /** Bitfield of supported cipher suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001565 unsigned int enc;
1566
1567#define WPA_DRIVER_AUTH_OPEN 0x00000001
1568#define WPA_DRIVER_AUTH_SHARED 0x00000002
1569#define WPA_DRIVER_AUTH_LEAP 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001570 /** Bitfield of supported IEEE 802.11 authentication algorithms */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001571 unsigned int auth;
1572
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001573/** Driver generated WPA/RSN IE */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001574#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001575/** Driver needs static WEP key setup after association command */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001576#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001577/** Driver takes care of all DFS operations */
Dmitry Shmidtd11f0192014-03-24 12:09:47 -07001578#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001579/** Driver takes care of RSN 4-way handshake internally; PMK is configured with
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001580 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
Hai Shalom74f70d42019-02-11 14:42:39 -08001581#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001582/** Driver is for a wired Ethernet interface */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001583#define WPA_DRIVER_FLAGS_WIRED 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001584/** Driver provides separate commands for authentication and association (SME in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001585 * wpa_supplicant). */
1586#define WPA_DRIVER_FLAGS_SME 0x00000020
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001587/** Driver supports AP mode */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001588#define WPA_DRIVER_FLAGS_AP 0x00000040
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001589/** Driver needs static WEP key setup after association has been completed */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001590#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001591/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001592#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001593/** Driver supports concurrent P2P operations */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001594#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001595/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001596 * Driver uses the initial interface as a dedicated management interface, i.e.,
1597 * it cannot be used for P2P group operations or non-P2P purposes.
1598 */
1599#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001600/** This interface is P2P capable (P2P GO or P2P Client) */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001601#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001602/** Driver supports station and key removal when stopping an AP */
Dmitry Shmidta38abf92014-03-06 13:38:44 -08001603#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001604/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001605 * Driver uses the initial interface for P2P management interface and non-P2P
1606 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1607 * P2P group operations.
1608 */
1609#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001610/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001611 * Driver is known to use sane error codes, i.e., when it indicates that
1612 * something (e.g., association) fails, there was indeed a failure and the
1613 * operation does not end up getting completed successfully later.
1614 */
1615#define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001616/** Driver supports off-channel TX */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001617#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001618/** Driver indicates TX status events for EAPOL Data frames */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001619#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001620/** Driver indicates TX status events for Deauth/Disassoc frames */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001621#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001622/** Driver supports roaming (BSS selection) in firmware */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001623#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001624/** Driver supports operating as a TDLS peer */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001625#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001626/** Driver requires external TDLS setup/teardown/discovery */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001627#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001628/** Driver indicates support for Probe Response offloading in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001629#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001630/** Driver supports U-APSD in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001631#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001632/** Driver supports inactivity timer in AP mode */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001633#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001634/** Driver expects user space implementation of MLME in AP mode */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001635#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001636/** Driver supports SAE with user space SME */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001637#define WPA_DRIVER_FLAGS_SAE 0x02000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001638/** Driver makes use of OBSS scan mechanism in wpa_supplicant */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001639#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001640/** Driver supports IBSS (Ad-hoc) mode */
Dmitry Shmidt700a1372013-03-15 14:14:44 -07001641#define WPA_DRIVER_FLAGS_IBSS 0x08000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001642/** Driver supports radar detection */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07001643#define WPA_DRIVER_FLAGS_RADAR 0x10000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001644/** Driver supports a dedicated interface for P2P Device */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001645#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001646/** Driver supports QoS Mapping */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001647#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001648/** Driver supports CSA in AP mode */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001649#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001650/** Driver supports mesh */
1651#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1652/** Driver support ACS offload */
1653#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1654/** Driver supports key management offload */
1655#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1656/** Driver supports TDLS channel switching */
1657#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001658/** Driver supports IBSS with HT datarates */
1659#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001660/** Driver supports IBSS with VHT datarates */
1661#define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07001662/** Driver supports automatic band selection */
1663#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001664/** Driver supports simultaneous off-channel operations */
1665#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001666/** Driver supports full AP client state */
1667#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001668/** Driver supports P2P Listen offload */
1669#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001670/** Driver supports FILS */
1671#define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001672/** Driver supports Beacon frame TX rate configuration (legacy rates) */
1673#define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1674/** Driver supports Beacon frame TX rate configuration (HT rates) */
1675#define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1676/** Driver supports Beacon frame TX rate configuration (VHT rates) */
1677#define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08001678/** Driver supports mgmt_tx with random TX address in non-connected state */
1679#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
1680/** Driver supports mgmt_tx with random TX addr in connected state */
1681#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
1682/** Driver supports better BSS reporting with sched_scan in connected mode */
1683#define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
1684/** Driver supports HE capabilities */
1685#define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001686/** Driver supports FILS shared key offload */
1687#define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
1688/** Driver supports all OCE STA specific mandatory features */
1689#define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
1690/** Driver supports all OCE AP specific mandatory features */
1691#define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
1692/**
1693 * Driver supports all OCE STA-CFON specific mandatory features only.
1694 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
1695 * userspace shall assume that this driver may not support all OCE AP
1696 * functionality but can support only OCE STA-CFON functionality.
1697 */
1698#define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
Roshan Pius3a1667e2018-07-03 15:17:14 -07001699/** Driver supports MFP-optional in the connect command */
1700#define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL
Hai Shalom39ba6fc2019-01-22 12:40:38 -08001701/** Driver is a self-managed regulatory device */
1702#define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL
Hai Shalom74f70d42019-02-11 14:42:39 -08001703/** Driver supports FTM responder functionality */
1704#define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL
1705/** Driver support 4-way handshake offload for WPA-Personal */
1706#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001707 u64 flags;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001708
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001709#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1710 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1711
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001712#define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1713#define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1714 unsigned int smps_modes;
1715
1716 unsigned int wmm_ac_supported:1;
1717
1718 unsigned int mac_addr_rand_scan_supported:1;
1719 unsigned int mac_addr_rand_sched_scan_supported:1;
1720
1721 /** Maximum number of supported active probe SSIDs */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001722 int max_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001723
1724 /** Maximum number of supported active probe SSIDs for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001725 int max_sched_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001726
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08001727 /** Maximum number of supported scan plans for scheduled scan */
1728 unsigned int max_sched_scan_plans;
1729
1730 /** Maximum interval in a scan plan. In seconds */
1731 u32 max_sched_scan_plan_interval;
1732
1733 /** Maximum number of iterations in a single scan plan */
1734 u32 max_sched_scan_plan_iterations;
1735
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001736 /** Whether sched_scan (offloaded scanning) is supported */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001737 int sched_scan_supported;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001738
1739 /** Maximum number of supported match sets for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001740 int max_match_sets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001741
1742 /**
1743 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1744 */
1745 unsigned int max_remain_on_chan;
1746
1747 /**
1748 * max_stations - Maximum number of associated stations the driver
1749 * supports in AP mode
1750 */
1751 unsigned int max_stations;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001752
1753 /**
1754 * probe_resp_offloads - Bitmap of supported protocols by the driver
1755 * for Probe Response offloading.
1756 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001757/** Driver Probe Response offloading support for WPS ver. 1 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001758#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001759/** Driver Probe Response offloading support for WPS ver. 2 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001760#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001761/** Driver Probe Response offloading support for P2P */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001762#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001763/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001764#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1765 unsigned int probe_resp_offloads;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001766
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07001767 unsigned int max_acl_mac_addrs;
1768
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001769 /**
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07001770 * Number of supported concurrent channels
1771 */
1772 unsigned int num_multichan_concurrent;
1773
1774 /**
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001775 * extended_capa - extended capabilities in driver/device
1776 *
1777 * Must be allocated and freed by driver and the pointers must be
1778 * valid for the lifetime of the driver, i.e., freed in deinit()
1779 */
1780 const u8 *extended_capa, *extended_capa_mask;
1781 unsigned int extended_capa_len;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001782
1783 struct wowlan_triggers wowlan_triggers;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001784
1785/** Driver adds the DS Params Set IE in Probe Request frames */
1786#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1787/** Driver adds the WFA TPC IE in Probe Request frames */
1788#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1789/** Driver handles quiet period requests */
1790#define WPA_DRIVER_FLAGS_QUIET 0x00000004
1791/**
1792 * Driver is capable of inserting the current TX power value into the body of
1793 * transmitted frames.
1794 * Background: Some Action frames include a TPC Report IE. This IE contains a
1795 * TX power field, which has to be updated by lower layers. One such Action
1796 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1797 * of spectrum management). Note that this insertion takes place at a fixed
1798 * offset, namely the 6th byte in the Action frame body.
1799 */
1800#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001801/**
1802 * Driver supports RRM. With this support, the driver will accept to use RRM in
1803 * (Re)Association Request frames, without supporting quiet period.
1804 */
1805#define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1806
Dmitry Shmidt29333592017-01-09 12:27:11 -08001807/** Driver supports setting the scan dwell time */
1808#define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
1809/** Driver supports Beacon Report Measurement */
1810#define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
1811
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001812 u32 rrm_flags;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001813
1814 /* Driver concurrency capabilities */
1815 unsigned int conc_capab;
1816 /* Maximum number of concurrent channels on 2.4 GHz */
1817 unsigned int max_conc_chan_2_4;
1818 /* Maximum number of concurrent channels on 5 GHz */
1819 unsigned int max_conc_chan_5_0;
1820
1821 /* Maximum number of supported CSA counters */
1822 u16 max_csa_counters;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001823};
1824
1825
1826struct hostapd_data;
1827
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001828#define STA_DRV_DATA_TX_MCS BIT(0)
1829#define STA_DRV_DATA_RX_MCS BIT(1)
1830#define STA_DRV_DATA_TX_VHT_MCS BIT(2)
1831#define STA_DRV_DATA_RX_VHT_MCS BIT(3)
1832#define STA_DRV_DATA_TX_VHT_NSS BIT(4)
1833#define STA_DRV_DATA_RX_VHT_NSS BIT(5)
1834#define STA_DRV_DATA_TX_SHORT_GI BIT(6)
1835#define STA_DRV_DATA_RX_SHORT_GI BIT(7)
Roshan Pius3a1667e2018-07-03 15:17:14 -07001836#define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001837
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001838struct hostap_sta_driver_data {
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001839 unsigned long rx_packets, tx_packets;
1840 unsigned long long rx_bytes, tx_bytes;
Hai Shalom81f62d82019-07-22 12:10:00 -07001841 unsigned long long rx_airtime, tx_airtime;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001842 int bytes_64bit; /* whether 64-bit byte counters are supported */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001843 unsigned long current_tx_rate;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001844 unsigned long current_rx_rate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001845 unsigned long inactive_msec;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001846 unsigned long flags; /* bitfield of STA_DRV_DATA_* */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001847 unsigned long num_ps_buf_frames;
1848 unsigned long tx_retry_failed;
1849 unsigned long tx_retry_count;
Roshan Pius3a1667e2018-07-03 15:17:14 -07001850 s8 last_ack_rssi;
Hai Shalom81f62d82019-07-22 12:10:00 -07001851 unsigned long backlog_packets;
1852 unsigned long backlog_bytes;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001853 s8 signal;
1854 u8 rx_vhtmcs;
1855 u8 tx_vhtmcs;
1856 u8 rx_mcs;
1857 u8 tx_mcs;
1858 u8 rx_vht_nss;
1859 u8 tx_vht_nss;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001860};
1861
1862struct hostapd_sta_add_params {
1863 const u8 *addr;
1864 u16 aid;
1865 u16 capability;
1866 const u8 *supp_rates;
1867 size_t supp_rates_len;
1868 u16 listen_interval;
1869 const struct ieee80211_ht_capabilities *ht_capabilities;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001870 const struct ieee80211_vht_capabilities *vht_capabilities;
Dmitry Shmidtbd14a572014-02-18 10:33:49 -08001871 int vht_opmode_enabled;
1872 u8 vht_opmode;
Hai Shalom81f62d82019-07-22 12:10:00 -07001873 const struct ieee80211_he_capabilities *he_capab;
1874 size_t he_capab_len;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001875 u32 flags; /* bitmask of WPA_STA_* flags */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001876 u32 flags_mask; /* unset bits in flags */
1877#ifdef CONFIG_MESH
1878 enum mesh_plink_state plink_state;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001879 u16 peer_aid;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001880#endif /* CONFIG_MESH */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001881 int set; /* Set STA parameters instead of add */
1882 u8 qosinfo;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08001883 const u8 *ext_capab;
1884 size_t ext_capab_len;
Dmitry Shmidt344abd32014-01-14 13:17:00 -08001885 const u8 *supp_channels;
1886 size_t supp_channels_len;
1887 const u8 *supp_oper_classes;
1888 size_t supp_oper_classes_len;
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001889 int support_p2p_ps;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001890};
1891
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07001892struct mac_address {
1893 u8 addr[ETH_ALEN];
1894};
1895
1896struct hostapd_acl_params {
1897 u8 acl_policy;
1898 unsigned int num_mac_acl;
1899 struct mac_address mac_acl[0];
1900};
1901
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001902enum wpa_driver_if_type {
1903 /**
1904 * WPA_IF_STATION - Station mode interface
1905 */
1906 WPA_IF_STATION,
1907
1908 /**
1909 * WPA_IF_AP_VLAN - AP mode VLAN interface
1910 *
1911 * This interface shares its address and Beacon frame with the main
1912 * BSS.
1913 */
1914 WPA_IF_AP_VLAN,
1915
1916 /**
1917 * WPA_IF_AP_BSS - AP mode BSS interface
1918 *
1919 * This interface has its own address and Beacon frame.
1920 */
1921 WPA_IF_AP_BSS,
1922
1923 /**
1924 * WPA_IF_P2P_GO - P2P Group Owner
1925 */
1926 WPA_IF_P2P_GO,
1927
1928 /**
1929 * WPA_IF_P2P_CLIENT - P2P Client
1930 */
1931 WPA_IF_P2P_CLIENT,
1932
1933 /**
1934 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1935 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1936 */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001937 WPA_IF_P2P_GROUP,
1938
1939 /**
1940 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1941 * abstracted P2P Device function in the driver
1942 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001943 WPA_IF_P2P_DEVICE,
1944
1945 /*
1946 * WPA_IF_MESH - Mesh interface
1947 */
1948 WPA_IF_MESH,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001949
1950 /*
1951 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1952 */
1953 WPA_IF_TDLS,
1954
1955 /*
1956 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1957 */
1958 WPA_IF_IBSS,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001959};
1960
1961struct wpa_init_params {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001962 void *global_priv;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001963 const u8 *bssid;
1964 const char *ifname;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001965 const char *driver_params;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001966 int use_pae_group_addr;
1967 char **bridge;
1968 size_t num_bridge;
1969
1970 u8 *own_addr; /* buffer for writing own MAC address */
1971};
1972
1973
1974struct wpa_bss_params {
1975 /** Interface name (for multi-SSID/VLAN support) */
1976 const char *ifname;
1977 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1978 int enabled;
1979
1980 int wpa;
1981 int ieee802_1x;
1982 int wpa_group;
1983 int wpa_pairwise;
1984 int wpa_key_mgmt;
1985 int rsn_preauth;
1986 enum mfp_options ieee80211w;
1987};
1988
1989#define WPA_STA_AUTHORIZED BIT(0)
1990#define WPA_STA_WMM BIT(1)
1991#define WPA_STA_SHORT_PREAMBLE BIT(2)
1992#define WPA_STA_MFP BIT(3)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001993#define WPA_STA_TDLS_PEER BIT(4)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001994#define WPA_STA_AUTHENTICATED BIT(5)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001995#define WPA_STA_ASSOCIATED BIT(6)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001996
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001997enum tdls_oper {
1998 TDLS_DISCOVERY_REQ,
1999 TDLS_SETUP,
2000 TDLS_TEARDOWN,
2001 TDLS_ENABLE_LINK,
2002 TDLS_DISABLE_LINK,
2003 TDLS_ENABLE,
2004 TDLS_DISABLE
2005};
2006
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002007enum wnm_oper {
2008 WNM_SLEEP_ENTER_CONFIRM,
2009 WNM_SLEEP_ENTER_FAIL,
2010 WNM_SLEEP_EXIT_CONFIRM,
2011 WNM_SLEEP_EXIT_FAIL,
2012 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
2013 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
2014 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
2015 * a STA */
2016 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
2017 * for a STA */
2018 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
2019 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
2020 * for a STA */
2021 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
2022};
2023
Roshan Pius3a1667e2018-07-03 15:17:14 -07002024/* enum smps_mode - SMPS mode definitions */
2025enum smps_mode {
2026 SMPS_AUTOMATIC,
2027 SMPS_OFF,
2028 SMPS_DYNAMIC,
2029 SMPS_STATIC,
2030
2031 /* Keep last */
2032 SMPS_INVALID,
2033};
2034
Hai Shalom74f70d42019-02-11 14:42:39 -08002035#define WPA_INVALID_NOISE 9999
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002036
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002037/**
2038 * struct wpa_signal_info - Information about channel signal quality
Hai Shalom74f70d42019-02-11 14:42:39 -08002039 * @frequency: control frequency
2040 * @above_threshold: true if the above threshold was crossed
2041 * (relevant for a CQM event)
2042 * @current_signal: in dBm
2043 * @avg_signal: in dBm
2044 * @avg_beacon_signal: in dBm
2045 * @current_noise: %WPA_INVALID_NOISE if not supported
2046 * @current_txrate: current TX rate
2047 * @chanwidth: channel width
2048 * @center_frq1: center frequency for the first segment
2049 * @center_frq2: center frequency for the second segment (if relevant)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002050 */
2051struct wpa_signal_info {
2052 u32 frequency;
2053 int above_threshold;
2054 int current_signal;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002055 int avg_signal;
Dmitry Shmidtf73259c2015-03-17 11:00:54 -07002056 int avg_beacon_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002057 int current_noise;
2058 int current_txrate;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002059 enum chan_width chanwidth;
2060 int center_frq1;
2061 int center_frq2;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002062};
2063
2064/**
Hai Shalom74f70d42019-02-11 14:42:39 -08002065 * struct wpa_channel_info - Information about the current channel
2066 * @frequency: Center frequency of the primary 20 MHz channel
2067 * @chanwidth: Width of the current operating channel
2068 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
2069 * This field is only filled in when using a 40 MHz channel.
2070 * @center_frq1: Center frequency of frequency segment 0
2071 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
2072 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
2073 * derived from center_frq2 for convenience.
2074 */
2075struct wpa_channel_info {
2076 u32 frequency;
2077 enum chan_width chanwidth;
2078 int sec_channel;
2079 int center_frq1;
2080 int center_frq2;
2081 u8 seg1_idx;
2082};
2083
2084/**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002085 * struct beacon_data - Beacon data
2086 * @head: Head portion of Beacon frame (before TIM IE)
2087 * @tail: Tail portion of Beacon frame (after TIM IE)
2088 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2089 * @proberesp_ies: Extra information element(s) to add into Probe Response
2090 * frames or %NULL
2091 * @assocresp_ies: Extra information element(s) to add into (Re)Association
2092 * Response frames or %NULL
2093 * @probe_resp: Probe Response frame template
2094 * @head_len: Length of @head
2095 * @tail_len: Length of @tail
2096 * @beacon_ies_len: Length of beacon_ies in octets
2097 * @proberesp_ies_len: Length of proberesp_ies in octets
2098 * @proberesp_ies_len: Length of proberesp_ies in octets
2099 * @probe_resp_len: Length of probe response template (@probe_resp)
2100 */
2101struct beacon_data {
2102 u8 *head, *tail;
2103 u8 *beacon_ies;
2104 u8 *proberesp_ies;
2105 u8 *assocresp_ies;
2106 u8 *probe_resp;
2107
2108 size_t head_len, tail_len;
2109 size_t beacon_ies_len;
2110 size_t proberesp_ies_len;
2111 size_t assocresp_ies_len;
2112 size_t probe_resp_len;
2113};
2114
2115/**
2116 * struct csa_settings - Settings for channel switch command
2117 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2118 * @block_tx: 1 - block transmission for CSA period
2119 * @freq_params: Next channel frequency parameter
2120 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2121 * @beacon_after: Next beacon/probe resp/asooc resp info
2122 * @counter_offset_beacon: Offset to the count field in beacon's tail
2123 * @counter_offset_presp: Offset to the count field in probe resp.
2124 */
2125struct csa_settings {
2126 u8 cs_count;
2127 u8 block_tx;
2128
2129 struct hostapd_freq_params freq_params;
2130 struct beacon_data beacon_csa;
2131 struct beacon_data beacon_after;
2132
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002133 u16 counter_offset_beacon[2];
2134 u16 counter_offset_presp[2];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002135};
2136
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002137/* TDLS peer capabilities for send_tdls_mgmt() */
2138enum tdls_peer_capability {
2139 TDLS_PEER_HT = BIT(0),
2140 TDLS_PEER_VHT = BIT(1),
2141 TDLS_PEER_WMM = BIT(2),
2142};
2143
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002144/* valid info in the wmm_params struct */
2145enum wmm_params_valid_info {
2146 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
2147};
2148
2149/**
2150 * struct wmm_params - WMM parameterss configured for this association
2151 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2152 * of the struct contain valid information.
2153 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2154 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2155 */
2156struct wmm_params {
2157 u8 info_bitmap;
2158 u8 uapsd_queues;
2159};
2160
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002161#ifdef CONFIG_MACSEC
2162struct macsec_init_params {
2163 Boolean always_include_sci;
2164 Boolean use_es;
2165 Boolean use_scb;
2166};
2167#endif /* CONFIG_MACSEC */
2168
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002169enum drv_br_port_attr {
2170 DRV_BR_PORT_ATTR_PROXYARP,
2171 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
2172};
2173
2174enum drv_br_net_param {
2175 DRV_BR_NET_PARAM_GARP_ACCEPT,
Dmitry Shmidt83474442015-04-15 13:47:09 -07002176 DRV_BR_MULTICAST_SNOOPING,
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002177};
2178
2179struct drv_acs_params {
2180 /* Selected mode (HOSTAPD_MODE_*) */
2181 enum hostapd_hw_mode hw_mode;
2182
2183 /* Indicates whether HT is enabled */
2184 int ht_enabled;
2185
2186 /* Indicates whether HT40 is enabled */
2187 int ht40_enabled;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07002188
2189 /* Indicates whether VHT is enabled */
2190 int vht_enabled;
2191
2192 /* Configured ACS channel width */
2193 u16 ch_width;
2194
2195 /* ACS channel list info */
2196 unsigned int ch_list_len;
2197 const u8 *ch_list;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002198 const int *freq_list;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002199};
2200
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002201struct wpa_bss_trans_info {
2202 u8 mbo_transition_reason;
2203 u8 n_candidates;
2204 u8 *bssid;
2205};
2206
2207struct wpa_bss_candidate_info {
2208 u8 num;
2209 struct candidate_list {
2210 u8 bssid[ETH_ALEN];
2211 u8 is_accept;
2212 u32 reject_reason;
2213 } *candidates;
2214};
2215
2216struct wpa_pmkid_params {
2217 const u8 *bssid;
2218 const u8 *ssid;
2219 size_t ssid_len;
2220 const u8 *fils_cache_id;
2221 const u8 *pmkid;
2222 const u8 *pmk;
2223 size_t pmk_len;
2224};
2225
2226/* Mask used to specify which connection parameters have to be updated */
2227enum wpa_drv_update_connect_params_mask {
2228 WPA_DRV_UPDATE_ASSOC_IES = BIT(0),
2229 WPA_DRV_UPDATE_FILS_ERP_INFO = BIT(1),
2230 WPA_DRV_UPDATE_AUTH_TYPE = BIT(2),
2231};
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002232
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002233/**
Roshan Pius3a1667e2018-07-03 15:17:14 -07002234 * struct external_auth - External authentication trigger parameters
2235 *
2236 * These are used across the external authentication request and event
2237 * interfaces.
2238 * @action: Action type / trigger for external authentication. Only significant
2239 * for the event interface.
2240 * @bssid: BSSID of the peer with which the authentication has to happen. Used
2241 * by both the request and event interface.
2242 * @ssid: SSID of the AP. Used by both the request and event interface.
2243 * @ssid_len: SSID length in octets.
2244 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2245 * the request interface.
2246 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2247 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2248 * the real status code for failures. Used only for the request interface
2249 * from user space to the driver.
Hai Shalom5f92bc92019-04-18 11:54:11 -07002250 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
Roshan Pius3a1667e2018-07-03 15:17:14 -07002251 */
2252struct external_auth {
2253 enum {
2254 EXT_AUTH_START,
2255 EXT_AUTH_ABORT,
2256 } action;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002257 const u8 *bssid;
2258 const u8 *ssid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002259 size_t ssid_len;
2260 unsigned int key_mgmt_suite;
2261 u16 status;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002262 const u8 *pmkid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002263};
2264
2265/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002266 * struct wpa_driver_ops - Driver interface API definition
2267 *
2268 * This structure defines the API that each driver interface needs to implement
2269 * for core wpa_supplicant code. All driver specific functionality is captured
2270 * in this wrapper.
2271 */
2272struct wpa_driver_ops {
2273 /** Name of the driver interface */
2274 const char *name;
2275 /** One line description of the driver interface */
2276 const char *desc;
2277
2278 /**
2279 * get_bssid - Get the current BSSID
2280 * @priv: private driver interface data
2281 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2282 *
2283 * Returns: 0 on success, -1 on failure
2284 *
2285 * Query kernel driver for the current BSSID and copy it to bssid.
2286 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2287 * associated.
2288 */
2289 int (*get_bssid)(void *priv, u8 *bssid);
2290
2291 /**
2292 * get_ssid - Get the current SSID
2293 * @priv: private driver interface data
2294 * @ssid: buffer for SSID (at least 32 bytes)
2295 *
2296 * Returns: Length of the SSID on success, -1 on failure
2297 *
2298 * Query kernel driver for the current SSID and copy it to ssid.
2299 * Returning zero is recommended if the STA is not associated.
2300 *
2301 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2302 * can, at least in theory, contain control characters (including nul)
2303 * and as such, should be processed as binary data, not a printable
2304 * string.
2305 */
2306 int (*get_ssid)(void *priv, u8 *ssid);
2307
2308 /**
2309 * set_key - Configure encryption key
2310 * @ifname: Interface name (for multi-SSID/VLAN support)
2311 * @priv: private driver interface data
2312 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002313 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08002314 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
2315 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
2316 * %WPA_ALG_BIP_CMAC_256);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002317 * %WPA_ALG_NONE clears the key.
2318 * @addr: Address of the peer STA (BSSID of the current AP when setting
2319 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
2320 * broadcast keys, %NULL for default keys that are used both for
2321 * broadcast and unicast; when clearing keys, %NULL is used to
2322 * indicate that both the broadcast-only and default key of the
2323 * specified key index is to be cleared
2324 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
2325 * IGTK
2326 * @set_tx: configure this key as the default Tx key (only used when
2327 * driver does not support separate unicast/individual key
2328 * @seq: sequence number/packet number, seq_len octets, the next
2329 * packet number to be used for in replay protection; configured
2330 * for Rx keys (in most cases, this is only used with broadcast
2331 * keys and set to zero for unicast keys); %NULL if not set
2332 * @seq_len: length of the seq, depends on the algorithm:
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002333 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002334 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
2335 * 8-byte Rx Mic Key
2336 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002337 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002338 *
2339 * Returns: 0 on success, -1 on failure
2340 *
2341 * Configure the given key for the kernel driver. If the driver
2342 * supports separate individual keys (4 default keys + 1 individual),
2343 * addr can be used to determine whether the key is default or
2344 * individual. If only 4 keys are supported, the default key with key
2345 * index 0 is used as the individual key. STA must be configured to use
2346 * it as the default Tx key (set_tx is set) and accept Rx for all the
2347 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2348 * broadcast keys, so key index 0 is available for this kind of
2349 * configuration.
2350 *
2351 * Please note that TKIP keys include separate TX and RX MIC keys and
2352 * some drivers may expect them in different order than wpa_supplicant
2353 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
2354 * will trigger Michael MIC errors. This can be fixed by changing the
2355 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
2356 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2357 * example on how this can be done.
2358 */
2359 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
2360 const u8 *addr, int key_idx, int set_tx,
2361 const u8 *seq, size_t seq_len,
2362 const u8 *key, size_t key_len);
2363
2364 /**
2365 * init - Initialize driver interface
2366 * @ctx: context to be used when calling wpa_supplicant functions,
2367 * e.g., wpa_supplicant_event()
2368 * @ifname: interface name, e.g., wlan0
2369 *
2370 * Returns: Pointer to private data, %NULL on failure
2371 *
2372 * Initialize driver interface, including event processing for kernel
2373 * driver events (e.g., associated, scan results, Michael MIC failure).
2374 * This function can allocate a private configuration data area for
2375 * @ctx, file descriptor, interface name, etc. information that may be
2376 * needed in future driver operations. If this is not used, non-NULL
2377 * value will need to be returned because %NULL is used to indicate
2378 * failure. The returned value will be used as 'void *priv' data for
2379 * all other driver_ops functions.
2380 *
2381 * The main event loop (eloop.c) of wpa_supplicant can be used to
2382 * register callback for read sockets (eloop_register_read_sock()).
2383 *
2384 * See below for more information about events and
2385 * wpa_supplicant_event() function.
2386 */
2387 void * (*init)(void *ctx, const char *ifname);
2388
2389 /**
2390 * deinit - Deinitialize driver interface
2391 * @priv: private driver interface data from init()
2392 *
2393 * Shut down driver interface and processing of driver events. Free
2394 * private data buffer if one was allocated in init() handler.
2395 */
2396 void (*deinit)(void *priv);
2397
2398 /**
2399 * set_param - Set driver configuration parameters
2400 * @priv: private driver interface data from init()
2401 * @param: driver specific configuration parameters
2402 *
2403 * Returns: 0 on success, -1 on failure
2404 *
2405 * Optional handler for notifying driver interface about configuration
2406 * parameters (driver_param).
2407 */
2408 int (*set_param)(void *priv, const char *param);
2409
2410 /**
2411 * set_countermeasures - Enable/disable TKIP countermeasures
2412 * @priv: private driver interface data
2413 * @enabled: 1 = countermeasures enabled, 0 = disabled
2414 *
2415 * Returns: 0 on success, -1 on failure
2416 *
2417 * Configure TKIP countermeasures. When these are enabled, the driver
2418 * should drop all received and queued frames that are using TKIP.
2419 */
2420 int (*set_countermeasures)(void *priv, int enabled);
2421
2422 /**
2423 * deauthenticate - Request driver to deauthenticate
2424 * @priv: private driver interface data
2425 * @addr: peer address (BSSID of the AP)
2426 * @reason_code: 16-bit reason code to be sent in the deauthentication
2427 * frame
2428 *
2429 * Returns: 0 on success, -1 on failure
2430 */
Hai Shalom81f62d82019-07-22 12:10:00 -07002431 int (*deauthenticate)(void *priv, const u8 *addr, u16 reason_code);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002432
2433 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002434 * associate - Request driver to associate
2435 * @priv: private driver interface data
2436 * @params: association parameters
2437 *
2438 * Returns: 0 on success, -1 on failure
2439 */
2440 int (*associate)(void *priv,
2441 struct wpa_driver_associate_params *params);
2442
2443 /**
2444 * add_pmkid - Add PMKSA cache entry to the driver
2445 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002446 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002447 *
2448 * Returns: 0 on success, -1 on failure
2449 *
2450 * This function is called when a new PMK is received, as a result of
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002451 * either normal authentication or RSN pre-authentication. The PMKSA
2452 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2453 * ssid, fils_cache_id, pmkid, and pmk.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002454 *
2455 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2456 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2457 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2458 * driver_ops function does not need to be implemented. Likewise, if
2459 * the driver does not support WPA, this function is not needed.
2460 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002461 int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002462
2463 /**
2464 * remove_pmkid - Remove PMKSA cache entry to the driver
2465 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002466 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002467 *
2468 * Returns: 0 on success, -1 on failure
2469 *
2470 * This function is called when the supplicant drops a PMKSA cache
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002471 * entry for any reason. The PMKSA parameters are either a set of
2472 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002473 *
2474 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2475 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2476 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2477 * from wpa_supplicant, this driver_ops function does not need to be
2478 * implemented. Likewise, if the driver does not support WPA, this
2479 * function is not needed.
2480 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002481 int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002482
2483 /**
2484 * flush_pmkid - Flush PMKSA cache
2485 * @priv: private driver interface data
2486 *
2487 * Returns: 0 on success, -1 on failure
2488 *
2489 * This function is called when the supplicant drops all PMKSA cache
2490 * entries for any reason.
2491 *
2492 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2493 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2494 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2495 * from wpa_supplicant, this driver_ops function does not need to be
2496 * implemented. Likewise, if the driver does not support WPA, this
2497 * function is not needed.
2498 */
2499 int (*flush_pmkid)(void *priv);
2500
2501 /**
2502 * get_capa - Get driver capabilities
2503 * @priv: private driver interface data
2504 *
2505 * Returns: 0 on success, -1 on failure
2506 *
2507 * Get driver/firmware/hardware capabilities.
2508 */
2509 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
2510
2511 /**
2512 * poll - Poll driver for association information
2513 * @priv: private driver interface data
2514 *
2515 * This is an option callback that can be used when the driver does not
2516 * provide event mechanism for association events. This is called when
2517 * receiving WPA EAPOL-Key messages that require association
2518 * information. The driver interface is supposed to generate associnfo
2519 * event before returning from this callback function. In addition, the
2520 * driver interface should generate an association event after having
2521 * sent out associnfo.
2522 */
2523 void (*poll)(void *priv);
2524
2525 /**
Dmitry Shmidte4663042016-04-04 10:07:49 -07002526 * get_ifindex - Get interface index
2527 * @priv: private driver interface data
2528 *
2529 * Returns: Interface index
2530 */
2531 unsigned int (*get_ifindex)(void *priv);
2532
2533 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002534 * get_ifname - Get interface name
2535 * @priv: private driver interface data
2536 *
2537 * Returns: Pointer to the interface name. This can differ from the
2538 * interface name used in init() call. Init() is called first.
2539 *
2540 * This optional function can be used to allow the driver interface to
2541 * replace the interface name with something else, e.g., based on an
2542 * interface mapping from a more descriptive name.
2543 */
2544 const char * (*get_ifname)(void *priv);
2545
2546 /**
2547 * get_mac_addr - Get own MAC address
2548 * @priv: private driver interface data
2549 *
2550 * Returns: Pointer to own MAC address or %NULL on failure
2551 *
2552 * This optional function can be used to get the own MAC address of the
2553 * device from the driver interface code. This is only needed if the
2554 * l2_packet implementation for the OS does not provide easy access to
2555 * a MAC address. */
2556 const u8 * (*get_mac_addr)(void *priv);
2557
2558 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002559 * set_operstate - Sets device operating state to DORMANT or UP
2560 * @priv: private driver interface data
2561 * @state: 0 = dormant, 1 = up
2562 * Returns: 0 on success, -1 on failure
2563 *
2564 * This is an optional function that can be used on operating systems
2565 * that support a concept of controlling network device state from user
2566 * space applications. This function, if set, gets called with
2567 * state = 1 when authentication has been completed and with state = 0
2568 * when connection is lost.
2569 */
2570 int (*set_operstate)(void *priv, int state);
2571
2572 /**
2573 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2574 * @priv: Private driver interface data
2575 * @addr: Address of the station for which to set protection (may be
2576 * %NULL for group keys)
2577 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2578 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2579 * Returns: 0 on success, -1 on failure
2580 *
2581 * This is an optional function that can be used to set the driver to
2582 * require protection for Tx and/or Rx frames. This uses the layer
2583 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2584 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2585 * set protection operation; instead, they set protection implicitly
2586 * based on configured keys.
2587 */
2588 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2589 int key_type);
2590
2591 /**
2592 * get_hw_feature_data - Get hardware support data (channels and rates)
2593 * @priv: Private driver interface data
2594 * @num_modes: Variable for returning the number of returned modes
2595 * flags: Variable for returning hardware feature flags
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002596 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002597 * Returns: Pointer to allocated hardware data on success or %NULL on
2598 * failure. Caller is responsible for freeing this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002599 */
2600 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2601 u16 *num_modes,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002602 u16 *flags, u8 *dfs);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002603
2604 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002605 * send_mlme - Send management frame from MLME
2606 * @priv: Private driver interface data
2607 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2608 * @data_len: Size of the management frame
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002609 * @noack: Do not wait for this frame to be acked (disable retries)
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07002610 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2611 * driver decide
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002612 * @csa_offs: Array of CSA offsets or %NULL
2613 * @csa_offs_len: Number of elements in csa_offs
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002614 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002615 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002616 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002617 int noack, unsigned int freq, const u16 *csa_offs,
2618 size_t csa_offs_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002619
2620 /**
2621 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2622 * @priv: Private driver interface data
2623 * @md: Mobility domain (2 octets) (also included inside ies)
2624 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2625 * @ies_len: Length of FT IEs in bytes
2626 * Returns: 0 on success, -1 on failure
2627 *
2628 * The supplicant uses this callback to let the driver know that keying
2629 * material for FT is available and that the driver can use the
2630 * provided IEs in the next message in FT authentication sequence.
2631 *
2632 * This function is only needed for driver that support IEEE 802.11r
2633 * (Fast BSS Transition).
2634 */
2635 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2636 size_t ies_len);
2637
2638 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002639 * get_scan_results2 - Fetch the latest scan results
2640 * @priv: private driver interface data
2641 *
2642 * Returns: Allocated buffer of scan results (caller is responsible for
2643 * freeing the data structure) on success, NULL on failure
2644 */
2645 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2646
2647 /**
2648 * set_country - Set country
2649 * @priv: Private driver interface data
2650 * @alpha2: country to which to switch to
2651 * Returns: 0 on success, -1 on failure
2652 *
2653 * This function is for drivers which support some form
2654 * of setting a regulatory domain.
2655 */
2656 int (*set_country)(void *priv, const char *alpha2);
2657
2658 /**
Dmitry Shmidtcce06662013-11-04 18:44:24 -08002659 * get_country - Get country
2660 * @priv: Private driver interface data
2661 * @alpha2: Buffer for returning country code (at least 3 octets)
2662 * Returns: 0 on success, -1 on failure
2663 */
2664 int (*get_country)(void *priv, char *alpha2);
2665
2666 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002667 * global_init - Global driver initialization
Dmitry Shmidte4663042016-04-04 10:07:49 -07002668 * @ctx: wpa_global pointer
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002669 * Returns: Pointer to private data (global), %NULL on failure
2670 *
2671 * This optional function is called to initialize the driver wrapper
2672 * for global data, i.e., data that applies to all interfaces. If this
2673 * function is implemented, global_deinit() will also need to be
2674 * implemented to free the private data. The driver will also likely
2675 * use init2() function instead of init() to get the pointer to global
2676 * data available to per-interface initializer.
2677 */
Dmitry Shmidte4663042016-04-04 10:07:49 -07002678 void * (*global_init)(void *ctx);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002679
2680 /**
2681 * global_deinit - Global driver deinitialization
2682 * @priv: private driver global data from global_init()
2683 *
2684 * Terminate any global driver related functionality and free the
2685 * global data structure.
2686 */
2687 void (*global_deinit)(void *priv);
2688
2689 /**
2690 * init2 - Initialize driver interface (with global data)
2691 * @ctx: context to be used when calling wpa_supplicant functions,
2692 * e.g., wpa_supplicant_event()
2693 * @ifname: interface name, e.g., wlan0
2694 * @global_priv: private driver global data from global_init()
2695 * Returns: Pointer to private data, %NULL on failure
2696 *
2697 * This function can be used instead of init() if the driver wrapper
2698 * uses global data.
2699 */
2700 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2701
2702 /**
2703 * get_interfaces - Get information about available interfaces
2704 * @global_priv: private driver global data from global_init()
2705 * Returns: Allocated buffer of interface information (caller is
2706 * responsible for freeing the data structure) on success, NULL on
2707 * failure
2708 */
2709 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2710
2711 /**
2712 * scan2 - Request the driver to initiate scan
2713 * @priv: private driver interface data
2714 * @params: Scan parameters
2715 *
2716 * Returns: 0 on success, -1 on failure
2717 *
2718 * Once the scan results are ready, the driver should report scan
2719 * results event for wpa_supplicant which will eventually request the
2720 * results with wpa_driver_get_scan_results2().
2721 */
2722 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2723
2724 /**
2725 * authenticate - Request driver to authenticate
2726 * @priv: private driver interface data
2727 * @params: authentication parameters
2728 * Returns: 0 on success, -1 on failure
2729 *
2730 * This is an optional function that can be used with drivers that
2731 * support separate authentication and association steps, i.e., when
2732 * wpa_supplicant can act as the SME. If not implemented, associate()
2733 * function is expected to take care of IEEE 802.11 authentication,
2734 * too.
2735 */
2736 int (*authenticate)(void *priv,
2737 struct wpa_driver_auth_params *params);
2738
2739 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002740 * set_ap - Set Beacon and Probe Response information for AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002741 * @priv: Private driver interface data
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002742 * @params: Parameters to use in AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002743 *
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002744 * This function is used to configure Beacon template and/or extra IEs
2745 * to add for Beacon and Probe Response frames for the driver in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002746 * AP mode. The driver is responsible for building the full Beacon
2747 * frame by concatenating the head part with TIM IE generated by the
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002748 * driver/firmware and finishing with the tail part. Depending on the
2749 * driver architectue, this can be done either by using the full
2750 * template or the set of additional IEs (e.g., WPS and P2P IE).
2751 * Similarly, Probe Response processing depends on the driver design.
2752 * If the driver (or firmware) takes care of replying to Probe Request
2753 * frames, the extra IEs provided here needs to be added to the Probe
2754 * Response frames.
2755 *
2756 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002757 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002758 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002759
2760 /**
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002761 * set_acl - Set ACL in AP mode
2762 * @priv: Private driver interface data
2763 * @params: Parameters to configure ACL
2764 * Returns: 0 on success, -1 on failure
2765 *
2766 * This is used only for the drivers which support MAC address ACL.
2767 */
2768 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2769
2770 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002771 * hapd_init - Initialize driver interface (hostapd only)
2772 * @hapd: Pointer to hostapd context
2773 * @params: Configuration for the driver wrapper
2774 * Returns: Pointer to private data, %NULL on failure
2775 *
2776 * This function is used instead of init() or init2() when the driver
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002777 * wrapper is used with hostapd.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002778 */
2779 void * (*hapd_init)(struct hostapd_data *hapd,
2780 struct wpa_init_params *params);
2781
2782 /**
2783 * hapd_deinit - Deinitialize driver interface (hostapd only)
2784 * @priv: Private driver interface data from hapd_init()
2785 */
2786 void (*hapd_deinit)(void *priv);
2787
2788 /**
2789 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2790 * @priv: Private driver interface data
2791 * @params: BSS parameters
2792 * Returns: 0 on success, -1 on failure
2793 *
2794 * This is an optional function to configure the kernel driver to
2795 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2796 * can be left undefined (set to %NULL) if IEEE 802.1X support is
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002797 * always enabled and the driver uses set_ap() to set WPA/RSN IE
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002798 * for Beacon frames.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002799 *
2800 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002801 */
2802 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2803
2804 /**
2805 * set_privacy - Enable/disable privacy (AP only)
2806 * @priv: Private driver interface data
2807 * @enabled: 1 = privacy enabled, 0 = disabled
2808 * Returns: 0 on success, -1 on failure
2809 *
2810 * This is an optional function to configure privacy field in the
2811 * kernel driver for Beacon frames. This can be left undefined (set to
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002812 * %NULL) if the driver uses the Beacon template from set_ap().
2813 *
2814 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002815 */
2816 int (*set_privacy)(void *priv, int enabled);
2817
2818 /**
2819 * get_seqnum - Fetch the current TSC/packet number (AP only)
2820 * @ifname: The interface name (main or virtual)
2821 * @priv: Private driver interface data
2822 * @addr: MAC address of the station or %NULL for group keys
2823 * @idx: Key index
2824 * @seq: Buffer for returning the latest used TSC/packet number
2825 * Returns: 0 on success, -1 on failure
2826 *
2827 * This function is used to fetch the last used TSC/packet number for
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002828 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2829 * keys, so there is no strict requirement on implementing support for
2830 * unicast keys (i.e., addr != %NULL).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002831 */
2832 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2833 int idx, u8 *seq);
2834
2835 /**
2836 * flush - Flush all association stations (AP only)
2837 * @priv: Private driver interface data
2838 * Returns: 0 on success, -1 on failure
2839 *
2840 * This function requests the driver to disassociate all associated
2841 * stations. This function does not need to be implemented if the
2842 * driver does not process association frames internally.
2843 */
2844 int (*flush)(void *priv);
2845
2846 /**
2847 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2848 * @priv: Private driver interface data
2849 * @elem: Information elements
2850 * @elem_len: Length of the elem buffer in octets
2851 * Returns: 0 on success, -1 on failure
2852 *
2853 * This is an optional function to add information elements in the
2854 * kernel driver for Beacon and Probe Response frames. This can be left
2855 * undefined (set to %NULL) if the driver uses the Beacon template from
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002856 * set_ap().
2857 *
2858 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002859 */
2860 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2861
2862 /**
Jouni Malinen1e6c57f2012-09-05 17:07:03 +03002863 * read_sta_data - Fetch station data
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002864 * @priv: Private driver interface data
2865 * @data: Buffer for returning station information
2866 * @addr: MAC address of the station
2867 * Returns: 0 on success, -1 on failure
2868 */
2869 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2870 const u8 *addr);
2871
2872 /**
2873 * hapd_send_eapol - Send an EAPOL packet (AP only)
2874 * @priv: private driver interface data
2875 * @addr: Destination MAC address
2876 * @data: EAPOL packet starting with IEEE 802.1X header
2877 * @data_len: Length of the EAPOL packet in octets
2878 * @encrypt: Whether the frame should be encrypted
2879 * @own_addr: Source MAC address
2880 * @flags: WPA_STA_* flags for the destination station
2881 *
2882 * Returns: 0 on success, -1 on failure
2883 */
2884 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2885 size_t data_len, int encrypt,
2886 const u8 *own_addr, u32 flags);
2887
2888 /**
2889 * sta_deauth - Deauthenticate a station (AP only)
2890 * @priv: Private driver interface data
2891 * @own_addr: Source address and BSSID for the Deauthentication frame
2892 * @addr: MAC address of the station to deauthenticate
2893 * @reason: Reason code for the Deauthentiation frame
2894 * Returns: 0 on success, -1 on failure
2895 *
2896 * This function requests a specific station to be deauthenticated and
2897 * a Deauthentication frame to be sent to it.
2898 */
2899 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07002900 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002901
2902 /**
2903 * sta_disassoc - Disassociate a station (AP only)
2904 * @priv: Private driver interface data
2905 * @own_addr: Source address and BSSID for the Disassociation frame
2906 * @addr: MAC address of the station to disassociate
2907 * @reason: Reason code for the Disassociation frame
2908 * Returns: 0 on success, -1 on failure
2909 *
2910 * This function requests a specific station to be disassociated and
2911 * a Disassociation frame to be sent to it.
2912 */
2913 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07002914 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002915
2916 /**
2917 * sta_remove - Remove a station entry (AP only)
2918 * @priv: Private driver interface data
2919 * @addr: MAC address of the station to be removed
2920 * Returns: 0 on success, -1 on failure
2921 */
2922 int (*sta_remove)(void *priv, const u8 *addr);
2923
2924 /**
2925 * hapd_get_ssid - Get the current SSID (AP only)
2926 * @priv: Private driver interface data
2927 * @buf: Buffer for returning the SSID
2928 * @len: Maximum length of the buffer
2929 * Returns: Length of the SSID on success, -1 on failure
2930 *
2931 * This function need not be implemented if the driver uses Beacon
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002932 * template from set_ap() and does not reply to Probe Request frames.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002933 */
2934 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2935
2936 /**
2937 * hapd_set_ssid - Set SSID (AP only)
2938 * @priv: Private driver interface data
2939 * @buf: SSID
2940 * @len: Length of the SSID in octets
2941 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002942 *
2943 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002944 */
2945 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2946
2947 /**
2948 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2949 * @priv: Private driver interface data
2950 * @enabled: 1 = countermeasures enabled, 0 = disabled
2951 * Returns: 0 on success, -1 on failure
2952 *
2953 * This need not be implemented if the driver does not take care of
2954 * association processing.
2955 */
2956 int (*hapd_set_countermeasures)(void *priv, int enabled);
2957
2958 /**
2959 * sta_add - Add a station entry
2960 * @priv: Private driver interface data
2961 * @params: Station parameters
2962 * Returns: 0 on success, -1 on failure
2963 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002964 * This function is used to add or set (params->set 1) a station
2965 * entry in the driver. Adding STA entries is used only if the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002966 * does not take care of association processing.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002967 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002968 * With drivers that don't support full AP client state, this function
2969 * is used to add a station entry to the driver once the station has
2970 * completed association.
2971 *
2972 * With TDLS, this function is used to add or set (params->set 1)
2973 * TDLS peer entries (even with drivers that do not support full AP
2974 * client state).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002975 */
2976 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2977
2978 /**
2979 * get_inact_sec - Get station inactivity duration (AP only)
2980 * @priv: Private driver interface data
2981 * @addr: Station address
2982 * Returns: Number of seconds station has been inactive, -1 on failure
2983 */
2984 int (*get_inact_sec)(void *priv, const u8 *addr);
2985
2986 /**
2987 * sta_clear_stats - Clear station statistics (AP only)
2988 * @priv: Private driver interface data
2989 * @addr: Station address
2990 * Returns: 0 on success, -1 on failure
2991 */
2992 int (*sta_clear_stats)(void *priv, const u8 *addr);
2993
2994 /**
2995 * set_freq - Set channel/frequency (AP only)
2996 * @priv: Private driver interface data
2997 * @freq: Channel parameters
2998 * Returns: 0 on success, -1 on failure
2999 */
3000 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
3001
3002 /**
3003 * set_rts - Set RTS threshold
3004 * @priv: Private driver interface data
3005 * @rts: RTS threshold in octets
3006 * Returns: 0 on success, -1 on failure
3007 */
3008 int (*set_rts)(void *priv, int rts);
3009
3010 /**
3011 * set_frag - Set fragmentation threshold
3012 * @priv: Private driver interface data
3013 * @frag: Fragmentation threshold in octets
3014 * Returns: 0 on success, -1 on failure
3015 */
3016 int (*set_frag)(void *priv, int frag);
3017
3018 /**
3019 * sta_set_flags - Set station flags (AP only)
3020 * @priv: Private driver interface data
3021 * @addr: Station address
3022 * @total_flags: Bitmap of all WPA_STA_* flags currently set
3023 * @flags_or: Bitmap of WPA_STA_* flags to add
3024 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
3025 * Returns: 0 on success, -1 on failure
3026 */
3027 int (*sta_set_flags)(void *priv, const u8 *addr,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08003028 unsigned int total_flags, unsigned int flags_or,
3029 unsigned int flags_and);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003030
3031 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07003032 * sta_set_airtime_weight - Set station airtime weight (AP only)
3033 * @priv: Private driver interface data
3034 * @addr: Station address
3035 * @weight: New weight for station airtime assignment
3036 * Returns: 0 on success, -1 on failure
3037 */
3038 int (*sta_set_airtime_weight)(void *priv, const u8 *addr,
3039 unsigned int weight);
3040
3041 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003042 * set_tx_queue_params - Set TX queue parameters
3043 * @priv: Private driver interface data
3044 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
3045 * @aifs: AIFS
3046 * @cw_min: cwMin
3047 * @cw_max: cwMax
3048 * @burst_time: Maximum length for bursting in 0.1 msec units
3049 */
3050 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
3051 int cw_max, int burst_time);
3052
3053 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003054 * if_add - Add a virtual interface
3055 * @priv: Private driver interface data
3056 * @type: Interface type
3057 * @ifname: Interface name for the new virtual interface
3058 * @addr: Local address to use for the interface or %NULL to use the
3059 * parent interface address
3060 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
3061 * @drv_priv: Pointer for overwriting the driver context or %NULL if
3062 * not allowed (applies only to %WPA_IF_AP_BSS type)
3063 * @force_ifname: Buffer for returning an interface name that the
3064 * driver ended up using if it differs from the requested ifname
3065 * @if_addr: Buffer for returning the allocated interface address
3066 * (this may differ from the requested addr if the driver cannot
3067 * change interface address)
3068 * @bridge: Bridge interface to use or %NULL if no bridge configured
Dmitry Shmidtcce06662013-11-04 18:44:24 -08003069 * @use_existing: Whether to allow existing interface to be used
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003070 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003071 * Returns: 0 on success, -1 on failure
3072 */
3073 int (*if_add)(void *priv, enum wpa_driver_if_type type,
3074 const char *ifname, const u8 *addr, void *bss_ctx,
3075 void **drv_priv, char *force_ifname, u8 *if_addr,
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003076 const char *bridge, int use_existing, int setup_ap);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003077
3078 /**
3079 * if_remove - Remove a virtual interface
3080 * @priv: Private driver interface data
3081 * @type: Interface type
3082 * @ifname: Interface name of the virtual interface to be removed
3083 * Returns: 0 on success, -1 on failure
3084 */
3085 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
3086 const char *ifname);
3087
3088 /**
3089 * set_sta_vlan - Bind a station into a specific interface (AP only)
3090 * @priv: Private driver interface data
3091 * @ifname: Interface (main or virtual BSS or VLAN)
3092 * @addr: MAC address of the associated station
3093 * @vlan_id: VLAN ID
3094 * Returns: 0 on success, -1 on failure
3095 *
3096 * This function is used to bind a station to a specific virtual
3097 * interface. It is only used if when virtual interfaces are supported,
3098 * e.g., to assign stations to different VLAN interfaces based on
3099 * information from a RADIUS server. This allows separate broadcast
3100 * domains to be used with a single BSS.
3101 */
3102 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
3103 int vlan_id);
3104
3105 /**
3106 * commit - Optional commit changes handler (AP only)
3107 * @priv: driver private data
3108 * Returns: 0 on success, -1 on failure
3109 *
3110 * This optional handler function can be registered if the driver
3111 * interface implementation needs to commit changes (e.g., by setting
3112 * network interface up) at the end of initial configuration. If set,
3113 * this handler will be called after initial setup has been completed.
3114 */
3115 int (*commit)(void *priv);
3116
3117 /**
3118 * send_ether - Send an ethernet packet (AP only)
3119 * @priv: private driver interface data
3120 * @dst: Destination MAC address
3121 * @src: Source MAC address
3122 * @proto: Ethertype
3123 * @data: EAPOL packet starting with IEEE 802.1X header
3124 * @data_len: Length of the EAPOL packet in octets
3125 * Returns: 0 on success, -1 on failure
3126 */
3127 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
3128 const u8 *data, size_t data_len);
3129
3130 /**
3131 * set_radius_acl_auth - Notification of RADIUS ACL change
3132 * @priv: Private driver interface data
3133 * @mac: MAC address of the station
3134 * @accepted: Whether the station was accepted
3135 * @session_timeout: Session timeout for the station
3136 * Returns: 0 on success, -1 on failure
3137 */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003138 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003139 u32 session_timeout);
3140
3141 /**
3142 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3143 * @priv: Private driver interface data
3144 * @mac: MAC address of the station
3145 * Returns: 0 on success, -1 on failure
3146 */
3147 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
3148
3149 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003150 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
3151 * @priv: Private driver interface data
3152 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3153 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3154 * extra IE(s)
3155 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3156 * to remove extra IE(s)
3157 * Returns: 0 on success, -1 on failure
3158 *
3159 * This is an optional function to add WPS IE in the kernel driver for
3160 * Beacon and Probe Response frames. This can be left undefined (set
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003161 * to %NULL) if the driver uses the Beacon template from set_ap()
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003162 * and does not process Probe Request frames. If the driver takes care
3163 * of (Re)Association frame processing, the assocresp buffer includes
3164 * WPS IE(s) that need to be added to (Re)Association Response frames
3165 * whenever a (Re)Association Request frame indicated use of WPS.
3166 *
3167 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3168 * frames when operating as a GO. The driver is responsible for adding
3169 * timing related attributes (e.g., NoA) in addition to the IEs
3170 * included here by appending them after these buffers. This call is
3171 * also used to provide Probe Response IEs for P2P Listen state
3172 * operations for drivers that generate the Probe Response frames
3173 * internally.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003174 *
3175 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003176 */
3177 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
3178 const struct wpabuf *proberesp,
3179 const struct wpabuf *assocresp);
3180
3181 /**
3182 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3183 * @priv: Private driver interface data
3184 * @authorized: Whether the port is authorized
3185 * Returns: 0 on success, -1 on failure
3186 */
3187 int (*set_supp_port)(void *priv, int authorized);
3188
3189 /**
3190 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3191 * @priv: Private driver interface data
3192 * @addr: MAC address of the associated station
3193 * @aid: Association ID
3194 * @val: 1 = bind to 4-address WDS; 0 = unbind
3195 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3196 * to indicate that bridge is not to be used
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07003197 * @ifname_wds: Buffer to return the interface name for the new WDS
3198 * station or %NULL to indicate name is not returned.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003199 * Returns: 0 on success, -1 on failure
3200 */
3201 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003202 const char *bridge_ifname, char *ifname_wds);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003203
3204 /**
3205 * send_action - Transmit an Action frame
3206 * @priv: Private driver interface data
3207 * @freq: Frequency (in MHz) of the channel
3208 * @wait: Time to wait off-channel for a response (in ms), or zero
3209 * @dst: Destination MAC address (Address 1)
3210 * @src: Source MAC address (Address 2)
3211 * @bssid: BSSID (Address 3)
3212 * @data: Frame body
3213 * @data_len: data length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003214 @ @no_cck: Whether CCK rates must not be used to transmit this frame
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003215 * Returns: 0 on success, -1 on failure
3216 *
3217 * This command can be used to request the driver to transmit an action
3218 * frame to the specified destination.
3219 *
3220 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3221 * be transmitted on the given channel and the device will wait for a
3222 * response on that channel for the given wait time.
3223 *
3224 * If the flag is not set, the wait time will be ignored. In this case,
3225 * if a remain-on-channel duration is in progress, the frame must be
3226 * transmitted on that channel; alternatively the frame may be sent on
3227 * the current operational channel (if in associated state in station
3228 * mode or while operating as an AP.)
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08003229 *
3230 * If @src differs from the device MAC address, use of a random
3231 * transmitter address is requested for this message exchange.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003232 */
3233 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
3234 const u8 *dst, const u8 *src, const u8 *bssid,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003235 const u8 *data, size_t data_len, int no_cck);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003236
3237 /**
3238 * send_action_cancel_wait - Cancel action frame TX wait
3239 * @priv: Private driver interface data
3240 *
3241 * This command cancels the wait time associated with sending an action
3242 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3243 * set in the driver flags.
3244 */
3245 void (*send_action_cancel_wait)(void *priv);
3246
3247 /**
3248 * remain_on_channel - Remain awake on a channel
3249 * @priv: Private driver interface data
3250 * @freq: Frequency (in MHz) of the channel
3251 * @duration: Duration in milliseconds
3252 * Returns: 0 on success, -1 on failure
3253 *
3254 * This command is used to request the driver to remain awake on the
3255 * specified channel for the specified duration and report received
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08003256 * Action frames with EVENT_RX_MGMT events. Optionally, received
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003257 * Probe Request frames may also be requested to be reported by calling
3258 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3259 *
3260 * The driver may not be at the requested channel when this function
3261 * returns, i.e., the return code is only indicating whether the
3262 * request was accepted. The caller will need to wait until the
3263 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3264 * completed the channel change. This may take some time due to other
3265 * need for the radio and the caller should be prepared to timing out
3266 * its wait since there are no guarantees on when this request can be
3267 * executed.
3268 */
3269 int (*remain_on_channel)(void *priv, unsigned int freq,
3270 unsigned int duration);
3271
3272 /**
3273 * cancel_remain_on_channel - Cancel remain-on-channel operation
3274 * @priv: Private driver interface data
3275 *
3276 * This command can be used to cancel a remain-on-channel operation
3277 * before its originally requested duration has passed. This could be
3278 * used, e.g., when remain_on_channel() is used to request extra time
3279 * to receive a response to an Action frame and the response is
3280 * received when there is still unneeded time remaining on the
3281 * remain-on-channel operation.
3282 */
3283 int (*cancel_remain_on_channel)(void *priv);
3284
3285 /**
3286 * probe_req_report - Request Probe Request frames to be indicated
3287 * @priv: Private driver interface data
3288 * @report: Whether to report received Probe Request frames
3289 * Returns: 0 on success, -1 on failure (or if not supported)
3290 *
3291 * This command can be used to request the driver to indicate when
3292 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3293 * Since this operation may require extra resources, e.g., due to less
3294 * optimal hardware/firmware RX filtering, many drivers may disable
3295 * Probe Request reporting at least in station mode. This command is
3296 * used to notify the driver when the Probe Request frames need to be
3297 * reported, e.g., during remain-on-channel operations.
3298 */
3299 int (*probe_req_report)(void *priv, int report);
3300
3301 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003302 * deinit_ap - Deinitialize AP mode
3303 * @priv: Private driver interface data
3304 * Returns: 0 on success, -1 on failure (or if not supported)
3305 *
3306 * This optional function can be used to disable AP mode related
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003307 * configuration. If the interface was not dynamically added,
3308 * change the driver mode to station mode to allow normal station
3309 * operations like scanning to be completed.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003310 */
3311 int (*deinit_ap)(void *priv);
3312
3313 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003314 * deinit_p2p_cli - Deinitialize P2P client mode
3315 * @priv: Private driver interface data
3316 * Returns: 0 on success, -1 on failure (or if not supported)
3317 *
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003318 * This optional function can be used to disable P2P client mode. If the
3319 * interface was not dynamically added, change the interface type back
3320 * to station mode.
Dmitry Shmidt04949592012-07-19 12:16:46 -07003321 */
3322 int (*deinit_p2p_cli)(void *priv);
3323
3324 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003325 * suspend - Notification on system suspend/hibernate event
3326 * @priv: Private driver interface data
3327 */
3328 void (*suspend)(void *priv);
3329
3330 /**
3331 * resume - Notification on system resume/thaw event
3332 * @priv: Private driver interface data
3333 */
3334 void (*resume)(void *priv);
3335
3336 /**
3337 * signal_monitor - Set signal monitoring parameters
3338 * @priv: Private driver interface data
3339 * @threshold: Threshold value for signal change events; 0 = disabled
3340 * @hysteresis: Minimum change in signal strength before indicating a
3341 * new event
3342 * Returns: 0 on success, -1 on failure (or if not supported)
3343 *
3344 * This function can be used to configure monitoring of signal strength
3345 * with the current AP. Whenever signal strength drops below the
3346 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3347 * should be generated assuming the signal strength has changed at
3348 * least %hysteresis from the previously indicated signal change event.
3349 */
3350 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
3351
3352 /**
3353 * send_frame - Send IEEE 802.11 frame (testing use only)
3354 * @priv: Private driver interface data
3355 * @data: IEEE 802.11 frame with IEEE 802.11 header
3356 * @data_len: Size of the frame
3357 * @encrypt: Whether to encrypt the frame (if keys are set)
3358 * Returns: 0 on success, -1 on failure
3359 *
3360 * This function is only used for debugging purposes and is not
3361 * required to be implemented for normal operations.
3362 */
3363 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
3364 int encrypt);
3365
3366 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003367 * get_noa - Get current Notice of Absence attribute payload
3368 * @priv: Private driver interface data
3369 * @buf: Buffer for returning NoA
3370 * @buf_len: Buffer length in octets
3371 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3372 * advertized, or -1 on failure
3373 *
3374 * This function is used to fetch the current Notice of Absence
3375 * attribute value from GO.
3376 */
3377 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
3378
3379 /**
3380 * set_noa - Set Notice of Absence parameters for GO (testing)
3381 * @priv: Private driver interface data
3382 * @count: Count
3383 * @start: Start time in ms from next TBTT
3384 * @duration: Duration in ms
3385 * Returns: 0 on success or -1 on failure
3386 *
3387 * This function is used to set Notice of Absence parameters for GO. It
3388 * is used only for testing. To disable NoA, all parameters are set to
3389 * 0.
3390 */
3391 int (*set_noa)(void *priv, u8 count, int start, int duration);
3392
3393 /**
3394 * set_p2p_powersave - Set P2P power save options
3395 * @priv: Private driver interface data
3396 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3397 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3398 * @ctwindow: 0.. = change (msec), -1 = no change
3399 * Returns: 0 on success or -1 on failure
3400 */
3401 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
3402 int ctwindow);
3403
3404 /**
3405 * ampdu - Enable/disable aggregation
3406 * @priv: Private driver interface data
3407 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3408 * Returns: 0 on success or -1 on failure
3409 */
3410 int (*ampdu)(void *priv, int ampdu);
3411
3412 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003413 * get_radio_name - Get physical radio name for the device
3414 * @priv: Private driver interface data
3415 * Returns: Radio name or %NULL if not known
3416 *
3417 * The returned data must not be modified by the caller. It is assumed
3418 * that any interface that has the same radio name as another is
3419 * sharing the same physical radio. This information can be used to
3420 * share scan results etc. information between the virtual interfaces
3421 * to speed up various operations.
3422 */
3423 const char * (*get_radio_name)(void *priv);
3424
3425 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003426 * send_tdls_mgmt - for sending TDLS management packets
3427 * @priv: private driver interface data
3428 * @dst: Destination (peer) MAC address
3429 * @action_code: TDLS action code for the mssage
3430 * @dialog_token: Dialog Token to use in the message (if needed)
3431 * @status_code: Status Code or Reason Code to use (if needed)
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003432 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003433 * @initiator: Is the current end the TDLS link initiator
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003434 * @buf: TDLS IEs to add to the message
3435 * @len: Length of buf in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003436 * Returns: 0 on success, negative (<0) on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003437 *
3438 * This optional function can be used to send packet to driver which is
3439 * responsible for receiving and sending all TDLS packets.
3440 */
3441 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003442 u8 dialog_token, u16 status_code, u32 peer_capab,
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003443 int initiator, const u8 *buf, size_t len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003444
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003445 /**
3446 * tdls_oper - Ask the driver to perform high-level TDLS operations
3447 * @priv: Private driver interface data
3448 * @oper: TDLS high-level operation. See %enum tdls_oper
3449 * @peer: Destination (peer) MAC address
3450 * Returns: 0 on success, negative (<0) on failure
3451 *
3452 * This optional function can be used to send high-level TDLS commands
3453 * to the driver.
3454 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003455 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
3456
3457 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07003458 * wnm_oper - Notify driver of the WNM frame reception
3459 * @priv: Private driver interface data
3460 * @oper: WNM operation. See %enum wnm_oper
3461 * @peer: Destination (peer) MAC address
3462 * @buf: Buffer for the driver to fill in (for getting IE)
3463 * @buf_len: Return the len of buf
3464 * Returns: 0 on success, negative (<0) on failure
3465 */
3466 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
3467 u8 *buf, u16 *buf_len);
3468
3469 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -07003470 * set_qos_map - Set QoS Map
3471 * @priv: Private driver interface data
3472 * @qos_map_set: QoS Map
3473 * @qos_map_set_len: Length of QoS Map
3474 */
3475 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
3476 u8 qos_map_set_len);
3477
3478 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003479 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3480 * @priv: Private driver interface data
3481 * @version: IP version of the IP address, 4 or 6
3482 * @ipaddr: IP address for the neigh entry
3483 * @prefixlen: IP address prefix length
3484 * @addr: Corresponding MAC address
3485 * Returns: 0 on success, negative (<0) on failure
3486 */
3487 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
3488 int prefixlen, const u8 *addr);
3489
3490 /**
3491 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3492 * @priv: Private driver interface data
3493 * @version: IP version of the IP address, 4 or 6
3494 * @ipaddr: IP address for the neigh entry
3495 * Returns: 0 on success, negative (<0) on failure
3496 */
3497 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
3498
3499 /**
3500 * br_port_set_attr - Set a bridge port attribute
3501 * @attr: Bridge port attribute to set
3502 * @val: Value to be set
3503 * Returns: 0 on success, negative (<0) on failure
3504 */
3505 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
3506 unsigned int val);
3507
3508 /**
3509 * br_port_set_attr - Set a bridge network parameter
3510 * @param: Bridge parameter to set
3511 * @val: Value to be set
3512 * Returns: 0 on success, negative (<0) on failure
3513 */
3514 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
3515 unsigned int val);
3516
3517 /**
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07003518 * set_wowlan - Set wake-on-wireless triggers
3519 * @priv: Private driver interface data
3520 * @triggers: wowlan triggers
3521 */
3522 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
3523
3524 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003525 * signal_poll - Get current connection information
3526 * @priv: Private driver interface data
3527 * @signal_info: Connection info structure
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003528 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003529 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003530
3531 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08003532 * channel_info - Get parameters of the current operating channel
3533 * @priv: Private driver interface data
3534 * @channel_info: Channel info structure
3535 * Returns: 0 on success, negative (<0) on failure
3536 */
3537 int (*channel_info)(void *priv, struct wpa_channel_info *channel_info);
3538
3539 /**
Jouni Malinen75ecf522011-06-27 15:19:46 -07003540 * set_authmode - Set authentication algorithm(s) for static WEP
3541 * @priv: Private driver interface data
3542 * @authmode: 1=Open System, 2=Shared Key, 3=both
3543 * Returns: 0 on success, -1 on failure
3544 *
3545 * This function can be used to set authentication algorithms for AP
3546 * mode when static WEP is used. If the driver uses user space MLME/SME
3547 * implementation, there is no need to implement this function.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003548 *
3549 * DEPRECATED - use set_ap() instead
Jouni Malinen75ecf522011-06-27 15:19:46 -07003550 */
3551 int (*set_authmode)(void *priv, int authmode);
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003552
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003553#ifdef ANDROID
Jouni Malinen75ecf522011-06-27 15:19:46 -07003554 /**
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003555 * driver_cmd - Execute driver-specific command
3556 * @priv: Private driver interface data
3557 * @cmd: Command to execute
3558 * @buf: Return buffer
3559 * @buf_len: Buffer length
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003560 * Returns: 0 on success, -1 on failure
3561 */
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003562 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
3563#endif /* ANDROID */
3564
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003565 /**
Dmitry Shmidta38abf92014-03-06 13:38:44 -08003566 * vendor_cmd - Execute vendor specific command
3567 * @priv: Private driver interface data
3568 * @vendor_id: Vendor id
3569 * @subcmd: Vendor command id
3570 * @data: Vendor command parameters (%NULL if no parameters)
3571 * @data_len: Data length
3572 * @buf: Return buffer (%NULL to ignore reply)
3573 * Returns: 0 on success, negative (<0) on failure
3574 *
3575 * This function handles vendor specific commands that are passed to
3576 * the driver/device. The command is identified by vendor id and
3577 * command id. Parameters can be passed as argument to the command
3578 * in the data buffer. Reply (if any) will be filled in the supplied
3579 * return buffer.
3580 *
3581 * The exact driver behavior is driver interface and vendor specific. As
3582 * an example, this will be converted to a vendor specific cfg80211
3583 * command in case of the nl80211 driver interface.
3584 */
3585 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3586 unsigned int subcmd, const u8 *data, size_t data_len,
3587 struct wpabuf *buf);
3588
3589 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003590 * set_rekey_info - Set rekey information
3591 * @priv: Private driver interface data
3592 * @kek: Current KEK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003593 * @kek_len: KEK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003594 * @kck: Current KCK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003595 * @kck_len: KCK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003596 * @replay_ctr: Current EAPOL-Key Replay Counter
3597 *
3598 * This optional function can be used to provide information for the
3599 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3600 * while the host (including wpa_supplicant) is sleeping.
3601 */
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003602 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3603 const u8 *kck, size_t kck_len,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003604 const u8 *replay_ctr);
3605
3606 /**
3607 * sta_assoc - Station association indication
3608 * @priv: Private driver interface data
3609 * @own_addr: Source address and BSSID for association frame
3610 * @addr: MAC address of the station to associate
3611 * @reassoc: flag to indicate re-association
3612 * @status: association response status code
3613 * @ie: assoc response ie buffer
3614 * @len: ie buffer length
3615 * Returns: 0 on success, -1 on failure
3616 *
3617 * This function indicates the driver to send (Re)Association
3618 * Response frame to the station.
3619 */
3620 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3621 int reassoc, u16 status, const u8 *ie, size_t len);
3622
3623 /**
3624 * sta_auth - Station authentication indication
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003625 * @priv: private driver interface data
3626 * @params: Station authentication parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003627 *
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003628 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003629 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003630 int (*sta_auth)(void *priv,
3631 struct wpa_driver_sta_auth_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003632
3633 /**
3634 * add_tspec - Add traffic stream
3635 * @priv: Private driver interface data
3636 * @addr: MAC address of the station to associate
3637 * @tspec_ie: tspec ie buffer
3638 * @tspec_ielen: tspec ie length
3639 * Returns: 0 on success, -1 on failure
3640 *
3641 * This function adds the traffic steam for the station
3642 * and fills the medium_time in tspec_ie.
3643 */
3644 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3645 size_t tspec_ielen);
3646
3647 /**
3648 * add_sta_node - Add a station node in the driver
3649 * @priv: Private driver interface data
3650 * @addr: MAC address of the station to add
3651 * @auth_alg: authentication algorithm used by the station
3652 * Returns: 0 on success, -1 on failure
3653 *
3654 * This function adds the station node in the driver, when
3655 * the station gets added by FT-over-DS.
3656 */
3657 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
3658
3659 /**
3660 * sched_scan - Request the driver to initiate scheduled scan
3661 * @priv: Private driver interface data
3662 * @params: Scan parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003663 * Returns: 0 on success, -1 on failure
3664 *
3665 * This operation should be used for scheduled scan offload to
3666 * the hardware. Every time scan results are available, the
3667 * driver should report scan results event for wpa_supplicant
3668 * which will eventually request the results with
3669 * wpa_driver_get_scan_results2(). This operation is optional
3670 * and if not provided or if it returns -1, we fall back to
3671 * normal host-scheduled scans.
3672 */
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003673 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003674
3675 /**
3676 * stop_sched_scan - Request the driver to stop a scheduled scan
3677 * @priv: Private driver interface data
3678 * Returns: 0 on success, -1 on failure
3679 *
3680 * This should cause the scheduled scan to be stopped and
3681 * results should stop being sent. Must be supported if
3682 * sched_scan is supported.
3683 */
3684 int (*stop_sched_scan)(void *priv);
3685
3686 /**
3687 * poll_client - Probe (null data or such) the given station
3688 * @priv: Private driver interface data
3689 * @own_addr: MAC address of sending interface
3690 * @addr: MAC address of the station to probe
3691 * @qos: Indicates whether station is QoS station
3692 *
3693 * This function is used to verify whether an associated station is
3694 * still present. This function does not need to be implemented if the
3695 * driver provides such inactivity polling mechanism.
3696 */
3697 void (*poll_client)(void *priv, const u8 *own_addr,
3698 const u8 *addr, int qos);
Dmitry Shmidt04949592012-07-19 12:16:46 -07003699
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003700 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003701 * radio_disable - Disable/enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003702 * @priv: Private driver interface data
Dmitry Shmidt04949592012-07-19 12:16:46 -07003703 * @disabled: 1=disable 0=enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003704 * Returns: 0 on success, -1 on failure
3705 *
Dmitry Shmidt04949592012-07-19 12:16:46 -07003706 * This optional command is for testing purposes. It can be used to
3707 * disable the radio on a testbed device to simulate out-of-radio-range
3708 * conditions.
3709 */
3710 int (*radio_disable)(void *priv, int disabled);
3711
3712 /**
3713 * switch_channel - Announce channel switch and migrate the GO to the
3714 * given frequency
3715 * @priv: Private driver interface data
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003716 * @settings: Settings for CSA period and new channel
Dmitry Shmidt04949592012-07-19 12:16:46 -07003717 * Returns: 0 on success, -1 on failure
3718 *
3719 * This function is used to move the GO to the legacy STA channel to
3720 * avoid frequency conflict in single channel concurrency.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003721 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003722 int (*switch_channel)(void *priv, struct csa_settings *settings);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003723
3724 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003725 * add_tx_ts - Add traffic stream
3726 * @priv: Private driver interface data
3727 * @tsid: Traffic stream ID
3728 * @addr: Receiver address
3729 * @user_prio: User priority of the traffic stream
3730 * @admitted_time: Admitted time for this TS in units of
3731 * 32 microsecond periods (per second).
3732 * Returns: 0 on success, -1 on failure
3733 */
3734 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3735 u16 admitted_time);
3736
3737 /**
3738 * del_tx_ts - Delete traffic stream
3739 * @priv: Private driver interface data
3740 * @tsid: Traffic stream ID
3741 * @addr: Receiver address
3742 * Returns: 0 on success, -1 on failure
3743 */
3744 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3745
3746 /**
3747 * Enable channel-switching with TDLS peer
3748 * @priv: Private driver interface data
3749 * @addr: MAC address of the TDLS peer
3750 * @oper_class: Operating class of the switch channel
3751 * @params: Channel specification
3752 * Returns: 0 on success, -1 on failure
3753 *
3754 * The function indicates to driver that it can start switching to a
3755 * different channel with a specified TDLS peer. The switching is
3756 * assumed on until canceled with tdls_disable_channel_switch().
3757 */
3758 int (*tdls_enable_channel_switch)(
3759 void *priv, const u8 *addr, u8 oper_class,
3760 const struct hostapd_freq_params *params);
3761
3762 /**
3763 * Disable channel switching with TDLS peer
3764 * @priv: Private driver interface data
3765 * @addr: MAC address of the TDLS peer
3766 * Returns: 0 on success, -1 on failure
3767 *
3768 * This function indicates to the driver that it should stop switching
3769 * with a given TDLS peer.
3770 */
3771 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3772
3773 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003774 * start_dfs_cac - Listen for radar interference on the channel
3775 * @priv: Private driver interface data
Dmitry Shmidt051af732013-10-22 13:52:46 -07003776 * @freq: Channel parameters
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003777 * Returns: 0 on success, -1 on failure
3778 */
Dmitry Shmidt051af732013-10-22 13:52:46 -07003779 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003780
3781 /**
3782 * stop_ap - Removes beacon from AP
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
3787 * configuration. Unlike deinit_ap, it does not change to station
3788 * mode.
3789 */
3790 int (*stop_ap)(void *priv);
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003791
3792 /**
3793 * get_survey - Retrieve survey data
3794 * @priv: Private driver interface data
3795 * @freq: If set, survey data for the specified frequency is only
3796 * being requested. If not set, all survey data is requested.
3797 * Returns: 0 on success, -1 on failure
3798 *
3799 * Use this to retrieve:
3800 *
3801 * - the observed channel noise floor
3802 * - the amount of time we have spent on the channel
3803 * - the amount of time during which we have spent on the channel that
3804 * the radio has determined the medium is busy and we cannot
3805 * transmit
3806 * - the amount of time we have spent receiving data
3807 * - the amount of time we have spent transmitting data
3808 *
3809 * This data can be used for spectrum heuristics. One example is
3810 * Automatic Channel Selection (ACS). The channel survey data is
3811 * kept on a linked list on the channel data, one entry is added
3812 * for each survey. The min_nf of the channel is updated for each
3813 * survey.
3814 */
3815 int (*get_survey)(void *priv, unsigned int freq);
Dmitry Shmidt56052862013-10-04 10:23:25 -07003816
3817 /**
3818 * status - Get driver interface status information
3819 * @priv: Private driver interface data
Hai Shalom74f70d42019-02-11 14:42:39 -08003820 * @buf: Buffer for printing the status information
Dmitry Shmidt56052862013-10-04 10:23:25 -07003821 * @buflen: Maximum length of the buffer
3822 * Returns: Length of written status information or -1 on failure
3823 */
3824 int (*status)(void *priv, char *buf, size_t buflen);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003825
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07003826 /**
3827 * roaming - Set roaming policy for driver-based BSS selection
3828 * @priv: Private driver interface data
3829 * @allowed: Whether roaming within ESS is allowed
3830 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3831 * Returns: Length of written status information or -1 on failure
3832 *
3833 * This optional callback can be used to update roaming policy from the
3834 * associate() command (bssid being set there indicates that the driver
3835 * should not roam before getting this roaming() call to allow roaming.
3836 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3837 * capability, roaming policy is handled within wpa_supplicant and there
3838 * is no need to implement or react to this callback.
3839 */
3840 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3841
3842 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -07003843 * disable_fils - Enable/disable FILS feature
3844 * @priv: Private driver interface data
3845 * @disable: 0-enable and 1-disable FILS feature
3846 * Returns: 0 on success, -1 on failure
3847 *
3848 * This callback can be used to configure driver and below layers to
3849 * enable/disable all FILS features.
3850 */
3851 int (*disable_fils)(void *priv, int disable);
3852
3853 /**
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07003854 * set_mac_addr - Set MAC address
3855 * @priv: Private driver interface data
3856 * @addr: MAC address to use or %NULL for setting back to permanent
3857 * Returns: 0 on success, -1 on failure
3858 */
3859 int (*set_mac_addr)(void *priv, const u8 *addr);
3860
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003861#ifdef CONFIG_MACSEC
3862 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3863
3864 int (*macsec_deinit)(void *priv);
3865
3866 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003867 * macsec_get_capability - Inform MKA of this driver's capability
3868 * @priv: Private driver interface data
3869 * @cap: Driver's capability
3870 * Returns: 0 on success, -1 on failure
3871 */
3872 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);
3873
3874 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003875 * enable_protect_frames - Set protect frames status
3876 * @priv: Private driver interface data
3877 * @enabled: TRUE = protect frames enabled
3878 * FALSE = protect frames disabled
3879 * Returns: 0 on success, -1 on failure (or if not supported)
3880 */
3881 int (*enable_protect_frames)(void *priv, Boolean enabled);
3882
3883 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08003884 * enable_encrypt - Set encryption status
3885 * @priv: Private driver interface data
3886 * @enabled: TRUE = encrypt outgoing traffic
3887 * FALSE = integrity-only protection on outgoing traffic
3888 * Returns: 0 on success, -1 on failure (or if not supported)
3889 */
3890 int (*enable_encrypt)(void *priv, Boolean enabled);
3891
3892 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003893 * set_replay_protect - Set replay protect status and window size
3894 * @priv: Private driver interface data
3895 * @enabled: TRUE = replay protect enabled
3896 * FALSE = replay protect disabled
3897 * @window: replay window size, valid only when replay protect enabled
3898 * Returns: 0 on success, -1 on failure (or if not supported)
3899 */
3900 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3901
3902 /**
3903 * set_current_cipher_suite - Set current cipher suite
3904 * @priv: Private driver interface data
3905 * @cs: EUI64 identifier
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003906 * Returns: 0 on success, -1 on failure (or if not supported)
3907 */
Dmitry Shmidt7d175302016-09-06 13:11:34 -07003908 int (*set_current_cipher_suite)(void *priv, u64 cs);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003909
3910 /**
3911 * enable_controlled_port - Set controlled port status
3912 * @priv: Private driver interface data
3913 * @enabled: TRUE = controlled port enabled
3914 * FALSE = controlled port disabled
3915 * Returns: 0 on success, -1 on failure (or if not supported)
3916 */
3917 int (*enable_controlled_port)(void *priv, Boolean enabled);
3918
3919 /**
3920 * get_receive_lowest_pn - Get receive lowest pn
3921 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003922 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003923 * Returns: 0 on success, -1 on failure (or if not supported)
3924 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003925 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003926
3927 /**
3928 * get_transmit_next_pn - Get transmit next pn
3929 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003930 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003931 * Returns: 0 on success, -1 on failure (or if not supported)
3932 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003933 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003934
3935 /**
3936 * set_transmit_next_pn - Set transmit next pn
3937 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003938 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003939 * Returns: 0 on success, -1 on failure (or if not supported)
3940 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003941 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003942
3943 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08003944 * set_receive_lowest_pn - Set receive lowest PN
3945 * @priv: Private driver interface data
3946 * @sa: secure association
3947 * Returns: 0 on success, -1 on failure (or if not supported)
3948 */
3949 int (*set_receive_lowest_pn)(void *priv, struct receive_sa *sa);
3950
3951 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003952 * create_receive_sc - create secure channel for receiving
3953 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003954 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003955 * @conf_offset: confidentiality offset (0, 30, or 50)
3956 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3957 * 2 = Strict)
3958 * Returns: 0 on success, -1 on failure (or if not supported)
3959 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003960 int (*create_receive_sc)(void *priv, struct receive_sc *sc,
3961 unsigned int conf_offset,
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003962 int validation);
3963
3964 /**
3965 * delete_receive_sc - delete secure connection for receiving
3966 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003967 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003968 * Returns: 0 on success, -1 on failure
3969 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003970 int (*delete_receive_sc)(void *priv, struct receive_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003971
3972 /**
3973 * create_receive_sa - create secure association for receive
3974 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003975 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003976 * Returns: 0 on success, -1 on failure
3977 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003978 int (*create_receive_sa)(void *priv, struct receive_sa *sa);
3979
3980 /**
3981 * delete_receive_sa - Delete secure association for receive
3982 * @priv: Private driver interface data from init()
3983 * @sa: Secure association
3984 * Returns: 0 on success, -1 on failure
3985 */
3986 int (*delete_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003987
3988 /**
3989 * enable_receive_sa - enable the SA for receive
3990 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003991 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003992 * Returns: 0 on success, -1 on failure
3993 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003994 int (*enable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003995
3996 /**
3997 * disable_receive_sa - disable SA for receive
3998 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003999 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004000 * Returns: 0 on success, -1 on failure
4001 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004002 int (*disable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004003
4004 /**
4005 * create_transmit_sc - create secure connection for transmit
4006 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004007 * @sc: secure channel
4008 * @conf_offset: confidentiality offset (0, 30, or 50)
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004009 * Returns: 0 on success, -1 on failure
4010 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004011 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
4012 unsigned int conf_offset);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004013
4014 /**
4015 * delete_transmit_sc - delete secure connection for transmit
4016 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004017 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004018 * Returns: 0 on success, -1 on failure
4019 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004020 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004021
4022 /**
4023 * create_transmit_sa - create secure association for transmit
4024 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004025 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004026 * Returns: 0 on success, -1 on failure
4027 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004028 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);
4029
4030 /**
4031 * delete_transmit_sa - Delete secure association for transmit
4032 * @priv: Private driver interface data from init()
4033 * @sa: Secure association
4034 * Returns: 0 on success, -1 on failure
4035 */
4036 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004037
4038 /**
4039 * enable_transmit_sa - enable SA for transmit
4040 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004041 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004042 * Returns: 0 on success, -1 on failure
4043 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004044 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004045
4046 /**
4047 * disable_transmit_sa - disable SA for transmit
4048 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004049 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004050 * Returns: 0 on success, -1 on failure
4051 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004052 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004053#endif /* CONFIG_MACSEC */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004054
4055 /**
4056 * init_mesh - Driver specific initialization for mesh
4057 * @priv: Private driver interface data
4058 * Returns: 0 on success, -1 on failure
4059 */
4060 int (*init_mesh)(void *priv);
4061
4062 /**
4063 * join_mesh - Join a mesh network
4064 * @priv: Private driver interface data
4065 * @params: Mesh configuration parameters
4066 * Returns: 0 on success, -1 on failure
4067 */
4068 int (*join_mesh)(void *priv,
4069 struct wpa_driver_mesh_join_params *params);
4070
4071 /**
4072 * leave_mesh - Leave a mesh network
4073 * @priv: Private driver interface data
4074 * Returns 0 on success, -1 on failure
4075 */
4076 int (*leave_mesh)(void *priv);
4077
4078 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07004079 * probe_mesh_link - Inject a frame over direct mesh link to a given
4080 * peer skipping the next_hop lookup from mpath table.
4081 * @priv: Private driver interface data
4082 * @addr: Peer MAC address
4083 * @eth: Ethernet frame to be sent
4084 * @len: Ethernet frame lengtn in bytes
4085 * Returns 0 on success, -1 on failure
4086 */
4087 int (*probe_mesh_link)(void *priv, const u8 *addr, const u8 *eth,
4088 size_t len);
4089
4090 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004091 * do_acs - Automatically select channel
4092 * @priv: Private driver interface data
4093 * @params: Parameters for ACS
4094 * Returns 0 on success, -1 on failure
4095 *
4096 * This command can be used to offload ACS to the driver if the driver
4097 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
4098 */
4099 int (*do_acs)(void *priv, struct drv_acs_params *params);
Ravi Joshie6ccb162015-07-16 17:45:41 -07004100
4101 /**
4102 * set_band - Notify driver of band selection
4103 * @priv: Private driver interface data
4104 * @band: The selected band(s)
4105 * Returns 0 on success, -1 on failure
4106 */
4107 int (*set_band)(void *priv, enum set_band band);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004108
4109 /**
4110 * get_pref_freq_list - Get preferred frequency list for an interface
4111 * @priv: Private driver interface data
4112 * @if_type: Interface type
4113 * @num: Number of channels
4114 * @freq_list: Preferred channel frequency list encoded in MHz values
4115 * Returns 0 on success, -1 on failure
4116 *
4117 * This command can be used to query the preferred frequency list from
4118 * the driver specific to a particular interface type.
4119 */
4120 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
4121 unsigned int *num, unsigned int *freq_list);
4122
4123 /**
4124 * set_prob_oper_freq - Indicate probable P2P operating channel
4125 * @priv: Private driver interface data
4126 * @freq: Channel frequency in MHz
4127 * Returns 0 on success, -1 on failure
4128 *
4129 * This command can be used to inform the driver of the operating
4130 * frequency that an ongoing P2P group formation is likely to come up
4131 * on. Local device is assuming P2P Client role.
4132 */
4133 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004134
4135 /**
4136 * abort_scan - Request the driver to abort an ongoing scan
4137 * @priv: Private driver interface data
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004138 * @scan_cookie: Cookie identifying the scan request. This is used only
4139 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4140 * was used to trigger scan. Otherwise, 0 is used.
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004141 * Returns 0 on success, -1 on failure
4142 */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004143 int (*abort_scan)(void *priv, u64 scan_cookie);
Dmitry Shmidt849734c2016-05-27 09:59:01 -07004144
4145 /**
4146 * configure_data_frame_filters - Request to configure frame filters
4147 * @priv: Private driver interface data
4148 * @filter_flags: The type of frames to filter (bitfield of
4149 * WPA_DATA_FRAME_FILTER_FLAG_*)
4150 * Returns: 0 on success or -1 on failure
4151 */
4152 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07004153
4154 /**
4155 * get_ext_capab - Get extended capabilities for the specified interface
4156 * @priv: Private driver interface data
4157 * @type: Interface type for which to get extended capabilities
4158 * @ext_capab: Extended capabilities fetched
4159 * @ext_capab_mask: Extended capabilities mask
4160 * @ext_capab_len: Length of the extended capabilities
4161 * Returns: 0 on success or -1 on failure
4162 */
4163 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
4164 const u8 **ext_capab, const u8 **ext_capab_mask,
4165 unsigned int *ext_capab_len);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004166
4167 /**
4168 * p2p_lo_start - Start offloading P2P listen to device
4169 * @priv: Private driver interface data
4170 * @freq: Listening frequency (MHz) for P2P listen
4171 * @period: Length of the listen operation in milliseconds
4172 * @interval: Interval for running the listen operation in milliseconds
4173 * @count: Number of times to run the listen operation
4174 * @device_types: Device primary and secondary types
4175 * @dev_types_len: Number of bytes for device_types
4176 * @ies: P2P IE and WSC IE for Probe Response frames
4177 * @ies_len: Length of ies in bytes
4178 * Returns: 0 on success or -1 on failure
4179 */
4180 int (*p2p_lo_start)(void *priv, unsigned int freq,
4181 unsigned int period, unsigned int interval,
4182 unsigned int count,
4183 const u8 *device_types, size_t dev_types_len,
4184 const u8 *ies, size_t ies_len);
4185
4186 /**
4187 * p2p_lo_stop - Stop P2P listen offload
4188 * @priv: Private driver interface data
4189 * Returns: 0 on success or -1 on failure
4190 */
4191 int (*p2p_lo_stop)(void *priv);
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07004192
4193 /**
4194 * set_default_scan_ies - Set default scan IEs
4195 * @priv: Private driver interface data
4196 * @ies: Scan default IEs buffer
4197 * @ies_len: Length of IEs in bytes
4198 * Returns: 0 on success or -1 on failure
4199 *
4200 * The driver can use these by default when there are no scan IEs coming
4201 * in the subsequent scan requests. Also in case of one or more of IEs
4202 * given in set_default_scan_ies() are missing in the subsequent scan
4203 * request, the driver should merge the missing scan IEs in the scan
4204 * request from the IEs set by set_default_scan_ies() in the Probe
4205 * Request frames sent.
4206 */
4207 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
4208
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004209 /**
4210 * set_tdls_mode - Set TDLS trigger mode to the host driver
4211 * @priv: Private driver interface data
4212 * @tdls_external_control: Represents if TDLS external trigger control
4213 * mode is enabled/disabled.
4214 *
4215 * This optional callback can be used to configure the TDLS external
4216 * trigger control mode to the host driver.
4217 */
4218 int (*set_tdls_mode)(void *priv, int tdls_external_control);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004219
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004220 /**
4221 * get_bss_transition_status - Get candidate BSS's transition status
4222 * @priv: Private driver interface data
4223 * @params: Candidate BSS list
4224 *
4225 * Get the accept or reject reason code for a list of BSS transition
4226 * candidates.
4227 */
4228 struct wpa_bss_candidate_info *
4229 (*get_bss_transition_status)(void *priv,
4230 struct wpa_bss_trans_info *params);
4231 /**
4232 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
4233 * @priv: Private driver interface data
4234 * @ignore_disallow: 0 to not ignore, 1 to ignore
4235 * Returns: 0 on success, -1 on failure
4236 */
4237 int (*ignore_assoc_disallow)(void *priv, int ignore_disallow);
4238
4239 /**
4240 * set_bssid_blacklist - Set blacklist of BSSIDs to the driver
4241 * @priv: Private driver interface data
4242 * @num_bssid: Number of blacklist BSSIDs
4243 * @bssids: List of blacklisted BSSIDs
4244 */
4245 int (*set_bssid_blacklist)(void *priv, unsigned int num_bssid,
4246 const u8 *bssid);
4247
4248 /**
4249 * update_connect_params - Update the connection parameters
4250 * @priv: Private driver interface data
4251 * @params: Association parameters
4252 * @mask: Bit mask indicating which parameters in @params have to be
4253 * updated
4254 * Returns: 0 on success, -1 on failure
4255 *
4256 * Update the connection parameters when in connected state so that the
4257 * driver uses the updated parameters for subsequent roaming. This is
4258 * used only with drivers that implement internal BSS selection and
4259 * roaming.
4260 */
4261 int (*update_connect_params)(
4262 void *priv, struct wpa_driver_associate_params *params,
4263 enum wpa_drv_update_connect_params_mask mask);
Roshan Pius3a1667e2018-07-03 15:17:14 -07004264
4265 /**
4266 * send_external_auth_status - Indicate the status of external
4267 * authentication processing to the host driver.
4268 * @priv: Private driver interface data
4269 * @params: Status of authentication processing.
4270 * Returns: 0 on success, -1 on failure
4271 */
4272 int (*send_external_auth_status)(void *priv,
4273 struct external_auth *params);
Hai Shalom74f70d42019-02-11 14:42:39 -08004274
4275 /**
4276 * set_4addr_mode - Set 4-address mode
4277 * @priv: Private driver interface data
4278 * @bridge_ifname: Bridge interface name
4279 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
4280 * Returns: 0 on success, < 0 on failure
4281 */
4282 int (*set_4addr_mode)(void *priv, const char *bridge_ifname, int val);
Hai Shalom81f62d82019-07-22 12:10:00 -07004283
4284 /**
4285 * update_dh_ie - Update DH IE
4286 * @priv: Private driver interface data
4287 * @peer_mac: Peer MAC address
4288 * @reason_code: Reacon code
4289 * @ie: DH IE
4290 * @ie_len: DH IE length in bytes
4291 * Returns: 0 on success, -1 on failure
4292 *
4293 * This callback is used to let the driver know the DH processing result
4294 * and DH IE for a pending association.
4295 */
4296 int (*update_dh_ie)(void *priv, const u8 *peer_mac, u16 reason_code,
4297 const u8 *ie, size_t ie_len);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004298};
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004299
4300/**
4301 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
4302 */
4303enum wpa_event_type {
4304 /**
4305 * EVENT_ASSOC - Association completed
4306 *
4307 * This event needs to be delivered when the driver completes IEEE
4308 * 802.11 association or reassociation successfully.
4309 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
4310 * after this event has been generated. In addition, optional
4311 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
4312 * more information about the association. If the driver interface gets
4313 * both of these events at the same time, it can also include the
4314 * assoc_info data in EVENT_ASSOC call.
4315 */
4316 EVENT_ASSOC,
4317
4318 /**
4319 * EVENT_DISASSOC - Association lost
4320 *
4321 * This event should be called when association is lost either due to
4322 * receiving deauthenticate or disassociate frame from the AP or when
4323 * sending either of these frames to the current AP. If the driver
4324 * supports separate deauthentication event, EVENT_DISASSOC should only
4325 * be used for disassociation and EVENT_DEAUTH for deauthentication.
4326 * In AP mode, union wpa_event_data::disassoc_info is required.
4327 */
4328 EVENT_DISASSOC,
4329
4330 /**
4331 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
4332 *
4333 * This event must be delivered when a Michael MIC error is detected by
4334 * the local driver. Additional data for event processing is
4335 * provided with union wpa_event_data::michael_mic_failure. This
4336 * information is used to request new encyption key and to initiate
4337 * TKIP countermeasures if needed.
4338 */
4339 EVENT_MICHAEL_MIC_FAILURE,
4340
4341 /**
4342 * EVENT_SCAN_RESULTS - Scan results available
4343 *
4344 * This event must be called whenever scan results are available to be
4345 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4346 * is expected to be used some time after struct wpa_driver_ops::scan()
4347 * is called. If the driver provides an unsolicited event when the scan
4348 * has been completed, this event can be used to trigger
4349 * EVENT_SCAN_RESULTS call. If such event is not available from the
4350 * driver, the driver wrapper code is expected to use a registered
4351 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
4352 * scan is expected to be completed. Optional information about
4353 * completed scan can be provided with union wpa_event_data::scan_info.
4354 */
4355 EVENT_SCAN_RESULTS,
4356
4357 /**
4358 * EVENT_ASSOCINFO - Report optional extra information for association
4359 *
4360 * This event can be used to report extra association information for
4361 * EVENT_ASSOC processing. This extra information includes IEs from
4362 * association frames and Beacon/Probe Response frames in union
4363 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4364 * EVENT_ASSOC. Alternatively, the driver interface can include
4365 * assoc_info data in the EVENT_ASSOC call if it has all the
4366 * information available at the same point.
4367 */
4368 EVENT_ASSOCINFO,
4369
4370 /**
4371 * EVENT_INTERFACE_STATUS - Report interface status changes
4372 *
4373 * This optional event can be used to report changes in interface
4374 * status (interface added/removed) using union
4375 * wpa_event_data::interface_status. This can be used to trigger
4376 * wpa_supplicant to stop and re-start processing for the interface,
4377 * e.g., when a cardbus card is ejected/inserted.
4378 */
4379 EVENT_INTERFACE_STATUS,
4380
4381 /**
4382 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4383 *
4384 * This event can be used to inform wpa_supplicant about candidates for
4385 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4386 * for scan request (ap_scan=2 mode), this event is required for
4387 * pre-authentication. If wpa_supplicant is performing scan request
4388 * (ap_scan=1), this event is optional since scan results can be used
4389 * to add pre-authentication candidates. union
4390 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4391 * candidate and priority of the candidate, e.g., based on the signal
4392 * strength, in order to try to pre-authenticate first with candidates
4393 * that are most likely targets for re-association.
4394 *
4395 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4396 * on the candidate list. In addition, it can be called for the current
4397 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4398 * will automatically skip pre-authentication in cases where a valid
4399 * PMKSA exists. When more than one candidate exists, this event should
4400 * be generated once for each candidate.
4401 *
4402 * Driver will be notified about successful pre-authentication with
4403 * struct wpa_driver_ops::add_pmkid() calls.
4404 */
4405 EVENT_PMKID_CANDIDATE,
4406
4407 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004408 * EVENT_TDLS - Request TDLS operation
4409 *
4410 * This event can be used to request a TDLS operation to be performed.
4411 */
4412 EVENT_TDLS,
4413
4414 /**
4415 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4416 *
4417 * The driver is expected to report the received FT IEs from
4418 * FT authentication sequence from the AP. The FT IEs are included in
4419 * the extra information in union wpa_event_data::ft_ies.
4420 */
4421 EVENT_FT_RESPONSE,
4422
4423 /**
4424 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4425 *
4426 * The driver can use this event to inform wpa_supplicant about a STA
4427 * in an IBSS with which protected frames could be exchanged. This
4428 * event starts RSN authentication with the other STA to authenticate
4429 * the STA and set up encryption keys with it.
4430 */
4431 EVENT_IBSS_RSN_START,
4432
4433 /**
4434 * EVENT_AUTH - Authentication result
4435 *
4436 * This event should be called when authentication attempt has been
4437 * completed. This is only used if the driver supports separate
4438 * authentication step (struct wpa_driver_ops::authenticate).
4439 * Information about authentication result is included in
4440 * union wpa_event_data::auth.
4441 */
4442 EVENT_AUTH,
4443
4444 /**
4445 * EVENT_DEAUTH - Authentication lost
4446 *
4447 * This event should be called when authentication is lost either due
4448 * to receiving deauthenticate frame from the AP or when sending that
4449 * frame to the current AP.
4450 * In AP mode, union wpa_event_data::deauth_info is required.
4451 */
4452 EVENT_DEAUTH,
4453
4454 /**
4455 * EVENT_ASSOC_REJECT - Association rejected
4456 *
4457 * This event should be called when (re)association attempt has been
4458 * rejected by the AP. Information about the association response is
4459 * included in union wpa_event_data::assoc_reject.
4460 */
4461 EVENT_ASSOC_REJECT,
4462
4463 /**
4464 * EVENT_AUTH_TIMED_OUT - Authentication timed out
4465 */
4466 EVENT_AUTH_TIMED_OUT,
4467
4468 /**
4469 * EVENT_ASSOC_TIMED_OUT - Association timed out
4470 */
4471 EVENT_ASSOC_TIMED_OUT,
4472
4473 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004474 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
4475 */
4476 EVENT_WPS_BUTTON_PUSHED,
4477
4478 /**
4479 * EVENT_TX_STATUS - Report TX status
4480 */
4481 EVENT_TX_STATUS,
4482
4483 /**
4484 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
4485 */
4486 EVENT_RX_FROM_UNKNOWN,
4487
4488 /**
4489 * EVENT_RX_MGMT - Report RX of a management frame
4490 */
4491 EVENT_RX_MGMT,
4492
4493 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004494 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
4495 *
4496 * This event is used to indicate when the driver has started the
4497 * requested remain-on-channel duration. Information about the
4498 * operation is included in union wpa_event_data::remain_on_channel.
4499 */
4500 EVENT_REMAIN_ON_CHANNEL,
4501
4502 /**
4503 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
4504 *
4505 * This event is used to indicate when the driver has completed
4506 * remain-on-channel duration, i.e., may noot be available on the
4507 * requested channel anymore. Information about the
4508 * operation is included in union wpa_event_data::remain_on_channel.
4509 */
4510 EVENT_CANCEL_REMAIN_ON_CHANNEL,
4511
4512 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004513 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
4514 *
4515 * This event is used to indicate when a Probe Request frame has been
4516 * received. Information about the received frame is included in
4517 * union wpa_event_data::rx_probe_req. The driver is required to report
4518 * these events only after successfully completed probe_req_report()
4519 * commands to request the events (i.e., report parameter is non-zero)
4520 * in station mode. In AP mode, Probe Request frames should always be
4521 * reported.
4522 */
4523 EVENT_RX_PROBE_REQ,
4524
4525 /**
4526 * EVENT_NEW_STA - New wired device noticed
4527 *
4528 * This event is used to indicate that a new device has been detected
4529 * in a network that does not use association-like functionality (i.e.,
4530 * mainly wired Ethernet). This can be used to start EAPOL
4531 * authenticator when receiving a frame from a device. The address of
4532 * the device is included in union wpa_event_data::new_sta.
4533 */
4534 EVENT_NEW_STA,
4535
4536 /**
4537 * EVENT_EAPOL_RX - Report received EAPOL frame
4538 *
4539 * When in AP mode with hostapd, this event is required to be used to
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004540 * deliver the receive EAPOL frames from the driver.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004541 */
4542 EVENT_EAPOL_RX,
4543
4544 /**
4545 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4546 *
4547 * This event is used to indicate changes in the signal strength
4548 * observed in frames received from the current AP if signal strength
4549 * monitoring has been enabled with signal_monitor().
4550 */
4551 EVENT_SIGNAL_CHANGE,
4552
4553 /**
4554 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4555 *
4556 * This event is used to indicate that the interface was enabled after
4557 * having been previously disabled, e.g., due to rfkill.
4558 */
4559 EVENT_INTERFACE_ENABLED,
4560
4561 /**
4562 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4563 *
4564 * This event is used to indicate that the interface was disabled,
4565 * e.g., due to rfkill.
4566 */
4567 EVENT_INTERFACE_DISABLED,
4568
4569 /**
4570 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4571 *
4572 * This event is used to indicate that the channel list has changed,
4573 * e.g., because of a regulatory domain change triggered by scan
4574 * results including an AP advertising a country code.
4575 */
4576 EVENT_CHANNEL_LIST_CHANGED,
4577
4578 /**
4579 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4580 *
4581 * This event is used to indicate that the driver cannot maintain this
4582 * interface in its operation mode anymore. The most likely use for
4583 * this is to indicate that AP mode operation is not available due to
4584 * operating channel would need to be changed to a DFS channel when
4585 * the driver does not support radar detection and another virtual
4586 * interfaces caused the operating channel to change. Other similar
4587 * resource conflicts could also trigger this for station mode
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07004588 * interfaces. This event can be propagated when channel switching
4589 * fails.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004590 */
4591 EVENT_INTERFACE_UNAVAILABLE,
4592
4593 /**
4594 * EVENT_BEST_CHANNEL
4595 *
4596 * Driver generates this event whenever it detects a better channel
4597 * (e.g., based on RSSI or channel use). This information can be used
4598 * to improve channel selection for a new AP/P2P group.
4599 */
4600 EVENT_BEST_CHANNEL,
4601
4602 /**
4603 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4604 *
4605 * This event should be called when a Deauthentication frame is dropped
4606 * due to it not being protected (MFP/IEEE 802.11w).
4607 * union wpa_event_data::unprot_deauth is required to provide more
4608 * details of the frame.
4609 */
4610 EVENT_UNPROT_DEAUTH,
4611
4612 /**
4613 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4614 *
4615 * This event should be called when a Disassociation frame is dropped
4616 * due to it not being protected (MFP/IEEE 802.11w).
4617 * union wpa_event_data::unprot_disassoc is required to provide more
4618 * details of the frame.
4619 */
4620 EVENT_UNPROT_DISASSOC,
4621
4622 /**
4623 * EVENT_STATION_LOW_ACK
4624 *
4625 * Driver generates this event whenever it detected that a particular
4626 * station was lost. Detection can be through massive transmission
4627 * failures for example.
4628 */
4629 EVENT_STATION_LOW_ACK,
4630
4631 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004632 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4633 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004634 EVENT_IBSS_PEER_LOST,
4635
4636 /**
4637 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4638 *
4639 * This event carries the new replay counter to notify wpa_supplicant
4640 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4641 * completed Group Key Handshake while the host (including
4642 * wpa_supplicant was sleeping).
4643 */
4644 EVENT_DRIVER_GTK_REKEY,
4645
4646 /**
4647 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4648 */
4649 EVENT_SCHED_SCAN_STOPPED,
4650
4651 /**
4652 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4653 *
4654 * This event indicates that the station responded to the poll
4655 * initiated with @poll_client.
4656 */
4657 EVENT_DRIVER_CLIENT_POLL_OK,
4658
4659 /**
4660 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4661 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07004662 EVENT_EAPOL_TX_STATUS,
4663
4664 /**
4665 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4666 *
4667 * Described in wpa_event_data.ch_switch
4668 * */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004669 EVENT_CH_SWITCH,
4670
4671 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07004672 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
4673 *
4674 * This is a pre-switch event indicating the shortly following switch
4675 * of operating channels.
4676 *
4677 * Described in wpa_event_data.ch_switch
4678 */
4679 EVENT_CH_SWITCH_STARTED,
4680 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004681 * EVENT_WNM - Request WNM operation
4682 *
4683 * This event can be used to request a WNM operation to be performed.
4684 */
Dmitry Shmidtf8623282013-02-20 14:34:59 -08004685 EVENT_WNM,
4686
4687 /**
4688 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4689 *
4690 * This event indicates that the driver reported a connection failure
4691 * with the specified client (for example, max client reached, etc.) in
4692 * AP mode.
4693 */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004694 EVENT_CONNECT_FAILED_REASON,
4695
4696 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004697 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004698 *
4699 * A radar has been detected on the supplied frequency, hostapd should
4700 * react accordingly (e.g., change channel).
4701 */
4702 EVENT_DFS_RADAR_DETECTED,
4703
4704 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004705 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004706 *
4707 * After a successful CAC, the channel can be marked clear and used.
4708 */
4709 EVENT_DFS_CAC_FINISHED,
4710
4711 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004712 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004713 *
4714 * The CAC was not successful, and the channel remains in the previous
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004715 * state. This may happen due to a radar being detected or other
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004716 * external influences.
4717 */
4718 EVENT_DFS_CAC_ABORTED,
4719
4720 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004721 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004722 *
4723 * The channel which was previously unavailable is now available again.
4724 */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004725 EVENT_DFS_NOP_FINISHED,
4726
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08004727 /**
4728 * EVENT_SURVEY - Received survey data
4729 *
4730 * This event gets triggered when a driver query is issued for survey
4731 * data and the requested data becomes available. The returned data is
4732 * stored in struct survey_results. The results provide at most one
4733 * survey entry for each frequency and at minimum will provide one
4734 * survey entry for one frequency. The survey data can be os_malloc()'d
4735 * and then os_free()'d, so the event callback must only copy data.
4736 */
4737 EVENT_SURVEY,
4738
4739 /**
4740 * EVENT_SCAN_STARTED - Scan started
4741 *
4742 * This indicates that driver has started a scan operation either based
4743 * on a request from wpa_supplicant/hostapd or from another application.
4744 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4745 * completed (either successfully or by getting cancelled).
4746 */
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08004747 EVENT_SCAN_STARTED,
4748
4749 /**
4750 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4751 *
4752 * This event indicates a set of frequency ranges that should be avoided
4753 * to reduce issues due to interference or internal co-existence
4754 * information in the driver.
4755 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004756 EVENT_AVOID_FREQUENCIES,
4757
4758 /**
4759 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4760 */
4761 EVENT_NEW_PEER_CANDIDATE,
4762
4763 /**
4764 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4765 *
4766 * Indicates a pair of primary and secondary channels chosen by ACS
4767 * in device.
4768 */
4769 EVENT_ACS_CHANNEL_SELECTED,
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004770
4771 /**
4772 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4773 * been started.
4774 *
4775 * This event indicates that channel availability check has been started
4776 * on a DFS frequency by a driver that supports DFS Offload.
4777 */
4778 EVENT_DFS_CAC_STARTED,
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004779
4780 /**
4781 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4782 */
4783 EVENT_P2P_LO_STOP,
Paul Stewart092955c2017-02-06 09:13:09 -08004784
4785 /**
4786 * EVENT_BEACON_LOSS - Beacon loss detected
4787 *
4788 * This event indicates that no Beacon frames has been received from
4789 * the current AP. This may indicate that the AP is not anymore in
4790 * range.
4791 */
4792 EVENT_BEACON_LOSS,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004793
4794 /**
4795 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
4796 * done previously (Pre-CAC) on the channel has expired. This would
4797 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
4798 * channel will be moved from available to usable. A new CAC has to be
4799 * performed before start operating on this channel.
4800 */
4801 EVENT_DFS_PRE_CAC_EXPIRED,
Roshan Pius3a1667e2018-07-03 15:17:14 -07004802
4803 /**
4804 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
4805 * that do not define separate commands for authentication and
4806 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
4807 * authentication to wpa_supplicant. This event carries all the
4808 * necessary information from the host driver for the authentication to
4809 * happen.
4810 */
4811 EVENT_EXTERNAL_AUTH,
4812
4813 /**
4814 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
4815 *
4816 * This event should be indicated when the driver completes the 4-way
4817 * handshake. This event should be preceded by an EVENT_ASSOC that
4818 * indicates the completion of IEEE 802.11 association.
4819 */
4820 EVENT_PORT_AUTHORIZED,
4821
4822 /**
4823 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
4824 * change event.
4825 */
4826 EVENT_STATION_OPMODE_CHANGED,
4827
4828 /**
4829 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
4830 *
4831 * This event is emitted when the MAC changes while the interface is
4832 * enabled. When an interface was disabled and becomes enabled, it
4833 * must be always assumed that the MAC possibly changed.
4834 */
4835 EVENT_INTERFACE_MAC_CHANGED,
4836
4837 /**
4838 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
4839 *
4840 * This event is emitted when an interface is added/removed for WDS STA.
4841 */
4842 EVENT_WDS_STA_INTERFACE_STATUS,
Hai Shalom81f62d82019-07-22 12:10:00 -07004843
4844 /**
4845 * EVENT_UPDATE_DH - Notification of updated DH information
4846 */
4847 EVENT_UPDATE_DH,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004848};
4849
4850
4851/**
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004852 * struct freq_survey - Channel survey info
4853 *
4854 * @ifidx: Interface index in which this survey was observed
4855 * @freq: Center of frequency of the surveyed channel
4856 * @nf: Channel noise floor in dBm
4857 * @channel_time: Amount of time in ms the radio spent on the channel
4858 * @channel_time_busy: Amount of time in ms the radio detected some signal
4859 * that indicated to the radio the channel was not clear
4860 * @channel_time_rx: Amount of time the radio spent receiving data
4861 * @channel_time_tx: Amount of time the radio spent transmitting data
4862 * @filled: bitmask indicating which fields have been reported, see
4863 * SURVEY_HAS_* defines.
4864 * @list: Internal list pointers
4865 */
4866struct freq_survey {
4867 u32 ifidx;
4868 unsigned int freq;
4869 s8 nf;
4870 u64 channel_time;
4871 u64 channel_time_busy;
4872 u64 channel_time_rx;
4873 u64 channel_time_tx;
4874 unsigned int filled;
4875 struct dl_list list;
4876};
4877
4878#define SURVEY_HAS_NF BIT(0)
4879#define SURVEY_HAS_CHAN_TIME BIT(1)
4880#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4881#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4882#define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4883
4884
4885/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004886 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4887 */
4888union wpa_event_data {
4889 /**
4890 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4891 *
4892 * This structure is optional for EVENT_ASSOC calls and required for
4893 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4894 * driver interface does not need to generate separate EVENT_ASSOCINFO
4895 * calls.
4896 */
4897 struct assoc_info {
4898 /**
4899 * reassoc - Flag to indicate association or reassociation
4900 */
4901 int reassoc;
4902
4903 /**
4904 * req_ies - (Re)Association Request IEs
4905 *
4906 * If the driver generates WPA/RSN IE, this event data must be
4907 * returned for WPA handshake to have needed information. If
4908 * wpa_supplicant-generated WPA/RSN IE is used, this
4909 * information event is optional.
4910 *
4911 * This should start with the first IE (fixed fields before IEs
4912 * are not included).
4913 */
4914 const u8 *req_ies;
4915
4916 /**
4917 * req_ies_len - Length of req_ies in bytes
4918 */
4919 size_t req_ies_len;
4920
4921 /**
4922 * resp_ies - (Re)Association Response IEs
4923 *
4924 * Optional association data from the driver. This data is not
4925 * required WPA, but may be useful for some protocols and as
4926 * such, should be reported if this is available to the driver
4927 * interface.
4928 *
4929 * This should start with the first IE (fixed fields before IEs
4930 * are not included).
4931 */
4932 const u8 *resp_ies;
4933
4934 /**
4935 * resp_ies_len - Length of resp_ies in bytes
4936 */
4937 size_t resp_ies_len;
4938
4939 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004940 * resp_frame - (Re)Association Response frame
4941 */
4942 const u8 *resp_frame;
4943
4944 /**
4945 * resp_frame_len - (Re)Association Response frame length
4946 */
4947 size_t resp_frame_len;
4948
4949 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004950 * beacon_ies - Beacon or Probe Response IEs
4951 *
4952 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4953 * Probe Response frames from the current AP (i.e., the one
4954 * that the client just associated with). This information is
4955 * used to update WPA/RSN IE for the AP. If this field is not
4956 * set, the results from previous scan will be used. If no
4957 * data for the new AP is found, scan results will be requested
4958 * again (without scan request). At this point, the driver is
4959 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4960 * used).
4961 *
4962 * This should start with the first IE (fixed fields before IEs
4963 * are not included).
4964 */
4965 const u8 *beacon_ies;
4966
4967 /**
4968 * beacon_ies_len - Length of beacon_ies */
4969 size_t beacon_ies_len;
4970
4971 /**
4972 * freq - Frequency of the operational channel in MHz
4973 */
4974 unsigned int freq;
4975
4976 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004977 * wmm_params - WMM parameters used in this association.
4978 */
4979 struct wmm_params wmm_params;
4980
4981 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004982 * addr - Station address (for AP mode)
4983 */
4984 const u8 *addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004985
4986 /**
4987 * The following is the key management offload information
4988 * @authorized
4989 * @key_replay_ctr
4990 * @key_replay_ctr_len
4991 * @ptk_kck
4992 * @ptk_kek_len
4993 * @ptk_kek
4994 * @ptk_kek_len
4995 */
4996
4997 /**
4998 * authorized - Status of key management offload,
4999 * 1 = successful
5000 */
5001 int authorized;
5002
5003 /**
5004 * key_replay_ctr - Key replay counter value last used
5005 * in a valid EAPOL-Key frame
5006 */
5007 const u8 *key_replay_ctr;
5008
5009 /**
5010 * key_replay_ctr_len - The length of key_replay_ctr
5011 */
5012 size_t key_replay_ctr_len;
5013
5014 /**
5015 * ptk_kck - The derived PTK KCK
5016 */
5017 const u8 *ptk_kck;
5018
5019 /**
5020 * ptk_kek_len - The length of ptk_kck
5021 */
5022 size_t ptk_kck_len;
5023
5024 /**
5025 * ptk_kek - The derived PTK KEK
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005026 * This is used in key management offload and also in FILS SK
5027 * offload.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005028 */
5029 const u8 *ptk_kek;
5030
5031 /**
5032 * ptk_kek_len - The length of ptk_kek
5033 */
5034 size_t ptk_kek_len;
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08005035
5036 /**
5037 * subnet_status - The subnet status:
5038 * 0 = unknown, 1 = unchanged, 2 = changed
5039 */
5040 u8 subnet_status;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005041
5042 /**
5043 * The following information is used in FILS SK offload
5044 * @fils_erp_next_seq_num
5045 * @fils_pmk
5046 * @fils_pmk_len
5047 * @fils_pmkid
5048 */
5049
5050 /**
5051 * fils_erp_next_seq_num - The next sequence number to use in
5052 * FILS ERP messages
5053 */
5054 u16 fils_erp_next_seq_num;
5055
5056 /**
5057 * fils_pmk - A new PMK if generated in case of FILS
5058 * authentication
5059 */
5060 const u8 *fils_pmk;
5061
5062 /**
5063 * fils_pmk_len - Length of fils_pmk
5064 */
5065 size_t fils_pmk_len;
5066
5067 /**
5068 * fils_pmkid - PMKID used or generated in FILS authentication
5069 */
5070 const u8 *fils_pmkid;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005071 } assoc_info;
5072
5073 /**
5074 * struct disassoc_info - Data for EVENT_DISASSOC events
5075 */
5076 struct disassoc_info {
5077 /**
5078 * addr - Station address (for AP mode)
5079 */
5080 const u8 *addr;
5081
5082 /**
5083 * reason_code - Reason Code (host byte order) used in
5084 * Deauthentication frame
5085 */
5086 u16 reason_code;
5087
5088 /**
5089 * ie - Optional IE(s) in Disassociation frame
5090 */
5091 const u8 *ie;
5092
5093 /**
5094 * ie_len - Length of ie buffer in octets
5095 */
5096 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005097
5098 /**
5099 * locally_generated - Whether the frame was locally generated
5100 */
5101 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005102 } disassoc_info;
5103
5104 /**
5105 * struct deauth_info - Data for EVENT_DEAUTH events
5106 */
5107 struct deauth_info {
5108 /**
5109 * addr - Station address (for AP mode)
5110 */
5111 const u8 *addr;
5112
5113 /**
5114 * reason_code - Reason Code (host byte order) used in
5115 * Deauthentication frame
5116 */
5117 u16 reason_code;
5118
5119 /**
5120 * ie - Optional IE(s) in Deauthentication frame
5121 */
5122 const u8 *ie;
5123
5124 /**
5125 * ie_len - Length of ie buffer in octets
5126 */
5127 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005128
5129 /**
5130 * locally_generated - Whether the frame was locally generated
5131 */
5132 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005133 } deauth_info;
5134
5135 /**
5136 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
5137 */
5138 struct michael_mic_failure {
5139 int unicast;
5140 const u8 *src;
5141 } michael_mic_failure;
5142
5143 /**
5144 * struct interface_status - Data for EVENT_INTERFACE_STATUS
5145 */
5146 struct interface_status {
Dmitry Shmidte4663042016-04-04 10:07:49 -07005147 unsigned int ifindex;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005148 char ifname[100];
5149 enum {
5150 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
5151 } ievent;
5152 } interface_status;
5153
5154 /**
5155 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
5156 */
5157 struct pmkid_candidate {
5158 /** BSSID of the PMKID candidate */
5159 u8 bssid[ETH_ALEN];
5160 /** Smaller the index, higher the priority */
5161 int index;
5162 /** Whether RSN IE includes pre-authenticate flag */
5163 int preauth;
5164 } pmkid_candidate;
5165
5166 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005167 * struct tdls - Data for EVENT_TDLS
5168 */
5169 struct tdls {
5170 u8 peer[ETH_ALEN];
5171 enum {
5172 TDLS_REQUEST_SETUP,
Dmitry Shmidt4dd28dc2015-03-10 11:21:43 -07005173 TDLS_REQUEST_TEARDOWN,
5174 TDLS_REQUEST_DISCOVER,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005175 } oper;
5176 u16 reason_code; /* for teardown */
5177 } tdls;
5178
5179 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07005180 * struct wnm - Data for EVENT_WNM
5181 */
5182 struct wnm {
5183 u8 addr[ETH_ALEN];
5184 enum {
5185 WNM_OPER_SLEEP,
5186 } oper;
5187 enum {
5188 WNM_SLEEP_ENTER,
5189 WNM_SLEEP_EXIT
5190 } sleep_action;
5191 int sleep_intval;
5192 u16 reason_code;
5193 u8 *buf;
5194 u16 buf_len;
5195 } wnm;
5196
5197 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005198 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
5199 *
5200 * During FT (IEEE 802.11r) authentication sequence, the driver is
5201 * expected to use this event to report received FT IEs (MDIE, FTIE,
5202 * RSN IE, TIE, possible resource request) to the supplicant. The FT
5203 * IEs for the next message will be delivered through the
5204 * struct wpa_driver_ops::update_ft_ies() callback.
5205 */
5206 struct ft_ies {
5207 const u8 *ies;
5208 size_t ies_len;
5209 int ft_action;
5210 u8 target_ap[ETH_ALEN];
5211 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
5212 const u8 *ric_ies;
5213 /** Length of ric_ies buffer in octets */
5214 size_t ric_ies_len;
5215 } ft_ies;
5216
5217 /**
5218 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
5219 */
5220 struct ibss_rsn_start {
5221 u8 peer[ETH_ALEN];
5222 } ibss_rsn_start;
5223
5224 /**
5225 * struct auth_info - Data for EVENT_AUTH events
5226 */
5227 struct auth_info {
5228 u8 peer[ETH_ALEN];
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005229 u8 bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005230 u16 auth_type;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005231 u16 auth_transaction;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005232 u16 status_code;
5233 const u8 *ies;
5234 size_t ies_len;
5235 } auth;
5236
5237 /**
5238 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
5239 */
5240 struct assoc_reject {
5241 /**
5242 * bssid - BSSID of the AP that rejected association
5243 */
5244 const u8 *bssid;
5245
5246 /**
5247 * resp_ies - (Re)Association Response IEs
5248 *
5249 * Optional association data from the driver. This data is not
5250 * required WPA, but may be useful for some protocols and as
5251 * such, should be reported if this is available to the driver
5252 * interface.
5253 *
5254 * This should start with the first IE (fixed fields before IEs
5255 * are not included).
5256 */
5257 const u8 *resp_ies;
5258
5259 /**
5260 * resp_ies_len - Length of resp_ies in bytes
5261 */
5262 size_t resp_ies_len;
5263
5264 /**
5265 * status_code - Status Code from (Re)association Response
5266 */
5267 u16 status_code;
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07005268
5269 /**
5270 * timed_out - Whether failure is due to timeout (etc.) rather
5271 * than explicit rejection response from the AP.
5272 */
5273 int timed_out;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08005274
5275 /**
5276 * timeout_reason - Reason for the timeout
5277 */
5278 const char *timeout_reason;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005279
5280 /**
5281 * fils_erp_next_seq_num - The next sequence number to use in
5282 * FILS ERP messages
5283 */
5284 u16 fils_erp_next_seq_num;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005285 } assoc_reject;
5286
5287 struct timeout_event {
5288 u8 addr[ETH_ALEN];
5289 } timeout_event;
5290
5291 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005292 * struct tx_status - Data for EVENT_TX_STATUS events
5293 */
5294 struct tx_status {
5295 u16 type;
5296 u16 stype;
5297 const u8 *dst;
5298 const u8 *data;
5299 size_t data_len;
5300 int ack;
5301 } tx_status;
5302
5303 /**
5304 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
5305 */
5306 struct rx_from_unknown {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005307 const u8 *bssid;
5308 const u8 *addr;
5309 int wds;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005310 } rx_from_unknown;
5311
5312 /**
5313 * struct rx_mgmt - Data for EVENT_RX_MGMT events
5314 */
5315 struct rx_mgmt {
5316 const u8 *frame;
5317 size_t frame_len;
5318 u32 datarate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005319
5320 /**
Dmitry Shmidt98660862014-03-11 17:26:21 -07005321 * drv_priv - Pointer to store driver private BSS information
5322 *
5323 * If not set to NULL, this is used for comparison with
5324 * hostapd_data->drv_priv to determine which BSS should process
5325 * the frame.
5326 */
5327 void *drv_priv;
5328
5329 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005330 * freq - Frequency (in MHz) on which the frame was received
5331 */
5332 int freq;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005333
5334 /**
5335 * ssi_signal - Signal strength in dBm (or 0 if not available)
5336 */
5337 int ssi_signal;
5338 } rx_mgmt;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005339
5340 /**
5341 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
5342 *
5343 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
5344 */
5345 struct remain_on_channel {
5346 /**
5347 * freq - Channel frequency in MHz
5348 */
5349 unsigned int freq;
5350
5351 /**
5352 * duration - Duration to remain on the channel in milliseconds
5353 */
5354 unsigned int duration;
5355 } remain_on_channel;
5356
5357 /**
5358 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
5359 * @aborted: Whether the scan was aborted
5360 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
5361 * @num_freqs: Number of entries in freqs array
5362 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
5363 * SSID)
5364 * @num_ssids: Number of entries in ssids array
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08005365 * @external_scan: Whether the scan info is for an external scan
5366 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
5367 * 0 if the source of the scan event is a vendor scan
Dmitry Shmidt29333592017-01-09 12:27:11 -08005368 * @scan_start_tsf: Time when the scan started in terms of TSF of the
5369 * BSS that the interface that requested the scan is connected to
5370 * (if available).
5371 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
5372 * is set.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005373 */
5374 struct scan_info {
5375 int aborted;
5376 const int *freqs;
5377 size_t num_freqs;
5378 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
5379 size_t num_ssids;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08005380 int external_scan;
5381 int nl_scan_event;
Dmitry Shmidt29333592017-01-09 12:27:11 -08005382 u64 scan_start_tsf;
5383 u8 scan_start_tsf_bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005384 } scan_info;
5385
5386 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005387 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
5388 */
5389 struct rx_probe_req {
5390 /**
5391 * sa - Source address of the received Probe Request frame
5392 */
5393 const u8 *sa;
5394
5395 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005396 * da - Destination address of the received Probe Request frame
5397 * or %NULL if not available
5398 */
5399 const u8 *da;
5400
5401 /**
5402 * bssid - BSSID of the received Probe Request frame or %NULL
5403 * if not available
5404 */
5405 const u8 *bssid;
5406
5407 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005408 * ie - IEs from the Probe Request body
5409 */
5410 const u8 *ie;
5411
5412 /**
5413 * ie_len - Length of ie buffer in octets
5414 */
5415 size_t ie_len;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005416
5417 /**
5418 * signal - signal strength in dBm (or 0 if not available)
5419 */
5420 int ssi_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005421 } rx_probe_req;
5422
5423 /**
5424 * struct new_sta - Data for EVENT_NEW_STA events
5425 */
5426 struct new_sta {
5427 const u8 *addr;
5428 } new_sta;
5429
5430 /**
5431 * struct eapol_rx - Data for EVENT_EAPOL_RX events
5432 */
5433 struct eapol_rx {
5434 const u8 *src;
5435 const u8 *data;
5436 size_t data_len;
5437 } eapol_rx;
5438
5439 /**
5440 * signal_change - Data for EVENT_SIGNAL_CHANGE events
5441 */
5442 struct wpa_signal_info signal_change;
5443
5444 /**
5445 * struct best_channel - Data for EVENT_BEST_CHANNEL events
5446 * @freq_24: Best 2.4 GHz band channel frequency in MHz
5447 * @freq_5: Best 5 GHz band channel frequency in MHz
5448 * @freq_overall: Best channel frequency in MHz
5449 *
5450 * 0 can be used to indicate no preference in either band.
5451 */
5452 struct best_channel {
5453 int freq_24;
5454 int freq_5;
5455 int freq_overall;
5456 } best_chan;
5457
5458 struct unprot_deauth {
5459 const u8 *sa;
5460 const u8 *da;
5461 u16 reason_code;
5462 } unprot_deauth;
5463
5464 struct unprot_disassoc {
5465 const u8 *sa;
5466 const u8 *da;
5467 u16 reason_code;
5468 } unprot_disassoc;
5469
5470 /**
5471 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
5472 * @addr: station address
Paul Stewart092955c2017-02-06 09:13:09 -08005473 * @num_packets: Number of packets lost (consecutive packets not
5474 * acknowledged)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005475 */
5476 struct low_ack {
5477 u8 addr[ETH_ALEN];
Paul Stewart092955c2017-02-06 09:13:09 -08005478 u32 num_packets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005479 } low_ack;
5480
5481 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005482 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
5483 */
5484 struct ibss_peer_lost {
5485 u8 peer[ETH_ALEN];
5486 } ibss_peer_lost;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005487
5488 /**
5489 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
5490 */
5491 struct driver_gtk_rekey {
5492 const u8 *bssid;
5493 const u8 *replay_ctr;
5494 } driver_gtk_rekey;
5495
5496 /**
5497 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
5498 * @addr: station address
5499 */
5500 struct client_poll {
5501 u8 addr[ETH_ALEN];
5502 } client_poll;
5503
5504 /**
5505 * struct eapol_tx_status
5506 * @dst: Original destination
5507 * @data: Data starting with IEEE 802.1X header (!)
5508 * @data_len: Length of data
5509 * @ack: Indicates ack or lost frame
5510 *
5511 * This corresponds to hapd_send_eapol if the frame sent
5512 * there isn't just reported as EVENT_TX_STATUS.
5513 */
5514 struct eapol_tx_status {
5515 const u8 *dst;
5516 const u8 *data;
5517 int data_len;
5518 int ack;
5519 } eapol_tx_status;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005520
5521 /**
5522 * struct ch_switch
5523 * @freq: Frequency of new channel in MHz
5524 * @ht_enabled: Whether this is an HT channel
5525 * @ch_offset: Secondary channel offset
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08005526 * @ch_width: Channel width
5527 * @cf1: Center frequency 1
5528 * @cf2: Center frequency 2
Dmitry Shmidt04949592012-07-19 12:16:46 -07005529 */
5530 struct ch_switch {
5531 int freq;
5532 int ht_enabled;
5533 int ch_offset;
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08005534 enum chan_width ch_width;
5535 int cf1;
5536 int cf2;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005537 } ch_switch;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08005538
5539 /**
5540 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
5541 * @addr: Remote client address
5542 * @code: Reason code for connection failure
5543 */
5544 struct connect_failed_reason {
5545 u8 addr[ETH_ALEN];
5546 enum {
5547 MAX_CLIENT_REACHED,
5548 BLOCKED_CLIENT
5549 } code;
5550 } connect_failed_reason;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005551
5552 /**
5553 * struct dfs_event - Data for radar detected events
5554 * @freq: Frequency of the channel in MHz
5555 */
5556 struct dfs_event {
5557 int freq;
Dmitry Shmidt051af732013-10-22 13:52:46 -07005558 int ht_enabled;
5559 int chan_offset;
5560 enum chan_width chan_width;
5561 int cf1;
5562 int cf2;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005563 } dfs_event;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005564
5565 /**
5566 * survey_results - Survey result data for EVENT_SURVEY
5567 * @freq_filter: Requested frequency survey filter, 0 if request
5568 * was for all survey data
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005569 * @survey_list: Linked list of survey data (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005570 */
5571 struct survey_results {
5572 unsigned int freq_filter;
5573 struct dl_list survey_list; /* struct freq_survey */
5574 } survey_results;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005575
5576 /**
5577 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
5578 * @initiator: Initiator of the regulatory change
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07005579 * @type: Regulatory change type
5580 * @alpha2: Country code (or "" if not available)
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005581 */
5582 struct channel_list_changed {
5583 enum reg_change_initiator initiator;
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07005584 enum reg_type type;
5585 char alpha2[3];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005586 } channel_list_changed;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08005587
5588 /**
5589 * freq_range - List of frequency ranges
5590 *
5591 * This is used as the data with EVENT_AVOID_FREQUENCIES.
5592 */
5593 struct wpa_freq_range_list freq_range;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005594
5595 /**
5596 * struct mesh_peer
5597 *
5598 * @peer: Peer address
5599 * @ies: Beacon IEs
5600 * @ie_len: Length of @ies
5601 *
5602 * Notification of new candidate mesh peer.
5603 */
5604 struct mesh_peer {
5605 const u8 *peer;
5606 const u8 *ies;
5607 size_t ie_len;
5608 } mesh_peer;
5609
5610 /**
5611 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
5612 * @pri_channel: Selected primary channel
5613 * @sec_channel: Selected secondary channel
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005614 * @vht_seg0_center_ch: VHT mode Segment0 center channel
5615 * @vht_seg1_center_ch: VHT mode Segment1 center channel
5616 * @ch_width: Selected Channel width by driver. Driver may choose to
5617 * change hostapd configured ACS channel width due driver internal
5618 * channel restrictions.
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07005619 * hw_mode: Selected band (used with hw_mode=any)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005620 */
5621 struct acs_selected_channels {
5622 u8 pri_channel;
5623 u8 sec_channel;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005624 u8 vht_seg0_center_ch;
5625 u8 vht_seg1_center_ch;
5626 u16 ch_width;
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07005627 enum hostapd_hw_mode hw_mode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005628 } acs_selected_channels;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005629
5630 /**
5631 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
5632 * @reason_code: Reason for stopping offload
5633 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
5634 * scheduled.
5635 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
5636 * be stopped.
5637 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
5638 * parameters.
5639 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
5640 * supported by device.
5641 */
5642 struct p2p_lo_stop {
5643 enum {
5644 P2P_LO_STOPPED_REASON_COMPLETE = 0,
5645 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
5646 P2P_LO_STOPPED_REASON_INVALID_PARAM,
5647 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
5648 } reason_code;
5649 } p2p_lo_stop;
Roshan Pius3a1667e2018-07-03 15:17:14 -07005650
5651 /* For EVENT_EXTERNAL_AUTH */
5652 struct external_auth external_auth;
5653
5654 /**
5655 * struct sta_opmode - Station's operation mode change event
5656 * @addr: The station MAC address
5657 * @smps_mode: SMPS mode of the station
5658 * @chan_width: Channel width of the station
5659 * @rx_nss: RX_NSS of the station
5660 *
5661 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
5662 */
5663 struct sta_opmode {
5664 const u8 *addr;
5665 enum smps_mode smps_mode;
5666 enum chan_width chan_width;
5667 u8 rx_nss;
5668 } sta_opmode;
5669
5670 /**
5671 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
5672 */
5673 struct wds_sta_interface {
5674 const u8 *sta_addr;
5675 const char *ifname;
5676 enum {
5677 INTERFACE_ADDED,
5678 INTERFACE_REMOVED
5679 } istatus;
5680 } wds_sta_interface;
Hai Shalom81f62d82019-07-22 12:10:00 -07005681
5682 /**
5683 * struct update_dh - Data for EVENT_UPDATE_DH
5684 */
5685 struct update_dh {
5686 const u8 *peer;
5687 const u8 *ie;
5688 size_t ie_len;
5689 } update_dh;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005690};
5691
5692/**
5693 * wpa_supplicant_event - Report a driver event for wpa_supplicant
5694 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5695 * with struct wpa_driver_ops::init()
5696 * @event: event type (defined above)
5697 * @data: possible extra data for the event
5698 *
5699 * Driver wrapper code should call this function whenever an event is received
5700 * from the driver.
5701 */
5702void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
5703 union wpa_event_data *data);
5704
Dmitry Shmidte4663042016-04-04 10:07:49 -07005705/**
5706 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
5707 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5708 * with struct wpa_driver_ops::init()
5709 * @event: event type (defined above)
5710 * @data: possible extra data for the event
5711 *
5712 * Same as wpa_supplicant_event(), but we search for the interface in
5713 * wpa_global.
5714 */
5715void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
5716 union wpa_event_data *data);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005717
5718/*
5719 * The following inline functions are provided for convenience to simplify
5720 * event indication for some of the common events.
5721 */
5722
5723static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
5724 size_t ielen, int reassoc)
5725{
5726 union wpa_event_data event;
5727 os_memset(&event, 0, sizeof(event));
5728 event.assoc_info.reassoc = reassoc;
5729 event.assoc_info.req_ies = ie;
5730 event.assoc_info.req_ies_len = ielen;
5731 event.assoc_info.addr = addr;
5732 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
5733}
5734
5735static inline void drv_event_disassoc(void *ctx, const u8 *addr)
5736{
5737 union wpa_event_data event;
5738 os_memset(&event, 0, sizeof(event));
5739 event.disassoc_info.addr = addr;
5740 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
5741}
5742
5743static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
5744 size_t data_len)
5745{
5746 union wpa_event_data event;
5747 os_memset(&event, 0, sizeof(event));
5748 event.eapol_rx.src = src;
5749 event.eapol_rx.data = data;
5750 event.eapol_rx.data_len = data_len;
5751 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
5752}
5753
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005754/* driver_common.c */
5755void wpa_scan_results_free(struct wpa_scan_results *res);
5756
5757/* Convert wpa_event_type to a string for logging */
5758const char * event_to_string(enum wpa_event_type event);
5759
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07005760/* Convert chan_width to a string for logging and control interfaces */
5761const char * channel_width_to_string(enum chan_width width);
5762
Hai Shalom74f70d42019-02-11 14:42:39 -08005763int channel_width_to_int(enum chan_width width);
5764
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005765int ht_supported(const struct hostapd_hw_modes *mode);
5766int vht_supported(const struct hostapd_hw_modes *mode);
5767
5768struct wowlan_triggers *
5769wpa_get_wowlan_triggers(const char *wowlan_triggers,
5770 const struct wpa_driver_capa *capa);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005771/* Convert driver flag to string */
5772const char * driver_flag_to_string(u64 flag);
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005773
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005774/* NULL terminated array of linked in driver wrappers */
Dmitry Shmidt1d755d02015-04-28 10:34:29 -07005775extern const struct wpa_driver_ops *const wpa_drivers[];
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005776
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07005777
5778/* Available drivers */
5779
5780#ifdef CONFIG_DRIVER_WEXT
5781extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
5782#endif /* CONFIG_DRIVER_WEXT */
5783#ifdef CONFIG_DRIVER_NL80211
5784/* driver_nl80211.c */
5785extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
5786#endif /* CONFIG_DRIVER_NL80211 */
5787#ifdef CONFIG_DRIVER_HOSTAP
5788extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
5789#endif /* CONFIG_DRIVER_HOSTAP */
5790#ifdef CONFIG_DRIVER_BSD
5791extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
5792#endif /* CONFIG_DRIVER_BSD */
5793#ifdef CONFIG_DRIVER_OPENBSD
5794/* driver_openbsd.c */
5795extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
5796#endif /* CONFIG_DRIVER_OPENBSD */
5797#ifdef CONFIG_DRIVER_NDIS
5798extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
5799#endif /* CONFIG_DRIVER_NDIS */
5800#ifdef CONFIG_DRIVER_WIRED
5801extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
5802#endif /* CONFIG_DRIVER_WIRED */
5803#ifdef CONFIG_DRIVER_MACSEC_QCA
5804/* driver_macsec_qca.c */
5805extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
5806#endif /* CONFIG_DRIVER_MACSEC_QCA */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08005807#ifdef CONFIG_DRIVER_MACSEC_LINUX
5808/* driver_macsec_linux.c */
5809extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops;
5810#endif /* CONFIG_DRIVER_MACSEC_LINUX */
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07005811#ifdef CONFIG_DRIVER_ROBOSWITCH
5812/* driver_roboswitch.c */
5813extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
5814#endif /* CONFIG_DRIVER_ROBOSWITCH */
5815#ifdef CONFIG_DRIVER_ATHEROS
5816/* driver_atheros.c */
5817extern const struct wpa_driver_ops wpa_driver_atheros_ops;
5818#endif /* CONFIG_DRIVER_ATHEROS */
5819#ifdef CONFIG_DRIVER_NONE
5820extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
5821#endif /* CONFIG_DRIVER_NONE */
5822
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005823#endif /* DRIVER_H */