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