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