]> git.ipfire.org Git - thirdparty/hostap.git/blob - src/drivers/driver.h
nl80211: Add concurrency capabilities to driver status
[thirdparty/hostap.git] / src / drivers / driver.h
1 /*
2 * Driver interface definition
3 * Copyright (c) 2003-2015, 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 "utils/list.h"
25
26 #define HOSTAPD_CHAN_DISABLED 0x00000001
27 #define HOSTAPD_CHAN_NO_IR 0x00000002
28 #define HOSTAPD_CHAN_RADAR 0x00000008
29 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
30 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
31 #define HOSTAPD_CHAN_HT40 0x00000040
32 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
33
34 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
35 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
36 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
37 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
38 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
39
40 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
41 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
42 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
43 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
44
45 #define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
46 #define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
47
48 /**
49 * enum reg_change_initiator - Regulatory change initiator
50 */
51 enum reg_change_initiator {
52 REGDOM_SET_BY_CORE,
53 REGDOM_SET_BY_USER,
54 REGDOM_SET_BY_DRIVER,
55 REGDOM_SET_BY_COUNTRY_IE,
56 REGDOM_BEACON_HINT,
57 };
58
59 /**
60 * enum reg_type - Regulatory change types
61 */
62 enum reg_type {
63 REGDOM_TYPE_UNKNOWN,
64 REGDOM_TYPE_COUNTRY,
65 REGDOM_TYPE_WORLD,
66 REGDOM_TYPE_CUSTOM_WORLD,
67 REGDOM_TYPE_INTERSECTION,
68 };
69
70 /**
71 * struct hostapd_channel_data - Channel information
72 */
73 struct hostapd_channel_data {
74 /**
75 * chan - Channel number (IEEE 802.11)
76 */
77 short chan;
78
79 /**
80 * freq - Frequency in MHz
81 */
82 int freq;
83
84 /**
85 * flag - Channel flags (HOSTAPD_CHAN_*)
86 */
87 int flag;
88
89 /**
90 * max_tx_power - Regulatory transmit power limit in dBm
91 */
92 u8 max_tx_power;
93
94 /**
95 * survey_list - Linked list of surveys (struct freq_survey)
96 */
97 struct dl_list survey_list;
98
99 /**
100 * min_nf - Minimum observed noise floor, in dBm, based on all
101 * surveyed channel data
102 */
103 s8 min_nf;
104
105 #ifdef CONFIG_ACS
106 /**
107 * interference_factor - Computed interference factor on this
108 * channel (used internally in src/ap/acs.c; driver wrappers do not
109 * need to set this)
110 */
111 long double interference_factor;
112 #endif /* CONFIG_ACS */
113
114 /**
115 * dfs_cac_ms - DFS CAC time in milliseconds
116 */
117 unsigned int dfs_cac_ms;
118 };
119
120 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
121 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
122
123 /**
124 * struct hostapd_hw_modes - Supported hardware mode information
125 */
126 struct hostapd_hw_modes {
127 /**
128 * mode - Hardware mode
129 */
130 enum hostapd_hw_mode mode;
131
132 /**
133 * num_channels - Number of entries in the channels array
134 */
135 int num_channels;
136
137 /**
138 * channels - Array of supported channels
139 */
140 struct hostapd_channel_data *channels;
141
142 /**
143 * num_rates - Number of entries in the rates array
144 */
145 int num_rates;
146
147 /**
148 * rates - Array of supported rates in 100 kbps units
149 */
150 int *rates;
151
152 /**
153 * ht_capab - HT (IEEE 802.11n) capabilities
154 */
155 u16 ht_capab;
156
157 /**
158 * mcs_set - MCS (IEEE 802.11n) rate parameters
159 */
160 u8 mcs_set[16];
161
162 /**
163 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
164 */
165 u8 a_mpdu_params;
166
167 /**
168 * vht_capab - VHT (IEEE 802.11ac) capabilities
169 */
170 u32 vht_capab;
171
172 /**
173 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
174 */
175 u8 vht_mcs_set[8];
176
177 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
178 };
179
180
181 #define IEEE80211_MODE_INFRA 0
182 #define IEEE80211_MODE_IBSS 1
183 #define IEEE80211_MODE_AP 2
184 #define IEEE80211_MODE_MESH 5
185
186 #define IEEE80211_CAP_ESS 0x0001
187 #define IEEE80211_CAP_IBSS 0x0002
188 #define IEEE80211_CAP_PRIVACY 0x0010
189 #define IEEE80211_CAP_RRM 0x1000
190
191 /* DMG (60 GHz) IEEE 802.11ad */
192 /* type - bits 0..1 */
193 #define IEEE80211_CAP_DMG_MASK 0x0003
194 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
195 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
196 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
197
198 #define WPA_SCAN_QUAL_INVALID BIT(0)
199 #define WPA_SCAN_NOISE_INVALID BIT(1)
200 #define WPA_SCAN_LEVEL_INVALID BIT(2)
201 #define WPA_SCAN_LEVEL_DBM BIT(3)
202 #define WPA_SCAN_ASSOCIATED BIT(5)
203
204 /**
205 * struct wpa_scan_res - Scan result for an BSS/IBSS
206 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
207 * @bssid: BSSID
208 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
209 * @beacon_int: beacon interval in TUs (host byte order)
210 * @caps: capability information field in host byte order
211 * @qual: signal quality
212 * @noise: noise level
213 * @level: signal level
214 * @tsf: Timestamp
215 * @age: Age of the information in milliseconds (i.e., how many milliseconds
216 * ago the last Beacon or Probe Response frame was received)
217 * @est_throughput: Estimated throughput in kbps (this is calculated during
218 * scan result processing if left zero by the driver wrapper)
219 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
220 * @ie_len: length of the following IE field in octets
221 * @beacon_ie_len: length of the following Beacon IE field in octets
222 *
223 * This structure is used as a generic format for scan results from the
224 * driver. Each driver interface implementation is responsible for converting
225 * the driver or OS specific scan results into this format.
226 *
227 * If the driver does not support reporting all IEs, the IE data structure is
228 * constructed of the IEs that are available. This field will also need to
229 * include SSID in IE format. All drivers are encouraged to be extended to
230 * report all IEs to make it easier to support future additions.
231 *
232 * This structure data is followed by ie_len octets of IEs from Probe Response
233 * frame (or if the driver does not indicate source of IEs, these may also be
234 * from Beacon frame). After the first set of IEs, another set of IEs may follow
235 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
236 */
237 struct wpa_scan_res {
238 unsigned int flags;
239 u8 bssid[ETH_ALEN];
240 int freq;
241 u16 beacon_int;
242 u16 caps;
243 int qual;
244 int noise;
245 int level;
246 u64 tsf;
247 unsigned int age;
248 unsigned int est_throughput;
249 int snr;
250 size_t ie_len;
251 size_t beacon_ie_len;
252 /* Followed by ie_len + beacon_ie_len octets of IE data */
253 };
254
255 /**
256 * struct wpa_scan_results - Scan results
257 * @res: Array of pointers to allocated variable length scan result entries
258 * @num: Number of entries in the scan result array
259 * @fetch_time: Time when the results were fetched from the driver
260 */
261 struct wpa_scan_results {
262 struct wpa_scan_res **res;
263 size_t num;
264 struct os_reltime fetch_time;
265 };
266
267 /**
268 * struct wpa_interface_info - Network interface information
269 * @next: Pointer to the next interface or NULL if this is the last one
270 * @ifname: Interface name that can be used with init() or init2()
271 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
272 * not available
273 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
274 * is not an allocated copy, i.e., get_interfaces() caller will not free
275 * this)
276 */
277 struct wpa_interface_info {
278 struct wpa_interface_info *next;
279 char *ifname;
280 char *desc;
281 const char *drv_name;
282 };
283
284 #define WPAS_MAX_SCAN_SSIDS 16
285
286 /**
287 * struct wpa_driver_scan_params - Scan parameters
288 * Data for struct wpa_driver_ops::scan2().
289 */
290 struct wpa_driver_scan_params {
291 /**
292 * ssids - SSIDs to scan for
293 */
294 struct wpa_driver_scan_ssid {
295 /**
296 * ssid - specific SSID to scan for (ProbeReq)
297 * %NULL or zero-length SSID is used to indicate active scan
298 * with wildcard SSID.
299 */
300 const u8 *ssid;
301 /**
302 * ssid_len: Length of the SSID in octets
303 */
304 size_t ssid_len;
305 } ssids[WPAS_MAX_SCAN_SSIDS];
306
307 /**
308 * num_ssids - Number of entries in ssids array
309 * Zero indicates a request for a passive scan.
310 */
311 size_t num_ssids;
312
313 /**
314 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
315 */
316 const u8 *extra_ies;
317
318 /**
319 * extra_ies_len - Length of extra_ies in octets
320 */
321 size_t extra_ies_len;
322
323 /**
324 * freqs - Array of frequencies to scan or %NULL for all frequencies
325 *
326 * The frequency is set in MHz. The array is zero-terminated.
327 */
328 int *freqs;
329
330 /**
331 * filter_ssids - Filter for reporting SSIDs
332 *
333 * This optional parameter can be used to request the driver wrapper to
334 * filter scan results to include only the specified SSIDs. %NULL
335 * indicates that no filtering is to be done. This can be used to
336 * reduce memory needs for scan results in environments that have large
337 * number of APs with different SSIDs.
338 *
339 * The driver wrapper is allowed to take this allocated buffer into its
340 * own use by setting the pointer to %NULL. In that case, the driver
341 * wrapper is responsible for freeing the buffer with os_free() once it
342 * is not needed anymore.
343 */
344 struct wpa_driver_scan_filter {
345 u8 ssid[SSID_MAX_LEN];
346 size_t ssid_len;
347 } *filter_ssids;
348
349 /**
350 * num_filter_ssids - Number of entries in filter_ssids array
351 */
352 size_t num_filter_ssids;
353
354 /**
355 * filter_rssi - Filter by RSSI
356 *
357 * The driver may filter scan results in firmware to reduce host
358 * wakeups and thereby save power. Specify the RSSI threshold in s32
359 * dBm.
360 */
361 s32 filter_rssi;
362
363 /**
364 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
365 *
366 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
367 * Mbps from the support rates element(s) in the Probe Request frames
368 * and not to transmit the frames at any of those rates.
369 */
370 unsigned int p2p_probe:1;
371
372 /**
373 * only_new_results - Request driver to report only new results
374 *
375 * This is used to request the driver to report only BSSes that have
376 * been detected after this scan request has been started, i.e., to
377 * flush old cached BSS entries.
378 */
379 unsigned int only_new_results:1;
380
381 /**
382 * low_priority - Requests driver to use a lower scan priority
383 *
384 * This is used to request the driver to use a lower scan priority
385 * if it supports such a thing.
386 */
387 unsigned int low_priority:1;
388
389 /**
390 * mac_addr_rand - Requests driver to randomize MAC address
391 */
392 unsigned int mac_addr_rand:1;
393
394 /**
395 * mac_addr - MAC address used with randomization. The address cannot be
396 * a multicast one, i.e., bit 0 of byte 0 should not be set.
397 */
398 const u8 *mac_addr;
399
400 /**
401 * mac_addr_mask - MAC address mask used with randomization.
402 *
403 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
404 * the mask should be taken as is from mac_addr. The mask should not
405 * allow the generation of a multicast address, i.e., bit 0 of byte 0
406 * must be set.
407 */
408 const u8 *mac_addr_mask;
409
410 /*
411 * NOTE: Whenever adding new parameters here, please make sure
412 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
413 * matching changes.
414 */
415 };
416
417 /**
418 * struct wpa_driver_auth_params - Authentication parameters
419 * Data for struct wpa_driver_ops::authenticate().
420 */
421 struct wpa_driver_auth_params {
422 int freq;
423 const u8 *bssid;
424 const u8 *ssid;
425 size_t ssid_len;
426 int auth_alg;
427 const u8 *ie;
428 size_t ie_len;
429 const u8 *wep_key[4];
430 size_t wep_key_len[4];
431 int wep_tx_keyidx;
432 int local_state_change;
433
434 /**
435 * p2p - Whether this connection is a P2P group
436 */
437 int p2p;
438
439 /**
440 * sae_data - SAE elements for Authentication frame
441 *
442 * This buffer starts with the Authentication transaction sequence
443 * number field. If SAE is not used, this pointer is %NULL.
444 */
445 const u8 *sae_data;
446
447 /**
448 * sae_data_len - Length of sae_data buffer in octets
449 */
450 size_t sae_data_len;
451 };
452
453 /**
454 * enum wps_mode - WPS mode
455 */
456 enum wps_mode {
457 /**
458 * WPS_MODE_NONE - No WPS provisioning being used
459 */
460 WPS_MODE_NONE,
461
462 /**
463 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
464 */
465 WPS_MODE_OPEN,
466
467 /**
468 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
469 */
470 WPS_MODE_PRIVACY
471 };
472
473 /**
474 * struct hostapd_freq_params - Channel parameters
475 */
476 struct hostapd_freq_params {
477 /**
478 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
479 */
480 enum hostapd_hw_mode mode;
481
482 /**
483 * freq - Primary channel center frequency in MHz
484 */
485 int freq;
486
487 /**
488 * channel - Channel number
489 */
490 int channel;
491
492 /**
493 * ht_enabled - Whether HT is enabled
494 */
495 int ht_enabled;
496
497 /**
498 * sec_channel_offset - Secondary channel offset for HT40
499 *
500 * 0 = HT40 disabled,
501 * -1 = HT40 enabled, secondary channel below primary,
502 * 1 = HT40 enabled, secondary channel above primary
503 */
504 int sec_channel_offset;
505
506 /**
507 * vht_enabled - Whether VHT is enabled
508 */
509 int vht_enabled;
510
511 /**
512 * center_freq1 - Segment 0 center frequency in MHz
513 *
514 * Valid for both HT and VHT.
515 */
516 int center_freq1;
517
518 /**
519 * center_freq2 - Segment 1 center frequency in MHz
520 *
521 * Non-zero only for bandwidth 80 and an 80+80 channel
522 */
523 int center_freq2;
524
525 /**
526 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
527 */
528 int bandwidth;
529 };
530
531 /**
532 * struct wpa_driver_associate_params - Association parameters
533 * Data for struct wpa_driver_ops::associate().
534 */
535 struct wpa_driver_associate_params {
536 /**
537 * bssid - BSSID of the selected AP
538 * This can be %NULL, if ap_scan=2 mode is used and the driver is
539 * responsible for selecting with which BSS to associate. */
540 const u8 *bssid;
541
542 /**
543 * bssid_hint - BSSID of a proposed AP
544 *
545 * This indicates which BSS has been found a suitable candidate for
546 * initial association for drivers that use driver/firmwate-based BSS
547 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
548 * the driver from selecting other BSSes in the ESS.
549 */
550 const u8 *bssid_hint;
551
552 /**
553 * ssid - The selected SSID
554 */
555 const u8 *ssid;
556
557 /**
558 * ssid_len - Length of the SSID (1..32)
559 */
560 size_t ssid_len;
561
562 /**
563 * freq - channel parameters
564 */
565 struct hostapd_freq_params freq;
566
567 /**
568 * freq_hint - Frequency of the channel the proposed AP is using
569 *
570 * This provides a channel on which a suitable BSS has been found as a
571 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
572 * limit the driver from selecting other channels for
573 * driver/firmware-based BSS selection.
574 */
575 int freq_hint;
576
577 /**
578 * bg_scan_period - Background scan period in seconds, 0 to disable
579 * background scan, or -1 to indicate no change to default driver
580 * configuration
581 */
582 int bg_scan_period;
583
584 /**
585 * beacon_int - Beacon interval for IBSS or 0 to use driver default
586 */
587 int beacon_int;
588
589 /**
590 * wpa_ie - WPA information element for (Re)Association Request
591 * WPA information element to be included in (Re)Association
592 * Request (including information element id and length). Use
593 * of this WPA IE is optional. If the driver generates the WPA
594 * IE, it can use pairwise_suite, group_suite, and
595 * key_mgmt_suite to select proper algorithms. In this case,
596 * the driver has to notify wpa_supplicant about the used WPA
597 * IE by generating an event that the interface code will
598 * convert into EVENT_ASSOCINFO data (see below).
599 *
600 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
601 * instead. The driver can determine which version is used by
602 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
603 * WPA2/RSN).
604 *
605 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
606 */
607 const u8 *wpa_ie;
608
609 /**
610 * wpa_ie_len - length of the wpa_ie
611 */
612 size_t wpa_ie_len;
613
614 /**
615 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
616 */
617 unsigned int wpa_proto;
618
619 /**
620 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
621 *
622 * This is usually ignored if @wpa_ie is used.
623 */
624 unsigned int pairwise_suite;
625
626 /**
627 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
628 *
629 * This is usually ignored if @wpa_ie is used.
630 */
631 unsigned int group_suite;
632
633 /**
634 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
635 *
636 * This is usually ignored if @wpa_ie is used.
637 */
638 unsigned int key_mgmt_suite;
639
640 /**
641 * auth_alg - Allowed authentication algorithms
642 * Bit field of WPA_AUTH_ALG_*
643 */
644 int auth_alg;
645
646 /**
647 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
648 */
649 int mode;
650
651 /**
652 * wep_key - WEP keys for static WEP configuration
653 */
654 const u8 *wep_key[4];
655
656 /**
657 * wep_key_len - WEP key length for static WEP configuration
658 */
659 size_t wep_key_len[4];
660
661 /**
662 * wep_tx_keyidx - WEP TX key index for static WEP configuration
663 */
664 int wep_tx_keyidx;
665
666 /**
667 * mgmt_frame_protection - IEEE 802.11w management frame protection
668 */
669 enum mfp_options mgmt_frame_protection;
670
671 /**
672 * ft_ies - IEEE 802.11r / FT information elements
673 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
674 * for fast transition, this parameter is set to include the IEs that
675 * are to be sent in the next FT Authentication Request message.
676 * update_ft_ies() handler is called to update the IEs for further
677 * FT messages in the sequence.
678 *
679 * The driver should use these IEs only if the target AP is advertising
680 * the same mobility domain as the one included in the MDIE here.
681 *
682 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
683 * AP after the initial association. These IEs can only be used if the
684 * target AP is advertising support for FT and is using the same MDIE
685 * and SSID as the current AP.
686 *
687 * The driver is responsible for reporting the FT IEs received from the
688 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
689 * type. update_ft_ies() handler will then be called with the FT IEs to
690 * include in the next frame in the authentication sequence.
691 */
692 const u8 *ft_ies;
693
694 /**
695 * ft_ies_len - Length of ft_ies in bytes
696 */
697 size_t ft_ies_len;
698
699 /**
700 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
701 *
702 * This value is provided to allow the driver interface easier access
703 * to the current mobility domain. This value is set to %NULL if no
704 * mobility domain is currently active.
705 */
706 const u8 *ft_md;
707
708 /**
709 * passphrase - RSN passphrase for PSK
710 *
711 * This value is made available only for WPA/WPA2-Personal (PSK) and
712 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
713 * the 8..63 character ASCII passphrase, if available. Please note that
714 * this can be %NULL if passphrase was not used to generate the PSK. In
715 * that case, the psk field must be used to fetch the PSK.
716 */
717 const char *passphrase;
718
719 /**
720 * psk - RSN PSK (alternative for passphrase for PSK)
721 *
722 * This value is made available only for WPA/WPA2-Personal (PSK) and
723 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
724 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
725 * be prepared to handle %NULL value as an error.
726 */
727 const u8 *psk;
728
729 /**
730 * drop_unencrypted - Enable/disable unencrypted frame filtering
731 *
732 * Configure the driver to drop all non-EAPOL frames (both receive and
733 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
734 * still be allowed for key negotiation.
735 */
736 int drop_unencrypted;
737
738 /**
739 * prev_bssid - Previously used BSSID in this ESS
740 *
741 * When not %NULL, this is a request to use reassociation instead of
742 * association.
743 */
744 const u8 *prev_bssid;
745
746 /**
747 * wps - WPS mode
748 *
749 * If the driver needs to do special configuration for WPS association,
750 * this variable provides more information on what type of association
751 * is being requested. Most drivers should not need ot use this.
752 */
753 enum wps_mode wps;
754
755 /**
756 * p2p - Whether this connection is a P2P group
757 */
758 int p2p;
759
760 /**
761 * uapsd - UAPSD parameters for the network
762 * -1 = do not change defaults
763 * AP mode: 1 = enabled, 0 = disabled
764 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
765 */
766 int uapsd;
767
768 /**
769 * fixed_bssid - Whether to force this BSSID in IBSS mode
770 * 1 = Fix this BSSID and prevent merges.
771 * 0 = Do not fix BSSID.
772 */
773 int fixed_bssid;
774
775 /**
776 * fixed_freq - Fix control channel in IBSS mode
777 * 0 = don't fix control channel (default)
778 * 1 = fix control channel; this prevents IBSS merging with another
779 * channel
780 */
781 int fixed_freq;
782
783 /**
784 * disable_ht - Disable HT (IEEE 802.11n) for this connection
785 */
786 int disable_ht;
787
788 /**
789 * htcaps - HT Capabilities over-rides
790 *
791 * Only bits set in the mask will be used, and not all values are used
792 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
793 *
794 * Pointer to struct ieee80211_ht_capabilities.
795 */
796 const u8 *htcaps;
797
798 /**
799 * htcaps_mask - HT Capabilities over-rides mask
800 *
801 * Pointer to struct ieee80211_ht_capabilities.
802 */
803 const u8 *htcaps_mask;
804
805 #ifdef CONFIG_VHT_OVERRIDES
806 /**
807 * disable_vht - Disable VHT for this connection
808 */
809 int disable_vht;
810
811 /**
812 * VHT capability overrides.
813 */
814 const struct ieee80211_vht_capabilities *vhtcaps;
815 const struct ieee80211_vht_capabilities *vhtcaps_mask;
816 #endif /* CONFIG_VHT_OVERRIDES */
817
818 /**
819 * req_key_mgmt_offload - Request key management offload for connection
820 *
821 * Request key management offload for this connection if the device
822 * supports it.
823 */
824 int req_key_mgmt_offload;
825
826 /**
827 * Flag for indicating whether this association includes support for
828 * RRM (Radio Resource Measurements)
829 */
830 int rrm_used;
831 };
832
833 enum hide_ssid {
834 NO_SSID_HIDING,
835 HIDDEN_SSID_ZERO_LEN,
836 HIDDEN_SSID_ZERO_CONTENTS
837 };
838
839 struct wowlan_triggers {
840 u8 any;
841 u8 disconnect;
842 u8 magic_pkt;
843 u8 gtk_rekey_failure;
844 u8 eap_identity_req;
845 u8 four_way_handshake;
846 u8 rfkill_release;
847 };
848
849 struct wpa_driver_ap_params {
850 /**
851 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
852 */
853 u8 *head;
854
855 /**
856 * head_len - Length of the head buffer in octets
857 */
858 size_t head_len;
859
860 /**
861 * tail - Beacon tail following TIM IE
862 */
863 u8 *tail;
864
865 /**
866 * tail_len - Length of the tail buffer in octets
867 */
868 size_t tail_len;
869
870 /**
871 * dtim_period - DTIM period
872 */
873 int dtim_period;
874
875 /**
876 * beacon_int - Beacon interval
877 */
878 int beacon_int;
879
880 /**
881 * basic_rates: -1 terminated array of basic rates in 100 kbps
882 *
883 * This parameter can be used to set a specific basic rate set for the
884 * BSS. If %NULL, default basic rate set is used.
885 */
886 int *basic_rates;
887
888 /**
889 * proberesp - Probe Response template
890 *
891 * This is used by drivers that reply to Probe Requests internally in
892 * AP mode and require the full Probe Response template.
893 */
894 u8 *proberesp;
895
896 /**
897 * proberesp_len - Length of the proberesp buffer in octets
898 */
899 size_t proberesp_len;
900
901 /**
902 * ssid - The SSID to use in Beacon/Probe Response frames
903 */
904 const u8 *ssid;
905
906 /**
907 * ssid_len - Length of the SSID (1..32)
908 */
909 size_t ssid_len;
910
911 /**
912 * hide_ssid - Whether to hide the SSID
913 */
914 enum hide_ssid hide_ssid;
915
916 /**
917 * pairwise_ciphers - WPA_CIPHER_* bitfield
918 */
919 unsigned int pairwise_ciphers;
920
921 /**
922 * group_cipher - WPA_CIPHER_*
923 */
924 unsigned int group_cipher;
925
926 /**
927 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
928 */
929 unsigned int key_mgmt_suites;
930
931 /**
932 * auth_algs - WPA_AUTH_ALG_* bitfield
933 */
934 unsigned int auth_algs;
935
936 /**
937 * wpa_version - WPA_PROTO_* bitfield
938 */
939 unsigned int wpa_version;
940
941 /**
942 * privacy - Whether privacy is used in the BSS
943 */
944 int privacy;
945
946 /**
947 * beacon_ies - WPS/P2P IE(s) for Beacon frames
948 *
949 * This is used to add IEs like WPS IE and P2P IE by drivers that do
950 * not use the full Beacon template.
951 */
952 const struct wpabuf *beacon_ies;
953
954 /**
955 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
956 *
957 * This is used to add IEs like WPS IE and P2P IE by drivers that
958 * reply to Probe Request frames internally.
959 */
960 const struct wpabuf *proberesp_ies;
961
962 /**
963 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
964 *
965 * This is used to add IEs like WPS IE by drivers that reply to
966 * (Re)Association Request frames internally.
967 */
968 const struct wpabuf *assocresp_ies;
969
970 /**
971 * isolate - Whether to isolate frames between associated stations
972 *
973 * If this is non-zero, the AP is requested to disable forwarding of
974 * frames between associated stations.
975 */
976 int isolate;
977
978 /**
979 * cts_protect - Whether CTS protection is enabled
980 */
981 int cts_protect;
982
983 /**
984 * preamble - Whether short preamble is enabled
985 */
986 int preamble;
987
988 /**
989 * short_slot_time - Whether short slot time is enabled
990 *
991 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
992 * not set (e.g., when 802.11g mode is not in use)
993 */
994 int short_slot_time;
995
996 /**
997 * ht_opmode - HT operation mode or -1 if HT not in use
998 */
999 int ht_opmode;
1000
1001 /**
1002 * interworking - Whether Interworking is enabled
1003 */
1004 int interworking;
1005
1006 /**
1007 * hessid - Homogeneous ESS identifier or %NULL if not set
1008 */
1009 const u8 *hessid;
1010
1011 /**
1012 * access_network_type - Access Network Type (0..15)
1013 *
1014 * This is used for filtering Probe Request frames when Interworking is
1015 * enabled.
1016 */
1017 u8 access_network_type;
1018
1019 /**
1020 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1021 *
1022 * This is used by driver which advertises this capability.
1023 */
1024 int ap_max_inactivity;
1025
1026 /**
1027 * ctwindow - Client Traffic Window (in TUs)
1028 */
1029 u8 p2p_go_ctwindow;
1030
1031 /**
1032 * smps_mode - SMPS mode
1033 *
1034 * SMPS mode to be used by the AP, specified as the relevant bits of
1035 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1036 */
1037 unsigned int smps_mode;
1038
1039 /**
1040 * disable_dgaf - Whether group-addressed frames are disabled
1041 */
1042 int disable_dgaf;
1043
1044 /**
1045 * osen - Whether OSEN security is enabled
1046 */
1047 int osen;
1048
1049 /**
1050 * freq - Channel parameters for dynamic bandwidth changes
1051 */
1052 struct hostapd_freq_params *freq;
1053
1054 /**
1055 * reenable - Whether this is to re-enable beaconing
1056 */
1057 int reenable;
1058 };
1059
1060 struct wpa_driver_mesh_bss_params {
1061 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1062 /*
1063 * TODO: Other mesh configuration parameters would go here.
1064 * See NL80211_MESHCONF_* for all the mesh config parameters.
1065 */
1066 unsigned int flags;
1067 int peer_link_timeout;
1068 };
1069
1070 struct wpa_driver_mesh_join_params {
1071 const u8 *meshid;
1072 int meshid_len;
1073 const int *basic_rates;
1074 const u8 *ies;
1075 int ie_len;
1076 struct hostapd_freq_params freq;
1077 int beacon_int;
1078 int max_peer_links;
1079 struct wpa_driver_mesh_bss_params conf;
1080 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1081 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1082 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1083 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1084 unsigned int flags;
1085 };
1086
1087 /**
1088 * struct wpa_driver_capa - Driver capability information
1089 */
1090 struct wpa_driver_capa {
1091 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1092 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1093 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1094 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1095 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1096 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1097 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1098 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1099 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1100 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
1101 /** Bitfield of supported key management suites */
1102 unsigned int key_mgmt;
1103
1104 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1105 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1106 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1107 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1108 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1109 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1110 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1111 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1112 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1113 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1114 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1115 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1116 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1117 /** Bitfield of supported cipher suites */
1118 unsigned int enc;
1119
1120 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1121 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1122 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1123 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1124 unsigned int auth;
1125
1126 /** Driver generated WPA/RSN IE */
1127 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1128 /** Driver needs static WEP key setup after association command */
1129 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1130 /** Driver takes care of all DFS operations */
1131 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1132 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1133 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1134 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1135 /** Driver is for a wired Ethernet interface */
1136 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1137 /** Driver provides separate commands for authentication and association (SME in
1138 * wpa_supplicant). */
1139 #define WPA_DRIVER_FLAGS_SME 0x00000020
1140 /** Driver supports AP mode */
1141 #define WPA_DRIVER_FLAGS_AP 0x00000040
1142 /** Driver needs static WEP key setup after association has been completed */
1143 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1144 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1145 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1146 /** Driver supports concurrent P2P operations */
1147 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1148 /**
1149 * Driver uses the initial interface as a dedicated management interface, i.e.,
1150 * it cannot be used for P2P group operations or non-P2P purposes.
1151 */
1152 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1153 /** This interface is P2P capable (P2P GO or P2P Client) */
1154 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1155 /** Driver supports station and key removal when stopping an AP */
1156 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1157 /**
1158 * Driver uses the initial interface for P2P management interface and non-P2P
1159 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1160 * P2P group operations.
1161 */
1162 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1163 /**
1164 * Driver is known to use sane error codes, i.e., when it indicates that
1165 * something (e.g., association) fails, there was indeed a failure and the
1166 * operation does not end up getting completed successfully later.
1167 */
1168 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1169 /** Driver supports off-channel TX */
1170 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1171 /** Driver indicates TX status events for EAPOL Data frames */
1172 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1173 /** Driver indicates TX status events for Deauth/Disassoc frames */
1174 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1175 /** Driver supports roaming (BSS selection) in firmware */
1176 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1177 /** Driver supports operating as a TDLS peer */
1178 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1179 /** Driver requires external TDLS setup/teardown/discovery */
1180 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1181 /** Driver indicates support for Probe Response offloading in AP mode */
1182 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1183 /** Driver supports U-APSD in AP mode */
1184 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1185 /** Driver supports inactivity timer in AP mode */
1186 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1187 /** Driver expects user space implementation of MLME in AP mode */
1188 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1189 /** Driver supports SAE with user space SME */
1190 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1191 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1192 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1193 /** Driver supports IBSS (Ad-hoc) mode */
1194 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1195 /** Driver supports radar detection */
1196 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1197 /** Driver supports a dedicated interface for P2P Device */
1198 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1199 /** Driver supports QoS Mapping */
1200 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1201 /** Driver supports CSA in AP mode */
1202 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1203 /** Driver supports mesh */
1204 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1205 /** Driver support ACS offload */
1206 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1207 /** Driver supports key management offload */
1208 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1209 /** Driver supports TDLS channel switching */
1210 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1211 /** Driver supports IBSS with HT datarates */
1212 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
1213 /** Driver supports IBSS with VHT datarates */
1214 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
1215 /** Driver supports automatic band selection */
1216 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
1217 u64 flags;
1218
1219 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1220 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1221 unsigned int smps_modes;
1222
1223 unsigned int wmm_ac_supported:1;
1224
1225 unsigned int mac_addr_rand_scan_supported:1;
1226 unsigned int mac_addr_rand_sched_scan_supported:1;
1227
1228 /** Maximum number of supported active probe SSIDs */
1229 int max_scan_ssids;
1230
1231 /** Maximum number of supported active probe SSIDs for sched_scan */
1232 int max_sched_scan_ssids;
1233
1234 /** Whether sched_scan (offloaded scanning) is supported */
1235 int sched_scan_supported;
1236
1237 /** Maximum number of supported match sets for sched_scan */
1238 int max_match_sets;
1239
1240 /**
1241 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1242 */
1243 unsigned int max_remain_on_chan;
1244
1245 /**
1246 * max_stations - Maximum number of associated stations the driver
1247 * supports in AP mode
1248 */
1249 unsigned int max_stations;
1250
1251 /**
1252 * probe_resp_offloads - Bitmap of supported protocols by the driver
1253 * for Probe Response offloading.
1254 */
1255 /** Driver Probe Response offloading support for WPS ver. 1 */
1256 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1257 /** Driver Probe Response offloading support for WPS ver. 2 */
1258 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1259 /** Driver Probe Response offloading support for P2P */
1260 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1261 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1262 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1263 unsigned int probe_resp_offloads;
1264
1265 unsigned int max_acl_mac_addrs;
1266
1267 /**
1268 * Number of supported concurrent channels
1269 */
1270 unsigned int num_multichan_concurrent;
1271
1272 /**
1273 * extended_capa - extended capabilities in driver/device
1274 *
1275 * Must be allocated and freed by driver and the pointers must be
1276 * valid for the lifetime of the driver, i.e., freed in deinit()
1277 */
1278 const u8 *extended_capa, *extended_capa_mask;
1279 unsigned int extended_capa_len;
1280
1281 struct wowlan_triggers wowlan_triggers;
1282
1283 /** Driver adds the DS Params Set IE in Probe Request frames */
1284 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1285 /** Driver adds the WFA TPC IE in Probe Request frames */
1286 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1287 /** Driver handles quiet period requests */
1288 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1289 /**
1290 * Driver is capable of inserting the current TX power value into the body of
1291 * transmitted frames.
1292 * Background: Some Action frames include a TPC Report IE. This IE contains a
1293 * TX power field, which has to be updated by lower layers. One such Action
1294 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1295 * of spectrum management). Note that this insertion takes place at a fixed
1296 * offset, namely the 6th byte in the Action frame body.
1297 */
1298 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1299 u32 rrm_flags;
1300
1301 /* Driver concurrency capabilities */
1302 unsigned int conc_capab;
1303 /* Maximum number of concurrent channels on 2.4 GHz */
1304 unsigned int max_conc_chan_2_4;
1305 /* Maximum number of concurrent channels on 5 GHz */
1306 unsigned int max_conc_chan_5_0;
1307 };
1308
1309
1310 struct hostapd_data;
1311
1312 struct hostap_sta_driver_data {
1313 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1314 unsigned long current_tx_rate;
1315 unsigned long inactive_msec;
1316 unsigned long flags;
1317 unsigned long num_ps_buf_frames;
1318 unsigned long tx_retry_failed;
1319 unsigned long tx_retry_count;
1320 int last_rssi;
1321 int last_ack_rssi;
1322 };
1323
1324 struct hostapd_sta_add_params {
1325 const u8 *addr;
1326 u16 aid;
1327 u16 capability;
1328 const u8 *supp_rates;
1329 size_t supp_rates_len;
1330 u16 listen_interval;
1331 const struct ieee80211_ht_capabilities *ht_capabilities;
1332 const struct ieee80211_vht_capabilities *vht_capabilities;
1333 int vht_opmode_enabled;
1334 u8 vht_opmode;
1335 u32 flags; /* bitmask of WPA_STA_* flags */
1336 u32 flags_mask; /* unset bits in flags */
1337 #ifdef CONFIG_MESH
1338 enum mesh_plink_state plink_state;
1339 #endif /* CONFIG_MESH */
1340 int set; /* Set STA parameters instead of add */
1341 u8 qosinfo;
1342 const u8 *ext_capab;
1343 size_t ext_capab_len;
1344 const u8 *supp_channels;
1345 size_t supp_channels_len;
1346 const u8 *supp_oper_classes;
1347 size_t supp_oper_classes_len;
1348 };
1349
1350 struct mac_address {
1351 u8 addr[ETH_ALEN];
1352 };
1353
1354 struct hostapd_acl_params {
1355 u8 acl_policy;
1356 unsigned int num_mac_acl;
1357 struct mac_address mac_acl[0];
1358 };
1359
1360 enum wpa_driver_if_type {
1361 /**
1362 * WPA_IF_STATION - Station mode interface
1363 */
1364 WPA_IF_STATION,
1365
1366 /**
1367 * WPA_IF_AP_VLAN - AP mode VLAN interface
1368 *
1369 * This interface shares its address and Beacon frame with the main
1370 * BSS.
1371 */
1372 WPA_IF_AP_VLAN,
1373
1374 /**
1375 * WPA_IF_AP_BSS - AP mode BSS interface
1376 *
1377 * This interface has its own address and Beacon frame.
1378 */
1379 WPA_IF_AP_BSS,
1380
1381 /**
1382 * WPA_IF_P2P_GO - P2P Group Owner
1383 */
1384 WPA_IF_P2P_GO,
1385
1386 /**
1387 * WPA_IF_P2P_CLIENT - P2P Client
1388 */
1389 WPA_IF_P2P_CLIENT,
1390
1391 /**
1392 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1393 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1394 */
1395 WPA_IF_P2P_GROUP,
1396
1397 /**
1398 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1399 * abstracted P2P Device function in the driver
1400 */
1401 WPA_IF_P2P_DEVICE,
1402
1403 /*
1404 * WPA_IF_MESH - Mesh interface
1405 */
1406 WPA_IF_MESH,
1407 };
1408
1409 struct wpa_init_params {
1410 void *global_priv;
1411 const u8 *bssid;
1412 const char *ifname;
1413 const char *driver_params;
1414 int use_pae_group_addr;
1415 char **bridge;
1416 size_t num_bridge;
1417
1418 u8 *own_addr; /* buffer for writing own MAC address */
1419 };
1420
1421
1422 struct wpa_bss_params {
1423 /** Interface name (for multi-SSID/VLAN support) */
1424 const char *ifname;
1425 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1426 int enabled;
1427
1428 int wpa;
1429 int ieee802_1x;
1430 int wpa_group;
1431 int wpa_pairwise;
1432 int wpa_key_mgmt;
1433 int rsn_preauth;
1434 enum mfp_options ieee80211w;
1435 };
1436
1437 #define WPA_STA_AUTHORIZED BIT(0)
1438 #define WPA_STA_WMM BIT(1)
1439 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1440 #define WPA_STA_MFP BIT(3)
1441 #define WPA_STA_TDLS_PEER BIT(4)
1442 #define WPA_STA_AUTHENTICATED BIT(5)
1443
1444 enum tdls_oper {
1445 TDLS_DISCOVERY_REQ,
1446 TDLS_SETUP,
1447 TDLS_TEARDOWN,
1448 TDLS_ENABLE_LINK,
1449 TDLS_DISABLE_LINK,
1450 TDLS_ENABLE,
1451 TDLS_DISABLE
1452 };
1453
1454 enum wnm_oper {
1455 WNM_SLEEP_ENTER_CONFIRM,
1456 WNM_SLEEP_ENTER_FAIL,
1457 WNM_SLEEP_EXIT_CONFIRM,
1458 WNM_SLEEP_EXIT_FAIL,
1459 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1460 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1461 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1462 * a STA */
1463 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1464 * for a STA */
1465 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1466 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1467 * for a STA */
1468 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1469 };
1470
1471 /* enum chan_width - Channel width definitions */
1472 enum chan_width {
1473 CHAN_WIDTH_20_NOHT,
1474 CHAN_WIDTH_20,
1475 CHAN_WIDTH_40,
1476 CHAN_WIDTH_80,
1477 CHAN_WIDTH_80P80,
1478 CHAN_WIDTH_160,
1479 CHAN_WIDTH_UNKNOWN
1480 };
1481
1482 /**
1483 * struct wpa_signal_info - Information about channel signal quality
1484 */
1485 struct wpa_signal_info {
1486 u32 frequency;
1487 int above_threshold;
1488 int current_signal;
1489 int avg_signal;
1490 int avg_beacon_signal;
1491 int current_noise;
1492 int current_txrate;
1493 enum chan_width chanwidth;
1494 int center_frq1;
1495 int center_frq2;
1496 };
1497
1498 /**
1499 * struct beacon_data - Beacon data
1500 * @head: Head portion of Beacon frame (before TIM IE)
1501 * @tail: Tail portion of Beacon frame (after TIM IE)
1502 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1503 * @proberesp_ies: Extra information element(s) to add into Probe Response
1504 * frames or %NULL
1505 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1506 * Response frames or %NULL
1507 * @probe_resp: Probe Response frame template
1508 * @head_len: Length of @head
1509 * @tail_len: Length of @tail
1510 * @beacon_ies_len: Length of beacon_ies in octets
1511 * @proberesp_ies_len: Length of proberesp_ies in octets
1512 * @proberesp_ies_len: Length of proberesp_ies in octets
1513 * @probe_resp_len: Length of probe response template (@probe_resp)
1514 */
1515 struct beacon_data {
1516 u8 *head, *tail;
1517 u8 *beacon_ies;
1518 u8 *proberesp_ies;
1519 u8 *assocresp_ies;
1520 u8 *probe_resp;
1521
1522 size_t head_len, tail_len;
1523 size_t beacon_ies_len;
1524 size_t proberesp_ies_len;
1525 size_t assocresp_ies_len;
1526 size_t probe_resp_len;
1527 };
1528
1529 /**
1530 * struct csa_settings - Settings for channel switch command
1531 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1532 * @block_tx: 1 - block transmission for CSA period
1533 * @freq_params: Next channel frequency parameter
1534 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1535 * @beacon_after: Next beacon/probe resp/asooc resp info
1536 * @counter_offset_beacon: Offset to the count field in beacon's tail
1537 * @counter_offset_presp: Offset to the count field in probe resp.
1538 */
1539 struct csa_settings {
1540 u8 cs_count;
1541 u8 block_tx;
1542
1543 struct hostapd_freq_params freq_params;
1544 struct beacon_data beacon_csa;
1545 struct beacon_data beacon_after;
1546
1547 u16 counter_offset_beacon;
1548 u16 counter_offset_presp;
1549 };
1550
1551 /* TDLS peer capabilities for send_tdls_mgmt() */
1552 enum tdls_peer_capability {
1553 TDLS_PEER_HT = BIT(0),
1554 TDLS_PEER_VHT = BIT(1),
1555 TDLS_PEER_WMM = BIT(2),
1556 };
1557
1558 /* valid info in the wmm_params struct */
1559 enum wmm_params_valid_info {
1560 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1561 };
1562
1563 /**
1564 * struct wmm_params - WMM parameterss configured for this association
1565 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1566 * of the struct contain valid information.
1567 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1568 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1569 */
1570 struct wmm_params {
1571 u8 info_bitmap;
1572 u8 uapsd_queues;
1573 };
1574
1575 #ifdef CONFIG_MACSEC
1576 struct macsec_init_params {
1577 Boolean always_include_sci;
1578 Boolean use_es;
1579 Boolean use_scb;
1580 };
1581 #endif /* CONFIG_MACSEC */
1582
1583 enum drv_br_port_attr {
1584 DRV_BR_PORT_ATTR_PROXYARP,
1585 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1586 };
1587
1588 enum drv_br_net_param {
1589 DRV_BR_NET_PARAM_GARP_ACCEPT,
1590 DRV_BR_MULTICAST_SNOOPING,
1591 };
1592
1593 struct drv_acs_params {
1594 /* Selected mode (HOSTAPD_MODE_*) */
1595 enum hostapd_hw_mode hw_mode;
1596
1597 /* Indicates whether HT is enabled */
1598 int ht_enabled;
1599
1600 /* Indicates whether HT40 is enabled */
1601 int ht40_enabled;
1602
1603 /* Indicates whether VHT is enabled */
1604 int vht_enabled;
1605
1606 /* Configured ACS channel width */
1607 u16 ch_width;
1608
1609 /* ACS channel list info */
1610 unsigned int ch_list_len;
1611 const u8 *ch_list;
1612 const int *freq_list;
1613 };
1614
1615
1616 /**
1617 * struct wpa_driver_ops - Driver interface API definition
1618 *
1619 * This structure defines the API that each driver interface needs to implement
1620 * for core wpa_supplicant code. All driver specific functionality is captured
1621 * in this wrapper.
1622 */
1623 struct wpa_driver_ops {
1624 /** Name of the driver interface */
1625 const char *name;
1626 /** One line description of the driver interface */
1627 const char *desc;
1628
1629 /**
1630 * get_bssid - Get the current BSSID
1631 * @priv: private driver interface data
1632 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1633 *
1634 * Returns: 0 on success, -1 on failure
1635 *
1636 * Query kernel driver for the current BSSID and copy it to bssid.
1637 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1638 * associated.
1639 */
1640 int (*get_bssid)(void *priv, u8 *bssid);
1641
1642 /**
1643 * get_ssid - Get the current SSID
1644 * @priv: private driver interface data
1645 * @ssid: buffer for SSID (at least 32 bytes)
1646 *
1647 * Returns: Length of the SSID on success, -1 on failure
1648 *
1649 * Query kernel driver for the current SSID and copy it to ssid.
1650 * Returning zero is recommended if the STA is not associated.
1651 *
1652 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1653 * can, at least in theory, contain control characters (including nul)
1654 * and as such, should be processed as binary data, not a printable
1655 * string.
1656 */
1657 int (*get_ssid)(void *priv, u8 *ssid);
1658
1659 /**
1660 * set_key - Configure encryption key
1661 * @ifname: Interface name (for multi-SSID/VLAN support)
1662 * @priv: private driver interface data
1663 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1664 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1665 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1666 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1667 * %WPA_ALG_BIP_CMAC_256);
1668 * %WPA_ALG_NONE clears the key.
1669 * @addr: Address of the peer STA (BSSID of the current AP when setting
1670 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1671 * broadcast keys, %NULL for default keys that are used both for
1672 * broadcast and unicast; when clearing keys, %NULL is used to
1673 * indicate that both the broadcast-only and default key of the
1674 * specified key index is to be cleared
1675 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1676 * IGTK
1677 * @set_tx: configure this key as the default Tx key (only used when
1678 * driver does not support separate unicast/individual key
1679 * @seq: sequence number/packet number, seq_len octets, the next
1680 * packet number to be used for in replay protection; configured
1681 * for Rx keys (in most cases, this is only used with broadcast
1682 * keys and set to zero for unicast keys); %NULL if not set
1683 * @seq_len: length of the seq, depends on the algorithm:
1684 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1685 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1686 * 8-byte Rx Mic Key
1687 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1688 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1689 *
1690 * Returns: 0 on success, -1 on failure
1691 *
1692 * Configure the given key for the kernel driver. If the driver
1693 * supports separate individual keys (4 default keys + 1 individual),
1694 * addr can be used to determine whether the key is default or
1695 * individual. If only 4 keys are supported, the default key with key
1696 * index 0 is used as the individual key. STA must be configured to use
1697 * it as the default Tx key (set_tx is set) and accept Rx for all the
1698 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1699 * broadcast keys, so key index 0 is available for this kind of
1700 * configuration.
1701 *
1702 * Please note that TKIP keys include separate TX and RX MIC keys and
1703 * some drivers may expect them in different order than wpa_supplicant
1704 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1705 * will trigger Michael MIC errors. This can be fixed by changing the
1706 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1707 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1708 * example on how this can be done.
1709 */
1710 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1711 const u8 *addr, int key_idx, int set_tx,
1712 const u8 *seq, size_t seq_len,
1713 const u8 *key, size_t key_len);
1714
1715 /**
1716 * init - Initialize driver interface
1717 * @ctx: context to be used when calling wpa_supplicant functions,
1718 * e.g., wpa_supplicant_event()
1719 * @ifname: interface name, e.g., wlan0
1720 *
1721 * Returns: Pointer to private data, %NULL on failure
1722 *
1723 * Initialize driver interface, including event processing for kernel
1724 * driver events (e.g., associated, scan results, Michael MIC failure).
1725 * This function can allocate a private configuration data area for
1726 * @ctx, file descriptor, interface name, etc. information that may be
1727 * needed in future driver operations. If this is not used, non-NULL
1728 * value will need to be returned because %NULL is used to indicate
1729 * failure. The returned value will be used as 'void *priv' data for
1730 * all other driver_ops functions.
1731 *
1732 * The main event loop (eloop.c) of wpa_supplicant can be used to
1733 * register callback for read sockets (eloop_register_read_sock()).
1734 *
1735 * See below for more information about events and
1736 * wpa_supplicant_event() function.
1737 */
1738 void * (*init)(void *ctx, const char *ifname);
1739
1740 /**
1741 * deinit - Deinitialize driver interface
1742 * @priv: private driver interface data from init()
1743 *
1744 * Shut down driver interface and processing of driver events. Free
1745 * private data buffer if one was allocated in init() handler.
1746 */
1747 void (*deinit)(void *priv);
1748
1749 /**
1750 * set_param - Set driver configuration parameters
1751 * @priv: private driver interface data from init()
1752 * @param: driver specific configuration parameters
1753 *
1754 * Returns: 0 on success, -1 on failure
1755 *
1756 * Optional handler for notifying driver interface about configuration
1757 * parameters (driver_param).
1758 */
1759 int (*set_param)(void *priv, const char *param);
1760
1761 /**
1762 * set_countermeasures - Enable/disable TKIP countermeasures
1763 * @priv: private driver interface data
1764 * @enabled: 1 = countermeasures enabled, 0 = disabled
1765 *
1766 * Returns: 0 on success, -1 on failure
1767 *
1768 * Configure TKIP countermeasures. When these are enabled, the driver
1769 * should drop all received and queued frames that are using TKIP.
1770 */
1771 int (*set_countermeasures)(void *priv, int enabled);
1772
1773 /**
1774 * deauthenticate - Request driver to deauthenticate
1775 * @priv: private driver interface data
1776 * @addr: peer address (BSSID of the AP)
1777 * @reason_code: 16-bit reason code to be sent in the deauthentication
1778 * frame
1779 *
1780 * Returns: 0 on success, -1 on failure
1781 */
1782 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1783
1784 /**
1785 * associate - Request driver to associate
1786 * @priv: private driver interface data
1787 * @params: association parameters
1788 *
1789 * Returns: 0 on success, -1 on failure
1790 */
1791 int (*associate)(void *priv,
1792 struct wpa_driver_associate_params *params);
1793
1794 /**
1795 * add_pmkid - Add PMKSA cache entry to the driver
1796 * @priv: private driver interface data
1797 * @bssid: BSSID for the PMKSA cache entry
1798 * @pmkid: PMKID for the PMKSA cache entry
1799 *
1800 * Returns: 0 on success, -1 on failure
1801 *
1802 * This function is called when a new PMK is received, as a result of
1803 * either normal authentication or RSN pre-authentication.
1804 *
1805 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1806 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1807 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1808 * driver_ops function does not need to be implemented. Likewise, if
1809 * the driver does not support WPA, this function is not needed.
1810 */
1811 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1812
1813 /**
1814 * remove_pmkid - Remove PMKSA cache entry to the driver
1815 * @priv: private driver interface data
1816 * @bssid: BSSID for the PMKSA cache entry
1817 * @pmkid: PMKID for the PMKSA cache entry
1818 *
1819 * Returns: 0 on success, -1 on failure
1820 *
1821 * This function is called when the supplicant drops a PMKSA cache
1822 * entry for any reason.
1823 *
1824 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1825 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1826 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1827 * from wpa_supplicant, this driver_ops function does not need to be
1828 * implemented. Likewise, if the driver does not support WPA, this
1829 * function is not needed.
1830 */
1831 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1832
1833 /**
1834 * flush_pmkid - Flush PMKSA cache
1835 * @priv: private driver interface data
1836 *
1837 * Returns: 0 on success, -1 on failure
1838 *
1839 * This function is called when the supplicant drops all PMKSA cache
1840 * entries for any reason.
1841 *
1842 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1843 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1844 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1845 * from wpa_supplicant, this driver_ops function does not need to be
1846 * implemented. Likewise, if the driver does not support WPA, this
1847 * function is not needed.
1848 */
1849 int (*flush_pmkid)(void *priv);
1850
1851 /**
1852 * get_capa - Get driver capabilities
1853 * @priv: private driver interface data
1854 *
1855 * Returns: 0 on success, -1 on failure
1856 *
1857 * Get driver/firmware/hardware capabilities.
1858 */
1859 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1860
1861 /**
1862 * poll - Poll driver for association information
1863 * @priv: private driver interface data
1864 *
1865 * This is an option callback that can be used when the driver does not
1866 * provide event mechanism for association events. This is called when
1867 * receiving WPA EAPOL-Key messages that require association
1868 * information. The driver interface is supposed to generate associnfo
1869 * event before returning from this callback function. In addition, the
1870 * driver interface should generate an association event after having
1871 * sent out associnfo.
1872 */
1873 void (*poll)(void *priv);
1874
1875 /**
1876 * get_ifname - Get interface name
1877 * @priv: private driver interface data
1878 *
1879 * Returns: Pointer to the interface name. This can differ from the
1880 * interface name used in init() call. Init() is called first.
1881 *
1882 * This optional function can be used to allow the driver interface to
1883 * replace the interface name with something else, e.g., based on an
1884 * interface mapping from a more descriptive name.
1885 */
1886 const char * (*get_ifname)(void *priv);
1887
1888 /**
1889 * get_mac_addr - Get own MAC address
1890 * @priv: private driver interface data
1891 *
1892 * Returns: Pointer to own MAC address or %NULL on failure
1893 *
1894 * This optional function can be used to get the own MAC address of the
1895 * device from the driver interface code. This is only needed if the
1896 * l2_packet implementation for the OS does not provide easy access to
1897 * a MAC address. */
1898 const u8 * (*get_mac_addr)(void *priv);
1899
1900 /**
1901 * set_operstate - Sets device operating state to DORMANT or UP
1902 * @priv: private driver interface data
1903 * @state: 0 = dormant, 1 = up
1904 * Returns: 0 on success, -1 on failure
1905 *
1906 * This is an optional function that can be used on operating systems
1907 * that support a concept of controlling network device state from user
1908 * space applications. This function, if set, gets called with
1909 * state = 1 when authentication has been completed and with state = 0
1910 * when connection is lost.
1911 */
1912 int (*set_operstate)(void *priv, int state);
1913
1914 /**
1915 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1916 * @priv: Private driver interface data
1917 * @addr: Address of the station for which to set protection (may be
1918 * %NULL for group keys)
1919 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1920 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1921 * Returns: 0 on success, -1 on failure
1922 *
1923 * This is an optional function that can be used to set the driver to
1924 * require protection for Tx and/or Rx frames. This uses the layer
1925 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1926 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1927 * set protection operation; instead, they set protection implicitly
1928 * based on configured keys.
1929 */
1930 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1931 int key_type);
1932
1933 /**
1934 * get_hw_feature_data - Get hardware support data (channels and rates)
1935 * @priv: Private driver interface data
1936 * @num_modes: Variable for returning the number of returned modes
1937 * flags: Variable for returning hardware feature flags
1938 * Returns: Pointer to allocated hardware data on success or %NULL on
1939 * failure. Caller is responsible for freeing this.
1940 */
1941 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1942 u16 *num_modes,
1943 u16 *flags);
1944
1945 /**
1946 * send_mlme - Send management frame from MLME
1947 * @priv: Private driver interface data
1948 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1949 * @data_len: Size of the management frame
1950 * @noack: Do not wait for this frame to be acked (disable retries)
1951 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
1952 * driver decide
1953 * Returns: 0 on success, -1 on failure
1954 */
1955 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1956 int noack, unsigned int freq);
1957
1958 /**
1959 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1960 * @priv: Private driver interface data
1961 * @md: Mobility domain (2 octets) (also included inside ies)
1962 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1963 * @ies_len: Length of FT IEs in bytes
1964 * Returns: 0 on success, -1 on failure
1965 *
1966 * The supplicant uses this callback to let the driver know that keying
1967 * material for FT is available and that the driver can use the
1968 * provided IEs in the next message in FT authentication sequence.
1969 *
1970 * This function is only needed for driver that support IEEE 802.11r
1971 * (Fast BSS Transition).
1972 */
1973 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1974 size_t ies_len);
1975
1976 /**
1977 * get_scan_results2 - Fetch the latest scan results
1978 * @priv: private driver interface data
1979 *
1980 * Returns: Allocated buffer of scan results (caller is responsible for
1981 * freeing the data structure) on success, NULL on failure
1982 */
1983 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1984
1985 /**
1986 * set_country - Set country
1987 * @priv: Private driver interface data
1988 * @alpha2: country to which to switch to
1989 * Returns: 0 on success, -1 on failure
1990 *
1991 * This function is for drivers which support some form
1992 * of setting a regulatory domain.
1993 */
1994 int (*set_country)(void *priv, const char *alpha2);
1995
1996 /**
1997 * get_country - Get country
1998 * @priv: Private driver interface data
1999 * @alpha2: Buffer for returning country code (at least 3 octets)
2000 * Returns: 0 on success, -1 on failure
2001 */
2002 int (*get_country)(void *priv, char *alpha2);
2003
2004 /**
2005 * global_init - Global driver initialization
2006 * Returns: Pointer to private data (global), %NULL on failure
2007 *
2008 * This optional function is called to initialize the driver wrapper
2009 * for global data, i.e., data that applies to all interfaces. If this
2010 * function is implemented, global_deinit() will also need to be
2011 * implemented to free the private data. The driver will also likely
2012 * use init2() function instead of init() to get the pointer to global
2013 * data available to per-interface initializer.
2014 */
2015 void * (*global_init)(void);
2016
2017 /**
2018 * global_deinit - Global driver deinitialization
2019 * @priv: private driver global data from global_init()
2020 *
2021 * Terminate any global driver related functionality and free the
2022 * global data structure.
2023 */
2024 void (*global_deinit)(void *priv);
2025
2026 /**
2027 * init2 - Initialize driver interface (with global data)
2028 * @ctx: context to be used when calling wpa_supplicant functions,
2029 * e.g., wpa_supplicant_event()
2030 * @ifname: interface name, e.g., wlan0
2031 * @global_priv: private driver global data from global_init()
2032 * Returns: Pointer to private data, %NULL on failure
2033 *
2034 * This function can be used instead of init() if the driver wrapper
2035 * uses global data.
2036 */
2037 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2038
2039 /**
2040 * get_interfaces - Get information about available interfaces
2041 * @global_priv: private driver global data from global_init()
2042 * Returns: Allocated buffer of interface information (caller is
2043 * responsible for freeing the data structure) on success, NULL on
2044 * failure
2045 */
2046 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2047
2048 /**
2049 * scan2 - Request the driver to initiate scan
2050 * @priv: private driver interface data
2051 * @params: Scan parameters
2052 *
2053 * Returns: 0 on success, -1 on failure
2054 *
2055 * Once the scan results are ready, the driver should report scan
2056 * results event for wpa_supplicant which will eventually request the
2057 * results with wpa_driver_get_scan_results2().
2058 */
2059 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2060
2061 /**
2062 * authenticate - Request driver to authenticate
2063 * @priv: private driver interface data
2064 * @params: authentication parameters
2065 * Returns: 0 on success, -1 on failure
2066 *
2067 * This is an optional function that can be used with drivers that
2068 * support separate authentication and association steps, i.e., when
2069 * wpa_supplicant can act as the SME. If not implemented, associate()
2070 * function is expected to take care of IEEE 802.11 authentication,
2071 * too.
2072 */
2073 int (*authenticate)(void *priv,
2074 struct wpa_driver_auth_params *params);
2075
2076 /**
2077 * set_ap - Set Beacon and Probe Response information for AP mode
2078 * @priv: Private driver interface data
2079 * @params: Parameters to use in AP mode
2080 *
2081 * This function is used to configure Beacon template and/or extra IEs
2082 * to add for Beacon and Probe Response frames for the driver in
2083 * AP mode. The driver is responsible for building the full Beacon
2084 * frame by concatenating the head part with TIM IE generated by the
2085 * driver/firmware and finishing with the tail part. Depending on the
2086 * driver architectue, this can be done either by using the full
2087 * template or the set of additional IEs (e.g., WPS and P2P IE).
2088 * Similarly, Probe Response processing depends on the driver design.
2089 * If the driver (or firmware) takes care of replying to Probe Request
2090 * frames, the extra IEs provided here needs to be added to the Probe
2091 * Response frames.
2092 *
2093 * Returns: 0 on success, -1 on failure
2094 */
2095 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
2096
2097 /**
2098 * set_acl - Set ACL in AP mode
2099 * @priv: Private driver interface data
2100 * @params: Parameters to configure ACL
2101 * Returns: 0 on success, -1 on failure
2102 *
2103 * This is used only for the drivers which support MAC address ACL.
2104 */
2105 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2106
2107 /**
2108 * hapd_init - Initialize driver interface (hostapd only)
2109 * @hapd: Pointer to hostapd context
2110 * @params: Configuration for the driver wrapper
2111 * Returns: Pointer to private data, %NULL on failure
2112 *
2113 * This function is used instead of init() or init2() when the driver
2114 * wrapper is used with hostapd.
2115 */
2116 void * (*hapd_init)(struct hostapd_data *hapd,
2117 struct wpa_init_params *params);
2118
2119 /**
2120 * hapd_deinit - Deinitialize driver interface (hostapd only)
2121 * @priv: Private driver interface data from hapd_init()
2122 */
2123 void (*hapd_deinit)(void *priv);
2124
2125 /**
2126 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2127 * @priv: Private driver interface data
2128 * @params: BSS parameters
2129 * Returns: 0 on success, -1 on failure
2130 *
2131 * This is an optional function to configure the kernel driver to
2132 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2133 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2134 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2135 * for Beacon frames.
2136 *
2137 * DEPRECATED - use set_ap() instead
2138 */
2139 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2140
2141 /**
2142 * set_privacy - Enable/disable privacy (AP only)
2143 * @priv: Private driver interface data
2144 * @enabled: 1 = privacy enabled, 0 = disabled
2145 * Returns: 0 on success, -1 on failure
2146 *
2147 * This is an optional function to configure privacy field in the
2148 * kernel driver for Beacon frames. This can be left undefined (set to
2149 * %NULL) if the driver uses the Beacon template from set_ap().
2150 *
2151 * DEPRECATED - use set_ap() instead
2152 */
2153 int (*set_privacy)(void *priv, int enabled);
2154
2155 /**
2156 * get_seqnum - Fetch the current TSC/packet number (AP only)
2157 * @ifname: The interface name (main or virtual)
2158 * @priv: Private driver interface data
2159 * @addr: MAC address of the station or %NULL for group keys
2160 * @idx: Key index
2161 * @seq: Buffer for returning the latest used TSC/packet number
2162 * Returns: 0 on success, -1 on failure
2163 *
2164 * This function is used to fetch the last used TSC/packet number for
2165 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2166 * keys, so there is no strict requirement on implementing support for
2167 * unicast keys (i.e., addr != %NULL).
2168 */
2169 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2170 int idx, u8 *seq);
2171
2172 /**
2173 * flush - Flush all association stations (AP only)
2174 * @priv: Private driver interface data
2175 * Returns: 0 on success, -1 on failure
2176 *
2177 * This function requests the driver to disassociate all associated
2178 * stations. This function does not need to be implemented if the
2179 * driver does not process association frames internally.
2180 */
2181 int (*flush)(void *priv);
2182
2183 /**
2184 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2185 * @priv: Private driver interface data
2186 * @elem: Information elements
2187 * @elem_len: Length of the elem buffer in octets
2188 * Returns: 0 on success, -1 on failure
2189 *
2190 * This is an optional function to add information elements in the
2191 * kernel driver for Beacon and Probe Response frames. This can be left
2192 * undefined (set to %NULL) if the driver uses the Beacon template from
2193 * set_ap().
2194 *
2195 * DEPRECATED - use set_ap() instead
2196 */
2197 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2198
2199 /**
2200 * read_sta_data - Fetch station data
2201 * @priv: Private driver interface data
2202 * @data: Buffer for returning station information
2203 * @addr: MAC address of the station
2204 * Returns: 0 on success, -1 on failure
2205 */
2206 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2207 const u8 *addr);
2208
2209 /**
2210 * hapd_send_eapol - Send an EAPOL packet (AP only)
2211 * @priv: private driver interface data
2212 * @addr: Destination MAC address
2213 * @data: EAPOL packet starting with IEEE 802.1X header
2214 * @data_len: Length of the EAPOL packet in octets
2215 * @encrypt: Whether the frame should be encrypted
2216 * @own_addr: Source MAC address
2217 * @flags: WPA_STA_* flags for the destination station
2218 *
2219 * Returns: 0 on success, -1 on failure
2220 */
2221 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2222 size_t data_len, int encrypt,
2223 const u8 *own_addr, u32 flags);
2224
2225 /**
2226 * sta_deauth - Deauthenticate a station (AP only)
2227 * @priv: Private driver interface data
2228 * @own_addr: Source address and BSSID for the Deauthentication frame
2229 * @addr: MAC address of the station to deauthenticate
2230 * @reason: Reason code for the Deauthentiation frame
2231 * Returns: 0 on success, -1 on failure
2232 *
2233 * This function requests a specific station to be deauthenticated and
2234 * a Deauthentication frame to be sent to it.
2235 */
2236 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2237 int reason);
2238
2239 /**
2240 * sta_disassoc - Disassociate a station (AP only)
2241 * @priv: Private driver interface data
2242 * @own_addr: Source address and BSSID for the Disassociation frame
2243 * @addr: MAC address of the station to disassociate
2244 * @reason: Reason code for the Disassociation frame
2245 * Returns: 0 on success, -1 on failure
2246 *
2247 * This function requests a specific station to be disassociated and
2248 * a Disassociation frame to be sent to it.
2249 */
2250 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2251 int reason);
2252
2253 /**
2254 * sta_remove - Remove a station entry (AP only)
2255 * @priv: Private driver interface data
2256 * @addr: MAC address of the station to be removed
2257 * Returns: 0 on success, -1 on failure
2258 */
2259 int (*sta_remove)(void *priv, const u8 *addr);
2260
2261 /**
2262 * hapd_get_ssid - Get the current SSID (AP only)
2263 * @priv: Private driver interface data
2264 * @buf: Buffer for returning the SSID
2265 * @len: Maximum length of the buffer
2266 * Returns: Length of the SSID on success, -1 on failure
2267 *
2268 * This function need not be implemented if the driver uses Beacon
2269 * template from set_ap() and does not reply to Probe Request frames.
2270 */
2271 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2272
2273 /**
2274 * hapd_set_ssid - Set SSID (AP only)
2275 * @priv: Private driver interface data
2276 * @buf: SSID
2277 * @len: Length of the SSID in octets
2278 * Returns: 0 on success, -1 on failure
2279 *
2280 * DEPRECATED - use set_ap() instead
2281 */
2282 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2283
2284 /**
2285 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2286 * @priv: Private driver interface data
2287 * @enabled: 1 = countermeasures enabled, 0 = disabled
2288 * Returns: 0 on success, -1 on failure
2289 *
2290 * This need not be implemented if the driver does not take care of
2291 * association processing.
2292 */
2293 int (*hapd_set_countermeasures)(void *priv, int enabled);
2294
2295 /**
2296 * sta_add - Add a station entry
2297 * @priv: Private driver interface data
2298 * @params: Station parameters
2299 * Returns: 0 on success, -1 on failure
2300 *
2301 * This function is used to add a station entry to the driver once the
2302 * station has completed association. This is only used if the driver
2303 * does not take care of association processing.
2304 *
2305 * With TDLS, this function is also used to add or set (params->set 1)
2306 * TDLS peer entries.
2307 */
2308 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2309
2310 /**
2311 * get_inact_sec - Get station inactivity duration (AP only)
2312 * @priv: Private driver interface data
2313 * @addr: Station address
2314 * Returns: Number of seconds station has been inactive, -1 on failure
2315 */
2316 int (*get_inact_sec)(void *priv, const u8 *addr);
2317
2318 /**
2319 * sta_clear_stats - Clear station statistics (AP only)
2320 * @priv: Private driver interface data
2321 * @addr: Station address
2322 * Returns: 0 on success, -1 on failure
2323 */
2324 int (*sta_clear_stats)(void *priv, const u8 *addr);
2325
2326 /**
2327 * set_freq - Set channel/frequency (AP only)
2328 * @priv: Private driver interface data
2329 * @freq: Channel parameters
2330 * Returns: 0 on success, -1 on failure
2331 */
2332 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2333
2334 /**
2335 * set_rts - Set RTS threshold
2336 * @priv: Private driver interface data
2337 * @rts: RTS threshold in octets
2338 * Returns: 0 on success, -1 on failure
2339 */
2340 int (*set_rts)(void *priv, int rts);
2341
2342 /**
2343 * set_frag - Set fragmentation threshold
2344 * @priv: Private driver interface data
2345 * @frag: Fragmentation threshold in octets
2346 * Returns: 0 on success, -1 on failure
2347 */
2348 int (*set_frag)(void *priv, int frag);
2349
2350 /**
2351 * sta_set_flags - Set station flags (AP only)
2352 * @priv: Private driver interface data
2353 * @addr: Station address
2354 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2355 * @flags_or: Bitmap of WPA_STA_* flags to add
2356 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2357 * Returns: 0 on success, -1 on failure
2358 */
2359 int (*sta_set_flags)(void *priv, const u8 *addr,
2360 unsigned int total_flags, unsigned int flags_or,
2361 unsigned int flags_and);
2362
2363 /**
2364 * set_tx_queue_params - Set TX queue parameters
2365 * @priv: Private driver interface data
2366 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2367 * @aifs: AIFS
2368 * @cw_min: cwMin
2369 * @cw_max: cwMax
2370 * @burst_time: Maximum length for bursting in 0.1 msec units
2371 */
2372 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2373 int cw_max, int burst_time);
2374
2375 /**
2376 * if_add - Add a virtual interface
2377 * @priv: Private driver interface data
2378 * @type: Interface type
2379 * @ifname: Interface name for the new virtual interface
2380 * @addr: Local address to use for the interface or %NULL to use the
2381 * parent interface address
2382 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2383 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2384 * not allowed (applies only to %WPA_IF_AP_BSS type)
2385 * @force_ifname: Buffer for returning an interface name that the
2386 * driver ended up using if it differs from the requested ifname
2387 * @if_addr: Buffer for returning the allocated interface address
2388 * (this may differ from the requested addr if the driver cannot
2389 * change interface address)
2390 * @bridge: Bridge interface to use or %NULL if no bridge configured
2391 * @use_existing: Whether to allow existing interface to be used
2392 * Returns: 0 on success, -1 on failure
2393 */
2394 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2395 const char *ifname, const u8 *addr, void *bss_ctx,
2396 void **drv_priv, char *force_ifname, u8 *if_addr,
2397 const char *bridge, int use_existing);
2398
2399 /**
2400 * if_remove - Remove a virtual interface
2401 * @priv: Private driver interface data
2402 * @type: Interface type
2403 * @ifname: Interface name of the virtual interface to be removed
2404 * Returns: 0 on success, -1 on failure
2405 */
2406 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2407 const char *ifname);
2408
2409 /**
2410 * set_sta_vlan - Bind a station into a specific interface (AP only)
2411 * @priv: Private driver interface data
2412 * @ifname: Interface (main or virtual BSS or VLAN)
2413 * @addr: MAC address of the associated station
2414 * @vlan_id: VLAN ID
2415 * Returns: 0 on success, -1 on failure
2416 *
2417 * This function is used to bind a station to a specific virtual
2418 * interface. It is only used if when virtual interfaces are supported,
2419 * e.g., to assign stations to different VLAN interfaces based on
2420 * information from a RADIUS server. This allows separate broadcast
2421 * domains to be used with a single BSS.
2422 */
2423 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2424 int vlan_id);
2425
2426 /**
2427 * commit - Optional commit changes handler (AP only)
2428 * @priv: driver private data
2429 * Returns: 0 on success, -1 on failure
2430 *
2431 * This optional handler function can be registered if the driver
2432 * interface implementation needs to commit changes (e.g., by setting
2433 * network interface up) at the end of initial configuration. If set,
2434 * this handler will be called after initial setup has been completed.
2435 */
2436 int (*commit)(void *priv);
2437
2438 /**
2439 * send_ether - Send an ethernet packet (AP only)
2440 * @priv: private driver interface data
2441 * @dst: Destination MAC address
2442 * @src: Source MAC address
2443 * @proto: Ethertype
2444 * @data: EAPOL packet starting with IEEE 802.1X header
2445 * @data_len: Length of the EAPOL packet in octets
2446 * Returns: 0 on success, -1 on failure
2447 */
2448 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2449 const u8 *data, size_t data_len);
2450
2451 /**
2452 * set_radius_acl_auth - Notification of RADIUS ACL change
2453 * @priv: Private driver interface data
2454 * @mac: MAC address of the station
2455 * @accepted: Whether the station was accepted
2456 * @session_timeout: Session timeout for the station
2457 * Returns: 0 on success, -1 on failure
2458 */
2459 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2460 u32 session_timeout);
2461
2462 /**
2463 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2464 * @priv: Private driver interface data
2465 * @mac: MAC address of the station
2466 * Returns: 0 on success, -1 on failure
2467 */
2468 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2469
2470 /**
2471 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2472 * @priv: Private driver interface data
2473 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2474 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2475 * extra IE(s)
2476 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2477 * to remove extra IE(s)
2478 * Returns: 0 on success, -1 on failure
2479 *
2480 * This is an optional function to add WPS IE in the kernel driver for
2481 * Beacon and Probe Response frames. This can be left undefined (set
2482 * to %NULL) if the driver uses the Beacon template from set_ap()
2483 * and does not process Probe Request frames. If the driver takes care
2484 * of (Re)Association frame processing, the assocresp buffer includes
2485 * WPS IE(s) that need to be added to (Re)Association Response frames
2486 * whenever a (Re)Association Request frame indicated use of WPS.
2487 *
2488 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2489 * frames when operating as a GO. The driver is responsible for adding
2490 * timing related attributes (e.g., NoA) in addition to the IEs
2491 * included here by appending them after these buffers. This call is
2492 * also used to provide Probe Response IEs for P2P Listen state
2493 * operations for drivers that generate the Probe Response frames
2494 * internally.
2495 *
2496 * DEPRECATED - use set_ap() instead
2497 */
2498 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2499 const struct wpabuf *proberesp,
2500 const struct wpabuf *assocresp);
2501
2502 /**
2503 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2504 * @priv: Private driver interface data
2505 * @authorized: Whether the port is authorized
2506 * Returns: 0 on success, -1 on failure
2507 */
2508 int (*set_supp_port)(void *priv, int authorized);
2509
2510 /**
2511 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2512 * @priv: Private driver interface data
2513 * @addr: MAC address of the associated station
2514 * @aid: Association ID
2515 * @val: 1 = bind to 4-address WDS; 0 = unbind
2516 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2517 * to indicate that bridge is not to be used
2518 * @ifname_wds: Buffer to return the interface name for the new WDS
2519 * station or %NULL to indicate name is not returned.
2520 * Returns: 0 on success, -1 on failure
2521 */
2522 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2523 const char *bridge_ifname, char *ifname_wds);
2524
2525 /**
2526 * send_action - Transmit an Action frame
2527 * @priv: Private driver interface data
2528 * @freq: Frequency (in MHz) of the channel
2529 * @wait: Time to wait off-channel for a response (in ms), or zero
2530 * @dst: Destination MAC address (Address 1)
2531 * @src: Source MAC address (Address 2)
2532 * @bssid: BSSID (Address 3)
2533 * @data: Frame body
2534 * @data_len: data length in octets
2535 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2536 * Returns: 0 on success, -1 on failure
2537 *
2538 * This command can be used to request the driver to transmit an action
2539 * frame to the specified destination.
2540 *
2541 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2542 * be transmitted on the given channel and the device will wait for a
2543 * response on that channel for the given wait time.
2544 *
2545 * If the flag is not set, the wait time will be ignored. In this case,
2546 * if a remain-on-channel duration is in progress, the frame must be
2547 * transmitted on that channel; alternatively the frame may be sent on
2548 * the current operational channel (if in associated state in station
2549 * mode or while operating as an AP.)
2550 */
2551 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2552 const u8 *dst, const u8 *src, const u8 *bssid,
2553 const u8 *data, size_t data_len, int no_cck);
2554
2555 /**
2556 * send_action_cancel_wait - Cancel action frame TX wait
2557 * @priv: Private driver interface data
2558 *
2559 * This command cancels the wait time associated with sending an action
2560 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2561 * set in the driver flags.
2562 */
2563 void (*send_action_cancel_wait)(void *priv);
2564
2565 /**
2566 * remain_on_channel - Remain awake on a channel
2567 * @priv: Private driver interface data
2568 * @freq: Frequency (in MHz) of the channel
2569 * @duration: Duration in milliseconds
2570 * Returns: 0 on success, -1 on failure
2571 *
2572 * This command is used to request the driver to remain awake on the
2573 * specified channel for the specified duration and report received
2574 * Action frames with EVENT_RX_MGMT events. Optionally, received
2575 * Probe Request frames may also be requested to be reported by calling
2576 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2577 *
2578 * The driver may not be at the requested channel when this function
2579 * returns, i.e., the return code is only indicating whether the
2580 * request was accepted. The caller will need to wait until the
2581 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2582 * completed the channel change. This may take some time due to other
2583 * need for the radio and the caller should be prepared to timing out
2584 * its wait since there are no guarantees on when this request can be
2585 * executed.
2586 */
2587 int (*remain_on_channel)(void *priv, unsigned int freq,
2588 unsigned int duration);
2589
2590 /**
2591 * cancel_remain_on_channel - Cancel remain-on-channel operation
2592 * @priv: Private driver interface data
2593 *
2594 * This command can be used to cancel a remain-on-channel operation
2595 * before its originally requested duration has passed. This could be
2596 * used, e.g., when remain_on_channel() is used to request extra time
2597 * to receive a response to an Action frame and the response is
2598 * received when there is still unneeded time remaining on the
2599 * remain-on-channel operation.
2600 */
2601 int (*cancel_remain_on_channel)(void *priv);
2602
2603 /**
2604 * probe_req_report - Request Probe Request frames to be indicated
2605 * @priv: Private driver interface data
2606 * @report: Whether to report received Probe Request frames
2607 * Returns: 0 on success, -1 on failure (or if not supported)
2608 *
2609 * This command can be used to request the driver to indicate when
2610 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2611 * Since this operation may require extra resources, e.g., due to less
2612 * optimal hardware/firmware RX filtering, many drivers may disable
2613 * Probe Request reporting at least in station mode. This command is
2614 * used to notify the driver when the Probe Request frames need to be
2615 * reported, e.g., during remain-on-channel operations.
2616 */
2617 int (*probe_req_report)(void *priv, int report);
2618
2619 /**
2620 * deinit_ap - Deinitialize AP mode
2621 * @priv: Private driver interface data
2622 * Returns: 0 on success, -1 on failure (or if not supported)
2623 *
2624 * This optional function can be used to disable AP mode related
2625 * configuration. If the interface was not dynamically added,
2626 * change the driver mode to station mode to allow normal station
2627 * operations like scanning to be completed.
2628 */
2629 int (*deinit_ap)(void *priv);
2630
2631 /**
2632 * deinit_p2p_cli - Deinitialize P2P client mode
2633 * @priv: Private driver interface data
2634 * Returns: 0 on success, -1 on failure (or if not supported)
2635 *
2636 * This optional function can be used to disable P2P client mode. If the
2637 * interface was not dynamically added, change the interface type back
2638 * to station mode.
2639 */
2640 int (*deinit_p2p_cli)(void *priv);
2641
2642 /**
2643 * suspend - Notification on system suspend/hibernate event
2644 * @priv: Private driver interface data
2645 */
2646 void (*suspend)(void *priv);
2647
2648 /**
2649 * resume - Notification on system resume/thaw event
2650 * @priv: Private driver interface data
2651 */
2652 void (*resume)(void *priv);
2653
2654 /**
2655 * signal_monitor - Set signal monitoring parameters
2656 * @priv: Private driver interface data
2657 * @threshold: Threshold value for signal change events; 0 = disabled
2658 * @hysteresis: Minimum change in signal strength before indicating a
2659 * new event
2660 * Returns: 0 on success, -1 on failure (or if not supported)
2661 *
2662 * This function can be used to configure monitoring of signal strength
2663 * with the current AP. Whenever signal strength drops below the
2664 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2665 * should be generated assuming the signal strength has changed at
2666 * least %hysteresis from the previously indicated signal change event.
2667 */
2668 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2669
2670 /**
2671 * send_frame - Send IEEE 802.11 frame (testing use only)
2672 * @priv: Private driver interface data
2673 * @data: IEEE 802.11 frame with IEEE 802.11 header
2674 * @data_len: Size of the frame
2675 * @encrypt: Whether to encrypt the frame (if keys are set)
2676 * Returns: 0 on success, -1 on failure
2677 *
2678 * This function is only used for debugging purposes and is not
2679 * required to be implemented for normal operations.
2680 */
2681 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2682 int encrypt);
2683
2684 /**
2685 * get_noa - Get current Notice of Absence attribute payload
2686 * @priv: Private driver interface data
2687 * @buf: Buffer for returning NoA
2688 * @buf_len: Buffer length in octets
2689 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2690 * advertized, or -1 on failure
2691 *
2692 * This function is used to fetch the current Notice of Absence
2693 * attribute value from GO.
2694 */
2695 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2696
2697 /**
2698 * set_noa - Set Notice of Absence parameters for GO (testing)
2699 * @priv: Private driver interface data
2700 * @count: Count
2701 * @start: Start time in ms from next TBTT
2702 * @duration: Duration in ms
2703 * Returns: 0 on success or -1 on failure
2704 *
2705 * This function is used to set Notice of Absence parameters for GO. It
2706 * is used only for testing. To disable NoA, all parameters are set to
2707 * 0.
2708 */
2709 int (*set_noa)(void *priv, u8 count, int start, int duration);
2710
2711 /**
2712 * set_p2p_powersave - Set P2P power save options
2713 * @priv: Private driver interface data
2714 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2715 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2716 * @ctwindow: 0.. = change (msec), -1 = no change
2717 * Returns: 0 on success or -1 on failure
2718 */
2719 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2720 int ctwindow);
2721
2722 /**
2723 * ampdu - Enable/disable aggregation
2724 * @priv: Private driver interface data
2725 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2726 * Returns: 0 on success or -1 on failure
2727 */
2728 int (*ampdu)(void *priv, int ampdu);
2729
2730 /**
2731 * get_radio_name - Get physical radio name for the device
2732 * @priv: Private driver interface data
2733 * Returns: Radio name or %NULL if not known
2734 *
2735 * The returned data must not be modified by the caller. It is assumed
2736 * that any interface that has the same radio name as another is
2737 * sharing the same physical radio. This information can be used to
2738 * share scan results etc. information between the virtual interfaces
2739 * to speed up various operations.
2740 */
2741 const char * (*get_radio_name)(void *priv);
2742
2743 /**
2744 * send_tdls_mgmt - for sending TDLS management packets
2745 * @priv: private driver interface data
2746 * @dst: Destination (peer) MAC address
2747 * @action_code: TDLS action code for the mssage
2748 * @dialog_token: Dialog Token to use in the message (if needed)
2749 * @status_code: Status Code or Reason Code to use (if needed)
2750 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2751 * @initiator: Is the current end the TDLS link initiator
2752 * @buf: TDLS IEs to add to the message
2753 * @len: Length of buf in octets
2754 * Returns: 0 on success, negative (<0) on failure
2755 *
2756 * This optional function can be used to send packet to driver which is
2757 * responsible for receiving and sending all TDLS packets.
2758 */
2759 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2760 u8 dialog_token, u16 status_code, u32 peer_capab,
2761 int initiator, const u8 *buf, size_t len);
2762
2763 /**
2764 * tdls_oper - Ask the driver to perform high-level TDLS operations
2765 * @priv: Private driver interface data
2766 * @oper: TDLS high-level operation. See %enum tdls_oper
2767 * @peer: Destination (peer) MAC address
2768 * Returns: 0 on success, negative (<0) on failure
2769 *
2770 * This optional function can be used to send high-level TDLS commands
2771 * to the driver.
2772 */
2773 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2774
2775 /**
2776 * wnm_oper - Notify driver of the WNM frame reception
2777 * @priv: Private driver interface data
2778 * @oper: WNM operation. See %enum wnm_oper
2779 * @peer: Destination (peer) MAC address
2780 * @buf: Buffer for the driver to fill in (for getting IE)
2781 * @buf_len: Return the len of buf
2782 * Returns: 0 on success, negative (<0) on failure
2783 */
2784 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2785 u8 *buf, u16 *buf_len);
2786
2787 /**
2788 * set_qos_map - Set QoS Map
2789 * @priv: Private driver interface data
2790 * @qos_map_set: QoS Map
2791 * @qos_map_set_len: Length of QoS Map
2792 */
2793 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2794 u8 qos_map_set_len);
2795
2796 /**
2797 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2798 * @priv: Private driver interface data
2799 * @version: IP version of the IP address, 4 or 6
2800 * @ipaddr: IP address for the neigh entry
2801 * @prefixlen: IP address prefix length
2802 * @addr: Corresponding MAC address
2803 * Returns: 0 on success, negative (<0) on failure
2804 */
2805 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2806 int prefixlen, const u8 *addr);
2807
2808 /**
2809 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2810 * @priv: Private driver interface data
2811 * @version: IP version of the IP address, 4 or 6
2812 * @ipaddr: IP address for the neigh entry
2813 * Returns: 0 on success, negative (<0) on failure
2814 */
2815 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2816
2817 /**
2818 * br_port_set_attr - Set a bridge port attribute
2819 * @attr: Bridge port attribute to set
2820 * @val: Value to be set
2821 * Returns: 0 on success, negative (<0) on failure
2822 */
2823 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2824 unsigned int val);
2825
2826 /**
2827 * br_port_set_attr - Set a bridge network parameter
2828 * @param: Bridge parameter to set
2829 * @val: Value to be set
2830 * Returns: 0 on success, negative (<0) on failure
2831 */
2832 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2833 unsigned int val);
2834
2835 /**
2836 * set_wowlan - Set wake-on-wireless triggers
2837 * @priv: Private driver interface data
2838 * @triggers: wowlan triggers
2839 */
2840 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2841
2842 /**
2843 * signal_poll - Get current connection information
2844 * @priv: Private driver interface data
2845 * @signal_info: Connection info structure
2846 */
2847 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2848
2849 /**
2850 * set_authmode - Set authentication algorithm(s) for static WEP
2851 * @priv: Private driver interface data
2852 * @authmode: 1=Open System, 2=Shared Key, 3=both
2853 * Returns: 0 on success, -1 on failure
2854 *
2855 * This function can be used to set authentication algorithms for AP
2856 * mode when static WEP is used. If the driver uses user space MLME/SME
2857 * implementation, there is no need to implement this function.
2858 *
2859 * DEPRECATED - use set_ap() instead
2860 */
2861 int (*set_authmode)(void *priv, int authmode);
2862
2863 #ifdef ANDROID
2864 /**
2865 * driver_cmd - Execute driver-specific command
2866 * @priv: Private driver interface data
2867 * @cmd: Command to execute
2868 * @buf: Return buffer
2869 * @buf_len: Buffer length
2870 * Returns: 0 on success, -1 on failure
2871 */
2872 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2873 #endif /* ANDROID */
2874
2875 /**
2876 * vendor_cmd - Execute vendor specific command
2877 * @priv: Private driver interface data
2878 * @vendor_id: Vendor id
2879 * @subcmd: Vendor command id
2880 * @data: Vendor command parameters (%NULL if no parameters)
2881 * @data_len: Data length
2882 * @buf: Return buffer (%NULL to ignore reply)
2883 * Returns: 0 on success, negative (<0) on failure
2884 *
2885 * This function handles vendor specific commands that are passed to
2886 * the driver/device. The command is identified by vendor id and
2887 * command id. Parameters can be passed as argument to the command
2888 * in the data buffer. Reply (if any) will be filled in the supplied
2889 * return buffer.
2890 *
2891 * The exact driver behavior is driver interface and vendor specific. As
2892 * an example, this will be converted to a vendor specific cfg80211
2893 * command in case of the nl80211 driver interface.
2894 */
2895 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2896 unsigned int subcmd, const u8 *data, size_t data_len,
2897 struct wpabuf *buf);
2898
2899 /**
2900 * set_rekey_info - Set rekey information
2901 * @priv: Private driver interface data
2902 * @kek: Current KEK
2903 * @kek_len: KEK length in octets
2904 * @kck: Current KCK
2905 * @kck_len: KCK length in octets
2906 * @replay_ctr: Current EAPOL-Key Replay Counter
2907 *
2908 * This optional function can be used to provide information for the
2909 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2910 * while the host (including wpa_supplicant) is sleeping.
2911 */
2912 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
2913 const u8 *kck, size_t kck_len,
2914 const u8 *replay_ctr);
2915
2916 /**
2917 * sta_assoc - Station association indication
2918 * @priv: Private driver interface data
2919 * @own_addr: Source address and BSSID for association frame
2920 * @addr: MAC address of the station to associate
2921 * @reassoc: flag to indicate re-association
2922 * @status: association response status code
2923 * @ie: assoc response ie buffer
2924 * @len: ie buffer length
2925 * Returns: 0 on success, -1 on failure
2926 *
2927 * This function indicates the driver to send (Re)Association
2928 * Response frame to the station.
2929 */
2930 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2931 int reassoc, u16 status, const u8 *ie, size_t len);
2932
2933 /**
2934 * sta_auth - Station authentication indication
2935 * @priv: Private driver interface data
2936 * @own_addr: Source address and BSSID for authentication frame
2937 * @addr: MAC address of the station to associate
2938 * @seq: authentication sequence number
2939 * @status: authentication response status code
2940 * @ie: authentication frame ie buffer
2941 * @len: ie buffer length
2942 *
2943 * This function indicates the driver to send Authentication frame
2944 * to the station.
2945 */
2946 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2947 u16 seq, u16 status, const u8 *ie, size_t len);
2948
2949 /**
2950 * add_tspec - Add traffic stream
2951 * @priv: Private driver interface data
2952 * @addr: MAC address of the station to associate
2953 * @tspec_ie: tspec ie buffer
2954 * @tspec_ielen: tspec ie length
2955 * Returns: 0 on success, -1 on failure
2956 *
2957 * This function adds the traffic steam for the station
2958 * and fills the medium_time in tspec_ie.
2959 */
2960 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2961 size_t tspec_ielen);
2962
2963 /**
2964 * add_sta_node - Add a station node in the driver
2965 * @priv: Private driver interface data
2966 * @addr: MAC address of the station to add
2967 * @auth_alg: authentication algorithm used by the station
2968 * Returns: 0 on success, -1 on failure
2969 *
2970 * This function adds the station node in the driver, when
2971 * the station gets added by FT-over-DS.
2972 */
2973 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2974
2975 /**
2976 * sched_scan - Request the driver to initiate scheduled scan
2977 * @priv: Private driver interface data
2978 * @params: Scan parameters
2979 * @interval: Interval between scan cycles in milliseconds
2980 * Returns: 0 on success, -1 on failure
2981 *
2982 * This operation should be used for scheduled scan offload to
2983 * the hardware. Every time scan results are available, the
2984 * driver should report scan results event for wpa_supplicant
2985 * which will eventually request the results with
2986 * wpa_driver_get_scan_results2(). This operation is optional
2987 * and if not provided or if it returns -1, we fall back to
2988 * normal host-scheduled scans.
2989 */
2990 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2991 u32 interval);
2992
2993 /**
2994 * stop_sched_scan - Request the driver to stop a scheduled scan
2995 * @priv: Private driver interface data
2996 * Returns: 0 on success, -1 on failure
2997 *
2998 * This should cause the scheduled scan to be stopped and
2999 * results should stop being sent. Must be supported if
3000 * sched_scan is supported.
3001 */
3002 int (*stop_sched_scan)(void *priv);
3003
3004 /**
3005 * poll_client - Probe (null data or such) the given station
3006 * @priv: Private driver interface data
3007 * @own_addr: MAC address of sending interface
3008 * @addr: MAC address of the station to probe
3009 * @qos: Indicates whether station is QoS station
3010 *
3011 * This function is used to verify whether an associated station is
3012 * still present. This function does not need to be implemented if the
3013 * driver provides such inactivity polling mechanism.
3014 */
3015 void (*poll_client)(void *priv, const u8 *own_addr,
3016 const u8 *addr, int qos);
3017
3018 /**
3019 * radio_disable - Disable/enable radio
3020 * @priv: Private driver interface data
3021 * @disabled: 1=disable 0=enable radio
3022 * Returns: 0 on success, -1 on failure
3023 *
3024 * This optional command is for testing purposes. It can be used to
3025 * disable the radio on a testbed device to simulate out-of-radio-range
3026 * conditions.
3027 */
3028 int (*radio_disable)(void *priv, int disabled);
3029
3030 /**
3031 * switch_channel - Announce channel switch and migrate the GO to the
3032 * given frequency
3033 * @priv: Private driver interface data
3034 * @settings: Settings for CSA period and new channel
3035 * Returns: 0 on success, -1 on failure
3036 *
3037 * This function is used to move the GO to the legacy STA channel to
3038 * avoid frequency conflict in single channel concurrency.
3039 */
3040 int (*switch_channel)(void *priv, struct csa_settings *settings);
3041
3042 /**
3043 * add_tx_ts - Add traffic stream
3044 * @priv: Private driver interface data
3045 * @tsid: Traffic stream ID
3046 * @addr: Receiver address
3047 * @user_prio: User priority of the traffic stream
3048 * @admitted_time: Admitted time for this TS in units of
3049 * 32 microsecond periods (per second).
3050 * Returns: 0 on success, -1 on failure
3051 */
3052 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3053 u16 admitted_time);
3054
3055 /**
3056 * del_tx_ts - Delete traffic stream
3057 * @priv: Private driver interface data
3058 * @tsid: Traffic stream ID
3059 * @addr: Receiver address
3060 * Returns: 0 on success, -1 on failure
3061 */
3062 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3063
3064 /**
3065 * Enable channel-switching with TDLS peer
3066 * @priv: Private driver interface data
3067 * @addr: MAC address of the TDLS peer
3068 * @oper_class: Operating class of the switch channel
3069 * @params: Channel specification
3070 * Returns: 0 on success, -1 on failure
3071 *
3072 * The function indicates to driver that it can start switching to a
3073 * different channel with a specified TDLS peer. The switching is
3074 * assumed on until canceled with tdls_disable_channel_switch().
3075 */
3076 int (*tdls_enable_channel_switch)(
3077 void *priv, const u8 *addr, u8 oper_class,
3078 const struct hostapd_freq_params *params);
3079
3080 /**
3081 * Disable channel switching with TDLS peer
3082 * @priv: Private driver interface data
3083 * @addr: MAC address of the TDLS peer
3084 * Returns: 0 on success, -1 on failure
3085 *
3086 * This function indicates to the driver that it should stop switching
3087 * with a given TDLS peer.
3088 */
3089 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3090
3091 /**
3092 * start_dfs_cac - Listen for radar interference on the channel
3093 * @priv: Private driver interface data
3094 * @freq: Channel parameters
3095 * Returns: 0 on success, -1 on failure
3096 */
3097 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
3098
3099 /**
3100 * stop_ap - Removes beacon from AP
3101 * @priv: Private driver interface data
3102 * Returns: 0 on success, -1 on failure (or if not supported)
3103 *
3104 * This optional function can be used to disable AP mode related
3105 * configuration. Unlike deinit_ap, it does not change to station
3106 * mode.
3107 */
3108 int (*stop_ap)(void *priv);
3109
3110 /**
3111 * get_survey - Retrieve survey data
3112 * @priv: Private driver interface data
3113 * @freq: If set, survey data for the specified frequency is only
3114 * being requested. If not set, all survey data is requested.
3115 * Returns: 0 on success, -1 on failure
3116 *
3117 * Use this to retrieve:
3118 *
3119 * - the observed channel noise floor
3120 * - the amount of time we have spent on the channel
3121 * - the amount of time during which we have spent on the channel that
3122 * the radio has determined the medium is busy and we cannot
3123 * transmit
3124 * - the amount of time we have spent receiving data
3125 * - the amount of time we have spent transmitting data
3126 *
3127 * This data can be used for spectrum heuristics. One example is
3128 * Automatic Channel Selection (ACS). The channel survey data is
3129 * kept on a linked list on the channel data, one entry is added
3130 * for each survey. The min_nf of the channel is updated for each
3131 * survey.
3132 */
3133 int (*get_survey)(void *priv, unsigned int freq);
3134
3135 /**
3136 * status - Get driver interface status information
3137 * @priv: Private driver interface data
3138 * @buf: Buffer for printing tou the status information
3139 * @buflen: Maximum length of the buffer
3140 * Returns: Length of written status information or -1 on failure
3141 */
3142 int (*status)(void *priv, char *buf, size_t buflen);
3143
3144 /**
3145 * roaming - Set roaming policy for driver-based BSS selection
3146 * @priv: Private driver interface data
3147 * @allowed: Whether roaming within ESS is allowed
3148 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3149 * Returns: Length of written status information or -1 on failure
3150 *
3151 * This optional callback can be used to update roaming policy from the
3152 * associate() command (bssid being set there indicates that the driver
3153 * should not roam before getting this roaming() call to allow roaming.
3154 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3155 * capability, roaming policy is handled within wpa_supplicant and there
3156 * is no need to implement or react to this callback.
3157 */
3158 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3159
3160 /**
3161 * set_mac_addr - Set MAC address
3162 * @priv: Private driver interface data
3163 * @addr: MAC address to use or %NULL for setting back to permanent
3164 * Returns: 0 on success, -1 on failure
3165 */
3166 int (*set_mac_addr)(void *priv, const u8 *addr);
3167
3168 #ifdef CONFIG_MACSEC
3169 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3170
3171 int (*macsec_deinit)(void *priv);
3172
3173 /**
3174 * enable_protect_frames - Set protect frames status
3175 * @priv: Private driver interface data
3176 * @enabled: TRUE = protect frames enabled
3177 * FALSE = protect frames disabled
3178 * Returns: 0 on success, -1 on failure (or if not supported)
3179 */
3180 int (*enable_protect_frames)(void *priv, Boolean enabled);
3181
3182 /**
3183 * set_replay_protect - Set replay protect status and window size
3184 * @priv: Private driver interface data
3185 * @enabled: TRUE = replay protect enabled
3186 * FALSE = replay protect disabled
3187 * @window: replay window size, valid only when replay protect enabled
3188 * Returns: 0 on success, -1 on failure (or if not supported)
3189 */
3190 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3191
3192 /**
3193 * set_current_cipher_suite - Set current cipher suite
3194 * @priv: Private driver interface data
3195 * @cs: EUI64 identifier
3196 * @cs_len: Length of the cs buffer in octets
3197 * Returns: 0 on success, -1 on failure (or if not supported)
3198 */
3199 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3200 size_t cs_len);
3201
3202 /**
3203 * enable_controlled_port - Set controlled port status
3204 * @priv: Private driver interface data
3205 * @enabled: TRUE = controlled port enabled
3206 * FALSE = controlled port disabled
3207 * Returns: 0 on success, -1 on failure (or if not supported)
3208 */
3209 int (*enable_controlled_port)(void *priv, Boolean enabled);
3210
3211 /**
3212 * get_receive_lowest_pn - Get receive lowest pn
3213 * @priv: Private driver interface data
3214 * @channel: secure channel
3215 * @an: association number
3216 * @lowest_pn: lowest accept pn
3217 * Returns: 0 on success, -1 on failure (or if not supported)
3218 */
3219 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3220 u32 *lowest_pn);
3221
3222 /**
3223 * get_transmit_next_pn - Get transmit next pn
3224 * @priv: Private driver interface data
3225 * @channel: secure channel
3226 * @an: association number
3227 * @next_pn: next pn
3228 * Returns: 0 on success, -1 on failure (or if not supported)
3229 */
3230 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3231 u32 *next_pn);
3232
3233 /**
3234 * set_transmit_next_pn - Set transmit next pn
3235 * @priv: Private driver interface data
3236 * @channel: secure channel
3237 * @an: association number
3238 * @next_pn: next pn
3239 * Returns: 0 on success, -1 on failure (or if not supported)
3240 */
3241 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3242 u32 next_pn);
3243
3244 /**
3245 * get_available_receive_sc - get available receive channel
3246 * @priv: Private driver interface data
3247 * @channel: secure channel
3248 * Returns: 0 on success, -1 on failure (or if not supported)
3249 */
3250 int (*get_available_receive_sc)(void *priv, u32 *channel);
3251
3252 /**
3253 * create_receive_sc - create secure channel for receiving
3254 * @priv: Private driver interface data
3255 * @channel: secure channel
3256 * @sci_addr: secure channel identifier - address
3257 * @sci_port: secure channel identifier - port
3258 * @conf_offset: confidentiality offset (0, 30, or 50)
3259 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3260 * 2 = Strict)
3261 * Returns: 0 on success, -1 on failure (or if not supported)
3262 */
3263 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3264 u16 sci_port, unsigned int conf_offset,
3265 int validation);
3266
3267 /**
3268 * delete_receive_sc - delete secure connection for receiving
3269 * @priv: private driver interface data from init()
3270 * @channel: secure channel
3271 * Returns: 0 on success, -1 on failure
3272 */
3273 int (*delete_receive_sc)(void *priv, u32 channel);
3274
3275 /**
3276 * create_receive_sa - create secure association for receive
3277 * @priv: private driver interface data from init()
3278 * @channel: secure channel
3279 * @an: association number
3280 * @lowest_pn: the lowest packet number can be received
3281 * @sak: the secure association key
3282 * Returns: 0 on success, -1 on failure
3283 */
3284 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3285 u32 lowest_pn, const u8 *sak);
3286
3287 /**
3288 * enable_receive_sa - enable the SA for receive
3289 * @priv: private driver interface data from init()
3290 * @channel: secure channel
3291 * @an: association number
3292 * Returns: 0 on success, -1 on failure
3293 */
3294 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3295
3296 /**
3297 * disable_receive_sa - disable SA for receive
3298 * @priv: private driver interface data from init()
3299 * @channel: secure channel index
3300 * @an: association number
3301 * Returns: 0 on success, -1 on failure
3302 */
3303 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3304
3305 /**
3306 * get_available_transmit_sc - get available transmit channel
3307 * @priv: Private driver interface data
3308 * @channel: secure channel
3309 * Returns: 0 on success, -1 on failure (or if not supported)
3310 */
3311 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3312
3313 /**
3314 * create_transmit_sc - create secure connection for transmit
3315 * @priv: private driver interface data from init()
3316 * @channel: secure channel
3317 * @sci_addr: secure channel identifier - address
3318 * @sci_port: secure channel identifier - port
3319 * Returns: 0 on success, -1 on failure
3320 */
3321 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3322 u16 sci_port, unsigned int conf_offset);
3323
3324 /**
3325 * delete_transmit_sc - delete secure connection for transmit
3326 * @priv: private driver interface data from init()
3327 * @channel: secure channel
3328 * Returns: 0 on success, -1 on failure
3329 */
3330 int (*delete_transmit_sc)(void *priv, u32 channel);
3331
3332 /**
3333 * create_transmit_sa - create secure association for transmit
3334 * @priv: private driver interface data from init()
3335 * @channel: secure channel index
3336 * @an: association number
3337 * @next_pn: the packet number used as next transmit packet
3338 * @confidentiality: True if the SA is to provide confidentiality
3339 * as well as integrity
3340 * @sak: the secure association key
3341 * Returns: 0 on success, -1 on failure
3342 */
3343 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3344 Boolean confidentiality, const u8 *sak);
3345
3346 /**
3347 * enable_transmit_sa - enable SA for transmit
3348 * @priv: private driver interface data from init()
3349 * @channel: secure channel
3350 * @an: association number
3351 * Returns: 0 on success, -1 on failure
3352 */
3353 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3354
3355 /**
3356 * disable_transmit_sa - disable SA for transmit
3357 * @priv: private driver interface data from init()
3358 * @channel: secure channel
3359 * @an: association number
3360 * Returns: 0 on success, -1 on failure
3361 */
3362 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3363 #endif /* CONFIG_MACSEC */
3364
3365 /**
3366 * init_mesh - Driver specific initialization for mesh
3367 * @priv: Private driver interface data
3368 * Returns: 0 on success, -1 on failure
3369 */
3370 int (*init_mesh)(void *priv);
3371
3372 /**
3373 * join_mesh - Join a mesh network
3374 * @priv: Private driver interface data
3375 * @params: Mesh configuration parameters
3376 * Returns: 0 on success, -1 on failure
3377 */
3378 int (*join_mesh)(void *priv,
3379 struct wpa_driver_mesh_join_params *params);
3380
3381 /**
3382 * leave_mesh - Leave a mesh network
3383 * @priv: Private driver interface data
3384 * Returns 0 on success, -1 on failure
3385 */
3386 int (*leave_mesh)(void *priv);
3387
3388 /**
3389 * do_acs - Automatically select channel
3390 * @priv: Private driver interface data
3391 * @params: Parameters for ACS
3392 * Returns 0 on success, -1 on failure
3393 *
3394 * This command can be used to offload ACS to the driver if the driver
3395 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3396 */
3397 int (*do_acs)(void *priv, struct drv_acs_params *params);
3398
3399 /**
3400 * set_band - Notify driver of band selection
3401 * @priv: Private driver interface data
3402 * @band: The selected band(s)
3403 * Returns 0 on success, -1 on failure
3404 */
3405 int (*set_band)(void *priv, enum set_band band);
3406 };
3407
3408
3409 /**
3410 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3411 */
3412 enum wpa_event_type {
3413 /**
3414 * EVENT_ASSOC - Association completed
3415 *
3416 * This event needs to be delivered when the driver completes IEEE
3417 * 802.11 association or reassociation successfully.
3418 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3419 * after this event has been generated. In addition, optional
3420 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3421 * more information about the association. If the driver interface gets
3422 * both of these events at the same time, it can also include the
3423 * assoc_info data in EVENT_ASSOC call.
3424 */
3425 EVENT_ASSOC,
3426
3427 /**
3428 * EVENT_DISASSOC - Association lost
3429 *
3430 * This event should be called when association is lost either due to
3431 * receiving deauthenticate or disassociate frame from the AP or when
3432 * sending either of these frames to the current AP. If the driver
3433 * supports separate deauthentication event, EVENT_DISASSOC should only
3434 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3435 * In AP mode, union wpa_event_data::disassoc_info is required.
3436 */
3437 EVENT_DISASSOC,
3438
3439 /**
3440 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3441 *
3442 * This event must be delivered when a Michael MIC error is detected by
3443 * the local driver. Additional data for event processing is
3444 * provided with union wpa_event_data::michael_mic_failure. This
3445 * information is used to request new encyption key and to initiate
3446 * TKIP countermeasures if needed.
3447 */
3448 EVENT_MICHAEL_MIC_FAILURE,
3449
3450 /**
3451 * EVENT_SCAN_RESULTS - Scan results available
3452 *
3453 * This event must be called whenever scan results are available to be
3454 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3455 * is expected to be used some time after struct wpa_driver_ops::scan()
3456 * is called. If the driver provides an unsolicited event when the scan
3457 * has been completed, this event can be used to trigger
3458 * EVENT_SCAN_RESULTS call. If such event is not available from the
3459 * driver, the driver wrapper code is expected to use a registered
3460 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3461 * scan is expected to be completed. Optional information about
3462 * completed scan can be provided with union wpa_event_data::scan_info.
3463 */
3464 EVENT_SCAN_RESULTS,
3465
3466 /**
3467 * EVENT_ASSOCINFO - Report optional extra information for association
3468 *
3469 * This event can be used to report extra association information for
3470 * EVENT_ASSOC processing. This extra information includes IEs from
3471 * association frames and Beacon/Probe Response frames in union
3472 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3473 * EVENT_ASSOC. Alternatively, the driver interface can include
3474 * assoc_info data in the EVENT_ASSOC call if it has all the
3475 * information available at the same point.
3476 */
3477 EVENT_ASSOCINFO,
3478
3479 /**
3480 * EVENT_INTERFACE_STATUS - Report interface status changes
3481 *
3482 * This optional event can be used to report changes in interface
3483 * status (interface added/removed) using union
3484 * wpa_event_data::interface_status. This can be used to trigger
3485 * wpa_supplicant to stop and re-start processing for the interface,
3486 * e.g., when a cardbus card is ejected/inserted.
3487 */
3488 EVENT_INTERFACE_STATUS,
3489
3490 /**
3491 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3492 *
3493 * This event can be used to inform wpa_supplicant about candidates for
3494 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3495 * for scan request (ap_scan=2 mode), this event is required for
3496 * pre-authentication. If wpa_supplicant is performing scan request
3497 * (ap_scan=1), this event is optional since scan results can be used
3498 * to add pre-authentication candidates. union
3499 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3500 * candidate and priority of the candidate, e.g., based on the signal
3501 * strength, in order to try to pre-authenticate first with candidates
3502 * that are most likely targets for re-association.
3503 *
3504 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3505 * on the candidate list. In addition, it can be called for the current
3506 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3507 * will automatically skip pre-authentication in cases where a valid
3508 * PMKSA exists. When more than one candidate exists, this event should
3509 * be generated once for each candidate.
3510 *
3511 * Driver will be notified about successful pre-authentication with
3512 * struct wpa_driver_ops::add_pmkid() calls.
3513 */
3514 EVENT_PMKID_CANDIDATE,
3515
3516 /**
3517 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3518 *
3519 * This event can be used to inform wpa_supplicant about desire to set
3520 * up secure direct link connection between two stations as defined in
3521 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3522 * STAKey negotiation. The caller will need to set peer address for the
3523 * event.
3524 */
3525 EVENT_STKSTART,
3526
3527 /**
3528 * EVENT_TDLS - Request TDLS operation
3529 *
3530 * This event can be used to request a TDLS operation to be performed.
3531 */
3532 EVENT_TDLS,
3533
3534 /**
3535 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3536 *
3537 * The driver is expected to report the received FT IEs from
3538 * FT authentication sequence from the AP. The FT IEs are included in
3539 * the extra information in union wpa_event_data::ft_ies.
3540 */
3541 EVENT_FT_RESPONSE,
3542
3543 /**
3544 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3545 *
3546 * The driver can use this event to inform wpa_supplicant about a STA
3547 * in an IBSS with which protected frames could be exchanged. This
3548 * event starts RSN authentication with the other STA to authenticate
3549 * the STA and set up encryption keys with it.
3550 */
3551 EVENT_IBSS_RSN_START,
3552
3553 /**
3554 * EVENT_AUTH - Authentication result
3555 *
3556 * This event should be called when authentication attempt has been
3557 * completed. This is only used if the driver supports separate
3558 * authentication step (struct wpa_driver_ops::authenticate).
3559 * Information about authentication result is included in
3560 * union wpa_event_data::auth.
3561 */
3562 EVENT_AUTH,
3563
3564 /**
3565 * EVENT_DEAUTH - Authentication lost
3566 *
3567 * This event should be called when authentication is lost either due
3568 * to receiving deauthenticate frame from the AP or when sending that
3569 * frame to the current AP.
3570 * In AP mode, union wpa_event_data::deauth_info is required.
3571 */
3572 EVENT_DEAUTH,
3573
3574 /**
3575 * EVENT_ASSOC_REJECT - Association rejected
3576 *
3577 * This event should be called when (re)association attempt has been
3578 * rejected by the AP. Information about the association response is
3579 * included in union wpa_event_data::assoc_reject.
3580 */
3581 EVENT_ASSOC_REJECT,
3582
3583 /**
3584 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3585 */
3586 EVENT_AUTH_TIMED_OUT,
3587
3588 /**
3589 * EVENT_ASSOC_TIMED_OUT - Association timed out
3590 */
3591 EVENT_ASSOC_TIMED_OUT,
3592
3593 /**
3594 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3595 */
3596 EVENT_WPS_BUTTON_PUSHED,
3597
3598 /**
3599 * EVENT_TX_STATUS - Report TX status
3600 */
3601 EVENT_TX_STATUS,
3602
3603 /**
3604 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3605 */
3606 EVENT_RX_FROM_UNKNOWN,
3607
3608 /**
3609 * EVENT_RX_MGMT - Report RX of a management frame
3610 */
3611 EVENT_RX_MGMT,
3612
3613 /**
3614 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3615 *
3616 * This event is used to indicate when the driver has started the
3617 * requested remain-on-channel duration. Information about the
3618 * operation is included in union wpa_event_data::remain_on_channel.
3619 */
3620 EVENT_REMAIN_ON_CHANNEL,
3621
3622 /**
3623 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3624 *
3625 * This event is used to indicate when the driver has completed
3626 * remain-on-channel duration, i.e., may noot be available on the
3627 * requested channel anymore. Information about the
3628 * operation is included in union wpa_event_data::remain_on_channel.
3629 */
3630 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3631
3632 /**
3633 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3634 *
3635 * This event is used to indicate when a Probe Request frame has been
3636 * received. Information about the received frame is included in
3637 * union wpa_event_data::rx_probe_req. The driver is required to report
3638 * these events only after successfully completed probe_req_report()
3639 * commands to request the events (i.e., report parameter is non-zero)
3640 * in station mode. In AP mode, Probe Request frames should always be
3641 * reported.
3642 */
3643 EVENT_RX_PROBE_REQ,
3644
3645 /**
3646 * EVENT_NEW_STA - New wired device noticed
3647 *
3648 * This event is used to indicate that a new device has been detected
3649 * in a network that does not use association-like functionality (i.e.,
3650 * mainly wired Ethernet). This can be used to start EAPOL
3651 * authenticator when receiving a frame from a device. The address of
3652 * the device is included in union wpa_event_data::new_sta.
3653 */
3654 EVENT_NEW_STA,
3655
3656 /**
3657 * EVENT_EAPOL_RX - Report received EAPOL frame
3658 *
3659 * When in AP mode with hostapd, this event is required to be used to
3660 * deliver the receive EAPOL frames from the driver.
3661 */
3662 EVENT_EAPOL_RX,
3663
3664 /**
3665 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3666 *
3667 * This event is used to indicate changes in the signal strength
3668 * observed in frames received from the current AP if signal strength
3669 * monitoring has been enabled with signal_monitor().
3670 */
3671 EVENT_SIGNAL_CHANGE,
3672
3673 /**
3674 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3675 *
3676 * This event is used to indicate that the interface was enabled after
3677 * having been previously disabled, e.g., due to rfkill.
3678 */
3679 EVENT_INTERFACE_ENABLED,
3680
3681 /**
3682 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3683 *
3684 * This event is used to indicate that the interface was disabled,
3685 * e.g., due to rfkill.
3686 */
3687 EVENT_INTERFACE_DISABLED,
3688
3689 /**
3690 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3691 *
3692 * This event is used to indicate that the channel list has changed,
3693 * e.g., because of a regulatory domain change triggered by scan
3694 * results including an AP advertising a country code.
3695 */
3696 EVENT_CHANNEL_LIST_CHANGED,
3697
3698 /**
3699 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3700 *
3701 * This event is used to indicate that the driver cannot maintain this
3702 * interface in its operation mode anymore. The most likely use for
3703 * this is to indicate that AP mode operation is not available due to
3704 * operating channel would need to be changed to a DFS channel when
3705 * the driver does not support radar detection and another virtual
3706 * interfaces caused the operating channel to change. Other similar
3707 * resource conflicts could also trigger this for station mode
3708 * interfaces. This event can be propagated when channel switching
3709 * fails.
3710 */
3711 EVENT_INTERFACE_UNAVAILABLE,
3712
3713 /**
3714 * EVENT_BEST_CHANNEL
3715 *
3716 * Driver generates this event whenever it detects a better channel
3717 * (e.g., based on RSSI or channel use). This information can be used
3718 * to improve channel selection for a new AP/P2P group.
3719 */
3720 EVENT_BEST_CHANNEL,
3721
3722 /**
3723 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3724 *
3725 * This event should be called when a Deauthentication frame is dropped
3726 * due to it not being protected (MFP/IEEE 802.11w).
3727 * union wpa_event_data::unprot_deauth is required to provide more
3728 * details of the frame.
3729 */
3730 EVENT_UNPROT_DEAUTH,
3731
3732 /**
3733 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3734 *
3735 * This event should be called when a Disassociation frame is dropped
3736 * due to it not being protected (MFP/IEEE 802.11w).
3737 * union wpa_event_data::unprot_disassoc is required to provide more
3738 * details of the frame.
3739 */
3740 EVENT_UNPROT_DISASSOC,
3741
3742 /**
3743 * EVENT_STATION_LOW_ACK
3744 *
3745 * Driver generates this event whenever it detected that a particular
3746 * station was lost. Detection can be through massive transmission
3747 * failures for example.
3748 */
3749 EVENT_STATION_LOW_ACK,
3750
3751 /**
3752 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3753 */
3754 EVENT_IBSS_PEER_LOST,
3755
3756 /**
3757 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3758 *
3759 * This event carries the new replay counter to notify wpa_supplicant
3760 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3761 * completed Group Key Handshake while the host (including
3762 * wpa_supplicant was sleeping).
3763 */
3764 EVENT_DRIVER_GTK_REKEY,
3765
3766 /**
3767 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3768 */
3769 EVENT_SCHED_SCAN_STOPPED,
3770
3771 /**
3772 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3773 *
3774 * This event indicates that the station responded to the poll
3775 * initiated with @poll_client.
3776 */
3777 EVENT_DRIVER_CLIENT_POLL_OK,
3778
3779 /**
3780 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3781 */
3782 EVENT_EAPOL_TX_STATUS,
3783
3784 /**
3785 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3786 *
3787 * Described in wpa_event_data.ch_switch
3788 * */
3789 EVENT_CH_SWITCH,
3790
3791 /**
3792 * EVENT_WNM - Request WNM operation
3793 *
3794 * This event can be used to request a WNM operation to be performed.
3795 */
3796 EVENT_WNM,
3797
3798 /**
3799 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3800 *
3801 * This event indicates that the driver reported a connection failure
3802 * with the specified client (for example, max client reached, etc.) in
3803 * AP mode.
3804 */
3805 EVENT_CONNECT_FAILED_REASON,
3806
3807 /**
3808 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
3809 *
3810 * A radar has been detected on the supplied frequency, hostapd should
3811 * react accordingly (e.g., change channel).
3812 */
3813 EVENT_DFS_RADAR_DETECTED,
3814
3815 /**
3816 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
3817 *
3818 * After a successful CAC, the channel can be marked clear and used.
3819 */
3820 EVENT_DFS_CAC_FINISHED,
3821
3822 /**
3823 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
3824 *
3825 * The CAC was not successful, and the channel remains in the previous
3826 * state. This may happen due to a radar beeing detected or other
3827 * external influences.
3828 */
3829 EVENT_DFS_CAC_ABORTED,
3830
3831 /**
3832 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
3833 *
3834 * The channel which was previously unavailable is now available again.
3835 */
3836 EVENT_DFS_NOP_FINISHED,
3837
3838 /**
3839 * EVENT_SURVEY - Received survey data
3840 *
3841 * This event gets triggered when a driver query is issued for survey
3842 * data and the requested data becomes available. The returned data is
3843 * stored in struct survey_results. The results provide at most one
3844 * survey entry for each frequency and at minimum will provide one
3845 * survey entry for one frequency. The survey data can be os_malloc()'d
3846 * and then os_free()'d, so the event callback must only copy data.
3847 */
3848 EVENT_SURVEY,
3849
3850 /**
3851 * EVENT_SCAN_STARTED - Scan started
3852 *
3853 * This indicates that driver has started a scan operation either based
3854 * on a request from wpa_supplicant/hostapd or from another application.
3855 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3856 * completed (either successfully or by getting cancelled).
3857 */
3858 EVENT_SCAN_STARTED,
3859
3860 /**
3861 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3862 *
3863 * This event indicates a set of frequency ranges that should be avoided
3864 * to reduce issues due to interference or internal co-existence
3865 * information in the driver.
3866 */
3867 EVENT_AVOID_FREQUENCIES,
3868
3869 /**
3870 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3871 */
3872 EVENT_NEW_PEER_CANDIDATE,
3873
3874 /**
3875 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
3876 *
3877 * Indicates a pair of primary and secondary channels chosen by ACS
3878 * in device.
3879 */
3880 EVENT_ACS_CHANNEL_SELECTED,
3881
3882 /**
3883 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
3884 * been started.
3885 *
3886 * This event indicates that channel availability check has been started
3887 * on a DFS frequency by a driver that supports DFS Offload.
3888 */
3889 EVENT_DFS_CAC_STARTED,
3890 };
3891
3892
3893 /**
3894 * struct freq_survey - Channel survey info
3895 *
3896 * @ifidx: Interface index in which this survey was observed
3897 * @freq: Center of frequency of the surveyed channel
3898 * @nf: Channel noise floor in dBm
3899 * @channel_time: Amount of time in ms the radio spent on the channel
3900 * @channel_time_busy: Amount of time in ms the radio detected some signal
3901 * that indicated to the radio the channel was not clear
3902 * @channel_time_rx: Amount of time the radio spent receiving data
3903 * @channel_time_tx: Amount of time the radio spent transmitting data
3904 * @filled: bitmask indicating which fields have been reported, see
3905 * SURVEY_HAS_* defines.
3906 * @list: Internal list pointers
3907 */
3908 struct freq_survey {
3909 u32 ifidx;
3910 unsigned int freq;
3911 s8 nf;
3912 u64 channel_time;
3913 u64 channel_time_busy;
3914 u64 channel_time_rx;
3915 u64 channel_time_tx;
3916 unsigned int filled;
3917 struct dl_list list;
3918 };
3919
3920 #define SURVEY_HAS_NF BIT(0)
3921 #define SURVEY_HAS_CHAN_TIME BIT(1)
3922 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3923 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3924 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3925
3926
3927 /**
3928 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3929 */
3930 union wpa_event_data {
3931 /**
3932 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3933 *
3934 * This structure is optional for EVENT_ASSOC calls and required for
3935 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3936 * driver interface does not need to generate separate EVENT_ASSOCINFO
3937 * calls.
3938 */
3939 struct assoc_info {
3940 /**
3941 * reassoc - Flag to indicate association or reassociation
3942 */
3943 int reassoc;
3944
3945 /**
3946 * req_ies - (Re)Association Request IEs
3947 *
3948 * If the driver generates WPA/RSN IE, this event data must be
3949 * returned for WPA handshake to have needed information. If
3950 * wpa_supplicant-generated WPA/RSN IE is used, this
3951 * information event is optional.
3952 *
3953 * This should start with the first IE (fixed fields before IEs
3954 * are not included).
3955 */
3956 const u8 *req_ies;
3957
3958 /**
3959 * req_ies_len - Length of req_ies in bytes
3960 */
3961 size_t req_ies_len;
3962
3963 /**
3964 * resp_ies - (Re)Association Response IEs
3965 *
3966 * Optional association data from the driver. This data is not
3967 * required WPA, but may be useful for some protocols and as
3968 * such, should be reported if this is available to the driver
3969 * interface.
3970 *
3971 * This should start with the first IE (fixed fields before IEs
3972 * are not included).
3973 */
3974 const u8 *resp_ies;
3975
3976 /**
3977 * resp_ies_len - Length of resp_ies in bytes
3978 */
3979 size_t resp_ies_len;
3980
3981 /**
3982 * beacon_ies - Beacon or Probe Response IEs
3983 *
3984 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3985 * Probe Response frames from the current AP (i.e., the one
3986 * that the client just associated with). This information is
3987 * used to update WPA/RSN IE for the AP. If this field is not
3988 * set, the results from previous scan will be used. If no
3989 * data for the new AP is found, scan results will be requested
3990 * again (without scan request). At this point, the driver is
3991 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3992 * used).
3993 *
3994 * This should start with the first IE (fixed fields before IEs
3995 * are not included).
3996 */
3997 const u8 *beacon_ies;
3998
3999 /**
4000 * beacon_ies_len - Length of beacon_ies */
4001 size_t beacon_ies_len;
4002
4003 /**
4004 * freq - Frequency of the operational channel in MHz
4005 */
4006 unsigned int freq;
4007
4008 /**
4009 * wmm_params - WMM parameters used in this association.
4010 */
4011 struct wmm_params wmm_params;
4012
4013 /**
4014 * addr - Station address (for AP mode)
4015 */
4016 const u8 *addr;
4017
4018 /**
4019 * The following is the key management offload information
4020 * @authorized
4021 * @key_replay_ctr
4022 * @key_replay_ctr_len
4023 * @ptk_kck
4024 * @ptk_kek_len
4025 * @ptk_kek
4026 * @ptk_kek_len
4027 */
4028
4029 /**
4030 * authorized - Status of key management offload,
4031 * 1 = successful
4032 */
4033 int authorized;
4034
4035 /**
4036 * key_replay_ctr - Key replay counter value last used
4037 * in a valid EAPOL-Key frame
4038 */
4039 const u8 *key_replay_ctr;
4040
4041 /**
4042 * key_replay_ctr_len - The length of key_replay_ctr
4043 */
4044 size_t key_replay_ctr_len;
4045
4046 /**
4047 * ptk_kck - The derived PTK KCK
4048 */
4049 const u8 *ptk_kck;
4050
4051 /**
4052 * ptk_kek_len - The length of ptk_kck
4053 */
4054 size_t ptk_kck_len;
4055
4056 /**
4057 * ptk_kek - The derived PTK KEK
4058 */
4059 const u8 *ptk_kek;
4060
4061 /**
4062 * ptk_kek_len - The length of ptk_kek
4063 */
4064 size_t ptk_kek_len;
4065 } assoc_info;
4066
4067 /**
4068 * struct disassoc_info - Data for EVENT_DISASSOC events
4069 */
4070 struct disassoc_info {
4071 /**
4072 * addr - Station address (for AP mode)
4073 */
4074 const u8 *addr;
4075
4076 /**
4077 * reason_code - Reason Code (host byte order) used in
4078 * Deauthentication frame
4079 */
4080 u16 reason_code;
4081
4082 /**
4083 * ie - Optional IE(s) in Disassociation frame
4084 */
4085 const u8 *ie;
4086
4087 /**
4088 * ie_len - Length of ie buffer in octets
4089 */
4090 size_t ie_len;
4091
4092 /**
4093 * locally_generated - Whether the frame was locally generated
4094 */
4095 int locally_generated;
4096 } disassoc_info;
4097
4098 /**
4099 * struct deauth_info - Data for EVENT_DEAUTH events
4100 */
4101 struct deauth_info {
4102 /**
4103 * addr - Station address (for AP mode)
4104 */
4105 const u8 *addr;
4106
4107 /**
4108 * reason_code - Reason Code (host byte order) used in
4109 * Deauthentication frame
4110 */
4111 u16 reason_code;
4112
4113 /**
4114 * ie - Optional IE(s) in Deauthentication frame
4115 */
4116 const u8 *ie;
4117
4118 /**
4119 * ie_len - Length of ie buffer in octets
4120 */
4121 size_t ie_len;
4122
4123 /**
4124 * locally_generated - Whether the frame was locally generated
4125 */
4126 int locally_generated;
4127 } deauth_info;
4128
4129 /**
4130 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4131 */
4132 struct michael_mic_failure {
4133 int unicast;
4134 const u8 *src;
4135 } michael_mic_failure;
4136
4137 /**
4138 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4139 */
4140 struct interface_status {
4141 char ifname[100];
4142 enum {
4143 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4144 } ievent;
4145 } interface_status;
4146
4147 /**
4148 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4149 */
4150 struct pmkid_candidate {
4151 /** BSSID of the PMKID candidate */
4152 u8 bssid[ETH_ALEN];
4153 /** Smaller the index, higher the priority */
4154 int index;
4155 /** Whether RSN IE includes pre-authenticate flag */
4156 int preauth;
4157 } pmkid_candidate;
4158
4159 /**
4160 * struct stkstart - Data for EVENT_STKSTART
4161 */
4162 struct stkstart {
4163 u8 peer[ETH_ALEN];
4164 } stkstart;
4165
4166 /**
4167 * struct tdls - Data for EVENT_TDLS
4168 */
4169 struct tdls {
4170 u8 peer[ETH_ALEN];
4171 enum {
4172 TDLS_REQUEST_SETUP,
4173 TDLS_REQUEST_TEARDOWN,
4174 TDLS_REQUEST_DISCOVER,
4175 } oper;
4176 u16 reason_code; /* for teardown */
4177 } tdls;
4178
4179 /**
4180 * struct wnm - Data for EVENT_WNM
4181 */
4182 struct wnm {
4183 u8 addr[ETH_ALEN];
4184 enum {
4185 WNM_OPER_SLEEP,
4186 } oper;
4187 enum {
4188 WNM_SLEEP_ENTER,
4189 WNM_SLEEP_EXIT
4190 } sleep_action;
4191 int sleep_intval;
4192 u16 reason_code;
4193 u8 *buf;
4194 u16 buf_len;
4195 } wnm;
4196
4197 /**
4198 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4199 *
4200 * During FT (IEEE 802.11r) authentication sequence, the driver is
4201 * expected to use this event to report received FT IEs (MDIE, FTIE,
4202 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4203 * IEs for the next message will be delivered through the
4204 * struct wpa_driver_ops::update_ft_ies() callback.
4205 */
4206 struct ft_ies {
4207 const u8 *ies;
4208 size_t ies_len;
4209 int ft_action;
4210 u8 target_ap[ETH_ALEN];
4211 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4212 const u8 *ric_ies;
4213 /** Length of ric_ies buffer in octets */
4214 size_t ric_ies_len;
4215 } ft_ies;
4216
4217 /**
4218 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4219 */
4220 struct ibss_rsn_start {
4221 u8 peer[ETH_ALEN];
4222 } ibss_rsn_start;
4223
4224 /**
4225 * struct auth_info - Data for EVENT_AUTH events
4226 */
4227 struct auth_info {
4228 u8 peer[ETH_ALEN];
4229 u8 bssid[ETH_ALEN];
4230 u16 auth_type;
4231 u16 auth_transaction;
4232 u16 status_code;
4233 const u8 *ies;
4234 size_t ies_len;
4235 } auth;
4236
4237 /**
4238 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4239 */
4240 struct assoc_reject {
4241 /**
4242 * bssid - BSSID of the AP that rejected association
4243 */
4244 const u8 *bssid;
4245
4246 /**
4247 * resp_ies - (Re)Association Response IEs
4248 *
4249 * Optional association data from the driver. This data is not
4250 * required WPA, but may be useful for some protocols and as
4251 * such, should be reported if this is available to the driver
4252 * interface.
4253 *
4254 * This should start with the first IE (fixed fields before IEs
4255 * are not included).
4256 */
4257 const u8 *resp_ies;
4258
4259 /**
4260 * resp_ies_len - Length of resp_ies in bytes
4261 */
4262 size_t resp_ies_len;
4263
4264 /**
4265 * status_code - Status Code from (Re)association Response
4266 */
4267 u16 status_code;
4268 } assoc_reject;
4269
4270 struct timeout_event {
4271 u8 addr[ETH_ALEN];
4272 } timeout_event;
4273
4274 /**
4275 * struct tx_status - Data for EVENT_TX_STATUS events
4276 */
4277 struct tx_status {
4278 u16 type;
4279 u16 stype;
4280 const u8 *dst;
4281 const u8 *data;
4282 size_t data_len;
4283 int ack;
4284 } tx_status;
4285
4286 /**
4287 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4288 */
4289 struct rx_from_unknown {
4290 const u8 *bssid;
4291 const u8 *addr;
4292 int wds;
4293 } rx_from_unknown;
4294
4295 /**
4296 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4297 */
4298 struct rx_mgmt {
4299 const u8 *frame;
4300 size_t frame_len;
4301 u32 datarate;
4302
4303 /**
4304 * drv_priv - Pointer to store driver private BSS information
4305 *
4306 * If not set to NULL, this is used for comparison with
4307 * hostapd_data->drv_priv to determine which BSS should process
4308 * the frame.
4309 */
4310 void *drv_priv;
4311
4312 /**
4313 * freq - Frequency (in MHz) on which the frame was received
4314 */
4315 int freq;
4316
4317 /**
4318 * ssi_signal - Signal strength in dBm (or 0 if not available)
4319 */
4320 int ssi_signal;
4321 } rx_mgmt;
4322
4323 /**
4324 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4325 *
4326 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4327 */
4328 struct remain_on_channel {
4329 /**
4330 * freq - Channel frequency in MHz
4331 */
4332 unsigned int freq;
4333
4334 /**
4335 * duration - Duration to remain on the channel in milliseconds
4336 */
4337 unsigned int duration;
4338 } remain_on_channel;
4339
4340 /**
4341 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4342 * @aborted: Whether the scan was aborted
4343 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4344 * @num_freqs: Number of entries in freqs array
4345 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4346 * SSID)
4347 * @num_ssids: Number of entries in ssids array
4348 */
4349 struct scan_info {
4350 int aborted;
4351 const int *freqs;
4352 size_t num_freqs;
4353 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4354 size_t num_ssids;
4355 } scan_info;
4356
4357 /**
4358 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4359 */
4360 struct rx_probe_req {
4361 /**
4362 * sa - Source address of the received Probe Request frame
4363 */
4364 const u8 *sa;
4365
4366 /**
4367 * da - Destination address of the received Probe Request frame
4368 * or %NULL if not available
4369 */
4370 const u8 *da;
4371
4372 /**
4373 * bssid - BSSID of the received Probe Request frame or %NULL
4374 * if not available
4375 */
4376 const u8 *bssid;
4377
4378 /**
4379 * ie - IEs from the Probe Request body
4380 */
4381 const u8 *ie;
4382
4383 /**
4384 * ie_len - Length of ie buffer in octets
4385 */
4386 size_t ie_len;
4387
4388 /**
4389 * signal - signal strength in dBm (or 0 if not available)
4390 */
4391 int ssi_signal;
4392 } rx_probe_req;
4393
4394 /**
4395 * struct new_sta - Data for EVENT_NEW_STA events
4396 */
4397 struct new_sta {
4398 const u8 *addr;
4399 } new_sta;
4400
4401 /**
4402 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4403 */
4404 struct eapol_rx {
4405 const u8 *src;
4406 const u8 *data;
4407 size_t data_len;
4408 } eapol_rx;
4409
4410 /**
4411 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4412 */
4413 struct wpa_signal_info signal_change;
4414
4415 /**
4416 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4417 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4418 * @freq_5: Best 5 GHz band channel frequency in MHz
4419 * @freq_overall: Best channel frequency in MHz
4420 *
4421 * 0 can be used to indicate no preference in either band.
4422 */
4423 struct best_channel {
4424 int freq_24;
4425 int freq_5;
4426 int freq_overall;
4427 } best_chan;
4428
4429 struct unprot_deauth {
4430 const u8 *sa;
4431 const u8 *da;
4432 u16 reason_code;
4433 } unprot_deauth;
4434
4435 struct unprot_disassoc {
4436 const u8 *sa;
4437 const u8 *da;
4438 u16 reason_code;
4439 } unprot_disassoc;
4440
4441 /**
4442 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4443 * @addr: station address
4444 */
4445 struct low_ack {
4446 u8 addr[ETH_ALEN];
4447 } low_ack;
4448
4449 /**
4450 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4451 */
4452 struct ibss_peer_lost {
4453 u8 peer[ETH_ALEN];
4454 } ibss_peer_lost;
4455
4456 /**
4457 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4458 */
4459 struct driver_gtk_rekey {
4460 const u8 *bssid;
4461 const u8 *replay_ctr;
4462 } driver_gtk_rekey;
4463
4464 /**
4465 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4466 * @addr: station address
4467 */
4468 struct client_poll {
4469 u8 addr[ETH_ALEN];
4470 } client_poll;
4471
4472 /**
4473 * struct eapol_tx_status
4474 * @dst: Original destination
4475 * @data: Data starting with IEEE 802.1X header (!)
4476 * @data_len: Length of data
4477 * @ack: Indicates ack or lost frame
4478 *
4479 * This corresponds to hapd_send_eapol if the frame sent
4480 * there isn't just reported as EVENT_TX_STATUS.
4481 */
4482 struct eapol_tx_status {
4483 const u8 *dst;
4484 const u8 *data;
4485 int data_len;
4486 int ack;
4487 } eapol_tx_status;
4488
4489 /**
4490 * struct ch_switch
4491 * @freq: Frequency of new channel in MHz
4492 * @ht_enabled: Whether this is an HT channel
4493 * @ch_offset: Secondary channel offset
4494 * @ch_width: Channel width
4495 * @cf1: Center frequency 1
4496 * @cf2: Center frequency 2
4497 */
4498 struct ch_switch {
4499 int freq;
4500 int ht_enabled;
4501 int ch_offset;
4502 enum chan_width ch_width;
4503 int cf1;
4504 int cf2;
4505 } ch_switch;
4506
4507 /**
4508 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4509 * @addr: Remote client address
4510 * @code: Reason code for connection failure
4511 */
4512 struct connect_failed_reason {
4513 u8 addr[ETH_ALEN];
4514 enum {
4515 MAX_CLIENT_REACHED,
4516 BLOCKED_CLIENT
4517 } code;
4518 } connect_failed_reason;
4519
4520 /**
4521 * struct dfs_event - Data for radar detected events
4522 * @freq: Frequency of the channel in MHz
4523 */
4524 struct dfs_event {
4525 int freq;
4526 int ht_enabled;
4527 int chan_offset;
4528 enum chan_width chan_width;
4529 int cf1;
4530 int cf2;
4531 } dfs_event;
4532
4533 /**
4534 * survey_results - Survey result data for EVENT_SURVEY
4535 * @freq_filter: Requested frequency survey filter, 0 if request
4536 * was for all survey data
4537 * @survey_list: Linked list of survey data (struct freq_survey)
4538 */
4539 struct survey_results {
4540 unsigned int freq_filter;
4541 struct dl_list survey_list; /* struct freq_survey */
4542 } survey_results;
4543
4544 /**
4545 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4546 * @initiator: Initiator of the regulatory change
4547 * @type: Regulatory change type
4548 * @alpha2: Country code (or "" if not available)
4549 */
4550 struct channel_list_changed {
4551 enum reg_change_initiator initiator;
4552 enum reg_type type;
4553 char alpha2[3];
4554 } channel_list_changed;
4555
4556 /**
4557 * freq_range - List of frequency ranges
4558 *
4559 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4560 */
4561 struct wpa_freq_range_list freq_range;
4562
4563 /**
4564 * struct mesh_peer
4565 *
4566 * @peer: Peer address
4567 * @ies: Beacon IEs
4568 * @ie_len: Length of @ies
4569 *
4570 * Notification of new candidate mesh peer.
4571 */
4572 struct mesh_peer {
4573 const u8 *peer;
4574 const u8 *ies;
4575 size_t ie_len;
4576 } mesh_peer;
4577
4578 /**
4579 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4580 * @pri_channel: Selected primary channel
4581 * @sec_channel: Selected secondary channel
4582 * @vht_seg0_center_ch: VHT mode Segment0 center channel
4583 * @vht_seg1_center_ch: VHT mode Segment1 center channel
4584 * @ch_width: Selected Channel width by driver. Driver may choose to
4585 * change hostapd configured ACS channel width due driver internal
4586 * channel restrictions.
4587 * hw_mode: Selected band (used with hw_mode=any)
4588 */
4589 struct acs_selected_channels {
4590 u8 pri_channel;
4591 u8 sec_channel;
4592 u8 vht_seg0_center_ch;
4593 u8 vht_seg1_center_ch;
4594 u16 ch_width;
4595 enum hostapd_hw_mode hw_mode;
4596 } acs_selected_channels;
4597 };
4598
4599 /**
4600 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4601 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4602 * with struct wpa_driver_ops::init()
4603 * @event: event type (defined above)
4604 * @data: possible extra data for the event
4605 *
4606 * Driver wrapper code should call this function whenever an event is received
4607 * from the driver.
4608 */
4609 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4610 union wpa_event_data *data);
4611
4612
4613 /*
4614 * The following inline functions are provided for convenience to simplify
4615 * event indication for some of the common events.
4616 */
4617
4618 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4619 size_t ielen, int reassoc)
4620 {
4621 union wpa_event_data event;
4622 os_memset(&event, 0, sizeof(event));
4623 event.assoc_info.reassoc = reassoc;
4624 event.assoc_info.req_ies = ie;
4625 event.assoc_info.req_ies_len = ielen;
4626 event.assoc_info.addr = addr;
4627 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4628 }
4629
4630 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4631 {
4632 union wpa_event_data event;
4633 os_memset(&event, 0, sizeof(event));
4634 event.disassoc_info.addr = addr;
4635 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4636 }
4637
4638 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4639 size_t data_len)
4640 {
4641 union wpa_event_data event;
4642 os_memset(&event, 0, sizeof(event));
4643 event.eapol_rx.src = src;
4644 event.eapol_rx.data = data;
4645 event.eapol_rx.data_len = data_len;
4646 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4647 }
4648
4649 /* driver_common.c */
4650 void wpa_scan_results_free(struct wpa_scan_results *res);
4651
4652 /* Convert wpa_event_type to a string for logging */
4653 const char * event_to_string(enum wpa_event_type event);
4654
4655 /* Convert chan_width to a string for logging and control interfaces */
4656 const char * channel_width_to_string(enum chan_width width);
4657
4658 int ht_supported(const struct hostapd_hw_modes *mode);
4659 int vht_supported(const struct hostapd_hw_modes *mode);
4660
4661 struct wowlan_triggers *
4662 wpa_get_wowlan_triggers(const char *wowlan_triggers,
4663 const struct wpa_driver_capa *capa);
4664
4665 /* NULL terminated array of linked in driver wrappers */
4666 extern const struct wpa_driver_ops *const wpa_drivers[];
4667
4668 #endif /* DRIVER_H */