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