blob: 969cbda6b3491145debc2b01b44c701caa585558 [file] [log] [blame]
b.liue9582032025-04-17 19:18:16 +08001/*
2 * Driver interface definition
3 * Copyright (c) 2003-2017, Jouni Malinen <j@w1.fi>
4 *
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
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.
15 */
16
17#ifndef DRIVER_H
18#define DRIVER_H
19
20#define WPA_SUPPLICANT_DRIVER_VERSION 4
21
22#include "ap/sta_info.h"
23#include "common/defs.h"
24#include "common/ieee802_11_defs.h"
25#include "common/wpa_common.h"
26#ifdef CONFIG_MACSEC
27#include "pae/ieee802_1x_kay.h"
28#endif /* CONFIG_MACSEC */
29#include "utils/list.h"
30
31#define HOSTAPD_CHAN_DISABLED 0x00000001
32#define HOSTAPD_CHAN_NO_IR 0x00000002
33#define HOSTAPD_CHAN_RADAR 0x00000008
34#define HOSTAPD_CHAN_HT40PLUS 0x00000010
35#define HOSTAPD_CHAN_HT40MINUS 0x00000020
36#define HOSTAPD_CHAN_HT40 0x00000040
37#define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
38
39#define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
40#define HOSTAPD_CHAN_DFS_USABLE 0x00000100
41#define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
42#define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
43#define HOSTAPD_CHAN_DFS_MASK 0x00000300
44
45#define HOSTAPD_CHAN_VHT_80MHZ_SUBCHANNEL 0x00000800
46#define HOSTAPD_CHAN_VHT_160MHZ_SUBCHANNEL 0x00001000
47
48#define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
49#define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
50
51/* Allowed bandwidth mask */
52enum hostapd_chan_width_attr {
53 HOSTAPD_CHAN_WIDTH_10 = BIT(0),
54 HOSTAPD_CHAN_WIDTH_20 = BIT(1),
55 HOSTAPD_CHAN_WIDTH_40P = BIT(2),
56 HOSTAPD_CHAN_WIDTH_40M = BIT(3),
57 HOSTAPD_CHAN_WIDTH_80 = BIT(4),
58 HOSTAPD_CHAN_WIDTH_160 = BIT(5),
59 HOSTAPD_CHAN_WIDTH_320 = BIT(6),
60};
61
62/* Filter gratuitous ARP */
63#define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
64/* Filter unsolicited Neighbor Advertisement */
65#define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
66/* Filter unicast IP packets encrypted using the GTK */
67#define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)
68
69#define HOSTAPD_DFS_REGION_FCC 1
70#define HOSTAPD_DFS_REGION_ETSI 2
71#define HOSTAPD_DFS_REGION_JP 3
72
73/**
74 * enum reg_change_initiator - Regulatory change initiator
75 */
76enum reg_change_initiator {
77 REGDOM_SET_BY_CORE,
78 REGDOM_SET_BY_USER,
79 REGDOM_SET_BY_DRIVER,
80 REGDOM_SET_BY_COUNTRY_IE,
81 REGDOM_BEACON_HINT,
82};
83
84/**
85 * enum reg_type - Regulatory change types
86 */
87enum reg_type {
88 REGDOM_TYPE_UNKNOWN,
89 REGDOM_TYPE_COUNTRY,
90 REGDOM_TYPE_WORLD,
91 REGDOM_TYPE_CUSTOM_WORLD,
92 REGDOM_TYPE_INTERSECTION,
93};
94
95/**
96 * struct hostapd_wmm_rule - WMM regulatory rule
97 * @min_cwmin: Lower bound of CW_min value
98 * @min_cwmax: Lower bound of CW_max value
99 * @min_aifs: Lower bound of AIFS value
100 * @max_txop: Upper bound of TXOP, value in units of 32 usec
101 */
102struct hostapd_wmm_rule {
103 int min_cwmin;
104 int min_cwmax;
105 int min_aifs;
106 int max_txop;
107};
108
109/**
110 * struct hostapd_channel_data - Channel information
111 */
112struct hostapd_channel_data {
113 /**
114 * chan - Channel number (IEEE 802.11)
115 */
116 short chan;
117
118 /**
119 * freq - Frequency in MHz
120 */
121 int freq;
122
123 /**
124 * flag - Channel flags (HOSTAPD_CHAN_*)
125 */
126 int flag;
127
128 /**
129 * allowed_bw - Allowed channel width bitmask
130 *
131 * See enum hostapd_chan_width_attr.
132 */
133 u32 allowed_bw;
134
135 /**
136 * max_tx_power - Regulatory transmit power limit in dBm
137 */
138 u8 max_tx_power;
139
140 /**
141 * survey_list - Linked list of surveys (struct freq_survey)
142 */
143 struct dl_list survey_list;
144
145 /**
146 * min_nf - Minimum observed noise floor, in dBm, based on all
147 * surveyed channel data
148 */
149 s8 min_nf;
150
151#ifdef CONFIG_ACS
152 /**
153 * interference_factor - Computed interference factor on this
154 * channel (used internally in src/ap/acs.c; driver wrappers do not
155 * need to set this)
156 */
157 long double interference_factor;
158#endif /* CONFIG_ACS */
159
160 /**
161 * dfs_cac_ms - DFS CAC time in milliseconds
162 */
163 unsigned int dfs_cac_ms;
164
165 /**
166 * wmm_rules_valid - Indicates wmm_rules state
167 */
168 int wmm_rules_valid;
169
170 /**
171 * wmm_rules - WMM regulatory rules
172 */
173 struct hostapd_wmm_rule wmm_rules[WMM_AC_NUM];
174
175 /**
176 * punct_bitmap - RU puncturing bitmap
177 */
178 u16 punct_bitmap;
179};
180
181#define HE_MAC_CAPAB_0 0
182#define HE_MAX_MAC_CAPAB_SIZE 6
183#define HE_MAX_PHY_CAPAB_SIZE 11
184#define HE_MAX_MCS_CAPAB_SIZE 12
185#define HE_MAX_PPET_CAPAB_SIZE 25
186
187/**
188 * struct he_capabilities - IEEE 802.11ax HE capabilities
189 */
190struct he_capabilities {
191 u8 he_supported;
192 u8 phy_cap[HE_MAX_PHY_CAPAB_SIZE];
193 u8 mac_cap[HE_MAX_MAC_CAPAB_SIZE];
194 u8 mcs[HE_MAX_MCS_CAPAB_SIZE];
195 u8 ppet[HE_MAX_PPET_CAPAB_SIZE];
196 u16 he_6ghz_capa;
197};
198
199/* struct eht_capabilities - IEEE 802.11be EHT capabilities */
200struct eht_capabilities {
201 bool eht_supported;
202 u16 mac_cap;
203 u8 phy_cap[EHT_PHY_CAPAB_LEN];
204 u8 mcs[EHT_MCS_NSS_CAPAB_LEN];
205 u8 ppet[EHT_PPE_THRESH_CAPAB_LEN];
206};
207
208#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
209#define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
210#define HOSTAPD_MODE_FLAG_HE_INFO_KNOWN BIT(2)
211
212
213enum ieee80211_op_mode {
214 IEEE80211_MODE_INFRA = 0,
215 IEEE80211_MODE_IBSS = 1,
216 IEEE80211_MODE_AP = 2,
217 IEEE80211_MODE_MESH = 5,
218
219 /* only add new entries before IEEE80211_MODE_NUM */
220 IEEE80211_MODE_NUM
221};
222
223/**
224 * struct ieee80211_edmg_config - EDMG configuration
225 *
226 * This structure describes most essential parameters needed
227 * for IEEE 802.11ay EDMG configuration
228 *
229 * @channels: Bitmap that indicates the 2.16 GHz channel(s)
230 * that are allowed to be used for transmissions.
231 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
232 * Set to 0 to indicate EDMG not supported.
233 * @bw_config: Channel BW Configuration subfield encodes
234 * the allowed channel bandwidth configurations
235 */
236struct ieee80211_edmg_config {
237 u8 channels;
238 enum edmg_bw_config bw_config;
239};
240
241/**
242 * struct hostapd_hw_modes - Supported hardware mode information
243 */
244struct hostapd_hw_modes {
245 /**
246 * mode - Hardware mode
247 */
248 enum hostapd_hw_mode mode;
249
250 /**
251 * num_channels - Number of entries in the channels array
252 */
253 int num_channels;
254
255 /**
256 * channels - Array of supported channels
257 */
258 struct hostapd_channel_data *channels;
259
260 /**
261 * num_rates - Number of entries in the rates array
262 */
263 int num_rates;
264
265 /**
266 * rates - Array of supported rates in 100 kbps units
267 */
268 int *rates;
269
270 /**
271 * ht_capab - HT (IEEE 802.11n) capabilities
272 */
273 u16 ht_capab;
274
275 /**
276 * mcs_set - MCS (IEEE 802.11n) rate parameters
277 */
278 u8 mcs_set[16];
279
280 /**
281 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
282 */
283 u8 a_mpdu_params;
284
285 /**
286 * vht_capab - VHT (IEEE 802.11ac) capabilities
287 */
288 u32 vht_capab;
289
290 /**
291 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
292 */
293 u8 vht_mcs_set[8];
294
295 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
296
297 /**
298 * he_capab - HE (IEEE 802.11ax) capabilities
299 */
300 struct he_capabilities he_capab[IEEE80211_MODE_NUM];
301
302 /**
303 * This structure describes the most essential parameters needed
304 * for IEEE 802.11ay EDMG configuration.
305 */
306 struct ieee80211_edmg_config edmg;
307
308 /**
309 * eht_capab - EHT (IEEE 802.11be) capabilities
310 */
311 struct eht_capabilities eht_capab[IEEE80211_MODE_NUM];
312};
313
314
315#define IEEE80211_CAP_ESS 0x0001
316#define IEEE80211_CAP_IBSS 0x0002
317#define IEEE80211_CAP_PRIVACY 0x0010
318#define IEEE80211_CAP_RRM 0x1000
319
320/* DMG (60 GHz) IEEE 802.11ad */
321/* type - bits 0..1 */
322#define IEEE80211_CAP_DMG_MASK 0x0003
323#define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
324#define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
325#define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
326
327#define WPA_SCAN_QUAL_INVALID BIT(0)
328#define WPA_SCAN_NOISE_INVALID BIT(1)
329#define WPA_SCAN_LEVEL_INVALID BIT(2)
330#define WPA_SCAN_LEVEL_DBM BIT(3)
331#define WPA_SCAN_ASSOCIATED BIT(5)
332
333/**
334 * struct wpa_scan_res - Scan result for an BSS/IBSS
335 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
336 * @bssid: BSSID
337 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
338 * @beacon_int: beacon interval in TUs (host byte order)
339 * @caps: capability information field in host byte order
340 * @qual: signal quality
341 * @noise: noise level
342 * @level: signal level
343 * @tsf: Timestamp
344 * @age: Age of the information in milliseconds (i.e., how many milliseconds
345 * ago the last Beacon or Probe Response frame was received)
346 * @est_throughput: Estimated throughput in kbps (this is calculated during
347 * scan result processing if left zero by the driver wrapper)
348 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
349 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
350 * of TSF of the BSS specified by %tsf_bssid.
351 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
352 * @beacon_newer: Whether the Beacon frame data is known to be newer
353 * @ie_len: length of the following IE field in octets
354 * @beacon_ie_len: length of the following Beacon IE field in octets
355 *
356 * This structure is used as a generic format for scan results from the
357 * driver. Each driver interface implementation is responsible for converting
358 * the driver or OS specific scan results into this format.
359 *
360 * If the driver does not support reporting all IEs, the IE data structure is
361 * constructed of the IEs that are available. This field will also need to
362 * include SSID in IE format. All drivers are encouraged to be extended to
363 * report all IEs to make it easier to support future additions.
364 *
365 * This structure data is followed by ie_len octets of IEs from Probe Response
366 * frame (or if the driver does not indicate source of IEs, these may also be
367 * from Beacon frame). After the first set of IEs, another set of IEs may follow
368 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
369 */
370struct wpa_scan_res {
371 unsigned int flags;
372 u8 bssid[ETH_ALEN];
373 int freq;
374 u16 beacon_int;
375 u16 caps;
376 int qual;
377 int noise;
378 int level;
379 u64 tsf;
380 unsigned int age;
381 unsigned int est_throughput;
382 int snr;
383 u64 parent_tsf;
384 u8 tsf_bssid[ETH_ALEN];
385 bool beacon_newer;
386 size_t ie_len;
387 size_t beacon_ie_len;
388 /* Followed by ie_len + beacon_ie_len octets of IE data */
389};
390
391/**
392 * struct wpa_scan_results - Scan results
393 * @res: Array of pointers to allocated variable length scan result entries
394 * @num: Number of entries in the scan result array
395 * @fetch_time: Time when the results were fetched from the driver
396 */
397struct wpa_scan_results {
398 struct wpa_scan_res **res;
399 size_t num;
400 struct os_reltime fetch_time;
401};
402
403/**
404 * struct wpa_interface_info - Network interface information
405 * @next: Pointer to the next interface or NULL if this is the last one
406 * @ifname: Interface name that can be used with init() or init2()
407 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
408 * not available
409 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
410 * is not an allocated copy, i.e., get_interfaces() caller will not free
411 * this)
412 */
413struct wpa_interface_info {
414 struct wpa_interface_info *next;
415 char *ifname;
416 char *desc;
417 const char *drv_name;
418};
419
420#define WPAS_MAX_SCAN_SSIDS 16
421
422/**
423 * struct wpa_driver_scan_ssid - SSIDs to scan for
424 * @ssid - specific SSID to scan for (ProbeReq)
425 * %NULL or zero-length SSID is used to indicate active scan
426 * with wildcard SSID.
427 * @ssid_len - Length of the SSID in octets
428 */
429struct wpa_driver_scan_ssid {
430 const u8 *ssid;
431 size_t ssid_len;
432};
433
434struct t2lm_mapping {
435 /**
436 * downlink - Bitmap of TIDs mapped with a link in downlink direction
437 */
438 u8 downlink;
439
440 /**
441 * uplink - Bitmap of TIDs mapped with a link in uplink direction
442 */
443 u8 uplink;
444};
445
446/**
447 * struct wpa_driver_scan_params - Scan parameters
448 * Data for struct wpa_driver_ops::scan2().
449 */
450struct wpa_driver_scan_params {
451 /**
452 * ssids - SSIDs to scan for
453 */
454 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
455
456 /**
457 * num_ssids - Number of entries in ssids array
458 * Zero indicates a request for a passive scan.
459 */
460 size_t num_ssids;
461
462 /**
463 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
464 */
465 const u8 *extra_ies;
466
467 /**
468 * extra_ies_len - Length of extra_ies in octets
469 */
470 size_t extra_ies_len;
471
472 /**
473 * freqs - Array of frequencies to scan or %NULL for all frequencies
474 *
475 * The frequency is set in MHz. The array is zero-terminated.
476 */
477 int *freqs;
478
479 /**
480 * filter_ssids - Filter for reporting SSIDs
481 *
482 * This optional parameter can be used to request the driver wrapper to
483 * filter scan results to include only the specified SSIDs. %NULL
484 * indicates that no filtering is to be done. This can be used to
485 * reduce memory needs for scan results in environments that have large
486 * number of APs with different SSIDs.
487 *
488 * The driver wrapper is allowed to take this allocated buffer into its
489 * own use by setting the pointer to %NULL. In that case, the driver
490 * wrapper is responsible for freeing the buffer with os_free() once it
491 * is not needed anymore.
492 */
493 struct wpa_driver_scan_filter {
494 u8 ssid[SSID_MAX_LEN];
495 size_t ssid_len;
496 } *filter_ssids;
497
498 /**
499 * num_filter_ssids - Number of entries in filter_ssids array
500 */
501 size_t num_filter_ssids;
502
503 /**
504 * filter_rssi - Filter by RSSI
505 *
506 * The driver may filter scan results in firmware to reduce host
507 * wakeups and thereby save power. Specify the RSSI threshold in s32
508 * dBm.
509 */
510 s32 filter_rssi;
511
512 /**
513 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
514 *
515 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
516 * Mbps from the support rates element(s) in the Probe Request frames
517 * and not to transmit the frames at any of those rates.
518 */
519 unsigned int p2p_probe:1;
520
521 /**
522 * only_new_results - Request driver to report only new results
523 *
524 * This is used to request the driver to report only BSSes that have
525 * been detected after this scan request has been started, i.e., to
526 * flush old cached BSS entries.
527 */
528 unsigned int only_new_results:1;
529
530 /**
531 * low_priority - Requests driver to use a lower scan priority
532 *
533 * This is used to request the driver to use a lower scan priority
534 * if it supports such a thing.
535 */
536 unsigned int low_priority:1;
537
538 /**
539 * mac_addr_rand - Requests driver to randomize MAC address
540 */
541 unsigned int mac_addr_rand:1;
542
543 /**
544 * mac_addr - MAC address used with randomization. The address cannot be
545 * a multicast one, i.e., bit 0 of byte 0 should not be set.
546 */
547 u8 *mac_addr;
548
549 /**
550 * mac_addr_mask - MAC address mask used with randomization.
551 *
552 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
553 * the mask should be taken as is from mac_addr. The mask should not
554 * allow the generation of a multicast address, i.e., bit 0 of byte 0
555 * must be set.
556 */
557 const u8 *mac_addr_mask;
558
559 /**
560 * sched_scan_plans - Scan plans for scheduled scan
561 *
562 * Each scan plan consists of the number of iterations to scan and the
563 * interval between scans. When a scan plan finishes (i.e., it was run
564 * for the specified number of iterations), the next scan plan is
565 * executed. The scan plans are executed in the order they appear in
566 * the array (lower index first). The last scan plan will run infinitely
567 * (until requested to stop), thus must not specify the number of
568 * iterations. All other scan plans must specify the number of
569 * iterations.
570 */
571 struct sched_scan_plan {
572 u32 interval; /* In seconds */
573 u32 iterations; /* Zero to run infinitely */
574 } *sched_scan_plans;
575
576 /**
577 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
578 */
579 unsigned int sched_scan_plans_num;
580
581 /**
582 * sched_scan_start_delay - Delay to use before starting the first scan
583 *
584 * Delay (in seconds) before scheduling first scan plan cycle. The
585 * driver may ignore this parameter and start immediately (or at any
586 * other time), if this feature is not supported.
587 */
588 u32 sched_scan_start_delay;
589
590 /**
591 * bssid - Specific BSSID to scan for
592 *
593 * This optional parameter can be used to replace the default wildcard
594 * BSSID with a specific BSSID to scan for if results are needed from
595 * only a single BSS.
596 */
597 const u8 *bssid;
598
599 /**
600 * scan_cookie - Unique identification representing the scan request
601 *
602 * This scan_cookie carries a unique identification representing the
603 * scan request if the host driver/kernel supports concurrent scan
604 * requests. This cookie is returned from the corresponding driver
605 * interface.
606 *
607 * Note: Unlike other parameters in this structure, scan_cookie is used
608 * only to return information instead of setting parameters for the
609 * scan.
610 */
611 u64 scan_cookie;
612
613 /**
614 * duration - Dwell time on each channel
615 *
616 * This optional parameter can be used to set the dwell time on each
617 * channel. In TUs.
618 */
619 u16 duration;
620
621 /**
622 * duration_mandatory - Whether the specified duration is mandatory
623 *
624 * If this is set, the duration specified by the %duration field is
625 * mandatory (and the driver should reject the scan request if it is
626 * unable to comply with the specified duration), otherwise it is the
627 * maximum duration and the actual duration may be shorter.
628 */
629 unsigned int duration_mandatory:1;
630
631 /**
632 * relative_rssi_set - Whether relative RSSI parameters are set
633 */
634 unsigned int relative_rssi_set:1;
635
636 /**
637 * relative_rssi - Relative RSSI for reporting better BSSs
638 *
639 * Amount of RSSI by which a BSS should be better than the current
640 * connected BSS to report the new BSS to user space.
641 */
642 s8 relative_rssi;
643
644 /**
645 * relative_adjust_band - Band to which RSSI should be adjusted
646 *
647 * The relative_adjust_rssi should be added to the band specified
648 * by relative_adjust_band.
649 */
650 enum set_band relative_adjust_band;
651
652 /**
653 * relative_adjust_rssi - RSSI to be added to relative_adjust_band
654 *
655 * An amount of relative_band_rssi should be added to the BSSs that
656 * belong to the band specified by relative_adjust_band while comparing
657 * with other bands for BSS reporting.
658 */
659 s8 relative_adjust_rssi;
660
661 /**
662 * oce_scan
663 *
664 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0)
665 * - Accept broadcast Probe Response frame.
666 * - Probe Request frame deferral and suppression.
667 * - Max Channel Time - driver fills FILS request params IE with
668 * Maximum Channel Time.
669 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps.
670 */
671 unsigned int oce_scan:1;
672
673 /**
674 * p2p_include_6ghz - Include 6 GHz channels for P2P full scan
675 *
676 */
677 unsigned int p2p_include_6ghz:1;
678
679 /**
680 * non_coloc_6ghz - Force scanning of non-PSC 6 GHz channels
681 *
682 * If this is set, the driver should scan non-PSC channels from the
683 * scan request even if neighbor reports from 2.4/5 GHz APs did not
684 * report a co-located AP on these channels. The default is to scan
685 * non-PSC channels only if a co-located AP was reported on the channel.
686 */
687 unsigned int non_coloc_6ghz:1;
688
689 /*
690 * NOTE: Whenever adding new parameters here, please make sure
691 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
692 * matching changes.
693 */
694};
695
696/**
697 * struct wpa_driver_auth_params - Authentication parameters
698 * Data for struct wpa_driver_ops::authenticate().
699 */
700struct wpa_driver_auth_params {
701 int freq;
702 const u8 *bssid;
703 const u8 *ssid;
704 size_t ssid_len;
705 int auth_alg;
706 const u8 *ie;
707 size_t ie_len;
708 const u8 *wep_key[4];
709 size_t wep_key_len[4];
710 int wep_tx_keyidx;
711 int local_state_change;
712
713 /**
714 * p2p - Whether this connection is a P2P group
715 */
716 int p2p;
717
718 /**
719 * auth_data - Additional elements for Authentication frame
720 *
721 * This buffer starts with the Authentication transaction sequence
722 * number field. If no special handling of such elements is needed, this
723 * pointer is %NULL. This is used with SAE and FILS.
724 */
725 const u8 *auth_data;
726
727 /**
728 * auth_data_len - Length of auth_data buffer in octets
729 */
730 size_t auth_data_len;
731
732 /**
733 * mld - Establish an MLD connection
734 */
735 bool mld;
736
737 /**
738 * mld_link_id - The link ID of the MLD AP to which we are associating
739 */
740 u8 mld_link_id;
741
742 /**
743 * The MLD AP address
744 */
745 const u8 *ap_mld_addr;
746};
747
748/**
749 * enum wps_mode - WPS mode
750 */
751enum wps_mode {
752 /**
753 * WPS_MODE_NONE - No WPS provisioning being used
754 */
755 WPS_MODE_NONE,
756
757 /**
758 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
759 */
760 WPS_MODE_OPEN,
761
762 /**
763 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
764 */
765 WPS_MODE_PRIVACY
766};
767
768/**
769 * struct hostapd_freq_params - Channel parameters
770 */
771struct hostapd_freq_params {
772 /**
773 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
774 */
775 enum hostapd_hw_mode mode;
776
777 /**
778 * freq - Primary channel center frequency in MHz
779 */
780 int freq;
781
782 /**
783 * channel - Channel number
784 */
785 int channel;
786
787 /**
788 * ht_enabled - Whether HT is enabled
789 */
790 int ht_enabled;
791
792 /**
793 * sec_channel_offset - Secondary channel offset for HT40
794 *
795 * 0 = HT40 disabled,
796 * -1 = HT40 enabled, secondary channel below primary,
797 * 1 = HT40 enabled, secondary channel above primary
798 */
799 int sec_channel_offset;
800
801 /**
802 * vht_enabled - Whether VHT is enabled
803 */
804 int vht_enabled;
805
806 /**
807 * he_enabled - Whether HE is enabled
808 */
809 int he_enabled;
810
811 /**
812 * center_freq1 - Segment 0 center frequency in MHz
813 *
814 * Valid for both HT and VHT.
815 */
816 int center_freq1;
817
818 /**
819 * center_freq2 - Segment 1 center frequency in MHz
820 *
821 * Non-zero only for bandwidth 80 and an 80+80 channel
822 */
823 int center_freq2;
824
825 /**
826 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
827 */
828 int bandwidth;
829
830 /**
831 * This structure describes the most essential parameters needed
832 * for IEEE 802.11ay EDMG configuration.
833 */
834 struct ieee80211_edmg_config edmg;
835
836 /**
837 * radar_background - Whether radar/CAC background is requested
838 */
839 bool radar_background;
840
841 /**
842 * eht_enabled - Whether EHT is enabled
843 */
844 bool eht_enabled;
845
846 /**
847 * link_id: If >=0 indicates the link of the AP MLD to configure
848 */
849 int link_id;
850};
851
852/**
853 * struct wpa_driver_sta_auth_params - Authentication parameters
854 * Data for struct wpa_driver_ops::sta_auth().
855 */
856struct wpa_driver_sta_auth_params {
857
858 /**
859 * own_addr - Source address and BSSID for authentication frame
860 */
861 const u8 *own_addr;
862
863 /**
864 * addr - MAC address of the station to associate
865 */
866 const u8 *addr;
867
868 /**
869 * seq - authentication sequence number
870 */
871 u16 seq;
872
873 /**
874 * status - authentication response status code
875 */
876 u16 status;
877
878 /**
879 * ie - authentication frame ie buffer
880 */
881 const u8 *ie;
882
883 /**
884 * len - ie buffer length
885 */
886 size_t len;
887
888 /**
889 * fils_auth - Indicates whether FILS authentication is being performed
890 */
891 int fils_auth;
892
893 /**
894 * fils_anonce - ANonce (required for FILS)
895 */
896 u8 fils_anonce[WPA_NONCE_LEN];
897
898 /**
899 * fils_snonce - SNonce (required for FILS)
900 */
901 u8 fils_snonce[WPA_NONCE_LEN];
902
903 /**
904 * fils_kek - key for encryption (required for FILS)
905 */
906 u8 fils_kek[WPA_KEK_MAX_LEN];
907
908 /**
909 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
910 */
911 size_t fils_kek_len;
912};
913
914struct wpa_driver_mld_params {
915 /**
916 * mld_addr - AP's MLD address
917 */
918 const u8 *mld_addr;
919
920 /**
921 * valid_links - The valid links including the association link
922 */
923 u16 valid_links;
924
925 /**
926 * assoc_link_id - The link on which the association is performed
927 */
928 u8 assoc_link_id;
929
930 /**
931 * mld_links - Link information
932 *
933 * Should include information on all the requested links for association
934 * including the link on which the association should take place.
935 * For the association link, the ies and ies_len should be NULL and
936 * 0 respectively.
937 */
938 struct {
939 int freq;
940 const u8 *bssid;
941 const u8 *ies;
942 size_t ies_len;
943 } mld_links[MAX_NUM_MLD_LINKS];
944};
945
946/**
947 * struct wpa_driver_associate_params - Association parameters
948 * Data for struct wpa_driver_ops::associate().
949 */
950struct wpa_driver_associate_params {
951 /**
952 * bssid - BSSID of the selected AP
953 * This can be %NULL, if ap_scan=2 mode is used and the driver is
954 * responsible for selecting with which BSS to associate. */
955 const u8 *bssid;
956
957 unsigned char rates[WLAN_SUPP_RATES_MAX];
958 int mcast_rate;
959
960 /**
961 * bssid_hint - BSSID of a proposed AP
962 *
963 * This indicates which BSS has been found a suitable candidate for
964 * initial association for drivers that use driver/firmwate-based BSS
965 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
966 * the driver from selecting other BSSes in the ESS.
967 */
968 const u8 *bssid_hint;
969
970 /**
971 * ssid - The selected SSID
972 */
973 const u8 *ssid;
974
975 /**
976 * ssid_len - Length of the SSID (1..32)
977 */
978 size_t ssid_len;
979
980 /**
981 * freq - channel parameters
982 */
983 struct hostapd_freq_params freq;
984
985 /**
986 * freq_hint - Frequency of the channel the proposed AP is using
987 *
988 * This provides a channel on which a suitable BSS has been found as a
989 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
990 * limit the driver from selecting other channels for
991 * driver/firmware-based BSS selection.
992 */
993 int freq_hint;
994
995 /**
996 * bg_scan_period - Background scan period in seconds, 0 to disable
997 * background scan, or -1 to indicate no change to default driver
998 * configuration
999 */
1000 int bg_scan_period;
1001
1002 /**
1003 * beacon_int - Beacon interval for IBSS or 0 to use driver default
1004 */
1005 int beacon_int;
1006
1007 /**
1008 * wpa_ie - WPA information element for (Re)Association Request
1009 * WPA information element to be included in (Re)Association
1010 * Request (including information element id and length). Use
1011 * of this WPA IE is optional. If the driver generates the WPA
1012 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
1013 * key_mgmt_suite to select proper algorithms. In this case,
1014 * the driver has to notify wpa_supplicant about the used WPA
1015 * IE by generating an event that the interface code will
1016 * convert into EVENT_ASSOCINFO data (see below).
1017 *
1018 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
1019 * instead. The driver can determine which version is used by
1020 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
1021 * WPA2/RSN).
1022 *
1023 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
1024 */
1025 const u8 *wpa_ie;
1026
1027 /**
1028 * wpa_ie_len - length of the wpa_ie
1029 */
1030 size_t wpa_ie_len;
1031
1032 /**
1033 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
1034 */
1035 unsigned int wpa_proto;
1036
1037 /**
1038 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
1039 *
1040 * This is usually ignored if @wpa_ie is used.
1041 */
1042 unsigned int pairwise_suite;
1043
1044 /**
1045 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
1046 *
1047 * This is usually ignored if @wpa_ie is used.
1048 */
1049 unsigned int group_suite;
1050
1051 /**
1052 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
1053 *
1054 * This is usually ignored if @wpa_ie is used.
1055 */
1056 unsigned int mgmt_group_suite;
1057
1058 /**
1059 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
1060 *
1061 * This is usually ignored if @wpa_ie is used.
1062 */
1063 unsigned int key_mgmt_suite;
1064
1065 /**
1066 * allowed_key_mgmts - Bitfield of allowed key management suites
1067 * (WPA_KEY_MGMT_*) other than @key_mgmt_suite for the current
1068 * connection
1069 *
1070 * SME in the driver may choose key_mgmt from this list for the initial
1071 * connection or roaming. The driver which doesn't support this
1072 * ignores this parameter.
1073 */
1074 unsigned int allowed_key_mgmts;
1075
1076 /**
1077 * auth_alg - Allowed authentication algorithms
1078 * Bit field of WPA_AUTH_ALG_*
1079 */
1080 int auth_alg;
1081
1082 /**
1083 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
1084 */
1085 int mode;
1086
1087 /**
1088 * wep_key - WEP keys for static WEP configuration
1089 */
1090 const u8 *wep_key[4];
1091
1092 /**
1093 * wep_key_len - WEP key length for static WEP configuration
1094 */
1095 size_t wep_key_len[4];
1096
1097 /**
1098 * wep_tx_keyidx - WEP TX key index for static WEP configuration
1099 */
1100 int wep_tx_keyidx;
1101
1102 /**
1103 * mgmt_frame_protection - IEEE 802.11w management frame protection
1104 */
1105 enum mfp_options mgmt_frame_protection;
1106
1107 /**
1108 * passphrase - RSN passphrase for PSK
1109 *
1110 * This value is made available only for WPA/WPA2-Personal (PSK) and
1111 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
1112 * is the 8..63 character ASCII passphrase, if available. Please note
1113 * that this can be %NULL if passphrase was not used to generate the
1114 * PSK. In that case, the psk field must be used to fetch the PSK.
1115 */
1116 const char *passphrase;
1117
1118 /**
1119 * psk - RSN PSK (alternative for passphrase for PSK)
1120 *
1121 * This value is made available only for WPA/WPA2-Personal (PSK) and
1122 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
1123 * is the 32-octet (256-bit) PSK, if available. The driver wrapper
1124 * should be prepared to handle %NULL value as an error.
1125 */
1126 const u8 *psk;
1127
1128 /**
1129 * drop_unencrypted - Enable/disable unencrypted frame filtering
1130 *
1131 * Configure the driver to drop all non-EAPOL frames (both receive and
1132 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
1133 * still be allowed for key negotiation.
1134 */
1135 int drop_unencrypted;
1136
1137 /**
1138 * prev_bssid - Previously used BSSID in this ESS
1139 *
1140 * When not %NULL, this is a request to use reassociation instead of
1141 * association.
1142 */
1143 const u8 *prev_bssid;
1144
1145 /**
1146 * wps - WPS mode
1147 *
1148 * If the driver needs to do special configuration for WPS association,
1149 * this variable provides more information on what type of association
1150 * is being requested. Most drivers should not need to use this.
1151 */
1152 enum wps_mode wps;
1153
1154 /**
1155 * p2p - Whether this connection is a P2P group
1156 */
1157 int p2p;
1158
1159 /**
1160 * uapsd - UAPSD parameters for the network
1161 * -1 = do not change defaults
1162 * AP mode: 1 = enabled, 0 = disabled
1163 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
1164 */
1165 int uapsd;
1166
1167 /**
1168 * fixed_bssid - Whether to force this BSSID in IBSS mode
1169 * 1 = Fix this BSSID and prevent merges.
1170 * 0 = Do not fix BSSID.
1171 */
1172 int fixed_bssid;
1173
1174 /**
1175 * fixed_freq - Fix control channel in IBSS mode
1176 * 0 = don't fix control channel (default)
1177 * 1 = fix control channel; this prevents IBSS merging with another
1178 * channel
1179 */
1180 int fixed_freq;
1181
1182 /**
1183 * disable_ht - Disable HT (IEEE 802.11n) for this connection
1184 */
1185 int disable_ht;
1186
1187 /**
1188 * htcaps - HT Capabilities over-rides
1189 *
1190 * Only bits set in the mask will be used, and not all values are used
1191 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
1192 *
1193 * Pointer to struct ieee80211_ht_capabilities.
1194 */
1195 const u8 *htcaps;
1196
1197 /**
1198 * htcaps_mask - HT Capabilities over-rides mask
1199 *
1200 * Pointer to struct ieee80211_ht_capabilities.
1201 */
1202 const u8 *htcaps_mask;
1203
1204#ifdef CONFIG_VHT_OVERRIDES
1205 /**
1206 * disable_vht - Disable VHT for this connection
1207 */
1208 int disable_vht;
1209
1210 /**
1211 * VHT capability overrides.
1212 */
1213 const struct ieee80211_vht_capabilities *vhtcaps;
1214 const struct ieee80211_vht_capabilities *vhtcaps_mask;
1215#endif /* CONFIG_VHT_OVERRIDES */
1216
1217#ifdef CONFIG_HE_OVERRIDES
1218 /**
1219 * disable_he - Disable HE for this connection
1220 */
1221 int disable_he;
1222#endif /* CONFIG_HE_OVERRIDES */
1223
1224 /**
1225 * req_key_mgmt_offload - Request key management offload for connection
1226 *
1227 * Request key management offload for this connection if the device
1228 * supports it.
1229 */
1230 int req_key_mgmt_offload;
1231
1232 /**
1233 * req_handshake_offload - Request EAPOL handshake offload
1234 *
1235 * Request EAPOL handshake offload for this connection if the device
1236 * supports it.
1237 */
1238 int req_handshake_offload;
1239
1240 /**
1241 * Flag for indicating whether this association includes support for
1242 * RRM (Radio Resource Measurements)
1243 */
1244 int rrm_used;
1245
1246 /**
1247 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1248 * AP as usual. Valid for DMG network only.
1249 */
1250 int pbss;
1251
1252 /**
1253 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1254 */
1255 const u8 *fils_kek;
1256
1257 /**
1258 * fils_kek_len: Length of fils_kek in bytes
1259 */
1260 size_t fils_kek_len;
1261
1262 /**
1263 * fils_nonces - Nonces for FILS association frame protection
1264 * (AES-SIV AAD)
1265 */
1266 const u8 *fils_nonces;
1267
1268 /**
1269 * fils_nonces_len: Length of fils_nonce in bytes
1270 */
1271 size_t fils_nonces_len;
1272
1273 /**
1274 * fils_erp_username - Username part of keyName-NAI
1275 */
1276 const u8 *fils_erp_username;
1277
1278 /**
1279 * fils_erp_username_len - Length of fils_erp_username in bytes
1280 */
1281 size_t fils_erp_username_len;
1282
1283 /**
1284 * fils_erp_realm - Realm/domain name to use in FILS ERP
1285 */
1286 const u8 *fils_erp_realm;
1287
1288 /**
1289 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1290 */
1291 size_t fils_erp_realm_len;
1292
1293 /**
1294 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1295 * messages
1296 */
1297 u16 fils_erp_next_seq_num;
1298
1299 /**
1300 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1301 * specified by fils_erp_username@fils_erp_realm.
1302 */
1303 const u8 *fils_erp_rrk;
1304
1305 /**
1306 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1307 */
1308 size_t fils_erp_rrk_len;
1309
1310 /**
1311 * sae_pwe - SAE mechanism for PWE derivation
1312 * 0 = hunting-and-pecking loop only
1313 * 1 = hash-to-element only
1314 * 2 = both hunting-and-pecking loop and hash-to-element enabled
1315 */
1316 enum sae_pwe sae_pwe;
1317
1318 /**
1319 * disable_eht - Disable EHT for this connection
1320 */
1321 int disable_eht;
1322
1323 /*
1324 * mld_params - MLD association parameters
1325 */
1326 struct wpa_driver_mld_params mld_params;
1327};
1328
1329enum hide_ssid {
1330 NO_SSID_HIDING,
1331 HIDDEN_SSID_ZERO_LEN,
1332 HIDDEN_SSID_ZERO_CONTENTS
1333};
1334
1335enum ch_switch_state {
1336 CH_SW_STARTED,
1337 CH_SW_FINISHED
1338};
1339
1340struct wowlan_triggers {
1341 u8 any;
1342 u8 disconnect;
1343 u8 magic_pkt;
1344 u8 gtk_rekey_failure;
1345 u8 eap_identity_req;
1346 u8 four_way_handshake;
1347 u8 rfkill_release;
1348};
1349
1350struct wpa_driver_ap_params {
1351 /**
1352 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1353 */
1354 u8 *head;
1355
1356 /**
1357 * head_len - Length of the head buffer in octets
1358 */
1359 size_t head_len;
1360
1361 /**
1362 * tail - Beacon tail following TIM IE
1363 */
1364 u8 *tail;
1365
1366 /**
1367 * tail_len - Length of the tail buffer in octets
1368 */
1369 size_t tail_len;
1370
1371 /**
1372 * dtim_period - DTIM period
1373 */
1374 int dtim_period;
1375
1376 /**
1377 * beacon_int - Beacon interval
1378 */
1379 int beacon_int;
1380
1381 /**
1382 * basic_rates: -1 terminated array of basic rates in 100 kbps
1383 *
1384 * This parameter can be used to set a specific basic rate set for the
1385 * BSS. If %NULL, default basic rate set is used.
1386 */
1387 int *basic_rates;
1388
1389 /**
1390 * beacon_rate: Beacon frame data rate
1391 *
1392 * This parameter can be used to set a specific Beacon frame data rate
1393 * for the BSS. The interpretation of this value depends on the
1394 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS,
1395 * HE: HE-MCS). If beacon_rate == 0 and rate_type == 0
1396 * (BEACON_RATE_LEGACY), the default Beacon frame data rate is used.
1397 */
1398 unsigned int beacon_rate;
1399
1400 /**
1401 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT/HE)
1402 */
1403 enum beacon_rate_type rate_type;
1404
1405 /**
1406 * proberesp - Probe Response template
1407 *
1408 * This is used by drivers that reply to Probe Requests internally in
1409 * AP mode and require the full Probe Response template.
1410 */
1411 u8 *proberesp;
1412
1413 /**
1414 * proberesp_len - Length of the proberesp buffer in octets
1415 */
1416 size_t proberesp_len;
1417
1418 /**
1419 * ssid - The SSID to use in Beacon/Probe Response frames
1420 */
1421 const u8 *ssid;
1422
1423 /**
1424 * ssid_len - Length of the SSID (1..32)
1425 */
1426 size_t ssid_len;
1427
1428 /**
1429 * hide_ssid - Whether to hide the SSID
1430 */
1431 enum hide_ssid hide_ssid;
1432
1433 /**
1434 * pairwise_ciphers - WPA_CIPHER_* bitfield
1435 */
1436 unsigned int pairwise_ciphers;
1437
1438 /**
1439 * group_cipher - WPA_CIPHER_*
1440 */
1441 unsigned int group_cipher;
1442
1443 /**
1444 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1445 */
1446 unsigned int key_mgmt_suites;
1447
1448 /**
1449 * auth_algs - WPA_AUTH_ALG_* bitfield
1450 */
1451 unsigned int auth_algs;
1452
1453 /**
1454 * wpa_version - WPA_PROTO_* bitfield
1455 */
1456 unsigned int wpa_version;
1457
1458 /**
1459 * privacy - Whether privacy is used in the BSS
1460 */
1461 int privacy;
1462
1463 /**
1464 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1465 *
1466 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1467 * not use the full Beacon template.
1468 */
1469 const struct wpabuf *beacon_ies;
1470
1471 /**
1472 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1473 *
1474 * This is used to add IEs like WPS IE and P2P IE by drivers that
1475 * reply to Probe Request frames internally.
1476 */
1477 const struct wpabuf *proberesp_ies;
1478
1479 /**
1480 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1481 *
1482 * This is used to add IEs like WPS IE by drivers that reply to
1483 * (Re)Association Request frames internally.
1484 */
1485 const struct wpabuf *assocresp_ies;
1486
1487 /**
1488 * isolate - Whether to isolate frames between associated stations
1489 *
1490 * If this is non-zero, the AP is requested to disable forwarding of
1491 * frames between associated stations.
1492 */
1493 int isolate;
1494
1495 /**
1496 * cts_protect - Whether CTS protection is enabled
1497 */
1498 int cts_protect;
1499
1500 /**
1501 * preamble - Whether short preamble is enabled
1502 */
1503 int preamble;
1504
1505 /**
1506 * short_slot_time - Whether short slot time is enabled
1507 *
1508 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1509 * not set (e.g., when 802.11g mode is not in use)
1510 */
1511 int short_slot_time;
1512
1513 /**
1514 * ht_opmode - HT operation mode or -1 if HT not in use
1515 */
1516 int ht_opmode;
1517
1518 /**
1519 * interworking - Whether Interworking is enabled
1520 */
1521 int interworking;
1522
1523 /**
1524 * hessid - Homogeneous ESS identifier or %NULL if not set
1525 */
1526 const u8 *hessid;
1527
1528 /**
1529 * access_network_type - Access Network Type (0..15)
1530 *
1531 * This is used for filtering Probe Request frames when Interworking is
1532 * enabled.
1533 */
1534 u8 access_network_type;
1535
1536 /**
1537 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1538 *
1539 * This is used by driver which advertises this capability.
1540 */
1541 int ap_max_inactivity;
1542
1543 /**
1544 * ctwindow - Client Traffic Window (in TUs)
1545 */
1546 u8 p2p_go_ctwindow;
1547
1548 /**
1549 * disable_dgaf - Whether group-addressed frames are disabled
1550 */
1551 int disable_dgaf;
1552
1553 /**
1554 * osen - Whether OSEN security is enabled
1555 */
1556 int osen;
1557
1558 /**
1559 * freq - Channel parameters for dynamic bandwidth changes
1560 */
1561 struct hostapd_freq_params *freq;
1562
1563 /**
1564 * reenable - Whether this is to re-enable beaconing
1565 */
1566 int reenable;
1567
1568 /**
1569 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1570 * infrastructure BSS. Valid only for DMG network.
1571 */
1572 int pbss;
1573
1574 /**
1575 * multicast_to_unicast - Whether to use multicast_to_unicast
1576 *
1577 * If this is non-zero, the AP is requested to perform multicast to
1578 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1579 * 802.1Q). If enabled, such frames are to be sent to each station
1580 * separately, with the DA replaced by their own MAC address rather
1581 * than the group address.
1582 *
1583 * Note that this may break certain expectations of the receiver, such
1584 * as the ability to drop unicast IP packets received within multicast
1585 * L2 frames, or the ability to not send ICMP destination unreachable
1586 * messages for packets received in L2 multicast (which is required,
1587 * but the receiver can't tell the difference if this new option is
1588 * enabled.)
1589 *
1590 * This also doesn't implement the 802.11 DMS (directed multicast
1591 * service).
1592 */
1593 int multicast_to_unicast;
1594
1595 /**
1596 * ftm_responder - Whether FTM responder is enabled
1597 */
1598 int ftm_responder;
1599
1600 /**
1601 * lci - Binary data, the content of an LCI report IE with type 8 as
1602 * defined in IEEE Std 802.11-2016, 9.4.2.22.10
1603 */
1604 const struct wpabuf *lci;
1605
1606 /**
1607 * civic - Binary data, the content of a measurement report IE with
1608 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
1609 */
1610 const struct wpabuf *civic;
1611
1612 /**
1613 * he_spr_ctrl - Spatial Reuse control field of SPR element
1614 */
1615 u8 he_spr_ctrl;
1616
1617 /**
1618 * he_spr_non_srg_obss_pd_max_offset - Non-SRG Maximum TX power offset
1619 */
1620 u8 he_spr_non_srg_obss_pd_max_offset;
1621
1622 /**
1623 * he_spr_srg_obss_pd_min_offset - Minimum TX power offset
1624 */
1625 u8 he_spr_srg_obss_pd_min_offset;
1626
1627 /**
1628 * he_spr_srg_obss_pd_max_offset - Maximum TX power offset
1629 */
1630 u8 he_spr_srg_obss_pd_max_offset;
1631
1632 /**
1633 * he_spr_bss_color_bitmap - BSS color values used by members of the
1634 * SRG.
1635 */
1636 u8 he_spr_bss_color_bitmap[8];
1637
1638 /**
1639 * he_spr_partial_bssid_bitmap - Partial BSSID values used by members
1640 * of the SRG.
1641 */
1642 u8 he_spr_partial_bssid_bitmap[8];
1643
1644 /**
1645 * he_bss_color - Whether the BSS Color is disabled
1646 */
1647 int he_bss_color_disabled;
1648
1649 /**
1650 * he_bss_color_partial - The BSS Color AID equation
1651 */
1652 int he_bss_color_partial;
1653
1654 /**
1655 * he_bss_color - The BSS Color of the AP
1656 */
1657 int he_bss_color;
1658
1659 /**
1660 * twt_responder - Whether Target Wait Time responder is enabled
1661 */
1662 int twt_responder;
1663
1664 /**
1665 * sae_pwe - SAE mechanism for PWE derivation
1666 * 0 = hunting-and-pecking loop only
1667 * 1 = hash-to-element only
1668 * 2 = both hunting-and-pecking loop and hash-to-element enabled
1669 */
1670 enum sae_pwe sae_pwe;
1671
1672 /**
1673 * FILS Discovery frame minimum interval in TUs
1674 */
1675 u32 fd_min_int;
1676
1677 /**
1678 * FILS Discovery frame maximum interval in TUs (0 = FD frame disabled)
1679 */
1680 u32 fd_max_int;
1681
1682 /**
1683 * FILS Discovery frame template data
1684 */
1685 u8 *fd_frame_tmpl;
1686
1687 /**
1688 * FILS Discovery frame template length
1689 */
1690 size_t fd_frame_tmpl_len;
1691
1692 /**
1693 * Unsolicited broadcast Probe Response interval in TUs
1694 */
1695 unsigned int unsol_bcast_probe_resp_interval;
1696
1697 /**
1698 * Unsolicited broadcast Probe Response template data
1699 */
1700 u8 *unsol_bcast_probe_resp_tmpl;
1701
1702 /**
1703 * Unsolicited broadcast Probe Response template length
1704 */
1705 size_t unsol_bcast_probe_resp_tmpl_len;
1706
1707 /**
1708 * mbssid_tx_iface - Transmitting interface of the MBSSID set
1709 */
1710 const char *mbssid_tx_iface;
1711
1712 /**
1713 * mbssid_index - The index of this BSS in the MBSSID set
1714 */
1715 unsigned int mbssid_index;
1716
1717 /**
1718 * mbssid_elem - Buffer containing all MBSSID elements
1719 */
1720 u8 *mbssid_elem;
1721
1722 /**
1723 * mbssid_elem_len - Total length of all MBSSID elements
1724 */
1725 size_t mbssid_elem_len;
1726
1727 /**
1728 * mbssid_elem_count - The number of MBSSID elements
1729 */
1730 u8 mbssid_elem_count;
1731
1732 /**
1733 * mbssid_elem_offset - Offsets to elements in mbssid_elem.
1734 * Kernel will use these offsets to generate multiple BSSID beacons.
1735 */
1736 u8 **mbssid_elem_offset;
1737
1738 /**
1739 * ema - Enhanced MBSSID advertisements support.
1740 */
1741 bool ema;
1742
1743 /**
1744 * punct_bitmap - Preamble puncturing bitmap
1745 * Each bit corresponds to a 20 MHz subchannel, the lowest bit for the
1746 * channel with the lowest frequency. A bit set to 1 indicates that the
1747 * subchannel is punctured, otherwise active.
1748 */
1749 u16 punct_bitmap;
1750
1751 /**
1752 * rnr_elem - This buffer contains all of reduced neighbor report (RNR)
1753 * elements
1754 */
1755 u8 *rnr_elem;
1756
1757 /**
1758 * rnr_elem_len - Length of rnr_elem buffer
1759 */
1760 size_t rnr_elem_len;
1761
1762 /**
1763 * rnr_elem_count - Number of RNR elements
1764 */
1765 unsigned int rnr_elem_count;
1766
1767 /**
1768 * rnr_elem_offset - The offsets to the elements in rnr_elem.
1769 * The driver will use these to include RNR elements in EMA beacons.
1770 */
1771 u8 **rnr_elem_offset;
1772
1773 /**
1774 * allowed_freqs - List of allowed 20 MHz channel center frequencies in
1775 * MHz for AP operation. Drivers which support this parameter will
1776 * generate a new list based on this provided list by filtering out
1777 * channels that cannot be used at that time due to regulatory or other
1778 * constraints. The resulting list is used as the list of all allowed
1779 * channels whenever performing operations like ACS and DFS.
1780 */
1781 int *allowed_freqs;
1782
1783 /*
1784 * mld_ap - Whether operating as an AP MLD
1785 */
1786 bool mld_ap;
1787
1788 /**
1789 * mld_link_id - Link id for MLD BSS's
1790 */
1791 u8 mld_link_id;
1792};
1793
1794struct wpa_driver_mesh_bss_params {
1795#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1796#define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1797#define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1798#define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
1799#define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010
1800#define WPA_DRIVER_MESH_CONF_FLAG_FORWARDING 0x00000020
1801 /*
1802 * TODO: Other mesh configuration parameters would go here.
1803 * See NL80211_MESHCONF_* for all the mesh config parameters.
1804 */
1805 unsigned int flags;
1806 int auto_plinks;
1807 int peer_link_timeout;
1808 int max_peer_links;
1809 int rssi_threshold;
1810 int forwarding;
1811 u16 ht_opmode;
1812};
1813
1814struct wpa_driver_mesh_join_params {
1815 const u8 *meshid;
1816 int meshid_len;
1817 const int *basic_rates;
1818 const u8 *ies;
1819 int ie_len;
1820 struct hostapd_freq_params freq;
1821 int beacon_int;
1822 int dtim_period;
1823 struct wpa_driver_mesh_bss_params conf;
1824#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1825#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1826#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1827#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1828 unsigned int flags;
1829 bool handle_dfs;
1830 int mcast_rate;
1831};
1832
1833struct wpa_driver_set_key_params {
1834 /**
1835 * ifname - Interface name (for multi-SSID/VLAN support) */
1836 const char *ifname;
1837
1838 /**
1839 * alg - Encryption algorithm
1840 *
1841 * (%WPA_ALG_NONE, %WPA_ALG_WEP, %WPA_ALG_TKIP, %WPA_ALG_CCMP,
1842 * %WPA_ALG_BIP_AES_CMAC_128, %WPA_ALG_GCMP, %WPA_ALG_GCMP_256,
1843 * %WPA_ALG_CCMP_256, %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1844 * %WPA_ALG_BIP_CMAC_256);
1845 * %WPA_ALG_NONE clears the key. */
1846 enum wpa_alg alg;
1847
1848 /**
1849 * addr - Address of the peer STA
1850 *
1851 * (BSSID of the current AP when setting pairwise key in station mode),
1852 * ff:ff:ff:ff:ff:ff for broadcast keys, %NULL for default keys that
1853 * are used both for broadcast and unicast; when clearing keys, %NULL
1854 * is used to indicate that both the broadcast-only and default key of
1855 * the specified key index is to be cleared */
1856 const u8 *addr;
1857
1858 /**
1859 * key_idx - Key index
1860 *
1861 * (0..3), usually 0 for unicast keys; 4..5 for IGTK; 6..7 for BIGTK */
1862 int key_idx;
1863
1864 /**
1865 * set_tx - Configure this key as the default Tx key
1866 *
1867 * Only used when driver does not support separate unicast/individual
1868 * key */
1869 int set_tx;
1870
1871 /**
1872 * seq - Sequence number/packet number
1873 *
1874 * seq_len octets, the next packet number to be used for in replay
1875 * protection; configured for Rx keys (in most cases, this is only used
1876 * with broadcast keys and set to zero for unicast keys); %NULL if not
1877 * set */
1878 const u8 *seq;
1879
1880 /**
1881 * seq_len - Length of the seq, depends on the algorithm
1882 *
1883 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets */
1884 size_t seq_len;
1885
1886 /**
1887 * key - Key buffer
1888 *
1889 * TKIP: 16-byte temporal key, 8-byte Tx Mic key, 8-byte Rx Mic Key */
1890 const u8 *key;
1891
1892 /**
1893 * key_len - Length of the key buffer in octets
1894 *
1895 * WEP: 5 or 13, TKIP: 32, CCMP/GCMP: 16, IGTK: 16 */
1896 size_t key_len;
1897
1898 /**
1899 * vlan_id - VLAN index (0..4095) for VLAN offload cases */
1900 int vlan_id;
1901
1902 /**
1903 * key_flag - Additional key flags
1904 *
1905 * %KEY_FLAG_MODIFY
1906 * Set when an already installed key must be updated.
1907 * So far the only use-case is changing RX/TX status for
1908 * pairwise keys. Must not be set when deleting a key.
1909 * %KEY_FLAG_DEFAULT
1910 * Set when the key is also a default key. Must not be set when
1911 * deleting a key.
1912 * %KEY_FLAG_RX
1913 * The key is valid for RX. Must not be set when deleting a key.
1914 * %KEY_FLAG_TX
1915 * The key is valid for TX. Must not be set when deleting a key.
1916 * %KEY_FLAG_GROUP
1917 * The key is a broadcast or group key.
1918 * %KEY_FLAG_PAIRWISE
1919 * The key is a pairwise key.
1920 * %KEY_FLAG_PMK
1921 * The key is a Pairwise Master Key (PMK).
1922 *
1923 * Valid and pre-defined combinations are:
1924 * %KEY_FLAG_GROUP_RX_TX
1925 * WEP key not to be installed as default key.
1926 * %KEY_FLAG_GROUP_RX_TX_DEFAULT
1927 * Default WEP or WPA-NONE key.
1928 * %KEY_FLAG_GROUP_RX
1929 * GTK key valid for RX only.
1930 * %KEY_FLAG_GROUP_TX_DEFAULT
1931 * GTK key valid for TX only, immediately taking over TX.
1932 * %KEY_FLAG_PAIRWISE_RX_TX
1933 * Pairwise key immediately becoming the active pairwise key.
1934 * %KEY_FLAG_PAIRWISE_RX
1935 * Pairwise key not yet valid for TX. (Only usable when Extended
1936 * Key ID is supported by the driver.)
1937 * %KEY_FLAG_PAIRWISE_RX_TX_MODIFY
1938 * Enable TX for a pairwise key installed with
1939 * KEY_FLAG_PAIRWISE_RX.
1940 *
1941 * Not a valid standalone key type but pre-defined to be combined
1942 * with other key_flags:
1943 * %KEY_FLAG_RX_TX
1944 * RX/TX key. */
1945 enum key_flag key_flag;
1946
1947 /**
1948 * link_id - MLO Link ID
1949 *
1950 * Set to a valid Link ID (0-14) when applicable, otherwise -1. */
1951 int link_id;
1952};
1953
1954enum wpa_driver_if_type {
1955 /**
1956 * WPA_IF_STATION - Station mode interface
1957 */
1958 WPA_IF_STATION,
1959
1960 /**
1961 * WPA_IF_AP_VLAN - AP mode VLAN interface
1962 *
1963 * This interface shares its address and Beacon frame with the main
1964 * BSS.
1965 */
1966 WPA_IF_AP_VLAN,
1967
1968 /**
1969 * WPA_IF_AP_BSS - AP mode BSS interface
1970 *
1971 * This interface has its own address and Beacon frame.
1972 */
1973 WPA_IF_AP_BSS,
1974
1975 /**
1976 * WPA_IF_P2P_GO - P2P Group Owner
1977 */
1978 WPA_IF_P2P_GO,
1979
1980 /**
1981 * WPA_IF_P2P_CLIENT - P2P Client
1982 */
1983 WPA_IF_P2P_CLIENT,
1984
1985 /**
1986 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1987 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1988 */
1989 WPA_IF_P2P_GROUP,
1990
1991 /**
1992 * WPA_IF_P2P_DEVICE - P2P Device interface is used to identify the
1993 * abstracted P2P Device function in the driver
1994 */
1995 WPA_IF_P2P_DEVICE,
1996
1997 /*
1998 * WPA_IF_MESH - Mesh interface
1999 */
2000 WPA_IF_MESH,
2001
2002 /*
2003 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
2004 */
2005 WPA_IF_TDLS,
2006
2007 /*
2008 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
2009 */
2010 WPA_IF_IBSS,
2011
2012 /*
2013 * WPA_IF_NAN - NAN Device
2014 */
2015 WPA_IF_NAN,
2016
2017 /* keep last */
2018 WPA_IF_MAX
2019};
2020
2021/**
2022 * struct wpa_driver_capa - Driver capability information
2023 */
2024struct wpa_driver_capa {
2025#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
2026#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
2027#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
2028#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
2029#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
2030#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
2031#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
2032#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
2033#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
2034#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
2035#define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
2036#define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
2037#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
2038#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
2039#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
2040#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
2041#define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000
2042#define WPA_DRIVER_CAPA_KEY_MGMT_802_1X_SHA256 0x00020000
2043#define WPA_DRIVER_CAPA_KEY_MGMT_PSK_SHA256 0x00040000
2044#define WPA_DRIVER_CAPA_KEY_MGMT_TPK_HANDSHAKE 0x00080000
2045#define WPA_DRIVER_CAPA_KEY_MGMT_FT_SAE 0x00100000
2046#define WPA_DRIVER_CAPA_KEY_MGMT_FT_802_1X_SHA384 0x00200000
2047#define WPA_DRIVER_CAPA_KEY_MGMT_CCKM 0x00400000
2048#define WPA_DRIVER_CAPA_KEY_MGMT_OSEN 0x00800000
2049#define WPA_DRIVER_CAPA_KEY_MGMT_SAE_EXT_KEY 0x01000000
2050#define WPA_DRIVER_CAPA_KEY_MGMT_FT_SAE_EXT_KEY 0x02000000
2051 /** Bitfield of supported key management suites */
2052 unsigned int key_mgmt;
2053 unsigned int key_mgmt_iftype[WPA_IF_MAX];
2054
2055#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
2056#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
2057#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
2058#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
2059#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
2060#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
2061#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
2062#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
2063#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
2064#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
2065#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
2066#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
2067#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
2068 /** Bitfield of supported cipher suites */
2069 unsigned int enc;
2070
2071#define WPA_DRIVER_AUTH_OPEN 0x00000001
2072#define WPA_DRIVER_AUTH_SHARED 0x00000002
2073#define WPA_DRIVER_AUTH_LEAP 0x00000004
2074 /** Bitfield of supported IEEE 802.11 authentication algorithms */
2075 unsigned int auth;
2076
2077/** Driver generated WPA/RSN IE */
2078#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
2079/** Driver needs static WEP key setup after association command */
2080#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
2081/** Driver takes care of all DFS operations */
2082#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
2083/** Driver takes care of RSN 4-way handshake internally; PMK is configured with
2084 * struct wpa_driver_ops::set_key using key_flag = KEY_FLAG_PMK */
2085#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008
2086/** Driver is for a wired Ethernet interface */
2087#define WPA_DRIVER_FLAGS_WIRED 0x00000010
2088/** Driver provides separate commands for authentication and association (SME in
2089 * wpa_supplicant). */
2090#define WPA_DRIVER_FLAGS_SME 0x00000020
2091/** Driver supports AP mode */
2092#define WPA_DRIVER_FLAGS_AP 0x00000040
2093/** Driver needs static WEP key setup after association has been completed */
2094#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
2095/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
2096#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
2097/** Driver supports concurrent P2P operations */
2098#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
2099/**
2100 * Driver uses the initial interface as a dedicated management interface, i.e.,
2101 * it cannot be used for P2P group operations or non-P2P purposes.
2102 */
2103#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
2104/** This interface is P2P capable (P2P GO or P2P Client) */
2105#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
2106/** Driver supports station and key removal when stopping an AP */
2107#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
2108/**
2109 * Driver uses the initial interface for P2P management interface and non-P2P
2110 * purposes (e.g., connect to infra AP), but this interface cannot be used for
2111 * P2P group operations.
2112 */
2113#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
2114/**
2115 * Driver is known to use valid error codes, i.e., when it indicates that
2116 * something (e.g., association) fails, there was indeed a failure and the
2117 * operation does not end up getting completed successfully later.
2118 */
2119#define WPA_DRIVER_FLAGS_VALID_ERROR_CODES 0x00004000
2120/** Driver supports off-channel TX */
2121#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
2122/** Driver indicates TX status events for EAPOL Data frames */
2123#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
2124/** Driver indicates TX status events for Deauth/Disassoc frames */
2125#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
2126/** Driver supports roaming (BSS selection) in firmware */
2127#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
2128/** Driver supports operating as a TDLS peer */
2129#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
2130/** Driver requires external TDLS setup/teardown/discovery */
2131#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
2132/** Driver indicates support for Probe Response offloading in AP mode */
2133#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
2134/** Driver supports U-APSD in AP mode */
2135#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
2136/** Driver supports inactivity timer in AP mode */
2137#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
2138/** Driver expects user space implementation of MLME in AP mode */
2139#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
2140/** Driver supports SAE with user space SME */
2141#define WPA_DRIVER_FLAGS_SAE 0x02000000
2142/** Driver makes use of OBSS scan mechanism in wpa_supplicant */
2143#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
2144/** Driver supports IBSS (Ad-hoc) mode */
2145#define WPA_DRIVER_FLAGS_IBSS 0x08000000
2146/** Driver supports radar detection */
2147#define WPA_DRIVER_FLAGS_RADAR 0x10000000
2148/** Driver supports a dedicated interface for P2P Device */
2149#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
2150/** Driver supports QoS Mapping */
2151#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
2152/** Driver supports CSA in AP mode */
2153#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
2154/** Driver supports mesh */
2155#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
2156/** Driver support ACS offload */
2157#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
2158/** Driver supports key management offload */
2159#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
2160/** Driver supports TDLS channel switching */
2161#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
2162/** Driver supports IBSS with HT datarates */
2163#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
2164/** Driver supports IBSS with VHT datarates */
2165#define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
2166/** Driver supports automatic band selection */
2167#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
2168/** Driver supports simultaneous off-channel operations */
2169#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
2170/** Driver supports full AP client state */
2171#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
2172/** Driver supports P2P Listen offload */
2173#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
2174/** Driver supports FILS */
2175#define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
2176/** Driver supports Beacon frame TX rate configuration (legacy rates) */
2177#define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
2178/** Driver supports Beacon frame TX rate configuration (HT rates) */
2179#define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
2180/** Driver supports Beacon frame TX rate configuration (VHT rates) */
2181#define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
2182/** Driver supports mgmt_tx with random TX address in non-connected state */
2183#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
2184/** Driver supports mgmt_tx with random TX addr in connected state */
2185#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
2186/** Driver supports better BSS reporting with sched_scan in connected mode */
2187#define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
2188/** Driver supports HE capabilities */
2189#define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
2190/** Driver supports FILS shared key offload */
2191#define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
2192/** Driver supports all OCE STA specific mandatory features */
2193#define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
2194/** Driver supports all OCE AP specific mandatory features */
2195#define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
2196/**
2197 * Driver supports all OCE STA-CFON specific mandatory features only.
2198 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
2199 * userspace shall assume that this driver may not support all OCE AP
2200 * functionality but can support only OCE STA-CFON functionality.
2201 */
2202#define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
2203/** Driver supports MFP-optional in the connect command */
2204#define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL
2205/** Driver is a self-managed regulatory device */
2206#define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL
2207/** Driver supports FTM responder functionality */
2208#define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL
2209/** Driver support 4-way handshake offload for WPA-Personal */
2210#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
2211/** Driver supports a separate control port TX for EAPOL frames */
2212#define WPA_DRIVER_FLAGS_CONTROL_PORT 0x0400000000000000ULL
2213/** Driver supports VLAN offload */
2214#define WPA_DRIVER_FLAGS_VLAN_OFFLOAD 0x0800000000000000ULL
2215/** Driver supports UPDATE_FT_IES command */
2216#define WPA_DRIVER_FLAGS_UPDATE_FT_IES 0x1000000000000000ULL
2217/** Driver can correctly rekey PTKs without Extended Key ID */
2218#define WPA_DRIVER_FLAGS_SAFE_PTK0_REKEYS 0x2000000000000000ULL
2219/** Driver supports Beacon protection */
2220#define WPA_DRIVER_FLAGS_BEACON_PROTECTION 0x4000000000000000ULL
2221/** Driver supports Extended Key ID */
2222#define WPA_DRIVER_FLAGS_EXTENDED_KEY_ID 0x8000000000000000ULL
2223 u64 flags;
2224
2225/** Driver supports a separate control port RX for EAPOL frames */
2226#define WPA_DRIVER_FLAGS2_CONTROL_PORT_RX 0x0000000000000001ULL
2227/** Driver supports TX status reports for EAPOL frames through control port */
2228#define WPA_DRIVER_FLAGS2_CONTROL_PORT_TX_STATUS 0x0000000000000002ULL
2229/** Driver supports secure LTF in AP mode */
2230#define WPA_DRIVER_FLAGS2_SEC_LTF_AP 0x0000000000000004ULL
2231/** Driver supports secure RTT measurement exchange in AP mode */
2232#define WPA_DRIVER_FLAGS2_SEC_RTT_AP 0x0000000000000008ULL
2233/**
2234 * Driver supports protection of range negotiation and measurement management
2235 * frames in AP mode
2236 */
2237#define WPA_DRIVER_FLAGS2_PROT_RANGE_NEG_AP 0x0000000000000010ULL
2238/** Driver supports Beacon frame TX rate configuration (HE rates) */
2239#define WPA_DRIVER_FLAGS2_BEACON_RATE_HE 0x0000000000000020ULL
2240/** Driver supports Beacon protection only in client mode */
2241#define WPA_DRIVER_FLAGS2_BEACON_PROTECTION_CLIENT 0x0000000000000040ULL
2242/** Driver supports Operating Channel Validation */
2243#define WPA_DRIVER_FLAGS2_OCV 0x0000000000000080ULL
2244/** Driver expects user space implementation of SME in AP mode */
2245#define WPA_DRIVER_FLAGS2_AP_SME 0x0000000000000100ULL
2246/** Driver handles SA Query procedures in AP mode */
2247#define WPA_DRIVER_FLAGS2_SA_QUERY_OFFLOAD_AP 0x0000000000000200ULL
2248/** Driver supports background radar/CAC detection */
2249#define WPA_DRIVER_RADAR_BACKGROUND 0x0000000000000400ULL
2250/** Driver supports secure LTF in STA mode */
2251#define WPA_DRIVER_FLAGS2_SEC_LTF_STA 0x0000000000000800ULL
2252/** Driver supports secure RTT measurement exchange in STA mode */
2253#define WPA_DRIVER_FLAGS2_SEC_RTT_STA 0x0000000000001000ULL
2254/**
2255 * Driver supports protection of range negotiation and measurement management
2256 * frames in STA mode
2257 */
2258#define WPA_DRIVER_FLAGS2_PROT_RANGE_NEG_STA 0x0000000000002000ULL
2259/** Driver supports MLO in station/AP mode */
2260#define WPA_DRIVER_FLAGS2_MLO 0x0000000000004000ULL
2261 u64 flags2;
2262
2263#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
2264 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
2265
2266 unsigned int wmm_ac_supported:1;
2267
2268 unsigned int mac_addr_rand_scan_supported:1;
2269 unsigned int mac_addr_rand_sched_scan_supported:1;
2270
2271 /** Maximum number of supported active probe SSIDs */
2272 int max_scan_ssids;
2273
2274 /** Maximum number of supported active probe SSIDs for sched_scan */
2275 int max_sched_scan_ssids;
2276
2277 /** Maximum number of supported scan plans for scheduled scan */
2278 unsigned int max_sched_scan_plans;
2279
2280 /** Maximum interval in a scan plan. In seconds */
2281 u32 max_sched_scan_plan_interval;
2282
2283 /** Maximum number of iterations in a single scan plan */
2284 u32 max_sched_scan_plan_iterations;
2285
2286 /** Whether sched_scan (offloaded scanning) is supported */
2287 int sched_scan_supported;
2288
2289 /** Maximum number of supported match sets for sched_scan */
2290 int max_match_sets;
2291
2292 /**
2293 * max_remain_on_chan - Maximum remain-on-channel duration in msec
2294 */
2295 unsigned int max_remain_on_chan;
2296
2297 /**
2298 * max_stations - Maximum number of associated stations the driver
2299 * supports in AP mode
2300 */
2301 unsigned int max_stations;
2302
2303 /**
2304 * probe_resp_offloads - Bitmap of supported protocols by the driver
2305 * for Probe Response offloading.
2306 */
2307/** Driver Probe Response offloading support for WPS ver. 1 */
2308#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
2309/** Driver Probe Response offloading support for WPS ver. 2 */
2310#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
2311/** Driver Probe Response offloading support for P2P */
2312#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
2313/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
2314#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
2315 unsigned int probe_resp_offloads;
2316
2317 unsigned int max_acl_mac_addrs;
2318
2319 /**
2320 * Number of supported concurrent channels
2321 */
2322 unsigned int num_multichan_concurrent;
2323
2324 /**
2325 * extended_capa - extended capabilities in driver/device
2326 *
2327 * Must be allocated and freed by driver and the pointers must be
2328 * valid for the lifetime of the driver, i.e., freed in deinit()
2329 */
2330 const u8 *extended_capa, *extended_capa_mask;
2331 unsigned int extended_capa_len;
2332
2333 struct wowlan_triggers wowlan_triggers;
2334
2335/** Driver adds the DS Params Set IE in Probe Request frames */
2336#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
2337/** Driver adds the WFA TPC IE in Probe Request frames */
2338#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
2339/** Driver handles quiet period requests */
2340#define WPA_DRIVER_FLAGS_QUIET 0x00000004
2341/**
2342 * Driver is capable of inserting the current TX power value into the body of
2343 * transmitted frames.
2344 * Background: Some Action frames include a TPC Report IE. This IE contains a
2345 * TX power field, which has to be updated by lower layers. One such Action
2346 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
2347 * of spectrum management). Note that this insertion takes place at a fixed
2348 * offset, namely the 6th byte in the Action frame body.
2349 */
2350#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
2351/**
2352 * Driver supports RRM. With this support, the driver will accept to use RRM in
2353 * (Re)Association Request frames, without supporting quiet period.
2354 */
2355#define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
2356
2357/** Driver supports setting the scan dwell time */
2358#define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
2359/** Driver supports Beacon Report Measurement */
2360#define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
2361
2362 u32 rrm_flags;
2363
2364 /* Driver concurrency capabilities */
2365 unsigned int conc_capab;
2366 /* Maximum number of concurrent channels on 2.4 GHz */
2367 unsigned int max_conc_chan_2_4;
2368 /* Maximum number of concurrent channels on 5 GHz */
2369 unsigned int max_conc_chan_5_0;
2370
2371 /* Maximum number of supported CSA counters */
2372 u16 max_csa_counters;
2373
2374 /* Maximum number of supported AKM suites in commands */
2375 unsigned int max_num_akms;
2376
2377 /* Maximum number of interfaces supported for MBSSID advertisement */
2378 unsigned int mbssid_max_interfaces;
2379 /* Maximum profile periodicity for enhanced MBSSID advertisement */
2380 unsigned int ema_max_periodicity;
2381};
2382
2383
2384struct hostapd_data;
2385
2386enum guard_interval {
2387 GUARD_INTERVAL_0_4 = 1,
2388 GUARD_INTERVAL_0_8 = 2,
2389 GUARD_INTERVAL_1_6 = 3,
2390 GUARD_INTERVAL_3_2 = 4,
2391};
2392
2393#define STA_DRV_DATA_TX_MCS BIT(0)
2394#define STA_DRV_DATA_RX_MCS BIT(1)
2395#define STA_DRV_DATA_TX_VHT_MCS BIT(2)
2396#define STA_DRV_DATA_RX_VHT_MCS BIT(3)
2397#define STA_DRV_DATA_TX_VHT_NSS BIT(4)
2398#define STA_DRV_DATA_RX_VHT_NSS BIT(5)
2399#define STA_DRV_DATA_TX_SHORT_GI BIT(6)
2400#define STA_DRV_DATA_RX_SHORT_GI BIT(7)
2401#define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
2402#define STA_DRV_DATA_CONN_TIME BIT(9)
2403#define STA_DRV_DATA_TX_HE_MCS BIT(10)
2404#define STA_DRV_DATA_RX_HE_MCS BIT(11)
2405#define STA_DRV_DATA_TX_HE_NSS BIT(12)
2406#define STA_DRV_DATA_RX_HE_NSS BIT(13)
2407#define STA_DRV_DATA_TX_HE_DCM BIT(14)
2408#define STA_DRV_DATA_RX_HE_DCM BIT(15)
2409#define STA_DRV_DATA_TX_HE_GI BIT(16)
2410#define STA_DRV_DATA_RX_HE_GI BIT(17)
2411
2412struct hostap_sta_driver_data {
2413 unsigned long rx_packets, tx_packets;
2414 unsigned long long rx_bytes, tx_bytes;
2415 unsigned long long rx_airtime, tx_airtime;
2416 unsigned long long beacons_count;
2417 int bytes_64bit; /* whether 64-bit byte counters are supported */
2418 unsigned long current_tx_rate; /* in kbps */
2419 unsigned long current_rx_rate; /* in kbps */
2420 unsigned long inactive_msec;
2421 unsigned long connected_sec;
2422 unsigned long flags; /* bitfield of STA_DRV_DATA_* */
2423 unsigned long num_ps_buf_frames;
2424 unsigned long tx_retry_failed;
2425 unsigned long tx_retry_count;
2426 s8 last_ack_rssi;
2427 unsigned long backlog_packets;
2428 unsigned long backlog_bytes;
2429 unsigned long fcs_error_count;
2430 unsigned long beacon_loss_count;
2431 unsigned long expected_throughput;
2432 unsigned long rx_drop_misc;
2433 unsigned long rx_mpdus;
2434 int signal; /* dBm; or -WPA_INVALID_NOISE */
2435 u8 rx_hemcs;
2436 u8 tx_hemcs;
2437 u8 rx_vhtmcs;
2438 u8 tx_vhtmcs;
2439 u8 rx_mcs;
2440 u8 tx_mcs;
2441 u8 rx_he_nss;
2442 u8 tx_he_nss;
2443 u8 rx_vht_nss;
2444 u8 tx_vht_nss;
2445 s8 avg_signal; /* dBm */
2446 s8 avg_beacon_signal; /* dBm */
2447 s8 avg_ack_signal; /* dBm */
2448 enum guard_interval rx_guard_interval, tx_guard_interval;
2449 u8 rx_dcm, tx_dcm;
2450};
2451
2452struct hostapd_sta_add_params {
2453 const u8 *addr;
2454 u16 aid;
2455 u16 capability;
2456 const u8 *supp_rates;
2457 size_t supp_rates_len;
2458 u16 listen_interval;
2459 const struct ieee80211_ht_capabilities *ht_capabilities;
2460 const struct ieee80211_vht_capabilities *vht_capabilities;
2461 int vht_opmode_enabled;
2462 u8 vht_opmode;
2463 const struct ieee80211_he_capabilities *he_capab;
2464 size_t he_capab_len;
2465 const struct ieee80211_he_6ghz_band_cap *he_6ghz_capab;
2466 const struct ieee80211_eht_capabilities *eht_capab;
2467 size_t eht_capab_len;
2468 u32 flags; /* bitmask of WPA_STA_* flags */
2469 u32 flags_mask; /* unset bits in flags */
2470#ifdef CONFIG_MESH
2471 enum mesh_plink_state plink_state;
2472 u16 peer_aid;
2473#endif /* CONFIG_MESH */
2474 int set; /* Set STA parameters instead of add */
2475 u8 qosinfo;
2476 const u8 *ext_capab;
2477 size_t ext_capab_len;
2478 const u8 *supp_channels;
2479 size_t supp_channels_len;
2480 const u8 *supp_oper_classes;
2481 size_t supp_oper_classes_len;
2482 int support_p2p_ps;
2483
2484 bool mld_link_sta;
2485 s8 mld_link_id;
2486 const u8 *mld_link_addr;
2487};
2488
2489struct mac_address {
2490 u8 addr[ETH_ALEN];
2491};
2492
2493struct hostapd_acl_params {
2494 u8 acl_policy;
2495 unsigned int num_mac_acl;
2496 struct mac_address mac_acl[0];
2497};
2498
2499struct wpa_init_params {
2500 void *global_priv;
2501 const u8 *bssid;
2502 const char *ifname;
2503 const char *driver_params;
2504 int use_pae_group_addr;
2505 char **bridge;
2506 size_t num_bridge;
2507
2508 u8 *own_addr; /* buffer for writing own MAC address */
2509};
2510
2511
2512struct wpa_bss_params {
2513 /** Interface name (for multi-SSID/VLAN support) */
2514 const char *ifname;
2515 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
2516 int enabled;
2517
2518 int wpa;
2519 int ieee802_1x;
2520 int wpa_group;
2521 int wpa_pairwise;
2522 int wpa_key_mgmt;
2523 int rsn_preauth;
2524 enum mfp_options ieee80211w;
2525};
2526
2527#define WPA_STA_AUTHORIZED BIT(0)
2528#define WPA_STA_WMM BIT(1)
2529#define WPA_STA_SHORT_PREAMBLE BIT(2)
2530#define WPA_STA_MFP BIT(3)
2531#define WPA_STA_TDLS_PEER BIT(4)
2532#define WPA_STA_AUTHENTICATED BIT(5)
2533#define WPA_STA_ASSOCIATED BIT(6)
2534
2535enum tdls_oper {
2536 TDLS_DISCOVERY_REQ,
2537 TDLS_SETUP,
2538 TDLS_TEARDOWN,
2539 TDLS_ENABLE_LINK,
2540 TDLS_DISABLE_LINK,
2541 TDLS_ENABLE,
2542 TDLS_DISABLE
2543};
2544
2545enum wnm_oper {
2546 WNM_SLEEP_ENTER_CONFIRM,
2547 WNM_SLEEP_ENTER_FAIL,
2548 WNM_SLEEP_EXIT_CONFIRM,
2549 WNM_SLEEP_EXIT_FAIL,
2550 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
2551 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
2552 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
2553 * a STA */
2554 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
2555 * for a STA */
2556 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
2557 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
2558 * for a STA */
2559 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
2560};
2561
2562/* enum smps_mode - SMPS mode definitions */
2563enum smps_mode {
2564 SMPS_AUTOMATIC,
2565 SMPS_OFF,
2566 SMPS_DYNAMIC,
2567 SMPS_STATIC,
2568
2569 /* Keep last */
2570 SMPS_INVALID,
2571};
2572
2573#define WPA_INVALID_NOISE 9999
2574
2575/**
2576 * struct wpa_signal_info - Information about channel signal quality
2577 * @frequency: control frequency
2578 * @above_threshold: true if the above threshold was crossed
2579 * (relevant for a CQM event)
2580 * @data: STA information
2581 * @current_noise: %WPA_INVALID_NOISE if not supported
2582 * @chanwidth: channel width
2583 * @center_frq1: center frequency for the first segment
2584 * @center_frq2: center frequency for the second segment (if relevant)
2585 */
2586struct wpa_signal_info {
2587 u32 frequency;
2588 int above_threshold;
2589 struct hostap_sta_driver_data data;
2590 int current_noise;
2591 enum chan_width chanwidth;
2592 int center_frq1;
2593 int center_frq2;
2594};
2595
2596struct wpa_mlo_signal_info {
2597 u16 valid_links;
2598 struct wpa_signal_info links[MAX_NUM_MLD_LINKS];
2599};
2600
2601/**
2602 * struct wpa_channel_info - Information about the current channel
2603 * @frequency: Center frequency of the primary 20 MHz channel
2604 * @chanwidth: Width of the current operating channel
2605 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
2606 * This field is only filled in when using a 40 MHz channel.
2607 * @center_frq1: Center frequency of frequency segment 0
2608 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
2609 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
2610 * derived from center_frq2 for convenience.
2611 */
2612struct wpa_channel_info {
2613 u32 frequency;
2614 enum chan_width chanwidth;
2615 int sec_channel;
2616 int center_frq1;
2617 int center_frq2;
2618 u8 seg1_idx;
2619};
2620
2621/**
2622 * struct beacon_data - Beacon data
2623 * @head: Head portion of Beacon frame (before TIM IE)
2624 * @tail: Tail portion of Beacon frame (after TIM IE)
2625 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2626 * @proberesp_ies: Extra information element(s) to add into Probe Response
2627 * frames or %NULL
2628 * @assocresp_ies: Extra information element(s) to add into (Re)Association
2629 * Response frames or %NULL
2630 * @probe_resp: Probe Response frame template
2631 * @head_len: Length of @head
2632 * @tail_len: Length of @tail
2633 * @beacon_ies_len: Length of beacon_ies in octets
2634 * @proberesp_ies_len: Length of proberesp_ies in octets
2635 * @proberesp_ies_len: Length of proberesp_ies in octets
2636 * @probe_resp_len: Length of probe response template (@probe_resp)
2637 */
2638struct beacon_data {
2639 u8 *head, *tail;
2640 u8 *beacon_ies;
2641 u8 *proberesp_ies;
2642 u8 *assocresp_ies;
2643 u8 *probe_resp;
2644
2645 size_t head_len, tail_len;
2646 size_t beacon_ies_len;
2647 size_t proberesp_ies_len;
2648 size_t assocresp_ies_len;
2649 size_t probe_resp_len;
2650};
2651
2652/**
2653 * struct csa_settings - Settings for channel switch command
2654 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2655 * @block_tx: 1 - block transmission for CSA period
2656 * @freq_params: Next channel frequency parameter
2657 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2658 * @beacon_after: Next beacon/probe resp/asooc resp info
2659 * @counter_offset_beacon: Offset to the count field in beacon's tail
2660 * @counter_offset_presp: Offset to the count field in probe resp.
2661 * @punct_bitmap - Preamble puncturing bitmap
2662 */
2663struct csa_settings {
2664 u8 cs_count;
2665 u8 block_tx;
2666
2667 struct hostapd_freq_params freq_params;
2668 struct beacon_data beacon_csa;
2669 struct beacon_data beacon_after;
2670
2671 u16 counter_offset_beacon[2];
2672 u16 counter_offset_presp[2];
2673
2674 u16 punct_bitmap;
2675};
2676
2677/**
2678 * struct cca_settings - Settings for color switch command
2679 * @cca_count: Count in Beacon frames (TBTT) to perform the switch
2680 * @cca_color: The new color that we are switching to
2681 * @beacon_cca: Beacon/Probe Response/(Re)Association Response frame info for
2682 * color switch period
2683 * @beacon_after: Next Beacon/Probe Response/(Re)Association Response frame info
2684 * @counter_offset_beacon: Offset to the count field in Beacon frame tail
2685 * @counter_offset_presp: Offset to the count field in Probe Response frame
2686 */
2687struct cca_settings {
2688 u8 cca_count;
2689 u8 cca_color;
2690
2691 struct beacon_data beacon_cca;
2692 struct beacon_data beacon_after;
2693
2694 u16 counter_offset_beacon;
2695 u16 counter_offset_presp;
2696};
2697
2698/* TDLS peer capabilities for send_tdls_mgmt() */
2699enum tdls_peer_capability {
2700 TDLS_PEER_HT = BIT(0),
2701 TDLS_PEER_VHT = BIT(1),
2702 TDLS_PEER_WMM = BIT(2),
2703 TDLS_PEER_HE = BIT(3),
2704};
2705
2706/* valid info in the wmm_params struct */
2707enum wmm_params_valid_info {
2708 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
2709};
2710
2711/**
2712 * struct wmm_params - WMM parameterss configured for this association
2713 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2714 * of the struct contain valid information.
2715 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2716 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2717 */
2718struct wmm_params {
2719 u8 info_bitmap;
2720 u8 uapsd_queues;
2721};
2722
2723#ifdef CONFIG_MACSEC
2724struct macsec_init_params {
2725 bool always_include_sci;
2726 bool use_es;
2727 bool use_scb;
2728};
2729#endif /* CONFIG_MACSEC */
2730
2731enum drv_br_port_attr {
2732 DRV_BR_PORT_ATTR_PROXYARP,
2733 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
2734 DRV_BR_PORT_ATTR_MCAST2UCAST,
2735};
2736
2737enum drv_br_net_param {
2738 DRV_BR_NET_PARAM_GARP_ACCEPT,
2739 DRV_BR_MULTICAST_SNOOPING,
2740};
2741
2742struct drv_acs_params {
2743 /* Selected mode (HOSTAPD_MODE_*) */
2744 enum hostapd_hw_mode hw_mode;
2745
2746 /* Indicates whether HT is enabled */
2747 int ht_enabled;
2748
2749 /* Indicates whether HT40 is enabled */
2750 int ht40_enabled;
2751
2752 /* Indicates whether VHT is enabled */
2753 int vht_enabled;
2754
2755 /* Configured ACS channel width */
2756 u16 ch_width;
2757
2758 /* ACS frequency list info */
2759 const int *freq_list;
2760
2761 /* Indicates whether EDMG is enabled */
2762 int edmg_enabled;
2763
2764 /* Indicates whether EHT is enabled */
2765 bool eht_enabled;
2766};
2767
2768struct wpa_bss_trans_info {
2769 u8 mbo_transition_reason;
2770 u8 n_candidates;
2771 u8 *bssid;
2772};
2773
2774struct wpa_bss_candidate_info {
2775 u8 num;
2776 struct candidate_list {
2777 u8 bssid[ETH_ALEN];
2778 u8 is_accept;
2779 u32 reject_reason;
2780 } *candidates;
2781};
2782
2783struct wpa_pmkid_params {
2784 const u8 *bssid;
2785 const u8 *ssid;
2786 size_t ssid_len;
2787 const u8 *fils_cache_id;
2788 const u8 *pmkid;
2789 const u8 *pmk;
2790 size_t pmk_len;
2791 u32 pmk_lifetime;
2792 u8 pmk_reauth_threshold;
2793};
2794
2795/* Mask used to specify which connection parameters have to be updated */
2796enum wpa_drv_update_connect_params_mask {
2797 WPA_DRV_UPDATE_ASSOC_IES = BIT(0),
2798 WPA_DRV_UPDATE_FILS_ERP_INFO = BIT(1),
2799 WPA_DRV_UPDATE_AUTH_TYPE = BIT(2),
2800};
2801
2802/**
2803 * struct external_auth - External authentication trigger parameters
2804 *
2805 * These are used across the external authentication request and event
2806 * interfaces.
2807 * @action: Action type / trigger for external authentication. Only significant
2808 * for the event interface.
2809 * @bssid: BSSID of the peer with which the authentication has to happen. Used
2810 * by both the request and event interface.
2811 * @ssid: SSID of the AP. Used by both the request and event interface.
2812 * @ssid_len: SSID length in octets.
2813 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2814 * the request interface.
2815 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2816 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2817 * the real status code for failures. Used only for the request interface
2818 * from user space to the driver.
2819 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
2820 * @mld_addr: AP's MLD address or %NULL if MLO is not used
2821 */
2822struct external_auth {
2823 enum {
2824 EXT_AUTH_START,
2825 EXT_AUTH_ABORT,
2826 } action;
2827 const u8 *bssid;
2828 const u8 *ssid;
2829 size_t ssid_len;
2830 unsigned int key_mgmt_suite;
2831 u16 status;
2832 const u8 *pmkid;
2833 const u8 *mld_addr;
2834};
2835
2836#define WPAS_MAX_PASN_PEERS 10
2837
2838enum pasn_status {
2839 PASN_STATUS_SUCCESS = 0,
2840 PASN_STATUS_FAILURE = 1,
2841};
2842
2843/**
2844 * struct pasn_peer - PASN peer parameters
2845 *
2846 * Used to process the PASN authentication event from the driver to
2847 * userspace and to send a response back.
2848 * @own_addr: Own MAC address specified by the driver to use for PASN
2849 * handshake.
2850 * @peer_addr: MAC address of the peer with which PASN authentication is to be
2851 * performed.
2852 * @network_id: Unique id for the network.
2853 * This identifier is used as a unique identifier for each network
2854 * block when using the control interface. Each network is allocated an
2855 * id when it is being created, either when reading the configuration
2856 * file or when a new network is added through the control interface.
2857 * @akmp: Authentication key management protocol type supported.
2858 * @cipher: Cipher suite.
2859 * @group: Finite cyclic group. Default group used is 19 (ECC).
2860 * @ltf_keyseed_required: Indicates whether LTF keyseed generation is required
2861 * @status: PASN response status, %PASN_STATUS_SUCCESS for successful
2862 * authentication, use %PASN_STATUS_FAILURE if PASN authentication
2863 * fails or if wpa_supplicant fails to set the security ranging context to
2864 * the driver
2865 */
2866struct pasn_peer {
2867 u8 own_addr[ETH_ALEN];
2868 u8 peer_addr[ETH_ALEN];
2869 int network_id;
2870 int akmp;
2871 int cipher;
2872 int group;
2873 bool ltf_keyseed_required;
2874 enum pasn_status status;
2875};
2876
2877/**
2878 * struct pasn_auth - PASN authentication trigger parameters
2879 *
2880 * These are used across the PASN authentication event from the driver to
2881 * userspace and to send a response to it.
2882 * @action: Action type. Only significant for the event interface.
2883 * @num_peers: The number of peers for which the PASN handshake is requested
2884 * for.
2885 * @peer: Holds the peer details.
2886 */
2887struct pasn_auth {
2888 enum {
2889 PASN_ACTION_AUTH,
2890 PASN_ACTION_DELETE_SECURE_RANGING_CONTEXT,
2891 } action;
2892 unsigned int num_peers;
2893 struct pasn_peer peer[WPAS_MAX_PASN_PEERS];
2894};
2895
2896/**
2897 * struct secure_ranging_params - Parameters required to set secure ranging
2898 * context for a peer.
2899 *
2900 * @action: Add or delete a security context to the driver.
2901 * @own_addr: Own MAC address used during key derivation.
2902 * @peer_addr: Address of the peer device.
2903 * @cipher: Cipher suite.
2904 * @tk_len: Length of temporal key.
2905 * @tk: Temporal key buffer.
2906 * @ltf_keyseed_len: Length of LTF keyseed.
2907 * @ltf_keyeed: LTF keyseed buffer.
2908 */
2909struct secure_ranging_params {
2910 u32 action;
2911 const u8 *own_addr;
2912 const u8 *peer_addr;
2913 u32 cipher;
2914 u8 tk_len;
2915 const u8 *tk;
2916 u8 ltf_keyseed_len;
2917 const u8 *ltf_keyseed;
2918};
2919
2920/* enum nested_attr - Used to specify if subcommand uses nested attributes */
2921enum nested_attr {
2922 NESTED_ATTR_NOT_USED = 0,
2923 NESTED_ATTR_USED = 1,
2924 NESTED_ATTR_UNSPECIFIED = 2,
2925};
2926
2927/* Preferred channel list information */
2928
2929/* GO role */
2930#define WEIGHTED_PCL_GO BIT(0)
2931/* P2P Client role */
2932#define WEIGHTED_PCL_CLI BIT(1)
2933/* Must be considered for operating channel */
2934#define WEIGHTED_PCL_MUST_CONSIDER BIT(2)
2935/* Should be excluded in GO negotiation */
2936#define WEIGHTED_PCL_EXCLUDE BIT(3)
2937
2938/* Preferred channel list with weight */
2939struct weighted_pcl {
2940 u32 freq; /* MHz */
2941 u8 weight;
2942 u32 flag; /* bitmap for WEIGHTED_PCL_* */
2943};
2944
2945struct driver_sta_mlo_info {
2946 bool default_map;
2947 u16 req_links; /* bitmap of requested link IDs */
2948 u16 valid_links; /* bitmap of accepted link IDs */
2949 u8 assoc_link_id;
2950 u8 ap_mld_addr[ETH_ALEN];
2951 struct {
2952 u8 addr[ETH_ALEN];
2953 u8 bssid[ETH_ALEN];
2954 unsigned int freq;
2955 struct t2lm_mapping t2lmap;
2956 } links[MAX_NUM_MLD_LINKS];
2957};
2958
2959/**
2960 * struct wpa_driver_ops - Driver interface API definition
2961 *
2962 * This structure defines the API that each driver interface needs to implement
2963 * for core wpa_supplicant code. All driver specific functionality is captured
2964 * in this wrapper.
2965 */
2966struct wpa_driver_ops {
2967 /** Name of the driver interface */
2968 const char *name;
2969 /** One line description of the driver interface */
2970 const char *desc;
2971
2972 /**
2973 * get_bssid - Get the current BSSID
2974 * @priv: private driver interface data
2975 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2976 *
2977 * Returns: 0 on success, -1 on failure
2978 *
2979 * Query kernel driver for the current BSSID and copy it to bssid.
2980 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2981 * associated.
2982 */
2983 int (*get_bssid)(void *priv, u8 *bssid);
2984
2985 /**
2986 * get_ssid - Get the current SSID
2987 * @priv: private driver interface data
2988 * @ssid: buffer for SSID (at least 32 bytes)
2989 *
2990 * Returns: Length of the SSID on success, -1 on failure
2991 *
2992 * Query kernel driver for the current SSID and copy it to ssid.
2993 * Returning zero is recommended if the STA is not associated.
2994 *
2995 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2996 * can, at least in theory, contain control characters (including nul)
2997 * and as such, should be processed as binary data, not a printable
2998 * string.
2999 */
3000 int (*get_ssid)(void *priv, u8 *ssid);
3001
3002 /**
3003 * set_key - Configure encryption key
3004 * @priv: private driver interface data
3005 * @params: Key parameters
3006 * Returns: 0 on success, -1 on failure
3007 *
3008 * Configure the given key for the kernel driver. If the driver
3009 * supports separate individual keys (4 default keys + 1 individual),
3010 * addr can be used to determine whether the key is default or
3011 * individual. If only 4 keys are supported, the default key with key
3012 * index 0 is used as the individual key. STA must be configured to use
3013 * it as the default Tx key (set_tx is set) and accept Rx for all the
3014 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
3015 * broadcast keys, so key index 0 is available for this kind of
3016 * configuration.
3017 *
3018 * Please note that TKIP keys include separate TX and RX MIC keys and
3019 * some drivers may expect them in different order than wpa_supplicant
3020 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
3021 * will trigger Michael MIC errors. This can be fixed by changing the
3022 * order of MIC keys by swapping the bytes 16..23 and 24..31 of the key
3023 * in driver_*.c set_key() implementation, see driver_ndis.c for an
3024 * example on how this can be done.
3025 */
3026 int (*set_key)(void *priv, struct wpa_driver_set_key_params *params);
3027
3028 /**
3029 * init - Initialize driver interface
3030 * @ctx: context to be used when calling wpa_supplicant functions,
3031 * e.g., wpa_supplicant_event()
3032 * @ifname: interface name, e.g., wlan0
3033 *
3034 * Returns: Pointer to private data, %NULL on failure
3035 *
3036 * Initialize driver interface, including event processing for kernel
3037 * driver events (e.g., associated, scan results, Michael MIC failure).
3038 * This function can allocate a private configuration data area for
3039 * @ctx, file descriptor, interface name, etc. information that may be
3040 * needed in future driver operations. If this is not used, non-NULL
3041 * value will need to be returned because %NULL is used to indicate
3042 * failure. The returned value will be used as 'void *priv' data for
3043 * all other driver_ops functions.
3044 *
3045 * The main event loop (eloop.c) of wpa_supplicant can be used to
3046 * register callback for read sockets (eloop_register_read_sock()).
3047 *
3048 * See below for more information about events and
3049 * wpa_supplicant_event() function.
3050 */
3051 void * (*init)(void *ctx, const char *ifname);
3052
3053 /**
3054 * deinit - Deinitialize driver interface
3055 * @priv: private driver interface data from init()
3056 *
3057 * Shut down driver interface and processing of driver events. Free
3058 * private data buffer if one was allocated in init() handler.
3059 */
3060 void (*deinit)(void *priv);
3061
3062 /**
3063 * set_param - Set driver configuration parameters
3064 * @priv: private driver interface data from init()
3065 * @param: driver specific configuration parameters
3066 *
3067 * Returns: 0 on success, -1 on failure
3068 *
3069 * Optional handler for notifying driver interface about configuration
3070 * parameters (driver_param).
3071 */
3072 int (*set_param)(void *priv, const char *param);
3073
3074 /**
3075 * set_countermeasures - Enable/disable TKIP countermeasures
3076 * @priv: private driver interface data
3077 * @enabled: 1 = countermeasures enabled, 0 = disabled
3078 *
3079 * Returns: 0 on success, -1 on failure
3080 *
3081 * Configure TKIP countermeasures. When these are enabled, the driver
3082 * should drop all received and queued frames that are using TKIP.
3083 */
3084 int (*set_countermeasures)(void *priv, int enabled);
3085
3086 /**
3087 * deauthenticate - Request driver to deauthenticate
3088 * @priv: private driver interface data
3089 * @addr: peer address (BSSID of the AP)
3090 * @reason_code: 16-bit reason code to be sent in the deauthentication
3091 * frame
3092 *
3093 * Returns: 0 on success, -1 on failure
3094 */
3095 int (*deauthenticate)(void *priv, const u8 *addr, u16 reason_code);
3096
3097 /**
3098 * associate - Request driver to associate
3099 * @priv: private driver interface data
3100 * @params: association parameters
3101 *
3102 * Returns: 0 on success, -1 on failure
3103 */
3104 int (*associate)(void *priv,
3105 struct wpa_driver_associate_params *params);
3106
3107 /**
3108 * add_pmkid - Add PMKSA cache entry to the driver
3109 * @priv: private driver interface data
3110 * @params: PMKSA parameters
3111 *
3112 * Returns: 0 on success, -1 on failure
3113 *
3114 * This function is called when a new PMK is received, as a result of
3115 * either normal authentication or RSN pre-authentication. The PMKSA
3116 * parameters are either a set of bssid, pmkid, and pmk; or a set of
3117 * ssid, fils_cache_id, pmkid, and pmk.
3118 *
3119 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
3120 * associate(), add_pmkid() can be used to add new PMKSA cache entries
3121 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
3122 * driver_ops function does not need to be implemented. Likewise, if
3123 * the driver does not support WPA, this function is not needed.
3124 */
3125 int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params);
3126
3127 /**
3128 * remove_pmkid - Remove PMKSA cache entry to the driver
3129 * @priv: private driver interface data
3130 * @params: PMKSA parameters
3131 *
3132 * Returns: 0 on success, -1 on failure
3133 *
3134 * This function is called when the supplicant drops a PMKSA cache
3135 * entry for any reason. The PMKSA parameters are either a set of
3136 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
3137 *
3138 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
3139 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
3140 * between the driver and wpa_supplicant. If the driver uses wpa_ie
3141 * from wpa_supplicant, this driver_ops function does not need to be
3142 * implemented. Likewise, if the driver does not support WPA, this
3143 * function is not needed.
3144 */
3145 int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params);
3146
3147 /**
3148 * flush_pmkid - Flush PMKSA cache
3149 * @priv: private driver interface data
3150 *
3151 * Returns: 0 on success, -1 on failure
3152 *
3153 * This function is called when the supplicant drops all PMKSA cache
3154 * entries for any reason.
3155 *
3156 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
3157 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
3158 * between the driver and wpa_supplicant. If the driver uses wpa_ie
3159 * from wpa_supplicant, this driver_ops function does not need to be
3160 * implemented. Likewise, if the driver does not support WPA, this
3161 * function is not needed.
3162 */
3163 int (*flush_pmkid)(void *priv);
3164
3165 /**
3166 * get_capa - Get driver capabilities
3167 * @priv: private driver interface data
3168 *
3169 * Returns: 0 on success, -1 on failure
3170 *
3171 * Get driver/firmware/hardware capabilities.
3172 */
3173 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
3174
3175 /**
3176 * poll - Poll driver for association information
3177 * @priv: private driver interface data
3178 *
3179 * This is an optional callback that can be used when the driver does
3180 * not provide event mechanism for association events. This is called
3181 * when receiving WPA/RSN EAPOL-Key messages that require association
3182 * information. The driver interface is supposed to generate associnfo
3183 * event before returning from this callback function. In addition, the
3184 * driver interface should generate an association event after having
3185 * sent out associnfo.
3186 */
3187 void (*poll)(void *priv);
3188
3189 /**
3190 * get_ifindex - Get interface index
3191 * @priv: private driver interface data
3192 *
3193 * Returns: Interface index
3194 */
3195 unsigned int (*get_ifindex)(void *priv);
3196
3197 /**
3198 * get_ifname - Get interface name
3199 * @priv: private driver interface data
3200 *
3201 * Returns: Pointer to the interface name. This can differ from the
3202 * interface name used in init() call. Init() is called first.
3203 *
3204 * This optional function can be used to allow the driver interface to
3205 * replace the interface name with something else, e.g., based on an
3206 * interface mapping from a more descriptive name.
3207 */
3208 const char * (*get_ifname)(void *priv);
3209
3210 /**
3211 * get_mac_addr - Get own MAC address
3212 * @priv: private driver interface data
3213 *
3214 * Returns: Pointer to own MAC address or %NULL on failure
3215 *
3216 * This optional function can be used to get the own MAC address of the
3217 * device from the driver interface code. This is only needed if the
3218 * l2_packet implementation for the OS does not provide easy access to
3219 * a MAC address. */
3220 const u8 * (*get_mac_addr)(void *priv);
3221
3222 /**
3223 * set_operstate - Sets device operating state to DORMANT or UP
3224 * @priv: private driver interface data
3225 * @state: 0 = dormant, 1 = up
3226 * Returns: 0 on success, -1 on failure
3227 *
3228 * This is an optional function that can be used on operating systems
3229 * that support a concept of controlling network device state from user
3230 * space applications. This function, if set, gets called with
3231 * state = 1 when authentication has been completed and with state = 0
3232 * when connection is lost.
3233 */
3234 int (*set_operstate)(void *priv, int state);
3235
3236 /**
3237 * mlme_setprotection - MLME-SETPROTECTION.request primitive
3238 * @priv: Private driver interface data
3239 * @addr: Address of the station for which to set protection (may be
3240 * %NULL for group keys)
3241 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
3242 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
3243 * Returns: 0 on success, -1 on failure
3244 *
3245 * This is an optional function that can be used to set the driver to
3246 * require protection for Tx and/or Rx frames. This uses the layer
3247 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
3248 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
3249 * set protection operation; instead, they set protection implicitly
3250 * based on configured keys.
3251 */
3252 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
3253 int key_type);
3254
3255 /**
3256 * get_hw_feature_data - Get hardware support data (channels and rates)
3257 * @priv: Private driver interface data
3258 * @num_modes: Variable for returning the number of returned modes
3259 * flags: Variable for returning hardware feature flags
3260 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
3261 * Returns: Pointer to allocated hardware data on success or %NULL on
3262 * failure. Caller is responsible for freeing this.
3263 */
3264 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
3265 u16 *num_modes,
3266 u16 *flags, u8 *dfs);
3267
3268 /**
3269 * send_mlme - Send management frame from MLME
3270 * @priv: Private driver interface data
3271 * @data: IEEE 802.11 management frame with IEEE 802.11 header
3272 * @data_len: Size of the management frame
3273 * @noack: Do not wait for this frame to be acked (disable retries)
3274 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
3275 * driver decide
3276 * @csa_offs: Array of CSA offsets or %NULL
3277 * @csa_offs_len: Number of elements in csa_offs
3278 * @no_encrypt: Do not encrypt frame even if appropriate key exists
3279 * (used only for testing purposes)
3280 * @wait: Time to wait off-channel for a response (in ms), or zero
3281 * @link_id: Link ID to use for TX, or -1 if not set
3282 * Returns: 0 on success, -1 on failure
3283 */
3284 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
3285 int noack, unsigned int freq, const u16 *csa_offs,
3286 size_t csa_offs_len, int no_encrypt,
3287 unsigned int wait, int link_id);
3288
3289 /**
3290 * update_ft_ies - Update FT (IEEE 802.11r) IEs
3291 * @priv: Private driver interface data
3292 * @md: Mobility domain (2 octets) (also included inside ies)
3293 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
3294 * @ies_len: Length of FT IEs in bytes
3295 * Returns: 0 on success, -1 on failure
3296 *
3297 * The supplicant uses this callback to let the driver know that keying
3298 * material for FT is available and that the driver can use the
3299 * provided IEs in the next message in FT authentication sequence.
3300 *
3301 * This function is only needed for driver that support IEEE 802.11r
3302 * (Fast BSS Transition).
3303 */
3304 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
3305 size_t ies_len);
3306
3307 /**
3308 * get_scan_results2 - Fetch the latest scan results
3309 * @priv: private driver interface data
3310 *
3311 * Returns: Allocated buffer of scan results (caller is responsible for
3312 * freeing the data structure) on success, NULL on failure
3313 */
3314 struct wpa_scan_results * (*get_scan_results2)(void *priv);
3315
3316 /**
3317 * set_country - Set country
3318 * @priv: Private driver interface data
3319 * @alpha2: country to which to switch to
3320 * Returns: 0 on success, -1 on failure
3321 *
3322 * This function is for drivers which support some form
3323 * of setting a regulatory domain.
3324 */
3325 int (*set_country)(void *priv, const char *alpha2);
3326
3327 /**
3328 * get_country - Get country
3329 * @priv: Private driver interface data
3330 * @alpha2: Buffer for returning country code (at least 3 octets)
3331 * Returns: 0 on success, -1 on failure
3332 */
3333 int (*get_country)(void *priv, char *alpha2);
3334
3335 /**
3336 * global_init - Global driver initialization
3337 * @ctx: wpa_global pointer
3338 * Returns: Pointer to private data (global), %NULL on failure
3339 *
3340 * This optional function is called to initialize the driver wrapper
3341 * for global data, i.e., data that applies to all interfaces. If this
3342 * function is implemented, global_deinit() will also need to be
3343 * implemented to free the private data. The driver will also likely
3344 * use init2() function instead of init() to get the pointer to global
3345 * data available to per-interface initializer.
3346 */
3347 void * (*global_init)(void *ctx);
3348
3349 /**
3350 * global_deinit - Global driver deinitialization
3351 * @priv: private driver global data from global_init()
3352 *
3353 * Terminate any global driver related functionality and free the
3354 * global data structure.
3355 */
3356 void (*global_deinit)(void *priv);
3357
3358 /**
3359 * init2 - Initialize driver interface (with global data)
3360 * @ctx: context to be used when calling wpa_supplicant functions,
3361 * e.g., wpa_supplicant_event()
3362 * @ifname: interface name, e.g., wlan0
3363 * @global_priv: private driver global data from global_init()
3364 * Returns: Pointer to private data, %NULL on failure
3365 *
3366 * This function can be used instead of init() if the driver wrapper
3367 * uses global data.
3368 */
3369 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
3370
3371 /**
3372 * get_interfaces - Get information about available interfaces
3373 * @global_priv: private driver global data from global_init()
3374 * Returns: Allocated buffer of interface information (caller is
3375 * responsible for freeing the data structure) on success, NULL on
3376 * failure
3377 */
3378 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
3379
3380 /**
3381 * scan2 - Request the driver to initiate scan
3382 * @priv: private driver interface data
3383 * @params: Scan parameters
3384 *
3385 * Returns: 0 on success, -1 on failure
3386 *
3387 * Once the scan results are ready, the driver should report scan
3388 * results event for wpa_supplicant which will eventually request the
3389 * results with wpa_driver_get_scan_results2().
3390 */
3391 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
3392
3393 /**
3394 * authenticate - Request driver to authenticate
3395 * @priv: private driver interface data
3396 * @params: authentication parameters
3397 * Returns: 0 on success, -1 on failure
3398 *
3399 * This is an optional function that can be used with drivers that
3400 * support separate authentication and association steps, i.e., when
3401 * wpa_supplicant can act as the SME. If not implemented, associate()
3402 * function is expected to take care of IEEE 802.11 authentication,
3403 * too.
3404 */
3405 int (*authenticate)(void *priv,
3406 struct wpa_driver_auth_params *params);
3407
3408 /**
3409 * set_ap - Set Beacon and Probe Response information for AP mode
3410 * @priv: Private driver interface data
3411 * @params: Parameters to use in AP mode
3412 *
3413 * This function is used to configure Beacon template and/or extra IEs
3414 * to add for Beacon and Probe Response frames for the driver in
3415 * AP mode. The driver is responsible for building the full Beacon
3416 * frame by concatenating the head part with TIM IE generated by the
3417 * driver/firmware and finishing with the tail part. Depending on the
3418 * driver architectue, this can be done either by using the full
3419 * template or the set of additional IEs (e.g., WPS and P2P IE).
3420 * Similarly, Probe Response processing depends on the driver design.
3421 * If the driver (or firmware) takes care of replying to Probe Request
3422 * frames, the extra IEs provided here needs to be added to the Probe
3423 * Response frames.
3424 *
3425 * Returns: 0 on success, -1 on failure
3426 */
3427 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
3428
3429 /**
3430 * set_acl - Set ACL in AP mode
3431 * @priv: Private driver interface data
3432 * @params: Parameters to configure ACL
3433 * Returns: 0 on success, -1 on failure
3434 *
3435 * This is used only for the drivers which support MAC address ACL.
3436 */
3437 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
3438
3439 /**
3440 * hapd_init - Initialize driver interface (hostapd only)
3441 * @hapd: Pointer to hostapd context
3442 * @params: Configuration for the driver wrapper
3443 * Returns: Pointer to private data, %NULL on failure
3444 *
3445 * This function is used instead of init() or init2() when the driver
3446 * wrapper is used with hostapd.
3447 */
3448 void * (*hapd_init)(struct hostapd_data *hapd,
3449 struct wpa_init_params *params);
3450
3451 /**
3452 * hapd_deinit - Deinitialize driver interface (hostapd only)
3453 * @priv: Private driver interface data from hapd_init()
3454 */
3455 void (*hapd_deinit)(void *priv);
3456
3457 /**
3458 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
3459 * @priv: Private driver interface data
3460 * @params: BSS parameters
3461 * Returns: 0 on success, -1 on failure
3462 *
3463 * This is an optional function to configure the kernel driver to
3464 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
3465 * can be left undefined (set to %NULL) if IEEE 802.1X support is
3466 * always enabled and the driver uses set_ap() to set WPA/RSN IE
3467 * for Beacon frames.
3468 *
3469 * DEPRECATED - use set_ap() instead
3470 */
3471 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
3472
3473 /**
3474 * set_privacy - Enable/disable privacy (AP only)
3475 * @priv: Private driver interface data
3476 * @enabled: 1 = privacy enabled, 0 = disabled
3477 * Returns: 0 on success, -1 on failure
3478 *
3479 * This is an optional function to configure privacy field in the
3480 * kernel driver for Beacon frames. This can be left undefined (set to
3481 * %NULL) if the driver uses the Beacon template from set_ap().
3482 *
3483 * DEPRECATED - use set_ap() instead
3484 */
3485 int (*set_privacy)(void *priv, int enabled);
3486
3487 /**
3488 * get_seqnum - Fetch the current TSC/packet number (AP only)
3489 * @ifname: The interface name (main or virtual)
3490 * @priv: Private driver interface data
3491 * @addr: MAC address of the station or %NULL for group keys
3492 * @idx: Key index
3493 * @link_id: Link ID for a group key, or -1 if not set
3494 * @seq: Buffer for returning the latest used TSC/packet number
3495 * Returns: 0 on success, -1 on failure
3496 *
3497 * This function is used to fetch the last used TSC/packet number for
3498 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
3499 * keys, so there is no strict requirement on implementing support for
3500 * unicast keys (i.e., addr != %NULL).
3501 */
3502 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
3503 int idx, int link_id, u8 *seq);
3504
3505 /**
3506 * flush - Flush all association stations (AP only)
3507 * @priv: Private driver interface data
3508 * Returns: 0 on success, -1 on failure
3509 *
3510 * This function requests the driver to disassociate all associated
3511 * stations. This function does not need to be implemented if the
3512 * driver does not process association frames internally.
3513 */
3514 int (*flush)(void *priv);
3515
3516 /**
3517 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
3518 * @priv: Private driver interface data
3519 * @elem: Information elements
3520 * @elem_len: Length of the elem buffer in octets
3521 * Returns: 0 on success, -1 on failure
3522 *
3523 * This is an optional function to add information elements in the
3524 * kernel driver for Beacon and Probe Response frames. This can be left
3525 * undefined (set to %NULL) if the driver uses the Beacon template from
3526 * set_ap().
3527 *
3528 * DEPRECATED - use set_ap() instead
3529 */
3530 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
3531
3532 /**
3533 * read_sta_data - Fetch station data
3534 * @priv: Private driver interface data
3535 * @data: Buffer for returning station information
3536 * @addr: MAC address of the station
3537 * Returns: 0 on success, -1 on failure
3538 */
3539 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
3540 const u8 *addr);
3541
3542 /**
3543 * tx_control_port - Send a frame over the 802.1X controlled port
3544 * @priv: Private driver interface data
3545 * @dest: Destination MAC address
3546 * @proto: Ethertype in host byte order
3547 * @buf: Frame payload starting from IEEE 802.1X header
3548 * @len: Frame payload length
3549 * @no_encrypt: Do not encrypt frame
3550 * @link_id: Link ID to use for TX, or -1 if not set
3551 *
3552 * Returns 0 on success, else an error
3553 *
3554 * This is like a normal Ethernet send except that the driver is aware
3555 * (by other means than the Ethertype) that this frame is special,
3556 * and more importantly it gains an ordering between the transmission of
3557 * the frame and other driver management operations such as key
3558 * installations. This can be used to work around known limitations in
3559 * IEEE 802.11 protocols such as race conditions between rekeying 4-way
3560 * handshake message 4/4 and a PTK being overwritten.
3561 *
3562 * This function is only used for a given interface if the driver
3563 * instance reports WPA_DRIVER_FLAGS_CONTROL_PORT capability. Otherwise,
3564 * API users will fall back to sending the frame via a normal socket.
3565 */
3566 int (*tx_control_port)(void *priv, const u8 *dest,
3567 u16 proto, const u8 *buf, size_t len,
3568 int no_encrypt, int link_id);
3569
3570 /**
3571 * hapd_send_eapol - Send an EAPOL packet (AP only)
3572 * @priv: private driver interface data
3573 * @addr: Destination MAC address
3574 * @data: EAPOL packet starting with IEEE 802.1X header
3575 * @data_len: Length of the EAPOL packet in octets
3576 * @encrypt: Whether the frame should be encrypted
3577 * @own_addr: Source MAC address
3578 * @flags: WPA_STA_* flags for the destination station
3579 * @link_id: Link ID to use for TX, or -1 if not set
3580 *
3581 * Returns: 0 on success, -1 on failure
3582 */
3583 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
3584 size_t data_len, int encrypt,
3585 const u8 *own_addr, u32 flags, int link_id);
3586
3587 /**
3588 * sta_deauth - Deauthenticate a station (AP only)
3589 * @priv: Private driver interface data
3590 * @own_addr: Source address and BSSID for the Deauthentication frame
3591 * @addr: MAC address of the station to deauthenticate
3592 * @reason: Reason code for the Deauthentication frame
3593 * @link_id: Link ID to use for Deauthentication frame, or -1 if not set
3594 * Returns: 0 on success, -1 on failure
3595 *
3596 * This function requests a specific station to be deauthenticated and
3597 * a Deauthentication frame to be sent to it.
3598 */
3599 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
3600 u16 reason, int link_id);
3601
3602 /**
3603 * sta_disassoc - Disassociate a station (AP only)
3604 * @priv: Private driver interface data
3605 * @own_addr: Source address and BSSID for the Disassociation frame
3606 * @addr: MAC address of the station to disassociate
3607 * @reason: Reason code for the Disassociation frame
3608 * Returns: 0 on success, -1 on failure
3609 *
3610 * This function requests a specific station to be disassociated and
3611 * a Disassociation frame to be sent to it.
3612 */
3613 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
3614 u16 reason);
3615
3616 /**
3617 * sta_remove - Remove a station entry (AP only)
3618 * @priv: Private driver interface data
3619 * @addr: MAC address of the station to be removed
3620 * Returns: 0 on success, -1 on failure
3621 */
3622 int (*sta_remove)(void *priv, const u8 *addr);
3623
3624 /**
3625 * hapd_get_ssid - Get the current SSID (AP only)
3626 * @priv: Private driver interface data
3627 * @buf: Buffer for returning the SSID
3628 * @len: Maximum length of the buffer
3629 * Returns: Length of the SSID on success, -1 on failure
3630 *
3631 * This function need not be implemented if the driver uses Beacon
3632 * template from set_ap() and does not reply to Probe Request frames.
3633 */
3634 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
3635
3636 /**
3637 * hapd_set_ssid - Set SSID (AP only)
3638 * @priv: Private driver interface data
3639 * @buf: SSID
3640 * @len: Length of the SSID in octets
3641 * Returns: 0 on success, -1 on failure
3642 *
3643 * DEPRECATED - use set_ap() instead
3644 */
3645 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
3646
3647 /**
3648 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
3649 * @priv: Private driver interface data
3650 * @enabled: 1 = countermeasures enabled, 0 = disabled
3651 * Returns: 0 on success, -1 on failure
3652 *
3653 * This need not be implemented if the driver does not take care of
3654 * association processing.
3655 */
3656 int (*hapd_set_countermeasures)(void *priv, int enabled);
3657
3658 /**
3659 * sta_add - Add a station entry
3660 * @priv: Private driver interface data
3661 * @params: Station parameters
3662 * Returns: 0 on success, -1 on failure
3663 *
3664 * This function is used to add or set (params->set 1) a station
3665 * entry in the driver. Adding STA entries is used only if the driver
3666 * does not take care of association processing.
3667 *
3668 * With drivers that don't support full AP client state, this function
3669 * is used to add a station entry to the driver once the station has
3670 * completed association.
3671 *
3672 * With TDLS, this function is used to add or set (params->set 1)
3673 * TDLS peer entries (even with drivers that do not support full AP
3674 * client state).
3675 */
3676 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
3677
3678 /**
3679 * get_inact_sec - Get station inactivity duration (AP only)
3680 * @priv: Private driver interface data
3681 * @addr: Station address
3682 * Returns: Number of seconds station has been inactive, -1 on failure
3683 */
3684 int (*get_inact_sec)(void *priv, const u8 *addr);
3685
3686 /**
3687 * sta_clear_stats - Clear station statistics (AP only)
3688 * @priv: Private driver interface data
3689 * @addr: Station address
3690 * Returns: 0 on success, -1 on failure
3691 */
3692 int (*sta_clear_stats)(void *priv, const u8 *addr);
3693
3694 /**
3695 * set_freq - Set channel/frequency (AP only)
3696 * @priv: Private driver interface data
3697 * @freq: Channel parameters
3698 * Returns: 0 on success, -1 on failure
3699 */
3700 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
3701
3702 /**
3703 * set_rts - Set RTS threshold
3704 * @priv: Private driver interface data
3705 * @rts: RTS threshold in octets
3706 * Returns: 0 on success, -1 on failure
3707 */
3708 int (*set_rts)(void *priv, int rts);
3709
3710 /**
3711 * set_frag - Set fragmentation threshold
3712 * @priv: Private driver interface data
3713 * @frag: Fragmentation threshold in octets
3714 * Returns: 0 on success, -1 on failure
3715 */
3716 int (*set_frag)(void *priv, int frag);
3717
3718 /**
3719 * sta_set_flags - Set station flags (AP only)
3720 * @priv: Private driver interface data
3721 * @addr: Station address
3722 * @total_flags: Bitmap of all WPA_STA_* flags currently set
3723 * @flags_or: Bitmap of WPA_STA_* flags to add
3724 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
3725 * Returns: 0 on success, -1 on failure
3726 */
3727 int (*sta_set_flags)(void *priv, const u8 *addr,
3728 unsigned int total_flags, unsigned int flags_or,
3729 unsigned int flags_and);
3730
3731 /**
3732 * sta_set_airtime_weight - Set station airtime weight (AP only)
3733 * @priv: Private driver interface data
3734 * @addr: Station address
3735 * @weight: New weight for station airtime assignment
3736 * Returns: 0 on success, -1 on failure
3737 */
3738 int (*sta_set_airtime_weight)(void *priv, const u8 *addr,
3739 unsigned int weight);
3740
3741 /**
3742 * set_tx_queue_params - Set TX queue parameters
3743 * @priv: Private driver interface data
3744 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
3745 * @aifs: AIFS
3746 * @cw_min: cwMin
3747 * @cw_max: cwMax
3748 * @burst_time: Maximum length for bursting in 0.1 msec units
3749 * @link_id: Link ID to use, or -1 for non MLD.
3750 */
3751 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
3752 int cw_max, int burst_time, int link_id);
3753
3754 /**
3755 * if_add - Add a virtual interface
3756 * @priv: Private driver interface data
3757 * @type: Interface type
3758 * @ifname: Interface name for the new virtual interface
3759 * @addr: Local address to use for the interface or %NULL to use the
3760 * parent interface address
3761 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
3762 * @drv_priv: Pointer for overwriting the driver context or %NULL if
3763 * not allowed (applies only to %WPA_IF_AP_BSS type)
3764 * @force_ifname: Buffer for returning an interface name that the
3765 * driver ended up using if it differs from the requested ifname
3766 * @if_addr: Buffer for returning the allocated interface address
3767 * (this may differ from the requested addr if the driver cannot
3768 * change interface address)
3769 * @bridge: Bridge interface to use or %NULL if no bridge configured
3770 * @use_existing: Whether to allow existing interface to be used
3771 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
3772 * Returns: 0 on success, -1 on failure
3773 */
3774 int (*if_add)(void *priv, enum wpa_driver_if_type type,
3775 const char *ifname, const u8 *addr, void *bss_ctx,
3776 void **drv_priv, char *force_ifname, u8 *if_addr,
3777 const char *bridge, int use_existing, int setup_ap);
3778
3779 /**
3780 * if_remove - Remove a virtual interface
3781 * @priv: Private driver interface data
3782 * @type: Interface type
3783 * @ifname: Interface name of the virtual interface to be removed
3784 * Returns: 0 on success, -1 on failure
3785 */
3786 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
3787 const char *ifname);
3788
3789 /**
3790 * set_sta_vlan - Bind a station into a specific interface (AP only)
3791 * @priv: Private driver interface data
3792 * @ifname: Interface (main or virtual BSS or VLAN)
3793 * @addr: MAC address of the associated station
3794 * @vlan_id: VLAN ID
3795 * @link_id: The link ID or -1 for non-MLO
3796 * Returns: 0 on success, -1 on failure
3797 *
3798 * This function is used to bind a station to a specific virtual
3799 * interface. It is only used if when virtual interfaces are supported,
3800 * e.g., to assign stations to different VLAN interfaces based on
3801 * information from a RADIUS server. This allows separate broadcast
3802 * domains to be used with a single BSS.
3803 */
3804 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
3805 int vlan_id, int link_id);
3806
3807 /**
3808 * commit - Optional commit changes handler (AP only)
3809 * @priv: driver private data
3810 * Returns: 0 on success, -1 on failure
3811 *
3812 * This optional handler function can be registered if the driver
3813 * interface implementation needs to commit changes (e.g., by setting
3814 * network interface up) at the end of initial configuration. If set,
3815 * this handler will be called after initial setup has been completed.
3816 */
3817 int (*commit)(void *priv);
3818
3819 /**
3820 * set_radius_acl_auth - Notification of RADIUS ACL change
3821 * @priv: Private driver interface data
3822 * @mac: MAC address of the station
3823 * @accepted: Whether the station was accepted
3824 * @session_timeout: Session timeout for the station
3825 * Returns: 0 on success, -1 on failure
3826 */
3827 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
3828 u32 session_timeout);
3829
3830 /**
3831 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3832 * @priv: Private driver interface data
3833 * @mac: MAC address of the station
3834 * Returns: 0 on success, -1 on failure
3835 */
3836 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
3837
3838 /**
3839 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
3840 * @priv: Private driver interface data
3841 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3842 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3843 * extra IE(s)
3844 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3845 * to remove extra IE(s)
3846 * Returns: 0 on success, -1 on failure
3847 *
3848 * This is an optional function to add WPS IE in the kernel driver for
3849 * Beacon and Probe Response frames. This can be left undefined (set
3850 * to %NULL) if the driver uses the Beacon template from set_ap()
3851 * and does not process Probe Request frames. If the driver takes care
3852 * of (Re)Association frame processing, the assocresp buffer includes
3853 * WPS IE(s) that need to be added to (Re)Association Response frames
3854 * whenever a (Re)Association Request frame indicated use of WPS.
3855 *
3856 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3857 * frames when operating as a GO. The driver is responsible for adding
3858 * timing related attributes (e.g., NoA) in addition to the IEs
3859 * included here by appending them after these buffers. This call is
3860 * also used to provide Probe Response IEs for P2P Listen state
3861 * operations for drivers that generate the Probe Response frames
3862 * internally.
3863 *
3864 * DEPRECATED - use set_ap() instead
3865 */
3866 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
3867 const struct wpabuf *proberesp,
3868 const struct wpabuf *assocresp);
3869
3870 /**
3871 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3872 * @priv: Private driver interface data
3873 * @authorized: Whether the port is authorized
3874 * Returns: 0 on success, -1 on failure
3875 */
3876 int (*set_supp_port)(void *priv, int authorized);
3877
3878 /**
3879 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3880 * @priv: Private driver interface data
3881 * @addr: MAC address of the associated station
3882 * @aid: Association ID
3883 * @val: 1 = bind to 4-address WDS; 0 = unbind
3884 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3885 * to indicate that bridge is not to be used
3886 * @ifname_wds: Buffer to return the interface name for the new WDS
3887 * station or %NULL to indicate name is not returned.
3888 * Returns: 0 on success, -1 on failure
3889 */
3890 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
3891 const char *bridge_ifname, char *ifname_wds);
3892
3893 /**
3894 * send_action - Transmit an Action frame
3895 * @priv: Private driver interface data
3896 * @freq: Frequency (in MHz) of the channel
3897 * @wait: Time to wait off-channel for a response (in ms), or zero
3898 * @dst: Destination MAC address (Address 1)
3899 * @src: Source MAC address (Address 2)
3900 * @bssid: BSSID (Address 3)
3901 * @data: Frame body
3902 * @data_len: data length in octets
3903 @ @no_cck: Whether CCK rates must not be used to transmit this frame
3904 * Returns: 0 on success, -1 on failure
3905 *
3906 * This command can be used to request the driver to transmit an action
3907 * frame to the specified destination.
3908 *
3909 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3910 * be transmitted on the given channel and the device will wait for a
3911 * response on that channel for the given wait time.
3912 *
3913 * If the flag is not set, the wait time will be ignored. In this case,
3914 * if a remain-on-channel duration is in progress, the frame must be
3915 * transmitted on that channel; alternatively the frame may be sent on
3916 * the current operational channel (if in associated state in station
3917 * mode or while operating as an AP.)
3918 *
3919 * If @src differs from the device MAC address, use of a random
3920 * transmitter address is requested for this message exchange.
3921 */
3922 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
3923 const u8 *dst, const u8 *src, const u8 *bssid,
3924 const u8 *data, size_t data_len, int no_cck);
3925
3926 /**
3927 * send_action_cancel_wait - Cancel action frame TX wait
3928 * @priv: Private driver interface data
3929 *
3930 * This command cancels the wait time associated with sending an action
3931 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3932 * set in the driver flags.
3933 */
3934 void (*send_action_cancel_wait)(void *priv);
3935
3936 /**
3937 * remain_on_channel - Remain awake on a channel
3938 * @priv: Private driver interface data
3939 * @freq: Frequency (in MHz) of the channel
3940 * @duration: Duration in milliseconds
3941 * Returns: 0 on success, -1 on failure
3942 *
3943 * This command is used to request the driver to remain awake on the
3944 * specified channel for the specified duration and report received
3945 * Action frames with EVENT_RX_MGMT events. Optionally, received
3946 * Probe Request frames may also be requested to be reported by calling
3947 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3948 *
3949 * The driver may not be at the requested channel when this function
3950 * returns, i.e., the return code is only indicating whether the
3951 * request was accepted. The caller will need to wait until the
3952 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3953 * completed the channel change. This may take some time due to other
3954 * need for the radio and the caller should be prepared to timing out
3955 * its wait since there are no guarantees on when this request can be
3956 * executed.
3957 */
3958 int (*remain_on_channel)(void *priv, unsigned int freq,
3959 unsigned int duration);
3960
3961 /**
3962 * cancel_remain_on_channel - Cancel remain-on-channel operation
3963 * @priv: Private driver interface data
3964 *
3965 * This command can be used to cancel a remain-on-channel operation
3966 * before its originally requested duration has passed. This could be
3967 * used, e.g., when remain_on_channel() is used to request extra time
3968 * to receive a response to an Action frame and the response is
3969 * received when there is still unneeded time remaining on the
3970 * remain-on-channel operation.
3971 */
3972 int (*cancel_remain_on_channel)(void *priv);
3973
3974 /**
3975 * probe_req_report - Request Probe Request frames to be indicated
3976 * @priv: Private driver interface data
3977 * @report: Whether to report received Probe Request frames
3978 * Returns: 0 on success, -1 on failure (or if not supported)
3979 *
3980 * This command can be used to request the driver to indicate when
3981 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3982 * Since this operation may require extra resources, e.g., due to less
3983 * optimal hardware/firmware RX filtering, many drivers may disable
3984 * Probe Request reporting at least in station mode. This command is
3985 * used to notify the driver when the Probe Request frames need to be
3986 * reported, e.g., during remain-on-channel operations.
3987 */
3988 int (*probe_req_report)(void *priv, int report);
3989
3990 /**
3991 * deinit_ap - Deinitialize AP mode
3992 * @priv: Private driver interface data
3993 * Returns: 0 on success, -1 on failure (or if not supported)
3994 *
3995 * This optional function can be used to disable AP mode related
3996 * configuration. If the interface was not dynamically added,
3997 * change the driver mode to station mode to allow normal station
3998 * operations like scanning to be completed.
3999 */
4000 int (*deinit_ap)(void *priv);
4001
4002 /**
4003 * deinit_p2p_cli - Deinitialize P2P client mode
4004 * @priv: Private driver interface data
4005 * Returns: 0 on success, -1 on failure (or if not supported)
4006 *
4007 * This optional function can be used to disable P2P client mode. If the
4008 * interface was not dynamically added, change the interface type back
4009 * to station mode.
4010 */
4011 int (*deinit_p2p_cli)(void *priv);
4012
4013 /**
4014 * suspend - Notification on system suspend/hibernate event
4015 * @priv: Private driver interface data
4016 */
4017 void (*suspend)(void *priv);
4018
4019 /**
4020 * resume - Notification on system resume/thaw event
4021 * @priv: Private driver interface data
4022 */
4023 void (*resume)(void *priv);
4024
4025 /**
4026 * signal_monitor - Set signal monitoring parameters
4027 * @priv: Private driver interface data
4028 * @threshold: Threshold value for signal change events; 0 = disabled
4029 * @hysteresis: Minimum change in signal strength before indicating a
4030 * new event
4031 * Returns: 0 on success, -1 on failure (or if not supported)
4032 *
4033 * This function can be used to configure monitoring of signal strength
4034 * with the current AP. Whenever signal strength drops below the
4035 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
4036 * should be generated assuming the signal strength has changed at
4037 * least %hysteresis from the previously indicated signal change event.
4038 */
4039 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
4040
4041 /**
4042 * get_noa - Get current Notice of Absence attribute payload
4043 * @priv: Private driver interface data
4044 * @buf: Buffer for returning NoA
4045 * @buf_len: Buffer length in octets
4046 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
4047 * advertized, or -1 on failure
4048 *
4049 * This function is used to fetch the current Notice of Absence
4050 * attribute value from GO.
4051 */
4052 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
4053
4054 /**
4055 * set_noa - Set Notice of Absence parameters for GO (testing)
4056 * @priv: Private driver interface data
4057 * @count: Count
4058 * @start: Start time in ms from next TBTT
4059 * @duration: Duration in ms
4060 * Returns: 0 on success or -1 on failure
4061 *
4062 * This function is used to set Notice of Absence parameters for GO. It
4063 * is used only for testing. To disable NoA, all parameters are set to
4064 * 0.
4065 */
4066 int (*set_noa)(void *priv, u8 count, int start, int duration);
4067
4068 /**
4069 * set_p2p_powersave - Set P2P power save options
4070 * @priv: Private driver interface data
4071 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
4072 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
4073 * @ctwindow: 0.. = change (msec), -1 = no change
4074 * Returns: 0 on success or -1 on failure
4075 */
4076 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
4077 int ctwindow);
4078
4079 /**
4080 * ampdu - Enable/disable aggregation
4081 * @priv: Private driver interface data
4082 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
4083 * Returns: 0 on success or -1 on failure
4084 */
4085 int (*ampdu)(void *priv, int ampdu);
4086
4087 /**
4088 * get_radio_name - Get physical radio name for the device
4089 * @priv: Private driver interface data
4090 * Returns: Radio name or %NULL if not known
4091 *
4092 * The returned data must not be modified by the caller. It is assumed
4093 * that any interface that has the same radio name as another is
4094 * sharing the same physical radio. This information can be used to
4095 * share scan results etc. information between the virtual interfaces
4096 * to speed up various operations.
4097 */
4098 const char * (*get_radio_name)(void *priv);
4099
4100 /**
4101 * send_tdls_mgmt - for sending TDLS management packets
4102 * @priv: private driver interface data
4103 * @dst: Destination (peer) MAC address
4104 * @action_code: TDLS action code for the mssage
4105 * @dialog_token: Dialog Token to use in the message (if needed)
4106 * @status_code: Status Code or Reason Code to use (if needed)
4107 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
4108 * @initiator: Is the current end the TDLS link initiator
4109 * @buf: TDLS IEs to add to the message
4110 * @len: Length of buf in octets
4111 * Returns: 0 on success, negative (<0) on failure
4112 *
4113 * This optional function can be used to send packet to driver which is
4114 * responsible for receiving and sending all TDLS packets.
4115 */
4116 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
4117 u8 dialog_token, u16 status_code, u32 peer_capab,
4118 int initiator, const u8 *buf, size_t len);
4119
4120 /**
4121 * tdls_oper - Ask the driver to perform high-level TDLS operations
4122 * @priv: Private driver interface data
4123 * @oper: TDLS high-level operation. See %enum tdls_oper
4124 * @peer: Destination (peer) MAC address
4125 * Returns: 0 on success, negative (<0) on failure
4126 *
4127 * This optional function can be used to send high-level TDLS commands
4128 * to the driver.
4129 */
4130 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
4131
4132 /**
4133 * wnm_oper - Notify driver of the WNM frame reception
4134 * @priv: Private driver interface data
4135 * @oper: WNM operation. See %enum wnm_oper
4136 * @peer: Destination (peer) MAC address
4137 * @buf: Buffer for the driver to fill in (for getting IE)
4138 * @buf_len: Return the len of buf
4139 * Returns: 0 on success, negative (<0) on failure
4140 */
4141 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
4142 u8 *buf, u16 *buf_len);
4143
4144 /**
4145 * set_qos_map - Set QoS Map
4146 * @priv: Private driver interface data
4147 * @qos_map_set: QoS Map
4148 * @qos_map_set_len: Length of QoS Map
4149 */
4150 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
4151 u8 qos_map_set_len);
4152
4153 /**
4154 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
4155 * @priv: Private driver interface data
4156 * @version: IP version of the IP address, 4 or 6
4157 * @ipaddr: IP address for the neigh entry
4158 * @prefixlen: IP address prefix length
4159 * @addr: Corresponding MAC address
4160 * Returns: 0 on success, negative (<0) on failure
4161 */
4162 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
4163 int prefixlen, const u8 *addr);
4164
4165 /**
4166 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
4167 * @priv: Private driver interface data
4168 * @version: IP version of the IP address, 4 or 6
4169 * @ipaddr: IP address for the neigh entry
4170 * Returns: 0 on success, negative (<0) on failure
4171 */
4172 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
4173
4174 /**
4175 * br_port_set_attr - Set a bridge port attribute
4176 * @attr: Bridge port attribute to set
4177 * @val: Value to be set
4178 * Returns: 0 on success, negative (<0) on failure
4179 */
4180 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
4181 unsigned int val);
4182
4183 /**
4184 * br_port_set_attr - Set a bridge network parameter
4185 * @param: Bridge parameter to set
4186 * @val: Value to be set
4187 * Returns: 0 on success, negative (<0) on failure
4188 */
4189 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
4190 unsigned int val);
4191
4192 /**
4193 * get_wowlan - Get wake-on-wireless status
4194 * @priv: Private driver interface data
4195 */
4196 int (*get_wowlan)(void *priv);
4197
4198 /**
4199 * set_wowlan - Set wake-on-wireless triggers
4200 * @priv: Private driver interface data
4201 * @triggers: wowlan triggers
4202 */
4203 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
4204
4205 /**
4206 * signal_poll - Get current connection information
4207 * @priv: Private driver interface data
4208 * @signal_info: Connection info structure
4209 */
4210 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
4211
4212 /**
4213 * mlo_signal_poll - Get current MLO connection information
4214 * @priv: Private driver interface data
4215 * @mlo_signal_info: MLO connection info structure
4216 */
4217 int (*mlo_signal_poll)(void *priv,
4218 struct wpa_mlo_signal_info *mlo_signal_info);
4219
4220 /**
4221 * channel_info - Get parameters of the current operating channel
4222 * @priv: Private driver interface data
4223 * @channel_info: Channel info structure
4224 * Returns: 0 on success, negative (<0) on failure
4225 */
4226 int (*channel_info)(void *priv, struct wpa_channel_info *channel_info);
4227
4228 /**
4229 * set_authmode - Set authentication algorithm(s) for static WEP
4230 * @priv: Private driver interface data
4231 * @authmode: 1=Open System, 2=Shared Key, 3=both
4232 * Returns: 0 on success, -1 on failure
4233 *
4234 * This function can be used to set authentication algorithms for AP
4235 * mode when static WEP is used. If the driver uses user space MLME/SME
4236 * implementation, there is no need to implement this function.
4237 *
4238 * DEPRECATED - use set_ap() instead
4239 */
4240 int (*set_authmode)(void *priv, int authmode);
4241
4242#ifdef ANDROID
4243 /**
4244 * driver_cmd - Execute driver-specific command
4245 * @priv: Private driver interface data
4246 * @cmd: Command to execute
4247 * @buf: Return buffer
4248 * @buf_len: Buffer length
4249 * Returns: 0 on success, -1 on failure
4250 */
4251 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
4252#endif /* ANDROID */
4253
4254 /**
4255 * vendor_cmd - Execute vendor specific command
4256 * @priv: Private driver interface data
4257 * @vendor_id: Vendor id
4258 * @subcmd: Vendor command id
4259 * @nested_attr_flag: Specifies if vendor subcommand uses nested
4260 * attributes or not
4261 * @data: Vendor command parameters (%NULL if no parameters)
4262 * @data_len: Data length
4263 * @buf: Return buffer (%NULL to ignore reply)
4264 * Returns: 0 on success, negative (<0) on failure
4265 *
4266 * This function handles vendor specific commands that are passed to
4267 * the driver/device. The command is identified by vendor id and
4268 * command id. The nested_attr_flag specifies whether the subcommand
4269 * uses nested attributes or not. Parameters can be passed
4270 * as argument to the command in the data buffer. Reply (if any) will be
4271 * filled in the supplied return buffer.
4272 *
4273 * The exact driver behavior is driver interface and vendor specific. As
4274 * an example, this will be converted to a vendor specific cfg80211
4275 * command in case of the nl80211 driver interface.
4276 */
4277 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
4278 unsigned int subcmd, const u8 *data, size_t data_len,
4279 enum nested_attr nested_attr_flag,
4280 struct wpabuf *buf);
4281
4282 /**
4283 * set_rekey_info - Set rekey information
4284 * @priv: Private driver interface data
4285 * @kek: Current KEK
4286 * @kek_len: KEK length in octets
4287 * @kck: Current KCK
4288 * @kck_len: KCK length in octets
4289 * @replay_ctr: Current EAPOL-Key Replay Counter
4290 *
4291 * This optional function can be used to provide information for the
4292 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
4293 * while the host (including wpa_supplicant) is sleeping.
4294 */
4295 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
4296 const u8 *kck, size_t kck_len,
4297 const u8 *replay_ctr);
4298
4299 /**
4300 * sta_assoc - Station association indication
4301 * @priv: Private driver interface data
4302 * @own_addr: Source address and BSSID for association frame
4303 * @addr: MAC address of the station to associate
4304 * @reassoc: flag to indicate re-association
4305 * @status: association response status code
4306 * @ie: assoc response ie buffer
4307 * @len: ie buffer length
4308 * Returns: 0 on success, -1 on failure
4309 *
4310 * This function indicates the driver to send (Re)Association
4311 * Response frame to the station.
4312 */
4313 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
4314 int reassoc, u16 status, const u8 *ie, size_t len);
4315
4316 /**
4317 * sta_auth - Station authentication indication
4318 * @priv: private driver interface data
4319 * @params: Station authentication parameters
4320 *
4321 * Returns: 0 on success, -1 on failure
4322 */
4323 int (*sta_auth)(void *priv,
4324 struct wpa_driver_sta_auth_params *params);
4325
4326 /**
4327 * add_tspec - Add traffic stream
4328 * @priv: Private driver interface data
4329 * @addr: MAC address of the station to associate
4330 * @tspec_ie: tspec ie buffer
4331 * @tspec_ielen: tspec ie length
4332 * Returns: 0 on success, -1 on failure
4333 *
4334 * This function adds the traffic steam for the station
4335 * and fills the medium_time in tspec_ie.
4336 */
4337 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
4338 size_t tspec_ielen);
4339
4340 /**
4341 * add_sta_node - Add a station node in the driver
4342 * @priv: Private driver interface data
4343 * @addr: MAC address of the station to add
4344 * @auth_alg: authentication algorithm used by the station
4345 * Returns: 0 on success, -1 on failure
4346 *
4347 * This function adds the station node in the driver, when
4348 * the station gets added by FT-over-DS.
4349 */
4350 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
4351
4352 /**
4353 * sched_scan - Request the driver to initiate scheduled scan
4354 * @priv: Private driver interface data
4355 * @params: Scan parameters
4356 * Returns: 0 on success, -1 on failure
4357 *
4358 * This operation should be used for scheduled scan offload to
4359 * the hardware. Every time scan results are available, the
4360 * driver should report scan results event for wpa_supplicant
4361 * which will eventually request the results with
4362 * wpa_driver_get_scan_results2(). This operation is optional
4363 * and if not provided or if it returns -1, we fall back to
4364 * normal host-scheduled scans.
4365 */
4366 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
4367
4368 /**
4369 * stop_sched_scan - Request the driver to stop a scheduled scan
4370 * @priv: Private driver interface data
4371 * Returns: 0 on success, -1 on failure
4372 *
4373 * This should cause the scheduled scan to be stopped and
4374 * results should stop being sent. Must be supported if
4375 * sched_scan is supported.
4376 */
4377 int (*stop_sched_scan)(void *priv);
4378
4379 /**
4380 * poll_client - Probe (null data or such) the given station
4381 * @priv: Private driver interface data
4382 * @own_addr: MAC address of sending interface
4383 * @addr: MAC address of the station to probe
4384 * @qos: Indicates whether station is QoS station
4385 *
4386 * This function is used to verify whether an associated station is
4387 * still present. This function does not need to be implemented if the
4388 * driver provides such inactivity polling mechanism.
4389 */
4390 void (*poll_client)(void *priv, const u8 *own_addr,
4391 const u8 *addr, int qos);
4392
4393 /**
4394 * radio_disable - Disable/enable radio
4395 * @priv: Private driver interface data
4396 * @disabled: 1=disable 0=enable radio
4397 * Returns: 0 on success, -1 on failure
4398 *
4399 * This optional command is for testing purposes. It can be used to
4400 * disable the radio on a testbed device to simulate out-of-radio-range
4401 * conditions.
4402 */
4403 int (*radio_disable)(void *priv, int disabled);
4404
4405 /**
4406 * switch_channel - Announce channel switch and migrate the GO to the
4407 * given frequency
4408 * @priv: Private driver interface data
4409 * @settings: Settings for CSA period and new channel
4410 * Returns: 0 on success, -1 on failure
4411 *
4412 * This function is used to move the GO to the legacy STA channel to
4413 * avoid frequency conflict in single channel concurrency.
4414 */
4415 int (*switch_channel)(void *priv, struct csa_settings *settings);
4416
4417 /**
4418 * switch_color - Announce color switch and migrate the BSS to the
4419 * given color
4420 * @priv: Private driver interface data
4421 * @settings: Settings for CCA period and new color
4422 * Returns: 0 on success, -1 on failure
4423 *
4424 * This function is used to move the BSS to its new color.
4425 */
4426 int (*switch_color)(void *priv, struct cca_settings *settings);
4427
4428 /**
4429 * add_tx_ts - Add traffic stream
4430 * @priv: Private driver interface data
4431 * @tsid: Traffic stream ID
4432 * @addr: Receiver address
4433 * @user_prio: User priority of the traffic stream
4434 * @admitted_time: Admitted time for this TS in units of
4435 * 32 microsecond periods (per second).
4436 * Returns: 0 on success, -1 on failure
4437 */
4438 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
4439 u16 admitted_time);
4440
4441 /**
4442 * del_tx_ts - Delete traffic stream
4443 * @priv: Private driver interface data
4444 * @tsid: Traffic stream ID
4445 * @addr: Receiver address
4446 * Returns: 0 on success, -1 on failure
4447 */
4448 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
4449
4450 /**
4451 * Enable channel-switching with TDLS peer
4452 * @priv: Private driver interface data
4453 * @addr: MAC address of the TDLS peer
4454 * @oper_class: Operating class of the switch channel
4455 * @params: Channel specification
4456 * Returns: 0 on success, -1 on failure
4457 *
4458 * The function indicates to driver that it can start switching to a
4459 * different channel with a specified TDLS peer. The switching is
4460 * assumed on until canceled with tdls_disable_channel_switch().
4461 */
4462 int (*tdls_enable_channel_switch)(
4463 void *priv, const u8 *addr, u8 oper_class,
4464 const struct hostapd_freq_params *params);
4465
4466 /**
4467 * Disable channel switching with TDLS peer
4468 * @priv: Private driver interface data
4469 * @addr: MAC address of the TDLS peer
4470 * Returns: 0 on success, -1 on failure
4471 *
4472 * This function indicates to the driver that it should stop switching
4473 * with a given TDLS peer.
4474 */
4475 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
4476
4477 /**
4478 * start_dfs_cac - Listen for radar interference on the channel
4479 * @priv: Private driver interface data
4480 * @freq: Channel parameters
4481 * Returns: 0 on success, -1 on failure
4482 */
4483 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
4484
4485 /**
4486 * stop_ap - Removes beacon from AP
4487 * @priv: Private driver interface data
4488 * Returns: 0 on success, -1 on failure (or if not supported)
4489 *
4490 * This optional function can be used to disable AP mode related
4491 * configuration. Unlike deinit_ap, it does not change to station
4492 * mode.
4493 */
4494 int (*stop_ap)(void *priv);
4495
4496 /**
4497 * get_survey - Retrieve survey data
4498 * @priv: Private driver interface data
4499 * @freq: If set, survey data for the specified frequency is only
4500 * being requested. If not set, all survey data is requested.
4501 * Returns: 0 on success, -1 on failure
4502 *
4503 * Use this to retrieve:
4504 *
4505 * - the observed channel noise floor
4506 * - the amount of time we have spent on the channel
4507 * - the amount of time during which we have spent on the channel that
4508 * the radio has determined the medium is busy and we cannot
4509 * transmit
4510 * - the amount of time we have spent receiving data
4511 * - the amount of time we have spent transmitting data
4512 *
4513 * This data can be used for spectrum heuristics. One example is
4514 * Automatic Channel Selection (ACS). The channel survey data is
4515 * kept on a linked list on the channel data, one entry is added
4516 * for each survey. The min_nf of the channel is updated for each
4517 * survey.
4518 */
4519 int (*get_survey)(void *priv, unsigned int freq);
4520
4521 /**
4522 * status - Get driver interface status information
4523 * @priv: Private driver interface data
4524 * @buf: Buffer for printing the status information
4525 * @buflen: Maximum length of the buffer
4526 * Returns: Length of written status information or -1 on failure
4527 */
4528 int (*status)(void *priv, char *buf, size_t buflen);
4529
4530 /**
4531 * roaming - Set roaming policy for driver-based BSS selection
4532 * @priv: Private driver interface data
4533 * @allowed: Whether roaming within ESS is allowed
4534 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
4535 * Returns: Length of written status information or -1 on failure
4536 *
4537 * This optional callback can be used to update roaming policy from the
4538 * associate() command (bssid being set there indicates that the driver
4539 * should not roam before getting this roaming() call to allow roaming.
4540 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
4541 * capability, roaming policy is handled within wpa_supplicant and there
4542 * is no need to implement or react to this callback.
4543 */
4544 int (*roaming)(void *priv, int allowed, const u8 *bssid);
4545
4546 /**
4547 * disable_fils - Enable/disable FILS feature
4548 * @priv: Private driver interface data
4549 * @disable: 0-enable and 1-disable FILS feature
4550 * Returns: 0 on success, -1 on failure
4551 *
4552 * This callback can be used to configure driver and below layers to
4553 * enable/disable all FILS features.
4554 */
4555 int (*disable_fils)(void *priv, int disable);
4556
4557 /**
4558 * set_mac_addr - Set MAC address
4559 * @priv: Private driver interface data
4560 * @addr: MAC address to use or %NULL for setting back to permanent
4561 * Returns: 0 on success, -1 on failure
4562 */
4563 int (*set_mac_addr)(void *priv, const u8 *addr);
4564
4565#ifdef CONFIG_MACSEC
4566 int (*macsec_init)(void *priv, struct macsec_init_params *params);
4567
4568 int (*macsec_deinit)(void *priv);
4569
4570 /**
4571 * macsec_get_capability - Inform MKA of this driver's capability
4572 * @priv: Private driver interface data
4573 * @cap: Driver's capability
4574 * Returns: 0 on success, -1 on failure
4575 */
4576 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);
4577
4578 /**
4579 * enable_protect_frames - Set protect frames status
4580 * @priv: Private driver interface data
4581 * @enabled: true = protect frames enabled
4582 * false = protect frames disabled
4583 * Returns: 0 on success, -1 on failure (or if not supported)
4584 */
4585 int (*enable_protect_frames)(void *priv, bool enabled);
4586
4587 /**
4588 * enable_encrypt - Set encryption status
4589 * @priv: Private driver interface data
4590 * @enabled: true = encrypt outgoing traffic
4591 * false = integrity-only protection on outgoing traffic
4592 * Returns: 0 on success, -1 on failure (or if not supported)
4593 */
4594 int (*enable_encrypt)(void *priv, bool enabled);
4595
4596 /**
4597 * set_replay_protect - Set replay protect status and window size
4598 * @priv: Private driver interface data
4599 * @enabled: true = replay protect enabled
4600 * false = replay protect disabled
4601 * @window: replay window size, valid only when replay protect enabled
4602 * Returns: 0 on success, -1 on failure (or if not supported)
4603 */
4604 int (*set_replay_protect)(void *priv, bool enabled, u32 window);
4605
4606 /**
4607 * set_offload - Set MACsec hardware offload
4608 * @priv: Private driver interface data
4609 * @offload: 0 = MACSEC_OFFLOAD_OFF
4610 * 1 = MACSEC_OFFLOAD_PHY
4611 * 2 = MACSEC_OFFLOAD_MAC
4612 * Returns: 0 on success, -1 on failure (or if not supported)
4613 */
4614 int (*set_offload)(void *priv, u8 offload);
4615
4616 /**
4617 * set_current_cipher_suite - Set current cipher suite
4618 * @priv: Private driver interface data
4619 * @cs: EUI64 identifier
4620 * Returns: 0 on success, -1 on failure (or if not supported)
4621 */
4622 int (*set_current_cipher_suite)(void *priv, u64 cs);
4623
4624 /**
4625 * enable_controlled_port - Set controlled port status
4626 * @priv: Private driver interface data
4627 * @enabled: true = controlled port enabled
4628 * false = controlled port disabled
4629 * Returns: 0 on success, -1 on failure (or if not supported)
4630 */
4631 int (*enable_controlled_port)(void *priv, bool enabled);
4632
4633 /**
4634 * get_receive_lowest_pn - Get receive lowest pn
4635 * @priv: Private driver interface data
4636 * @sa: secure association
4637 * Returns: 0 on success, -1 on failure (or if not supported)
4638 */
4639 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);
4640
4641 /**
4642 * get_transmit_next_pn - Get transmit next pn
4643 * @priv: Private driver interface data
4644 * @sa: secure association
4645 * Returns: 0 on success, -1 on failure (or if not supported)
4646 */
4647 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);
4648
4649 /**
4650 * set_transmit_next_pn - Set transmit next pn
4651 * @priv: Private driver interface data
4652 * @sa: secure association
4653 * Returns: 0 on success, -1 on failure (or if not supported)
4654 */
4655 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);
4656
4657 /**
4658 * set_receive_lowest_pn - Set receive lowest PN
4659 * @priv: Private driver interface data
4660 * @sa: secure association
4661 * Returns: 0 on success, -1 on failure (or if not supported)
4662 */
4663 int (*set_receive_lowest_pn)(void *priv, struct receive_sa *sa);
4664
4665 /**
4666 * create_receive_sc - create secure channel for receiving
4667 * @priv: Private driver interface data
4668 * @sc: secure channel
4669 * @conf_offset: confidentiality offset (0, 30, or 50)
4670 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
4671 * 2 = Strict)
4672 * Returns: 0 on success, -1 on failure (or if not supported)
4673 */
4674 int (*create_receive_sc)(void *priv, struct receive_sc *sc,
4675 unsigned int conf_offset,
4676 int validation);
4677
4678 /**
4679 * delete_receive_sc - delete secure connection for receiving
4680 * @priv: private driver interface data from init()
4681 * @sc: secure channel
4682 * Returns: 0 on success, -1 on failure
4683 */
4684 int (*delete_receive_sc)(void *priv, struct receive_sc *sc);
4685
4686 /**
4687 * create_receive_sa - create secure association for receive
4688 * @priv: private driver interface data from init()
4689 * @sa: secure association
4690 * Returns: 0 on success, -1 on failure
4691 */
4692 int (*create_receive_sa)(void *priv, struct receive_sa *sa);
4693
4694 /**
4695 * delete_receive_sa - Delete secure association for receive
4696 * @priv: Private driver interface data from init()
4697 * @sa: Secure association
4698 * Returns: 0 on success, -1 on failure
4699 */
4700 int (*delete_receive_sa)(void *priv, struct receive_sa *sa);
4701
4702 /**
4703 * enable_receive_sa - enable the SA for receive
4704 * @priv: private driver interface data from init()
4705 * @sa: secure association
4706 * Returns: 0 on success, -1 on failure
4707 */
4708 int (*enable_receive_sa)(void *priv, struct receive_sa *sa);
4709
4710 /**
4711 * disable_receive_sa - disable SA for receive
4712 * @priv: private driver interface data from init()
4713 * @sa: secure association
4714 * Returns: 0 on success, -1 on failure
4715 */
4716 int (*disable_receive_sa)(void *priv, struct receive_sa *sa);
4717
4718 /**
4719 * create_transmit_sc - create secure connection for transmit
4720 * @priv: private driver interface data from init()
4721 * @sc: secure channel
4722 * @conf_offset: confidentiality offset (0, 30, or 50)
4723 * Returns: 0 on success, -1 on failure
4724 */
4725 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
4726 unsigned int conf_offset);
4727
4728 /**
4729 * delete_transmit_sc - delete secure connection for transmit
4730 * @priv: private driver interface data from init()
4731 * @sc: secure channel
4732 * Returns: 0 on success, -1 on failure
4733 */
4734 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);
4735
4736 /**
4737 * create_transmit_sa - create secure association for transmit
4738 * @priv: private driver interface data from init()
4739 * @sa: secure association
4740 * Returns: 0 on success, -1 on failure
4741 */
4742 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);
4743
4744 /**
4745 * delete_transmit_sa - Delete secure association for transmit
4746 * @priv: Private driver interface data from init()
4747 * @sa: Secure association
4748 * Returns: 0 on success, -1 on failure
4749 */
4750 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);
4751
4752 /**
4753 * enable_transmit_sa - enable SA for transmit
4754 * @priv: private driver interface data from init()
4755 * @sa: secure association
4756 * Returns: 0 on success, -1 on failure
4757 */
4758 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);
4759
4760 /**
4761 * disable_transmit_sa - disable SA for transmit
4762 * @priv: private driver interface data from init()
4763 * @sa: secure association
4764 * Returns: 0 on success, -1 on failure
4765 */
4766 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
4767#endif /* CONFIG_MACSEC */
4768
4769 /**
4770 * init_mesh - Driver specific initialization for mesh
4771 * @priv: Private driver interface data
4772 * Returns: 0 on success, -1 on failure
4773 */
4774 int (*init_mesh)(void *priv);
4775
4776 /**
4777 * join_mesh - Join a mesh network
4778 * @priv: Private driver interface data
4779 * @params: Mesh configuration parameters
4780 * Returns: 0 on success, -1 on failure
4781 */
4782 int (*join_mesh)(void *priv,
4783 struct wpa_driver_mesh_join_params *params);
4784
4785 /**
4786 * leave_mesh - Leave a mesh network
4787 * @priv: Private driver interface data
4788 * Returns 0 on success, -1 on failure
4789 */
4790 int (*leave_mesh)(void *priv);
4791
4792 /**
4793 * probe_mesh_link - Inject a frame over direct mesh link to a given
4794 * peer skipping the next_hop lookup from mpath table.
4795 * @priv: Private driver interface data
4796 * @addr: Peer MAC address
4797 * @eth: Ethernet frame to be sent
4798 * @len: Ethernet frame lengtn in bytes
4799 * Returns 0 on success, -1 on failure
4800 */
4801 int (*probe_mesh_link)(void *priv, const u8 *addr, const u8 *eth,
4802 size_t len);
4803
4804 /**
4805 * do_acs - Automatically select channel
4806 * @priv: Private driver interface data
4807 * @params: Parameters for ACS
4808 * Returns 0 on success, -1 on failure
4809 *
4810 * This command can be used to offload ACS to the driver if the driver
4811 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
4812 */
4813 int (*do_acs)(void *priv, struct drv_acs_params *params);
4814
4815 /**
4816 * set_band - Notify driver of band(s) selection
4817 * @priv: Private driver interface data
4818 * @band_mask: The selected band(s) bit mask (from enum set_band)
4819 * Returns 0 on success, -1 on failure
4820 */
4821 int (*set_band)(void *priv, u32 band_mask);
4822
4823 /**
4824 * get_pref_freq_list - Get preferred frequency list for an interface
4825 * @priv: Private driver interface data
4826 * @if_type: Interface type
4827 * @num: Number of channels
4828 * @freq_list: Weighted preferred channel list
4829 * Returns 0 on success, -1 on failure
4830 *
4831 * This command can be used to query the preferred frequency list from
4832 * the driver specific to a particular interface type. The freq_list
4833 * array needs to have room for *num entries. *num will be updated to
4834 * indicate the number of entries fetched from the driver.
4835 */
4836 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
4837 unsigned int *num,
4838 struct weighted_pcl *freq_list);
4839
4840 /**
4841 * set_prob_oper_freq - Indicate probable P2P operating channel
4842 * @priv: Private driver interface data
4843 * @freq: Channel frequency in MHz
4844 * Returns 0 on success, -1 on failure
4845 *
4846 * This command can be used to inform the driver of the operating
4847 * frequency that an ongoing P2P group formation is likely to come up
4848 * on. Local device is assuming P2P Client role.
4849 */
4850 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
4851
4852 /**
4853 * abort_scan - Request the driver to abort an ongoing scan
4854 * @priv: Private driver interface data
4855 * @scan_cookie: Cookie identifying the scan request. This is used only
4856 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4857 * was used to trigger scan. Otherwise, 0 is used.
4858 * Returns 0 on success, -1 on failure
4859 */
4860 int (*abort_scan)(void *priv, u64 scan_cookie);
4861
4862 /**
4863 * configure_data_frame_filters - Request to configure frame filters
4864 * @priv: Private driver interface data
4865 * @filter_flags: The type of frames to filter (bitfield of
4866 * WPA_DATA_FRAME_FILTER_FLAG_*)
4867 * Returns: 0 on success or -1 on failure
4868 */
4869 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
4870
4871 /**
4872 * get_ext_capab - Get extended capabilities for the specified interface
4873 * @priv: Private driver interface data
4874 * @type: Interface type for which to get extended capabilities
4875 * @ext_capab: Extended capabilities fetched
4876 * @ext_capab_mask: Extended capabilities mask
4877 * @ext_capab_len: Length of the extended capabilities
4878 * Returns: 0 on success or -1 on failure
4879 */
4880 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
4881 const u8 **ext_capab, const u8 **ext_capab_mask,
4882 unsigned int *ext_capab_len);
4883
4884 /**
4885 * get_mld_capab - Get MLD capabilities for the specified interface
4886 * @priv: Private driver interface data
4887 * @type: Interface type for which to get MLD capabilities
4888 * @eml_capa: EML capabilities
4889 * @mld_capa_and_ops: MLD Capabilities and Operations
4890 * Returns: 0 on success or -1 on failure
4891 */
4892 int (*get_mld_capab)(void *priv, enum wpa_driver_if_type type,
4893 u16 *eml_capa, u16 *mld_capa_and_ops);
4894
4895 /**
4896 * p2p_lo_start - Start offloading P2P listen to device
4897 * @priv: Private driver interface data
4898 * @freq: Listening frequency (MHz) for P2P listen
4899 * @period: Length of the listen operation in milliseconds
4900 * @interval: Interval for running the listen operation in milliseconds
4901 * @count: Number of times to run the listen operation
4902 * @device_types: Device primary and secondary types
4903 * @dev_types_len: Number of bytes for device_types
4904 * @ies: P2P IE and WSC IE for Probe Response frames
4905 * @ies_len: Length of ies in bytes
4906 * Returns: 0 on success or -1 on failure
4907 */
4908 int (*p2p_lo_start)(void *priv, unsigned int freq,
4909 unsigned int period, unsigned int interval,
4910 unsigned int count,
4911 const u8 *device_types, size_t dev_types_len,
4912 const u8 *ies, size_t ies_len);
4913
4914 /**
4915 * p2p_lo_stop - Stop P2P listen offload
4916 * @priv: Private driver interface data
4917 * Returns: 0 on success or -1 on failure
4918 */
4919 int (*p2p_lo_stop)(void *priv);
4920
4921 /**
4922 * set_default_scan_ies - Set default scan IEs
4923 * @priv: Private driver interface data
4924 * @ies: Scan default IEs buffer
4925 * @ies_len: Length of IEs in bytes
4926 * Returns: 0 on success or -1 on failure
4927 *
4928 * The driver can use these by default when there are no scan IEs coming
4929 * in the subsequent scan requests. Also in case of one or more of IEs
4930 * given in set_default_scan_ies() are missing in the subsequent scan
4931 * request, the driver should merge the missing scan IEs in the scan
4932 * request from the IEs set by set_default_scan_ies() in the Probe
4933 * Request frames sent.
4934 */
4935 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
4936
4937 /**
4938 * set_tdls_mode - Set TDLS trigger mode to the host driver
4939 * @priv: Private driver interface data
4940 * @tdls_external_control: Represents if TDLS external trigger control
4941 * mode is enabled/disabled.
4942 *
4943 * This optional callback can be used to configure the TDLS external
4944 * trigger control mode to the host driver.
4945 */
4946 int (*set_tdls_mode)(void *priv, int tdls_external_control);
4947
4948 /**
4949 * get_bss_transition_status - Get candidate BSS's transition status
4950 * @priv: Private driver interface data
4951 * @params: Candidate BSS list
4952 *
4953 * Get the accept or reject reason code for a list of BSS transition
4954 * candidates.
4955 */
4956 struct wpa_bss_candidate_info *
4957 (*get_bss_transition_status)(void *priv,
4958 struct wpa_bss_trans_info *params);
4959 /**
4960 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
4961 * @priv: Private driver interface data
4962 * @ignore_disallow: 0 to not ignore, 1 to ignore
4963 * Returns: 0 on success, -1 on failure
4964 */
4965 int (*ignore_assoc_disallow)(void *priv, int ignore_disallow);
4966
4967 /**
4968 * set_bssid_tmp_disallow - Set disallowed BSSIDs to the driver
4969 * @priv: Private driver interface data
4970 * @num_bssid: Number of temporarily disallowed BSSIDs
4971 * @bssids: List of temporarily disallowed BSSIDs
4972 */
4973 int (*set_bssid_tmp_disallow)(void *priv, unsigned int num_bssid,
4974 const u8 *bssid);
4975
4976 /**
4977 * update_connect_params - Update the connection parameters
4978 * @priv: Private driver interface data
4979 * @params: Association parameters
4980 * @mask: Bit mask indicating which parameters in @params have to be
4981 * updated
4982 * Returns: 0 on success, -1 on failure
4983 *
4984 * Update the connection parameters when in connected state so that the
4985 * driver uses the updated parameters for subsequent roaming. This is
4986 * used only with drivers that implement internal BSS selection and
4987 * roaming.
4988 */
4989 int (*update_connect_params)(
4990 void *priv, struct wpa_driver_associate_params *params,
4991 enum wpa_drv_update_connect_params_mask mask);
4992
4993 /**
4994 * send_external_auth_status - Indicate the status of external
4995 * authentication processing to the host driver.
4996 * @priv: Private driver interface data
4997 * @params: Status of authentication processing.
4998 * Returns: 0 on success, -1 on failure
4999 */
5000 int (*send_external_auth_status)(void *priv,
5001 struct external_auth *params);
5002
5003 /**
5004 * set_4addr_mode - Set 4-address mode
5005 * @priv: Private driver interface data
5006 * @bridge_ifname: Bridge interface name
5007 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
5008 * Returns: 0 on success, < 0 on failure
5009 */
5010 int (*set_4addr_mode)(void *priv, const char *bridge_ifname, int val);
5011
5012 /**
5013 * update_dh_ie - Update DH IE
5014 * @priv: Private driver interface data
5015 * @peer_mac: Peer MAC address
5016 * @reason_code: Reacon code
5017 * @ie: DH IE
5018 * @ie_len: DH IE length in bytes
5019 * Returns: 0 on success, -1 on failure
5020 *
5021 * This callback is used to let the driver know the DH processing result
5022 * and DH IE for a pending association.
5023 */
5024 int (*update_dh_ie)(void *priv, const u8 *peer_mac, u16 reason_code,
5025 const u8 *ie, size_t ie_len);
5026
5027 /**
5028 * dpp_listen - Notify driver about start/stop of DPP listen
5029 * @priv: Private driver interface data
5030 * @enable: Whether listen state is enabled (or disabled)
5031 * Returns: 0 on success, -1 on failure
5032 *
5033 * This optional callback can be used to update RX frame filtering to
5034 * explicitly allow reception of broadcast Public Action frames.
5035 */
5036 int (*dpp_listen)(void *priv, bool enable);
5037
5038 /**
5039 * set_secure_ranging_ctx - Add or delete secure ranging parameters of
5040 * the specified peer to the driver.
5041 * @priv: Private driver interface data
5042 * @params: Secure ranging parameters
5043 * Returns: 0 on success, -1 on failure
5044 *
5045 */
5046 int (*set_secure_ranging_ctx)(void *priv,
5047 struct secure_ranging_params *params);
5048
5049 /**
5050 * send_pasn_resp - Send PASN response for a set of peers to the
5051 * driver.
5052 * @priv: Private driver interface data
5053 * @params: Parameters holding peers and respective status.
5054 * Returns: 0 on success, -1 on failure
5055 */
5056 int (*send_pasn_resp)(void *priv, struct pasn_auth *params);
5057
5058 /**
5059 * get_sta_mlo_info - Get the current multi-link association info
5060 * @priv: Private driver interface data
5061 * @mlo: Pointer to fill multi-link association info
5062 * Returns: 0 on success, -1 on failure
5063 *
5064 * This callback is used to fetch multi-link of the current association.
5065 */
5066 int (*get_sta_mlo_info)(void *priv,
5067 struct driver_sta_mlo_info *mlo_info);
5068
5069 /**
5070 * link_add - Add a link to the AP MLD interface
5071 * @priv: Private driver interface data
5072 * @link_id: The link ID
5073 * @addr: The MAC address to use for the link
5074 * Returns: 0 on success, negative value on failure
5075 */
5076 int (*link_add)(void *priv, u8 link_id, const u8 *addr);
5077
5078#ifdef CONFIG_TESTING_OPTIONS
5079 int (*register_frame)(void *priv, u16 type,
5080 const u8 *match, size_t match_len,
5081 bool multicast);
5082#endif /* CONFIG_TESTING_OPTIONS */
5083};
5084
5085/**
5086 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
5087 */
5088enum wpa_event_type {
5089 /**
5090 * EVENT_ASSOC - Association completed
5091 *
5092 * This event needs to be delivered when the driver completes IEEE
5093 * 802.11 association or reassociation successfully.
5094 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
5095 * after this event has been generated. In addition, optional
5096 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
5097 * more information about the association. If the driver interface gets
5098 * both of these events at the same time, it can also include the
5099 * assoc_info data in EVENT_ASSOC call.
5100 */
5101 EVENT_ASSOC,
5102
5103 /**
5104 * EVENT_DISASSOC - Association lost
5105 *
5106 * This event should be called when association is lost either due to
5107 * receiving deauthenticate or disassociate frame from the AP or when
5108 * sending either of these frames to the current AP. If the driver
5109 * supports separate deauthentication event, EVENT_DISASSOC should only
5110 * be used for disassociation and EVENT_DEAUTH for deauthentication.
5111 * In AP mode, union wpa_event_data::disassoc_info is required.
5112 */
5113 EVENT_DISASSOC,
5114
5115 /**
5116 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
5117 *
5118 * This event must be delivered when a Michael MIC error is detected by
5119 * the local driver. Additional data for event processing is
5120 * provided with union wpa_event_data::michael_mic_failure. This
5121 * information is used to request new encryption key and to initiate
5122 * TKIP countermeasures if needed.
5123 */
5124 EVENT_MICHAEL_MIC_FAILURE,
5125
5126 /**
5127 * EVENT_SCAN_RESULTS - Scan results available
5128 *
5129 * This event must be called whenever scan results are available to be
5130 * fetched with struct wpa_driver_ops::get_scan_results(). This event
5131 * is expected to be used some time after struct wpa_driver_ops::scan()
5132 * is called. If the driver provides an unsolicited event when the scan
5133 * has been completed, this event can be used to trigger
5134 * EVENT_SCAN_RESULTS call. If such event is not available from the
5135 * driver, the driver wrapper code is expected to use a registered
5136 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
5137 * scan is expected to be completed. Optional information about
5138 * completed scan can be provided with union wpa_event_data::scan_info.
5139 */
5140 EVENT_SCAN_RESULTS,
5141
5142 /**
5143 * EVENT_ASSOCINFO - Report optional extra information for association
5144 *
5145 * This event can be used to report extra association information for
5146 * EVENT_ASSOC processing. This extra information includes IEs from
5147 * association frames and Beacon/Probe Response frames in union
5148 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
5149 * EVENT_ASSOC. Alternatively, the driver interface can include
5150 * assoc_info data in the EVENT_ASSOC call if it has all the
5151 * information available at the same point.
5152 */
5153 EVENT_ASSOCINFO,
5154
5155 /**
5156 * EVENT_INTERFACE_STATUS - Report interface status changes
5157 *
5158 * This optional event can be used to report changes in interface
5159 * status (interface added/removed) using union
5160 * wpa_event_data::interface_status. This can be used to trigger
5161 * wpa_supplicant to stop and re-start processing for the interface,
5162 * e.g., when a cardbus card is ejected/inserted.
5163 */
5164 EVENT_INTERFACE_STATUS,
5165
5166 /**
5167 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
5168 *
5169 * This event can be used to inform wpa_supplicant about candidates for
5170 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
5171 * for scan request (ap_scan=2 mode), this event is required for
5172 * pre-authentication. If wpa_supplicant is performing scan request
5173 * (ap_scan=1), this event is optional since scan results can be used
5174 * to add pre-authentication candidates. union
5175 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
5176 * candidate and priority of the candidate, e.g., based on the signal
5177 * strength, in order to try to pre-authenticate first with candidates
5178 * that are most likely targets for re-association.
5179 *
5180 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
5181 * on the candidate list. In addition, it can be called for the current
5182 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
5183 * will automatically skip pre-authentication in cases where a valid
5184 * PMKSA exists. When more than one candidate exists, this event should
5185 * be generated once for each candidate.
5186 *
5187 * Driver will be notified about successful pre-authentication with
5188 * struct wpa_driver_ops::add_pmkid() calls.
5189 */
5190 EVENT_PMKID_CANDIDATE,
5191
5192 /**
5193 * EVENT_TDLS - Request TDLS operation
5194 *
5195 * This event can be used to request a TDLS operation to be performed.
5196 */
5197 EVENT_TDLS,
5198
5199 /**
5200 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
5201 *
5202 * The driver is expected to report the received FT IEs from
5203 * FT authentication sequence from the AP. The FT IEs are included in
5204 * the extra information in union wpa_event_data::ft_ies.
5205 */
5206 EVENT_FT_RESPONSE,
5207
5208 /**
5209 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
5210 *
5211 * The driver can use this event to inform wpa_supplicant about a STA
5212 * in an IBSS with which protected frames could be exchanged. This
5213 * event starts RSN authentication with the other STA to authenticate
5214 * the STA and set up encryption keys with it.
5215 */
5216 EVENT_IBSS_RSN_START,
5217
5218 /**
5219 * EVENT_AUTH - Authentication result
5220 *
5221 * This event should be called when authentication attempt has been
5222 * completed. This is only used if the driver supports separate
5223 * authentication step (struct wpa_driver_ops::authenticate).
5224 * Information about authentication result is included in
5225 * union wpa_event_data::auth.
5226 */
5227 EVENT_AUTH,
5228
5229 /**
5230 * EVENT_DEAUTH - Authentication lost
5231 *
5232 * This event should be called when authentication is lost either due
5233 * to receiving deauthenticate frame from the AP or when sending that
5234 * frame to the current AP.
5235 * In AP mode, union wpa_event_data::deauth_info is required.
5236 */
5237 EVENT_DEAUTH,
5238
5239 /**
5240 * EVENT_ASSOC_REJECT - Association rejected
5241 *
5242 * This event should be called when (re)association attempt has been
5243 * rejected by the AP. Information about the association response is
5244 * included in union wpa_event_data::assoc_reject.
5245 */
5246 EVENT_ASSOC_REJECT,
5247
5248 /**
5249 * EVENT_AUTH_TIMED_OUT - Authentication timed out
5250 */
5251 EVENT_AUTH_TIMED_OUT,
5252
5253 /**
5254 * EVENT_ASSOC_TIMED_OUT - Association timed out
5255 */
5256 EVENT_ASSOC_TIMED_OUT,
5257
5258 /**
5259 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
5260 */
5261 EVENT_WPS_BUTTON_PUSHED,
5262
5263 /**
5264 * EVENT_TX_STATUS - Report TX status
5265 */
5266 EVENT_TX_STATUS,
5267
5268 /**
5269 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
5270 */
5271 EVENT_RX_FROM_UNKNOWN,
5272
5273 /**
5274 * EVENT_RX_MGMT - Report RX of a management frame
5275 */
5276 EVENT_RX_MGMT,
5277
5278 /**
5279 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
5280 *
5281 * This event is used to indicate when the driver has started the
5282 * requested remain-on-channel duration. Information about the
5283 * operation is included in union wpa_event_data::remain_on_channel.
5284 */
5285 EVENT_REMAIN_ON_CHANNEL,
5286
5287 /**
5288 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
5289 *
5290 * This event is used to indicate when the driver has completed
5291 * remain-on-channel duration, i.e., may noot be available on the
5292 * requested channel anymore. Information about the
5293 * operation is included in union wpa_event_data::remain_on_channel.
5294 */
5295 EVENT_CANCEL_REMAIN_ON_CHANNEL,
5296
5297 /**
5298 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
5299 *
5300 * This event is used to indicate when a Probe Request frame has been
5301 * received. Information about the received frame is included in
5302 * union wpa_event_data::rx_probe_req. The driver is required to report
5303 * these events only after successfully completed probe_req_report()
5304 * commands to request the events (i.e., report parameter is non-zero)
5305 * in station mode. In AP mode, Probe Request frames should always be
5306 * reported.
5307 */
5308 EVENT_RX_PROBE_REQ,
5309
5310 /**
5311 * EVENT_NEW_STA - New wired device noticed
5312 *
5313 * This event is used to indicate that a new device has been detected
5314 * in a network that does not use association-like functionality (i.e.,
5315 * mainly wired Ethernet). This can be used to start EAPOL
5316 * authenticator when receiving a frame from a device. The address of
5317 * the device is included in union wpa_event_data::new_sta.
5318 */
5319 EVENT_NEW_STA,
5320
5321 /**
5322 * EVENT_EAPOL_RX - Report received EAPOL frame
5323 *
5324 * When in AP mode with hostapd, this event is required to be used to
5325 * deliver the receive EAPOL frames from the driver.
5326 */
5327 EVENT_EAPOL_RX,
5328
5329 /**
5330 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
5331 *
5332 * This event is used to indicate changes in the signal strength
5333 * observed in frames received from the current AP if signal strength
5334 * monitoring has been enabled with signal_monitor().
5335 */
5336 EVENT_SIGNAL_CHANGE,
5337
5338 /**
5339 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
5340 *
5341 * This event is used to indicate that the interface was enabled after
5342 * having been previously disabled, e.g., due to rfkill.
5343 */
5344 EVENT_INTERFACE_ENABLED,
5345
5346 /**
5347 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
5348 *
5349 * This event is used to indicate that the interface was disabled,
5350 * e.g., due to rfkill.
5351 */
5352 EVENT_INTERFACE_DISABLED,
5353
5354 /**
5355 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
5356 *
5357 * This event is used to indicate that the channel list has changed,
5358 * e.g., because of a regulatory domain change triggered by scan
5359 * results including an AP advertising a country code.
5360 */
5361 EVENT_CHANNEL_LIST_CHANGED,
5362
5363 /**
5364 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
5365 *
5366 * This event is used to indicate that the driver cannot maintain this
5367 * interface in its operation mode anymore. The most likely use for
5368 * this is to indicate that AP mode operation is not available due to
5369 * operating channel would need to be changed to a DFS channel when
5370 * the driver does not support radar detection and another virtual
5371 * interfaces caused the operating channel to change. Other similar
5372 * resource conflicts could also trigger this for station mode
5373 * interfaces. This event can be propagated when channel switching
5374 * fails.
5375 */
5376 EVENT_INTERFACE_UNAVAILABLE,
5377
5378 /**
5379 * EVENT_BEST_CHANNEL
5380 *
5381 * Driver generates this event whenever it detects a better channel
5382 * (e.g., based on RSSI or channel use). This information can be used
5383 * to improve channel selection for a new AP/P2P group.
5384 */
5385 EVENT_BEST_CHANNEL,
5386
5387 /**
5388 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
5389 *
5390 * This event should be called when a Deauthentication frame is dropped
5391 * due to it not being protected (MFP/IEEE 802.11w).
5392 * union wpa_event_data::unprot_deauth is required to provide more
5393 * details of the frame.
5394 */
5395 EVENT_UNPROT_DEAUTH,
5396
5397 /**
5398 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
5399 *
5400 * This event should be called when a Disassociation frame is dropped
5401 * due to it not being protected (MFP/IEEE 802.11w).
5402 * union wpa_event_data::unprot_disassoc is required to provide more
5403 * details of the frame.
5404 */
5405 EVENT_UNPROT_DISASSOC,
5406
5407 /**
5408 * EVENT_STATION_LOW_ACK
5409 *
5410 * Driver generates this event whenever it detected that a particular
5411 * station was lost. Detection can be through massive transmission
5412 * failures for example.
5413 */
5414 EVENT_STATION_LOW_ACK,
5415
5416 /**
5417 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
5418 */
5419 EVENT_IBSS_PEER_LOST,
5420
5421 /**
5422 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
5423 *
5424 * This event carries the new replay counter to notify wpa_supplicant
5425 * of the current EAPOL-Key Replay Counter in case the driver/firmware
5426 * completed Group Key Handshake while the host (including
5427 * wpa_supplicant was sleeping).
5428 */
5429 EVENT_DRIVER_GTK_REKEY,
5430
5431 /**
5432 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
5433 */
5434 EVENT_SCHED_SCAN_STOPPED,
5435
5436 /**
5437 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
5438 *
5439 * This event indicates that the station responded to the poll
5440 * initiated with @poll_client.
5441 */
5442 EVENT_DRIVER_CLIENT_POLL_OK,
5443
5444 /**
5445 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
5446 */
5447 EVENT_EAPOL_TX_STATUS,
5448
5449 /**
5450 * EVENT_CH_SWITCH - AP or GO decided to switch channels
5451 *
5452 * Described in wpa_event_data.ch_switch
5453 * */
5454 EVENT_CH_SWITCH,
5455
5456 /**
5457 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
5458 *
5459 * This is a pre-switch event indicating the shortly following switch
5460 * of operating channels.
5461 *
5462 * Described in wpa_event_data.ch_switch
5463 */
5464 EVENT_CH_SWITCH_STARTED,
5465 /**
5466 * EVENT_WNM - Request WNM operation
5467 *
5468 * This event can be used to request a WNM operation to be performed.
5469 */
5470 EVENT_WNM,
5471
5472 /**
5473 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
5474 *
5475 * This event indicates that the driver reported a connection failure
5476 * with the specified client (for example, max client reached, etc.) in
5477 * AP mode.
5478 */
5479 EVENT_CONNECT_FAILED_REASON,
5480
5481 /**
5482 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
5483 *
5484 * A radar has been detected on the supplied frequency, hostapd should
5485 * react accordingly (e.g., change channel).
5486 */
5487 EVENT_DFS_RADAR_DETECTED,
5488
5489 /**
5490 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
5491 *
5492 * After a successful CAC, the channel can be marked clear and used.
5493 */
5494 EVENT_DFS_CAC_FINISHED,
5495
5496 /**
5497 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
5498 *
5499 * The CAC was not successful, and the channel remains in the previous
5500 * state. This may happen due to a radar being detected or other
5501 * external influences.
5502 */
5503 EVENT_DFS_CAC_ABORTED,
5504
5505 /**
5506 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
5507 *
5508 * The channel which was previously unavailable is now available again.
5509 */
5510 EVENT_DFS_NOP_FINISHED,
5511
5512 /**
5513 * EVENT_SURVEY - Received survey data
5514 *
5515 * This event gets triggered when a driver query is issued for survey
5516 * data and the requested data becomes available. The returned data is
5517 * stored in struct survey_results. The results provide at most one
5518 * survey entry for each frequency and at minimum will provide one
5519 * survey entry for one frequency. The survey data can be os_malloc()'d
5520 * and then os_free()'d, so the event callback must only copy data.
5521 */
5522 EVENT_SURVEY,
5523
5524 /**
5525 * EVENT_SCAN_STARTED - Scan started
5526 *
5527 * This indicates that driver has started a scan operation either based
5528 * on a request from wpa_supplicant/hostapd or from another application.
5529 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
5530 * completed (either successfully or by getting cancelled).
5531 */
5532 EVENT_SCAN_STARTED,
5533
5534 /**
5535 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
5536 *
5537 * This event indicates a set of frequency ranges that should be avoided
5538 * to reduce issues due to interference or internal co-existence
5539 * information in the driver.
5540 */
5541 EVENT_AVOID_FREQUENCIES,
5542
5543 /**
5544 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
5545 */
5546 EVENT_NEW_PEER_CANDIDATE,
5547
5548 /**
5549 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
5550 *
5551 * Indicates a pair of primary and secondary channels chosen by ACS
5552 * in device.
5553 */
5554 EVENT_ACS_CHANNEL_SELECTED,
5555
5556 /**
5557 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
5558 * been started.
5559 *
5560 * This event indicates that channel availability check has been started
5561 * on a DFS frequency by a driver that supports DFS Offload.
5562 */
5563 EVENT_DFS_CAC_STARTED,
5564
5565 /**
5566 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
5567 */
5568 EVENT_P2P_LO_STOP,
5569
5570 /**
5571 * EVENT_BEACON_LOSS - Beacon loss detected
5572 *
5573 * This event indicates that no Beacon frames has been received from
5574 * the current AP. This may indicate that the AP is not anymore in
5575 * range.
5576 */
5577 EVENT_BEACON_LOSS,
5578
5579 /**
5580 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
5581 * done previously (Pre-CAC) on the channel has expired. This would
5582 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
5583 * channel will be moved from available to usable. A new CAC has to be
5584 * performed before start operating on this channel.
5585 */
5586 EVENT_DFS_PRE_CAC_EXPIRED,
5587
5588 /**
5589 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
5590 * that do not define separate commands for authentication and
5591 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
5592 * authentication to wpa_supplicant. This event carries all the
5593 * necessary information from the host driver for the authentication to
5594 * happen.
5595 */
5596 EVENT_EXTERNAL_AUTH,
5597
5598 /**
5599 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
5600 *
5601 * This event should be indicated when the driver completes the 4-way
5602 * handshake. This event should be preceded by an EVENT_ASSOC that
5603 * indicates the completion of IEEE 802.11 association.
5604 */
5605 EVENT_PORT_AUTHORIZED,
5606
5607 /**
5608 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
5609 * change event.
5610 */
5611 EVENT_STATION_OPMODE_CHANGED,
5612
5613 /**
5614 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
5615 *
5616 * This event is emitted when the MAC changes while the interface is
5617 * enabled. When an interface was disabled and becomes enabled, it
5618 * must be always assumed that the MAC possibly changed.
5619 */
5620 EVENT_INTERFACE_MAC_CHANGED,
5621
5622 /**
5623 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
5624 *
5625 * This event is emitted when an interface is added/removed for WDS STA.
5626 */
5627 EVENT_WDS_STA_INTERFACE_STATUS,
5628
5629 /**
5630 * EVENT_UPDATE_DH - Notification of updated DH information
5631 */
5632 EVENT_UPDATE_DH,
5633
5634 /**
5635 * EVENT_UNPROT_BEACON - Unprotected Beacon frame received
5636 *
5637 * This event should be called when a Beacon frame is dropped due to it
5638 * not being protected correctly. union wpa_event_data::unprot_beacon
5639 * is required to provide more details of the frame.
5640 */
5641 EVENT_UNPROT_BEACON,
5642
5643 /**
5644 * EVENT_TX_WAIT_EXPIRE - TX wait timed out
5645 *
5646 * This event is used to indicate when the driver has completed
5647 * wait for a response frame based on a TX request that specified a
5648 * non-zero wait time and that has not been explicitly cancelled.
5649 */
5650 EVENT_TX_WAIT_EXPIRE,
5651
5652 /**
5653 * EVENT_BSS_COLOR_COLLISION - Notification of a BSS color collision
5654 */
5655 EVENT_BSS_COLOR_COLLISION,
5656
5657 /**
5658 * EVENT_CCA_STARTED_NOTIFY - Notification that CCA has started
5659 */
5660 EVENT_CCA_STARTED_NOTIFY,
5661
5662 /**
5663 * EVENT_CCA_ABORTED_NOTIFY - Notification that CCA has aborted
5664 */
5665 EVENT_CCA_ABORTED_NOTIFY,
5666
5667 /**
5668 * EVENT_CCA_NOTIFY - Notification that CCA has completed
5669 */
5670 EVENT_CCA_NOTIFY,
5671
5672 /**
5673 * EVENT_PASN_AUTH - This event is used by the driver that requests
5674 * PASN authentication and secure ranging context for multiple peers.
5675 */
5676 EVENT_PASN_AUTH,
5677
5678 /**
5679 * EVENT_LINK_CH_SWITCH - MLD AP link decided to switch channels
5680 *
5681 * Described in wpa_event_data.ch_switch.
5682 *
5683 */
5684 EVENT_LINK_CH_SWITCH,
5685
5686 /**
5687 * EVENT_LINK_CH_SWITCH_STARTED - MLD AP link started to switch channels
5688 *
5689 * This is a pre-switch event indicating the shortly following switch
5690 * of operating channels.
5691 *
5692 * Described in wpa_event_data.ch_switch.
5693 */
5694 EVENT_LINK_CH_SWITCH_STARTED,
5695
5696 /**
5697 * EVENT_TID_LINK_MAP - MLD event to set TID-to-link mapping
5698 *
5699 * This event is used by the driver to indicate the received TID-to-link
5700 * mapping response from the associated AP MLD.
5701 *
5702 * Described in wpa_event_data.t2l_map_info.
5703 */
5704 EVENT_TID_LINK_MAP,
5705
5706 /**
5707 * EVENT_LINK_RECONFIG - Notification that AP links removed
5708 */
5709 EVENT_LINK_RECONFIG,
5710};
5711
5712
5713/**
5714 * struct freq_survey - Channel survey info
5715 *
5716 * @ifidx: Interface index in which this survey was observed
5717 * @freq: Center of frequency of the surveyed channel
5718 * @nf: Channel noise floor in dBm
5719 * @channel_time: Amount of time in ms the radio spent on the channel
5720 * @channel_time_busy: Amount of time in ms the radio detected some signal
5721 * that indicated to the radio the channel was not clear
5722 * @channel_time_rx: Amount of time the radio spent receiving data
5723 * @channel_time_tx: Amount of time the radio spent transmitting data
5724 * @filled: bitmask indicating which fields have been reported, see
5725 * SURVEY_HAS_* defines.
5726 * @list: Internal list pointers
5727 */
5728struct freq_survey {
5729 u32 ifidx;
5730 unsigned int freq;
5731 s8 nf;
5732 u64 channel_time;
5733 u64 channel_time_busy;
5734 u64 channel_time_rx;
5735 u64 channel_time_tx;
5736 unsigned int filled;
5737 struct dl_list list;
5738};
5739
5740#define SURVEY_HAS_NF BIT(0)
5741#define SURVEY_HAS_CHAN_TIME BIT(1)
5742#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
5743#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
5744#define SURVEY_HAS_CHAN_TIME_TX BIT(4)
5745
5746/**
5747 * enum sta_connect_fail_reason_codes - STA connect failure reason code values
5748 * @STA_CONNECT_FAIL_REASON_UNSPECIFIED: No reason code specified for
5749 * connection failure.
5750 * @STA_CONNECT_FAIL_REASON_NO_BSS_FOUND: No Probe Response frame received
5751 * for unicast Probe Request frame.
5752 * @STA_CONNECT_FAIL_REASON_AUTH_TX_FAIL: STA failed to send auth request.
5753 * @STA_CONNECT_FAIL_REASON_AUTH_NO_ACK_RECEIVED: AP didn't send ACK for
5754 * auth request.
5755 * @STA_CONNECT_FAIL_REASON_AUTH_NO_RESP_RECEIVED: Auth response is not
5756 * received from AP.
5757 * @STA_CONNECT_FAIL_REASON_ASSOC_REQ_TX_FAIL: STA failed to send
5758 * Association Request frame.
5759 * @STA_CONNECT_FAIL_REASON_ASSOC_NO_ACK_RECEIVED: AP didn't send ACK for
5760 * Association Request frame.
5761 * @STA_CONNECT_FAIL_REASON_ASSOC_NO_RESP_RECEIVED: Association Response
5762 * frame is not received from AP.
5763 */
5764enum sta_connect_fail_reason_codes {
5765 STA_CONNECT_FAIL_REASON_UNSPECIFIED = 0,
5766 STA_CONNECT_FAIL_REASON_NO_BSS_FOUND = 1,
5767 STA_CONNECT_FAIL_REASON_AUTH_TX_FAIL = 2,
5768 STA_CONNECT_FAIL_REASON_AUTH_NO_ACK_RECEIVED = 3,
5769 STA_CONNECT_FAIL_REASON_AUTH_NO_RESP_RECEIVED = 4,
5770 STA_CONNECT_FAIL_REASON_ASSOC_REQ_TX_FAIL = 5,
5771 STA_CONNECT_FAIL_REASON_ASSOC_NO_ACK_RECEIVED = 6,
5772 STA_CONNECT_FAIL_REASON_ASSOC_NO_RESP_RECEIVED = 7,
5773};
5774
5775/**
5776 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
5777 */
5778union wpa_event_data {
5779 /**
5780 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
5781 *
5782 * This structure is optional for EVENT_ASSOC calls and required for
5783 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
5784 * driver interface does not need to generate separate EVENT_ASSOCINFO
5785 * calls.
5786 */
5787 struct assoc_info {
5788 /**
5789 * reassoc - Flag to indicate association or reassociation
5790 */
5791 int reassoc;
5792
5793 /**
5794 * req_ies - (Re)Association Request IEs
5795 *
5796 * If the driver generates WPA/RSN IE, this event data must be
5797 * returned for WPA handshake to have needed information. If
5798 * wpa_supplicant-generated WPA/RSN IE is used, this
5799 * information event is optional.
5800 *
5801 * This should start with the first IE (fixed fields before IEs
5802 * are not included).
5803 */
5804 const u8 *req_ies;
5805
5806 /**
5807 * req_ies_len - Length of req_ies in bytes
5808 */
5809 size_t req_ies_len;
5810
5811 /**
5812 * resp_ies - (Re)Association Response IEs
5813 *
5814 * Optional association data from the driver. This data is not
5815 * required WPA, but may be useful for some protocols and as
5816 * such, should be reported if this is available to the driver
5817 * interface.
5818 *
5819 * This should start with the first IE (fixed fields before IEs
5820 * are not included).
5821 */
5822 const u8 *resp_ies;
5823
5824 /**
5825 * resp_ies_len - Length of resp_ies in bytes
5826 */
5827 size_t resp_ies_len;
5828
5829 /**
5830 * resp_frame - (Re)Association Response frame
5831 */
5832 const u8 *resp_frame;
5833
5834 /**
5835 * resp_frame_len - (Re)Association Response frame length
5836 */
5837 size_t resp_frame_len;
5838
5839 /**
5840 * beacon_ies - Beacon or Probe Response IEs
5841 *
5842 * Optional Beacon/ProbeResp data: IEs included in Beacon or
5843 * Probe Response frames from the current AP (i.e., the one
5844 * that the client just associated with). This information is
5845 * used to update WPA/RSN IE for the AP. If this field is not
5846 * set, the results from previous scan will be used. If no
5847 * data for the new AP is found, scan results will be requested
5848 * again (without scan request). At this point, the driver is
5849 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
5850 * used).
5851 *
5852 * This should start with the first IE (fixed fields before IEs
5853 * are not included).
5854 */
5855 const u8 *beacon_ies;
5856
5857 /**
5858 * beacon_ies_len - Length of beacon_ies */
5859 size_t beacon_ies_len;
5860
5861 /**
5862 * freq - Frequency of the operational channel in MHz
5863 */
5864 unsigned int freq;
5865
5866 /**
5867 * wmm_params - WMM parameters used in this association.
5868 */
5869 struct wmm_params wmm_params;
5870
5871 /**
5872 * addr - Station address (for AP mode)
5873 */
5874 const u8 *addr;
5875
5876 /**
5877 * The following is the key management offload information
5878 * @authorized
5879 * @key_replay_ctr
5880 * @key_replay_ctr_len
5881 * @ptk_kck
5882 * @ptk_kek_len
5883 * @ptk_kek
5884 * @ptk_kek_len
5885 */
5886
5887 /**
5888 * authorized - Status of key management offload,
5889 * 1 = successful
5890 */
5891 int authorized;
5892
5893 /**
5894 * key_replay_ctr - Key replay counter value last used
5895 * in a valid EAPOL-Key frame
5896 */
5897 const u8 *key_replay_ctr;
5898
5899 /**
5900 * key_replay_ctr_len - The length of key_replay_ctr
5901 */
5902 size_t key_replay_ctr_len;
5903
5904 /**
5905 * ptk_kck - The derived PTK KCK
5906 */
5907 const u8 *ptk_kck;
5908
5909 /**
5910 * ptk_kek_len - The length of ptk_kck
5911 */
5912 size_t ptk_kck_len;
5913
5914 /**
5915 * ptk_kek - The derived PTK KEK
5916 * This is used in key management offload and also in FILS SK
5917 * offload.
5918 */
5919 const u8 *ptk_kek;
5920
5921 /**
5922 * ptk_kek_len - The length of ptk_kek
5923 */
5924 size_t ptk_kek_len;
5925
5926 /**
5927 * subnet_status - The subnet status:
5928 * 0 = unknown, 1 = unchanged, 2 = changed
5929 */
5930 u8 subnet_status;
5931
5932 /**
5933 * The following information is used in FILS SK offload
5934 * @fils_erp_next_seq_num
5935 * @fils_pmk
5936 * @fils_pmk_len
5937 * @fils_pmkid
5938 */
5939
5940 /**
5941 * fils_erp_next_seq_num - The next sequence number to use in
5942 * FILS ERP messages
5943 */
5944 u16 fils_erp_next_seq_num;
5945
5946 /**
5947 * fils_pmk - A new PMK if generated in case of FILS
5948 * authentication
5949 */
5950 const u8 *fils_pmk;
5951
5952 /**
5953 * fils_pmk_len - Length of fils_pmk
5954 */
5955 size_t fils_pmk_len;
5956
5957 /**
5958 * fils_pmkid - PMKID used or generated in FILS authentication
5959 */
5960 const u8 *fils_pmkid;
5961 } assoc_info;
5962
5963 /**
5964 * struct disassoc_info - Data for EVENT_DISASSOC events
5965 */
5966 struct disassoc_info {
5967 /**
5968 * addr - Station address (for AP mode)
5969 */
5970 const u8 *addr;
5971
5972 /**
5973 * reason_code - Reason Code (host byte order) used in
5974 * Deauthentication frame
5975 */
5976 u16 reason_code;
5977
5978 /**
5979 * ie - Optional IE(s) in Disassociation frame
5980 */
5981 const u8 *ie;
5982
5983 /**
5984 * ie_len - Length of ie buffer in octets
5985 */
5986 size_t ie_len;
5987
5988 /**
5989 * locally_generated - Whether the frame was locally generated
5990 */
5991 int locally_generated;
5992 } disassoc_info;
5993
5994 /**
5995 * struct deauth_info - Data for EVENT_DEAUTH events
5996 */
5997 struct deauth_info {
5998 /**
5999 * addr - Station address (for AP mode)
6000 */
6001 const u8 *addr;
6002
6003 /**
6004 * reason_code - Reason Code (host byte order) used in
6005 * Deauthentication frame
6006 */
6007 u16 reason_code;
6008
6009 /**
6010 * ie - Optional IE(s) in Deauthentication frame
6011 */
6012 const u8 *ie;
6013
6014 /**
6015 * ie_len - Length of ie buffer in octets
6016 */
6017 size_t ie_len;
6018
6019 /**
6020 * locally_generated - Whether the frame was locally generated
6021 */
6022 int locally_generated;
6023 } deauth_info;
6024
6025 /**
6026 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
6027 */
6028 struct michael_mic_failure {
6029 int unicast;
6030 const u8 *src;
6031 } michael_mic_failure;
6032
6033 /**
6034 * struct interface_status - Data for EVENT_INTERFACE_STATUS
6035 */
6036 struct interface_status {
6037 unsigned int ifindex;
6038 char ifname[100];
6039 enum {
6040 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
6041 } ievent;
6042 } interface_status;
6043
6044 /**
6045 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
6046 */
6047 struct pmkid_candidate {
6048 /** BSSID of the PMKID candidate */
6049 u8 bssid[ETH_ALEN];
6050 /** Smaller the index, higher the priority */
6051 int index;
6052 /** Whether RSN IE includes pre-authenticate flag */
6053 int preauth;
6054 } pmkid_candidate;
6055
6056 /**
6057 * struct tdls - Data for EVENT_TDLS
6058 */
6059 struct tdls {
6060 u8 peer[ETH_ALEN];
6061 enum {
6062 TDLS_REQUEST_SETUP,
6063 TDLS_REQUEST_TEARDOWN,
6064 TDLS_REQUEST_DISCOVER,
6065 } oper;
6066 u16 reason_code; /* for teardown */
6067 } tdls;
6068
6069 /**
6070 * struct wnm - Data for EVENT_WNM
6071 */
6072 struct wnm {
6073 u8 addr[ETH_ALEN];
6074 enum {
6075 WNM_OPER_SLEEP,
6076 } oper;
6077 enum {
6078 WNM_SLEEP_ENTER,
6079 WNM_SLEEP_EXIT
6080 } sleep_action;
6081 int sleep_intval;
6082 u16 reason_code;
6083 u8 *buf;
6084 u16 buf_len;
6085 } wnm;
6086
6087 /**
6088 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
6089 *
6090 * During FT (IEEE 802.11r) authentication sequence, the driver is
6091 * expected to use this event to report received FT IEs (MDIE, FTIE,
6092 * RSN IE, TIE, possible resource request) to the supplicant. The FT
6093 * IEs for the next message will be delivered through the
6094 * struct wpa_driver_ops::update_ft_ies() callback.
6095 */
6096 struct ft_ies {
6097 const u8 *ies;
6098 size_t ies_len;
6099 int ft_action;
6100 u8 target_ap[ETH_ALEN];
6101 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
6102 const u8 *ric_ies;
6103 /** Length of ric_ies buffer in octets */
6104 size_t ric_ies_len;
6105 } ft_ies;
6106
6107 /**
6108 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
6109 */
6110 struct ibss_rsn_start {
6111 u8 peer[ETH_ALEN];
6112 } ibss_rsn_start;
6113
6114 /**
6115 * struct auth_info - Data for EVENT_AUTH events
6116 */
6117 struct auth_info {
6118 u8 peer[ETH_ALEN];
6119 u8 bssid[ETH_ALEN];
6120 u16 auth_type;
6121 u16 auth_transaction;
6122 u16 status_code;
6123 const u8 *ies;
6124 size_t ies_len;
6125 } auth;
6126
6127 /**
6128 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
6129 */
6130 struct assoc_reject {
6131 /**
6132 * bssid - BSSID of the AP that rejected association
6133 */
6134 const u8 *bssid;
6135
6136 /**
6137 * resp_ies - (Re)Association Response IEs
6138 *
6139 * Optional association data from the driver. This data is not
6140 * required WPA, but may be useful for some protocols and as
6141 * such, should be reported if this is available to the driver
6142 * interface.
6143 *
6144 * This should start with the first IE (fixed fields before IEs
6145 * are not included).
6146 */
6147 const u8 *resp_ies;
6148
6149 /**
6150 * resp_ies_len - Length of resp_ies in bytes
6151 */
6152 size_t resp_ies_len;
6153
6154 /**
6155 * status_code - Status Code from (Re)association Response
6156 */
6157 u16 status_code;
6158
6159 /**
6160 * timed_out - Whether failure is due to timeout (etc.) rather
6161 * than explicit rejection response from the AP.
6162 */
6163 int timed_out;
6164
6165 /**
6166 * timeout_reason - Reason for the timeout
6167 */
6168 const char *timeout_reason;
6169
6170 /**
6171 * fils_erp_next_seq_num - The next sequence number to use in
6172 * FILS ERP messages
6173 */
6174 u16 fils_erp_next_seq_num;
6175
6176 /**
6177 * reason_code - Connection failure reason code from the driver
6178 */
6179 enum sta_connect_fail_reason_codes reason_code;
6180 } assoc_reject;
6181
6182 struct timeout_event {
6183 u8 addr[ETH_ALEN];
6184 } timeout_event;
6185
6186 /**
6187 * struct tx_status - Data for EVENT_TX_STATUS events
6188 */
6189 struct tx_status {
6190 u16 type;
6191 u16 stype;
6192 const u8 *dst;
6193 const u8 *data;
6194 size_t data_len;
6195 int ack;
6196 int link_id;
6197 } tx_status;
6198
6199 /**
6200 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
6201 */
6202 struct rx_from_unknown {
6203 const u8 *bssid;
6204 const u8 *addr;
6205 int wds;
6206 } rx_from_unknown;
6207
6208 /**
6209 * struct rx_mgmt - Data for EVENT_RX_MGMT events
6210 */
6211 struct rx_mgmt {
6212 const u8 *frame;
6213 size_t frame_len;
6214 u32 datarate;
6215
6216 /**
6217 * drv_priv - Pointer to store driver private BSS information
6218 *
6219 * If not set to NULL, this is used for comparison with
6220 * hostapd_data->drv_priv to determine which BSS should process
6221 * the frame.
6222 */
6223 void *drv_priv;
6224
6225 /**
6226 * freq - Frequency (in MHz) on which the frame was received
6227 */
6228 int freq;
6229
6230 /**
6231 * ssi_signal - Signal strength in dBm (or 0 if not available)
6232 */
6233 int ssi_signal;
6234
6235 /**
6236 * link_id - MLO link on which the frame was received or -1 for
6237 * non MLD.
6238 */
6239 int link_id;
6240 } rx_mgmt;
6241
6242 /**
6243 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
6244 *
6245 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
6246 */
6247 struct remain_on_channel {
6248 /**
6249 * freq - Channel frequency in MHz
6250 */
6251 unsigned int freq;
6252
6253 /**
6254 * duration - Duration to remain on the channel in milliseconds
6255 */
6256 unsigned int duration;
6257 } remain_on_channel;
6258
6259 /**
6260 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
6261 * @aborted: Whether the scan was aborted
6262 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
6263 * @num_freqs: Number of entries in freqs array
6264 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
6265 * SSID)
6266 * @num_ssids: Number of entries in ssids array
6267 * @external_scan: Whether the scan info is for an external scan
6268 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
6269 * 0 if the source of the scan event is a vendor scan
6270 * @scan_start_tsf: Time when the scan started in terms of TSF of the
6271 * BSS that the interface that requested the scan is connected to
6272 * (if available).
6273 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
6274 * is set.
6275 */
6276 struct scan_info {
6277 int aborted;
6278 const int *freqs;
6279 size_t num_freqs;
6280 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
6281 size_t num_ssids;
6282 int external_scan;
6283 int nl_scan_event;
6284 u64 scan_start_tsf;
6285 u8 scan_start_tsf_bssid[ETH_ALEN];
6286 } scan_info;
6287
6288 /**
6289 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
6290 */
6291 struct rx_probe_req {
6292 /**
6293 * sa - Source address of the received Probe Request frame
6294 */
6295 const u8 *sa;
6296
6297 /**
6298 * da - Destination address of the received Probe Request frame
6299 * or %NULL if not available
6300 */
6301 const u8 *da;
6302
6303 /**
6304 * bssid - BSSID of the received Probe Request frame or %NULL
6305 * if not available
6306 */
6307 const u8 *bssid;
6308
6309 /**
6310 * ie - IEs from the Probe Request body
6311 */
6312 const u8 *ie;
6313
6314 /**
6315 * ie_len - Length of ie buffer in octets
6316 */
6317 size_t ie_len;
6318
6319 /**
6320 * signal - signal strength in dBm (or 0 if not available)
6321 */
6322 int ssi_signal;
6323 } rx_probe_req;
6324
6325 /**
6326 * struct new_sta - Data for EVENT_NEW_STA events
6327 */
6328 struct new_sta {
6329 const u8 *addr;
6330 } new_sta;
6331
6332 /**
6333 * struct eapol_rx - Data for EVENT_EAPOL_RX events
6334 */
6335 struct eapol_rx {
6336 const u8 *src;
6337 const u8 *data;
6338 size_t data_len;
6339 enum frame_encryption encrypted;
6340 int link_id;
6341 } eapol_rx;
6342
6343 /**
6344 * signal_change - Data for EVENT_SIGNAL_CHANGE events
6345 */
6346 struct wpa_signal_info signal_change;
6347
6348 /**
6349 * struct best_channel - Data for EVENT_BEST_CHANNEL events
6350 * @freq_24: Best 2.4 GHz band channel frequency in MHz
6351 * @freq_5: Best 5 GHz band channel frequency in MHz
6352 * @freq_overall: Best channel frequency in MHz
6353 *
6354 * 0 can be used to indicate no preference in either band.
6355 */
6356 struct best_channel {
6357 int freq_24;
6358 int freq_5;
6359 int freq_overall;
6360 } best_chan;
6361
6362 struct unprot_deauth {
6363 const u8 *sa;
6364 const u8 *da;
6365 u16 reason_code;
6366 } unprot_deauth;
6367
6368 struct unprot_disassoc {
6369 const u8 *sa;
6370 const u8 *da;
6371 u16 reason_code;
6372 } unprot_disassoc;
6373
6374 /**
6375 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
6376 * @addr: station address
6377 * @num_packets: Number of packets lost (consecutive packets not
6378 * acknowledged)
6379 */
6380 struct low_ack {
6381 u8 addr[ETH_ALEN];
6382 u32 num_packets;
6383 } low_ack;
6384
6385 /**
6386 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
6387 */
6388 struct ibss_peer_lost {
6389 u8 peer[ETH_ALEN];
6390 } ibss_peer_lost;
6391
6392 /**
6393 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
6394 */
6395 struct driver_gtk_rekey {
6396 const u8 *bssid;
6397 const u8 *replay_ctr;
6398 } driver_gtk_rekey;
6399
6400 /**
6401 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
6402 * @addr: station address
6403 */
6404 struct client_poll {
6405 u8 addr[ETH_ALEN];
6406 } client_poll;
6407
6408 /**
6409 * struct eapol_tx_status
6410 * @dst: Original destination
6411 * @data: Data starting with IEEE 802.1X header (!)
6412 * @data_len: Length of data
6413 * @ack: Indicates ack or lost frame
6414 * @link_id: MLD link id used to transmit the frame or -1 for non MLO
6415 *
6416 * This corresponds to hapd_send_eapol if the frame sent
6417 * there isn't just reported as EVENT_TX_STATUS.
6418 */
6419 struct eapol_tx_status {
6420 const u8 *dst;
6421 const u8 *data;
6422 int data_len;
6423 int ack;
6424 int link_id;
6425 } eapol_tx_status;
6426
6427 /**
6428 * struct ch_switch
6429 * @count: Count until channel switch activates
6430 * @freq: Frequency of new channel in MHz
6431 * @ht_enabled: Whether this is an HT channel
6432 * @ch_offset: Secondary channel offset
6433 * @ch_width: Channel width
6434 * @cf1: Center frequency 1
6435 * @cf2: Center frequency 2
6436 * @link_id: Link ID of the MLO link
6437 * @punct_bitmap: Puncturing bitmap
6438 */
6439 struct ch_switch {
6440 int count;
6441 int freq;
6442 int ht_enabled;
6443 int ch_offset;
6444 enum chan_width ch_width;
6445 int cf1;
6446 int cf2;
6447 int link_id;
6448 u16 punct_bitmap;
6449 } ch_switch;
6450
6451 /**
6452 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
6453 * @addr: Remote client address
6454 * @code: Reason code for connection failure
6455 */
6456 struct connect_failed_reason {
6457 u8 addr[ETH_ALEN];
6458 enum {
6459 MAX_CLIENT_REACHED,
6460 BLOCKED_CLIENT
6461 } code;
6462 } connect_failed_reason;
6463
6464 /**
6465 * struct dfs_event - Data for radar detected events
6466 * @freq: Frequency of the channel in MHz
6467 */
6468 struct dfs_event {
6469 int freq;
6470 int ht_enabled;
6471 int chan_offset;
6472 enum chan_width chan_width;
6473 int cf1;
6474 int cf2;
6475 } dfs_event;
6476
6477 /**
6478 * survey_results - Survey result data for EVENT_SURVEY
6479 * @freq_filter: Requested frequency survey filter, 0 if request
6480 * was for all survey data
6481 * @survey_list: Linked list of survey data (struct freq_survey)
6482 */
6483 struct survey_results {
6484 unsigned int freq_filter;
6485 struct dl_list survey_list; /* struct freq_survey */
6486 } survey_results;
6487
6488 /**
6489 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
6490 * @initiator: Initiator of the regulatory change
6491 * @type: Regulatory change type
6492 * @alpha2: Country code (or "" if not available)
6493 */
6494 struct channel_list_changed {
6495 enum reg_change_initiator initiator;
6496 enum reg_type type;
6497 char alpha2[3];
6498 } channel_list_changed;
6499
6500 /**
6501 * freq_range - List of frequency ranges
6502 *
6503 * This is used as the data with EVENT_AVOID_FREQUENCIES.
6504 */
6505 struct wpa_freq_range_list freq_range;
6506
6507 /**
6508 * struct mesh_peer
6509 *
6510 * @peer: Peer address
6511 * @ies: Beacon IEs
6512 * @ie_len: Length of @ies
6513 *
6514 * Notification of new candidate mesh peer.
6515 */
6516 struct mesh_peer {
6517 const u8 *peer;
6518 const u8 *ies;
6519 size_t ie_len;
6520 } mesh_peer;
6521
6522 /**
6523 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
6524 * @pri_freq: Selected primary frequency
6525 * @sec_freq: Selected secondary frequency
6526 * @edmg_channel: Selected EDMG channel
6527 * @vht_seg0_center_ch: VHT mode Segment0 center channel
6528 * The value is the index of the channel center frequency for
6529 * 20 MHz, 40 MHz, and 80 MHz channels. The value is the center
6530 * frequency index of the primary 80 MHz segment for 160 MHz and
6531 * 80+80 MHz channels.
6532 * @vht_seg1_center_ch: VHT mode Segment1 center channel
6533 * The value is zero for 20 MHz, 40 MHz, and 80 MHz channels. The
6534 * value is the index of the channel center frequency for 160 MHz
6535 * channels and the center frequency index of the secondary 80 MHz
6536 * segment for 80+80 MHz channels.
6537 * @ch_width: Selected Channel width by driver. Driver may choose to
6538 * change hostapd configured ACS channel width due driver internal
6539 * channel restrictions.
6540 * hw_mode: Selected band (used with hw_mode=any)
6541 */
6542 struct acs_selected_channels {
6543 unsigned int pri_freq;
6544 unsigned int sec_freq;
6545 u8 edmg_channel;
6546 u8 vht_seg0_center_ch;
6547 u8 vht_seg1_center_ch;
6548 u16 ch_width;
6549 enum hostapd_hw_mode hw_mode;
6550 u16 puncture_bitmap;
6551 } acs_selected_channels;
6552
6553 /**
6554 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
6555 * @reason_code: Reason for stopping offload
6556 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
6557 * scheduled.
6558 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
6559 * be stopped.
6560 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
6561 * parameters.
6562 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
6563 * supported by device.
6564 */
6565 struct p2p_lo_stop {
6566 enum {
6567 P2P_LO_STOPPED_REASON_COMPLETE = 0,
6568 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
6569 P2P_LO_STOPPED_REASON_INVALID_PARAM,
6570 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
6571 } reason_code;
6572 } p2p_lo_stop;
6573
6574 /* For EVENT_EXTERNAL_AUTH */
6575 struct external_auth external_auth;
6576
6577 /**
6578 * struct sta_opmode - Station's operation mode change event
6579 * @addr: The station MAC address
6580 * @smps_mode: SMPS mode of the station
6581 * @chan_width: Channel width of the station
6582 * @rx_nss: RX_NSS of the station
6583 *
6584 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
6585 */
6586 struct sta_opmode {
6587 const u8 *addr;
6588 enum smps_mode smps_mode;
6589 enum chan_width chan_width;
6590 u8 rx_nss;
6591 } sta_opmode;
6592
6593 /**
6594 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
6595 */
6596 struct wds_sta_interface {
6597 const u8 *sta_addr;
6598 const char *ifname;
6599 enum {
6600 INTERFACE_ADDED,
6601 INTERFACE_REMOVED
6602 } istatus;
6603 } wds_sta_interface;
6604
6605 /**
6606 * struct update_dh - Data for EVENT_UPDATE_DH
6607 */
6608 struct update_dh {
6609 const u8 *peer;
6610 const u8 *ie;
6611 size_t ie_len;
6612 } update_dh;
6613
6614 /**
6615 * struct unprot_beacon - Data for EVENT_UNPROT_BEACON
6616 */
6617 struct unprot_beacon {
6618 const u8 *sa;
6619 } unprot_beacon;
6620
6621 /**
6622 * struct bss_color_collision - Data for EVENT_BSS_COLOR_COLLISION
6623 */
6624 struct bss_color_collision {
6625 u64 bitmap;
6626 } bss_color_collision;
6627
6628 /**
6629 * struct pasn_auth - Data for EVENT_PASN_AUTH
6630 */
6631 struct pasn_auth pasn_auth;
6632
6633 /**
6634 * struct port_authorized - Data for EVENT_PORT_AUTHORIZED
6635 */
6636 struct port_authorized {
6637 const u8 *td_bitmap;
6638 size_t td_bitmap_len;
6639 } port_authorized;
6640
6641 /**
6642 * struct tid_link_map_info - Data for EVENT_TID_LINK_MAP
6643 */
6644 struct tid_link_map_info {
6645 bool default_map;
6646 u8 valid_links;
6647 struct t2lm_mapping t2lmap[MAX_NUM_MLD_LINKS];
6648 } t2l_map_info;
6649};
6650
6651/**
6652 * wpa_supplicant_event - Report a driver event for wpa_supplicant
6653 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
6654 * with struct wpa_driver_ops::init()
6655 * @event: event type (defined above)
6656 * @data: possible extra data for the event
6657 *
6658 * Driver wrapper code should call this function whenever an event is received
6659 * from the driver.
6660 */
6661extern void (*wpa_supplicant_event)(void *ctx, enum wpa_event_type event,
6662 union wpa_event_data *data);
6663
6664/**
6665 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
6666 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
6667 * with struct wpa_driver_ops::init()
6668 * @event: event type (defined above)
6669 * @data: possible extra data for the event
6670 *
6671 * Same as wpa_supplicant_event(), but we search for the interface in
6672 * wpa_global.
6673 */
6674extern void (*wpa_supplicant_event_global)(void *ctx, enum wpa_event_type event,
6675 union wpa_event_data *data);
6676
6677/*
6678 * The following inline functions are provided for convenience to simplify
6679 * event indication for some of the common events.
6680 */
6681
6682static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
6683 size_t ielen, int reassoc)
6684{
6685 union wpa_event_data event;
6686 os_memset(&event, 0, sizeof(event));
6687 event.assoc_info.reassoc = reassoc;
6688 event.assoc_info.req_ies = ie;
6689 event.assoc_info.req_ies_len = ielen;
6690 event.assoc_info.addr = addr;
6691 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
6692}
6693
6694static inline void drv_event_disassoc(void *ctx, const u8 *addr)
6695{
6696 union wpa_event_data event;
6697 os_memset(&event, 0, sizeof(event));
6698 event.disassoc_info.addr = addr;
6699 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
6700}
6701
6702static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
6703 size_t data_len)
6704{
6705 union wpa_event_data event;
6706 os_memset(&event, 0, sizeof(event));
6707 event.eapol_rx.src = src;
6708 event.eapol_rx.data = data;
6709 event.eapol_rx.data_len = data_len;
6710 event.eapol_rx.encrypted = FRAME_ENCRYPTION_UNKNOWN;
6711 event.eapol_rx.link_id = -1;
6712 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
6713}
6714
6715static inline void drv_event_eapol_rx2(void *ctx, const u8 *src, const u8 *data,
6716 size_t data_len,
6717 enum frame_encryption encrypted,
6718 int link_id)
6719{
6720 union wpa_event_data event;
6721 os_memset(&event, 0, sizeof(event));
6722 event.eapol_rx.src = src;
6723 event.eapol_rx.data = data;
6724 event.eapol_rx.data_len = data_len;
6725 event.eapol_rx.encrypted = encrypted;
6726 event.eapol_rx.link_id = link_id;
6727 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
6728}
6729
6730/* driver_common.c */
6731void wpa_scan_results_free(struct wpa_scan_results *res);
6732
6733/* Convert wpa_event_type to a string for logging */
6734const char * event_to_string(enum wpa_event_type event);
6735
6736/* Convert chan_width to a string for logging and control interfaces */
6737const char * channel_width_to_string(enum chan_width width);
6738
6739int channel_width_to_int(enum chan_width width);
6740
6741int ht_supported(const struct hostapd_hw_modes *mode);
6742int vht_supported(const struct hostapd_hw_modes *mode);
6743bool he_supported(const struct hostapd_hw_modes *hw_mode,
6744 enum ieee80211_op_mode op_mode);
6745
6746struct wowlan_triggers *
6747wpa_get_wowlan_triggers(const char *wowlan_triggers,
6748 const struct wpa_driver_capa *capa);
6749/* Convert driver flag to string */
6750const char * driver_flag_to_string(u64 flag);
6751const char * driver_flag2_to_string(u64 flag2);
6752
6753/* NULL terminated array of linked in driver wrappers */
6754extern const struct wpa_driver_ops *const wpa_drivers[];
6755
6756
6757/* Available drivers */
6758
6759#ifdef CONFIG_DRIVER_WEXT
6760extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
6761#endif /* CONFIG_DRIVER_WEXT */
6762#ifdef CONFIG_DRIVER_NL80211
6763/* driver_nl80211.c */
6764extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
6765#endif /* CONFIG_DRIVER_NL80211 */
6766#ifdef CONFIG_DRIVER_HOSTAP
6767extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
6768#endif /* CONFIG_DRIVER_HOSTAP */
6769#ifdef CONFIG_DRIVER_BSD
6770extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
6771#endif /* CONFIG_DRIVER_BSD */
6772#ifdef CONFIG_DRIVER_OPENBSD
6773/* driver_openbsd.c */
6774extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
6775#endif /* CONFIG_DRIVER_OPENBSD */
6776#ifdef CONFIG_DRIVER_NDIS
6777extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
6778#endif /* CONFIG_DRIVER_NDIS */
6779#ifdef CONFIG_DRIVER_WIRED
6780extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
6781#endif /* CONFIG_DRIVER_WIRED */
6782#ifdef CONFIG_DRIVER_MACSEC_QCA
6783/* driver_macsec_qca.c */
6784extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
6785#endif /* CONFIG_DRIVER_MACSEC_QCA */
6786#ifdef CONFIG_DRIVER_MACSEC_LINUX
6787/* driver_macsec_linux.c */
6788extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops;
6789#endif /* CONFIG_DRIVER_MACSEC_LINUX */
6790#ifdef CONFIG_DRIVER_ROBOSWITCH
6791/* driver_roboswitch.c */
6792extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
6793#endif /* CONFIG_DRIVER_ROBOSWITCH */
6794#ifdef CONFIG_DRIVER_ATHEROS
6795/* driver_atheros.c */
6796extern const struct wpa_driver_ops wpa_driver_atheros_ops;
6797#endif /* CONFIG_DRIVER_ATHEROS */
6798#ifdef CONFIG_DRIVER_NONE
6799extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
6800#endif /* CONFIG_DRIVER_NONE */
6801
6802#endif /* DRIVER_H */