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