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