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