]> git.ipfire.org Git - thirdparty/hostap.git/blame - src/drivers/driver.h
nl80211: Fetch STA TX/RX duration statistics
[thirdparty/hostap.git] / src / drivers / driver.h
CommitLineData
6fc6879b 1/*
e0498677 2 * Driver interface definition
68855672 3 * Copyright (c) 2003-2017, Jouni Malinen <j@w1.fi>
6fc6879b 4 *
0f3d578e
JM
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
e0498677
JM
7 *
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.
6fc6879b
JM
15 */
16
17#ifndef DRIVER_H
18#define DRIVER_H
19
642187d6 20#define WPA_SUPPLICANT_DRIVER_VERSION 4
6fc6879b 21
90973fb2 22#include "common/defs.h"
d9d1b952 23#include "common/ieee802_11_defs.h"
f46c154c 24#include "common/wpa_common.h"
f75f6e2b
SD
25#ifdef CONFIG_MACSEC
26#include "pae/ieee802_1x_kay.h"
27#endif /* CONFIG_MACSEC */
0185007c 28#include "utils/list.h"
6fc6879b 29
c5121837 30#define HOSTAPD_CHAN_DISABLED 0x00000001
0a443580 31#define HOSTAPD_CHAN_NO_IR 0x00000002
c5121837 32#define HOSTAPD_CHAN_RADAR 0x00000008
d8e66e80
JM
33#define HOSTAPD_CHAN_HT40PLUS 0x00000010
34#define HOSTAPD_CHAN_HT40MINUS 0x00000020
35#define HOSTAPD_CHAN_HT40 0x00000040
50f4f2a0 36#define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
c5121837 37
fc96522e
SW
38#define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
39#define HOSTAPD_CHAN_DFS_USABLE 0x00000100
40#define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
41#define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
42#define HOSTAPD_CHAN_DFS_MASK 0x00000300
43
53cfad46
EP
44#define HOSTAPD_CHAN_VHT_10_70 0x00000800
45#define HOSTAPD_CHAN_VHT_30_50 0x00001000
46#define HOSTAPD_CHAN_VHT_50_30 0x00002000
47#define HOSTAPD_CHAN_VHT_70_10 0x00004000
48
ea6bf29e
IP
49#define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
50#define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
51
bee5d8e0
AK
52#define HOSTAPD_CHAN_VHT_10_150 0x00100000
53#define HOSTAPD_CHAN_VHT_30_130 0x00200000
54#define HOSTAPD_CHAN_VHT_50_110 0x00400000
55#define HOSTAPD_CHAN_VHT_70_90 0x00800000
56#define HOSTAPD_CHAN_VHT_90_70 0x01000000
57#define HOSTAPD_CHAN_VHT_110_50 0x02000000
58#define HOSTAPD_CHAN_VHT_130_30 0x04000000
59#define HOSTAPD_CHAN_VHT_150_10 0x08000000
60
4299ad82
DL
61/* 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
e42adb9a
MG
71/* Filter gratuitous ARP */
72#define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
73/* Filter unsolicited Neighbor Advertisement */
74#define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
75/* Filter unicast IP packets encrypted using the GTK */
76#define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)
77
aa56e36d
VT
78#define HOSTAPD_DFS_REGION_FCC 1
79#define HOSTAPD_DFS_REGION_ETSI 2
80#define HOSTAPD_DFS_REGION_JP 3
81
4e8f31e2
JM
82/**
83 * enum reg_change_initiator - Regulatory change initiator
84 */
795baf77
AS
85enum reg_change_initiator {
86 REGDOM_SET_BY_CORE,
87 REGDOM_SET_BY_USER,
88 REGDOM_SET_BY_DRIVER,
89 REGDOM_SET_BY_COUNTRY_IE,
8597ebdb 90 REGDOM_BEACON_HINT,
795baf77
AS
91};
92
4e8f31e2
JM
93/**
94 * enum reg_type - Regulatory change types
95 */
142817b2
JM
96enum 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
e0498677
JM
104/**
105 * struct hostapd_channel_data - Channel information
106 */
c5121837 107struct hostapd_channel_data {
e0498677
JM
108 /**
109 * chan - Channel number (IEEE 802.11)
110 */
111 short chan;
112
113 /**
114 * freq - Frequency in MHz
115 */
c0976528 116 int freq;
e0498677
JM
117
118 /**
119 * flag - Channel flags (HOSTAPD_CHAN_*)
120 */
121 int flag;
122
4299ad82
DL
123 /**
124 * allowed_bw - Allowed channel width bitmask
125 *
126 * See enum hostapd_chan_width_attr.
127 */
128 u32 allowed_bw;
129
e0498677 130 /**
6651f1f9 131 * max_tx_power - Regulatory transmit power limit in dBm
e0498677
JM
132 */
133 u8 max_tx_power;
0185007c 134
4e8f31e2
JM
135 /**
136 * survey_list - Linked list of surveys (struct freq_survey)
0185007c
MK
137 */
138 struct dl_list survey_list;
139
140 /**
141 * min_nf - Minimum observed noise floor, in dBm, based on all
142 * surveyed channel data
143 */
144 s8 min_nf;
50f4f2a0
MK
145
146#ifdef CONFIG_ACS
147 /**
148 * interference_factor - Computed interference factor on this
149 * channel (used internally in src/ap/acs.c; driver wrappers do not
150 * need to set this)
151 */
152 long double interference_factor;
153#endif /* CONFIG_ACS */
bbbacbf2 154
4e8f31e2
JM
155 /**
156 * dfs_cac_ms - DFS CAC time in milliseconds
157 */
bbbacbf2 158 unsigned int dfs_cac_ms;
c5121837
JM
159};
160
94380cb4 161#define HE_MAX_NUM_SS 8
5b3940d0
JC
162#define HE_MAX_MAC_CAPAB_SIZE 6
163#define HE_MAX_PHY_CAPAB_SIZE 11
164#define HE_MAX_MCS_CAPAB_SIZE 12
94380cb4
PX
165
166/**
167 * struct he_ppe_threshold - IEEE 802.11ax HE PPE Threshold
168 */
169struct he_ppe_threshold {
170 u32 numss_m1;
171 u32 ru_count;
172 u32 ppet16_ppet8_ru3_ru0[HE_MAX_NUM_SS];
173};
174
175/**
176 * struct he_capabilities - IEEE 802.11ax HE capabilities
177 */
178struct he_capabilities {
179 u8 he_supported;
5b3940d0
JC
180 u8 phy_cap[HE_MAX_PHY_CAPAB_SIZE];
181 u8 mac_cap[HE_MAX_MAC_CAPAB_SIZE];
182 u8 mcs[HE_MAX_MCS_CAPAB_SIZE];
94380cb4
PX
183 struct he_ppe_threshold ppet;
184};
185
e3b473eb 186#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
c8ebeda4 187#define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
e3b473eb 188
e0498677
JM
189/**
190 * struct hostapd_hw_modes - Supported hardware mode information
191 */
c5121837 192struct hostapd_hw_modes {
e0498677
JM
193 /**
194 * mode - Hardware mode
195 */
71934751 196 enum hostapd_hw_mode mode;
e0498677
JM
197
198 /**
199 * num_channels - Number of entries in the channels array
200 */
c5121837 201 int num_channels;
e0498677
JM
202
203 /**
204 * channels - Array of supported channels
205 */
c5121837 206 struct hostapd_channel_data *channels;
e0498677
JM
207
208 /**
209 * num_rates - Number of entries in the rates array
210 */
c5121837 211 int num_rates;
e0498677
JM
212
213 /**
214 * rates - Array of supported rates in 100 kbps units
215 */
216 int *rates;
217
218 /**
219 * ht_capab - HT (IEEE 802.11n) capabilities
220 */
c5121837 221 u16 ht_capab;
e0498677
JM
222
223 /**
224 * mcs_set - MCS (IEEE 802.11n) rate parameters
225 */
08eb154d 226 u8 mcs_set[16];
e0498677
JM
227
228 /**
229 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
230 */
be8eb8ab 231 u8 a_mpdu_params;
e3b473eb 232
efe45d14
MP
233 /**
234 * vht_capab - VHT (IEEE 802.11ac) capabilities
235 */
236 u32 vht_capab;
237
238 /**
239 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
240 */
241 u8 vht_mcs_set[8];
242
e3b473eb 243 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
94380cb4
PX
244
245 /**
246 * he_capab - HE (IEEE 802.11ax) capabilities
247 */
248 struct he_capabilities he_capab;
c5121837
JM
249};
250
251
6fc6879b
JM
252#define IEEE80211_MODE_INFRA 0
253#define IEEE80211_MODE_IBSS 1
ad1e68e6 254#define IEEE80211_MODE_AP 2
476e6bb6 255#define IEEE80211_MODE_MESH 5
6fc6879b
JM
256
257#define IEEE80211_CAP_ESS 0x0001
258#define IEEE80211_CAP_IBSS 0x0002
259#define IEEE80211_CAP_PRIVACY 0x0010
0dc957b9 260#define IEEE80211_CAP_RRM 0x1000
6fc6879b 261
ff3ad3c5
VK
262/* DMG (60 GHz) IEEE 802.11ad */
263/* type - bits 0..1 */
264#define IEEE80211_CAP_DMG_MASK 0x0003
265#define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
266#define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
267#define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
268
7c2849d2
JM
269#define WPA_SCAN_QUAL_INVALID BIT(0)
270#define WPA_SCAN_NOISE_INVALID BIT(1)
271#define WPA_SCAN_LEVEL_INVALID BIT(2)
272#define WPA_SCAN_LEVEL_DBM BIT(3)
e6b8efeb 273#define WPA_SCAN_ASSOCIATED BIT(5)
7c2849d2 274
6fc6879b
JM
275/**
276 * struct wpa_scan_res - Scan result for an BSS/IBSS
7c2849d2 277 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
6fc6879b
JM
278 * @bssid: BSSID
279 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
280 * @beacon_int: beacon interval in TUs (host byte order)
281 * @caps: capability information field in host byte order
282 * @qual: signal quality
283 * @noise: noise level
284 * @level: signal level
285 * @tsf: Timestamp
b3ad11bb
JM
286 * @age: Age of the information in milliseconds (i.e., how many milliseconds
287 * ago the last Beacon or Probe Response frame was received)
a1b790eb
JM
288 * @est_throughput: Estimated throughput in kbps (this is calculated during
289 * scan result processing if left zero by the driver wrapper)
290 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
c16b9f8d
AS
291 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
292 * of TSF of the BSS specified by %tsf_bssid.
293 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
6fc6879b 294 * @ie_len: length of the following IE field in octets
8c090654 295 * @beacon_ie_len: length of the following Beacon IE field in octets
6fc6879b
JM
296 *
297 * This structure is used as a generic format for scan results from the
298 * driver. Each driver interface implementation is responsible for converting
299 * the driver or OS specific scan results into this format.
300 *
301 * If the driver does not support reporting all IEs, the IE data structure is
302 * constructed of the IEs that are available. This field will also need to
303 * include SSID in IE format. All drivers are encouraged to be extended to
304 * report all IEs to make it easier to support future additions.
4e8f31e2
JM
305 *
306 * This structure data is followed by ie_len octets of IEs from Probe Response
307 * frame (or if the driver does not indicate source of IEs, these may also be
308 * from Beacon frame). After the first set of IEs, another set of IEs may follow
309 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
6fc6879b
JM
310 */
311struct wpa_scan_res {
7c2849d2 312 unsigned int flags;
6fc6879b
JM
313 u8 bssid[ETH_ALEN];
314 int freq;
315 u16 beacon_int;
316 u16 caps;
317 int qual;
318 int noise;
319 int level;
320 u64 tsf;
b3ad11bb 321 unsigned int age;
a1b790eb
JM
322 unsigned int est_throughput;
323 int snr;
c16b9f8d
AS
324 u64 parent_tsf;
325 u8 tsf_bssid[ETH_ALEN];
6fc6879b 326 size_t ie_len;
8c090654 327 size_t beacon_ie_len;
4e8f31e2 328 /* Followed by ie_len + beacon_ie_len octets of IE data */
6fc6879b
JM
329};
330
331/**
332 * struct wpa_scan_results - Scan results
333 * @res: Array of pointers to allocated variable length scan result entries
334 * @num: Number of entries in the scan result array
c5f10e80 335 * @fetch_time: Time when the results were fetched from the driver
6fc6879b
JM
336 */
337struct wpa_scan_results {
338 struct wpa_scan_res **res;
339 size_t num;
acb69cec 340 struct os_reltime fetch_time;
6fc6879b
JM
341};
342
4b4a8ae5
JM
343/**
344 * struct wpa_interface_info - Network interface information
345 * @next: Pointer to the next interface or NULL if this is the last one
346 * @ifname: Interface name that can be used with init() or init2()
347 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
348 * not available
60ad2c7b 349 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
4b4a8ae5
JM
350 * is not an allocated copy, i.e., get_interfaces() caller will not free
351 * this)
352 */
353struct wpa_interface_info {
354 struct wpa_interface_info *next;
355 char *ifname;
356 char *desc;
357 const char *drv_name;
358};
359
35b741fd 360#define WPAS_MAX_SCAN_SSIDS 16
fc2b7ed5 361
0ae86f90
RP
362/**
363 * struct wpa_driver_scan_ssid - SSIDs to scan for
364 * @ssid - specific SSID to scan for (ProbeReq)
365 * %NULL or zero-length SSID is used to indicate active scan
366 * with wildcard SSID.
367 * @ssid_len - Length of the SSID in octets
368 */
369struct wpa_driver_scan_ssid {
370 const u8 *ssid;
371 size_t ssid_len;
372};
373
fc2b7ed5
JM
374/**
375 * struct wpa_driver_scan_params - Scan parameters
376 * Data for struct wpa_driver_ops::scan2().
377 */
378struct wpa_driver_scan_params {
379 /**
380 * ssids - SSIDs to scan for
381 */
0ae86f90 382 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
fc2b7ed5
JM
383
384 /**
385 * num_ssids - Number of entries in ssids array
386 * Zero indicates a request for a passive scan.
387 */
388 size_t num_ssids;
389
390 /**
391 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
392 */
393 const u8 *extra_ies;
394
395 /**
396 * extra_ies_len - Length of extra_ies in octets
397 */
398 size_t extra_ies_len;
d3a98225
JM
399
400 /**
401 * freqs - Array of frequencies to scan or %NULL for all frequencies
402 *
403 * The frequency is set in MHz. The array is zero-terminated.
404 */
405 int *freqs;
3812464c
JM
406
407 /**
408 * filter_ssids - Filter for reporting SSIDs
409 *
410 * This optional parameter can be used to request the driver wrapper to
411 * filter scan results to include only the specified SSIDs. %NULL
412 * indicates that no filtering is to be done. This can be used to
413 * reduce memory needs for scan results in environments that have large
414 * number of APs with different SSIDs.
415 *
416 * The driver wrapper is allowed to take this allocated buffer into its
417 * own use by setting the pointer to %NULL. In that case, the driver
418 * wrapper is responsible for freeing the buffer with os_free() once it
419 * is not needed anymore.
420 */
421 struct wpa_driver_scan_filter {
d9d1b952 422 u8 ssid[SSID_MAX_LEN];
3812464c
JM
423 size_t ssid_len;
424 } *filter_ssids;
425
426 /**
427 * num_filter_ssids - Number of entries in filter_ssids array
428 */
429 size_t num_filter_ssids;
47185fc7 430
bf8d6d24
TP
431 /**
432 * filter_rssi - Filter by RSSI
433 *
434 * The driver may filter scan results in firmware to reduce host
435 * wakeups and thereby save power. Specify the RSSI threshold in s32
436 * dBm.
437 */
438 s32 filter_rssi;
439
47185fc7
RM
440 /**
441 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
442 *
443 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
444 * Mbps from the support rates element(s) in the Probe Request frames
445 * and not to transmit the frames at any of those rates.
446 */
57a8f8af 447 unsigned int p2p_probe:1;
949938aa
JM
448
449 /**
450 * only_new_results - Request driver to report only new results
451 *
452 * This is used to request the driver to report only BSSes that have
453 * been detected after this scan request has been started, i.e., to
454 * flush old cached BSS entries.
455 */
57a8f8af
JB
456 unsigned int only_new_results:1;
457
458 /**
459 * low_priority - Requests driver to use a lower scan priority
460 *
461 * This is used to request the driver to use a lower scan priority
462 * if it supports such a thing.
463 */
464 unsigned int low_priority:1;
dd43aaa5 465
ff23ed22
IP
466 /**
467 * mac_addr_rand - Requests driver to randomize MAC address
468 */
469 unsigned int mac_addr_rand:1;
470
471 /**
472 * mac_addr - MAC address used with randomization. The address cannot be
473 * a multicast one, i.e., bit 0 of byte 0 should not be set.
474 */
475 const u8 *mac_addr;
476
477 /**
478 * mac_addr_mask - MAC address mask used with randomization.
479 *
480 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
481 * the mask should be taken as is from mac_addr. The mask should not
482 * allow the generation of a multicast address, i.e., bit 0 of byte 0
483 * must be set.
484 */
485 const u8 *mac_addr_mask;
486
09ea4309
AS
487 /**
488 * sched_scan_plans - Scan plans for scheduled scan
489 *
490 * Each scan plan consists of the number of iterations to scan and the
491 * interval between scans. When a scan plan finishes (i.e., it was run
492 * for the specified number of iterations), the next scan plan is
493 * executed. The scan plans are executed in the order they appear in
494 * the array (lower index first). The last scan plan will run infinitely
495 * (until requested to stop), thus must not specify the number of
496 * iterations. All other scan plans must specify the number of
497 * iterations.
498 */
499 struct sched_scan_plan {
500 u32 interval; /* In seconds */
501 u32 iterations; /* Zero to run infinitely */
502 } *sched_scan_plans;
503
504 /**
505 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
506 */
507 unsigned int sched_scan_plans_num;
508
d0330d57
PK
509 /**
510 * sched_scan_start_delay - Delay to use before starting the first scan
511 *
512 * Delay (in seconds) before scheduling first scan plan cycle. The
513 * driver may ignore this parameter and start immediately (or at any
514 * other time), if this feature is not supported.
515 */
516 u32 sched_scan_start_delay;
517
eb20cea5
JM
518 /**
519 * bssid - Specific BSSID to scan for
520 *
521 * This optional parameter can be used to replace the default wildcard
522 * BSSID with a specific BSSID to scan for if results are needed from
523 * only a single BSS.
524 */
525 const u8 *bssid;
526
eeb34a43
SD
527 /**
528 * scan_cookie - Unique identification representing the scan request
529 *
530 * This scan_cookie carries a unique identification representing the
531 * scan request if the host driver/kernel supports concurrent scan
532 * requests. This cookie is returned from the corresponding driver
533 * interface.
534 *
535 * Note: Unlike other parameters in this structure, scan_cookie is used
536 * only to return information instead of setting parameters for the
537 * scan.
538 */
539 u64 scan_cookie;
540
c16b9f8d
AS
541 /**
542 * duration - Dwell time on each channel
543 *
544 * This optional parameter can be used to set the dwell time on each
545 * channel. In TUs.
546 */
547 u16 duration;
548
549 /**
550 * duration_mandatory - Whether the specified duration is mandatory
551 *
552 * If this is set, the duration specified by the %duration field is
553 * mandatory (and the driver should reject the scan request if it is
554 * unable to comply with the specified duration), otherwise it is the
555 * maximum duration and the actual duration may be shorter.
556 */
557 unsigned int duration_mandatory:1;
558
20c846d9 559 /**
560 * relative_rssi_set - Whether relative RSSI parameters are set
561 */
562 unsigned int relative_rssi_set:1;
563
564 /**
565 * relative_rssi - Relative RSSI for reporting better BSSs
566 *
567 * Amount of RSSI by which a BSS should be better than the current
568 * connected BSS to report the new BSS to user space.
569 */
570 s8 relative_rssi;
571
572 /**
573 * relative_adjust_band - Band to which RSSI should be adjusted
574 *
575 * The relative_adjust_rssi should be added to the band specified
576 * by relative_adjust_band.
577 */
578 enum set_band relative_adjust_band;
579
580 /**
581 * relative_adjust_rssi - RSSI to be added to relative_adjust_band
582 *
583 * An amount of relative_band_rssi should be added to the BSSs that
584 * belong to the band specified by relative_adjust_band while comparing
585 * with other bands for BSS reporting.
586 */
587 s8 relative_adjust_rssi;
588
938dd97a
RZ
589 /**
590 * oce_scan
591 *
592 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0)
593 * - Accept broadcast Probe Response frame.
594 * - Probe Request frame deferral and suppression.
595 * - Max Channel Time - driver fills FILS request params IE with
596 * Maximum Channel Time.
597 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps.
598 */
599 unsigned int oce_scan:1;
600
dd43aaa5
JM
601 /*
602 * NOTE: Whenever adding new parameters here, please make sure
603 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
604 * matching changes.
605 */
fc2b7ed5
JM
606};
607
c2a04078
JM
608/**
609 * struct wpa_driver_auth_params - Authentication parameters
610 * Data for struct wpa_driver_ops::authenticate().
611 */
612struct wpa_driver_auth_params {
613 int freq;
614 const u8 *bssid;
615 const u8 *ssid;
616 size_t ssid_len;
617 int auth_alg;
618 const u8 *ie;
619 size_t ie_len;
a0b2f99b
JM
620 const u8 *wep_key[4];
621 size_t wep_key_len[4];
622 int wep_tx_keyidx;
2a7e7f4e 623 int local_state_change;
2f4f73b1
EP
624
625 /**
626 * p2p - Whether this connection is a P2P group
627 */
628 int p2p;
629
4e8f31e2 630 /**
ce16c489 631 * auth_data - Additional elements for Authentication frame
4e8f31e2
JM
632 *
633 * This buffer starts with the Authentication transaction sequence
ce16c489
JM
634 * number field. If no special handling of such elements is needed, this
635 * pointer is %NULL. This is used with SAE and FILS.
4e8f31e2 636 */
ce16c489 637 const u8 *auth_data;
c10347f2 638
4e8f31e2 639 /**
ce16c489 640 * auth_data_len - Length of auth_data buffer in octets
4e8f31e2 641 */
ce16c489 642 size_t auth_data_len;
c2a04078
JM
643};
644
4e8f31e2
JM
645/**
646 * enum wps_mode - WPS mode
647 */
0c80427d 648enum wps_mode {
4e8f31e2
JM
649 /**
650 * WPS_MODE_NONE - No WPS provisioning being used
651 */
652 WPS_MODE_NONE,
653
654 /**
655 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
656 */
657 WPS_MODE_OPEN,
658
659 /**
660 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
661 */
662 WPS_MODE_PRIVACY
0c80427d
JM
663};
664
4e8f31e2
JM
665/**
666 * struct hostapd_freq_params - Channel parameters
667 */
4ec68377 668struct hostapd_freq_params {
4e8f31e2
JM
669 /**
670 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
671 */
672 enum hostapd_hw_mode mode;
673
674 /**
675 * freq - Primary channel center frequency in MHz
676 */
4ec68377 677 int freq;
4e8f31e2
JM
678
679 /**
680 * channel - Channel number
681 */
4ec68377 682 int channel;
4e8f31e2
JM
683
684 /**
685 * ht_enabled - Whether HT is enabled
686 */
4ec68377 687 int ht_enabled;
4ec68377 688
4e8f31e2
JM
689 /**
690 * sec_channel_offset - Secondary channel offset for HT40
691 *
692 * 0 = HT40 disabled,
693 * -1 = HT40 enabled, secondary channel below primary,
694 * 1 = HT40 enabled, secondary channel above primary
695 */
696 int sec_channel_offset;
697
698 /**
699 * vht_enabled - Whether VHT is enabled
700 */
4ec68377
JD
701 int vht_enabled;
702
4e8f31e2
JM
703 /**
704 * center_freq1 - Segment 0 center frequency in MHz
705 *
706 * Valid for both HT and VHT.
707 */
708 int center_freq1;
709
710 /**
711 * center_freq2 - Segment 1 center frequency in MHz
712 *
713 * Non-zero only for bandwidth 80 and an 80+80 channel
714 */
715 int center_freq2;
716
717 /**
718 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
719 */
4ec68377
JD
720 int bandwidth;
721};
722
6b128fb2
JM
723/**
724 * struct wpa_driver_sta_auth_params - Authentication parameters
725 * Data for struct wpa_driver_ops::sta_auth().
726 */
727struct wpa_driver_sta_auth_params {
728
729 /**
730 * own_addr - Source address and BSSID for authentication frame
731 */
732 const u8 *own_addr;
733
734 /**
735 * addr - MAC address of the station to associate
736 */
737 const u8 *addr;
738
739 /**
740 * seq - authentication sequence number
741 */
742 u16 seq;
743
744 /**
745 * status - authentication response status code
746 */
747 u16 status;
748
749 /**
750 * ie - authentication frame ie buffer
751 */
752 const u8 *ie;
753
754 /**
755 * len - ie buffer length
756 */
757 size_t len;
f46c154c
JM
758
759 /**
760 * fils_auth - Indicates whether FILS authentication is being performed
761 */
762 int fils_auth;
763
764 /**
765 * fils_anonce - ANonce (required for FILS)
766 */
767 u8 fils_anonce[WPA_NONCE_LEN];
768
769 /**
770 * fils_snonce - SNonce (required for FILS)
771 */
772 u8 fils_snonce[WPA_NONCE_LEN];
773
774 /**
775 * fils_kek - key for encryption (required for FILS)
776 */
777 u8 fils_kek[WPA_KEK_MAX_LEN];
778
779 /**
780 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
781 */
782 size_t fils_kek_len;
6b128fb2
JM
783};
784
6fc6879b
JM
785/**
786 * struct wpa_driver_associate_params - Association parameters
787 * Data for struct wpa_driver_ops::associate().
788 */
789struct wpa_driver_associate_params {
790 /**
791 * bssid - BSSID of the selected AP
792 * This can be %NULL, if ap_scan=2 mode is used and the driver is
793 * responsible for selecting with which BSS to associate. */
794 const u8 *bssid;
795
7ac7fd43
DS
796 /**
797 * bssid_hint - BSSID of a proposed AP
798 *
799 * This indicates which BSS has been found a suitable candidate for
800 * initial association for drivers that use driver/firmwate-based BSS
801 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
802 * the driver from selecting other BSSes in the ESS.
803 */
804 const u8 *bssid_hint;
805
6fc6879b
JM
806 /**
807 * ssid - The selected SSID
808 */
809 const u8 *ssid;
e0498677
JM
810
811 /**
812 * ssid_len - Length of the SSID (1..32)
813 */
6fc6879b
JM
814 size_t ssid_len;
815
816 /**
4ec68377 817 * freq - channel parameters
6fc6879b 818 */
4ec68377 819 struct hostapd_freq_params freq;
6fc6879b 820
7ac7fd43
DS
821 /**
822 * freq_hint - Frequency of the channel the proposed AP is using
823 *
824 * This provides a channel on which a suitable BSS has been found as a
825 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
826 * limit the driver from selecting other channels for
827 * driver/firmware-based BSS selection.
828 */
829 int freq_hint;
830
1f6c0ab8
BS
831 /**
832 * bg_scan_period - Background scan period in seconds, 0 to disable
833 * background scan, or -1 to indicate no change to default driver
834 * configuration
835 */
836 int bg_scan_period;
837
8f05577d
JM
838 /**
839 * beacon_int - Beacon interval for IBSS or 0 to use driver default
840 */
841 int beacon_int;
842
6fc6879b
JM
843 /**
844 * wpa_ie - WPA information element for (Re)Association Request
845 * WPA information element to be included in (Re)Association
846 * Request (including information element id and length). Use
847 * of this WPA IE is optional. If the driver generates the WPA
61a56c14 848 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
6fc6879b
JM
849 * key_mgmt_suite to select proper algorithms. In this case,
850 * the driver has to notify wpa_supplicant about the used WPA
851 * IE by generating an event that the interface code will
852 * convert into EVENT_ASSOCINFO data (see below).
853 *
854 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
855 * instead. The driver can determine which version is used by
856 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
857 * WPA2/RSN).
ad08c363
JM
858 *
859 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
6fc6879b
JM
860 */
861 const u8 *wpa_ie;
e0498677 862
6fc6879b
JM
863 /**
864 * wpa_ie_len - length of the wpa_ie
865 */
866 size_t wpa_ie_len;
867
64fa840a
JM
868 /**
869 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
870 */
871 unsigned int wpa_proto;
872
e0498677 873 /**
4848a38d 874 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
e0498677
JM
875 *
876 * This is usually ignored if @wpa_ie is used.
877 */
4848a38d 878 unsigned int pairwise_suite;
e0498677
JM
879
880 /**
4848a38d 881 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
e0498677
JM
882 *
883 * This is usually ignored if @wpa_ie is used.
884 */
4848a38d 885 unsigned int group_suite;
e0498677 886
61a56c14
JM
887 /**
888 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
889 *
890 * This is usually ignored if @wpa_ie is used.
891 */
892 unsigned int mgmt_group_suite;
893
e0498677 894 /**
4848a38d 895 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
e0498677
JM
896 *
897 * This is usually ignored if @wpa_ie is used.
898 */
4848a38d 899 unsigned int key_mgmt_suite;
6fc6879b
JM
900
901 /**
902 * auth_alg - Allowed authentication algorithms
abd9fafa 903 * Bit field of WPA_AUTH_ALG_*
6fc6879b
JM
904 */
905 int auth_alg;
906
907 /**
908 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
909 */
910 int mode;
911
912 /**
913 * wep_key - WEP keys for static WEP configuration
914 */
915 const u8 *wep_key[4];
916
917 /**
918 * wep_key_len - WEP key length for static WEP configuration
919 */
920 size_t wep_key_len[4];
921
922 /**
923 * wep_tx_keyidx - WEP TX key index for static WEP configuration
924 */
925 int wep_tx_keyidx;
926
927 /**
928 * mgmt_frame_protection - IEEE 802.11w management frame protection
929 */
70f8cc8e 930 enum mfp_options mgmt_frame_protection;
6fc6879b 931
6fc6879b
JM
932 /**
933 * passphrase - RSN passphrase for PSK
934 *
935 * This value is made available only for WPA/WPA2-Personal (PSK) and
436ee2fd
AS
936 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
937 * is the 8..63 character ASCII passphrase, if available. Please note
938 * that this can be %NULL if passphrase was not used to generate the
939 * PSK. In that case, the psk field must be used to fetch the PSK.
6fc6879b
JM
940 */
941 const char *passphrase;
942
943 /**
944 * psk - RSN PSK (alternative for passphrase for PSK)
945 *
946 * This value is made available only for WPA/WPA2-Personal (PSK) and
436ee2fd
AS
947 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
948 * is the 32-octet (256-bit) PSK, if available. The driver wrapper
949 * should be prepared to handle %NULL value as an error.
6fc6879b
JM
950 */
951 const u8 *psk;
36b15723
JM
952
953 /**
954 * drop_unencrypted - Enable/disable unencrypted frame filtering
955 *
956 * Configure the driver to drop all non-EAPOL frames (both receive and
957 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
958 * still be allowed for key negotiation.
959 */
960 int drop_unencrypted;
62fa124c
JM
961
962 /**
963 * prev_bssid - Previously used BSSID in this ESS
964 *
965 * When not %NULL, this is a request to use reassociation instead of
966 * association.
967 */
968 const u8 *prev_bssid;
0c80427d
JM
969
970 /**
971 * wps - WPS mode
972 *
973 * If the driver needs to do special configuration for WPS association,
974 * this variable provides more information on what type of association
975 * is being requested. Most drivers should not need ot use this.
976 */
977 enum wps_mode wps;
75bde05d
JM
978
979 /**
980 * p2p - Whether this connection is a P2P group
981 */
982 int p2p;
eea2fd9e
JM
983
984 /**
985 * uapsd - UAPSD parameters for the network
986 * -1 = do not change defaults
987 * AP mode: 1 = enabled, 0 = disabled
988 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
989 */
990 int uapsd;
9e2af29f
NC
991
992 /**
993 * fixed_bssid - Whether to force this BSSID in IBSS mode
994 * 1 = Fix this BSSID and prevent merges.
995 * 0 = Do not fix BSSID.
996 */
997 int fixed_bssid;
80e8a5ee 998
4d9e6fba
JD
999 /**
1000 * fixed_freq - Fix control channel in IBSS mode
1001 * 0 = don't fix control channel (default)
1002 * 1 = fix control channel; this prevents IBSS merging with another
1003 * channel
1004 */
1005 int fixed_freq;
1006
80e8a5ee
BG
1007 /**
1008 * disable_ht - Disable HT (IEEE 802.11n) for this connection
1009 */
1010 int disable_ht;
1011
1012 /**
4e8f31e2
JM
1013 * htcaps - HT Capabilities over-rides
1014 *
1015 * Only bits set in the mask will be used, and not all values are used
1016 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
1017 *
1018 * Pointer to struct ieee80211_ht_capabilities.
1019 */
1020 const u8 *htcaps;
1021
1022 /**
1023 * htcaps_mask - HT Capabilities over-rides mask
1024 *
1025 * Pointer to struct ieee80211_ht_capabilities.
80e8a5ee 1026 */
4e8f31e2 1027 const u8 *htcaps_mask;
e9ee8dc3
JB
1028
1029#ifdef CONFIG_VHT_OVERRIDES
1030 /**
1031 * disable_vht - Disable VHT for this connection
1032 */
1033 int disable_vht;
1034
1035 /**
1036 * VHT capability overrides.
1037 */
1038 const struct ieee80211_vht_capabilities *vhtcaps;
1039 const struct ieee80211_vht_capabilities *vhtcaps_mask;
1040#endif /* CONFIG_VHT_OVERRIDES */
b41f2684
CL
1041
1042 /**
1043 * req_key_mgmt_offload - Request key management offload for connection
1044 *
1045 * Request key management offload for this connection if the device
1046 * supports it.
1047 */
1048 int req_key_mgmt_offload;
0dc957b9
AK
1049
1050 /**
1051 * Flag for indicating whether this association includes support for
1052 * RRM (Radio Resource Measurements)
1053 */
1054 int rrm_used;
86b5c400
LD
1055
1056 /**
1057 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1058 * AP as usual. Valid for DMG network only.
1059 */
1060 int pbss;
ac56c395
JM
1061
1062 /**
1063 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1064 */
1065 const u8 *fils_kek;
1066
1067 /**
1068 * fils_kek_len: Length of fils_kek in bytes
1069 */
1070 size_t fils_kek_len;
1071
1072 /**
1073 * fils_nonces - Nonces for FILS association frame protection
1074 * (AES-SIV AAD)
1075 */
1076 const u8 *fils_nonces;
1077
1078 /**
1079 * fils_nonces_len: Length of fils_nonce in bytes
1080 */
1081 size_t fils_nonces_len;
ad295f3b
VK
1082
1083 /**
1084 * fils_erp_username - Username part of keyName-NAI
1085 */
1086 const u8 *fils_erp_username;
1087
1088 /**
1089 * fils_erp_username_len - Length of fils_erp_username in bytes
1090 */
1091 size_t fils_erp_username_len;
1092
1093 /**
1094 * fils_erp_realm - Realm/domain name to use in FILS ERP
1095 */
1096 const u8 *fils_erp_realm;
1097
1098 /**
1099 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1100 */
1101 size_t fils_erp_realm_len;
1102
1103 /**
1104 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1105 * messages
1106 */
1107 u16 fils_erp_next_seq_num;
1108
1109 /**
1110 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1111 * specified by fils_erp_username@fils_erp_realm.
1112 */
1113 const u8 *fils_erp_rrk;
1114
1115 /**
1116 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1117 */
1118 size_t fils_erp_rrk_len;
6fc6879b
JM
1119};
1120
97a7a0b5
JM
1121enum hide_ssid {
1122 NO_SSID_HIDING,
1123 HIDDEN_SSID_ZERO_LEN,
1124 HIDDEN_SSID_ZERO_CONTENTS
1125};
1126
95f556f3
OD
1127enum ch_switch_state {
1128 CH_SW_STARTED,
1129 CH_SW_FINISHED
1130};
1131
e4fa8b12
EP
1132struct wowlan_triggers {
1133 u8 any;
1134 u8 disconnect;
1135 u8 magic_pkt;
1136 u8 gtk_rekey_failure;
1137 u8 eap_identity_req;
1138 u8 four_way_handshake;
1139 u8 rfkill_release;
1140};
1141
19c3b566
JM
1142struct wpa_driver_ap_params {
1143 /**
1144 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1145 */
e44a384b 1146 u8 *head;
19c3b566
JM
1147
1148 /**
1149 * head_len - Length of the head buffer in octets
1150 */
1151 size_t head_len;
1152
1153 /**
1154 * tail - Beacon tail following TIM IE
1155 */
e44a384b 1156 u8 *tail;
19c3b566
JM
1157
1158 /**
1159 * tail_len - Length of the tail buffer in octets
1160 */
1161 size_t tail_len;
1162
1163 /**
1164 * dtim_period - DTIM period
1165 */
1166 int dtim_period;
1167
1168 /**
1169 * beacon_int - Beacon interval
1170 */
1171 int beacon_int;
ccb941e6 1172
e5693c47
JM
1173 /**
1174 * basic_rates: -1 terminated array of basic rates in 100 kbps
1175 *
1176 * This parameter can be used to set a specific basic rate set for the
1177 * BSS. If %NULL, default basic rate set is used.
1178 */
1179 int *basic_rates;
1180
29483a56
PK
1181 /**
1182 * beacon_rate: Beacon frame data rate
1183 *
1184 * This parameter can be used to set a specific Beacon frame data rate
1185 * for the BSS. The interpretation of this value depends on the
1186 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS). If
1187 * beacon_rate == 0 and rate_type == 0 (BEACON_RATE_LEGACY), the default
1188 * Beacon frame data rate is used.
1189 */
1190 unsigned int beacon_rate;
1191
1192 /**
1193 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT)
1194 */
1195 enum beacon_rate_type rate_type;
1196
5b99e21a
AN
1197 /**
1198 * proberesp - Probe Response template
1199 *
1200 * This is used by drivers that reply to Probe Requests internally in
1201 * AP mode and require the full Probe Response template.
1202 */
e44a384b 1203 u8 *proberesp;
5b99e21a
AN
1204
1205 /**
1206 * proberesp_len - Length of the proberesp buffer in octets
1207 */
1208 size_t proberesp_len;
1209
ccb941e6
JM
1210 /**
1211 * ssid - The SSID to use in Beacon/Probe Response frames
1212 */
1213 const u8 *ssid;
1214
1215 /**
1216 * ssid_len - Length of the SSID (1..32)
1217 */
1218 size_t ssid_len;
b11d1d64 1219
97a7a0b5
JM
1220 /**
1221 * hide_ssid - Whether to hide the SSID
1222 */
1223 enum hide_ssid hide_ssid;
1224
b11d1d64
JM
1225 /**
1226 * pairwise_ciphers - WPA_CIPHER_* bitfield
1227 */
1228 unsigned int pairwise_ciphers;
1229
1230 /**
1231 * group_cipher - WPA_CIPHER_*
1232 */
1233 unsigned int group_cipher;
1234
1235 /**
1236 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1237 */
1238 unsigned int key_mgmt_suites;
1239
1240 /**
1241 * auth_algs - WPA_AUTH_ALG_* bitfield
1242 */
1243 unsigned int auth_algs;
1244
1245 /**
1246 * wpa_version - WPA_PROTO_* bitfield
1247 */
1248 unsigned int wpa_version;
1249
1250 /**
1251 * privacy - Whether privacy is used in the BSS
1252 */
1253 int privacy;
fb91db56
JM
1254
1255 /**
1256 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1257 *
dcd1eb5b
JM
1258 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1259 * not use the full Beacon template.
fb91db56
JM
1260 */
1261 const struct wpabuf *beacon_ies;
1262
1263 /**
1264 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1265 *
1266 * This is used to add IEs like WPS IE and P2P IE by drivers that
1267 * reply to Probe Request frames internally.
1268 */
1269 const struct wpabuf *proberesp_ies;
1270
1271 /**
1272 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
062390ef
JM
1273 *
1274 * This is used to add IEs like WPS IE by drivers that reply to
1275 * (Re)Association Request frames internally.
fb91db56
JM
1276 */
1277 const struct wpabuf *assocresp_ies;
fd13a541
JM
1278
1279 /**
1280 * isolate - Whether to isolate frames between associated stations
1281 *
1282 * If this is non-zero, the AP is requested to disable forwarding of
e53a0c74 1283 * frames between associated stations.
fd13a541
JM
1284 */
1285 int isolate;
31357268
JM
1286
1287 /**
1288 * cts_protect - Whether CTS protection is enabled
1289 */
1290 int cts_protect;
1291
1292 /**
1293 * preamble - Whether short preamble is enabled
1294 */
1295 int preamble;
1296
1297 /**
1298 * short_slot_time - Whether short slot time is enabled
1299 *
1300 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1301 * not set (e.g., when 802.11g mode is not in use)
1302 */
1303 int short_slot_time;
1304
1305 /**
1306 * ht_opmode - HT operation mode or -1 if HT not in use
1307 */
1308 int ht_opmode;
8a33a63f
JM
1309
1310 /**
1311 * interworking - Whether Interworking is enabled
1312 */
1313 int interworking;
1314
1315 /**
1316 * hessid - Homogeneous ESS identifier or %NULL if not set
1317 */
1318 const u8 *hessid;
16991cff
JM
1319
1320 /**
1321 * access_network_type - Access Network Type (0..15)
1322 *
1323 * This is used for filtering Probe Request frames when Interworking is
1324 * enabled.
1325 */
1326 u8 access_network_type;
a0133ee1
VT
1327
1328 /**
1329 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1330 *
1331 * This is used by driver which advertises this capability.
1332 */
1333 int ap_max_inactivity;
83421850 1334
0b8bcaa5
EP
1335 /**
1336 * ctwindow - Client Traffic Window (in TUs)
1337 */
1338 u8 p2p_go_ctwindow;
1339
83421850 1340 /**
8f461b50
EP
1341 * smps_mode - SMPS mode
1342 *
1343 * SMPS mode to be used by the AP, specified as the relevant bits of
1344 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1345 */
1346 unsigned int smps_mode;
1347
1348 /**
83421850
JM
1349 * disable_dgaf - Whether group-addressed frames are disabled
1350 */
1351 int disable_dgaf;
a14896e8
JM
1352
1353 /**
1354 * osen - Whether OSEN security is enabled
1355 */
1356 int osen;
196c9c7c
PX
1357
1358 /**
1359 * freq - Channel parameters for dynamic bandwidth changes
1360 */
1361 struct hostapd_freq_params *freq;
f33c8606
JM
1362
1363 /**
1364 * reenable - Whether this is to re-enable beaconing
1365 */
1366 int reenable;
86b5c400
LD
1367
1368 /**
1369 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1370 * infrastructure BSS. Valid only for DMG network.
1371 */
1372 int pbss;
34f7c699
MB
1373
1374 /**
1375 * multicast_to_unicast - Whether to use multicast_to_unicast
1376 *
1377 * If this is non-zero, the AP is requested to perform multicast to
1378 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1379 * 802.1Q). If enabled, such frames are to be sent to each station
1380 * separately, with the DA replaced by their own MAC address rather
1381 * than the group address.
1382 *
1383 * Note that this may break certain expectations of the receiver, such
1384 * as the ability to drop unicast IP packets received within multicast
1385 * L2 frames, or the ability to not send ICMP destination unreachable
1386 * messages for packets received in L2 multicast (which is required,
1387 * but the receiver can't tell the difference if this new option is
1388 * enabled.)
1389 *
1390 * This also doesn't implement the 802.11 DMS (directed multicast
1391 * service).
1392 */
1393 int multicast_to_unicast;
4cb618cf
AO
1394
1395 /**
1396 * ftm_responder - Whether FTM responder is enabled
1397 */
1398 int ftm_responder;
1399
1400 /**
1401 * lci - Binary data, the content of an LCI report IE with type 8 as
1402 * defined in IEEE Std 802.11-2016, 9.4.2.22.10
1403 */
1404 const struct wpabuf *lci;
1405
1406 /**
1407 * civic - Binary data, the content of a measurement report IE with
1408 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
1409 */
1410 const struct wpabuf *civic;
19c3b566
JM
1411};
1412
6c1664f6 1413struct wpa_driver_mesh_bss_params {
2bd62171
MH
1414#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1415#define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1416#define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
052b8d38 1417#define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
31a856a1 1418#define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010
6c1664f6
BC
1419 /*
1420 * TODO: Other mesh configuration parameters would go here.
1421 * See NL80211_MESHCONF_* for all the mesh config parameters.
1422 */
1423 unsigned int flags;
2bd62171 1424 int auto_plinks;
5a2a6de6 1425 int peer_link_timeout;
a1431ef8 1426 int max_peer_links;
31a856a1 1427 int rssi_threshold;
052b8d38 1428 u16 ht_opmode;
6c1664f6
BC
1429};
1430
1431struct wpa_driver_mesh_join_params {
1432 const u8 *meshid;
1433 int meshid_len;
1434 const int *basic_rates;
1435 const u8 *ies;
1436 int ie_len;
f7e889fa 1437 struct hostapd_freq_params freq;
9c58c5f7 1438 int beacon_int;
4ac2ea57 1439 int dtim_period;
6c1664f6
BC
1440 struct wpa_driver_mesh_bss_params conf;
1441#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1442#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1443#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1444#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1445 unsigned int flags;
1446};
1447
6fc6879b
JM
1448/**
1449 * struct wpa_driver_capa - Driver capability information
1450 */
1451struct wpa_driver_capa {
1452#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1453#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1454#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1455#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1456#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1457#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1458#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
369c8d7b 1459#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
399e6135
JM
1460#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1461#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
f9561868 1462#define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
567da5bb 1463#define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
fe3e0bac
VK
1464#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1465#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1466#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1467#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
8ec7c99e 1468#define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000
4e8f31e2 1469 /** Bitfield of supported key management suites */
6fc6879b
JM
1470 unsigned int key_mgmt;
1471
1472#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1473#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1474#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1475#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
349493bd 1476#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
eb7719ff 1477#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
30675c34
JM
1478#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1479#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1480#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1481#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1482#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1483#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
ae6f9272 1484#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
4e8f31e2 1485 /** Bitfield of supported cipher suites */
6fc6879b
JM
1486 unsigned int enc;
1487
1488#define WPA_DRIVER_AUTH_OPEN 0x00000001
1489#define WPA_DRIVER_AUTH_SHARED 0x00000002
1490#define WPA_DRIVER_AUTH_LEAP 0x00000004
4e8f31e2 1491 /** Bitfield of supported IEEE 802.11 authentication algorithms */
6fc6879b
JM
1492 unsigned int auth;
1493
4e8f31e2 1494/** Driver generated WPA/RSN IE */
6fc6879b 1495#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
4e8f31e2 1496/** Driver needs static WEP key setup after association command */
6fc6879b 1497#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
4e8f31e2 1498/** Driver takes care of all DFS operations */
65d645ce 1499#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
4e8f31e2 1500/** Driver takes care of RSN 4-way handshake internally; PMK is configured with
6fc6879b 1501 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
436ee2fd 1502#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008
4e8f31e2 1503/** Driver is for a wired Ethernet interface */
4ef1e644 1504#define WPA_DRIVER_FLAGS_WIRED 0x00000010
4e8f31e2 1505/** Driver provides separate commands for authentication and association (SME in
c2a04078
JM
1506 * wpa_supplicant). */
1507#define WPA_DRIVER_FLAGS_SME 0x00000020
4e8f31e2 1508/** Driver supports AP mode */
1581b38b 1509#define WPA_DRIVER_FLAGS_AP 0x00000040
4e8f31e2 1510/** Driver needs static WEP key setup after association has been completed */
0194fedb 1511#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
4e8f31e2 1512/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
196c9c7c 1513#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
4e8f31e2 1514/** Driver supports concurrent P2P operations */
75bde05d 1515#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
4e8f31e2 1516/**
75bde05d 1517 * Driver uses the initial interface as a dedicated management interface, i.e.,
971e357f 1518 * it cannot be used for P2P group operations or non-P2P purposes.
75bde05d
JM
1519 */
1520#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
4e8f31e2 1521/** This interface is P2P capable (P2P GO or P2P Client) */
75bde05d 1522#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
4e8f31e2 1523/** Driver supports station and key removal when stopping an AP */
354c903f 1524#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
4e8f31e2 1525/**
971e357f
JM
1526 * Driver uses the initial interface for P2P management interface and non-P2P
1527 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1528 * P2P group operations.
1529 */
1530#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
4e8f31e2 1531/**
871f4dd0
JM
1532 * Driver is known to use sane error codes, i.e., when it indicates that
1533 * something (e.g., association) fails, there was indeed a failure and the
1534 * operation does not end up getting completed successfully later.
1535 */
1536#define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
4e8f31e2 1537/** Driver supports off-channel TX */
190b9062 1538#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
4e8f31e2 1539/** Driver indicates TX status events for EAPOL Data frames */
2fee890a 1540#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
4e8f31e2 1541/** Driver indicates TX status events for Deauth/Disassoc frames */
4dc03726 1542#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
4e8f31e2 1543/** Driver supports roaming (BSS selection) in firmware */
004ba773 1544#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
4e8f31e2 1545/** Driver supports operating as a TDLS peer */
03ea1786 1546#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
4e8f31e2 1547/** Driver requires external TDLS setup/teardown/discovery */
03ea1786 1548#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
4e8f31e2 1549/** Driver indicates support for Probe Response offloading in AP mode */
562c9d97 1550#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
4e8f31e2 1551/** Driver supports U-APSD in AP mode */
70619a5d 1552#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
4e8f31e2 1553/** Driver supports inactivity timer in AP mode */
a0133ee1 1554#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
4e8f31e2 1555/** Driver expects user space implementation of MLME in AP mode */
e5091674 1556#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
4e8f31e2 1557/** Driver supports SAE with user space SME */
c10347f2 1558#define WPA_DRIVER_FLAGS_SAE 0x02000000
4e8f31e2 1559/** Driver makes use of OBSS scan mechanism in wpa_supplicant */
368b1957 1560#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
4e8f31e2 1561/** Driver supports IBSS (Ad-hoc) mode */
65d52fc1 1562#define WPA_DRIVER_FLAGS_IBSS 0x08000000
4e8f31e2 1563/** Driver supports radar detection */
f295d0c8 1564#define WPA_DRIVER_FLAGS_RADAR 0x10000000
4e8f31e2 1565/** Driver supports a dedicated interface for P2P Device */
7aad838c 1566#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
4e8f31e2 1567/** Driver supports QoS Mapping */
429dd9af 1568#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
4e8f31e2 1569/** Driver supports CSA in AP mode */
991aa9c7 1570#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
4e8f31e2 1571/** Driver supports mesh */
24bd4e0b 1572#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
4e8f31e2 1573/** Driver support ACS offload */
16689c7c 1574#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
4e8f31e2 1575/** Driver supports key management offload */
15badebd 1576#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
4daa5729
AN
1577/** Driver supports TDLS channel switching */
1578#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1830817e
JD
1579/** Driver supports IBSS with HT datarates */
1580#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
563ee183
JD
1581/** Driver supports IBSS with VHT datarates */
1582#define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
3784c058
PX
1583/** Driver supports automatic band selection */
1584#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
8e509745
KV
1585/** Driver supports simultaneous off-channel operations */
1586#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
dc55b6b6
AB
1587/** Driver supports full AP client state */
1588#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
a6f5b193
PX
1589/** Driver supports P2P Listen offload */
1590#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
061dac1d
JM
1591/** Driver supports FILS */
1592#define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
29483a56
PK
1593/** Driver supports Beacon frame TX rate configuration (legacy rates) */
1594#define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1595/** Driver supports Beacon frame TX rate configuration (HT rates) */
1596#define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1597/** Driver supports Beacon frame TX rate configuration (VHT rates) */
1598#define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
8331c9b3
VK
1599/** Driver supports mgmt_tx with random TX address in non-connected state */
1600#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
1601/** Driver supports mgmt_tx with random TX addr in connected state */
1602#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
20c846d9 1603/** Driver supports better BSS reporting with sched_scan in connected mode */
1604#define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
94380cb4
PX
1605/** Driver supports HE capabilities */
1606#define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
ad295f3b
VK
1607/** Driver supports FILS shared key offload */
1608#define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
fb718f94
AP
1609/** Driver supports all OCE STA specific mandatory features */
1610#define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
1611/** Driver supports all OCE AP specific mandatory features */
1612#define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
1613/**
1614 * Driver supports all OCE STA-CFON specific mandatory features only.
1615 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
1616 * userspace shall assume that this driver may not support all OCE AP
1617 * functionality but can support only OCE STA-CFON functionality.
1618 */
1619#define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
299d21e8
EG
1620/** Driver supports MFP-optional in the connect command */
1621#define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL
8aa4d552
PX
1622/** Driver is a self-managed regulatory device */
1623#define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL
4cb618cf
AO
1624/** Driver supports FTM responder functionality */
1625#define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL
436ee2fd
AS
1626/** Driver support 4-way handshake offload for WPA-Personal */
1627#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
24bd4e0b 1628 u64 flags;
80bc75f1 1629
dc55b6b6
AB
1630#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1631 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1632
04ee647d
EP
1633#define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1634#define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1635 unsigned int smps_modes;
1636
471cd6e1
MB
1637 unsigned int wmm_ac_supported:1;
1638
ff23ed22
IP
1639 unsigned int mac_addr_rand_scan_supported:1;
1640 unsigned int mac_addr_rand_sched_scan_supported:1;
1641
4e8f31e2 1642 /** Maximum number of supported active probe SSIDs */
80bc75f1 1643 int max_scan_ssids;
4e8f31e2
JM
1644
1645 /** Maximum number of supported active probe SSIDs for sched_scan */
cbdf3507 1646 int max_sched_scan_ssids;
4e8f31e2 1647
09ea4309
AS
1648 /** Maximum number of supported scan plans for scheduled scan */
1649 unsigned int max_sched_scan_plans;
1650
1651 /** Maximum interval in a scan plan. In seconds */
1652 u32 max_sched_scan_plan_interval;
1653
1654 /** Maximum number of iterations in a single scan plan */
1655 u32 max_sched_scan_plan_iterations;
1656
4e8f31e2 1657 /** Whether sched_scan (offloaded scanning) is supported */
cbdf3507 1658 int sched_scan_supported;
4e8f31e2
JM
1659
1660 /** Maximum number of supported match sets for sched_scan */
b59e6f26 1661 int max_match_sets;
814782b9
JM
1662
1663 /**
1664 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1665 */
1666 unsigned int max_remain_on_chan;
c4ea4c5c
JM
1667
1668 /**
1669 * max_stations - Maximum number of associated stations the driver
1670 * supports in AP mode
1671 */
1672 unsigned int max_stations;
562c9d97
AN
1673
1674 /**
1675 * probe_resp_offloads - Bitmap of supported protocols by the driver
1676 * for Probe Response offloading.
1677 */
4e8f31e2 1678/** Driver Probe Response offloading support for WPS ver. 1 */
562c9d97 1679#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
4e8f31e2 1680/** Driver Probe Response offloading support for WPS ver. 2 */
562c9d97 1681#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
4e8f31e2 1682/** Driver Probe Response offloading support for P2P */
562c9d97 1683#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
4e8f31e2 1684/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
562c9d97
AN
1685#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1686 unsigned int probe_resp_offloads;
8cd6b7bc 1687
3c4ca363
VN
1688 unsigned int max_acl_mac_addrs;
1689
4752147d
IP
1690 /**
1691 * Number of supported concurrent channels
1692 */
1693 unsigned int num_multichan_concurrent;
1694
8cd6b7bc
JB
1695 /**
1696 * extended_capa - extended capabilities in driver/device
1697 *
1698 * Must be allocated and freed by driver and the pointers must be
1699 * valid for the lifetime of the driver, i.e., freed in deinit()
1700 */
1701 const u8 *extended_capa, *extended_capa_mask;
1702 unsigned int extended_capa_len;
e4fa8b12
EP
1703
1704 struct wowlan_triggers wowlan_triggers;
0dc957b9 1705
4e8f31e2 1706/** Driver adds the DS Params Set IE in Probe Request frames */
0dc957b9 1707#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
4e8f31e2 1708/** Driver adds the WFA TPC IE in Probe Request frames */
0dc957b9 1709#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
4e8f31e2 1710/** Driver handles quiet period requests */
0dc957b9
AK
1711#define WPA_DRIVER_FLAGS_QUIET 0x00000004
1712/**
1713 * Driver is capable of inserting the current TX power value into the body of
1714 * transmitted frames.
1715 * Background: Some Action frames include a TPC Report IE. This IE contains a
1716 * TX power field, which has to be updated by lower layers. One such Action
1717 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1718 * of spectrum management). Note that this insertion takes place at a fixed
1719 * offset, namely the 6th byte in the Action frame body.
1720 */
1721#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
a7f0bb70
BL
1722/**
1723 * Driver supports RRM. With this support, the driver will accept to use RRM in
1724 * (Re)Association Request frames, without supporting quiet period.
1725 */
1726#define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1727
c16b9f8d
AS
1728/** Driver supports setting the scan dwell time */
1729#define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
1730/** Driver supports Beacon Report Measurement */
1731#define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
1732
0dc957b9 1733 u32 rrm_flags;
079a28f7
AK
1734
1735 /* Driver concurrency capabilities */
1736 unsigned int conc_capab;
1737 /* Maximum number of concurrent channels on 2.4 GHz */
1738 unsigned int max_conc_chan_2_4;
1739 /* Maximum number of concurrent channels on 5 GHz */
1740 unsigned int max_conc_chan_5_0;
366179d2
AO
1741
1742 /* Maximum number of supported CSA counters */
1743 u16 max_csa_counters;
6fc6879b
JM
1744};
1745
1746
c5121837
JM
1747struct hostapd_data;
1748
3567641e 1749#define STA_DRV_DATA_TX_MCS BIT(0)
1750#define STA_DRV_DATA_RX_MCS BIT(1)
1751#define STA_DRV_DATA_TX_VHT_MCS BIT(2)
1752#define STA_DRV_DATA_RX_VHT_MCS BIT(3)
1753#define STA_DRV_DATA_TX_VHT_NSS BIT(4)
1754#define STA_DRV_DATA_RX_VHT_NSS BIT(5)
1755#define STA_DRV_DATA_TX_SHORT_GI BIT(6)
1756#define STA_DRV_DATA_RX_SHORT_GI BIT(7)
72123a84 1757#define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
3567641e 1758
c5121837 1759struct hostap_sta_driver_data {
43022abd
NL
1760 unsigned long rx_packets, tx_packets;
1761 unsigned long long rx_bytes, tx_bytes;
58d4c236 1762 unsigned long long rx_airtime, tx_airtime;
43022abd 1763 int bytes_64bit; /* whether 64-bit byte counters are supported */
c5121837 1764 unsigned long current_tx_rate;
3567641e 1765 unsigned long current_rx_rate;
c5121837 1766 unsigned long inactive_msec;
3567641e 1767 unsigned long flags; /* bitfield of STA_DRV_DATA_* */
c5121837
JM
1768 unsigned long num_ps_buf_frames;
1769 unsigned long tx_retry_failed;
1770 unsigned long tx_retry_count;
72123a84 1771 s8 last_ack_rssi;
1d6f6385
THJ
1772 unsigned long backlog_packets;
1773 unsigned long backlog_bytes;
3567641e 1774 s8 signal;
1775 u8 rx_vhtmcs;
1776 u8 tx_vhtmcs;
1777 u8 rx_mcs;
1778 u8 tx_mcs;
1779 u8 rx_vht_nss;
1780 u8 tx_vht_nss;
c5121837
JM
1781};
1782
1783struct hostapd_sta_add_params {
1784 const u8 *addr;
1785 u16 aid;
1786 u16 capability;
1787 const u8 *supp_rates;
1788 size_t supp_rates_len;
c5121837 1789 u16 listen_interval;
fc4e2d95 1790 const struct ieee80211_ht_capabilities *ht_capabilities;
a9a1d0f0 1791 const struct ieee80211_vht_capabilities *vht_capabilities;
8a458116
MK
1792 int vht_opmode_enabled;
1793 u8 vht_opmode;
d83ab1fe 1794 u32 flags; /* bitmask of WPA_STA_* flags */
7e31703e 1795 u32 flags_mask; /* unset bits in flags */
7c7e7877
BC
1796#ifdef CONFIG_MESH
1797 enum mesh_plink_state plink_state;
e347cafe 1798 u16 peer_aid;
7c7e7877 1799#endif /* CONFIG_MESH */
45b722f1 1800 int set; /* Set STA parameters instead of add */
5d061637 1801 u8 qosinfo;
d16531c4
SD
1802 const u8 *ext_capab;
1803 size_t ext_capab_len;
3ed97271
SD
1804 const u8 *supp_channels;
1805 size_t supp_channels_len;
1806 const u8 *supp_oper_classes;
1807 size_t supp_oper_classes_len;
ae33239c 1808 int support_p2p_ps;
c5121837
JM
1809};
1810
3c4ca363
VN
1811struct mac_address {
1812 u8 addr[ETH_ALEN];
1813};
1814
1815struct hostapd_acl_params {
1816 u8 acl_policy;
1817 unsigned int num_mac_acl;
1818 struct mac_address mac_acl[0];
1819};
1820
22a7c9d7
JM
1821enum wpa_driver_if_type {
1822 /**
1823 * WPA_IF_STATION - Station mode interface
1824 */
1825 WPA_IF_STATION,
1826
1827 /**
1828 * WPA_IF_AP_VLAN - AP mode VLAN interface
1829 *
1830 * This interface shares its address and Beacon frame with the main
1831 * BSS.
1832 */
1833 WPA_IF_AP_VLAN,
1834
1835 /**
1836 * WPA_IF_AP_BSS - AP mode BSS interface
1837 *
1838 * This interface has its own address and Beacon frame.
1839 */
1840 WPA_IF_AP_BSS,
75bde05d
JM
1841
1842 /**
1843 * WPA_IF_P2P_GO - P2P Group Owner
1844 */
1845 WPA_IF_P2P_GO,
1846
1847 /**
1848 * WPA_IF_P2P_CLIENT - P2P Client
1849 */
1850 WPA_IF_P2P_CLIENT,
1851
1852 /**
1853 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1854 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1855 */
7aad838c
NS
1856 WPA_IF_P2P_GROUP,
1857
1858 /**
1859 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1860 * abstracted P2P Device function in the driver
1861 */
5b78493f
MH
1862 WPA_IF_P2P_DEVICE,
1863
1864 /*
1865 * WPA_IF_MESH - Mesh interface
1866 */
1867 WPA_IF_MESH,
98342208
AK
1868
1869 /*
1870 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1871 */
1872 WPA_IF_TDLS,
1873
1874 /*
1875 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1876 */
1877 WPA_IF_IBSS,
c5121837
JM
1878};
1879
92f475b4 1880struct wpa_init_params {
4b24282a 1881 void *global_priv;
92f475b4
JM
1882 const u8 *bssid;
1883 const char *ifname;
0ecff8d7 1884 const char *driver_params;
92f475b4 1885 int use_pae_group_addr;
92f475b4
JM
1886 char **bridge;
1887 size_t num_bridge;
412036f5
JM
1888
1889 u8 *own_addr; /* buffer for writing own MAC address */
92f475b4
JM
1890};
1891
c5121837 1892
e3bd3912
JM
1893struct wpa_bss_params {
1894 /** Interface name (for multi-SSID/VLAN support) */
1895 const char *ifname;
1896 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1897 int enabled;
af586419
JM
1898
1899 int wpa;
1900 int ieee802_1x;
1901 int wpa_group;
1902 int wpa_pairwise;
1903 int wpa_key_mgmt;
1904 int rsn_preauth;
a1ca0292 1905 enum mfp_options ieee80211w;
e3bd3912
JM
1906};
1907
0de39516
JM
1908#define WPA_STA_AUTHORIZED BIT(0)
1909#define WPA_STA_WMM BIT(1)
1910#define WPA_STA_SHORT_PREAMBLE BIT(2)
1911#define WPA_STA_MFP BIT(3)
45b722f1 1912#define WPA_STA_TDLS_PEER BIT(4)
7a228b5c 1913#define WPA_STA_AUTHENTICATED BIT(5)
dc55b6b6 1914#define WPA_STA_ASSOCIATED BIT(6)
e3bd3912 1915
281ff0aa
GP
1916enum tdls_oper {
1917 TDLS_DISCOVERY_REQ,
1918 TDLS_SETUP,
1919 TDLS_TEARDOWN,
1920 TDLS_ENABLE_LINK,
b8f64582
JM
1921 TDLS_DISABLE_LINK,
1922 TDLS_ENABLE,
1923 TDLS_DISABLE
281ff0aa
GP
1924};
1925
a884be9d
XC
1926enum wnm_oper {
1927 WNM_SLEEP_ENTER_CONFIRM,
1928 WNM_SLEEP_ENTER_FAIL,
1929 WNM_SLEEP_EXIT_CONFIRM,
1930 WNM_SLEEP_EXIT_FAIL,
1931 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1932 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1933 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1934 * a STA */
1935 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1936 * for a STA */
1937 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1938 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1939 * for a STA */
1940 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1941};
1942
e8ada160
T
1943/* enum smps_mode - SMPS mode definitions */
1944enum smps_mode {
1945 SMPS_AUTOMATIC,
1946 SMPS_OFF,
1947 SMPS_DYNAMIC,
1948 SMPS_STATIC,
1949
1950 /* Keep last */
1951 SMPS_INVALID,
1952};
1953
941807f6
EG
1954#define WPA_INVALID_NOISE 9999
1955
1c5c7273
PS
1956/**
1957 * struct wpa_signal_info - Information about channel signal quality
941807f6
EG
1958 * @frequency: control frequency
1959 * @above_threshold: true if the above threshold was crossed
1960 * (relevant for a CQM event)
1961 * @current_signal: in dBm
1962 * @avg_signal: in dBm
1963 * @avg_beacon_signal: in dBm
1964 * @current_noise: %WPA_INVALID_NOISE if not supported
1965 * @current_txrate: current TX rate
1966 * @chanwidth: channel width
1967 * @center_frq1: center frequency for the first segment
1968 * @center_frq2: center frequency for the second segment (if relevant)
1c5c7273
PS
1969 */
1970struct wpa_signal_info {
1971 u32 frequency;
1972 int above_threshold;
1973 int current_signal;
95783298 1974 int avg_signal;
74fa78b2 1975 int avg_beacon_signal;
1c5c7273
PS
1976 int current_noise;
1977 int current_txrate;
2cc8d8f4
AO
1978 enum chan_width chanwidth;
1979 int center_frq1;
1980 int center_frq2;
1c5c7273
PS
1981};
1982
7f00dc6e
MV
1983/**
1984 * struct wpa_channel_info - Information about the current channel
1985 * @frequency: Center frequency of the primary 20 MHz channel
1986 * @chanwidth: Width of the current operating channel
1987 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
1988 * This field is only filled in when using a 40 MHz channel.
1989 * @center_frq1: Center frequency of frequency segment 0
1990 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
1991 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
1992 * derived from center_frq2 for convenience.
1993 */
1994struct wpa_channel_info {
1995 u32 frequency;
1996 enum chan_width chanwidth;
1997 int sec_channel;
1998 int center_frq1;
1999 int center_frq2;
2000 u8 seg1_idx;
2001};
2002
dcca2219
AO
2003/**
2004 * struct beacon_data - Beacon data
2005 * @head: Head portion of Beacon frame (before TIM IE)
2006 * @tail: Tail portion of Beacon frame (after TIM IE)
2007 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2008 * @proberesp_ies: Extra information element(s) to add into Probe Response
2009 * frames or %NULL
2010 * @assocresp_ies: Extra information element(s) to add into (Re)Association
2011 * Response frames or %NULL
2012 * @probe_resp: Probe Response frame template
2013 * @head_len: Length of @head
2014 * @tail_len: Length of @tail
2015 * @beacon_ies_len: Length of beacon_ies in octets
2016 * @proberesp_ies_len: Length of proberesp_ies in octets
2017 * @proberesp_ies_len: Length of proberesp_ies in octets
2018 * @probe_resp_len: Length of probe response template (@probe_resp)
2019 */
2020struct beacon_data {
2021 u8 *head, *tail;
2022 u8 *beacon_ies;
2023 u8 *proberesp_ies;
2024 u8 *assocresp_ies;
2025 u8 *probe_resp;
2026
2027 size_t head_len, tail_len;
2028 size_t beacon_ies_len;
2029 size_t proberesp_ies_len;
2030 size_t assocresp_ies_len;
2031 size_t probe_resp_len;
2032};
2033
2034/**
2035 * struct csa_settings - Settings for channel switch command
2036 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2037 * @block_tx: 1 - block transmission for CSA period
2038 * @freq_params: Next channel frequency parameter
2039 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2040 * @beacon_after: Next beacon/probe resp/asooc resp info
2041 * @counter_offset_beacon: Offset to the count field in beacon's tail
2042 * @counter_offset_presp: Offset to the count field in probe resp.
2043 */
2044struct csa_settings {
2045 u8 cs_count;
2046 u8 block_tx;
2047
2048 struct hostapd_freq_params freq_params;
2049 struct beacon_data beacon_csa;
2050 struct beacon_data beacon_after;
2051
366179d2
AO
2052 u16 counter_offset_beacon[2];
2053 u16 counter_offset_presp[2];
dcca2219
AO
2054};
2055
96ecea5e
SD
2056/* TDLS peer capabilities for send_tdls_mgmt() */
2057enum tdls_peer_capability {
2058 TDLS_PEER_HT = BIT(0),
2059 TDLS_PEER_VHT = BIT(1),
2060 TDLS_PEER_WMM = BIT(2),
2061};
2062
0f14a44e
EP
2063/* valid info in the wmm_params struct */
2064enum wmm_params_valid_info {
2065 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
2066};
2067
2068/**
2069 * struct wmm_params - WMM parameterss configured for this association
2070 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2071 * of the struct contain valid information.
2072 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2073 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2074 */
2075struct wmm_params {
2076 u8 info_bitmap;
2077 u8 uapsd_queues;
2078};
2079
7baec808
HW
2080#ifdef CONFIG_MACSEC
2081struct macsec_init_params {
2082 Boolean always_include_sci;
2083 Boolean use_es;
2084 Boolean use_scb;
2085};
2086#endif /* CONFIG_MACSEC */
2087
73d2294f
KP
2088enum drv_br_port_attr {
2089 DRV_BR_PORT_ATTR_PROXYARP,
2090 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
2091};
2092
7565752d
KP
2093enum drv_br_net_param {
2094 DRV_BR_NET_PARAM_GARP_ACCEPT,
60eb9e17 2095 DRV_BR_MULTICAST_SNOOPING,
7565752d
KP
2096};
2097
16689c7c
PX
2098struct drv_acs_params {
2099 /* Selected mode (HOSTAPD_MODE_*) */
2100 enum hostapd_hw_mode hw_mode;
2101
2102 /* Indicates whether HT is enabled */
2103 int ht_enabled;
2104
2105 /* Indicates whether HT40 is enabled */
2106 int ht40_enabled;
857d9422
MM
2107
2108 /* Indicates whether VHT is enabled */
2109 int vht_enabled;
2110
2111 /* Configured ACS channel width */
2112 u16 ch_width;
2113
2114 /* ACS channel list info */
2115 unsigned int ch_list_len;
2116 const u8 *ch_list;
d0cdccd3 2117 const int *freq_list;
16689c7c
PX
2118};
2119
3ab48492
KV
2120struct wpa_bss_trans_info {
2121 u8 mbo_transition_reason;
2122 u8 n_candidates;
2123 u8 *bssid;
2124};
2125
2126struct wpa_bss_candidate_info {
2127 u8 num;
2128 struct candidate_list {
2129 u8 bssid[ETH_ALEN];
2130 u8 is_accept;
2131 u32 reject_reason;
2132 } *candidates;
2133};
7baec808 2134
6fbb5414
VK
2135struct wpa_pmkid_params {
2136 const u8 *bssid;
061a3d3d
VK
2137 const u8 *ssid;
2138 size_t ssid_len;
2139 const u8 *fils_cache_id;
6fbb5414 2140 const u8 *pmkid;
061a3d3d
VK
2141 const u8 *pmk;
2142 size_t pmk_len;
6fbb5414
VK
2143};
2144
3c67e977
VK
2145/* Mask used to specify which connection parameters have to be updated */
2146enum wpa_drv_update_connect_params_mask {
2147 WPA_DRV_UPDATE_ASSOC_IES = BIT(0),
2148 WPA_DRV_UPDATE_FILS_ERP_INFO = BIT(1),
2149 WPA_DRV_UPDATE_AUTH_TYPE = BIT(2),
2150};
2151
ba71cb82
SD
2152/**
2153 * struct external_auth - External authentication trigger parameters
2154 *
2155 * These are used across the external authentication request and event
2156 * interfaces.
2157 * @action: Action type / trigger for external authentication. Only significant
2158 * for the event interface.
2159 * @bssid: BSSID of the peer with which the authentication has to happen. Used
2160 * by both the request and event interface.
2161 * @ssid: SSID of the AP. Used by both the request and event interface.
2162 * @ssid_len: SSID length in octets.
2163 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2164 * the request interface.
2165 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2166 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2167 * the real status code for failures. Used only for the request interface
2168 * from user space to the driver.
236e793e 2169 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
ba71cb82
SD
2170 */
2171struct external_auth {
2172 enum {
2173 EXT_AUTH_START,
2174 EXT_AUTH_ABORT,
2175 } action;
dd1a8cef
JM
2176 const u8 *bssid;
2177 const u8 *ssid;
ba71cb82
SD
2178 size_t ssid_len;
2179 unsigned int key_mgmt_suite;
2180 u16 status;
236e793e 2181 const u8 *pmkid;
ba71cb82
SD
2182};
2183
6fc6879b
JM
2184/**
2185 * struct wpa_driver_ops - Driver interface API definition
2186 *
2187 * This structure defines the API that each driver interface needs to implement
2188 * for core wpa_supplicant code. All driver specific functionality is captured
2189 * in this wrapper.
2190 */
2191struct wpa_driver_ops {
2192 /** Name of the driver interface */
2193 const char *name;
2194 /** One line description of the driver interface */
2195 const char *desc;
2196
2197 /**
2198 * get_bssid - Get the current BSSID
2199 * @priv: private driver interface data
2200 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2201 *
2202 * Returns: 0 on success, -1 on failure
2203 *
2204 * Query kernel driver for the current BSSID and copy it to bssid.
2205 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2206 * associated.
2207 */
2208 int (*get_bssid)(void *priv, u8 *bssid);
2209
2210 /**
2211 * get_ssid - Get the current SSID
2212 * @priv: private driver interface data
2213 * @ssid: buffer for SSID (at least 32 bytes)
2214 *
2215 * Returns: Length of the SSID on success, -1 on failure
2216 *
2217 * Query kernel driver for the current SSID and copy it to ssid.
2218 * Returning zero is recommended if the STA is not associated.
2219 *
2220 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2221 * can, at least in theory, contain control characters (including nul)
2222 * and as such, should be processed as binary data, not a printable
2223 * string.
2224 */
2225 int (*get_ssid)(void *priv, u8 *ssid);
2226
6fc6879b
JM
2227 /**
2228 * set_key - Configure encryption key
642187d6 2229 * @ifname: Interface name (for multi-SSID/VLAN support)
6fc6879b
JM
2230 * @priv: private driver interface data
2231 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
eb7719ff 2232 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
30675c34
JM
2233 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
2234 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
2235 * %WPA_ALG_BIP_CMAC_256);
6fc6879b 2236 * %WPA_ALG_NONE clears the key.
0382097e
JM
2237 * @addr: Address of the peer STA (BSSID of the current AP when setting
2238 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
2239 * broadcast keys, %NULL for default keys that are used both for
2240 * broadcast and unicast; when clearing keys, %NULL is used to
2241 * indicate that both the broadcast-only and default key of the
2242 * specified key index is to be cleared
6fc6879b
JM
2243 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
2244 * IGTK
2245 * @set_tx: configure this key as the default Tx key (only used when
2246 * driver does not support separate unicast/individual key
2247 * @seq: sequence number/packet number, seq_len octets, the next
2248 * packet number to be used for in replay protection; configured
2249 * for Rx keys (in most cases, this is only used with broadcast
da64c266 2250 * keys and set to zero for unicast keys); %NULL if not set
6fc6879b 2251 * @seq_len: length of the seq, depends on the algorithm:
eb7719ff 2252 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
6fc6879b
JM
2253 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
2254 * 8-byte Rx Mic Key
2255 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
eb7719ff 2256 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
6fc6879b
JM
2257 *
2258 * Returns: 0 on success, -1 on failure
2259 *
2260 * Configure the given key for the kernel driver. If the driver
2261 * supports separate individual keys (4 default keys + 1 individual),
2262 * addr can be used to determine whether the key is default or
2263 * individual. If only 4 keys are supported, the default key with key
2264 * index 0 is used as the individual key. STA must be configured to use
2265 * it as the default Tx key (set_tx is set) and accept Rx for all the
2266 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2267 * broadcast keys, so key index 0 is available for this kind of
2268 * configuration.
2269 *
2270 * Please note that TKIP keys include separate TX and RX MIC keys and
2271 * some drivers may expect them in different order than wpa_supplicant
2272 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
61fbd3df 2273 * will trigger Michael MIC errors. This can be fixed by changing the
6fc6879b
JM
2274 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
2275 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2276 * example on how this can be done.
2277 */
71934751 2278 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
642187d6
JM
2279 const u8 *addr, int key_idx, int set_tx,
2280 const u8 *seq, size_t seq_len,
6fc6879b
JM
2281 const u8 *key, size_t key_len);
2282
2283 /**
2284 * init - Initialize driver interface
2285 * @ctx: context to be used when calling wpa_supplicant functions,
2286 * e.g., wpa_supplicant_event()
2287 * @ifname: interface name, e.g., wlan0
2288 *
2289 * Returns: Pointer to private data, %NULL on failure
2290 *
2291 * Initialize driver interface, including event processing for kernel
2292 * driver events (e.g., associated, scan results, Michael MIC failure).
2293 * This function can allocate a private configuration data area for
2294 * @ctx, file descriptor, interface name, etc. information that may be
2295 * needed in future driver operations. If this is not used, non-NULL
2296 * value will need to be returned because %NULL is used to indicate
2297 * failure. The returned value will be used as 'void *priv' data for
2298 * all other driver_ops functions.
2299 *
2300 * The main event loop (eloop.c) of wpa_supplicant can be used to
2301 * register callback for read sockets (eloop_register_read_sock()).
2302 *
2303 * See below for more information about events and
2304 * wpa_supplicant_event() function.
2305 */
2306 void * (*init)(void *ctx, const char *ifname);
2307
2308 /**
2309 * deinit - Deinitialize driver interface
2310 * @priv: private driver interface data from init()
2311 *
2312 * Shut down driver interface and processing of driver events. Free
2313 * private data buffer if one was allocated in init() handler.
2314 */
2315 void (*deinit)(void *priv);
2316
2317 /**
2318 * set_param - Set driver configuration parameters
2319 * @priv: private driver interface data from init()
2320 * @param: driver specific configuration parameters
2321 *
2322 * Returns: 0 on success, -1 on failure
2323 *
2324 * Optional handler for notifying driver interface about configuration
2325 * parameters (driver_param).
2326 */
2327 int (*set_param)(void *priv, const char *param);
2328
2329 /**
2330 * set_countermeasures - Enable/disable TKIP countermeasures
2331 * @priv: private driver interface data
2332 * @enabled: 1 = countermeasures enabled, 0 = disabled
2333 *
2334 * Returns: 0 on success, -1 on failure
2335 *
2336 * Configure TKIP countermeasures. When these are enabled, the driver
2337 * should drop all received and queued frames that are using TKIP.
2338 */
2339 int (*set_countermeasures)(void *priv, int enabled);
2340
6fc6879b
JM
2341 /**
2342 * deauthenticate - Request driver to deauthenticate
2343 * @priv: private driver interface data
2344 * @addr: peer address (BSSID of the AP)
2345 * @reason_code: 16-bit reason code to be sent in the deauthentication
2346 * frame
2347 *
2348 * Returns: 0 on success, -1 on failure
2349 */
4be17ffb 2350 int (*deauthenticate)(void *priv, const u8 *addr, u16 reason_code);
6fc6879b 2351
6fc6879b
JM
2352 /**
2353 * associate - Request driver to associate
2354 * @priv: private driver interface data
2355 * @params: association parameters
2356 *
2357 * Returns: 0 on success, -1 on failure
2358 */
2359 int (*associate)(void *priv,
2360 struct wpa_driver_associate_params *params);
2361
6fc6879b
JM
2362 /**
2363 * add_pmkid - Add PMKSA cache entry to the driver
2364 * @priv: private driver interface data
6fbb5414 2365 * @params: PMKSA parameters
6fc6879b
JM
2366 *
2367 * Returns: 0 on success, -1 on failure
2368 *
2369 * This function is called when a new PMK is received, as a result of
061a3d3d
VK
2370 * either normal authentication or RSN pre-authentication. The PMKSA
2371 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2372 * ssid, fils_cache_id, pmkid, and pmk.
6fc6879b
JM
2373 *
2374 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2375 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2376 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2377 * driver_ops function does not need to be implemented. Likewise, if
2378 * the driver does not support WPA, this function is not needed.
2379 */
6fbb5414 2380 int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params);
6fc6879b
JM
2381
2382 /**
2383 * remove_pmkid - Remove PMKSA cache entry to the driver
2384 * @priv: private driver interface data
6fbb5414 2385 * @params: PMKSA parameters
6fc6879b
JM
2386 *
2387 * Returns: 0 on success, -1 on failure
2388 *
2389 * This function is called when the supplicant drops a PMKSA cache
061a3d3d
VK
2390 * entry for any reason. The PMKSA parameters are either a set of
2391 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
6fc6879b
JM
2392 *
2393 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2394 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2395 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2396 * from wpa_supplicant, this driver_ops function does not need to be
2397 * implemented. Likewise, if the driver does not support WPA, this
2398 * function is not needed.
2399 */
6fbb5414 2400 int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params);
6fc6879b
JM
2401
2402 /**
2403 * flush_pmkid - Flush PMKSA cache
2404 * @priv: private driver interface data
2405 *
2406 * Returns: 0 on success, -1 on failure
2407 *
2408 * This function is called when the supplicant drops all PMKSA cache
2409 * entries for any reason.
2410 *
2411 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2412 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2413 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2414 * from wpa_supplicant, this driver_ops function does not need to be
2415 * implemented. Likewise, if the driver does not support WPA, this
2416 * function is not needed.
2417 */
2418 int (*flush_pmkid)(void *priv);
2419
2420 /**
6179d2fd 2421 * get_capa - Get driver capabilities
6fc6879b
JM
2422 * @priv: private driver interface data
2423 *
2424 * Returns: 0 on success, -1 on failure
2425 *
2426 * Get driver/firmware/hardware capabilities.
2427 */
2428 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
2429
2430 /**
2431 * poll - Poll driver for association information
2432 * @priv: private driver interface data
2433 *
2434 * This is an option callback that can be used when the driver does not
2435 * provide event mechanism for association events. This is called when
2436 * receiving WPA EAPOL-Key messages that require association
2437 * information. The driver interface is supposed to generate associnfo
2438 * event before returning from this callback function. In addition, the
2439 * driver interface should generate an association event after having
2440 * sent out associnfo.
2441 */
2442 void (*poll)(void *priv);
2443
45e3fc72
RM
2444 /**
2445 * get_ifindex - Get interface index
2446 * @priv: private driver interface data
2447 *
2448 * Returns: Interface index
2449 */
2450 unsigned int (*get_ifindex)(void *priv);
2451
6fc6879b
JM
2452 /**
2453 * get_ifname - Get interface name
2454 * @priv: private driver interface data
2455 *
2456 * Returns: Pointer to the interface name. This can differ from the
e519314e 2457 * interface name used in init() call. Init() is called first.
6fc6879b
JM
2458 *
2459 * This optional function can be used to allow the driver interface to
2460 * replace the interface name with something else, e.g., based on an
2461 * interface mapping from a more descriptive name.
2462 */
2463 const char * (*get_ifname)(void *priv);
2464
2465 /**
2466 * get_mac_addr - Get own MAC address
2467 * @priv: private driver interface data
2468 *
2469 * Returns: Pointer to own MAC address or %NULL on failure
2470 *
2471 * This optional function can be used to get the own MAC address of the
2472 * device from the driver interface code. This is only needed if the
2473 * l2_packet implementation for the OS does not provide easy access to
2474 * a MAC address. */
2475 const u8 * (*get_mac_addr)(void *priv);
2476
6fc6879b
JM
2477 /**
2478 * set_operstate - Sets device operating state to DORMANT or UP
2479 * @priv: private driver interface data
2480 * @state: 0 = dormant, 1 = up
2481 * Returns: 0 on success, -1 on failure
2482 *
2483 * This is an optional function that can be used on operating systems
2484 * that support a concept of controlling network device state from user
2485 * space applications. This function, if set, gets called with
2486 * state = 1 when authentication has been completed and with state = 0
2487 * when connection is lost.
2488 */
2489 int (*set_operstate)(void *priv, int state);
2490
2491 /**
2492 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2493 * @priv: Private driver interface data
2494 * @addr: Address of the station for which to set protection (may be
2495 * %NULL for group keys)
2496 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2497 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2498 * Returns: 0 on success, -1 on failure
2499 *
2500 * This is an optional function that can be used to set the driver to
2501 * require protection for Tx and/or Rx frames. This uses the layer
2502 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2503 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2504 * set protection operation; instead, they set protection implicitly
2505 * based on configured keys.
2506 */
2507 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2508 int key_type);
2509
2510 /**
2511 * get_hw_feature_data - Get hardware support data (channels and rates)
2512 * @priv: Private driver interface data
2513 * @num_modes: Variable for returning the number of returned modes
2514 * flags: Variable for returning hardware feature flags
aa56e36d 2515 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
6fc6879b
JM
2516 * Returns: Pointer to allocated hardware data on success or %NULL on
2517 * failure. Caller is responsible for freeing this.
6fc6879b 2518 */
6caf9ca6
JM
2519 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2520 u16 *num_modes,
aa56e36d 2521 u16 *flags, u8 *dfs);
6fc6879b 2522
6fc6879b
JM
2523 /**
2524 * send_mlme - Send management frame from MLME
2525 * @priv: Private driver interface data
2526 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2527 * @data_len: Size of the management frame
8cfa3527 2528 * @noack: Do not wait for this frame to be acked (disable retries)
5d180a77
AO
2529 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2530 * driver decide
2d3943ce
AO
2531 * @csa_offs: Array of CSA offsets or %NULL
2532 * @csa_offs_len: Number of elements in csa_offs
6fc6879b 2533 * Returns: 0 on success, -1 on failure
6fc6879b 2534 */
8cfa3527 2535 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
2d3943ce
AO
2536 int noack, unsigned int freq, const u16 *csa_offs,
2537 size_t csa_offs_len);
6fc6879b 2538
6fc6879b
JM
2539 /**
2540 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2541 * @priv: Private driver interface data
2542 * @md: Mobility domain (2 octets) (also included inside ies)
2543 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2544 * @ies_len: Length of FT IEs in bytes
2545 * Returns: 0 on success, -1 on failure
2546 *
2547 * The supplicant uses this callback to let the driver know that keying
2548 * material for FT is available and that the driver can use the
2549 * provided IEs in the next message in FT authentication sequence.
2550 *
2551 * This function is only needed for driver that support IEEE 802.11r
2552 * (Fast BSS Transition).
2553 */
2554 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2555 size_t ies_len);
2556
6fc6879b
JM
2557 /**
2558 * get_scan_results2 - Fetch the latest scan results
2559 * @priv: private driver interface data
2560 *
2561 * Returns: Allocated buffer of scan results (caller is responsible for
2562 * freeing the data structure) on success, NULL on failure
2563 */
2564 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2565
6d158490
LR
2566 /**
2567 * set_country - Set country
2568 * @priv: Private driver interface data
2569 * @alpha2: country to which to switch to
2570 * Returns: 0 on success, -1 on failure
2571 *
2572 * This function is for drivers which support some form
2573 * of setting a regulatory domain.
2574 */
2575 int (*set_country)(void *priv, const char *alpha2);
ac305589 2576
f0793bf1
JM
2577 /**
2578 * get_country - Get country
2579 * @priv: Private driver interface data
2580 * @alpha2: Buffer for returning country code (at least 3 octets)
2581 * Returns: 0 on success, -1 on failure
2582 */
2583 int (*get_country)(void *priv, char *alpha2);
2584
ac305589
JM
2585 /**
2586 * global_init - Global driver initialization
45e3fc72 2587 * @ctx: wpa_global pointer
ac305589
JM
2588 * Returns: Pointer to private data (global), %NULL on failure
2589 *
2590 * This optional function is called to initialize the driver wrapper
2591 * for global data, i.e., data that applies to all interfaces. If this
2592 * function is implemented, global_deinit() will also need to be
2593 * implemented to free the private data. The driver will also likely
2594 * use init2() function instead of init() to get the pointer to global
2595 * data available to per-interface initializer.
2596 */
45e3fc72 2597 void * (*global_init)(void *ctx);
ac305589
JM
2598
2599 /**
2600 * global_deinit - Global driver deinitialization
2601 * @priv: private driver global data from global_init()
2602 *
2603 * Terminate any global driver related functionality and free the
2604 * global data structure.
2605 */
2606 void (*global_deinit)(void *priv);
2607
2608 /**
2609 * init2 - Initialize driver interface (with global data)
2610 * @ctx: context to be used when calling wpa_supplicant functions,
2611 * e.g., wpa_supplicant_event()
2612 * @ifname: interface name, e.g., wlan0
2613 * @global_priv: private driver global data from global_init()
2614 * Returns: Pointer to private data, %NULL on failure
2615 *
2616 * This function can be used instead of init() if the driver wrapper
2617 * uses global data.
2618 */
2619 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
4b4a8ae5
JM
2620
2621 /**
2622 * get_interfaces - Get information about available interfaces
2623 * @global_priv: private driver global data from global_init()
2624 * Returns: Allocated buffer of interface information (caller is
2625 * responsible for freeing the data structure) on success, NULL on
2626 * failure
2627 */
2628 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
fc2b7ed5
JM
2629
2630 /**
2631 * scan2 - Request the driver to initiate scan
2632 * @priv: private driver interface data
2633 * @params: Scan parameters
2634 *
2635 * Returns: 0 on success, -1 on failure
2636 *
2637 * Once the scan results are ready, the driver should report scan
2638 * results event for wpa_supplicant which will eventually request the
2639 * results with wpa_driver_get_scan_results2().
2640 */
2641 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
c2a04078
JM
2642
2643 /**
2644 * authenticate - Request driver to authenticate
2645 * @priv: private driver interface data
2646 * @params: authentication parameters
2647 * Returns: 0 on success, -1 on failure
2648 *
2649 * This is an optional function that can be used with drivers that
2650 * support separate authentication and association steps, i.e., when
2651 * wpa_supplicant can act as the SME. If not implemented, associate()
2652 * function is expected to take care of IEEE 802.11 authentication,
2653 * too.
2654 */
d2440ba0
JM
2655 int (*authenticate)(void *priv,
2656 struct wpa_driver_auth_params *params);
2657
15333707 2658 /**
19c3b566 2659 * set_ap - Set Beacon and Probe Response information for AP mode
15333707 2660 * @priv: Private driver interface data
19c3b566 2661 * @params: Parameters to use in AP mode
15333707 2662 *
19c3b566
JM
2663 * This function is used to configure Beacon template and/or extra IEs
2664 * to add for Beacon and Probe Response frames for the driver in
15333707
JM
2665 * AP mode. The driver is responsible for building the full Beacon
2666 * frame by concatenating the head part with TIM IE generated by the
19c3b566
JM
2667 * driver/firmware and finishing with the tail part. Depending on the
2668 * driver architectue, this can be done either by using the full
2669 * template or the set of additional IEs (e.g., WPS and P2P IE).
2670 * Similarly, Probe Response processing depends on the driver design.
2671 * If the driver (or firmware) takes care of replying to Probe Request
2672 * frames, the extra IEs provided here needs to be added to the Probe
2673 * Response frames.
2674 *
2675 * Returns: 0 on success, -1 on failure
15333707 2676 */
19c3b566 2677 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
c5121837 2678
3c4ca363
VN
2679 /**
2680 * set_acl - Set ACL in AP mode
2681 * @priv: Private driver interface data
2682 * @params: Parameters to configure ACL
2683 * Returns: 0 on success, -1 on failure
2684 *
2685 * This is used only for the drivers which support MAC address ACL.
2686 */
2687 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2688
15333707
JM
2689 /**
2690 * hapd_init - Initialize driver interface (hostapd only)
2691 * @hapd: Pointer to hostapd context
2692 * @params: Configuration for the driver wrapper
2693 * Returns: Pointer to private data, %NULL on failure
2694 *
2695 * This function is used instead of init() or init2() when the driver
ffbf1eaa 2696 * wrapper is used with hostapd.
15333707 2697 */
92f475b4
JM
2698 void * (*hapd_init)(struct hostapd_data *hapd,
2699 struct wpa_init_params *params);
15333707
JM
2700
2701 /**
2702 * hapd_deinit - Deinitialize driver interface (hostapd only)
2703 * @priv: Private driver interface data from hapd_init()
2704 */
c5121837
JM
2705 void (*hapd_deinit)(void *priv);
2706
2707 /**
15333707 2708 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
15333707 2709 * @priv: Private driver interface data
e3bd3912 2710 * @params: BSS parameters
c5121837
JM
2711 * Returns: 0 on success, -1 on failure
2712 *
15333707 2713 * This is an optional function to configure the kernel driver to
e3bd3912
JM
2714 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2715 * can be left undefined (set to %NULL) if IEEE 802.1X support is
dcd1eb5b 2716 * always enabled and the driver uses set_ap() to set WPA/RSN IE
e3bd3912 2717 * for Beacon frames.
062390ef
JM
2718 *
2719 * DEPRECATED - use set_ap() instead
c5121837 2720 */
e3bd3912 2721 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
c5121837
JM
2722
2723 /**
15333707
JM
2724 * set_privacy - Enable/disable privacy (AP only)
2725 * @priv: Private driver interface data
c5121837 2726 * @enabled: 1 = privacy enabled, 0 = disabled
15333707 2727 * Returns: 0 on success, -1 on failure
c5121837 2728 *
15333707
JM
2729 * This is an optional function to configure privacy field in the
2730 * kernel driver for Beacon frames. This can be left undefined (set to
dcd1eb5b 2731 * %NULL) if the driver uses the Beacon template from set_ap().
062390ef
JM
2732 *
2733 * DEPRECATED - use set_ap() instead
c5121837 2734 */
d5dd016a 2735 int (*set_privacy)(void *priv, int enabled);
c5121837 2736
15333707
JM
2737 /**
2738 * get_seqnum - Fetch the current TSC/packet number (AP only)
2739 * @ifname: The interface name (main or virtual)
2740 * @priv: Private driver interface data
2741 * @addr: MAC address of the station or %NULL for group keys
2742 * @idx: Key index
2743 * @seq: Buffer for returning the latest used TSC/packet number
2744 * Returns: 0 on success, -1 on failure
2745 *
2746 * This function is used to fetch the last used TSC/packet number for
eb7719ff
JM
2747 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2748 * keys, so there is no strict requirement on implementing support for
2749 * unicast keys (i.e., addr != %NULL).
15333707 2750 */
c5121837
JM
2751 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2752 int idx, u8 *seq);
15333707 2753
15333707
JM
2754 /**
2755 * flush - Flush all association stations (AP only)
2756 * @priv: Private driver interface data
2757 * Returns: 0 on success, -1 on failure
2758 *
2759 * This function requests the driver to disassociate all associated
2760 * stations. This function does not need to be implemented if the
2761 * driver does not process association frames internally.
2762 */
c5121837 2763 int (*flush)(void *priv);
15333707
JM
2764
2765 /**
2766 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
15333707
JM
2767 * @priv: Private driver interface data
2768 * @elem: Information elements
2769 * @elem_len: Length of the elem buffer in octets
2770 * Returns: 0 on success, -1 on failure
2771 *
2772 * This is an optional function to add information elements in the
2773 * kernel driver for Beacon and Probe Response frames. This can be left
2774 * undefined (set to %NULL) if the driver uses the Beacon template from
dcd1eb5b 2775 * set_ap().
062390ef
JM
2776 *
2777 * DEPRECATED - use set_ap() instead
15333707 2778 */
aa484516 2779 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
c5121837 2780
15333707 2781 /**
d732463c 2782 * read_sta_data - Fetch station data
15333707
JM
2783 * @priv: Private driver interface data
2784 * @data: Buffer for returning station information
2785 * @addr: MAC address of the station
2786 * Returns: 0 on success, -1 on failure
2787 */
c5121837
JM
2788 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2789 const u8 *addr);
15333707
JM
2790
2791 /**
2792 * hapd_send_eapol - Send an EAPOL packet (AP only)
2793 * @priv: private driver interface data
2794 * @addr: Destination MAC address
2795 * @data: EAPOL packet starting with IEEE 802.1X header
2796 * @data_len: Length of the EAPOL packet in octets
2797 * @encrypt: Whether the frame should be encrypted
2798 * @own_addr: Source MAC address
4378fc14 2799 * @flags: WPA_STA_* flags for the destination station
15333707
JM
2800 *
2801 * Returns: 0 on success, -1 on failure
2802 */
c5121837
JM
2803 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2804 size_t data_len, int encrypt,
4378fc14 2805 const u8 *own_addr, u32 flags);
15333707 2806
90b8c4c5
JM
2807 /**
2808 * sta_deauth - Deauthenticate a station (AP only)
2809 * @priv: Private driver interface data
2810 * @own_addr: Source address and BSSID for the Deauthentication frame
2811 * @addr: MAC address of the station to deauthenticate
2812 * @reason: Reason code for the Deauthentiation frame
2813 * Returns: 0 on success, -1 on failure
2814 *
2815 * This function requests a specific station to be deauthenticated and
2816 * a Deauthentication frame to be sent to it.
2817 */
731723a5 2818 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
4be17ffb 2819 u16 reason);
90b8c4c5
JM
2820
2821 /**
2822 * sta_disassoc - Disassociate a station (AP only)
2823 * @priv: Private driver interface data
2824 * @own_addr: Source address and BSSID for the Disassociation frame
2825 * @addr: MAC address of the station to disassociate
2826 * @reason: Reason code for the Disassociation frame
2827 * Returns: 0 on success, -1 on failure
2828 *
2829 * This function requests a specific station to be disassociated and
2830 * a Disassociation frame to be sent to it.
2831 */
731723a5 2832 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
4be17ffb 2833 u16 reason);
90b8c4c5
JM
2834
2835 /**
2836 * sta_remove - Remove a station entry (AP only)
2837 * @priv: Private driver interface data
2838 * @addr: MAC address of the station to be removed
2839 * Returns: 0 on success, -1 on failure
2840 */
c5121837 2841 int (*sta_remove)(void *priv, const u8 *addr);
90b8c4c5
JM
2842
2843 /**
2844 * hapd_get_ssid - Get the current SSID (AP only)
90b8c4c5
JM
2845 * @priv: Private driver interface data
2846 * @buf: Buffer for returning the SSID
2847 * @len: Maximum length of the buffer
2848 * Returns: Length of the SSID on success, -1 on failure
2849 *
2850 * This function need not be implemented if the driver uses Beacon
dcd1eb5b 2851 * template from set_ap() and does not reply to Probe Request frames.
90b8c4c5 2852 */
8709de1a 2853 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
90b8c4c5
JM
2854
2855 /**
2856 * hapd_set_ssid - Set SSID (AP only)
90b8c4c5
JM
2857 * @priv: Private driver interface data
2858 * @buf: SSID
2859 * @len: Length of the SSID in octets
2860 * Returns: 0 on success, -1 on failure
062390ef
JM
2861 *
2862 * DEPRECATED - use set_ap() instead
90b8c4c5 2863 */
8709de1a
JM
2864 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2865
90b8c4c5
JM
2866 /**
2867 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2868 * @priv: Private driver interface data
2869 * @enabled: 1 = countermeasures enabled, 0 = disabled
2870 * Returns: 0 on success, -1 on failure
2871 *
2872 * This need not be implemented if the driver does not take care of
2873 * association processing.
2874 */
c5121837 2875 int (*hapd_set_countermeasures)(void *priv, int enabled);
90b8c4c5
JM
2876
2877 /**
2878 * sta_add - Add a station entry
90b8c4c5
JM
2879 * @priv: Private driver interface data
2880 * @params: Station parameters
2881 * Returns: 0 on success, -1 on failure
2882 *
dc55b6b6
AB
2883 * This function is used to add or set (params->set 1) a station
2884 * entry in the driver. Adding STA entries is used only if the driver
90b8c4c5 2885 * does not take care of association processing.
45b722f1 2886 *
dc55b6b6
AB
2887 * With drivers that don't support full AP client state, this function
2888 * is used to add a station entry to the driver once the station has
2889 * completed association.
2890 *
2891 * With TDLS, this function is used to add or set (params->set 1)
2892 * TDLS peer entries (even with drivers that do not support full AP
2893 * client state).
90b8c4c5 2894 */
62847751 2895 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
90b8c4c5
JM
2896
2897 /**
2898 * get_inact_sec - Get station inactivity duration (AP only)
2899 * @priv: Private driver interface data
2900 * @addr: Station address
2901 * Returns: Number of seconds station has been inactive, -1 on failure
2902 */
c5121837 2903 int (*get_inact_sec)(void *priv, const u8 *addr);
90b8c4c5
JM
2904
2905 /**
2906 * sta_clear_stats - Clear station statistics (AP only)
2907 * @priv: Private driver interface data
2908 * @addr: Station address
2909 * Returns: 0 on success, -1 on failure
2910 */
c5121837
JM
2911 int (*sta_clear_stats)(void *priv, const u8 *addr);
2912
90b8c4c5
JM
2913 /**
2914 * set_freq - Set channel/frequency (AP only)
2915 * @priv: Private driver interface data
2916 * @freq: Channel parameters
2917 * Returns: 0 on success, -1 on failure
2918 */
c5121837 2919 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
90b8c4c5
JM
2920
2921 /**
2922 * set_rts - Set RTS threshold
2923 * @priv: Private driver interface data
2924 * @rts: RTS threshold in octets
2925 * Returns: 0 on success, -1 on failure
2926 */
c5121837 2927 int (*set_rts)(void *priv, int rts);
90b8c4c5
JM
2928
2929 /**
2930 * set_frag - Set fragmentation threshold
2931 * @priv: Private driver interface data
2932 * @frag: Fragmentation threshold in octets
2933 * Returns: 0 on success, -1 on failure
2934 */
c5121837 2935 int (*set_frag)(void *priv, int frag);
c5121837 2936
90b8c4c5
JM
2937 /**
2938 * sta_set_flags - Set station flags (AP only)
2939 * @priv: Private driver interface data
2940 * @addr: Station address
0de39516
JM
2941 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2942 * @flags_or: Bitmap of WPA_STA_* flags to add
2943 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
90b8c4c5
JM
2944 * Returns: 0 on success, -1 on failure
2945 */
3234cba4 2946 int (*sta_set_flags)(void *priv, const u8 *addr,
f97e3ce4
JM
2947 unsigned int total_flags, unsigned int flags_or,
2948 unsigned int flags_and);
90b8c4c5 2949
90b8c4c5
JM
2950 /**
2951 * set_tx_queue_params - Set TX queue parameters
2952 * @priv: Private driver interface data
7e3c1781 2953 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
90b8c4c5
JM
2954 * @aifs: AIFS
2955 * @cw_min: cwMin
2956 * @cw_max: cwMax
2957 * @burst_time: Maximum length for bursting in 0.1 msec units
2958 */
c5121837
JM
2959 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2960 int cw_max, int burst_time);
90b8c4c5 2961
22a7c9d7
JM
2962 /**
2963 * if_add - Add a virtual interface
15333707 2964 * @priv: Private driver interface data
22a7c9d7
JM
2965 * @type: Interface type
2966 * @ifname: Interface name for the new virtual interface
2967 * @addr: Local address to use for the interface or %NULL to use the
2968 * parent interface address
8043e725 2969 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
a2e40bb6
FF
2970 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2971 * not allowed (applies only to %WPA_IF_AP_BSS type)
f3585c8a
JM
2972 * @force_ifname: Buffer for returning an interface name that the
2973 * driver ended up using if it differs from the requested ifname
2974 * @if_addr: Buffer for returning the allocated interface address
2975 * (this may differ from the requested addr if the driver cannot
2976 * change interface address)
e17a2477 2977 * @bridge: Bridge interface to use or %NULL if no bridge configured
2aec4f3c 2978 * @use_existing: Whether to allow existing interface to be used
d8a3b66d 2979 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
22a7c9d7
JM
2980 * Returns: 0 on success, -1 on failure
2981 */
7ab68865
JM
2982 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2983 const char *ifname, const u8 *addr, void *bss_ctx,
e17a2477 2984 void **drv_priv, char *force_ifname, u8 *if_addr,
d8a3b66d 2985 const char *bridge, int use_existing, int setup_ap);
22a7c9d7
JM
2986
2987 /**
2988 * if_remove - Remove a virtual interface
2989 * @priv: Private driver interface data
2990 * @type: Interface type
2991 * @ifname: Interface name of the virtual interface to be removed
2992 * Returns: 0 on success, -1 on failure
2993 */
2994 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2995 const char *ifname);
90b8c4c5 2996
15333707
JM
2997 /**
2998 * set_sta_vlan - Bind a station into a specific interface (AP only)
2999 * @priv: Private driver interface data
3000 * @ifname: Interface (main or virtual BSS or VLAN)
3001 * @addr: MAC address of the associated station
3002 * @vlan_id: VLAN ID
3003 * Returns: 0 on success, -1 on failure
3004 *
3005 * This function is used to bind a station to a specific virtual
3006 * interface. It is only used if when virtual interfaces are supported,
3007 * e.g., to assign stations to different VLAN interfaces based on
3008 * information from a RADIUS server. This allows separate broadcast
3009 * domains to be used with a single BSS.
3010 */
c5121837
JM
3011 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
3012 int vlan_id);
15333707 3013
c5121837 3014 /**
15333707 3015 * commit - Optional commit changes handler (AP only)
c5121837
JM
3016 * @priv: driver private data
3017 * Returns: 0 on success, -1 on failure
3018 *
3019 * This optional handler function can be registered if the driver
3020 * interface implementation needs to commit changes (e.g., by setting
3021 * network interface up) at the end of initial configuration. If set,
3022 * this handler will be called after initial setup has been completed.
3023 */
3024 int (*commit)(void *priv);
3025
90b8c4c5
JM
3026 /**
3027 * send_ether - Send an ethernet packet (AP only)
3028 * @priv: private driver interface data
3029 * @dst: Destination MAC address
3030 * @src: Source MAC address
3031 * @proto: Ethertype
3032 * @data: EAPOL packet starting with IEEE 802.1X header
3033 * @data_len: Length of the EAPOL packet in octets
3034 * Returns: 0 on success, -1 on failure
3035 */
c5121837
JM
3036 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
3037 const u8 *data, size_t data_len);
3038
90b8c4c5
JM
3039 /**
3040 * set_radius_acl_auth - Notification of RADIUS ACL change
3041 * @priv: Private driver interface data
3042 * @mac: MAC address of the station
3043 * @accepted: Whether the station was accepted
3044 * @session_timeout: Session timeout for the station
3045 * Returns: 0 on success, -1 on failure
3046 */
0e80ea2c 3047 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
c5121837 3048 u32 session_timeout);
90b8c4c5
JM
3049
3050 /**
3051 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3052 * @priv: Private driver interface data
3053 * @mac: MAC address of the station
3054 * Returns: 0 on success, -1 on failure
3055 */
c5121837
JM
3056 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
3057
15333707 3058 /**
b3db190f 3059 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
15333707 3060 * @priv: Private driver interface data
b3db190f
JM
3061 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3062 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3063 * extra IE(s)
0e2e565a
JM
3064 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3065 * to remove extra IE(s)
15333707
JM
3066 * Returns: 0 on success, -1 on failure
3067 *
3068 * This is an optional function to add WPS IE in the kernel driver for
14f79386 3069 * Beacon and Probe Response frames. This can be left undefined (set
dcd1eb5b 3070 * to %NULL) if the driver uses the Beacon template from set_ap()
0e2e565a
JM
3071 * and does not process Probe Request frames. If the driver takes care
3072 * of (Re)Association frame processing, the assocresp buffer includes
3073 * WPS IE(s) that need to be added to (Re)Association Response frames
3074 * whenever a (Re)Association Request frame indicated use of WPS.
75bde05d
JM
3075 *
3076 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3077 * frames when operating as a GO. The driver is responsible for adding
3078 * timing related attributes (e.g., NoA) in addition to the IEs
3079 * included here by appending them after these buffers. This call is
3080 * also used to provide Probe Response IEs for P2P Listen state
3081 * operations for drivers that generate the Probe Response frames
3082 * internally.
062390ef
JM
3083 *
3084 * DEPRECATED - use set_ap() instead
15333707 3085 */
0ebdf627 3086 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
0e2e565a
JM
3087 const struct wpabuf *proberesp,
3088 const struct wpabuf *assocresp);
4bc181ec
JM
3089
3090 /**
3091 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3092 * @priv: Private driver interface data
3093 * @authorized: Whether the port is authorized
3094 * Returns: 0 on success, -1 on failure
3095 */
3096 int (*set_supp_port)(void *priv, int authorized);
fbbfcbac
FF
3097
3098 /**
3099 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3100 * @priv: Private driver interface data
3101 * @addr: MAC address of the associated station
3102 * @aid: Association ID
3103 * @val: 1 = bind to 4-address WDS; 0 = unbind
d38ae2ea
FF
3104 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3105 * to indicate that bridge is not to be used
69dd2967
SM
3106 * @ifname_wds: Buffer to return the interface name for the new WDS
3107 * station or %NULL to indicate name is not returned.
fbbfcbac
FF
3108 * Returns: 0 on success, -1 on failure
3109 */
d38ae2ea 3110 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
0e80ea2c 3111 const char *bridge_ifname, char *ifname_wds);
504e905c 3112
55777702
JM
3113 /**
3114 * send_action - Transmit an Action frame
3115 * @priv: Private driver interface data
3116 * @freq: Frequency (in MHz) of the channel
190b9062 3117 * @wait: Time to wait off-channel for a response (in ms), or zero
e8828999
JM
3118 * @dst: Destination MAC address (Address 1)
3119 * @src: Source MAC address (Address 2)
3120 * @bssid: BSSID (Address 3)
55777702
JM
3121 * @data: Frame body
3122 * @data_len: data length in octets
b106173a 3123 @ @no_cck: Whether CCK rates must not be used to transmit this frame
55777702
JM
3124 * Returns: 0 on success, -1 on failure
3125 *
3126 * This command can be used to request the driver to transmit an action
190b9062
JB
3127 * frame to the specified destination.
3128 *
3129 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3130 * be transmitted on the given channel and the device will wait for a
3131 * response on that channel for the given wait time.
3132 *
3133 * If the flag is not set, the wait time will be ignored. In this case,
3134 * if a remain-on-channel duration is in progress, the frame must be
3135 * transmitted on that channel; alternatively the frame may be sent on
3136 * the current operational channel (if in associated state in station
3137 * mode or while operating as an AP.)
8331c9b3
VK
3138 *
3139 * If @src differs from the device MAC address, use of a random
3140 * transmitter address is requested for this message exchange.
55777702 3141 */
190b9062 3142 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
e8828999 3143 const u8 *dst, const u8 *src, const u8 *bssid,
b106173a 3144 const u8 *data, size_t data_len, int no_cck);
55777702 3145
190b9062
JB
3146 /**
3147 * send_action_cancel_wait - Cancel action frame TX wait
3148 * @priv: Private driver interface data
3149 *
3150 * This command cancels the wait time associated with sending an action
3151 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3152 * set in the driver flags.
3153 */
3154 void (*send_action_cancel_wait)(void *priv);
3155
55777702
JM
3156 /**
3157 * remain_on_channel - Remain awake on a channel
3158 * @priv: Private driver interface data
3159 * @freq: Frequency (in MHz) of the channel
3160 * @duration: Duration in milliseconds
3161 * Returns: 0 on success, -1 on failure
3162 *
3163 * This command is used to request the driver to remain awake on the
3164 * specified channel for the specified duration and report received
dbfb8e82 3165 * Action frames with EVENT_RX_MGMT events. Optionally, received
55777702
JM
3166 * Probe Request frames may also be requested to be reported by calling
3167 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3168 *
3169 * The driver may not be at the requested channel when this function
3170 * returns, i.e., the return code is only indicating whether the
3171 * request was accepted. The caller will need to wait until the
3172 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3173 * completed the channel change. This may take some time due to other
3174 * need for the radio and the caller should be prepared to timing out
3175 * its wait since there are no guarantees on when this request can be
3176 * executed.
3177 */
3178 int (*remain_on_channel)(void *priv, unsigned int freq,
3179 unsigned int duration);
3180
3181 /**
3182 * cancel_remain_on_channel - Cancel remain-on-channel operation
3183 * @priv: Private driver interface data
3184 *
3185 * This command can be used to cancel a remain-on-channel operation
3186 * before its originally requested duration has passed. This could be
3187 * used, e.g., when remain_on_channel() is used to request extra time
3188 * to receive a response to an Action frame and the response is
3189 * received when there is still unneeded time remaining on the
3190 * remain-on-channel operation.
3191 */
3192 int (*cancel_remain_on_channel)(void *priv);
3193
504e905c
JM
3194 /**
3195 * probe_req_report - Request Probe Request frames to be indicated
3196 * @priv: Private driver interface data
3197 * @report: Whether to report received Probe Request frames
3198 * Returns: 0 on success, -1 on failure (or if not supported)
3199 *
3200 * This command can be used to request the driver to indicate when
3201 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3202 * Since this operation may require extra resources, e.g., due to less
3203 * optimal hardware/firmware RX filtering, many drivers may disable
3204 * Probe Request reporting at least in station mode. This command is
3205 * used to notify the driver when the Probe Request frames need to be
3206 * reported, e.g., during remain-on-channel operations.
3207 */
3208 int (*probe_req_report)(void *priv, int report);
4e5cb1a3 3209
af473088
JM
3210 /**
3211 * deinit_ap - Deinitialize AP mode
3212 * @priv: Private driver interface data
3213 * Returns: 0 on success, -1 on failure (or if not supported)
3214 *
3215 * This optional function can be used to disable AP mode related
60b13c20
IP
3216 * configuration. If the interface was not dynamically added,
3217 * change the driver mode to station mode to allow normal station
3218 * operations like scanning to be completed.
af473088
JM
3219 */
3220 int (*deinit_ap)(void *priv);
207ef3fb 3221
3c29244e
EP
3222 /**
3223 * deinit_p2p_cli - Deinitialize P2P client mode
3224 * @priv: Private driver interface data
3225 * Returns: 0 on success, -1 on failure (or if not supported)
3226 *
60b13c20
IP
3227 * This optional function can be used to disable P2P client mode. If the
3228 * interface was not dynamically added, change the interface type back
3229 * to station mode.
3c29244e
EP
3230 */
3231 int (*deinit_p2p_cli)(void *priv);
3232
207ef3fb
JM
3233 /**
3234 * suspend - Notification on system suspend/hibernate event
3235 * @priv: Private driver interface data
3236 */
3237 void (*suspend)(void *priv);
3238
3239 /**
3240 * resume - Notification on system resume/thaw event
3241 * @priv: Private driver interface data
3242 */
3243 void (*resume)(void *priv);
b625473c
JM
3244
3245 /**
3246 * signal_monitor - Set signal monitoring parameters
3247 * @priv: Private driver interface data
3248 * @threshold: Threshold value for signal change events; 0 = disabled
3249 * @hysteresis: Minimum change in signal strength before indicating a
3250 * new event
3251 * Returns: 0 on success, -1 on failure (or if not supported)
3252 *
3253 * This function can be used to configure monitoring of signal strength
3254 * with the current AP. Whenever signal strength drops below the
3255 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3256 * should be generated assuming the signal strength has changed at
3257 * least %hysteresis from the previously indicated signal change event.
3258 */
3259 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
b91ab76e
JM
3260
3261 /**
3262 * send_frame - Send IEEE 802.11 frame (testing use only)
3263 * @priv: Private driver interface data
3264 * @data: IEEE 802.11 frame with IEEE 802.11 header
3265 * @data_len: Size of the frame
3266 * @encrypt: Whether to encrypt the frame (if keys are set)
3267 * Returns: 0 on success, -1 on failure
3268 *
3269 * This function is only used for debugging purposes and is not
3270 * required to be implemented for normal operations.
3271 */
3272 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
3273 int encrypt);
75bde05d 3274
75bde05d
JM
3275 /**
3276 * get_noa - Get current Notice of Absence attribute payload
3277 * @priv: Private driver interface data
3278 * @buf: Buffer for returning NoA
3279 * @buf_len: Buffer length in octets
3280 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3281 * advertized, or -1 on failure
3282 *
3283 * This function is used to fetch the current Notice of Absence
3284 * attribute value from GO.
3285 */
3286 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
3287
3288 /**
3289 * set_noa - Set Notice of Absence parameters for GO (testing)
3290 * @priv: Private driver interface data
3291 * @count: Count
3292 * @start: Start time in ms from next TBTT
3293 * @duration: Duration in ms
3294 * Returns: 0 on success or -1 on failure
3295 *
3296 * This function is used to set Notice of Absence parameters for GO. It
3297 * is used only for testing. To disable NoA, all parameters are set to
3298 * 0.
3299 */
3300 int (*set_noa)(void *priv, u8 count, int start, int duration);
c381508d
JM
3301
3302 /**
3303 * set_p2p_powersave - Set P2P power save options
3304 * @priv: Private driver interface data
3305 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3306 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3307 * @ctwindow: 0.. = change (msec), -1 = no change
3308 * Returns: 0 on success or -1 on failure
3309 */
3310 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
3311 int ctwindow);
b6c79a99
JM
3312
3313 /**
3314 * ampdu - Enable/disable aggregation
3315 * @priv: Private driver interface data
3316 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3317 * Returns: 0 on success or -1 on failure
3318 */
3319 int (*ampdu)(void *priv, int ampdu);
0f66abd2 3320
6859f1cb
BG
3321 /**
3322 * get_radio_name - Get physical radio name for the device
3323 * @priv: Private driver interface data
3324 * Returns: Radio name or %NULL if not known
3325 *
3326 * The returned data must not be modified by the caller. It is assumed
3327 * that any interface that has the same radio name as another is
3328 * sharing the same physical radio. This information can be used to
3329 * share scan results etc. information between the virtual interfaces
3330 * to speed up various operations.
3331 */
3332 const char * (*get_radio_name)(void *priv);
3ac17eba 3333
281ff0aa
GP
3334 /**
3335 * send_tdls_mgmt - for sending TDLS management packets
3336 * @priv: private driver interface data
3337 * @dst: Destination (peer) MAC address
3338 * @action_code: TDLS action code for the mssage
3339 * @dialog_token: Dialog Token to use in the message (if needed)
3340 * @status_code: Status Code or Reason Code to use (if needed)
96ecea5e 3341 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
984dadc2 3342 * @initiator: Is the current end the TDLS link initiator
281ff0aa
GP
3343 * @buf: TDLS IEs to add to the message
3344 * @len: Length of buf in octets
45b722f1 3345 * Returns: 0 on success, negative (<0) on failure
281ff0aa
GP
3346 *
3347 * This optional function can be used to send packet to driver which is
3348 * responsible for receiving and sending all TDLS packets.
3349 */
3350 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
96ecea5e 3351 u8 dialog_token, u16 status_code, u32 peer_capab,
984dadc2 3352 int initiator, const u8 *buf, size_t len);
281ff0aa 3353
45b722f1
AN
3354 /**
3355 * tdls_oper - Ask the driver to perform high-level TDLS operations
3356 * @priv: Private driver interface data
3357 * @oper: TDLS high-level operation. See %enum tdls_oper
3358 * @peer: Destination (peer) MAC address
3359 * Returns: 0 on success, negative (<0) on failure
3360 *
3361 * This optional function can be used to send high-level TDLS commands
3362 * to the driver.
3363 */
281ff0aa 3364 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
1c5c7273 3365
a884be9d
XC
3366 /**
3367 * wnm_oper - Notify driver of the WNM frame reception
3368 * @priv: Private driver interface data
3369 * @oper: WNM operation. See %enum wnm_oper
3370 * @peer: Destination (peer) MAC address
3371 * @buf: Buffer for the driver to fill in (for getting IE)
3372 * @buf_len: Return the len of buf
3373 * Returns: 0 on success, negative (<0) on failure
3374 */
3375 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
3376 u8 *buf, u16 *buf_len);
3377
c551700f
KP
3378 /**
3379 * set_qos_map - Set QoS Map
3380 * @priv: Private driver interface data
3381 * @qos_map_set: QoS Map
3382 * @qos_map_set_len: Length of QoS Map
3383 */
3384 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
3385 u8 qos_map_set_len);
3386
71103bed
KP
3387 /**
3388 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3389 * @priv: Private driver interface data
ed4ddb6d
KP
3390 * @version: IP version of the IP address, 4 or 6
3391 * @ipaddr: IP address for the neigh entry
3392 * @prefixlen: IP address prefix length
71103bed
KP
3393 * @addr: Corresponding MAC address
3394 * Returns: 0 on success, negative (<0) on failure
3395 */
ed4ddb6d
KP
3396 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
3397 int prefixlen, const u8 *addr);
71103bed
KP
3398
3399 /**
3400 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3401 * @priv: Private driver interface data
ed4ddb6d
KP
3402 * @version: IP version of the IP address, 4 or 6
3403 * @ipaddr: IP address for the neigh entry
71103bed
KP
3404 * Returns: 0 on success, negative (<0) on failure
3405 */
ed4ddb6d 3406 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
71103bed 3407
73d2294f
KP
3408 /**
3409 * br_port_set_attr - Set a bridge port attribute
3410 * @attr: Bridge port attribute to set
3411 * @val: Value to be set
3412 * Returns: 0 on success, negative (<0) on failure
3413 */
3414 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
3415 unsigned int val);
3416
7565752d
KP
3417 /**
3418 * br_port_set_attr - Set a bridge network parameter
3419 * @param: Bridge parameter to set
3420 * @val: Value to be set
3421 * Returns: 0 on success, negative (<0) on failure
3422 */
3423 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
3424 unsigned int val);
3425
e4fa8b12
EP
3426 /**
3427 * set_wowlan - Set wake-on-wireless triggers
3428 * @priv: Private driver interface data
3429 * @triggers: wowlan triggers
3430 */
3431 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
3432
1c5c7273
PS
3433 /**
3434 * signal_poll - Get current connection information
3435 * @priv: Private driver interface data
3436 * @signal_info: Connection info structure
0e80ea2c 3437 */
1c5c7273 3438 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
41fd1d9e 3439
7f00dc6e
MV
3440 /**
3441 * channel_info - Get parameters of the current operating channel
3442 * @priv: Private driver interface data
3443 * @channel_info: Channel info structure
3444 * Returns: 0 on success, negative (<0) on failure
3445 */
3446 int (*channel_info)(void *priv, struct wpa_channel_info *channel_info);
3447
41fd1d9e
KZ
3448 /**
3449 * set_authmode - Set authentication algorithm(s) for static WEP
3450 * @priv: Private driver interface data
3451 * @authmode: 1=Open System, 2=Shared Key, 3=both
3452 * Returns: 0 on success, -1 on failure
3453 *
3454 * This function can be used to set authentication algorithms for AP
3455 * mode when static WEP is used. If the driver uses user space MLME/SME
3456 * implementation, there is no need to implement this function.
062390ef
JM
3457 *
3458 * DEPRECATED - use set_ap() instead
41fd1d9e
KZ
3459 */
3460 int (*set_authmode)(void *priv, int authmode);
b14a210c 3461
5e2c3490
JM
3462#ifdef ANDROID
3463 /**
3464 * driver_cmd - Execute driver-specific command
3465 * @priv: Private driver interface data
3466 * @cmd: Command to execute
3467 * @buf: Return buffer
3468 * @buf_len: Buffer length
3469 * Returns: 0 on success, -1 on failure
3470 */
3471 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
3472#endif /* ANDROID */
3473
adef8948
BL
3474 /**
3475 * vendor_cmd - Execute vendor specific command
3476 * @priv: Private driver interface data
3477 * @vendor_id: Vendor id
3478 * @subcmd: Vendor command id
3479 * @data: Vendor command parameters (%NULL if no parameters)
3480 * @data_len: Data length
3481 * @buf: Return buffer (%NULL to ignore reply)
3482 * Returns: 0 on success, negative (<0) on failure
3483 *
3484 * This function handles vendor specific commands that are passed to
3485 * the driver/device. The command is identified by vendor id and
3486 * command id. Parameters can be passed as argument to the command
3487 * in the data buffer. Reply (if any) will be filled in the supplied
3488 * return buffer.
3489 *
3490 * The exact driver behavior is driver interface and vendor specific. As
3491 * an example, this will be converted to a vendor specific cfg80211
3492 * command in case of the nl80211 driver interface.
3493 */
3494 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3495 unsigned int subcmd, const u8 *data, size_t data_len,
3496 struct wpabuf *buf);
3497
b14a210c
JB
3498 /**
3499 * set_rekey_info - Set rekey information
3500 * @priv: Private driver interface data
3501 * @kek: Current KEK
98cd3d1c 3502 * @kek_len: KEK length in octets
b14a210c 3503 * @kck: Current KCK
98cd3d1c 3504 * @kck_len: KCK length in octets
b14a210c
JB
3505 * @replay_ctr: Current EAPOL-Key Replay Counter
3506 *
3507 * This optional function can be used to provide information for the
3508 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3509 * while the host (including wpa_supplicant) is sleeping.
3510 */
98cd3d1c
JM
3511 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3512 const u8 *kck, size_t kck_len,
b14a210c 3513 const u8 *replay_ctr);
a52eba0f
SP
3514
3515 /**
3516 * sta_assoc - Station association indication
3517 * @priv: Private driver interface data
3518 * @own_addr: Source address and BSSID for association frame
3519 * @addr: MAC address of the station to associate
3520 * @reassoc: flag to indicate re-association
3521 * @status: association response status code
3522 * @ie: assoc response ie buffer
3523 * @len: ie buffer length
3524 * Returns: 0 on success, -1 on failure
3525 *
3526 * This function indicates the driver to send (Re)Association
3527 * Response frame to the station.
3528 */
3529 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3530 int reassoc, u16 status, const u8 *ie, size_t len);
3531
3532 /**
3533 * sta_auth - Station authentication indication
6b128fb2
JM
3534 * @priv: private driver interface data
3535 * @params: Station authentication parameters
a52eba0f 3536 *
6b128fb2 3537 * Returns: 0 on success, -1 on failure
a52eba0f 3538 */
6b128fb2
JM
3539 int (*sta_auth)(void *priv,
3540 struct wpa_driver_sta_auth_params *params);
a52eba0f
SP
3541
3542 /**
3543 * add_tspec - Add traffic stream
3544 * @priv: Private driver interface data
3545 * @addr: MAC address of the station to associate
3546 * @tspec_ie: tspec ie buffer
3547 * @tspec_ielen: tspec ie length
3548 * Returns: 0 on success, -1 on failure
3549 *
3550 * This function adds the traffic steam for the station
3551 * and fills the medium_time in tspec_ie.
3552 */
3553 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3554 size_t tspec_ielen);
3555
3556 /**
3557 * add_sta_node - Add a station node in the driver
3558 * @priv: Private driver interface data
3559 * @addr: MAC address of the station to add
3560 * @auth_alg: authentication algorithm used by the station
3561 * Returns: 0 on success, -1 on failure
3562 *
3563 * This function adds the station node in the driver, when
3564 * the station gets added by FT-over-DS.
3565 */
3566 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
cbdf3507
LC
3567
3568 /**
3569 * sched_scan - Request the driver to initiate scheduled scan
3570 * @priv: Private driver interface data
3571 * @params: Scan parameters
cbdf3507
LC
3572 * Returns: 0 on success, -1 on failure
3573 *
3574 * This operation should be used for scheduled scan offload to
3575 * the hardware. Every time scan results are available, the
3576 * driver should report scan results event for wpa_supplicant
3577 * which will eventually request the results with
3578 * wpa_driver_get_scan_results2(). This operation is optional
3579 * and if not provided or if it returns -1, we fall back to
3580 * normal host-scheduled scans.
3581 */
09ea4309 3582 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
cbdf3507
LC
3583
3584 /**
3585 * stop_sched_scan - Request the driver to stop a scheduled scan
3586 * @priv: Private driver interface data
3587 * Returns: 0 on success, -1 on failure
3588 *
3589 * This should cause the scheduled scan to be stopped and
3590 * results should stop being sent. Must be supported if
3591 * sched_scan is supported.
3592 */
3593 int (*stop_sched_scan)(void *priv);
bcf24348
JB
3594
3595 /**
3596 * poll_client - Probe (null data or such) the given station
3597 * @priv: Private driver interface data
3598 * @own_addr: MAC address of sending interface
3599 * @addr: MAC address of the station to probe
3600 * @qos: Indicates whether station is QoS station
3601 *
3602 * This function is used to verify whether an associated station is
3603 * still present. This function does not need to be implemented if the
3604 * driver provides such inactivity polling mechanism.
3605 */
3606 void (*poll_client)(void *priv, const u8 *own_addr,
3607 const u8 *addr, int qos);
8b9d0bfa
JM
3608
3609 /**
3610 * radio_disable - Disable/enable radio
3611 * @priv: Private driver interface data
3612 * @disabled: 1=disable 0=enable radio
3613 * Returns: 0 on success, -1 on failure
3614 *
3615 * This optional command is for testing purposes. It can be used to
3616 * disable the radio on a testbed device to simulate out-of-radio-range
3617 * conditions.
3618 */
3619 int (*radio_disable)(void *priv, int disabled);
ef35f5a0
JJ
3620
3621 /**
3622 * switch_channel - Announce channel switch and migrate the GO to the
3623 * given frequency
3624 * @priv: Private driver interface data
dcca2219 3625 * @settings: Settings for CSA period and new channel
ef35f5a0
JJ
3626 * Returns: 0 on success, -1 on failure
3627 *
3628 * This function is used to move the GO to the legacy STA channel to
3629 * avoid frequency conflict in single channel concurrency.
3630 */
dcca2219 3631 int (*switch_channel)(void *priv, struct csa_settings *settings);
f90e9c1c 3632
471cd6e1
MB
3633 /**
3634 * add_tx_ts - Add traffic stream
3635 * @priv: Private driver interface data
3636 * @tsid: Traffic stream ID
3637 * @addr: Receiver address
3638 * @user_prio: User priority of the traffic stream
3639 * @admitted_time: Admitted time for this TS in units of
3640 * 32 microsecond periods (per second).
3641 * Returns: 0 on success, -1 on failure
3642 */
3643 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3644 u16 admitted_time);
3645
3646 /**
3647 * del_tx_ts - Delete traffic stream
3648 * @priv: Private driver interface data
3649 * @tsid: Traffic stream ID
3650 * @addr: Receiver address
3651 * Returns: 0 on success, -1 on failure
3652 */
3653 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3654
6b90deae
AN
3655 /**
3656 * Enable channel-switching with TDLS peer
3657 * @priv: Private driver interface data
3658 * @addr: MAC address of the TDLS peer
3659 * @oper_class: Operating class of the switch channel
3660 * @params: Channel specification
3661 * Returns: 0 on success, -1 on failure
3662 *
3663 * The function indicates to driver that it can start switching to a
3664 * different channel with a specified TDLS peer. The switching is
3665 * assumed on until canceled with tdls_disable_channel_switch().
3666 */
3667 int (*tdls_enable_channel_switch)(
3668 void *priv, const u8 *addr, u8 oper_class,
3669 const struct hostapd_freq_params *params);
3670
3671 /**
3672 * Disable channel switching with TDLS peer
3673 * @priv: Private driver interface data
3674 * @addr: MAC address of the TDLS peer
3675 * Returns: 0 on success, -1 on failure
3676 *
3677 * This function indicates to the driver that it should stop switching
3678 * with a given TDLS peer.
3679 */
3680 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3681
f90e9c1c
SW
3682 /**
3683 * start_dfs_cac - Listen for radar interference on the channel
3684 * @priv: Private driver interface data
04e8003c 3685 * @freq: Channel parameters
f90e9c1c
SW
3686 * Returns: 0 on success, -1 on failure
3687 */
04e8003c 3688 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
695c7038
SW
3689
3690 /**
3691 * stop_ap - Removes beacon from AP
3692 * @priv: Private driver interface data
3693 * Returns: 0 on success, -1 on failure (or if not supported)
3694 *
3695 * This optional function can be used to disable AP mode related
3696 * configuration. Unlike deinit_ap, it does not change to station
3697 * mode.
3698 */
3699 int (*stop_ap)(void *priv);
0185007c
MK
3700
3701 /**
3702 * get_survey - Retrieve survey data
3703 * @priv: Private driver interface data
3704 * @freq: If set, survey data for the specified frequency is only
3705 * being requested. If not set, all survey data is requested.
3706 * Returns: 0 on success, -1 on failure
3707 *
3708 * Use this to retrieve:
3709 *
3710 * - the observed channel noise floor
3711 * - the amount of time we have spent on the channel
3712 * - the amount of time during which we have spent on the channel that
3713 * the radio has determined the medium is busy and we cannot
3714 * transmit
3715 * - the amount of time we have spent receiving data
3716 * - the amount of time we have spent transmitting data
3717 *
3718 * This data can be used for spectrum heuristics. One example is
3719 * Automatic Channel Selection (ACS). The channel survey data is
3720 * kept on a linked list on the channel data, one entry is added
3721 * for each survey. The min_nf of the channel is updated for each
3722 * survey.
3723 */
3724 int (*get_survey)(void *priv, unsigned int freq);
a771c07d
JM
3725
3726 /**
3727 * status - Get driver interface status information
3728 * @priv: Private driver interface data
d0dde080 3729 * @buf: Buffer for printing the status information
a771c07d
JM
3730 * @buflen: Maximum length of the buffer
3731 * Returns: Length of written status information or -1 on failure
3732 */
3733 int (*status)(void *priv, char *buf, size_t buflen);
7baec808 3734
0ef023e4
JM
3735 /**
3736 * roaming - Set roaming policy for driver-based BSS selection
3737 * @priv: Private driver interface data
3738 * @allowed: Whether roaming within ESS is allowed
3739 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3740 * Returns: Length of written status information or -1 on failure
3741 *
3742 * This optional callback can be used to update roaming policy from the
3743 * associate() command (bssid being set there indicates that the driver
3744 * should not roam before getting this roaming() call to allow roaming.
3745 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3746 * capability, roaming policy is handled within wpa_supplicant and there
3747 * is no need to implement or react to this callback.
3748 */
3749 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3750
d98038bb 3751 /**
3752 * disable_fils - Enable/disable FILS feature
3753 * @priv: Private driver interface data
3754 * @disable: 0-enable and 1-disable FILS feature
3755 * Returns: 0 on success, -1 on failure
3756 *
3757 * This callback can be used to configure driver and below layers to
3758 * enable/disable all FILS features.
3759 */
3760 int (*disable_fils)(void *priv, int disable);
3761
fee354c7
JM
3762 /**
3763 * set_mac_addr - Set MAC address
3764 * @priv: Private driver interface data
3765 * @addr: MAC address to use or %NULL for setting back to permanent
3766 * Returns: 0 on success, -1 on failure
3767 */
3768 int (*set_mac_addr)(void *priv, const u8 *addr);
3769
7baec808
HW
3770#ifdef CONFIG_MACSEC
3771 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3772
3773 int (*macsec_deinit)(void *priv);
3774
a25e4efc
SD
3775 /**
3776 * macsec_get_capability - Inform MKA of this driver's capability
3777 * @priv: Private driver interface data
3778 * @cap: Driver's capability
3779 * Returns: 0 on success, -1 on failure
3780 */
3781 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);
3782
7baec808
HW
3783 /**
3784 * enable_protect_frames - Set protect frames status
3785 * @priv: Private driver interface data
3786 * @enabled: TRUE = protect frames enabled
3787 * FALSE = protect frames disabled
3788 * Returns: 0 on success, -1 on failure (or if not supported)
3789 */
3790 int (*enable_protect_frames)(void *priv, Boolean enabled);
3791
1d3d0666
SD
3792 /**
3793 * enable_encrypt - Set encryption status
3794 * @priv: Private driver interface data
3795 * @enabled: TRUE = encrypt outgoing traffic
3796 * FALSE = integrity-only protection on outgoing traffic
3797 * Returns: 0 on success, -1 on failure (or if not supported)
3798 */
3799 int (*enable_encrypt)(void *priv, Boolean enabled);
3800
7baec808
HW
3801 /**
3802 * set_replay_protect - Set replay protect status and window size
3803 * @priv: Private driver interface data
3804 * @enabled: TRUE = replay protect enabled
3805 * FALSE = replay protect disabled
3806 * @window: replay window size, valid only when replay protect enabled
3807 * Returns: 0 on success, -1 on failure (or if not supported)
3808 */
3809 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3810
3811 /**
3812 * set_current_cipher_suite - Set current cipher suite
3813 * @priv: Private driver interface data
3814 * @cs: EUI64 identifier
7baec808
HW
3815 * Returns: 0 on success, -1 on failure (or if not supported)
3816 */
07a6bfe1 3817 int (*set_current_cipher_suite)(void *priv, u64 cs);
7baec808
HW
3818
3819 /**
3820 * enable_controlled_port - Set controlled port status
3821 * @priv: Private driver interface data
3822 * @enabled: TRUE = controlled port enabled
3823 * FALSE = controlled port disabled
3824 * Returns: 0 on success, -1 on failure (or if not supported)
3825 */
3826 int (*enable_controlled_port)(void *priv, Boolean enabled);
3827
3828 /**
3829 * get_receive_lowest_pn - Get receive lowest pn
3830 * @priv: Private driver interface data
7fa5eff8 3831 * @sa: secure association
7baec808
HW
3832 * Returns: 0 on success, -1 on failure (or if not supported)
3833 */
7fa5eff8 3834 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);
7baec808
HW
3835
3836 /**
3837 * get_transmit_next_pn - Get transmit next pn
3838 * @priv: Private driver interface data
7fa5eff8 3839 * @sa: secure association
7baec808
HW
3840 * Returns: 0 on success, -1 on failure (or if not supported)
3841 */
7fa5eff8 3842 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);
7baec808
HW
3843
3844 /**
3845 * set_transmit_next_pn - Set transmit next pn
3846 * @priv: Private driver interface data
7fa5eff8 3847 * @sa: secure association
7baec808
HW
3848 * Returns: 0 on success, -1 on failure (or if not supported)
3849 */
7fa5eff8 3850 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);
7baec808 3851
2fc06756
MS
3852 /**
3853 * set_receive_lowest_pn - Set receive lowest PN
3854 * @priv: Private driver interface data
3855 * @sa: secure association
3856 * Returns: 0 on success, -1 on failure (or if not supported)
3857 */
3858 int (*set_receive_lowest_pn)(void *priv, struct receive_sa *sa);
3859
7baec808
HW
3860 /**
3861 * create_receive_sc - create secure channel for receiving
3862 * @priv: Private driver interface data
5f5ca284 3863 * @sc: secure channel
7baec808
HW
3864 * @conf_offset: confidentiality offset (0, 30, or 50)
3865 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3866 * 2 = Strict)
3867 * Returns: 0 on success, -1 on failure (or if not supported)
3868 */
5f5ca284
SD
3869 int (*create_receive_sc)(void *priv, struct receive_sc *sc,
3870 unsigned int conf_offset,
7baec808
HW
3871 int validation);
3872
3873 /**
3874 * delete_receive_sc - delete secure connection for receiving
3875 * @priv: private driver interface data from init()
5f5ca284 3876 * @sc: secure channel
7baec808
HW
3877 * Returns: 0 on success, -1 on failure
3878 */
5f5ca284 3879 int (*delete_receive_sc)(void *priv, struct receive_sc *sc);
7baec808
HW
3880
3881 /**
3882 * create_receive_sa - create secure association for receive
3883 * @priv: private driver interface data from init()
cecdecdb 3884 * @sa: secure association
7baec808
HW
3885 * Returns: 0 on success, -1 on failure
3886 */
cecdecdb 3887 int (*create_receive_sa)(void *priv, struct receive_sa *sa);
7baec808 3888
23c3528a
SD
3889 /**
3890 * delete_receive_sa - Delete secure association for receive
3891 * @priv: Private driver interface data from init()
3892 * @sa: Secure association
3893 * Returns: 0 on success, -1 on failure
3894 */
3895 int (*delete_receive_sa)(void *priv, struct receive_sa *sa);
3896
7baec808
HW
3897 /**
3898 * enable_receive_sa - enable the SA for receive
3899 * @priv: private driver interface data from init()
cecdecdb 3900 * @sa: secure association
7baec808
HW
3901 * Returns: 0 on success, -1 on failure
3902 */
cecdecdb 3903 int (*enable_receive_sa)(void *priv, struct receive_sa *sa);
7baec808
HW
3904
3905 /**
3906 * disable_receive_sa - disable SA for receive
3907 * @priv: private driver interface data from init()
cecdecdb 3908 * @sa: secure association
7baec808
HW
3909 * Returns: 0 on success, -1 on failure
3910 */
cecdecdb 3911 int (*disable_receive_sa)(void *priv, struct receive_sa *sa);
7baec808 3912
7baec808
HW
3913 /**
3914 * create_transmit_sc - create secure connection for transmit
3915 * @priv: private driver interface data from init()
8ebfc7c2
SD
3916 * @sc: secure channel
3917 * @conf_offset: confidentiality offset (0, 30, or 50)
7baec808
HW
3918 * Returns: 0 on success, -1 on failure
3919 */
8ebfc7c2
SD
3920 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
3921 unsigned int conf_offset);
7baec808
HW
3922
3923 /**
3924 * delete_transmit_sc - delete secure connection for transmit
3925 * @priv: private driver interface data from init()
8ebfc7c2 3926 * @sc: secure channel
7baec808
HW
3927 * Returns: 0 on success, -1 on failure
3928 */
8ebfc7c2 3929 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);
7baec808
HW
3930
3931 /**
3932 * create_transmit_sa - create secure association for transmit
3933 * @priv: private driver interface data from init()
909c1b98 3934 * @sa: secure association
7baec808
HW
3935 * Returns: 0 on success, -1 on failure
3936 */
909c1b98 3937 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);
7baec808 3938
23c3528a
SD
3939 /**
3940 * delete_transmit_sa - Delete secure association for transmit
3941 * @priv: Private driver interface data from init()
3942 * @sa: Secure association
3943 * Returns: 0 on success, -1 on failure
3944 */
3945 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);
3946
7baec808
HW
3947 /**
3948 * enable_transmit_sa - enable SA for transmit
3949 * @priv: private driver interface data from init()
909c1b98 3950 * @sa: secure association
7baec808
HW
3951 * Returns: 0 on success, -1 on failure
3952 */
909c1b98 3953 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);
7baec808
HW
3954
3955 /**
3956 * disable_transmit_sa - disable SA for transmit
3957 * @priv: private driver interface data from init()
909c1b98 3958 * @sa: secure association
7baec808
HW
3959 * Returns: 0 on success, -1 on failure
3960 */
909c1b98 3961 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
7baec808 3962#endif /* CONFIG_MACSEC */
6c1664f6
BC
3963
3964 /**
3965 * init_mesh - Driver specific initialization for mesh
3966 * @priv: Private driver interface data
3967 * Returns: 0 on success, -1 on failure
3968 */
3969 int (*init_mesh)(void *priv);
3970
3971 /**
3972 * join_mesh - Join a mesh network
3973 * @priv: Private driver interface data
3974 * @params: Mesh configuration parameters
3975 * Returns: 0 on success, -1 on failure
3976 */
3977 int (*join_mesh)(void *priv,
3978 struct wpa_driver_mesh_join_params *params);
3979
3980 /**
3981 * leave_mesh - Leave a mesh network
3982 * @priv: Private driver interface data
3983 * Returns 0 on success, -1 on failure
3984 */
3985 int (*leave_mesh)(void *priv);
16689c7c
PX
3986
3987 /**
3988 * do_acs - Automatically select channel
3989 * @priv: Private driver interface data
3990 * @params: Parameters for ACS
3991 * Returns 0 on success, -1 on failure
3992 *
3993 * This command can be used to offload ACS to the driver if the driver
3994 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3995 */
3996 int (*do_acs)(void *priv, struct drv_acs_params *params);
844dfeb8
SD
3997
3998 /**
3999 * set_band - Notify driver of band selection
4000 * @priv: Private driver interface data
4001 * @band: The selected band(s)
4002 * Returns 0 on success, -1 on failure
4003 */
4004 int (*set_band)(void *priv, enum set_band band);
7c813acf 4005
98342208
AK
4006 /**
4007 * get_pref_freq_list - Get preferred frequency list for an interface
4008 * @priv: Private driver interface data
4009 * @if_type: Interface type
4010 * @num: Number of channels
4011 * @freq_list: Preferred channel frequency list encoded in MHz values
4012 * Returns 0 on success, -1 on failure
4013 *
4014 * This command can be used to query the preferred frequency list from
4015 * the driver specific to a particular interface type.
4016 */
4017 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
4018 unsigned int *num, unsigned int *freq_list);
4019
7c813acf
AK
4020 /**
4021 * set_prob_oper_freq - Indicate probable P2P operating channel
4022 * @priv: Private driver interface data
4023 * @freq: Channel frequency in MHz
4024 * Returns 0 on success, -1 on failure
4025 *
4026 * This command can be used to inform the driver of the operating
4027 * frequency that an ongoing P2P group formation is likely to come up
4028 * on. Local device is assuming P2P Client role.
4029 */
4030 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
4f30addb
KV
4031
4032 /**
4033 * abort_scan - Request the driver to abort an ongoing scan
4034 * @priv: Private driver interface data
eeb34a43
SD
4035 * @scan_cookie: Cookie identifying the scan request. This is used only
4036 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4037 * was used to trigger scan. Otherwise, 0 is used.
4f30addb
KV
4038 * Returns 0 on success, -1 on failure
4039 */
eeb34a43 4040 int (*abort_scan)(void *priv, u64 scan_cookie);
e42adb9a
MG
4041
4042 /**
4043 * configure_data_frame_filters - Request to configure frame filters
4044 * @priv: Private driver interface data
4045 * @filter_flags: The type of frames to filter (bitfield of
4046 * WPA_DATA_FRAME_FILTER_FLAG_*)
4047 * Returns: 0 on success or -1 on failure
4048 */
4049 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
cc9a2575
KV
4050
4051 /**
4052 * get_ext_capab - Get extended capabilities for the specified interface
4053 * @priv: Private driver interface data
4054 * @type: Interface type for which to get extended capabilities
4055 * @ext_capab: Extended capabilities fetched
4056 * @ext_capab_mask: Extended capabilities mask
4057 * @ext_capab_len: Length of the extended capabilities
4058 * Returns: 0 on success or -1 on failure
4059 */
4060 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
4061 const u8 **ext_capab, const u8 **ext_capab_mask,
4062 unsigned int *ext_capab_len);
a6f5b193
PX
4063
4064 /**
4065 * p2p_lo_start - Start offloading P2P listen to device
4066 * @priv: Private driver interface data
4067 * @freq: Listening frequency (MHz) for P2P listen
4068 * @period: Length of the listen operation in milliseconds
4069 * @interval: Interval for running the listen operation in milliseconds
4070 * @count: Number of times to run the listen operation
4071 * @device_types: Device primary and secondary types
4072 * @dev_types_len: Number of bytes for device_types
4073 * @ies: P2P IE and WSC IE for Probe Response frames
4074 * @ies_len: Length of ies in bytes
4075 * Returns: 0 on success or -1 on failure
4076 */
4077 int (*p2p_lo_start)(void *priv, unsigned int freq,
4078 unsigned int period, unsigned int interval,
4079 unsigned int count,
4080 const u8 *device_types, size_t dev_types_len,
4081 const u8 *ies, size_t ies_len);
4082
4083 /**
4084 * p2p_lo_stop - Stop P2P listen offload
4085 * @priv: Private driver interface data
4086 * Returns: 0 on success or -1 on failure
4087 */
4088 int (*p2p_lo_stop)(void *priv);
cc9985d1 4089
4090 /**
4091 * set_default_scan_ies - Set default scan IEs
4092 * @priv: Private driver interface data
4093 * @ies: Scan default IEs buffer
4094 * @ies_len: Length of IEs in bytes
4095 * Returns: 0 on success or -1 on failure
4096 *
4097 * The driver can use these by default when there are no scan IEs coming
4098 * in the subsequent scan requests. Also in case of one or more of IEs
4099 * given in set_default_scan_ies() are missing in the subsequent scan
4100 * request, the driver should merge the missing scan IEs in the scan
4101 * request from the IEs set by set_default_scan_ies() in the Probe
4102 * Request frames sent.
4103 */
4104 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
4105
2e4e4fb7
SD
4106 /**
4107 * set_tdls_mode - Set TDLS trigger mode to the host driver
4108 * @priv: Private driver interface data
4109 * @tdls_external_control: Represents if TDLS external trigger control
4110 * mode is enabled/disabled.
4111 *
4112 * This optional callback can be used to configure the TDLS external
4113 * trigger control mode to the host driver.
4114 */
4115 int (*set_tdls_mode)(void *priv, int tdls_external_control);
6fc6879b 4116
3ab48492
KV
4117 /**
4118 * get_bss_transition_status - Get candidate BSS's transition status
4119 * @priv: Private driver interface data
4120 * @params: Candidate BSS list
4121 *
4122 * Get the accept or reject reason code for a list of BSS transition
4123 * candidates.
4124 */
4125 struct wpa_bss_candidate_info *
4126 (*get_bss_transition_status)(void *priv,
4127 struct wpa_bss_trans_info *params);
178553b7
VK
4128 /**
4129 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
4130 * @priv: Private driver interface data
4131 * @ignore_disallow: 0 to not ignore, 1 to ignore
4132 * Returns: 0 on success, -1 on failure
4133 */
4134 int (*ignore_assoc_disallow)(void *priv, int ignore_disallow);
b04854ce
AP
4135
4136 /**
4137 * set_bssid_blacklist - Set blacklist of BSSIDs to the driver
4138 * @priv: Private driver interface data
4139 * @num_bssid: Number of blacklist BSSIDs
4140 * @bssids: List of blacklisted BSSIDs
4141 */
4142 int (*set_bssid_blacklist)(void *priv, unsigned int num_bssid,
4143 const u8 *bssid);
3c67e977
VK
4144
4145 /**
4146 * update_connect_params - Update the connection parameters
4147 * @priv: Private driver interface data
4148 * @params: Association parameters
4149 * @mask: Bit mask indicating which parameters in @params have to be
4150 * updated
4151 * Returns: 0 on success, -1 on failure
4152 *
4153 * Update the connection parameters when in connected state so that the
4154 * driver uses the updated parameters for subsequent roaming. This is
4155 * used only with drivers that implement internal BSS selection and
4156 * roaming.
4157 */
4158 int (*update_connect_params)(
4159 void *priv, struct wpa_driver_associate_params *params,
4160 enum wpa_drv_update_connect_params_mask mask);
ba71cb82
SD
4161
4162 /**
4163 * send_external_auth_status - Indicate the status of external
4164 * authentication processing to the host driver.
4165 * @priv: Private driver interface data
4166 * @params: Status of authentication processing.
4167 * Returns: 0 on success, -1 on failure
4168 */
4169 int (*send_external_auth_status)(void *priv,
4170 struct external_auth *params);
5abc7823
VN
4171
4172 /**
4173 * set_4addr_mode - Set 4-address mode
4174 * @priv: Private driver interface data
4175 * @bridge_ifname: Bridge interface name
4176 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
4177 * Returns: 0 on success, < 0 on failure
4178 */
4179 int (*set_4addr_mode)(void *priv, const char *bridge_ifname, int val);
3ab48492 4180};
e0498677 4181
6fc6879b
JM
4182/**
4183 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
4184 */
9646a8ab 4185enum wpa_event_type {
6fc6879b
JM
4186 /**
4187 * EVENT_ASSOC - Association completed
4188 *
4189 * This event needs to be delivered when the driver completes IEEE
4190 * 802.11 association or reassociation successfully.
4191 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
4192 * after this event has been generated. In addition, optional
4193 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
4194 * more information about the association. If the driver interface gets
4195 * both of these events at the same time, it can also include the
4196 * assoc_info data in EVENT_ASSOC call.
4197 */
4198 EVENT_ASSOC,
4199
4200 /**
4201 * EVENT_DISASSOC - Association lost
4202 *
4203 * This event should be called when association is lost either due to
4204 * receiving deauthenticate or disassociate frame from the AP or when
c2a04078
JM
4205 * sending either of these frames to the current AP. If the driver
4206 * supports separate deauthentication event, EVENT_DISASSOC should only
4207 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1d041bec 4208 * In AP mode, union wpa_event_data::disassoc_info is required.
6fc6879b
JM
4209 */
4210 EVENT_DISASSOC,
4211
4212 /**
4213 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
4214 *
4215 * This event must be delivered when a Michael MIC error is detected by
4216 * the local driver. Additional data for event processing is
4217 * provided with union wpa_event_data::michael_mic_failure. This
4218 * information is used to request new encyption key and to initiate
4219 * TKIP countermeasures if needed.
4220 */
4221 EVENT_MICHAEL_MIC_FAILURE,
4222
4223 /**
4224 * EVENT_SCAN_RESULTS - Scan results available
4225 *
4226 * This event must be called whenever scan results are available to be
4227 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4228 * is expected to be used some time after struct wpa_driver_ops::scan()
4229 * is called. If the driver provides an unsolicited event when the scan
4230 * has been completed, this event can be used to trigger
4231 * EVENT_SCAN_RESULTS call. If such event is not available from the
4232 * driver, the driver wrapper code is expected to use a registered
4233 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
8d923a4a
JM
4234 * scan is expected to be completed. Optional information about
4235 * completed scan can be provided with union wpa_event_data::scan_info.
6fc6879b
JM
4236 */
4237 EVENT_SCAN_RESULTS,
4238
4239 /**
4240 * EVENT_ASSOCINFO - Report optional extra information for association
4241 *
4242 * This event can be used to report extra association information for
4243 * EVENT_ASSOC processing. This extra information includes IEs from
4244 * association frames and Beacon/Probe Response frames in union
4245 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4246 * EVENT_ASSOC. Alternatively, the driver interface can include
4247 * assoc_info data in the EVENT_ASSOC call if it has all the
4248 * information available at the same point.
4249 */
4250 EVENT_ASSOCINFO,
4251
4252 /**
4253 * EVENT_INTERFACE_STATUS - Report interface status changes
4254 *
4255 * This optional event can be used to report changes in interface
4256 * status (interface added/removed) using union
4257 * wpa_event_data::interface_status. This can be used to trigger
4258 * wpa_supplicant to stop and re-start processing for the interface,
4259 * e.g., when a cardbus card is ejected/inserted.
4260 */
4261 EVENT_INTERFACE_STATUS,
4262
4263 /**
4264 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4265 *
4266 * This event can be used to inform wpa_supplicant about candidates for
4267 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4268 * for scan request (ap_scan=2 mode), this event is required for
4269 * pre-authentication. If wpa_supplicant is performing scan request
4270 * (ap_scan=1), this event is optional since scan results can be used
4271 * to add pre-authentication candidates. union
4272 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4273 * candidate and priority of the candidate, e.g., based on the signal
4274 * strength, in order to try to pre-authenticate first with candidates
4275 * that are most likely targets for re-association.
4276 *
4277 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4278 * on the candidate list. In addition, it can be called for the current
4279 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4280 * will automatically skip pre-authentication in cases where a valid
4281 * PMKSA exists. When more than one candidate exists, this event should
4282 * be generated once for each candidate.
4283 *
4284 * Driver will be notified about successful pre-authentication with
4285 * struct wpa_driver_ops::add_pmkid() calls.
4286 */
4287 EVENT_PMKID_CANDIDATE,
4288
281ff0aa
GP
4289 /**
4290 * EVENT_TDLS - Request TDLS operation
4291 *
4292 * This event can be used to request a TDLS operation to be performed.
4293 */
4294 EVENT_TDLS,
4295
6fc6879b
JM
4296 /**
4297 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4298 *
4299 * The driver is expected to report the received FT IEs from
4300 * FT authentication sequence from the AP. The FT IEs are included in
4301 * the extra information in union wpa_event_data::ft_ies.
4302 */
11ef8d35
JM
4303 EVENT_FT_RESPONSE,
4304
4305 /**
4306 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4307 *
4308 * The driver can use this event to inform wpa_supplicant about a STA
4309 * in an IBSS with which protected frames could be exchanged. This
4310 * event starts RSN authentication with the other STA to authenticate
4311 * the STA and set up encryption keys with it.
4312 */
c2a04078
JM
4313 EVENT_IBSS_RSN_START,
4314
4315 /**
4316 * EVENT_AUTH - Authentication result
4317 *
4318 * This event should be called when authentication attempt has been
4319 * completed. This is only used if the driver supports separate
4320 * authentication step (struct wpa_driver_ops::authenticate).
4321 * Information about authentication result is included in
4322 * union wpa_event_data::auth.
4323 */
4324 EVENT_AUTH,
4325
4326 /**
4327 * EVENT_DEAUTH - Authentication lost
4328 *
4329 * This event should be called when authentication is lost either due
4330 * to receiving deauthenticate frame from the AP or when sending that
4331 * frame to the current AP.
1d041bec 4332 * In AP mode, union wpa_event_data::deauth_info is required.
c2a04078 4333 */
efa46078
JM
4334 EVENT_DEAUTH,
4335
4336 /**
4337 * EVENT_ASSOC_REJECT - Association rejected
4338 *
4339 * This event should be called when (re)association attempt has been
59ddf221 4340 * rejected by the AP. Information about the association response is
efa46078
JM
4341 * included in union wpa_event_data::assoc_reject.
4342 */
da1fb17c
JM
4343 EVENT_ASSOC_REJECT,
4344
4345 /**
4346 * EVENT_AUTH_TIMED_OUT - Authentication timed out
4347 */
4348 EVENT_AUTH_TIMED_OUT,
4349
4350 /**
4351 * EVENT_ASSOC_TIMED_OUT - Association timed out
4352 */
08fd8c15
JM
4353 EVENT_ASSOC_TIMED_OUT,
4354
fcf0f87d
JM
4355 /**
4356 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
4357 */
f8b1f695
JM
4358 EVENT_WPS_BUTTON_PUSHED,
4359
4360 /**
4361 * EVENT_TX_STATUS - Report TX status
4362 */
4363 EVENT_TX_STATUS,
4364
4365 /**
4366 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
4367 */
4368 EVENT_RX_FROM_UNKNOWN,
4369
4370 /**
4371 * EVENT_RX_MGMT - Report RX of a management frame
4372 */
245519e0
JM
4373 EVENT_RX_MGMT,
4374
55777702
JM
4375 /**
4376 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
4377 *
4378 * This event is used to indicate when the driver has started the
4379 * requested remain-on-channel duration. Information about the
4380 * operation is included in union wpa_event_data::remain_on_channel.
4381 */
4382 EVENT_REMAIN_ON_CHANNEL,
4383
4384 /**
4385 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
4386 *
4387 * This event is used to indicate when the driver has completed
4388 * remain-on-channel duration, i.e., may noot be available on the
4389 * requested channel anymore. Information about the
4390 * operation is included in union wpa_event_data::remain_on_channel.
4391 */
4392 EVENT_CANCEL_REMAIN_ON_CHANNEL,
4393
a0e0d3bb
JM
4394 /**
4395 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
4396 *
4397 * This event is used to indicate when a Probe Request frame has been
4398 * received. Information about the received frame is included in
504e905c
JM
4399 * union wpa_event_data::rx_probe_req. The driver is required to report
4400 * these events only after successfully completed probe_req_report()
4401 * commands to request the events (i.e., report parameter is non-zero)
4402 * in station mode. In AP mode, Probe Request frames should always be
4403 * reported.
a0e0d3bb 4404 */
a70a5d6d
JM
4405 EVENT_RX_PROBE_REQ,
4406
4407 /**
4408 * EVENT_NEW_STA - New wired device noticed
4409 *
4410 * This event is used to indicate that a new device has been detected
4411 * in a network that does not use association-like functionality (i.e.,
4412 * mainly wired Ethernet). This can be used to start EAPOL
4413 * authenticator when receiving a frame from a device. The address of
4414 * the device is included in union wpa_event_data::new_sta.
4415 */
a8e0505b
JM
4416 EVENT_NEW_STA,
4417
4418 /**
4419 * EVENT_EAPOL_RX - Report received EAPOL frame
4420 *
4421 * When in AP mode with hostapd, this event is required to be used to
2961bfa8 4422 * deliver the receive EAPOL frames from the driver.
a8e0505b 4423 */
b625473c
JM
4424 EVENT_EAPOL_RX,
4425
4426 /**
4427 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4428 *
4429 * This event is used to indicate changes in the signal strength
4430 * observed in frames received from the current AP if signal strength
4431 * monitoring has been enabled with signal_monitor().
4432 */
8401a6b0
JM
4433 EVENT_SIGNAL_CHANGE,
4434
4435 /**
4436 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4437 *
4438 * This event is used to indicate that the interface was enabled after
4439 * having been previously disabled, e.g., due to rfkill.
4440 */
4441 EVENT_INTERFACE_ENABLED,
4442
4443 /**
4444 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4445 *
4446 * This event is used to indicate that the interface was disabled,
4447 * e.g., due to rfkill.
4448 */
b5c9da8d
JM
4449 EVENT_INTERFACE_DISABLED,
4450
4451 /**
4452 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4453 *
4454 * This event is used to indicate that the channel list has changed,
4455 * e.g., because of a regulatory domain change triggered by scan
4456 * results including an AP advertising a country code.
4457 */
c973f386
JM
4458 EVENT_CHANNEL_LIST_CHANGED,
4459
4460 /**
4461 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4462 *
4463 * This event is used to indicate that the driver cannot maintain this
4464 * interface in its operation mode anymore. The most likely use for
4465 * this is to indicate that AP mode operation is not available due to
4466 * operating channel would need to be changed to a DFS channel when
4467 * the driver does not support radar detection and another virtual
4468 * interfaces caused the operating channel to change. Other similar
4469 * resource conflicts could also trigger this for station mode
5841958f
MK
4470 * interfaces. This event can be propagated when channel switching
4471 * fails.
c973f386 4472 */
7cfc4ac3
AGS
4473 EVENT_INTERFACE_UNAVAILABLE,
4474
4475 /**
4476 * EVENT_BEST_CHANNEL
4477 *
4478 * Driver generates this event whenever it detects a better channel
4479 * (e.g., based on RSSI or channel use). This information can be used
4480 * to improve channel selection for a new AP/P2P group.
4481 */
7d878ca7
JM
4482 EVENT_BEST_CHANNEL,
4483
4484 /**
4485 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4486 *
4487 * This event should be called when a Deauthentication frame is dropped
4488 * due to it not being protected (MFP/IEEE 802.11w).
4489 * union wpa_event_data::unprot_deauth is required to provide more
4490 * details of the frame.
4491 */
4492 EVENT_UNPROT_DEAUTH,
4493
4494 /**
4495 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4496 *
4497 * This event should be called when a Disassociation frame is dropped
4498 * due to it not being protected (MFP/IEEE 802.11w).
4499 * union wpa_event_data::unprot_disassoc is required to provide more
4500 * details of the frame.
4501 */
4502 EVENT_UNPROT_DISASSOC,
0d7e5a3a
JB
4503
4504 /**
4505 * EVENT_STATION_LOW_ACK
4506 *
4507 * Driver generates this event whenever it detected that a particular
4508 * station was lost. Detection can be through massive transmission
4509 * failures for example.
4510 */
3ac17eba
JM
4511 EVENT_STATION_LOW_ACK,
4512
ea244d21
XC
4513 /**
4514 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4515 */
b14a210c
JB
4516 EVENT_IBSS_PEER_LOST,
4517
4518 /**
4519 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4520 *
4521 * This event carries the new replay counter to notify wpa_supplicant
4522 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4523 * completed Group Key Handshake while the host (including
4524 * wpa_supplicant was sleeping).
4525 */
cbdf3507
LC
4526 EVENT_DRIVER_GTK_REKEY,
4527
4528 /**
4529 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4530 */
bcf24348
JB
4531 EVENT_SCHED_SCAN_STOPPED,
4532
4533 /**
4534 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4535 *
4536 * This event indicates that the station responded to the poll
4537 * initiated with @poll_client.
4538 */
dd840f79
JB
4539 EVENT_DRIVER_CLIENT_POLL_OK,
4540
4541 /**
4542 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4543 */
1b487b8b
TP
4544 EVENT_EAPOL_TX_STATUS,
4545
4546 /**
4547 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4548 *
4549 * Described in wpa_event_data.ch_switch
4550 * */
a884be9d
XC
4551 EVENT_CH_SWITCH,
4552
4553 /**
95f556f3
OD
4554 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
4555 *
4556 * This is a pre-switch event indicating the shortly following switch
4557 * of operating channels.
4558 *
4559 * Described in wpa_event_data.ch_switch
4560 */
4561 EVENT_CH_SWITCH_STARTED,
4562 /**
a884be9d
XC
4563 * EVENT_WNM - Request WNM operation
4564 *
4565 * This event can be used to request a WNM operation to be performed.
4566 */
3140803b
RM
4567 EVENT_WNM,
4568
4569 /**
4570 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4571 *
4572 * This event indicates that the driver reported a connection failure
4573 * with the specified client (for example, max client reached, etc.) in
4574 * AP mode.
4575 */
04be54fa
SW
4576 EVENT_CONNECT_FAILED_REASON,
4577
4578 /**
480994da 4579 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
04be54fa
SW
4580 *
4581 * A radar has been detected on the supplied frequency, hostapd should
4582 * react accordingly (e.g., change channel).
4583 */
4584 EVENT_DFS_RADAR_DETECTED,
4585
4586 /**
480994da 4587 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
04be54fa
SW
4588 *
4589 * After a successful CAC, the channel can be marked clear and used.
4590 */
4591 EVENT_DFS_CAC_FINISHED,
4592
4593 /**
480994da 4594 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
04be54fa
SW
4595 *
4596 * The CAC was not successful, and the channel remains in the previous
641c73f8 4597 * state. This may happen due to a radar being detected or other
04be54fa
SW
4598 * external influences.
4599 */
4600 EVENT_DFS_CAC_ABORTED,
4601
4602 /**
480994da 4603 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
04be54fa
SW
4604 *
4605 * The channel which was previously unavailable is now available again.
4606 */
0185007c
MK
4607 EVENT_DFS_NOP_FINISHED,
4608
18ae2377
JM
4609 /**
4610 * EVENT_SURVEY - Received survey data
4611 *
4612 * This event gets triggered when a driver query is issued for survey
4613 * data and the requested data becomes available. The returned data is
4614 * stored in struct survey_results. The results provide at most one
4615 * survey entry for each frequency and at minimum will provide one
4616 * survey entry for one frequency. The survey data can be os_malloc()'d
4617 * and then os_free()'d, so the event callback must only copy data.
4618 */
a5f40eff
JM
4619 EVENT_SURVEY,
4620
4621 /**
4622 * EVENT_SCAN_STARTED - Scan started
4623 *
4624 * This indicates that driver has started a scan operation either based
4625 * on a request from wpa_supplicant/hostapd or from another application.
4626 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4627 * completed (either successfully or by getting cancelled).
4628 */
253f2e37
AH
4629 EVENT_SCAN_STARTED,
4630
4631 /**
4632 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4633 *
4634 * This event indicates a set of frequency ranges that should be avoided
4635 * to reduce issues due to interference or internal co-existence
4636 * information in the driver.
4637 */
a52024c9
BC
4638 EVENT_AVOID_FREQUENCIES,
4639
4640 /**
4641 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4642 */
16689c7c 4643 EVENT_NEW_PEER_CANDIDATE,
a52024c9 4644
16689c7c
PX
4645 /**
4646 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4647 *
4648 * Indicates a pair of primary and secondary channels chosen by ACS
4649 * in device.
4650 */
4651 EVENT_ACS_CHANNEL_SELECTED,
480994da
AK
4652
4653 /**
4654 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4655 * been started.
4656 *
4657 * This event indicates that channel availability check has been started
4658 * on a DFS frequency by a driver that supports DFS Offload.
4659 */
4660 EVENT_DFS_CAC_STARTED,
a6f5b193
PX
4661
4662 /**
4663 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4664 */
4665 EVENT_P2P_LO_STOP,
68855672
JM
4666
4667 /**
4668 * EVENT_BEACON_LOSS - Beacon loss detected
4669 *
4670 * This event indicates that no Beacon frames has been received from
4671 * the current AP. This may indicate that the AP is not anymore in
4672 * range.
4673 */
4674 EVENT_BEACON_LOSS,
62c8c7f7
VT
4675
4676 /**
4677 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
4678 * done previously (Pre-CAC) on the channel has expired. This would
4679 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
4680 * channel will be moved from available to usable. A new CAC has to be
4681 * performed before start operating on this channel.
4682 */
4683 EVENT_DFS_PRE_CAC_EXPIRED,
ba71cb82
SD
4684
4685 /**
4686 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
4687 * that do not define separate commands for authentication and
4688 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
4689 * authentication to wpa_supplicant. This event carries all the
4690 * necessary information from the host driver for the authentication to
4691 * happen.
4692 */
4693 EVENT_EXTERNAL_AUTH,
0a20bd7d
AS
4694
4695 /**
4696 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
4697 *
4698 * This event should be indicated when the driver completes the 4-way
4699 * handshake. This event should be preceded by an EVENT_ASSOC that
4700 * indicates the completion of IEEE 802.11 association.
4701 */
4702 EVENT_PORT_AUTHORIZED,
e8ada160
T
4703
4704 /**
4705 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
4706 * change event.
4707 */
4708 EVENT_STATION_OPMODE_CHANGED,
77a020a1
BG
4709
4710 /**
4711 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
4712 *
4713 * This event is emitted when the MAC changes while the interface is
4714 * enabled. When an interface was disabled and becomes enabled, it
4715 * must be always assumed that the MAC possibly changed.
4716 */
4717 EVENT_INTERFACE_MAC_CHANGED,
1952b626
BP
4718
4719 /**
4720 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
4721 *
4722 * This event is emitted when an interface is added/removed for WDS STA.
4723 */
4724 EVENT_WDS_STA_INTERFACE_STATUS,
9646a8ab 4725};
6fc6879b
JM
4726
4727
0185007c
MK
4728/**
4729 * struct freq_survey - Channel survey info
4730 *
4731 * @ifidx: Interface index in which this survey was observed
4732 * @freq: Center of frequency of the surveyed channel
4733 * @nf: Channel noise floor in dBm
4734 * @channel_time: Amount of time in ms the radio spent on the channel
4735 * @channel_time_busy: Amount of time in ms the radio detected some signal
4736 * that indicated to the radio the channel was not clear
4737 * @channel_time_rx: Amount of time the radio spent receiving data
4738 * @channel_time_tx: Amount of time the radio spent transmitting data
4739 * @filled: bitmask indicating which fields have been reported, see
4740 * SURVEY_HAS_* defines.
4741 * @list: Internal list pointers
4742 */
4743struct freq_survey {
4744 u32 ifidx;
4745 unsigned int freq;
4746 s8 nf;
4747 u64 channel_time;
4748 u64 channel_time_busy;
4749 u64 channel_time_rx;
4750 u64 channel_time_tx;
4751 unsigned int filled;
4752 struct dl_list list;
4753};
4754
4755#define SURVEY_HAS_NF BIT(0)
4756#define SURVEY_HAS_CHAN_TIME BIT(1)
4757#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4758#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4759#define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4760
4761
6fc6879b
JM
4762/**
4763 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4764 */
4765union wpa_event_data {
4766 /**
4767 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4768 *
4769 * This structure is optional for EVENT_ASSOC calls and required for
4770 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4771 * driver interface does not need to generate separate EVENT_ASSOCINFO
4772 * calls.
4773 */
4774 struct assoc_info {
39b08b5f
SP
4775 /**
4776 * reassoc - Flag to indicate association or reassociation
4777 */
4778 int reassoc;
4779
6fc6879b
JM
4780 /**
4781 * req_ies - (Re)Association Request IEs
4782 *
4783 * If the driver generates WPA/RSN IE, this event data must be
4784 * returned for WPA handshake to have needed information. If
4785 * wpa_supplicant-generated WPA/RSN IE is used, this
4786 * information event is optional.
4787 *
4788 * This should start with the first IE (fixed fields before IEs
4789 * are not included).
4790 */
1d041bec 4791 const u8 *req_ies;
6fc6879b
JM
4792
4793 /**
4794 * req_ies_len - Length of req_ies in bytes
4795 */
4796 size_t req_ies_len;
4797
4798 /**
4799 * resp_ies - (Re)Association Response IEs
4800 *
4801 * Optional association data from the driver. This data is not
4802 * required WPA, but may be useful for some protocols and as
4803 * such, should be reported if this is available to the driver
4804 * interface.
4805 *
4806 * This should start with the first IE (fixed fields before IEs
4807 * are not included).
4808 */
1d041bec 4809 const u8 *resp_ies;
6fc6879b
JM
4810
4811 /**
4812 * resp_ies_len - Length of resp_ies in bytes
4813 */
4814 size_t resp_ies_len;
4815
5b092fb6
JM
4816 /**
4817 * resp_frame - (Re)Association Response frame
4818 */
4819 const u8 *resp_frame;
4820
4821 /**
4822 * resp_frame_len - (Re)Association Response frame length
4823 */
4824 size_t resp_frame_len;
4825
6fc6879b
JM
4826 /**
4827 * beacon_ies - Beacon or Probe Response IEs
4828 *
4829 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4830 * Probe Response frames from the current AP (i.e., the one
4831 * that the client just associated with). This information is
4832 * used to update WPA/RSN IE for the AP. If this field is not
4833 * set, the results from previous scan will be used. If no
4834 * data for the new AP is found, scan results will be requested
4835 * again (without scan request). At this point, the driver is
4836 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4837 * used).
4838 *
4839 * This should start with the first IE (fixed fields before IEs
4840 * are not included).
4841 */
1d041bec 4842 const u8 *beacon_ies;
6fc6879b
JM
4843
4844 /**
4845 * beacon_ies_len - Length of beacon_ies */
4846 size_t beacon_ies_len;
4832ecd7
JM
4847
4848 /**
4849 * freq - Frequency of the operational channel in MHz
4850 */
4851 unsigned int freq;
1d041bec 4852
0f14a44e
EP
4853 /**
4854 * wmm_params - WMM parameters used in this association.
4855 */
4856 struct wmm_params wmm_params;
4857
1d041bec
JM
4858 /**
4859 * addr - Station address (for AP mode)
4860 */
4861 const u8 *addr;
b41f2684
CL
4862
4863 /**
4864 * The following is the key management offload information
4865 * @authorized
4866 * @key_replay_ctr
4867 * @key_replay_ctr_len
4868 * @ptk_kck
4869 * @ptk_kek_len
4870 * @ptk_kek
4871 * @ptk_kek_len
4872 */
4873
4874 /**
4875 * authorized - Status of key management offload,
4876 * 1 = successful
4877 */
4878 int authorized;
4879
4880 /**
4881 * key_replay_ctr - Key replay counter value last used
4882 * in a valid EAPOL-Key frame
4883 */
4884 const u8 *key_replay_ctr;
4885
4886 /**
4887 * key_replay_ctr_len - The length of key_replay_ctr
4888 */
4889 size_t key_replay_ctr_len;
4890
4891 /**
4892 * ptk_kck - The derived PTK KCK
4893 */
4894 const u8 *ptk_kck;
4895
4896 /**
4897 * ptk_kek_len - The length of ptk_kck
4898 */
4899 size_t ptk_kck_len;
4900
4901 /**
4902 * ptk_kek - The derived PTK KEK
ad295f3b
VK
4903 * This is used in key management offload and also in FILS SK
4904 * offload.
b41f2684
CL
4905 */
4906 const u8 *ptk_kek;
4907
4908 /**
4909 * ptk_kek_len - The length of ptk_kek
4910 */
4911 size_t ptk_kek_len;
f32227ed
RJ
4912
4913 /**
4914 * subnet_status - The subnet status:
4915 * 0 = unknown, 1 = unchanged, 2 = changed
4916 */
4917 u8 subnet_status;
ad295f3b
VK
4918
4919 /**
4920 * The following information is used in FILS SK offload
4921 * @fils_erp_next_seq_num
4922 * @fils_pmk
4923 * @fils_pmk_len
4924 * @fils_pmkid
4925 */
4926
4927 /**
4928 * fils_erp_next_seq_num - The next sequence number to use in
4929 * FILS ERP messages
4930 */
4931 u16 fils_erp_next_seq_num;
4932
4933 /**
4934 * fils_pmk - A new PMK if generated in case of FILS
4935 * authentication
4936 */
4937 const u8 *fils_pmk;
4938
4939 /**
4940 * fils_pmk_len - Length of fils_pmk
4941 */
4942 size_t fils_pmk_len;
4943
4944 /**
4945 * fils_pmkid - PMKID used or generated in FILS authentication
4946 */
4947 const u8 *fils_pmkid;
6fc6879b
JM
4948 } assoc_info;
4949
1d041bec
JM
4950 /**
4951 * struct disassoc_info - Data for EVENT_DISASSOC events
4952 */
4953 struct disassoc_info {
4954 /**
4955 * addr - Station address (for AP mode)
4956 */
4957 const u8 *addr;
0544b242
JM
4958
4959 /**
4960 * reason_code - Reason Code (host byte order) used in
4961 * Deauthentication frame
4962 */
4963 u16 reason_code;
75bde05d
JM
4964
4965 /**
4966 * ie - Optional IE(s) in Disassociation frame
4967 */
4968 const u8 *ie;
4969
4970 /**
4971 * ie_len - Length of ie buffer in octets
4972 */
4973 size_t ie_len;
3d9975d5
JM
4974
4975 /**
4976 * locally_generated - Whether the frame was locally generated
4977 */
4978 int locally_generated;
1d041bec
JM
4979 } disassoc_info;
4980
4981 /**
4982 * struct deauth_info - Data for EVENT_DEAUTH events
4983 */
4984 struct deauth_info {
4985 /**
4986 * addr - Station address (for AP mode)
4987 */
4988 const u8 *addr;
0544b242
JM
4989
4990 /**
4991 * reason_code - Reason Code (host byte order) used in
4992 * Deauthentication frame
4993 */
4994 u16 reason_code;
75bde05d
JM
4995
4996 /**
4997 * ie - Optional IE(s) in Deauthentication frame
4998 */
4999 const u8 *ie;
5000
5001 /**
5002 * ie_len - Length of ie buffer in octets
5003 */
5004 size_t ie_len;
3d9975d5
JM
5005
5006 /**
5007 * locally_generated - Whether the frame was locally generated
5008 */
5009 int locally_generated;
1d041bec
JM
5010 } deauth_info;
5011
6fc6879b
JM
5012 /**
5013 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
5014 */
5015 struct michael_mic_failure {
5016 int unicast;
ad1e68e6 5017 const u8 *src;
6fc6879b
JM
5018 } michael_mic_failure;
5019
5020 /**
5021 * struct interface_status - Data for EVENT_INTERFACE_STATUS
5022 */
5023 struct interface_status {
45e3fc72 5024 unsigned int ifindex;
6fc6879b
JM
5025 char ifname[100];
5026 enum {
5027 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
5028 } ievent;
5029 } interface_status;
5030
5031 /**
5032 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
5033 */
5034 struct pmkid_candidate {
5035 /** BSSID of the PMKID candidate */
5036 u8 bssid[ETH_ALEN];
5037 /** Smaller the index, higher the priority */
5038 int index;
5039 /** Whether RSN IE includes pre-authenticate flag */
5040 int preauth;
5041 } pmkid_candidate;
5042
281ff0aa
GP
5043 /**
5044 * struct tdls - Data for EVENT_TDLS
5045 */
5046 struct tdls {
5047 u8 peer[ETH_ALEN];
5048 enum {
5049 TDLS_REQUEST_SETUP,
c10ca2a6
SD
5050 TDLS_REQUEST_TEARDOWN,
5051 TDLS_REQUEST_DISCOVER,
281ff0aa
GP
5052 } oper;
5053 u16 reason_code; /* for teardown */
5054 } tdls;
5055
a884be9d
XC
5056 /**
5057 * struct wnm - Data for EVENT_WNM
5058 */
5059 struct wnm {
5060 u8 addr[ETH_ALEN];
5061 enum {
5062 WNM_OPER_SLEEP,
5063 } oper;
5064 enum {
5065 WNM_SLEEP_ENTER,
5066 WNM_SLEEP_EXIT
5067 } sleep_action;
5068 int sleep_intval;
5069 u16 reason_code;
5070 u8 *buf;
5071 u16 buf_len;
5072 } wnm;
5073
6fc6879b
JM
5074 /**
5075 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
5076 *
5077 * During FT (IEEE 802.11r) authentication sequence, the driver is
5078 * expected to use this event to report received FT IEs (MDIE, FTIE,
5079 * RSN IE, TIE, possible resource request) to the supplicant. The FT
5080 * IEs for the next message will be delivered through the
5081 * struct wpa_driver_ops::update_ft_ies() callback.
5082 */
5083 struct ft_ies {
5084 const u8 *ies;
5085 size_t ies_len;
5086 int ft_action;
5087 u8 target_ap[ETH_ALEN];
babfbf15
JM
5088 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
5089 const u8 *ric_ies;
5090 /** Length of ric_ies buffer in octets */
5091 size_t ric_ies_len;
6fc6879b 5092 } ft_ies;
11ef8d35
JM
5093
5094 /**
5095 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
5096 */
5097 struct ibss_rsn_start {
5098 u8 peer[ETH_ALEN];
5099 } ibss_rsn_start;
c2a04078
JM
5100
5101 /**
5102 * struct auth_info - Data for EVENT_AUTH events
5103 */
5104 struct auth_info {
5105 u8 peer[ETH_ALEN];
a52eba0f 5106 u8 bssid[ETH_ALEN];
c2a04078 5107 u16 auth_type;
a52eba0f 5108 u16 auth_transaction;
c2a04078
JM
5109 u16 status_code;
5110 const u8 *ies;
5111 size_t ies_len;
5112 } auth;
efa46078
JM
5113
5114 /**
5115 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
5116 */
5117 struct assoc_reject {
59ddf221
JM
5118 /**
5119 * bssid - BSSID of the AP that rejected association
5120 */
5121 const u8 *bssid;
5122
efa46078
JM
5123 /**
5124 * resp_ies - (Re)Association Response IEs
5125 *
5126 * Optional association data from the driver. This data is not
5127 * required WPA, but may be useful for some protocols and as
5128 * such, should be reported if this is available to the driver
5129 * interface.
5130 *
5131 * This should start with the first IE (fixed fields before IEs
5132 * are not included).
5133 */
59ddf221 5134 const u8 *resp_ies;
efa46078
JM
5135
5136 /**
5137 * resp_ies_len - Length of resp_ies in bytes
5138 */
5139 size_t resp_ies_len;
5140
5141 /**
5142 * status_code - Status Code from (Re)association Response
5143 */
5144 u16 status_code;
9a5160f5
JM
5145
5146 /**
5147 * timed_out - Whether failure is due to timeout (etc.) rather
5148 * than explicit rejection response from the AP.
5149 */
5150 int timed_out;
3f23260d
PK
5151
5152 /**
5153 * timeout_reason - Reason for the timeout
5154 */
5155 const char *timeout_reason;
ad295f3b
VK
5156
5157 /**
5158 * fils_erp_next_seq_num - The next sequence number to use in
5159 * FILS ERP messages
5160 */
5161 u16 fils_erp_next_seq_num;
efa46078 5162 } assoc_reject;
da1fb17c
JM
5163
5164 struct timeout_event {
5165 u8 addr[ETH_ALEN];
5166 } timeout_event;
08fd8c15 5167
f8b1f695
JM
5168 /**
5169 * struct tx_status - Data for EVENT_TX_STATUS events
5170 */
5171 struct tx_status {
5172 u16 type;
5173 u16 stype;
5174 const u8 *dst;
5175 const u8 *data;
5176 size_t data_len;
5177 int ack;
5178 } tx_status;
5179
5180 /**
5181 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
5182 */
5183 struct rx_from_unknown {
9b90955e
JB
5184 const u8 *bssid;
5185 const u8 *addr;
5186 int wds;
f8b1f695
JM
5187 } rx_from_unknown;
5188
5189 /**
5190 * struct rx_mgmt - Data for EVENT_RX_MGMT events
5191 */
5192 struct rx_mgmt {
b57e086c 5193 const u8 *frame;
f8b1f695 5194 size_t frame_len;
2a8b7416 5195 u32 datarate;
55777702 5196
1d91f504
SW
5197 /**
5198 * drv_priv - Pointer to store driver private BSS information
5199 *
5200 * If not set to NULL, this is used for comparison with
5201 * hostapd_data->drv_priv to determine which BSS should process
5202 * the frame.
5203 */
5204 void *drv_priv;
5205
55777702
JM
5206 /**
5207 * freq - Frequency (in MHz) on which the frame was received
5208 */
5209 int freq;
2d2ecf51
JM
5210
5211 /**
5212 * ssi_signal - Signal strength in dBm (or 0 if not available)
5213 */
5214 int ssi_signal;
dbfb8e82 5215 } rx_mgmt;
55777702
JM
5216
5217 /**
5218 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
5219 *
5220 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
5221 */
5222 struct remain_on_channel {
5223 /**
5224 * freq - Channel frequency in MHz
5225 */
5226 unsigned int freq;
5227
5228 /**
5229 * duration - Duration to remain on the channel in milliseconds
5230 */
5231 unsigned int duration;
5232 } remain_on_channel;
5233
8d923a4a
JM
5234 /**
5235 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
5236 * @aborted: Whether the scan was aborted
5237 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
5238 * @num_freqs: Number of entries in freqs array
5239 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
5240 * SSID)
5241 * @num_ssids: Number of entries in ssids array
adcd7c4b
KV
5242 * @external_scan: Whether the scan info is for an external scan
5243 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
5244 * 0 if the source of the scan event is a vendor scan
c16b9f8d
AS
5245 * @scan_start_tsf: Time when the scan started in terms of TSF of the
5246 * BSS that the interface that requested the scan is connected to
5247 * (if available).
5248 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
5249 * is set.
8d923a4a
JM
5250 */
5251 struct scan_info {
5252 int aborted;
5253 const int *freqs;
5254 size_t num_freqs;
5255 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
5256 size_t num_ssids;
adcd7c4b
KV
5257 int external_scan;
5258 int nl_scan_event;
c16b9f8d
AS
5259 u64 scan_start_tsf;
5260 u8 scan_start_tsf_bssid[ETH_ALEN];
8d923a4a 5261 } scan_info;
245519e0 5262
a0e0d3bb
JM
5263 /**
5264 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
5265 */
5266 struct rx_probe_req {
5267 /**
5268 * sa - Source address of the received Probe Request frame
5269 */
5270 const u8 *sa;
5271
04a85e44
JM
5272 /**
5273 * da - Destination address of the received Probe Request frame
5274 * or %NULL if not available
5275 */
5276 const u8 *da;
5277
5278 /**
5279 * bssid - BSSID of the received Probe Request frame or %NULL
5280 * if not available
5281 */
5282 const u8 *bssid;
5283
a0e0d3bb
JM
5284 /**
5285 * ie - IEs from the Probe Request body
5286 */
5287 const u8 *ie;
5288
5289 /**
5290 * ie_len - Length of ie buffer in octets
5291 */
5292 size_t ie_len;
baf513d6
JB
5293
5294 /**
5295 * signal - signal strength in dBm (or 0 if not available)
5296 */
5297 int ssi_signal;
a0e0d3bb 5298 } rx_probe_req;
a70a5d6d
JM
5299
5300 /**
5301 * struct new_sta - Data for EVENT_NEW_STA events
5302 */
5303 struct new_sta {
5304 const u8 *addr;
5305 } new_sta;
a8e0505b
JM
5306
5307 /**
5308 * struct eapol_rx - Data for EVENT_EAPOL_RX events
5309 */
5310 struct eapol_rx {
5311 const u8 *src;
5312 const u8 *data;
5313 size_t data_len;
5314 } eapol_rx;
b625473c
JM
5315
5316 /**
1c5c7273 5317 * signal_change - Data for EVENT_SIGNAL_CHANGE events
b625473c 5318 */
1c5c7273 5319 struct wpa_signal_info signal_change;
7cfc4ac3
AGS
5320
5321 /**
5322 * struct best_channel - Data for EVENT_BEST_CHANNEL events
5323 * @freq_24: Best 2.4 GHz band channel frequency in MHz
5324 * @freq_5: Best 5 GHz band channel frequency in MHz
5325 * @freq_overall: Best channel frequency in MHz
5326 *
5327 * 0 can be used to indicate no preference in either band.
5328 */
5329 struct best_channel {
5330 int freq_24;
5331 int freq_5;
5332 int freq_overall;
5333 } best_chan;
7d878ca7
JM
5334
5335 struct unprot_deauth {
5336 const u8 *sa;
5337 const u8 *da;
5338 u16 reason_code;
5339 } unprot_deauth;
5340
5341 struct unprot_disassoc {
5342 const u8 *sa;
5343 const u8 *da;
5344 u16 reason_code;
5345 } unprot_disassoc;
0d7e5a3a
JB
5346
5347 /**
5348 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
5349 * @addr: station address
68855672
JM
5350 * @num_packets: Number of packets lost (consecutive packets not
5351 * acknowledged)
0d7e5a3a
JB
5352 */
5353 struct low_ack {
5354 u8 addr[ETH_ALEN];
68855672 5355 u32 num_packets;
0d7e5a3a 5356 } low_ack;
3ac17eba 5357
ea244d21
XC
5358 /**
5359 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
5360 */
5361 struct ibss_peer_lost {
5362 u8 peer[ETH_ALEN];
5363 } ibss_peer_lost;
b14a210c
JB
5364
5365 /**
5366 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
5367 */
5368 struct driver_gtk_rekey {
5369 const u8 *bssid;
5370 const u8 *replay_ctr;
5371 } driver_gtk_rekey;
bcf24348
JB
5372
5373 /**
5374 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
5375 * @addr: station address
5376 */
5377 struct client_poll {
5378 u8 addr[ETH_ALEN];
5379 } client_poll;
dd840f79
JB
5380
5381 /**
5382 * struct eapol_tx_status
5383 * @dst: Original destination
5384 * @data: Data starting with IEEE 802.1X header (!)
5385 * @data_len: Length of data
5386 * @ack: Indicates ack or lost frame
5387 *
5388 * This corresponds to hapd_send_eapol if the frame sent
5389 * there isn't just reported as EVENT_TX_STATUS.
5390 */
5391 struct eapol_tx_status {
5392 const u8 *dst;
5393 const u8 *data;
5394 int data_len;
5395 int ack;
5396 } eapol_tx_status;
1b487b8b
TP
5397
5398 /**
5399 * struct ch_switch
5400 * @freq: Frequency of new channel in MHz
5401 * @ht_enabled: Whether this is an HT channel
5402 * @ch_offset: Secondary channel offset
8d1fdde7
JD
5403 * @ch_width: Channel width
5404 * @cf1: Center frequency 1
5405 * @cf2: Center frequency 2
1b487b8b
TP
5406 */
5407 struct ch_switch {
5408 int freq;
5409 int ht_enabled;
5410 int ch_offset;
8d1fdde7
JD
5411 enum chan_width ch_width;
5412 int cf1;
5413 int cf2;
1b487b8b 5414 } ch_switch;
3140803b
RM
5415
5416 /**
5417 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
5418 * @addr: Remote client address
5419 * @code: Reason code for connection failure
5420 */
5421 struct connect_failed_reason {
5422 u8 addr[ETH_ALEN];
5423 enum {
5424 MAX_CLIENT_REACHED,
5425 BLOCKED_CLIENT
5426 } code;
5427 } connect_failed_reason;
04be54fa
SW
5428
5429 /**
5430 * struct dfs_event - Data for radar detected events
5431 * @freq: Frequency of the channel in MHz
5432 */
5433 struct dfs_event {
5434 int freq;
846de15d
JD
5435 int ht_enabled;
5436 int chan_offset;
5437 enum chan_width chan_width;
5438 int cf1;
5439 int cf2;
04be54fa 5440 } dfs_event;
0185007c
MK
5441
5442 /**
5443 * survey_results - Survey result data for EVENT_SURVEY
5444 * @freq_filter: Requested frequency survey filter, 0 if request
5445 * was for all survey data
4e8f31e2 5446 * @survey_list: Linked list of survey data (struct freq_survey)
0185007c
MK
5447 */
5448 struct survey_results {
5449 unsigned int freq_filter;
5450 struct dl_list survey_list; /* struct freq_survey */
5451 } survey_results;
795baf77
AS
5452
5453 /**
5454 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
5455 * @initiator: Initiator of the regulatory change
142817b2
JM
5456 * @type: Regulatory change type
5457 * @alpha2: Country code (or "" if not available)
795baf77
AS
5458 */
5459 struct channel_list_changed {
5460 enum reg_change_initiator initiator;
142817b2
JM
5461 enum reg_type type;
5462 char alpha2[3];
795baf77 5463 } channel_list_changed;
253f2e37
AH
5464
5465 /**
5466 * freq_range - List of frequency ranges
5467 *
5468 * This is used as the data with EVENT_AVOID_FREQUENCIES.
5469 */
5470 struct wpa_freq_range_list freq_range;
a52024c9
BC
5471
5472 /**
5473 * struct mesh_peer
5474 *
5475 * @peer: Peer address
5476 * @ies: Beacon IEs
5477 * @ie_len: Length of @ies
5478 *
5479 * Notification of new candidate mesh peer.
5480 */
5481 struct mesh_peer {
5482 const u8 *peer;
5483 const u8 *ies;
5484 size_t ie_len;
5485 } mesh_peer;
5486
16689c7c
PX
5487 /**
5488 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
5489 * @pri_channel: Selected primary channel
5490 * @sec_channel: Selected secondary channel
857d9422
MM
5491 * @vht_seg0_center_ch: VHT mode Segment0 center channel
5492 * @vht_seg1_center_ch: VHT mode Segment1 center channel
5493 * @ch_width: Selected Channel width by driver. Driver may choose to
5494 * change hostapd configured ACS channel width due driver internal
5495 * channel restrictions.
3784c058 5496 * hw_mode: Selected band (used with hw_mode=any)
16689c7c
PX
5497 */
5498 struct acs_selected_channels {
5499 u8 pri_channel;
5500 u8 sec_channel;
857d9422
MM
5501 u8 vht_seg0_center_ch;
5502 u8 vht_seg1_center_ch;
5503 u16 ch_width;
3784c058 5504 enum hostapd_hw_mode hw_mode;
16689c7c 5505 } acs_selected_channels;
a6f5b193
PX
5506
5507 /**
5508 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
5509 * @reason_code: Reason for stopping offload
5510 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
5511 * scheduled.
5512 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
5513 * be stopped.
5514 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
5515 * parameters.
5516 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
5517 * supported by device.
5518 */
5519 struct p2p_lo_stop {
5520 enum {
5521 P2P_LO_STOPPED_REASON_COMPLETE = 0,
5522 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
5523 P2P_LO_STOPPED_REASON_INVALID_PARAM,
5524 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
5525 } reason_code;
5526 } p2p_lo_stop;
ba71cb82
SD
5527
5528 /* For EVENT_EXTERNAL_AUTH */
5529 struct external_auth external_auth;
e8ada160
T
5530
5531 /**
5532 * struct sta_opmode - Station's operation mode change event
5533 * @addr: The station MAC address
5534 * @smps_mode: SMPS mode of the station
5535 * @chan_width: Channel width of the station
5536 * @rx_nss: RX_NSS of the station
5537 *
5538 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
5539 */
5540 struct sta_opmode {
5541 const u8 *addr;
5542 enum smps_mode smps_mode;
5543 enum chan_width chan_width;
5544 u8 rx_nss;
5545 } sta_opmode;
1952b626
BP
5546
5547 /**
5548 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
5549 */
5550 struct wds_sta_interface {
5551 const u8 *sta_addr;
5552 const char *ifname;
5553 enum {
5554 INTERFACE_ADDED,
5555 INTERFACE_REMOVED
5556 } istatus;
5557 } wds_sta_interface;
6fc6879b
JM
5558};
5559
5560/**
5561 * wpa_supplicant_event - Report a driver event for wpa_supplicant
5562 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5563 * with struct wpa_driver_ops::init()
5564 * @event: event type (defined above)
5565 * @data: possible extra data for the event
5566 *
5567 * Driver wrapper code should call this function whenever an event is received
5568 * from the driver.
5569 */
9646a8ab 5570void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
6fc6879b
JM
5571 union wpa_event_data *data);
5572
45e3fc72
RM
5573/**
5574 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
5575 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5576 * with struct wpa_driver_ops::init()
5577 * @event: event type (defined above)
5578 * @data: possible extra data for the event
5579 *
5580 * Same as wpa_supplicant_event(), but we search for the interface in
5581 * wpa_global.
5582 */
5583void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
5584 union wpa_event_data *data);
c5121837 5585
1d041bec
JM
5586/*
5587 * The following inline functions are provided for convenience to simplify
5588 * event indication for some of the common events.
5589 */
5590
5591static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
39b08b5f 5592 size_t ielen, int reassoc)
1d041bec
JM
5593{
5594 union wpa_event_data event;
5595 os_memset(&event, 0, sizeof(event));
39b08b5f 5596 event.assoc_info.reassoc = reassoc;
1d041bec
JM
5597 event.assoc_info.req_ies = ie;
5598 event.assoc_info.req_ies_len = ielen;
5599 event.assoc_info.addr = addr;
5600 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
5601}
5602
5603static inline void drv_event_disassoc(void *ctx, const u8 *addr)
5604{
5605 union wpa_event_data event;
5606 os_memset(&event, 0, sizeof(event));
5607 event.disassoc_info.addr = addr;
5608 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
5609}
c5121837 5610
baac6490
JM
5611static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
5612 size_t data_len)
5613{
5614 union wpa_event_data event;
5615 os_memset(&event, 0, sizeof(event));
5616 event.eapol_rx.src = src;
5617 event.eapol_rx.data = data;
5618 event.eapol_rx.data_len = data_len;
5619 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
5620}
5621
aea855d7
JM
5622/* driver_common.c */
5623void wpa_scan_results_free(struct wpa_scan_results *res);
9e0e6902 5624
6c3771d7
BG
5625/* Convert wpa_event_type to a string for logging */
5626const char * event_to_string(enum wpa_event_type event);
5627
7a4a93b9
DW
5628/* Convert chan_width to a string for logging and control interfaces */
5629const char * channel_width_to_string(enum chan_width width);
5630
d706e0d7
MV
5631int channel_width_to_int(enum chan_width width);
5632
3eafc494
JM
5633int ht_supported(const struct hostapd_hw_modes *mode);
5634int vht_supported(const struct hostapd_hw_modes *mode);
5635
88cb27c7
DS
5636struct wowlan_triggers *
5637wpa_get_wowlan_triggers(const char *wowlan_triggers,
5638 const struct wpa_driver_capa *capa);
4d7aab78
EL
5639/* Convert driver flag to string */
5640const char * driver_flag_to_string(u64 flag);
88cb27c7 5641
fcc61230 5642/* NULL terminated array of linked in driver wrappers */
8b423edb 5643extern const struct wpa_driver_ops *const wpa_drivers[];
fcc61230 5644
39ab6a5d
JM
5645
5646/* Available drivers */
5647
5648#ifdef CONFIG_DRIVER_WEXT
5649extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
5650#endif /* CONFIG_DRIVER_WEXT */
5651#ifdef CONFIG_DRIVER_NL80211
5652/* driver_nl80211.c */
5653extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
5654#endif /* CONFIG_DRIVER_NL80211 */
5655#ifdef CONFIG_DRIVER_HOSTAP
5656extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
5657#endif /* CONFIG_DRIVER_HOSTAP */
5658#ifdef CONFIG_DRIVER_BSD
5659extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
5660#endif /* CONFIG_DRIVER_BSD */
5661#ifdef CONFIG_DRIVER_OPENBSD
5662/* driver_openbsd.c */
5663extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
5664#endif /* CONFIG_DRIVER_OPENBSD */
5665#ifdef CONFIG_DRIVER_NDIS
5666extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
5667#endif /* CONFIG_DRIVER_NDIS */
5668#ifdef CONFIG_DRIVER_WIRED
5669extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
5670#endif /* CONFIG_DRIVER_WIRED */
5671#ifdef CONFIG_DRIVER_MACSEC_QCA
5672/* driver_macsec_qca.c */
5673extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
5674#endif /* CONFIG_DRIVER_MACSEC_QCA */
f014d9db
SD
5675#ifdef CONFIG_DRIVER_MACSEC_LINUX
5676/* driver_macsec_linux.c */
5677extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops;
5678#endif /* CONFIG_DRIVER_MACSEC_LINUX */
39ab6a5d
JM
5679#ifdef CONFIG_DRIVER_ROBOSWITCH
5680/* driver_roboswitch.c */
5681extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
5682#endif /* CONFIG_DRIVER_ROBOSWITCH */
5683#ifdef CONFIG_DRIVER_ATHEROS
5684/* driver_atheros.c */
5685extern const struct wpa_driver_ops wpa_driver_atheros_ops;
5686#endif /* CONFIG_DRIVER_ATHEROS */
5687#ifdef CONFIG_DRIVER_NONE
5688extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
5689#endif /* CONFIG_DRIVER_NONE */
5690
6fc6879b 5691#endif /* DRIVER_H */