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