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