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