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