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