]> git.ipfire.org Git - thirdparty/hostap.git/blob - src/drivers/driver.h
nl80211: Check if driver supports OCE specific features
[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 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1442 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1443 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1444 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
1445 /** Bitfield of supported key management suites */
1446 unsigned int key_mgmt;
1447
1448 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1449 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1450 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1451 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1452 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1453 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1454 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1455 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1456 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1457 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1458 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1459 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1460 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1461 /** Bitfield of supported cipher suites */
1462 unsigned int enc;
1463
1464 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1465 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1466 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1467 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1468 unsigned int auth;
1469
1470 /** Driver generated WPA/RSN IE */
1471 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1472 /** Driver needs static WEP key setup after association command */
1473 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1474 /** Driver takes care of all DFS operations */
1475 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1476 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1477 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1478 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1479 /** Driver is for a wired Ethernet interface */
1480 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1481 /** Driver provides separate commands for authentication and association (SME in
1482 * wpa_supplicant). */
1483 #define WPA_DRIVER_FLAGS_SME 0x00000020
1484 /** Driver supports AP mode */
1485 #define WPA_DRIVER_FLAGS_AP 0x00000040
1486 /** Driver needs static WEP key setup after association has been completed */
1487 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1488 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1489 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1490 /** Driver supports concurrent P2P operations */
1491 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1492 /**
1493 * Driver uses the initial interface as a dedicated management interface, i.e.,
1494 * it cannot be used for P2P group operations or non-P2P purposes.
1495 */
1496 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1497 /** This interface is P2P capable (P2P GO or P2P Client) */
1498 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1499 /** Driver supports station and key removal when stopping an AP */
1500 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1501 /**
1502 * Driver uses the initial interface for P2P management interface and non-P2P
1503 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1504 * P2P group operations.
1505 */
1506 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1507 /**
1508 * Driver is known to use sane error codes, i.e., when it indicates that
1509 * something (e.g., association) fails, there was indeed a failure and the
1510 * operation does not end up getting completed successfully later.
1511 */
1512 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1513 /** Driver supports off-channel TX */
1514 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1515 /** Driver indicates TX status events for EAPOL Data frames */
1516 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1517 /** Driver indicates TX status events for Deauth/Disassoc frames */
1518 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1519 /** Driver supports roaming (BSS selection) in firmware */
1520 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1521 /** Driver supports operating as a TDLS peer */
1522 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1523 /** Driver requires external TDLS setup/teardown/discovery */
1524 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1525 /** Driver indicates support for Probe Response offloading in AP mode */
1526 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1527 /** Driver supports U-APSD in AP mode */
1528 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1529 /** Driver supports inactivity timer in AP mode */
1530 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1531 /** Driver expects user space implementation of MLME in AP mode */
1532 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1533 /** Driver supports SAE with user space SME */
1534 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1535 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1536 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1537 /** Driver supports IBSS (Ad-hoc) mode */
1538 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1539 /** Driver supports radar detection */
1540 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1541 /** Driver supports a dedicated interface for P2P Device */
1542 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1543 /** Driver supports QoS Mapping */
1544 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1545 /** Driver supports CSA in AP mode */
1546 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1547 /** Driver supports mesh */
1548 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1549 /** Driver support ACS offload */
1550 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1551 /** Driver supports key management offload */
1552 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1553 /** Driver supports TDLS channel switching */
1554 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1555 /** Driver supports IBSS with HT datarates */
1556 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
1557 /** Driver supports IBSS with VHT datarates */
1558 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
1559 /** Driver supports automatic band selection */
1560 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
1561 /** Driver supports simultaneous off-channel operations */
1562 #define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
1563 /** Driver supports full AP client state */
1564 #define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
1565 /** Driver supports P2P Listen offload */
1566 #define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
1567 /** Driver supports FILS */
1568 #define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
1569 /** Driver supports Beacon frame TX rate configuration (legacy rates) */
1570 #define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1571 /** Driver supports Beacon frame TX rate configuration (HT rates) */
1572 #define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1573 /** Driver supports Beacon frame TX rate configuration (VHT rates) */
1574 #define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
1575 /** Driver supports mgmt_tx with random TX address in non-connected state */
1576 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
1577 /** Driver supports mgmt_tx with random TX addr in connected state */
1578 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
1579 /** Driver supports better BSS reporting with sched_scan in connected mode */
1580 #define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
1581 /** Driver supports HE capabilities */
1582 #define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
1583 /** Driver supports FILS shared key offload */
1584 #define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
1585 /** Driver supports all OCE STA specific mandatory features */
1586 #define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
1587 /** Driver supports all OCE AP specific mandatory features */
1588 #define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
1589 /**
1590 * Driver supports all OCE STA-CFON specific mandatory features only.
1591 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
1592 * userspace shall assume that this driver may not support all OCE AP
1593 * functionality but can support only OCE STA-CFON functionality.
1594 */
1595 #define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
1596 u64 flags;
1597
1598 #define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1599 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1600
1601 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1602 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1603 unsigned int smps_modes;
1604
1605 unsigned int wmm_ac_supported:1;
1606
1607 unsigned int mac_addr_rand_scan_supported:1;
1608 unsigned int mac_addr_rand_sched_scan_supported:1;
1609
1610 /** Maximum number of supported active probe SSIDs */
1611 int max_scan_ssids;
1612
1613 /** Maximum number of supported active probe SSIDs for sched_scan */
1614 int max_sched_scan_ssids;
1615
1616 /** Maximum number of supported scan plans for scheduled scan */
1617 unsigned int max_sched_scan_plans;
1618
1619 /** Maximum interval in a scan plan. In seconds */
1620 u32 max_sched_scan_plan_interval;
1621
1622 /** Maximum number of iterations in a single scan plan */
1623 u32 max_sched_scan_plan_iterations;
1624
1625 /** Whether sched_scan (offloaded scanning) is supported */
1626 int sched_scan_supported;
1627
1628 /** Maximum number of supported match sets for sched_scan */
1629 int max_match_sets;
1630
1631 /**
1632 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1633 */
1634 unsigned int max_remain_on_chan;
1635
1636 /**
1637 * max_stations - Maximum number of associated stations the driver
1638 * supports in AP mode
1639 */
1640 unsigned int max_stations;
1641
1642 /**
1643 * probe_resp_offloads - Bitmap of supported protocols by the driver
1644 * for Probe Response offloading.
1645 */
1646 /** Driver Probe Response offloading support for WPS ver. 1 */
1647 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1648 /** Driver Probe Response offloading support for WPS ver. 2 */
1649 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1650 /** Driver Probe Response offloading support for P2P */
1651 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1652 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1653 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1654 unsigned int probe_resp_offloads;
1655
1656 unsigned int max_acl_mac_addrs;
1657
1658 /**
1659 * Number of supported concurrent channels
1660 */
1661 unsigned int num_multichan_concurrent;
1662
1663 /**
1664 * extended_capa - extended capabilities in driver/device
1665 *
1666 * Must be allocated and freed by driver and the pointers must be
1667 * valid for the lifetime of the driver, i.e., freed in deinit()
1668 */
1669 const u8 *extended_capa, *extended_capa_mask;
1670 unsigned int extended_capa_len;
1671
1672 struct wowlan_triggers wowlan_triggers;
1673
1674 /** Driver adds the DS Params Set IE in Probe Request frames */
1675 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1676 /** Driver adds the WFA TPC IE in Probe Request frames */
1677 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1678 /** Driver handles quiet period requests */
1679 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1680 /**
1681 * Driver is capable of inserting the current TX power value into the body of
1682 * transmitted frames.
1683 * Background: Some Action frames include a TPC Report IE. This IE contains a
1684 * TX power field, which has to be updated by lower layers. One such Action
1685 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1686 * of spectrum management). Note that this insertion takes place at a fixed
1687 * offset, namely the 6th byte in the Action frame body.
1688 */
1689 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1690 /**
1691 * Driver supports RRM. With this support, the driver will accept to use RRM in
1692 * (Re)Association Request frames, without supporting quiet period.
1693 */
1694 #define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1695
1696 /** Driver supports setting the scan dwell time */
1697 #define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
1698 /** Driver supports Beacon Report Measurement */
1699 #define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
1700
1701 u32 rrm_flags;
1702
1703 /* Driver concurrency capabilities */
1704 unsigned int conc_capab;
1705 /* Maximum number of concurrent channels on 2.4 GHz */
1706 unsigned int max_conc_chan_2_4;
1707 /* Maximum number of concurrent channels on 5 GHz */
1708 unsigned int max_conc_chan_5_0;
1709
1710 /* Maximum number of supported CSA counters */
1711 u16 max_csa_counters;
1712 };
1713
1714
1715 struct hostapd_data;
1716
1717 struct hostap_sta_driver_data {
1718 unsigned long rx_packets, tx_packets;
1719 unsigned long long rx_bytes, tx_bytes;
1720 int bytes_64bit; /* whether 64-bit byte counters are supported */
1721 unsigned long current_tx_rate;
1722 unsigned long inactive_msec;
1723 unsigned long flags;
1724 unsigned long num_ps_buf_frames;
1725 unsigned long tx_retry_failed;
1726 unsigned long tx_retry_count;
1727 int last_rssi;
1728 int last_ack_rssi;
1729 };
1730
1731 struct hostapd_sta_add_params {
1732 const u8 *addr;
1733 u16 aid;
1734 u16 capability;
1735 const u8 *supp_rates;
1736 size_t supp_rates_len;
1737 u16 listen_interval;
1738 const struct ieee80211_ht_capabilities *ht_capabilities;
1739 const struct ieee80211_vht_capabilities *vht_capabilities;
1740 int vht_opmode_enabled;
1741 u8 vht_opmode;
1742 u32 flags; /* bitmask of WPA_STA_* flags */
1743 u32 flags_mask; /* unset bits in flags */
1744 #ifdef CONFIG_MESH
1745 enum mesh_plink_state plink_state;
1746 u16 peer_aid;
1747 #endif /* CONFIG_MESH */
1748 int set; /* Set STA parameters instead of add */
1749 u8 qosinfo;
1750 const u8 *ext_capab;
1751 size_t ext_capab_len;
1752 const u8 *supp_channels;
1753 size_t supp_channels_len;
1754 const u8 *supp_oper_classes;
1755 size_t supp_oper_classes_len;
1756 int support_p2p_ps;
1757 };
1758
1759 struct mac_address {
1760 u8 addr[ETH_ALEN];
1761 };
1762
1763 struct hostapd_acl_params {
1764 u8 acl_policy;
1765 unsigned int num_mac_acl;
1766 struct mac_address mac_acl[0];
1767 };
1768
1769 enum wpa_driver_if_type {
1770 /**
1771 * WPA_IF_STATION - Station mode interface
1772 */
1773 WPA_IF_STATION,
1774
1775 /**
1776 * WPA_IF_AP_VLAN - AP mode VLAN interface
1777 *
1778 * This interface shares its address and Beacon frame with the main
1779 * BSS.
1780 */
1781 WPA_IF_AP_VLAN,
1782
1783 /**
1784 * WPA_IF_AP_BSS - AP mode BSS interface
1785 *
1786 * This interface has its own address and Beacon frame.
1787 */
1788 WPA_IF_AP_BSS,
1789
1790 /**
1791 * WPA_IF_P2P_GO - P2P Group Owner
1792 */
1793 WPA_IF_P2P_GO,
1794
1795 /**
1796 * WPA_IF_P2P_CLIENT - P2P Client
1797 */
1798 WPA_IF_P2P_CLIENT,
1799
1800 /**
1801 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1802 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1803 */
1804 WPA_IF_P2P_GROUP,
1805
1806 /**
1807 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1808 * abstracted P2P Device function in the driver
1809 */
1810 WPA_IF_P2P_DEVICE,
1811
1812 /*
1813 * WPA_IF_MESH - Mesh interface
1814 */
1815 WPA_IF_MESH,
1816
1817 /*
1818 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1819 */
1820 WPA_IF_TDLS,
1821
1822 /*
1823 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1824 */
1825 WPA_IF_IBSS,
1826 };
1827
1828 struct wpa_init_params {
1829 void *global_priv;
1830 const u8 *bssid;
1831 const char *ifname;
1832 const char *driver_params;
1833 int use_pae_group_addr;
1834 char **bridge;
1835 size_t num_bridge;
1836
1837 u8 *own_addr; /* buffer for writing own MAC address */
1838 };
1839
1840
1841 struct wpa_bss_params {
1842 /** Interface name (for multi-SSID/VLAN support) */
1843 const char *ifname;
1844 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1845 int enabled;
1846
1847 int wpa;
1848 int ieee802_1x;
1849 int wpa_group;
1850 int wpa_pairwise;
1851 int wpa_key_mgmt;
1852 int rsn_preauth;
1853 enum mfp_options ieee80211w;
1854 };
1855
1856 #define WPA_STA_AUTHORIZED BIT(0)
1857 #define WPA_STA_WMM BIT(1)
1858 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1859 #define WPA_STA_MFP BIT(3)
1860 #define WPA_STA_TDLS_PEER BIT(4)
1861 #define WPA_STA_AUTHENTICATED BIT(5)
1862 #define WPA_STA_ASSOCIATED BIT(6)
1863
1864 enum tdls_oper {
1865 TDLS_DISCOVERY_REQ,
1866 TDLS_SETUP,
1867 TDLS_TEARDOWN,
1868 TDLS_ENABLE_LINK,
1869 TDLS_DISABLE_LINK,
1870 TDLS_ENABLE,
1871 TDLS_DISABLE
1872 };
1873
1874 enum wnm_oper {
1875 WNM_SLEEP_ENTER_CONFIRM,
1876 WNM_SLEEP_ENTER_FAIL,
1877 WNM_SLEEP_EXIT_CONFIRM,
1878 WNM_SLEEP_EXIT_FAIL,
1879 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1880 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1881 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1882 * a STA */
1883 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1884 * for a STA */
1885 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1886 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1887 * for a STA */
1888 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1889 };
1890
1891 /* enum chan_width - Channel width definitions */
1892 enum chan_width {
1893 CHAN_WIDTH_20_NOHT,
1894 CHAN_WIDTH_20,
1895 CHAN_WIDTH_40,
1896 CHAN_WIDTH_80,
1897 CHAN_WIDTH_80P80,
1898 CHAN_WIDTH_160,
1899 CHAN_WIDTH_UNKNOWN
1900 };
1901
1902 /**
1903 * struct wpa_signal_info - Information about channel signal quality
1904 */
1905 struct wpa_signal_info {
1906 u32 frequency;
1907 int above_threshold;
1908 int current_signal;
1909 int avg_signal;
1910 int avg_beacon_signal;
1911 int current_noise;
1912 int current_txrate;
1913 enum chan_width chanwidth;
1914 int center_frq1;
1915 int center_frq2;
1916 };
1917
1918 /**
1919 * struct beacon_data - Beacon data
1920 * @head: Head portion of Beacon frame (before TIM IE)
1921 * @tail: Tail portion of Beacon frame (after TIM IE)
1922 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1923 * @proberesp_ies: Extra information element(s) to add into Probe Response
1924 * frames or %NULL
1925 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1926 * Response frames or %NULL
1927 * @probe_resp: Probe Response frame template
1928 * @head_len: Length of @head
1929 * @tail_len: Length of @tail
1930 * @beacon_ies_len: Length of beacon_ies in octets
1931 * @proberesp_ies_len: Length of proberesp_ies in octets
1932 * @proberesp_ies_len: Length of proberesp_ies in octets
1933 * @probe_resp_len: Length of probe response template (@probe_resp)
1934 */
1935 struct beacon_data {
1936 u8 *head, *tail;
1937 u8 *beacon_ies;
1938 u8 *proberesp_ies;
1939 u8 *assocresp_ies;
1940 u8 *probe_resp;
1941
1942 size_t head_len, tail_len;
1943 size_t beacon_ies_len;
1944 size_t proberesp_ies_len;
1945 size_t assocresp_ies_len;
1946 size_t probe_resp_len;
1947 };
1948
1949 /**
1950 * struct csa_settings - Settings for channel switch command
1951 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1952 * @block_tx: 1 - block transmission for CSA period
1953 * @freq_params: Next channel frequency parameter
1954 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1955 * @beacon_after: Next beacon/probe resp/asooc resp info
1956 * @counter_offset_beacon: Offset to the count field in beacon's tail
1957 * @counter_offset_presp: Offset to the count field in probe resp.
1958 */
1959 struct csa_settings {
1960 u8 cs_count;
1961 u8 block_tx;
1962
1963 struct hostapd_freq_params freq_params;
1964 struct beacon_data beacon_csa;
1965 struct beacon_data beacon_after;
1966
1967 u16 counter_offset_beacon[2];
1968 u16 counter_offset_presp[2];
1969 };
1970
1971 /* TDLS peer capabilities for send_tdls_mgmt() */
1972 enum tdls_peer_capability {
1973 TDLS_PEER_HT = BIT(0),
1974 TDLS_PEER_VHT = BIT(1),
1975 TDLS_PEER_WMM = BIT(2),
1976 };
1977
1978 /* valid info in the wmm_params struct */
1979 enum wmm_params_valid_info {
1980 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1981 };
1982
1983 /**
1984 * struct wmm_params - WMM parameterss configured for this association
1985 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1986 * of the struct contain valid information.
1987 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1988 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1989 */
1990 struct wmm_params {
1991 u8 info_bitmap;
1992 u8 uapsd_queues;
1993 };
1994
1995 #ifdef CONFIG_MACSEC
1996 struct macsec_init_params {
1997 Boolean always_include_sci;
1998 Boolean use_es;
1999 Boolean use_scb;
2000 };
2001 #endif /* CONFIG_MACSEC */
2002
2003 enum drv_br_port_attr {
2004 DRV_BR_PORT_ATTR_PROXYARP,
2005 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
2006 };
2007
2008 enum drv_br_net_param {
2009 DRV_BR_NET_PARAM_GARP_ACCEPT,
2010 DRV_BR_MULTICAST_SNOOPING,
2011 };
2012
2013 struct drv_acs_params {
2014 /* Selected mode (HOSTAPD_MODE_*) */
2015 enum hostapd_hw_mode hw_mode;
2016
2017 /* Indicates whether HT is enabled */
2018 int ht_enabled;
2019
2020 /* Indicates whether HT40 is enabled */
2021 int ht40_enabled;
2022
2023 /* Indicates whether VHT is enabled */
2024 int vht_enabled;
2025
2026 /* Configured ACS channel width */
2027 u16 ch_width;
2028
2029 /* ACS channel list info */
2030 unsigned int ch_list_len;
2031 const u8 *ch_list;
2032 const int *freq_list;
2033 };
2034
2035 struct wpa_bss_trans_info {
2036 u8 mbo_transition_reason;
2037 u8 n_candidates;
2038 u8 *bssid;
2039 };
2040
2041 struct wpa_bss_candidate_info {
2042 u8 num;
2043 struct candidate_list {
2044 u8 bssid[ETH_ALEN];
2045 u8 is_accept;
2046 u32 reject_reason;
2047 } *candidates;
2048 };
2049
2050 struct wpa_pmkid_params {
2051 const u8 *bssid;
2052 const u8 *ssid;
2053 size_t ssid_len;
2054 const u8 *fils_cache_id;
2055 const u8 *pmkid;
2056 const u8 *pmk;
2057 size_t pmk_len;
2058 };
2059
2060 /**
2061 * struct wpa_driver_ops - Driver interface API definition
2062 *
2063 * This structure defines the API that each driver interface needs to implement
2064 * for core wpa_supplicant code. All driver specific functionality is captured
2065 * in this wrapper.
2066 */
2067 struct wpa_driver_ops {
2068 /** Name of the driver interface */
2069 const char *name;
2070 /** One line description of the driver interface */
2071 const char *desc;
2072
2073 /**
2074 * get_bssid - Get the current BSSID
2075 * @priv: private driver interface data
2076 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2077 *
2078 * Returns: 0 on success, -1 on failure
2079 *
2080 * Query kernel driver for the current BSSID and copy it to bssid.
2081 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2082 * associated.
2083 */
2084 int (*get_bssid)(void *priv, u8 *bssid);
2085
2086 /**
2087 * get_ssid - Get the current SSID
2088 * @priv: private driver interface data
2089 * @ssid: buffer for SSID (at least 32 bytes)
2090 *
2091 * Returns: Length of the SSID on success, -1 on failure
2092 *
2093 * Query kernel driver for the current SSID and copy it to ssid.
2094 * Returning zero is recommended if the STA is not associated.
2095 *
2096 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2097 * can, at least in theory, contain control characters (including nul)
2098 * and as such, should be processed as binary data, not a printable
2099 * string.
2100 */
2101 int (*get_ssid)(void *priv, u8 *ssid);
2102
2103 /**
2104 * set_key - Configure encryption key
2105 * @ifname: Interface name (for multi-SSID/VLAN support)
2106 * @priv: private driver interface data
2107 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
2108 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
2109 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
2110 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
2111 * %WPA_ALG_BIP_CMAC_256);
2112 * %WPA_ALG_NONE clears the key.
2113 * @addr: Address of the peer STA (BSSID of the current AP when setting
2114 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
2115 * broadcast keys, %NULL for default keys that are used both for
2116 * broadcast and unicast; when clearing keys, %NULL is used to
2117 * indicate that both the broadcast-only and default key of the
2118 * specified key index is to be cleared
2119 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
2120 * IGTK
2121 * @set_tx: configure this key as the default Tx key (only used when
2122 * driver does not support separate unicast/individual key
2123 * @seq: sequence number/packet number, seq_len octets, the next
2124 * packet number to be used for in replay protection; configured
2125 * for Rx keys (in most cases, this is only used with broadcast
2126 * keys and set to zero for unicast keys); %NULL if not set
2127 * @seq_len: length of the seq, depends on the algorithm:
2128 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
2129 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
2130 * 8-byte Rx Mic Key
2131 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
2132 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
2133 *
2134 * Returns: 0 on success, -1 on failure
2135 *
2136 * Configure the given key for the kernel driver. If the driver
2137 * supports separate individual keys (4 default keys + 1 individual),
2138 * addr can be used to determine whether the key is default or
2139 * individual. If only 4 keys are supported, the default key with key
2140 * index 0 is used as the individual key. STA must be configured to use
2141 * it as the default Tx key (set_tx is set) and accept Rx for all the
2142 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2143 * broadcast keys, so key index 0 is available for this kind of
2144 * configuration.
2145 *
2146 * Please note that TKIP keys include separate TX and RX MIC keys and
2147 * some drivers may expect them in different order than wpa_supplicant
2148 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
2149 * will trigger Michael MIC errors. This can be fixed by changing the
2150 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
2151 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2152 * example on how this can be done.
2153 */
2154 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
2155 const u8 *addr, int key_idx, int set_tx,
2156 const u8 *seq, size_t seq_len,
2157 const u8 *key, size_t key_len);
2158
2159 /**
2160 * init - Initialize driver interface
2161 * @ctx: context to be used when calling wpa_supplicant functions,
2162 * e.g., wpa_supplicant_event()
2163 * @ifname: interface name, e.g., wlan0
2164 *
2165 * Returns: Pointer to private data, %NULL on failure
2166 *
2167 * Initialize driver interface, including event processing for kernel
2168 * driver events (e.g., associated, scan results, Michael MIC failure).
2169 * This function can allocate a private configuration data area for
2170 * @ctx, file descriptor, interface name, etc. information that may be
2171 * needed in future driver operations. If this is not used, non-NULL
2172 * value will need to be returned because %NULL is used to indicate
2173 * failure. The returned value will be used as 'void *priv' data for
2174 * all other driver_ops functions.
2175 *
2176 * The main event loop (eloop.c) of wpa_supplicant can be used to
2177 * register callback for read sockets (eloop_register_read_sock()).
2178 *
2179 * See below for more information about events and
2180 * wpa_supplicant_event() function.
2181 */
2182 void * (*init)(void *ctx, const char *ifname);
2183
2184 /**
2185 * deinit - Deinitialize driver interface
2186 * @priv: private driver interface data from init()
2187 *
2188 * Shut down driver interface and processing of driver events. Free
2189 * private data buffer if one was allocated in init() handler.
2190 */
2191 void (*deinit)(void *priv);
2192
2193 /**
2194 * set_param - Set driver configuration parameters
2195 * @priv: private driver interface data from init()
2196 * @param: driver specific configuration parameters
2197 *
2198 * Returns: 0 on success, -1 on failure
2199 *
2200 * Optional handler for notifying driver interface about configuration
2201 * parameters (driver_param).
2202 */
2203 int (*set_param)(void *priv, const char *param);
2204
2205 /**
2206 * set_countermeasures - Enable/disable TKIP countermeasures
2207 * @priv: private driver interface data
2208 * @enabled: 1 = countermeasures enabled, 0 = disabled
2209 *
2210 * Returns: 0 on success, -1 on failure
2211 *
2212 * Configure TKIP countermeasures. When these are enabled, the driver
2213 * should drop all received and queued frames that are using TKIP.
2214 */
2215 int (*set_countermeasures)(void *priv, int enabled);
2216
2217 /**
2218 * deauthenticate - Request driver to deauthenticate
2219 * @priv: private driver interface data
2220 * @addr: peer address (BSSID of the AP)
2221 * @reason_code: 16-bit reason code to be sent in the deauthentication
2222 * frame
2223 *
2224 * Returns: 0 on success, -1 on failure
2225 */
2226 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
2227
2228 /**
2229 * associate - Request driver to associate
2230 * @priv: private driver interface data
2231 * @params: association parameters
2232 *
2233 * Returns: 0 on success, -1 on failure
2234 */
2235 int (*associate)(void *priv,
2236 struct wpa_driver_associate_params *params);
2237
2238 /**
2239 * add_pmkid - Add PMKSA cache entry to the driver
2240 * @priv: private driver interface data
2241 * @params: PMKSA parameters
2242 *
2243 * Returns: 0 on success, -1 on failure
2244 *
2245 * This function is called when a new PMK is received, as a result of
2246 * either normal authentication or RSN pre-authentication. The PMKSA
2247 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2248 * ssid, fils_cache_id, pmkid, and pmk.
2249 *
2250 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2251 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2252 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2253 * driver_ops function does not need to be implemented. Likewise, if
2254 * the driver does not support WPA, this function is not needed.
2255 */
2256 int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params);
2257
2258 /**
2259 * remove_pmkid - Remove PMKSA cache entry to the driver
2260 * @priv: private driver interface data
2261 * @params: PMKSA parameters
2262 *
2263 * Returns: 0 on success, -1 on failure
2264 *
2265 * This function is called when the supplicant drops a PMKSA cache
2266 * entry for any reason. The PMKSA parameters are either a set of
2267 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
2268 *
2269 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2270 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2271 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2272 * from wpa_supplicant, this driver_ops function does not need to be
2273 * implemented. Likewise, if the driver does not support WPA, this
2274 * function is not needed.
2275 */
2276 int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params);
2277
2278 /**
2279 * flush_pmkid - Flush PMKSA cache
2280 * @priv: private driver interface data
2281 *
2282 * Returns: 0 on success, -1 on failure
2283 *
2284 * This function is called when the supplicant drops all PMKSA cache
2285 * entries for any reason.
2286 *
2287 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2288 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2289 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2290 * from wpa_supplicant, this driver_ops function does not need to be
2291 * implemented. Likewise, if the driver does not support WPA, this
2292 * function is not needed.
2293 */
2294 int (*flush_pmkid)(void *priv);
2295
2296 /**
2297 * get_capa - Get driver capabilities
2298 * @priv: private driver interface data
2299 *
2300 * Returns: 0 on success, -1 on failure
2301 *
2302 * Get driver/firmware/hardware capabilities.
2303 */
2304 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
2305
2306 /**
2307 * poll - Poll driver for association information
2308 * @priv: private driver interface data
2309 *
2310 * This is an option callback that can be used when the driver does not
2311 * provide event mechanism for association events. This is called when
2312 * receiving WPA EAPOL-Key messages that require association
2313 * information. The driver interface is supposed to generate associnfo
2314 * event before returning from this callback function. In addition, the
2315 * driver interface should generate an association event after having
2316 * sent out associnfo.
2317 */
2318 void (*poll)(void *priv);
2319
2320 /**
2321 * get_ifindex - Get interface index
2322 * @priv: private driver interface data
2323 *
2324 * Returns: Interface index
2325 */
2326 unsigned int (*get_ifindex)(void *priv);
2327
2328 /**
2329 * get_ifname - Get interface name
2330 * @priv: private driver interface data
2331 *
2332 * Returns: Pointer to the interface name. This can differ from the
2333 * interface name used in init() call. Init() is called first.
2334 *
2335 * This optional function can be used to allow the driver interface to
2336 * replace the interface name with something else, e.g., based on an
2337 * interface mapping from a more descriptive name.
2338 */
2339 const char * (*get_ifname)(void *priv);
2340
2341 /**
2342 * get_mac_addr - Get own MAC address
2343 * @priv: private driver interface data
2344 *
2345 * Returns: Pointer to own MAC address or %NULL on failure
2346 *
2347 * This optional function can be used to get the own MAC address of the
2348 * device from the driver interface code. This is only needed if the
2349 * l2_packet implementation for the OS does not provide easy access to
2350 * a MAC address. */
2351 const u8 * (*get_mac_addr)(void *priv);
2352
2353 /**
2354 * set_operstate - Sets device operating state to DORMANT or UP
2355 * @priv: private driver interface data
2356 * @state: 0 = dormant, 1 = up
2357 * Returns: 0 on success, -1 on failure
2358 *
2359 * This is an optional function that can be used on operating systems
2360 * that support a concept of controlling network device state from user
2361 * space applications. This function, if set, gets called with
2362 * state = 1 when authentication has been completed and with state = 0
2363 * when connection is lost.
2364 */
2365 int (*set_operstate)(void *priv, int state);
2366
2367 /**
2368 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2369 * @priv: Private driver interface data
2370 * @addr: Address of the station for which to set protection (may be
2371 * %NULL for group keys)
2372 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2373 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2374 * Returns: 0 on success, -1 on failure
2375 *
2376 * This is an optional function that can be used to set the driver to
2377 * require protection for Tx and/or Rx frames. This uses the layer
2378 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2379 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2380 * set protection operation; instead, they set protection implicitly
2381 * based on configured keys.
2382 */
2383 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2384 int key_type);
2385
2386 /**
2387 * get_hw_feature_data - Get hardware support data (channels and rates)
2388 * @priv: Private driver interface data
2389 * @num_modes: Variable for returning the number of returned modes
2390 * flags: Variable for returning hardware feature flags
2391 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
2392 * Returns: Pointer to allocated hardware data on success or %NULL on
2393 * failure. Caller is responsible for freeing this.
2394 */
2395 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2396 u16 *num_modes,
2397 u16 *flags, u8 *dfs);
2398
2399 /**
2400 * send_mlme - Send management frame from MLME
2401 * @priv: Private driver interface data
2402 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2403 * @data_len: Size of the management frame
2404 * @noack: Do not wait for this frame to be acked (disable retries)
2405 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2406 * driver decide
2407 * @csa_offs: Array of CSA offsets or %NULL
2408 * @csa_offs_len: Number of elements in csa_offs
2409 * Returns: 0 on success, -1 on failure
2410 */
2411 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
2412 int noack, unsigned int freq, const u16 *csa_offs,
2413 size_t csa_offs_len);
2414
2415 /**
2416 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2417 * @priv: Private driver interface data
2418 * @md: Mobility domain (2 octets) (also included inside ies)
2419 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2420 * @ies_len: Length of FT IEs in bytes
2421 * Returns: 0 on success, -1 on failure
2422 *
2423 * The supplicant uses this callback to let the driver know that keying
2424 * material for FT is available and that the driver can use the
2425 * provided IEs in the next message in FT authentication sequence.
2426 *
2427 * This function is only needed for driver that support IEEE 802.11r
2428 * (Fast BSS Transition).
2429 */
2430 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2431 size_t ies_len);
2432
2433 /**
2434 * get_scan_results2 - Fetch the latest scan results
2435 * @priv: private driver interface data
2436 *
2437 * Returns: Allocated buffer of scan results (caller is responsible for
2438 * freeing the data structure) on success, NULL on failure
2439 */
2440 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2441
2442 /**
2443 * set_country - Set country
2444 * @priv: Private driver interface data
2445 * @alpha2: country to which to switch to
2446 * Returns: 0 on success, -1 on failure
2447 *
2448 * This function is for drivers which support some form
2449 * of setting a regulatory domain.
2450 */
2451 int (*set_country)(void *priv, const char *alpha2);
2452
2453 /**
2454 * get_country - Get country
2455 * @priv: Private driver interface data
2456 * @alpha2: Buffer for returning country code (at least 3 octets)
2457 * Returns: 0 on success, -1 on failure
2458 */
2459 int (*get_country)(void *priv, char *alpha2);
2460
2461 /**
2462 * global_init - Global driver initialization
2463 * @ctx: wpa_global pointer
2464 * Returns: Pointer to private data (global), %NULL on failure
2465 *
2466 * This optional function is called to initialize the driver wrapper
2467 * for global data, i.e., data that applies to all interfaces. If this
2468 * function is implemented, global_deinit() will also need to be
2469 * implemented to free the private data. The driver will also likely
2470 * use init2() function instead of init() to get the pointer to global
2471 * data available to per-interface initializer.
2472 */
2473 void * (*global_init)(void *ctx);
2474
2475 /**
2476 * global_deinit - Global driver deinitialization
2477 * @priv: private driver global data from global_init()
2478 *
2479 * Terminate any global driver related functionality and free the
2480 * global data structure.
2481 */
2482 void (*global_deinit)(void *priv);
2483
2484 /**
2485 * init2 - Initialize driver interface (with global data)
2486 * @ctx: context to be used when calling wpa_supplicant functions,
2487 * e.g., wpa_supplicant_event()
2488 * @ifname: interface name, e.g., wlan0
2489 * @global_priv: private driver global data from global_init()
2490 * Returns: Pointer to private data, %NULL on failure
2491 *
2492 * This function can be used instead of init() if the driver wrapper
2493 * uses global data.
2494 */
2495 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2496
2497 /**
2498 * get_interfaces - Get information about available interfaces
2499 * @global_priv: private driver global data from global_init()
2500 * Returns: Allocated buffer of interface information (caller is
2501 * responsible for freeing the data structure) on success, NULL on
2502 * failure
2503 */
2504 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2505
2506 /**
2507 * scan2 - Request the driver to initiate scan
2508 * @priv: private driver interface data
2509 * @params: Scan parameters
2510 *
2511 * Returns: 0 on success, -1 on failure
2512 *
2513 * Once the scan results are ready, the driver should report scan
2514 * results event for wpa_supplicant which will eventually request the
2515 * results with wpa_driver_get_scan_results2().
2516 */
2517 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2518
2519 /**
2520 * authenticate - Request driver to authenticate
2521 * @priv: private driver interface data
2522 * @params: authentication parameters
2523 * Returns: 0 on success, -1 on failure
2524 *
2525 * This is an optional function that can be used with drivers that
2526 * support separate authentication and association steps, i.e., when
2527 * wpa_supplicant can act as the SME. If not implemented, associate()
2528 * function is expected to take care of IEEE 802.11 authentication,
2529 * too.
2530 */
2531 int (*authenticate)(void *priv,
2532 struct wpa_driver_auth_params *params);
2533
2534 /**
2535 * set_ap - Set Beacon and Probe Response information for AP mode
2536 * @priv: Private driver interface data
2537 * @params: Parameters to use in AP mode
2538 *
2539 * This function is used to configure Beacon template and/or extra IEs
2540 * to add for Beacon and Probe Response frames for the driver in
2541 * AP mode. The driver is responsible for building the full Beacon
2542 * frame by concatenating the head part with TIM IE generated by the
2543 * driver/firmware and finishing with the tail part. Depending on the
2544 * driver architectue, this can be done either by using the full
2545 * template or the set of additional IEs (e.g., WPS and P2P IE).
2546 * Similarly, Probe Response processing depends on the driver design.
2547 * If the driver (or firmware) takes care of replying to Probe Request
2548 * frames, the extra IEs provided here needs to be added to the Probe
2549 * Response frames.
2550 *
2551 * Returns: 0 on success, -1 on failure
2552 */
2553 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
2554
2555 /**
2556 * set_acl - Set ACL in AP mode
2557 * @priv: Private driver interface data
2558 * @params: Parameters to configure ACL
2559 * Returns: 0 on success, -1 on failure
2560 *
2561 * This is used only for the drivers which support MAC address ACL.
2562 */
2563 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2564
2565 /**
2566 * hapd_init - Initialize driver interface (hostapd only)
2567 * @hapd: Pointer to hostapd context
2568 * @params: Configuration for the driver wrapper
2569 * Returns: Pointer to private data, %NULL on failure
2570 *
2571 * This function is used instead of init() or init2() when the driver
2572 * wrapper is used with hostapd.
2573 */
2574 void * (*hapd_init)(struct hostapd_data *hapd,
2575 struct wpa_init_params *params);
2576
2577 /**
2578 * hapd_deinit - Deinitialize driver interface (hostapd only)
2579 * @priv: Private driver interface data from hapd_init()
2580 */
2581 void (*hapd_deinit)(void *priv);
2582
2583 /**
2584 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2585 * @priv: Private driver interface data
2586 * @params: BSS parameters
2587 * Returns: 0 on success, -1 on failure
2588 *
2589 * This is an optional function to configure the kernel driver to
2590 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2591 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2592 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2593 * for Beacon frames.
2594 *
2595 * DEPRECATED - use set_ap() instead
2596 */
2597 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2598
2599 /**
2600 * set_privacy - Enable/disable privacy (AP only)
2601 * @priv: Private driver interface data
2602 * @enabled: 1 = privacy enabled, 0 = disabled
2603 * Returns: 0 on success, -1 on failure
2604 *
2605 * This is an optional function to configure privacy field in the
2606 * kernel driver for Beacon frames. This can be left undefined (set to
2607 * %NULL) if the driver uses the Beacon template from set_ap().
2608 *
2609 * DEPRECATED - use set_ap() instead
2610 */
2611 int (*set_privacy)(void *priv, int enabled);
2612
2613 /**
2614 * get_seqnum - Fetch the current TSC/packet number (AP only)
2615 * @ifname: The interface name (main or virtual)
2616 * @priv: Private driver interface data
2617 * @addr: MAC address of the station or %NULL for group keys
2618 * @idx: Key index
2619 * @seq: Buffer for returning the latest used TSC/packet number
2620 * Returns: 0 on success, -1 on failure
2621 *
2622 * This function is used to fetch the last used TSC/packet number for
2623 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2624 * keys, so there is no strict requirement on implementing support for
2625 * unicast keys (i.e., addr != %NULL).
2626 */
2627 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2628 int idx, u8 *seq);
2629
2630 /**
2631 * flush - Flush all association stations (AP only)
2632 * @priv: Private driver interface data
2633 * Returns: 0 on success, -1 on failure
2634 *
2635 * This function requests the driver to disassociate all associated
2636 * stations. This function does not need to be implemented if the
2637 * driver does not process association frames internally.
2638 */
2639 int (*flush)(void *priv);
2640
2641 /**
2642 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2643 * @priv: Private driver interface data
2644 * @elem: Information elements
2645 * @elem_len: Length of the elem buffer in octets
2646 * Returns: 0 on success, -1 on failure
2647 *
2648 * This is an optional function to add information elements in the
2649 * kernel driver for Beacon and Probe Response frames. This can be left
2650 * undefined (set to %NULL) if the driver uses the Beacon template from
2651 * set_ap().
2652 *
2653 * DEPRECATED - use set_ap() instead
2654 */
2655 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2656
2657 /**
2658 * read_sta_data - Fetch station data
2659 * @priv: Private driver interface data
2660 * @data: Buffer for returning station information
2661 * @addr: MAC address of the station
2662 * Returns: 0 on success, -1 on failure
2663 */
2664 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2665 const u8 *addr);
2666
2667 /**
2668 * hapd_send_eapol - Send an EAPOL packet (AP only)
2669 * @priv: private driver interface data
2670 * @addr: Destination MAC address
2671 * @data: EAPOL packet starting with IEEE 802.1X header
2672 * @data_len: Length of the EAPOL packet in octets
2673 * @encrypt: Whether the frame should be encrypted
2674 * @own_addr: Source MAC address
2675 * @flags: WPA_STA_* flags for the destination station
2676 *
2677 * Returns: 0 on success, -1 on failure
2678 */
2679 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2680 size_t data_len, int encrypt,
2681 const u8 *own_addr, u32 flags);
2682
2683 /**
2684 * sta_deauth - Deauthenticate a station (AP only)
2685 * @priv: Private driver interface data
2686 * @own_addr: Source address and BSSID for the Deauthentication frame
2687 * @addr: MAC address of the station to deauthenticate
2688 * @reason: Reason code for the Deauthentiation frame
2689 * Returns: 0 on success, -1 on failure
2690 *
2691 * This function requests a specific station to be deauthenticated and
2692 * a Deauthentication frame to be sent to it.
2693 */
2694 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2695 int reason);
2696
2697 /**
2698 * sta_disassoc - Disassociate a station (AP only)
2699 * @priv: Private driver interface data
2700 * @own_addr: Source address and BSSID for the Disassociation frame
2701 * @addr: MAC address of the station to disassociate
2702 * @reason: Reason code for the Disassociation frame
2703 * Returns: 0 on success, -1 on failure
2704 *
2705 * This function requests a specific station to be disassociated and
2706 * a Disassociation frame to be sent to it.
2707 */
2708 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2709 int reason);
2710
2711 /**
2712 * sta_remove - Remove a station entry (AP only)
2713 * @priv: Private driver interface data
2714 * @addr: MAC address of the station to be removed
2715 * Returns: 0 on success, -1 on failure
2716 */
2717 int (*sta_remove)(void *priv, const u8 *addr);
2718
2719 /**
2720 * hapd_get_ssid - Get the current SSID (AP only)
2721 * @priv: Private driver interface data
2722 * @buf: Buffer for returning the SSID
2723 * @len: Maximum length of the buffer
2724 * Returns: Length of the SSID on success, -1 on failure
2725 *
2726 * This function need not be implemented if the driver uses Beacon
2727 * template from set_ap() and does not reply to Probe Request frames.
2728 */
2729 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2730
2731 /**
2732 * hapd_set_ssid - Set SSID (AP only)
2733 * @priv: Private driver interface data
2734 * @buf: SSID
2735 * @len: Length of the SSID in octets
2736 * Returns: 0 on success, -1 on failure
2737 *
2738 * DEPRECATED - use set_ap() instead
2739 */
2740 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2741
2742 /**
2743 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2744 * @priv: Private driver interface data
2745 * @enabled: 1 = countermeasures enabled, 0 = disabled
2746 * Returns: 0 on success, -1 on failure
2747 *
2748 * This need not be implemented if the driver does not take care of
2749 * association processing.
2750 */
2751 int (*hapd_set_countermeasures)(void *priv, int enabled);
2752
2753 /**
2754 * sta_add - Add a station entry
2755 * @priv: Private driver interface data
2756 * @params: Station parameters
2757 * Returns: 0 on success, -1 on failure
2758 *
2759 * This function is used to add or set (params->set 1) a station
2760 * entry in the driver. Adding STA entries is used only if the driver
2761 * does not take care of association processing.
2762 *
2763 * With drivers that don't support full AP client state, this function
2764 * is used to add a station entry to the driver once the station has
2765 * completed association.
2766 *
2767 * With TDLS, this function is used to add or set (params->set 1)
2768 * TDLS peer entries (even with drivers that do not support full AP
2769 * client state).
2770 */
2771 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2772
2773 /**
2774 * get_inact_sec - Get station inactivity duration (AP only)
2775 * @priv: Private driver interface data
2776 * @addr: Station address
2777 * Returns: Number of seconds station has been inactive, -1 on failure
2778 */
2779 int (*get_inact_sec)(void *priv, const u8 *addr);
2780
2781 /**
2782 * sta_clear_stats - Clear station statistics (AP only)
2783 * @priv: Private driver interface data
2784 * @addr: Station address
2785 * Returns: 0 on success, -1 on failure
2786 */
2787 int (*sta_clear_stats)(void *priv, const u8 *addr);
2788
2789 /**
2790 * set_freq - Set channel/frequency (AP only)
2791 * @priv: Private driver interface data
2792 * @freq: Channel parameters
2793 * Returns: 0 on success, -1 on failure
2794 */
2795 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2796
2797 /**
2798 * set_rts - Set RTS threshold
2799 * @priv: Private driver interface data
2800 * @rts: RTS threshold in octets
2801 * Returns: 0 on success, -1 on failure
2802 */
2803 int (*set_rts)(void *priv, int rts);
2804
2805 /**
2806 * set_frag - Set fragmentation threshold
2807 * @priv: Private driver interface data
2808 * @frag: Fragmentation threshold in octets
2809 * Returns: 0 on success, -1 on failure
2810 */
2811 int (*set_frag)(void *priv, int frag);
2812
2813 /**
2814 * sta_set_flags - Set station flags (AP only)
2815 * @priv: Private driver interface data
2816 * @addr: Station address
2817 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2818 * @flags_or: Bitmap of WPA_STA_* flags to add
2819 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2820 * Returns: 0 on success, -1 on failure
2821 */
2822 int (*sta_set_flags)(void *priv, const u8 *addr,
2823 unsigned int total_flags, unsigned int flags_or,
2824 unsigned int flags_and);
2825
2826 /**
2827 * set_tx_queue_params - Set TX queue parameters
2828 * @priv: Private driver interface data
2829 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2830 * @aifs: AIFS
2831 * @cw_min: cwMin
2832 * @cw_max: cwMax
2833 * @burst_time: Maximum length for bursting in 0.1 msec units
2834 */
2835 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2836 int cw_max, int burst_time);
2837
2838 /**
2839 * if_add - Add a virtual interface
2840 * @priv: Private driver interface data
2841 * @type: Interface type
2842 * @ifname: Interface name for the new virtual interface
2843 * @addr: Local address to use for the interface or %NULL to use the
2844 * parent interface address
2845 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2846 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2847 * not allowed (applies only to %WPA_IF_AP_BSS type)
2848 * @force_ifname: Buffer for returning an interface name that the
2849 * driver ended up using if it differs from the requested ifname
2850 * @if_addr: Buffer for returning the allocated interface address
2851 * (this may differ from the requested addr if the driver cannot
2852 * change interface address)
2853 * @bridge: Bridge interface to use or %NULL if no bridge configured
2854 * @use_existing: Whether to allow existing interface to be used
2855 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
2856 * Returns: 0 on success, -1 on failure
2857 */
2858 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2859 const char *ifname, const u8 *addr, void *bss_ctx,
2860 void **drv_priv, char *force_ifname, u8 *if_addr,
2861 const char *bridge, int use_existing, int setup_ap);
2862
2863 /**
2864 * if_remove - Remove a virtual interface
2865 * @priv: Private driver interface data
2866 * @type: Interface type
2867 * @ifname: Interface name of the virtual interface to be removed
2868 * Returns: 0 on success, -1 on failure
2869 */
2870 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2871 const char *ifname);
2872
2873 /**
2874 * set_sta_vlan - Bind a station into a specific interface (AP only)
2875 * @priv: Private driver interface data
2876 * @ifname: Interface (main or virtual BSS or VLAN)
2877 * @addr: MAC address of the associated station
2878 * @vlan_id: VLAN ID
2879 * Returns: 0 on success, -1 on failure
2880 *
2881 * This function is used to bind a station to a specific virtual
2882 * interface. It is only used if when virtual interfaces are supported,
2883 * e.g., to assign stations to different VLAN interfaces based on
2884 * information from a RADIUS server. This allows separate broadcast
2885 * domains to be used with a single BSS.
2886 */
2887 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2888 int vlan_id);
2889
2890 /**
2891 * commit - Optional commit changes handler (AP only)
2892 * @priv: driver private data
2893 * Returns: 0 on success, -1 on failure
2894 *
2895 * This optional handler function can be registered if the driver
2896 * interface implementation needs to commit changes (e.g., by setting
2897 * network interface up) at the end of initial configuration. If set,
2898 * this handler will be called after initial setup has been completed.
2899 */
2900 int (*commit)(void *priv);
2901
2902 /**
2903 * send_ether - Send an ethernet packet (AP only)
2904 * @priv: private driver interface data
2905 * @dst: Destination MAC address
2906 * @src: Source MAC address
2907 * @proto: Ethertype
2908 * @data: EAPOL packet starting with IEEE 802.1X header
2909 * @data_len: Length of the EAPOL packet in octets
2910 * Returns: 0 on success, -1 on failure
2911 */
2912 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2913 const u8 *data, size_t data_len);
2914
2915 /**
2916 * set_radius_acl_auth - Notification of RADIUS ACL change
2917 * @priv: Private driver interface data
2918 * @mac: MAC address of the station
2919 * @accepted: Whether the station was accepted
2920 * @session_timeout: Session timeout for the station
2921 * Returns: 0 on success, -1 on failure
2922 */
2923 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2924 u32 session_timeout);
2925
2926 /**
2927 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2928 * @priv: Private driver interface data
2929 * @mac: MAC address of the station
2930 * Returns: 0 on success, -1 on failure
2931 */
2932 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2933
2934 /**
2935 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2936 * @priv: Private driver interface data
2937 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2938 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2939 * extra IE(s)
2940 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2941 * to remove extra IE(s)
2942 * Returns: 0 on success, -1 on failure
2943 *
2944 * This is an optional function to add WPS IE in the kernel driver for
2945 * Beacon and Probe Response frames. This can be left undefined (set
2946 * to %NULL) if the driver uses the Beacon template from set_ap()
2947 * and does not process Probe Request frames. If the driver takes care
2948 * of (Re)Association frame processing, the assocresp buffer includes
2949 * WPS IE(s) that need to be added to (Re)Association Response frames
2950 * whenever a (Re)Association Request frame indicated use of WPS.
2951 *
2952 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2953 * frames when operating as a GO. The driver is responsible for adding
2954 * timing related attributes (e.g., NoA) in addition to the IEs
2955 * included here by appending them after these buffers. This call is
2956 * also used to provide Probe Response IEs for P2P Listen state
2957 * operations for drivers that generate the Probe Response frames
2958 * internally.
2959 *
2960 * DEPRECATED - use set_ap() instead
2961 */
2962 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2963 const struct wpabuf *proberesp,
2964 const struct wpabuf *assocresp);
2965
2966 /**
2967 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2968 * @priv: Private driver interface data
2969 * @authorized: Whether the port is authorized
2970 * Returns: 0 on success, -1 on failure
2971 */
2972 int (*set_supp_port)(void *priv, int authorized);
2973
2974 /**
2975 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2976 * @priv: Private driver interface data
2977 * @addr: MAC address of the associated station
2978 * @aid: Association ID
2979 * @val: 1 = bind to 4-address WDS; 0 = unbind
2980 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2981 * to indicate that bridge is not to be used
2982 * @ifname_wds: Buffer to return the interface name for the new WDS
2983 * station or %NULL to indicate name is not returned.
2984 * Returns: 0 on success, -1 on failure
2985 */
2986 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2987 const char *bridge_ifname, char *ifname_wds);
2988
2989 /**
2990 * send_action - Transmit an Action frame
2991 * @priv: Private driver interface data
2992 * @freq: Frequency (in MHz) of the channel
2993 * @wait: Time to wait off-channel for a response (in ms), or zero
2994 * @dst: Destination MAC address (Address 1)
2995 * @src: Source MAC address (Address 2)
2996 * @bssid: BSSID (Address 3)
2997 * @data: Frame body
2998 * @data_len: data length in octets
2999 @ @no_cck: Whether CCK rates must not be used to transmit this frame
3000 * Returns: 0 on success, -1 on failure
3001 *
3002 * This command can be used to request the driver to transmit an action
3003 * frame to the specified destination.
3004 *
3005 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3006 * be transmitted on the given channel and the device will wait for a
3007 * response on that channel for the given wait time.
3008 *
3009 * If the flag is not set, the wait time will be ignored. In this case,
3010 * if a remain-on-channel duration is in progress, the frame must be
3011 * transmitted on that channel; alternatively the frame may be sent on
3012 * the current operational channel (if in associated state in station
3013 * mode or while operating as an AP.)
3014 *
3015 * If @src differs from the device MAC address, use of a random
3016 * transmitter address is requested for this message exchange.
3017 */
3018 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
3019 const u8 *dst, const u8 *src, const u8 *bssid,
3020 const u8 *data, size_t data_len, int no_cck);
3021
3022 /**
3023 * send_action_cancel_wait - Cancel action frame TX wait
3024 * @priv: Private driver interface data
3025 *
3026 * This command cancels the wait time associated with sending an action
3027 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3028 * set in the driver flags.
3029 */
3030 void (*send_action_cancel_wait)(void *priv);
3031
3032 /**
3033 * remain_on_channel - Remain awake on a channel
3034 * @priv: Private driver interface data
3035 * @freq: Frequency (in MHz) of the channel
3036 * @duration: Duration in milliseconds
3037 * Returns: 0 on success, -1 on failure
3038 *
3039 * This command is used to request the driver to remain awake on the
3040 * specified channel for the specified duration and report received
3041 * Action frames with EVENT_RX_MGMT events. Optionally, received
3042 * Probe Request frames may also be requested to be reported by calling
3043 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3044 *
3045 * The driver may not be at the requested channel when this function
3046 * returns, i.e., the return code is only indicating whether the
3047 * request was accepted. The caller will need to wait until the
3048 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3049 * completed the channel change. This may take some time due to other
3050 * need for the radio and the caller should be prepared to timing out
3051 * its wait since there are no guarantees on when this request can be
3052 * executed.
3053 */
3054 int (*remain_on_channel)(void *priv, unsigned int freq,
3055 unsigned int duration);
3056
3057 /**
3058 * cancel_remain_on_channel - Cancel remain-on-channel operation
3059 * @priv: Private driver interface data
3060 *
3061 * This command can be used to cancel a remain-on-channel operation
3062 * before its originally requested duration has passed. This could be
3063 * used, e.g., when remain_on_channel() is used to request extra time
3064 * to receive a response to an Action frame and the response is
3065 * received when there is still unneeded time remaining on the
3066 * remain-on-channel operation.
3067 */
3068 int (*cancel_remain_on_channel)(void *priv);
3069
3070 /**
3071 * probe_req_report - Request Probe Request frames to be indicated
3072 * @priv: Private driver interface data
3073 * @report: Whether to report received Probe Request frames
3074 * Returns: 0 on success, -1 on failure (or if not supported)
3075 *
3076 * This command can be used to request the driver to indicate when
3077 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3078 * Since this operation may require extra resources, e.g., due to less
3079 * optimal hardware/firmware RX filtering, many drivers may disable
3080 * Probe Request reporting at least in station mode. This command is
3081 * used to notify the driver when the Probe Request frames need to be
3082 * reported, e.g., during remain-on-channel operations.
3083 */
3084 int (*probe_req_report)(void *priv, int report);
3085
3086 /**
3087 * deinit_ap - Deinitialize AP mode
3088 * @priv: Private driver interface data
3089 * Returns: 0 on success, -1 on failure (or if not supported)
3090 *
3091 * This optional function can be used to disable AP mode related
3092 * configuration. If the interface was not dynamically added,
3093 * change the driver mode to station mode to allow normal station
3094 * operations like scanning to be completed.
3095 */
3096 int (*deinit_ap)(void *priv);
3097
3098 /**
3099 * deinit_p2p_cli - Deinitialize P2P client mode
3100 * @priv: Private driver interface data
3101 * Returns: 0 on success, -1 on failure (or if not supported)
3102 *
3103 * This optional function can be used to disable P2P client mode. If the
3104 * interface was not dynamically added, change the interface type back
3105 * to station mode.
3106 */
3107 int (*deinit_p2p_cli)(void *priv);
3108
3109 /**
3110 * suspend - Notification on system suspend/hibernate event
3111 * @priv: Private driver interface data
3112 */
3113 void (*suspend)(void *priv);
3114
3115 /**
3116 * resume - Notification on system resume/thaw event
3117 * @priv: Private driver interface data
3118 */
3119 void (*resume)(void *priv);
3120
3121 /**
3122 * signal_monitor - Set signal monitoring parameters
3123 * @priv: Private driver interface data
3124 * @threshold: Threshold value for signal change events; 0 = disabled
3125 * @hysteresis: Minimum change in signal strength before indicating a
3126 * new event
3127 * Returns: 0 on success, -1 on failure (or if not supported)
3128 *
3129 * This function can be used to configure monitoring of signal strength
3130 * with the current AP. Whenever signal strength drops below the
3131 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3132 * should be generated assuming the signal strength has changed at
3133 * least %hysteresis from the previously indicated signal change event.
3134 */
3135 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
3136
3137 /**
3138 * send_frame - Send IEEE 802.11 frame (testing use only)
3139 * @priv: Private driver interface data
3140 * @data: IEEE 802.11 frame with IEEE 802.11 header
3141 * @data_len: Size of the frame
3142 * @encrypt: Whether to encrypt the frame (if keys are set)
3143 * Returns: 0 on success, -1 on failure
3144 *
3145 * This function is only used for debugging purposes and is not
3146 * required to be implemented for normal operations.
3147 */
3148 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
3149 int encrypt);
3150
3151 /**
3152 * get_noa - Get current Notice of Absence attribute payload
3153 * @priv: Private driver interface data
3154 * @buf: Buffer for returning NoA
3155 * @buf_len: Buffer length in octets
3156 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3157 * advertized, or -1 on failure
3158 *
3159 * This function is used to fetch the current Notice of Absence
3160 * attribute value from GO.
3161 */
3162 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
3163
3164 /**
3165 * set_noa - Set Notice of Absence parameters for GO (testing)
3166 * @priv: Private driver interface data
3167 * @count: Count
3168 * @start: Start time in ms from next TBTT
3169 * @duration: Duration in ms
3170 * Returns: 0 on success or -1 on failure
3171 *
3172 * This function is used to set Notice of Absence parameters for GO. It
3173 * is used only for testing. To disable NoA, all parameters are set to
3174 * 0.
3175 */
3176 int (*set_noa)(void *priv, u8 count, int start, int duration);
3177
3178 /**
3179 * set_p2p_powersave - Set P2P power save options
3180 * @priv: Private driver interface data
3181 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3182 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3183 * @ctwindow: 0.. = change (msec), -1 = no change
3184 * Returns: 0 on success or -1 on failure
3185 */
3186 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
3187 int ctwindow);
3188
3189 /**
3190 * ampdu - Enable/disable aggregation
3191 * @priv: Private driver interface data
3192 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3193 * Returns: 0 on success or -1 on failure
3194 */
3195 int (*ampdu)(void *priv, int ampdu);
3196
3197 /**
3198 * get_radio_name - Get physical radio name for the device
3199 * @priv: Private driver interface data
3200 * Returns: Radio name or %NULL if not known
3201 *
3202 * The returned data must not be modified by the caller. It is assumed
3203 * that any interface that has the same radio name as another is
3204 * sharing the same physical radio. This information can be used to
3205 * share scan results etc. information between the virtual interfaces
3206 * to speed up various operations.
3207 */
3208 const char * (*get_radio_name)(void *priv);
3209
3210 /**
3211 * send_tdls_mgmt - for sending TDLS management packets
3212 * @priv: private driver interface data
3213 * @dst: Destination (peer) MAC address
3214 * @action_code: TDLS action code for the mssage
3215 * @dialog_token: Dialog Token to use in the message (if needed)
3216 * @status_code: Status Code or Reason Code to use (if needed)
3217 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
3218 * @initiator: Is the current end the TDLS link initiator
3219 * @buf: TDLS IEs to add to the message
3220 * @len: Length of buf in octets
3221 * Returns: 0 on success, negative (<0) on failure
3222 *
3223 * This optional function can be used to send packet to driver which is
3224 * responsible for receiving and sending all TDLS packets.
3225 */
3226 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
3227 u8 dialog_token, u16 status_code, u32 peer_capab,
3228 int initiator, const u8 *buf, size_t len);
3229
3230 /**
3231 * tdls_oper - Ask the driver to perform high-level TDLS operations
3232 * @priv: Private driver interface data
3233 * @oper: TDLS high-level operation. See %enum tdls_oper
3234 * @peer: Destination (peer) MAC address
3235 * Returns: 0 on success, negative (<0) on failure
3236 *
3237 * This optional function can be used to send high-level TDLS commands
3238 * to the driver.
3239 */
3240 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
3241
3242 /**
3243 * wnm_oper - Notify driver of the WNM frame reception
3244 * @priv: Private driver interface data
3245 * @oper: WNM operation. See %enum wnm_oper
3246 * @peer: Destination (peer) MAC address
3247 * @buf: Buffer for the driver to fill in (for getting IE)
3248 * @buf_len: Return the len of buf
3249 * Returns: 0 on success, negative (<0) on failure
3250 */
3251 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
3252 u8 *buf, u16 *buf_len);
3253
3254 /**
3255 * set_qos_map - Set QoS Map
3256 * @priv: Private driver interface data
3257 * @qos_map_set: QoS Map
3258 * @qos_map_set_len: Length of QoS Map
3259 */
3260 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
3261 u8 qos_map_set_len);
3262
3263 /**
3264 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3265 * @priv: Private driver interface data
3266 * @version: IP version of the IP address, 4 or 6
3267 * @ipaddr: IP address for the neigh entry
3268 * @prefixlen: IP address prefix length
3269 * @addr: Corresponding MAC address
3270 * Returns: 0 on success, negative (<0) on failure
3271 */
3272 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
3273 int prefixlen, const u8 *addr);
3274
3275 /**
3276 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3277 * @priv: Private driver interface data
3278 * @version: IP version of the IP address, 4 or 6
3279 * @ipaddr: IP address for the neigh entry
3280 * Returns: 0 on success, negative (<0) on failure
3281 */
3282 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
3283
3284 /**
3285 * br_port_set_attr - Set a bridge port attribute
3286 * @attr: Bridge port attribute to set
3287 * @val: Value to be set
3288 * Returns: 0 on success, negative (<0) on failure
3289 */
3290 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
3291 unsigned int val);
3292
3293 /**
3294 * br_port_set_attr - Set a bridge network parameter
3295 * @param: Bridge parameter to set
3296 * @val: Value to be set
3297 * Returns: 0 on success, negative (<0) on failure
3298 */
3299 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
3300 unsigned int val);
3301
3302 /**
3303 * set_wowlan - Set wake-on-wireless triggers
3304 * @priv: Private driver interface data
3305 * @triggers: wowlan triggers
3306 */
3307 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
3308
3309 /**
3310 * signal_poll - Get current connection information
3311 * @priv: Private driver interface data
3312 * @signal_info: Connection info structure
3313 */
3314 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
3315
3316 /**
3317 * set_authmode - Set authentication algorithm(s) for static WEP
3318 * @priv: Private driver interface data
3319 * @authmode: 1=Open System, 2=Shared Key, 3=both
3320 * Returns: 0 on success, -1 on failure
3321 *
3322 * This function can be used to set authentication algorithms for AP
3323 * mode when static WEP is used. If the driver uses user space MLME/SME
3324 * implementation, there is no need to implement this function.
3325 *
3326 * DEPRECATED - use set_ap() instead
3327 */
3328 int (*set_authmode)(void *priv, int authmode);
3329
3330 #ifdef ANDROID
3331 /**
3332 * driver_cmd - Execute driver-specific command
3333 * @priv: Private driver interface data
3334 * @cmd: Command to execute
3335 * @buf: Return buffer
3336 * @buf_len: Buffer length
3337 * Returns: 0 on success, -1 on failure
3338 */
3339 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
3340 #endif /* ANDROID */
3341
3342 /**
3343 * vendor_cmd - Execute vendor specific command
3344 * @priv: Private driver interface data
3345 * @vendor_id: Vendor id
3346 * @subcmd: Vendor command id
3347 * @data: Vendor command parameters (%NULL if no parameters)
3348 * @data_len: Data length
3349 * @buf: Return buffer (%NULL to ignore reply)
3350 * Returns: 0 on success, negative (<0) on failure
3351 *
3352 * This function handles vendor specific commands that are passed to
3353 * the driver/device. The command is identified by vendor id and
3354 * command id. Parameters can be passed as argument to the command
3355 * in the data buffer. Reply (if any) will be filled in the supplied
3356 * return buffer.
3357 *
3358 * The exact driver behavior is driver interface and vendor specific. As
3359 * an example, this will be converted to a vendor specific cfg80211
3360 * command in case of the nl80211 driver interface.
3361 */
3362 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3363 unsigned int subcmd, const u8 *data, size_t data_len,
3364 struct wpabuf *buf);
3365
3366 /**
3367 * set_rekey_info - Set rekey information
3368 * @priv: Private driver interface data
3369 * @kek: Current KEK
3370 * @kek_len: KEK length in octets
3371 * @kck: Current KCK
3372 * @kck_len: KCK length in octets
3373 * @replay_ctr: Current EAPOL-Key Replay Counter
3374 *
3375 * This optional function can be used to provide information for the
3376 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3377 * while the host (including wpa_supplicant) is sleeping.
3378 */
3379 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3380 const u8 *kck, size_t kck_len,
3381 const u8 *replay_ctr);
3382
3383 /**
3384 * sta_assoc - Station association indication
3385 * @priv: Private driver interface data
3386 * @own_addr: Source address and BSSID for association frame
3387 * @addr: MAC address of the station to associate
3388 * @reassoc: flag to indicate re-association
3389 * @status: association response status code
3390 * @ie: assoc response ie buffer
3391 * @len: ie buffer length
3392 * Returns: 0 on success, -1 on failure
3393 *
3394 * This function indicates the driver to send (Re)Association
3395 * Response frame to the station.
3396 */
3397 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3398 int reassoc, u16 status, const u8 *ie, size_t len);
3399
3400 /**
3401 * sta_auth - Station authentication indication
3402 * @priv: private driver interface data
3403 * @params: Station authentication parameters
3404 *
3405 * Returns: 0 on success, -1 on failure
3406 */
3407 int (*sta_auth)(void *priv,
3408 struct wpa_driver_sta_auth_params *params);
3409
3410 /**
3411 * add_tspec - Add traffic stream
3412 * @priv: Private driver interface data
3413 * @addr: MAC address of the station to associate
3414 * @tspec_ie: tspec ie buffer
3415 * @tspec_ielen: tspec ie length
3416 * Returns: 0 on success, -1 on failure
3417 *
3418 * This function adds the traffic steam for the station
3419 * and fills the medium_time in tspec_ie.
3420 */
3421 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3422 size_t tspec_ielen);
3423
3424 /**
3425 * add_sta_node - Add a station node in the driver
3426 * @priv: Private driver interface data
3427 * @addr: MAC address of the station to add
3428 * @auth_alg: authentication algorithm used by the station
3429 * Returns: 0 on success, -1 on failure
3430 *
3431 * This function adds the station node in the driver, when
3432 * the station gets added by FT-over-DS.
3433 */
3434 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
3435
3436 /**
3437 * sched_scan - Request the driver to initiate scheduled scan
3438 * @priv: Private driver interface data
3439 * @params: Scan parameters
3440 * Returns: 0 on success, -1 on failure
3441 *
3442 * This operation should be used for scheduled scan offload to
3443 * the hardware. Every time scan results are available, the
3444 * driver should report scan results event for wpa_supplicant
3445 * which will eventually request the results with
3446 * wpa_driver_get_scan_results2(). This operation is optional
3447 * and if not provided or if it returns -1, we fall back to
3448 * normal host-scheduled scans.
3449 */
3450 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
3451
3452 /**
3453 * stop_sched_scan - Request the driver to stop a scheduled scan
3454 * @priv: Private driver interface data
3455 * Returns: 0 on success, -1 on failure
3456 *
3457 * This should cause the scheduled scan to be stopped and
3458 * results should stop being sent. Must be supported if
3459 * sched_scan is supported.
3460 */
3461 int (*stop_sched_scan)(void *priv);
3462
3463 /**
3464 * poll_client - Probe (null data or such) the given station
3465 * @priv: Private driver interface data
3466 * @own_addr: MAC address of sending interface
3467 * @addr: MAC address of the station to probe
3468 * @qos: Indicates whether station is QoS station
3469 *
3470 * This function is used to verify whether an associated station is
3471 * still present. This function does not need to be implemented if the
3472 * driver provides such inactivity polling mechanism.
3473 */
3474 void (*poll_client)(void *priv, const u8 *own_addr,
3475 const u8 *addr, int qos);
3476
3477 /**
3478 * radio_disable - Disable/enable radio
3479 * @priv: Private driver interface data
3480 * @disabled: 1=disable 0=enable radio
3481 * Returns: 0 on success, -1 on failure
3482 *
3483 * This optional command is for testing purposes. It can be used to
3484 * disable the radio on a testbed device to simulate out-of-radio-range
3485 * conditions.
3486 */
3487 int (*radio_disable)(void *priv, int disabled);
3488
3489 /**
3490 * switch_channel - Announce channel switch and migrate the GO to the
3491 * given frequency
3492 * @priv: Private driver interface data
3493 * @settings: Settings for CSA period and new channel
3494 * Returns: 0 on success, -1 on failure
3495 *
3496 * This function is used to move the GO to the legacy STA channel to
3497 * avoid frequency conflict in single channel concurrency.
3498 */
3499 int (*switch_channel)(void *priv, struct csa_settings *settings);
3500
3501 /**
3502 * add_tx_ts - Add traffic stream
3503 * @priv: Private driver interface data
3504 * @tsid: Traffic stream ID
3505 * @addr: Receiver address
3506 * @user_prio: User priority of the traffic stream
3507 * @admitted_time: Admitted time for this TS in units of
3508 * 32 microsecond periods (per second).
3509 * Returns: 0 on success, -1 on failure
3510 */
3511 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3512 u16 admitted_time);
3513
3514 /**
3515 * del_tx_ts - Delete traffic stream
3516 * @priv: Private driver interface data
3517 * @tsid: Traffic stream ID
3518 * @addr: Receiver address
3519 * Returns: 0 on success, -1 on failure
3520 */
3521 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3522
3523 /**
3524 * Enable channel-switching with TDLS peer
3525 * @priv: Private driver interface data
3526 * @addr: MAC address of the TDLS peer
3527 * @oper_class: Operating class of the switch channel
3528 * @params: Channel specification
3529 * Returns: 0 on success, -1 on failure
3530 *
3531 * The function indicates to driver that it can start switching to a
3532 * different channel with a specified TDLS peer. The switching is
3533 * assumed on until canceled with tdls_disable_channel_switch().
3534 */
3535 int (*tdls_enable_channel_switch)(
3536 void *priv, const u8 *addr, u8 oper_class,
3537 const struct hostapd_freq_params *params);
3538
3539 /**
3540 * Disable channel switching with TDLS peer
3541 * @priv: Private driver interface data
3542 * @addr: MAC address of the TDLS peer
3543 * Returns: 0 on success, -1 on failure
3544 *
3545 * This function indicates to the driver that it should stop switching
3546 * with a given TDLS peer.
3547 */
3548 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3549
3550 /**
3551 * start_dfs_cac - Listen for radar interference on the channel
3552 * @priv: Private driver interface data
3553 * @freq: Channel parameters
3554 * Returns: 0 on success, -1 on failure
3555 */
3556 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
3557
3558 /**
3559 * stop_ap - Removes beacon from AP
3560 * @priv: Private driver interface data
3561 * Returns: 0 on success, -1 on failure (or if not supported)
3562 *
3563 * This optional function can be used to disable AP mode related
3564 * configuration. Unlike deinit_ap, it does not change to station
3565 * mode.
3566 */
3567 int (*stop_ap)(void *priv);
3568
3569 /**
3570 * get_survey - Retrieve survey data
3571 * @priv: Private driver interface data
3572 * @freq: If set, survey data for the specified frequency is only
3573 * being requested. If not set, all survey data is requested.
3574 * Returns: 0 on success, -1 on failure
3575 *
3576 * Use this to retrieve:
3577 *
3578 * - the observed channel noise floor
3579 * - the amount of time we have spent on the channel
3580 * - the amount of time during which we have spent on the channel that
3581 * the radio has determined the medium is busy and we cannot
3582 * transmit
3583 * - the amount of time we have spent receiving data
3584 * - the amount of time we have spent transmitting data
3585 *
3586 * This data can be used for spectrum heuristics. One example is
3587 * Automatic Channel Selection (ACS). The channel survey data is
3588 * kept on a linked list on the channel data, one entry is added
3589 * for each survey. The min_nf of the channel is updated for each
3590 * survey.
3591 */
3592 int (*get_survey)(void *priv, unsigned int freq);
3593
3594 /**
3595 * status - Get driver interface status information
3596 * @priv: Private driver interface data
3597 * @buf: Buffer for printing tou the status information
3598 * @buflen: Maximum length of the buffer
3599 * Returns: Length of written status information or -1 on failure
3600 */
3601 int (*status)(void *priv, char *buf, size_t buflen);
3602
3603 /**
3604 * roaming - Set roaming policy for driver-based BSS selection
3605 * @priv: Private driver interface data
3606 * @allowed: Whether roaming within ESS is allowed
3607 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3608 * Returns: Length of written status information or -1 on failure
3609 *
3610 * This optional callback can be used to update roaming policy from the
3611 * associate() command (bssid being set there indicates that the driver
3612 * should not roam before getting this roaming() call to allow roaming.
3613 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3614 * capability, roaming policy is handled within wpa_supplicant and there
3615 * is no need to implement or react to this callback.
3616 */
3617 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3618
3619 /**
3620 * set_mac_addr - Set MAC address
3621 * @priv: Private driver interface data
3622 * @addr: MAC address to use or %NULL for setting back to permanent
3623 * Returns: 0 on success, -1 on failure
3624 */
3625 int (*set_mac_addr)(void *priv, const u8 *addr);
3626
3627 #ifdef CONFIG_MACSEC
3628 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3629
3630 int (*macsec_deinit)(void *priv);
3631
3632 /**
3633 * macsec_get_capability - Inform MKA of this driver's capability
3634 * @priv: Private driver interface data
3635 * @cap: Driver's capability
3636 * Returns: 0 on success, -1 on failure
3637 */
3638 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);
3639
3640 /**
3641 * enable_protect_frames - Set protect frames status
3642 * @priv: Private driver interface data
3643 * @enabled: TRUE = protect frames enabled
3644 * FALSE = protect frames disabled
3645 * Returns: 0 on success, -1 on failure (or if not supported)
3646 */
3647 int (*enable_protect_frames)(void *priv, Boolean enabled);
3648
3649 /**
3650 * enable_encrypt - Set encryption status
3651 * @priv: Private driver interface data
3652 * @enabled: TRUE = encrypt outgoing traffic
3653 * FALSE = integrity-only protection on outgoing traffic
3654 * Returns: 0 on success, -1 on failure (or if not supported)
3655 */
3656 int (*enable_encrypt)(void *priv, Boolean enabled);
3657
3658 /**
3659 * set_replay_protect - Set replay protect status and window size
3660 * @priv: Private driver interface data
3661 * @enabled: TRUE = replay protect enabled
3662 * FALSE = replay protect disabled
3663 * @window: replay window size, valid only when replay protect enabled
3664 * Returns: 0 on success, -1 on failure (or if not supported)
3665 */
3666 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3667
3668 /**
3669 * set_current_cipher_suite - Set current cipher suite
3670 * @priv: Private driver interface data
3671 * @cs: EUI64 identifier
3672 * Returns: 0 on success, -1 on failure (or if not supported)
3673 */
3674 int (*set_current_cipher_suite)(void *priv, u64 cs);
3675
3676 /**
3677 * enable_controlled_port - Set controlled port status
3678 * @priv: Private driver interface data
3679 * @enabled: TRUE = controlled port enabled
3680 * FALSE = controlled port disabled
3681 * Returns: 0 on success, -1 on failure (or if not supported)
3682 */
3683 int (*enable_controlled_port)(void *priv, Boolean enabled);
3684
3685 /**
3686 * get_receive_lowest_pn - Get receive lowest pn
3687 * @priv: Private driver interface data
3688 * @sa: secure association
3689 * Returns: 0 on success, -1 on failure (or if not supported)
3690 */
3691 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);
3692
3693 /**
3694 * get_transmit_next_pn - Get transmit next pn
3695 * @priv: Private driver interface data
3696 * @sa: secure association
3697 * Returns: 0 on success, -1 on failure (or if not supported)
3698 */
3699 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);
3700
3701 /**
3702 * set_transmit_next_pn - Set transmit next pn
3703 * @priv: Private driver interface data
3704 * @sa: secure association
3705 * Returns: 0 on success, -1 on failure (or if not supported)
3706 */
3707 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);
3708
3709 /**
3710 * create_receive_sc - create secure channel for receiving
3711 * @priv: Private driver interface data
3712 * @sc: secure channel
3713 * @conf_offset: confidentiality offset (0, 30, or 50)
3714 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3715 * 2 = Strict)
3716 * Returns: 0 on success, -1 on failure (or if not supported)
3717 */
3718 int (*create_receive_sc)(void *priv, struct receive_sc *sc,
3719 unsigned int conf_offset,
3720 int validation);
3721
3722 /**
3723 * delete_receive_sc - delete secure connection for receiving
3724 * @priv: private driver interface data from init()
3725 * @sc: secure channel
3726 * Returns: 0 on success, -1 on failure
3727 */
3728 int (*delete_receive_sc)(void *priv, struct receive_sc *sc);
3729
3730 /**
3731 * create_receive_sa - create secure association for receive
3732 * @priv: private driver interface data from init()
3733 * @sa: secure association
3734 * Returns: 0 on success, -1 on failure
3735 */
3736 int (*create_receive_sa)(void *priv, struct receive_sa *sa);
3737
3738 /**
3739 * delete_receive_sa - Delete secure association for receive
3740 * @priv: Private driver interface data from init()
3741 * @sa: Secure association
3742 * Returns: 0 on success, -1 on failure
3743 */
3744 int (*delete_receive_sa)(void *priv, struct receive_sa *sa);
3745
3746 /**
3747 * enable_receive_sa - enable the SA for receive
3748 * @priv: private driver interface data from init()
3749 * @sa: secure association
3750 * Returns: 0 on success, -1 on failure
3751 */
3752 int (*enable_receive_sa)(void *priv, struct receive_sa *sa);
3753
3754 /**
3755 * disable_receive_sa - disable SA for receive
3756 * @priv: private driver interface data from init()
3757 * @sa: secure association
3758 * Returns: 0 on success, -1 on failure
3759 */
3760 int (*disable_receive_sa)(void *priv, struct receive_sa *sa);
3761
3762 /**
3763 * create_transmit_sc - create secure connection for transmit
3764 * @priv: private driver interface data from init()
3765 * @sc: secure channel
3766 * @conf_offset: confidentiality offset (0, 30, or 50)
3767 * Returns: 0 on success, -1 on failure
3768 */
3769 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
3770 unsigned int conf_offset);
3771
3772 /**
3773 * delete_transmit_sc - delete secure connection for transmit
3774 * @priv: private driver interface data from init()
3775 * @sc: secure channel
3776 * Returns: 0 on success, -1 on failure
3777 */
3778 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);
3779
3780 /**
3781 * create_transmit_sa - create secure association for transmit
3782 * @priv: private driver interface data from init()
3783 * @sa: secure association
3784 * Returns: 0 on success, -1 on failure
3785 */
3786 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);
3787
3788 /**
3789 * delete_transmit_sa - Delete secure association for transmit
3790 * @priv: Private driver interface data from init()
3791 * @sa: Secure association
3792 * Returns: 0 on success, -1 on failure
3793 */
3794 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);
3795
3796 /**
3797 * enable_transmit_sa - enable SA for transmit
3798 * @priv: private driver interface data from init()
3799 * @sa: secure association
3800 * Returns: 0 on success, -1 on failure
3801 */
3802 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);
3803
3804 /**
3805 * disable_transmit_sa - disable SA for transmit
3806 * @priv: private driver interface data from init()
3807 * @sa: secure association
3808 * Returns: 0 on success, -1 on failure
3809 */
3810 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
3811 #endif /* CONFIG_MACSEC */
3812
3813 /**
3814 * init_mesh - Driver specific initialization for mesh
3815 * @priv: Private driver interface data
3816 * Returns: 0 on success, -1 on failure
3817 */
3818 int (*init_mesh)(void *priv);
3819
3820 /**
3821 * join_mesh - Join a mesh network
3822 * @priv: Private driver interface data
3823 * @params: Mesh configuration parameters
3824 * Returns: 0 on success, -1 on failure
3825 */
3826 int (*join_mesh)(void *priv,
3827 struct wpa_driver_mesh_join_params *params);
3828
3829 /**
3830 * leave_mesh - Leave a mesh network
3831 * @priv: Private driver interface data
3832 * Returns 0 on success, -1 on failure
3833 */
3834 int (*leave_mesh)(void *priv);
3835
3836 /**
3837 * do_acs - Automatically select channel
3838 * @priv: Private driver interface data
3839 * @params: Parameters for ACS
3840 * Returns 0 on success, -1 on failure
3841 *
3842 * This command can be used to offload ACS to the driver if the driver
3843 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3844 */
3845 int (*do_acs)(void *priv, struct drv_acs_params *params);
3846
3847 /**
3848 * set_band - Notify driver of band selection
3849 * @priv: Private driver interface data
3850 * @band: The selected band(s)
3851 * Returns 0 on success, -1 on failure
3852 */
3853 int (*set_band)(void *priv, enum set_band band);
3854
3855 /**
3856 * get_pref_freq_list - Get preferred frequency list for an interface
3857 * @priv: Private driver interface data
3858 * @if_type: Interface type
3859 * @num: Number of channels
3860 * @freq_list: Preferred channel frequency list encoded in MHz values
3861 * Returns 0 on success, -1 on failure
3862 *
3863 * This command can be used to query the preferred frequency list from
3864 * the driver specific to a particular interface type.
3865 */
3866 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
3867 unsigned int *num, unsigned int *freq_list);
3868
3869 /**
3870 * set_prob_oper_freq - Indicate probable P2P operating channel
3871 * @priv: Private driver interface data
3872 * @freq: Channel frequency in MHz
3873 * Returns 0 on success, -1 on failure
3874 *
3875 * This command can be used to inform the driver of the operating
3876 * frequency that an ongoing P2P group formation is likely to come up
3877 * on. Local device is assuming P2P Client role.
3878 */
3879 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
3880
3881 /**
3882 * abort_scan - Request the driver to abort an ongoing scan
3883 * @priv: Private driver interface data
3884 * @scan_cookie: Cookie identifying the scan request. This is used only
3885 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
3886 * was used to trigger scan. Otherwise, 0 is used.
3887 * Returns 0 on success, -1 on failure
3888 */
3889 int (*abort_scan)(void *priv, u64 scan_cookie);
3890
3891 /**
3892 * configure_data_frame_filters - Request to configure frame filters
3893 * @priv: Private driver interface data
3894 * @filter_flags: The type of frames to filter (bitfield of
3895 * WPA_DATA_FRAME_FILTER_FLAG_*)
3896 * Returns: 0 on success or -1 on failure
3897 */
3898 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
3899
3900 /**
3901 * get_ext_capab - Get extended capabilities for the specified interface
3902 * @priv: Private driver interface data
3903 * @type: Interface type for which to get extended capabilities
3904 * @ext_capab: Extended capabilities fetched
3905 * @ext_capab_mask: Extended capabilities mask
3906 * @ext_capab_len: Length of the extended capabilities
3907 * Returns: 0 on success or -1 on failure
3908 */
3909 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
3910 const u8 **ext_capab, const u8 **ext_capab_mask,
3911 unsigned int *ext_capab_len);
3912
3913 /**
3914 * p2p_lo_start - Start offloading P2P listen to device
3915 * @priv: Private driver interface data
3916 * @freq: Listening frequency (MHz) for P2P listen
3917 * @period: Length of the listen operation in milliseconds
3918 * @interval: Interval for running the listen operation in milliseconds
3919 * @count: Number of times to run the listen operation
3920 * @device_types: Device primary and secondary types
3921 * @dev_types_len: Number of bytes for device_types
3922 * @ies: P2P IE and WSC IE for Probe Response frames
3923 * @ies_len: Length of ies in bytes
3924 * Returns: 0 on success or -1 on failure
3925 */
3926 int (*p2p_lo_start)(void *priv, unsigned int freq,
3927 unsigned int period, unsigned int interval,
3928 unsigned int count,
3929 const u8 *device_types, size_t dev_types_len,
3930 const u8 *ies, size_t ies_len);
3931
3932 /**
3933 * p2p_lo_stop - Stop P2P listen offload
3934 * @priv: Private driver interface data
3935 * Returns: 0 on success or -1 on failure
3936 */
3937 int (*p2p_lo_stop)(void *priv);
3938
3939 /**
3940 * set_default_scan_ies - Set default scan IEs
3941 * @priv: Private driver interface data
3942 * @ies: Scan default IEs buffer
3943 * @ies_len: Length of IEs in bytes
3944 * Returns: 0 on success or -1 on failure
3945 *
3946 * The driver can use these by default when there are no scan IEs coming
3947 * in the subsequent scan requests. Also in case of one or more of IEs
3948 * given in set_default_scan_ies() are missing in the subsequent scan
3949 * request, the driver should merge the missing scan IEs in the scan
3950 * request from the IEs set by set_default_scan_ies() in the Probe
3951 * Request frames sent.
3952 */
3953 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
3954
3955 /**
3956 * set_tdls_mode - Set TDLS trigger mode to the host driver
3957 * @priv: Private driver interface data
3958 * @tdls_external_control: Represents if TDLS external trigger control
3959 * mode is enabled/disabled.
3960 *
3961 * This optional callback can be used to configure the TDLS external
3962 * trigger control mode to the host driver.
3963 */
3964 int (*set_tdls_mode)(void *priv, int tdls_external_control);
3965
3966 /**
3967 * get_bss_transition_status - Get candidate BSS's transition status
3968 * @priv: Private driver interface data
3969 * @params: Candidate BSS list
3970 *
3971 * Get the accept or reject reason code for a list of BSS transition
3972 * candidates.
3973 */
3974 struct wpa_bss_candidate_info *
3975 (*get_bss_transition_status)(void *priv,
3976 struct wpa_bss_trans_info *params);
3977 /**
3978 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
3979 * @priv: Private driver interface data
3980 * @ignore_disallow: 0 to not ignore, 1 to ignore
3981 * Returns: 0 on success, -1 on failure
3982 */
3983 int (*ignore_assoc_disallow)(void *priv, int ignore_disallow);
3984
3985 /**
3986 * set_bssid_blacklist - Set blacklist of BSSIDs to the driver
3987 * @priv: Private driver interface data
3988 * @num_bssid: Number of blacklist BSSIDs
3989 * @bssids: List of blacklisted BSSIDs
3990 */
3991 int (*set_bssid_blacklist)(void *priv, unsigned int num_bssid,
3992 const u8 *bssid);
3993 };
3994
3995 /**
3996 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3997 */
3998 enum wpa_event_type {
3999 /**
4000 * EVENT_ASSOC - Association completed
4001 *
4002 * This event needs to be delivered when the driver completes IEEE
4003 * 802.11 association or reassociation successfully.
4004 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
4005 * after this event has been generated. In addition, optional
4006 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
4007 * more information about the association. If the driver interface gets
4008 * both of these events at the same time, it can also include the
4009 * assoc_info data in EVENT_ASSOC call.
4010 */
4011 EVENT_ASSOC,
4012
4013 /**
4014 * EVENT_DISASSOC - Association lost
4015 *
4016 * This event should be called when association is lost either due to
4017 * receiving deauthenticate or disassociate frame from the AP or when
4018 * sending either of these frames to the current AP. If the driver
4019 * supports separate deauthentication event, EVENT_DISASSOC should only
4020 * be used for disassociation and EVENT_DEAUTH for deauthentication.
4021 * In AP mode, union wpa_event_data::disassoc_info is required.
4022 */
4023 EVENT_DISASSOC,
4024
4025 /**
4026 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
4027 *
4028 * This event must be delivered when a Michael MIC error is detected by
4029 * the local driver. Additional data for event processing is
4030 * provided with union wpa_event_data::michael_mic_failure. This
4031 * information is used to request new encyption key and to initiate
4032 * TKIP countermeasures if needed.
4033 */
4034 EVENT_MICHAEL_MIC_FAILURE,
4035
4036 /**
4037 * EVENT_SCAN_RESULTS - Scan results available
4038 *
4039 * This event must be called whenever scan results are available to be
4040 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4041 * is expected to be used some time after struct wpa_driver_ops::scan()
4042 * is called. If the driver provides an unsolicited event when the scan
4043 * has been completed, this event can be used to trigger
4044 * EVENT_SCAN_RESULTS call. If such event is not available from the
4045 * driver, the driver wrapper code is expected to use a registered
4046 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
4047 * scan is expected to be completed. Optional information about
4048 * completed scan can be provided with union wpa_event_data::scan_info.
4049 */
4050 EVENT_SCAN_RESULTS,
4051
4052 /**
4053 * EVENT_ASSOCINFO - Report optional extra information for association
4054 *
4055 * This event can be used to report extra association information for
4056 * EVENT_ASSOC processing. This extra information includes IEs from
4057 * association frames and Beacon/Probe Response frames in union
4058 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4059 * EVENT_ASSOC. Alternatively, the driver interface can include
4060 * assoc_info data in the EVENT_ASSOC call if it has all the
4061 * information available at the same point.
4062 */
4063 EVENT_ASSOCINFO,
4064
4065 /**
4066 * EVENT_INTERFACE_STATUS - Report interface status changes
4067 *
4068 * This optional event can be used to report changes in interface
4069 * status (interface added/removed) using union
4070 * wpa_event_data::interface_status. This can be used to trigger
4071 * wpa_supplicant to stop and re-start processing for the interface,
4072 * e.g., when a cardbus card is ejected/inserted.
4073 */
4074 EVENT_INTERFACE_STATUS,
4075
4076 /**
4077 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4078 *
4079 * This event can be used to inform wpa_supplicant about candidates for
4080 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4081 * for scan request (ap_scan=2 mode), this event is required for
4082 * pre-authentication. If wpa_supplicant is performing scan request
4083 * (ap_scan=1), this event is optional since scan results can be used
4084 * to add pre-authentication candidates. union
4085 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4086 * candidate and priority of the candidate, e.g., based on the signal
4087 * strength, in order to try to pre-authenticate first with candidates
4088 * that are most likely targets for re-association.
4089 *
4090 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4091 * on the candidate list. In addition, it can be called for the current
4092 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4093 * will automatically skip pre-authentication in cases where a valid
4094 * PMKSA exists. When more than one candidate exists, this event should
4095 * be generated once for each candidate.
4096 *
4097 * Driver will be notified about successful pre-authentication with
4098 * struct wpa_driver_ops::add_pmkid() calls.
4099 */
4100 EVENT_PMKID_CANDIDATE,
4101
4102 /**
4103 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
4104 *
4105 * This event can be used to inform wpa_supplicant about desire to set
4106 * up secure direct link connection between two stations as defined in
4107 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
4108 * STAKey negotiation. The caller will need to set peer address for the
4109 * event.
4110 */
4111 EVENT_STKSTART,
4112
4113 /**
4114 * EVENT_TDLS - Request TDLS operation
4115 *
4116 * This event can be used to request a TDLS operation to be performed.
4117 */
4118 EVENT_TDLS,
4119
4120 /**
4121 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4122 *
4123 * The driver is expected to report the received FT IEs from
4124 * FT authentication sequence from the AP. The FT IEs are included in
4125 * the extra information in union wpa_event_data::ft_ies.
4126 */
4127 EVENT_FT_RESPONSE,
4128
4129 /**
4130 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4131 *
4132 * The driver can use this event to inform wpa_supplicant about a STA
4133 * in an IBSS with which protected frames could be exchanged. This
4134 * event starts RSN authentication with the other STA to authenticate
4135 * the STA and set up encryption keys with it.
4136 */
4137 EVENT_IBSS_RSN_START,
4138
4139 /**
4140 * EVENT_AUTH - Authentication result
4141 *
4142 * This event should be called when authentication attempt has been
4143 * completed. This is only used if the driver supports separate
4144 * authentication step (struct wpa_driver_ops::authenticate).
4145 * Information about authentication result is included in
4146 * union wpa_event_data::auth.
4147 */
4148 EVENT_AUTH,
4149
4150 /**
4151 * EVENT_DEAUTH - Authentication lost
4152 *
4153 * This event should be called when authentication is lost either due
4154 * to receiving deauthenticate frame from the AP or when sending that
4155 * frame to the current AP.
4156 * In AP mode, union wpa_event_data::deauth_info is required.
4157 */
4158 EVENT_DEAUTH,
4159
4160 /**
4161 * EVENT_ASSOC_REJECT - Association rejected
4162 *
4163 * This event should be called when (re)association attempt has been
4164 * rejected by the AP. Information about the association response is
4165 * included in union wpa_event_data::assoc_reject.
4166 */
4167 EVENT_ASSOC_REJECT,
4168
4169 /**
4170 * EVENT_AUTH_TIMED_OUT - Authentication timed out
4171 */
4172 EVENT_AUTH_TIMED_OUT,
4173
4174 /**
4175 * EVENT_ASSOC_TIMED_OUT - Association timed out
4176 */
4177 EVENT_ASSOC_TIMED_OUT,
4178
4179 /**
4180 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
4181 */
4182 EVENT_WPS_BUTTON_PUSHED,
4183
4184 /**
4185 * EVENT_TX_STATUS - Report TX status
4186 */
4187 EVENT_TX_STATUS,
4188
4189 /**
4190 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
4191 */
4192 EVENT_RX_FROM_UNKNOWN,
4193
4194 /**
4195 * EVENT_RX_MGMT - Report RX of a management frame
4196 */
4197 EVENT_RX_MGMT,
4198
4199 /**
4200 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
4201 *
4202 * This event is used to indicate when the driver has started the
4203 * requested remain-on-channel duration. Information about the
4204 * operation is included in union wpa_event_data::remain_on_channel.
4205 */
4206 EVENT_REMAIN_ON_CHANNEL,
4207
4208 /**
4209 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
4210 *
4211 * This event is used to indicate when the driver has completed
4212 * remain-on-channel duration, i.e., may noot be available on the
4213 * requested channel anymore. Information about the
4214 * operation is included in union wpa_event_data::remain_on_channel.
4215 */
4216 EVENT_CANCEL_REMAIN_ON_CHANNEL,
4217
4218 /**
4219 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
4220 *
4221 * This event is used to indicate when a Probe Request frame has been
4222 * received. Information about the received frame is included in
4223 * union wpa_event_data::rx_probe_req. The driver is required to report
4224 * these events only after successfully completed probe_req_report()
4225 * commands to request the events (i.e., report parameter is non-zero)
4226 * in station mode. In AP mode, Probe Request frames should always be
4227 * reported.
4228 */
4229 EVENT_RX_PROBE_REQ,
4230
4231 /**
4232 * EVENT_NEW_STA - New wired device noticed
4233 *
4234 * This event is used to indicate that a new device has been detected
4235 * in a network that does not use association-like functionality (i.e.,
4236 * mainly wired Ethernet). This can be used to start EAPOL
4237 * authenticator when receiving a frame from a device. The address of
4238 * the device is included in union wpa_event_data::new_sta.
4239 */
4240 EVENT_NEW_STA,
4241
4242 /**
4243 * EVENT_EAPOL_RX - Report received EAPOL frame
4244 *
4245 * When in AP mode with hostapd, this event is required to be used to
4246 * deliver the receive EAPOL frames from the driver.
4247 */
4248 EVENT_EAPOL_RX,
4249
4250 /**
4251 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4252 *
4253 * This event is used to indicate changes in the signal strength
4254 * observed in frames received from the current AP if signal strength
4255 * monitoring has been enabled with signal_monitor().
4256 */
4257 EVENT_SIGNAL_CHANGE,
4258
4259 /**
4260 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4261 *
4262 * This event is used to indicate that the interface was enabled after
4263 * having been previously disabled, e.g., due to rfkill.
4264 */
4265 EVENT_INTERFACE_ENABLED,
4266
4267 /**
4268 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4269 *
4270 * This event is used to indicate that the interface was disabled,
4271 * e.g., due to rfkill.
4272 */
4273 EVENT_INTERFACE_DISABLED,
4274
4275 /**
4276 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4277 *
4278 * This event is used to indicate that the channel list has changed,
4279 * e.g., because of a regulatory domain change triggered by scan
4280 * results including an AP advertising a country code.
4281 */
4282 EVENT_CHANNEL_LIST_CHANGED,
4283
4284 /**
4285 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4286 *
4287 * This event is used to indicate that the driver cannot maintain this
4288 * interface in its operation mode anymore. The most likely use for
4289 * this is to indicate that AP mode operation is not available due to
4290 * operating channel would need to be changed to a DFS channel when
4291 * the driver does not support radar detection and another virtual
4292 * interfaces caused the operating channel to change. Other similar
4293 * resource conflicts could also trigger this for station mode
4294 * interfaces. This event can be propagated when channel switching
4295 * fails.
4296 */
4297 EVENT_INTERFACE_UNAVAILABLE,
4298
4299 /**
4300 * EVENT_BEST_CHANNEL
4301 *
4302 * Driver generates this event whenever it detects a better channel
4303 * (e.g., based on RSSI or channel use). This information can be used
4304 * to improve channel selection for a new AP/P2P group.
4305 */
4306 EVENT_BEST_CHANNEL,
4307
4308 /**
4309 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4310 *
4311 * This event should be called when a Deauthentication frame is dropped
4312 * due to it not being protected (MFP/IEEE 802.11w).
4313 * union wpa_event_data::unprot_deauth is required to provide more
4314 * details of the frame.
4315 */
4316 EVENT_UNPROT_DEAUTH,
4317
4318 /**
4319 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4320 *
4321 * This event should be called when a Disassociation frame is dropped
4322 * due to it not being protected (MFP/IEEE 802.11w).
4323 * union wpa_event_data::unprot_disassoc is required to provide more
4324 * details of the frame.
4325 */
4326 EVENT_UNPROT_DISASSOC,
4327
4328 /**
4329 * EVENT_STATION_LOW_ACK
4330 *
4331 * Driver generates this event whenever it detected that a particular
4332 * station was lost. Detection can be through massive transmission
4333 * failures for example.
4334 */
4335 EVENT_STATION_LOW_ACK,
4336
4337 /**
4338 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4339 */
4340 EVENT_IBSS_PEER_LOST,
4341
4342 /**
4343 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4344 *
4345 * This event carries the new replay counter to notify wpa_supplicant
4346 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4347 * completed Group Key Handshake while the host (including
4348 * wpa_supplicant was sleeping).
4349 */
4350 EVENT_DRIVER_GTK_REKEY,
4351
4352 /**
4353 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4354 */
4355 EVENT_SCHED_SCAN_STOPPED,
4356
4357 /**
4358 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4359 *
4360 * This event indicates that the station responded to the poll
4361 * initiated with @poll_client.
4362 */
4363 EVENT_DRIVER_CLIENT_POLL_OK,
4364
4365 /**
4366 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4367 */
4368 EVENT_EAPOL_TX_STATUS,
4369
4370 /**
4371 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4372 *
4373 * Described in wpa_event_data.ch_switch
4374 * */
4375 EVENT_CH_SWITCH,
4376
4377 /**
4378 * EVENT_WNM - Request WNM operation
4379 *
4380 * This event can be used to request a WNM operation to be performed.
4381 */
4382 EVENT_WNM,
4383
4384 /**
4385 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4386 *
4387 * This event indicates that the driver reported a connection failure
4388 * with the specified client (for example, max client reached, etc.) in
4389 * AP mode.
4390 */
4391 EVENT_CONNECT_FAILED_REASON,
4392
4393 /**
4394 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
4395 *
4396 * A radar has been detected on the supplied frequency, hostapd should
4397 * react accordingly (e.g., change channel).
4398 */
4399 EVENT_DFS_RADAR_DETECTED,
4400
4401 /**
4402 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
4403 *
4404 * After a successful CAC, the channel can be marked clear and used.
4405 */
4406 EVENT_DFS_CAC_FINISHED,
4407
4408 /**
4409 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
4410 *
4411 * The CAC was not successful, and the channel remains in the previous
4412 * state. This may happen due to a radar being detected or other
4413 * external influences.
4414 */
4415 EVENT_DFS_CAC_ABORTED,
4416
4417 /**
4418 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
4419 *
4420 * The channel which was previously unavailable is now available again.
4421 */
4422 EVENT_DFS_NOP_FINISHED,
4423
4424 /**
4425 * EVENT_SURVEY - Received survey data
4426 *
4427 * This event gets triggered when a driver query is issued for survey
4428 * data and the requested data becomes available. The returned data is
4429 * stored in struct survey_results. The results provide at most one
4430 * survey entry for each frequency and at minimum will provide one
4431 * survey entry for one frequency. The survey data can be os_malloc()'d
4432 * and then os_free()'d, so the event callback must only copy data.
4433 */
4434 EVENT_SURVEY,
4435
4436 /**
4437 * EVENT_SCAN_STARTED - Scan started
4438 *
4439 * This indicates that driver has started a scan operation either based
4440 * on a request from wpa_supplicant/hostapd or from another application.
4441 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4442 * completed (either successfully or by getting cancelled).
4443 */
4444 EVENT_SCAN_STARTED,
4445
4446 /**
4447 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4448 *
4449 * This event indicates a set of frequency ranges that should be avoided
4450 * to reduce issues due to interference or internal co-existence
4451 * information in the driver.
4452 */
4453 EVENT_AVOID_FREQUENCIES,
4454
4455 /**
4456 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4457 */
4458 EVENT_NEW_PEER_CANDIDATE,
4459
4460 /**
4461 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4462 *
4463 * Indicates a pair of primary and secondary channels chosen by ACS
4464 * in device.
4465 */
4466 EVENT_ACS_CHANNEL_SELECTED,
4467
4468 /**
4469 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4470 * been started.
4471 *
4472 * This event indicates that channel availability check has been started
4473 * on a DFS frequency by a driver that supports DFS Offload.
4474 */
4475 EVENT_DFS_CAC_STARTED,
4476
4477 /**
4478 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4479 */
4480 EVENT_P2P_LO_STOP,
4481
4482 /**
4483 * EVENT_BEACON_LOSS - Beacon loss detected
4484 *
4485 * This event indicates that no Beacon frames has been received from
4486 * the current AP. This may indicate that the AP is not anymore in
4487 * range.
4488 */
4489 EVENT_BEACON_LOSS,
4490
4491 /**
4492 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
4493 * done previously (Pre-CAC) on the channel has expired. This would
4494 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
4495 * channel will be moved from available to usable. A new CAC has to be
4496 * performed before start operating on this channel.
4497 */
4498 EVENT_DFS_PRE_CAC_EXPIRED,
4499 };
4500
4501
4502 /**
4503 * struct freq_survey - Channel survey info
4504 *
4505 * @ifidx: Interface index in which this survey was observed
4506 * @freq: Center of frequency of the surveyed channel
4507 * @nf: Channel noise floor in dBm
4508 * @channel_time: Amount of time in ms the radio spent on the channel
4509 * @channel_time_busy: Amount of time in ms the radio detected some signal
4510 * that indicated to the radio the channel was not clear
4511 * @channel_time_rx: Amount of time the radio spent receiving data
4512 * @channel_time_tx: Amount of time the radio spent transmitting data
4513 * @filled: bitmask indicating which fields have been reported, see
4514 * SURVEY_HAS_* defines.
4515 * @list: Internal list pointers
4516 */
4517 struct freq_survey {
4518 u32 ifidx;
4519 unsigned int freq;
4520 s8 nf;
4521 u64 channel_time;
4522 u64 channel_time_busy;
4523 u64 channel_time_rx;
4524 u64 channel_time_tx;
4525 unsigned int filled;
4526 struct dl_list list;
4527 };
4528
4529 #define SURVEY_HAS_NF BIT(0)
4530 #define SURVEY_HAS_CHAN_TIME BIT(1)
4531 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4532 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4533 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4534
4535
4536 /**
4537 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4538 */
4539 union wpa_event_data {
4540 /**
4541 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4542 *
4543 * This structure is optional for EVENT_ASSOC calls and required for
4544 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4545 * driver interface does not need to generate separate EVENT_ASSOCINFO
4546 * calls.
4547 */
4548 struct assoc_info {
4549 /**
4550 * reassoc - Flag to indicate association or reassociation
4551 */
4552 int reassoc;
4553
4554 /**
4555 * req_ies - (Re)Association Request IEs
4556 *
4557 * If the driver generates WPA/RSN IE, this event data must be
4558 * returned for WPA handshake to have needed information. If
4559 * wpa_supplicant-generated WPA/RSN IE is used, this
4560 * information event is optional.
4561 *
4562 * This should start with the first IE (fixed fields before IEs
4563 * are not included).
4564 */
4565 const u8 *req_ies;
4566
4567 /**
4568 * req_ies_len - Length of req_ies in bytes
4569 */
4570 size_t req_ies_len;
4571
4572 /**
4573 * resp_ies - (Re)Association Response IEs
4574 *
4575 * Optional association data from the driver. This data is not
4576 * required WPA, but may be useful for some protocols and as
4577 * such, should be reported if this is available to the driver
4578 * interface.
4579 *
4580 * This should start with the first IE (fixed fields before IEs
4581 * are not included).
4582 */
4583 const u8 *resp_ies;
4584
4585 /**
4586 * resp_ies_len - Length of resp_ies in bytes
4587 */
4588 size_t resp_ies_len;
4589
4590 /**
4591 * resp_frame - (Re)Association Response frame
4592 */
4593 const u8 *resp_frame;
4594
4595 /**
4596 * resp_frame_len - (Re)Association Response frame length
4597 */
4598 size_t resp_frame_len;
4599
4600 /**
4601 * beacon_ies - Beacon or Probe Response IEs
4602 *
4603 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4604 * Probe Response frames from the current AP (i.e., the one
4605 * that the client just associated with). This information is
4606 * used to update WPA/RSN IE for the AP. If this field is not
4607 * set, the results from previous scan will be used. If no
4608 * data for the new AP is found, scan results will be requested
4609 * again (without scan request). At this point, the driver is
4610 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4611 * used).
4612 *
4613 * This should start with the first IE (fixed fields before IEs
4614 * are not included).
4615 */
4616 const u8 *beacon_ies;
4617
4618 /**
4619 * beacon_ies_len - Length of beacon_ies */
4620 size_t beacon_ies_len;
4621
4622 /**
4623 * freq - Frequency of the operational channel in MHz
4624 */
4625 unsigned int freq;
4626
4627 /**
4628 * wmm_params - WMM parameters used in this association.
4629 */
4630 struct wmm_params wmm_params;
4631
4632 /**
4633 * addr - Station address (for AP mode)
4634 */
4635 const u8 *addr;
4636
4637 /**
4638 * The following is the key management offload information
4639 * @authorized
4640 * @key_replay_ctr
4641 * @key_replay_ctr_len
4642 * @ptk_kck
4643 * @ptk_kek_len
4644 * @ptk_kek
4645 * @ptk_kek_len
4646 */
4647
4648 /**
4649 * authorized - Status of key management offload,
4650 * 1 = successful
4651 */
4652 int authorized;
4653
4654 /**
4655 * key_replay_ctr - Key replay counter value last used
4656 * in a valid EAPOL-Key frame
4657 */
4658 const u8 *key_replay_ctr;
4659
4660 /**
4661 * key_replay_ctr_len - The length of key_replay_ctr
4662 */
4663 size_t key_replay_ctr_len;
4664
4665 /**
4666 * ptk_kck - The derived PTK KCK
4667 */
4668 const u8 *ptk_kck;
4669
4670 /**
4671 * ptk_kek_len - The length of ptk_kck
4672 */
4673 size_t ptk_kck_len;
4674
4675 /**
4676 * ptk_kek - The derived PTK KEK
4677 * This is used in key management offload and also in FILS SK
4678 * offload.
4679 */
4680 const u8 *ptk_kek;
4681
4682 /**
4683 * ptk_kek_len - The length of ptk_kek
4684 */
4685 size_t ptk_kek_len;
4686
4687 /**
4688 * subnet_status - The subnet status:
4689 * 0 = unknown, 1 = unchanged, 2 = changed
4690 */
4691 u8 subnet_status;
4692
4693 /**
4694 * The following information is used in FILS SK offload
4695 * @fils_erp_next_seq_num
4696 * @fils_pmk
4697 * @fils_pmk_len
4698 * @fils_pmkid
4699 */
4700
4701 /**
4702 * fils_erp_next_seq_num - The next sequence number to use in
4703 * FILS ERP messages
4704 */
4705 u16 fils_erp_next_seq_num;
4706
4707 /**
4708 * fils_pmk - A new PMK if generated in case of FILS
4709 * authentication
4710 */
4711 const u8 *fils_pmk;
4712
4713 /**
4714 * fils_pmk_len - Length of fils_pmk
4715 */
4716 size_t fils_pmk_len;
4717
4718 /**
4719 * fils_pmkid - PMKID used or generated in FILS authentication
4720 */
4721 const u8 *fils_pmkid;
4722 } assoc_info;
4723
4724 /**
4725 * struct disassoc_info - Data for EVENT_DISASSOC events
4726 */
4727 struct disassoc_info {
4728 /**
4729 * addr - Station address (for AP mode)
4730 */
4731 const u8 *addr;
4732
4733 /**
4734 * reason_code - Reason Code (host byte order) used in
4735 * Deauthentication frame
4736 */
4737 u16 reason_code;
4738
4739 /**
4740 * ie - Optional IE(s) in Disassociation frame
4741 */
4742 const u8 *ie;
4743
4744 /**
4745 * ie_len - Length of ie buffer in octets
4746 */
4747 size_t ie_len;
4748
4749 /**
4750 * locally_generated - Whether the frame was locally generated
4751 */
4752 int locally_generated;
4753 } disassoc_info;
4754
4755 /**
4756 * struct deauth_info - Data for EVENT_DEAUTH events
4757 */
4758 struct deauth_info {
4759 /**
4760 * addr - Station address (for AP mode)
4761 */
4762 const u8 *addr;
4763
4764 /**
4765 * reason_code - Reason Code (host byte order) used in
4766 * Deauthentication frame
4767 */
4768 u16 reason_code;
4769
4770 /**
4771 * ie - Optional IE(s) in Deauthentication frame
4772 */
4773 const u8 *ie;
4774
4775 /**
4776 * ie_len - Length of ie buffer in octets
4777 */
4778 size_t ie_len;
4779
4780 /**
4781 * locally_generated - Whether the frame was locally generated
4782 */
4783 int locally_generated;
4784 } deauth_info;
4785
4786 /**
4787 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4788 */
4789 struct michael_mic_failure {
4790 int unicast;
4791 const u8 *src;
4792 } michael_mic_failure;
4793
4794 /**
4795 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4796 */
4797 struct interface_status {
4798 unsigned int ifindex;
4799 char ifname[100];
4800 enum {
4801 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4802 } ievent;
4803 } interface_status;
4804
4805 /**
4806 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4807 */
4808 struct pmkid_candidate {
4809 /** BSSID of the PMKID candidate */
4810 u8 bssid[ETH_ALEN];
4811 /** Smaller the index, higher the priority */
4812 int index;
4813 /** Whether RSN IE includes pre-authenticate flag */
4814 int preauth;
4815 } pmkid_candidate;
4816
4817 /**
4818 * struct stkstart - Data for EVENT_STKSTART
4819 */
4820 struct stkstart {
4821 u8 peer[ETH_ALEN];
4822 } stkstart;
4823
4824 /**
4825 * struct tdls - Data for EVENT_TDLS
4826 */
4827 struct tdls {
4828 u8 peer[ETH_ALEN];
4829 enum {
4830 TDLS_REQUEST_SETUP,
4831 TDLS_REQUEST_TEARDOWN,
4832 TDLS_REQUEST_DISCOVER,
4833 } oper;
4834 u16 reason_code; /* for teardown */
4835 } tdls;
4836
4837 /**
4838 * struct wnm - Data for EVENT_WNM
4839 */
4840 struct wnm {
4841 u8 addr[ETH_ALEN];
4842 enum {
4843 WNM_OPER_SLEEP,
4844 } oper;
4845 enum {
4846 WNM_SLEEP_ENTER,
4847 WNM_SLEEP_EXIT
4848 } sleep_action;
4849 int sleep_intval;
4850 u16 reason_code;
4851 u8 *buf;
4852 u16 buf_len;
4853 } wnm;
4854
4855 /**
4856 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4857 *
4858 * During FT (IEEE 802.11r) authentication sequence, the driver is
4859 * expected to use this event to report received FT IEs (MDIE, FTIE,
4860 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4861 * IEs for the next message will be delivered through the
4862 * struct wpa_driver_ops::update_ft_ies() callback.
4863 */
4864 struct ft_ies {
4865 const u8 *ies;
4866 size_t ies_len;
4867 int ft_action;
4868 u8 target_ap[ETH_ALEN];
4869 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4870 const u8 *ric_ies;
4871 /** Length of ric_ies buffer in octets */
4872 size_t ric_ies_len;
4873 } ft_ies;
4874
4875 /**
4876 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4877 */
4878 struct ibss_rsn_start {
4879 u8 peer[ETH_ALEN];
4880 } ibss_rsn_start;
4881
4882 /**
4883 * struct auth_info - Data for EVENT_AUTH events
4884 */
4885 struct auth_info {
4886 u8 peer[ETH_ALEN];
4887 u8 bssid[ETH_ALEN];
4888 u16 auth_type;
4889 u16 auth_transaction;
4890 u16 status_code;
4891 const u8 *ies;
4892 size_t ies_len;
4893 } auth;
4894
4895 /**
4896 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4897 */
4898 struct assoc_reject {
4899 /**
4900 * bssid - BSSID of the AP that rejected association
4901 */
4902 const u8 *bssid;
4903
4904 /**
4905 * resp_ies - (Re)Association Response IEs
4906 *
4907 * Optional association data from the driver. This data is not
4908 * required WPA, but may be useful for some protocols and as
4909 * such, should be reported if this is available to the driver
4910 * interface.
4911 *
4912 * This should start with the first IE (fixed fields before IEs
4913 * are not included).
4914 */
4915 const u8 *resp_ies;
4916
4917 /**
4918 * resp_ies_len - Length of resp_ies in bytes
4919 */
4920 size_t resp_ies_len;
4921
4922 /**
4923 * status_code - Status Code from (Re)association Response
4924 */
4925 u16 status_code;
4926
4927 /**
4928 * timed_out - Whether failure is due to timeout (etc.) rather
4929 * than explicit rejection response from the AP.
4930 */
4931 int timed_out;
4932
4933 /**
4934 * timeout_reason - Reason for the timeout
4935 */
4936 const char *timeout_reason;
4937
4938 /**
4939 * fils_erp_next_seq_num - The next sequence number to use in
4940 * FILS ERP messages
4941 */
4942 u16 fils_erp_next_seq_num;
4943 } assoc_reject;
4944
4945 struct timeout_event {
4946 u8 addr[ETH_ALEN];
4947 } timeout_event;
4948
4949 /**
4950 * struct tx_status - Data for EVENT_TX_STATUS events
4951 */
4952 struct tx_status {
4953 u16 type;
4954 u16 stype;
4955 const u8 *dst;
4956 const u8 *data;
4957 size_t data_len;
4958 int ack;
4959 } tx_status;
4960
4961 /**
4962 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4963 */
4964 struct rx_from_unknown {
4965 const u8 *bssid;
4966 const u8 *addr;
4967 int wds;
4968 } rx_from_unknown;
4969
4970 /**
4971 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4972 */
4973 struct rx_mgmt {
4974 const u8 *frame;
4975 size_t frame_len;
4976 u32 datarate;
4977
4978 /**
4979 * drv_priv - Pointer to store driver private BSS information
4980 *
4981 * If not set to NULL, this is used for comparison with
4982 * hostapd_data->drv_priv to determine which BSS should process
4983 * the frame.
4984 */
4985 void *drv_priv;
4986
4987 /**
4988 * freq - Frequency (in MHz) on which the frame was received
4989 */
4990 int freq;
4991
4992 /**
4993 * ssi_signal - Signal strength in dBm (or 0 if not available)
4994 */
4995 int ssi_signal;
4996 } rx_mgmt;
4997
4998 /**
4999 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
5000 *
5001 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
5002 */
5003 struct remain_on_channel {
5004 /**
5005 * freq - Channel frequency in MHz
5006 */
5007 unsigned int freq;
5008
5009 /**
5010 * duration - Duration to remain on the channel in milliseconds
5011 */
5012 unsigned int duration;
5013 } remain_on_channel;
5014
5015 /**
5016 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
5017 * @aborted: Whether the scan was aborted
5018 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
5019 * @num_freqs: Number of entries in freqs array
5020 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
5021 * SSID)
5022 * @num_ssids: Number of entries in ssids array
5023 * @external_scan: Whether the scan info is for an external scan
5024 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
5025 * 0 if the source of the scan event is a vendor scan
5026 * @scan_start_tsf: Time when the scan started in terms of TSF of the
5027 * BSS that the interface that requested the scan is connected to
5028 * (if available).
5029 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
5030 * is set.
5031 */
5032 struct scan_info {
5033 int aborted;
5034 const int *freqs;
5035 size_t num_freqs;
5036 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
5037 size_t num_ssids;
5038 int external_scan;
5039 int nl_scan_event;
5040 u64 scan_start_tsf;
5041 u8 scan_start_tsf_bssid[ETH_ALEN];
5042 } scan_info;
5043
5044 /**
5045 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
5046 */
5047 struct rx_probe_req {
5048 /**
5049 * sa - Source address of the received Probe Request frame
5050 */
5051 const u8 *sa;
5052
5053 /**
5054 * da - Destination address of the received Probe Request frame
5055 * or %NULL if not available
5056 */
5057 const u8 *da;
5058
5059 /**
5060 * bssid - BSSID of the received Probe Request frame or %NULL
5061 * if not available
5062 */
5063 const u8 *bssid;
5064
5065 /**
5066 * ie - IEs from the Probe Request body
5067 */
5068 const u8 *ie;
5069
5070 /**
5071 * ie_len - Length of ie buffer in octets
5072 */
5073 size_t ie_len;
5074
5075 /**
5076 * signal - signal strength in dBm (or 0 if not available)
5077 */
5078 int ssi_signal;
5079 } rx_probe_req;
5080
5081 /**
5082 * struct new_sta - Data for EVENT_NEW_STA events
5083 */
5084 struct new_sta {
5085 const u8 *addr;
5086 } new_sta;
5087
5088 /**
5089 * struct eapol_rx - Data for EVENT_EAPOL_RX events
5090 */
5091 struct eapol_rx {
5092 const u8 *src;
5093 const u8 *data;
5094 size_t data_len;
5095 } eapol_rx;
5096
5097 /**
5098 * signal_change - Data for EVENT_SIGNAL_CHANGE events
5099 */
5100 struct wpa_signal_info signal_change;
5101
5102 /**
5103 * struct best_channel - Data for EVENT_BEST_CHANNEL events
5104 * @freq_24: Best 2.4 GHz band channel frequency in MHz
5105 * @freq_5: Best 5 GHz band channel frequency in MHz
5106 * @freq_overall: Best channel frequency in MHz
5107 *
5108 * 0 can be used to indicate no preference in either band.
5109 */
5110 struct best_channel {
5111 int freq_24;
5112 int freq_5;
5113 int freq_overall;
5114 } best_chan;
5115
5116 struct unprot_deauth {
5117 const u8 *sa;
5118 const u8 *da;
5119 u16 reason_code;
5120 } unprot_deauth;
5121
5122 struct unprot_disassoc {
5123 const u8 *sa;
5124 const u8 *da;
5125 u16 reason_code;
5126 } unprot_disassoc;
5127
5128 /**
5129 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
5130 * @addr: station address
5131 * @num_packets: Number of packets lost (consecutive packets not
5132 * acknowledged)
5133 */
5134 struct low_ack {
5135 u8 addr[ETH_ALEN];
5136 u32 num_packets;
5137 } low_ack;
5138
5139 /**
5140 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
5141 */
5142 struct ibss_peer_lost {
5143 u8 peer[ETH_ALEN];
5144 } ibss_peer_lost;
5145
5146 /**
5147 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
5148 */
5149 struct driver_gtk_rekey {
5150 const u8 *bssid;
5151 const u8 *replay_ctr;
5152 } driver_gtk_rekey;
5153
5154 /**
5155 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
5156 * @addr: station address
5157 */
5158 struct client_poll {
5159 u8 addr[ETH_ALEN];
5160 } client_poll;
5161
5162 /**
5163 * struct eapol_tx_status
5164 * @dst: Original destination
5165 * @data: Data starting with IEEE 802.1X header (!)
5166 * @data_len: Length of data
5167 * @ack: Indicates ack or lost frame
5168 *
5169 * This corresponds to hapd_send_eapol if the frame sent
5170 * there isn't just reported as EVENT_TX_STATUS.
5171 */
5172 struct eapol_tx_status {
5173 const u8 *dst;
5174 const u8 *data;
5175 int data_len;
5176 int ack;
5177 } eapol_tx_status;
5178
5179 /**
5180 * struct ch_switch
5181 * @freq: Frequency of new channel in MHz
5182 * @ht_enabled: Whether this is an HT channel
5183 * @ch_offset: Secondary channel offset
5184 * @ch_width: Channel width
5185 * @cf1: Center frequency 1
5186 * @cf2: Center frequency 2
5187 */
5188 struct ch_switch {
5189 int freq;
5190 int ht_enabled;
5191 int ch_offset;
5192 enum chan_width ch_width;
5193 int cf1;
5194 int cf2;
5195 } ch_switch;
5196
5197 /**
5198 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
5199 * @addr: Remote client address
5200 * @code: Reason code for connection failure
5201 */
5202 struct connect_failed_reason {
5203 u8 addr[ETH_ALEN];
5204 enum {
5205 MAX_CLIENT_REACHED,
5206 BLOCKED_CLIENT
5207 } code;
5208 } connect_failed_reason;
5209
5210 /**
5211 * struct dfs_event - Data for radar detected events
5212 * @freq: Frequency of the channel in MHz
5213 */
5214 struct dfs_event {
5215 int freq;
5216 int ht_enabled;
5217 int chan_offset;
5218 enum chan_width chan_width;
5219 int cf1;
5220 int cf2;
5221 } dfs_event;
5222
5223 /**
5224 * survey_results - Survey result data for EVENT_SURVEY
5225 * @freq_filter: Requested frequency survey filter, 0 if request
5226 * was for all survey data
5227 * @survey_list: Linked list of survey data (struct freq_survey)
5228 */
5229 struct survey_results {
5230 unsigned int freq_filter;
5231 struct dl_list survey_list; /* struct freq_survey */
5232 } survey_results;
5233
5234 /**
5235 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
5236 * @initiator: Initiator of the regulatory change
5237 * @type: Regulatory change type
5238 * @alpha2: Country code (or "" if not available)
5239 */
5240 struct channel_list_changed {
5241 enum reg_change_initiator initiator;
5242 enum reg_type type;
5243 char alpha2[3];
5244 } channel_list_changed;
5245
5246 /**
5247 * freq_range - List of frequency ranges
5248 *
5249 * This is used as the data with EVENT_AVOID_FREQUENCIES.
5250 */
5251 struct wpa_freq_range_list freq_range;
5252
5253 /**
5254 * struct mesh_peer
5255 *
5256 * @peer: Peer address
5257 * @ies: Beacon IEs
5258 * @ie_len: Length of @ies
5259 *
5260 * Notification of new candidate mesh peer.
5261 */
5262 struct mesh_peer {
5263 const u8 *peer;
5264 const u8 *ies;
5265 size_t ie_len;
5266 } mesh_peer;
5267
5268 /**
5269 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
5270 * @pri_channel: Selected primary channel
5271 * @sec_channel: Selected secondary channel
5272 * @vht_seg0_center_ch: VHT mode Segment0 center channel
5273 * @vht_seg1_center_ch: VHT mode Segment1 center channel
5274 * @ch_width: Selected Channel width by driver. Driver may choose to
5275 * change hostapd configured ACS channel width due driver internal
5276 * channel restrictions.
5277 * hw_mode: Selected band (used with hw_mode=any)
5278 */
5279 struct acs_selected_channels {
5280 u8 pri_channel;
5281 u8 sec_channel;
5282 u8 vht_seg0_center_ch;
5283 u8 vht_seg1_center_ch;
5284 u16 ch_width;
5285 enum hostapd_hw_mode hw_mode;
5286 } acs_selected_channels;
5287
5288 /**
5289 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
5290 * @reason_code: Reason for stopping offload
5291 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
5292 * scheduled.
5293 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
5294 * be stopped.
5295 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
5296 * parameters.
5297 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
5298 * supported by device.
5299 */
5300 struct p2p_lo_stop {
5301 enum {
5302 P2P_LO_STOPPED_REASON_COMPLETE = 0,
5303 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
5304 P2P_LO_STOPPED_REASON_INVALID_PARAM,
5305 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
5306 } reason_code;
5307 } p2p_lo_stop;
5308 };
5309
5310 /**
5311 * wpa_supplicant_event - Report a driver event for wpa_supplicant
5312 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5313 * with struct wpa_driver_ops::init()
5314 * @event: event type (defined above)
5315 * @data: possible extra data for the event
5316 *
5317 * Driver wrapper code should call this function whenever an event is received
5318 * from the driver.
5319 */
5320 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
5321 union wpa_event_data *data);
5322
5323 /**
5324 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
5325 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5326 * with struct wpa_driver_ops::init()
5327 * @event: event type (defined above)
5328 * @data: possible extra data for the event
5329 *
5330 * Same as wpa_supplicant_event(), but we search for the interface in
5331 * wpa_global.
5332 */
5333 void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
5334 union wpa_event_data *data);
5335
5336 /*
5337 * The following inline functions are provided for convenience to simplify
5338 * event indication for some of the common events.
5339 */
5340
5341 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
5342 size_t ielen, int reassoc)
5343 {
5344 union wpa_event_data event;
5345 os_memset(&event, 0, sizeof(event));
5346 event.assoc_info.reassoc = reassoc;
5347 event.assoc_info.req_ies = ie;
5348 event.assoc_info.req_ies_len = ielen;
5349 event.assoc_info.addr = addr;
5350 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
5351 }
5352
5353 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
5354 {
5355 union wpa_event_data event;
5356 os_memset(&event, 0, sizeof(event));
5357 event.disassoc_info.addr = addr;
5358 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
5359 }
5360
5361 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
5362 size_t data_len)
5363 {
5364 union wpa_event_data event;
5365 os_memset(&event, 0, sizeof(event));
5366 event.eapol_rx.src = src;
5367 event.eapol_rx.data = data;
5368 event.eapol_rx.data_len = data_len;
5369 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
5370 }
5371
5372 /* driver_common.c */
5373 void wpa_scan_results_free(struct wpa_scan_results *res);
5374
5375 /* Convert wpa_event_type to a string for logging */
5376 const char * event_to_string(enum wpa_event_type event);
5377
5378 /* Convert chan_width to a string for logging and control interfaces */
5379 const char * channel_width_to_string(enum chan_width width);
5380
5381 int ht_supported(const struct hostapd_hw_modes *mode);
5382 int vht_supported(const struct hostapd_hw_modes *mode);
5383
5384 struct wowlan_triggers *
5385 wpa_get_wowlan_triggers(const char *wowlan_triggers,
5386 const struct wpa_driver_capa *capa);
5387 /* Convert driver flag to string */
5388 const char * driver_flag_to_string(u64 flag);
5389
5390 /* NULL terminated array of linked in driver wrappers */
5391 extern const struct wpa_driver_ops *const wpa_drivers[];
5392
5393
5394 /* Available drivers */
5395
5396 #ifdef CONFIG_DRIVER_WEXT
5397 extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
5398 #endif /* CONFIG_DRIVER_WEXT */
5399 #ifdef CONFIG_DRIVER_NL80211
5400 /* driver_nl80211.c */
5401 extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
5402 #endif /* CONFIG_DRIVER_NL80211 */
5403 #ifdef CONFIG_DRIVER_HOSTAP
5404 extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
5405 #endif /* CONFIG_DRIVER_HOSTAP */
5406 #ifdef CONFIG_DRIVER_BSD
5407 extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
5408 #endif /* CONFIG_DRIVER_BSD */
5409 #ifdef CONFIG_DRIVER_OPENBSD
5410 /* driver_openbsd.c */
5411 extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
5412 #endif /* CONFIG_DRIVER_OPENBSD */
5413 #ifdef CONFIG_DRIVER_NDIS
5414 extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
5415 #endif /* CONFIG_DRIVER_NDIS */
5416 #ifdef CONFIG_DRIVER_WIRED
5417 extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
5418 #endif /* CONFIG_DRIVER_WIRED */
5419 #ifdef CONFIG_DRIVER_MACSEC_QCA
5420 /* driver_macsec_qca.c */
5421 extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
5422 #endif /* CONFIG_DRIVER_MACSEC_QCA */
5423 #ifdef CONFIG_DRIVER_MACSEC_LINUX
5424 /* driver_macsec_linux.c */
5425 extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops;
5426 #endif /* CONFIG_DRIVER_MACSEC_LINUX */
5427 #ifdef CONFIG_DRIVER_ROBOSWITCH
5428 /* driver_roboswitch.c */
5429 extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
5430 #endif /* CONFIG_DRIVER_ROBOSWITCH */
5431 #ifdef CONFIG_DRIVER_ATHEROS
5432 /* driver_atheros.c */
5433 extern const struct wpa_driver_ops wpa_driver_atheros_ops;
5434 #endif /* CONFIG_DRIVER_ATHEROS */
5435 #ifdef CONFIG_DRIVER_NONE
5436 extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
5437 #endif /* CONFIG_DRIVER_NONE */
5438
5439 #endif /* DRIVER_H */