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