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