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