Line data Source code
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 : * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1410 : */
1411 : WPA_IF_TDLS,
1412 :
1413 : /*
1414 : * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1415 : */
1416 : WPA_IF_IBSS,
1417 : };
1418 :
1419 : struct wpa_init_params {
1420 : void *global_priv;
1421 : const u8 *bssid;
1422 : const char *ifname;
1423 : const char *driver_params;
1424 : int use_pae_group_addr;
1425 : char **bridge;
1426 : size_t num_bridge;
1427 :
1428 : u8 *own_addr; /* buffer for writing own MAC address */
1429 : };
1430 :
1431 :
1432 : struct wpa_bss_params {
1433 : /** Interface name (for multi-SSID/VLAN support) */
1434 : const char *ifname;
1435 : /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1436 : int enabled;
1437 :
1438 : int wpa;
1439 : int ieee802_1x;
1440 : int wpa_group;
1441 : int wpa_pairwise;
1442 : int wpa_key_mgmt;
1443 : int rsn_preauth;
1444 : enum mfp_options ieee80211w;
1445 : };
1446 :
1447 : #define WPA_STA_AUTHORIZED BIT(0)
1448 : #define WPA_STA_WMM BIT(1)
1449 : #define WPA_STA_SHORT_PREAMBLE BIT(2)
1450 : #define WPA_STA_MFP BIT(3)
1451 : #define WPA_STA_TDLS_PEER BIT(4)
1452 : #define WPA_STA_AUTHENTICATED BIT(5)
1453 :
1454 : enum tdls_oper {
1455 : TDLS_DISCOVERY_REQ,
1456 : TDLS_SETUP,
1457 : TDLS_TEARDOWN,
1458 : TDLS_ENABLE_LINK,
1459 : TDLS_DISABLE_LINK,
1460 : TDLS_ENABLE,
1461 : TDLS_DISABLE
1462 : };
1463 :
1464 : enum wnm_oper {
1465 : WNM_SLEEP_ENTER_CONFIRM,
1466 : WNM_SLEEP_ENTER_FAIL,
1467 : WNM_SLEEP_EXIT_CONFIRM,
1468 : WNM_SLEEP_EXIT_FAIL,
1469 : WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1470 : WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1471 : WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1472 : * a STA */
1473 : WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1474 : * for a STA */
1475 : WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1476 : WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1477 : * for a STA */
1478 : WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1479 : };
1480 :
1481 : /* enum chan_width - Channel width definitions */
1482 : enum chan_width {
1483 : CHAN_WIDTH_20_NOHT,
1484 : CHAN_WIDTH_20,
1485 : CHAN_WIDTH_40,
1486 : CHAN_WIDTH_80,
1487 : CHAN_WIDTH_80P80,
1488 : CHAN_WIDTH_160,
1489 : CHAN_WIDTH_UNKNOWN
1490 : };
1491 :
1492 : /**
1493 : * struct wpa_signal_info - Information about channel signal quality
1494 : */
1495 : struct wpa_signal_info {
1496 : u32 frequency;
1497 : int above_threshold;
1498 : int current_signal;
1499 : int avg_signal;
1500 : int avg_beacon_signal;
1501 : int current_noise;
1502 : int current_txrate;
1503 : enum chan_width chanwidth;
1504 : int center_frq1;
1505 : int center_frq2;
1506 : };
1507 :
1508 : /**
1509 : * struct beacon_data - Beacon data
1510 : * @head: Head portion of Beacon frame (before TIM IE)
1511 : * @tail: Tail portion of Beacon frame (after TIM IE)
1512 : * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1513 : * @proberesp_ies: Extra information element(s) to add into Probe Response
1514 : * frames or %NULL
1515 : * @assocresp_ies: Extra information element(s) to add into (Re)Association
1516 : * Response frames or %NULL
1517 : * @probe_resp: Probe Response frame template
1518 : * @head_len: Length of @head
1519 : * @tail_len: Length of @tail
1520 : * @beacon_ies_len: Length of beacon_ies in octets
1521 : * @proberesp_ies_len: Length of proberesp_ies in octets
1522 : * @proberesp_ies_len: Length of proberesp_ies in octets
1523 : * @probe_resp_len: Length of probe response template (@probe_resp)
1524 : */
1525 : struct beacon_data {
1526 : u8 *head, *tail;
1527 : u8 *beacon_ies;
1528 : u8 *proberesp_ies;
1529 : u8 *assocresp_ies;
1530 : u8 *probe_resp;
1531 :
1532 : size_t head_len, tail_len;
1533 : size_t beacon_ies_len;
1534 : size_t proberesp_ies_len;
1535 : size_t assocresp_ies_len;
1536 : size_t probe_resp_len;
1537 : };
1538 :
1539 : /**
1540 : * struct csa_settings - Settings for channel switch command
1541 : * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1542 : * @block_tx: 1 - block transmission for CSA period
1543 : * @freq_params: Next channel frequency parameter
1544 : * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1545 : * @beacon_after: Next beacon/probe resp/asooc resp info
1546 : * @counter_offset_beacon: Offset to the count field in beacon's tail
1547 : * @counter_offset_presp: Offset to the count field in probe resp.
1548 : */
1549 : struct csa_settings {
1550 : u8 cs_count;
1551 : u8 block_tx;
1552 :
1553 : struct hostapd_freq_params freq_params;
1554 : struct beacon_data beacon_csa;
1555 : struct beacon_data beacon_after;
1556 :
1557 : u16 counter_offset_beacon;
1558 : u16 counter_offset_presp;
1559 : };
1560 :
1561 : /* TDLS peer capabilities for send_tdls_mgmt() */
1562 : enum tdls_peer_capability {
1563 : TDLS_PEER_HT = BIT(0),
1564 : TDLS_PEER_VHT = BIT(1),
1565 : TDLS_PEER_WMM = BIT(2),
1566 : };
1567 :
1568 : /* valid info in the wmm_params struct */
1569 : enum wmm_params_valid_info {
1570 : WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1571 : };
1572 :
1573 : /**
1574 : * struct wmm_params - WMM parameterss configured for this association
1575 : * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1576 : * of the struct contain valid information.
1577 : * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1578 : * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1579 : */
1580 : struct wmm_params {
1581 : u8 info_bitmap;
1582 : u8 uapsd_queues;
1583 : };
1584 :
1585 : #ifdef CONFIG_MACSEC
1586 : struct macsec_init_params {
1587 : Boolean always_include_sci;
1588 : Boolean use_es;
1589 : Boolean use_scb;
1590 : };
1591 : #endif /* CONFIG_MACSEC */
1592 :
1593 : enum drv_br_port_attr {
1594 : DRV_BR_PORT_ATTR_PROXYARP,
1595 : DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1596 : };
1597 :
1598 : enum drv_br_net_param {
1599 : DRV_BR_NET_PARAM_GARP_ACCEPT,
1600 : DRV_BR_MULTICAST_SNOOPING,
1601 : };
1602 :
1603 : struct drv_acs_params {
1604 : /* Selected mode (HOSTAPD_MODE_*) */
1605 : enum hostapd_hw_mode hw_mode;
1606 :
1607 : /* Indicates whether HT is enabled */
1608 : int ht_enabled;
1609 :
1610 : /* Indicates whether HT40 is enabled */
1611 : int ht40_enabled;
1612 :
1613 : /* Indicates whether VHT is enabled */
1614 : int vht_enabled;
1615 :
1616 : /* Configured ACS channel width */
1617 : u16 ch_width;
1618 :
1619 : /* ACS channel list info */
1620 : unsigned int ch_list_len;
1621 : const u8 *ch_list;
1622 : const int *freq_list;
1623 : };
1624 :
1625 :
1626 : /**
1627 : * struct wpa_driver_ops - Driver interface API definition
1628 : *
1629 : * This structure defines the API that each driver interface needs to implement
1630 : * for core wpa_supplicant code. All driver specific functionality is captured
1631 : * in this wrapper.
1632 : */
1633 : struct wpa_driver_ops {
1634 : /** Name of the driver interface */
1635 : const char *name;
1636 : /** One line description of the driver interface */
1637 : const char *desc;
1638 :
1639 : /**
1640 : * get_bssid - Get the current BSSID
1641 : * @priv: private driver interface data
1642 : * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1643 : *
1644 : * Returns: 0 on success, -1 on failure
1645 : *
1646 : * Query kernel driver for the current BSSID and copy it to bssid.
1647 : * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1648 : * associated.
1649 : */
1650 : int (*get_bssid)(void *priv, u8 *bssid);
1651 :
1652 : /**
1653 : * get_ssid - Get the current SSID
1654 : * @priv: private driver interface data
1655 : * @ssid: buffer for SSID (at least 32 bytes)
1656 : *
1657 : * Returns: Length of the SSID on success, -1 on failure
1658 : *
1659 : * Query kernel driver for the current SSID and copy it to ssid.
1660 : * Returning zero is recommended if the STA is not associated.
1661 : *
1662 : * Note: SSID is an array of octets, i.e., it is not nul terminated and
1663 : * can, at least in theory, contain control characters (including nul)
1664 : * and as such, should be processed as binary data, not a printable
1665 : * string.
1666 : */
1667 : int (*get_ssid)(void *priv, u8 *ssid);
1668 :
1669 : /**
1670 : * set_key - Configure encryption key
1671 : * @ifname: Interface name (for multi-SSID/VLAN support)
1672 : * @priv: private driver interface data
1673 : * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1674 : * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1675 : * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1676 : * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1677 : * %WPA_ALG_BIP_CMAC_256);
1678 : * %WPA_ALG_NONE clears the key.
1679 : * @addr: Address of the peer STA (BSSID of the current AP when setting
1680 : * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1681 : * broadcast keys, %NULL for default keys that are used both for
1682 : * broadcast and unicast; when clearing keys, %NULL is used to
1683 : * indicate that both the broadcast-only and default key of the
1684 : * specified key index is to be cleared
1685 : * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1686 : * IGTK
1687 : * @set_tx: configure this key as the default Tx key (only used when
1688 : * driver does not support separate unicast/individual key
1689 : * @seq: sequence number/packet number, seq_len octets, the next
1690 : * packet number to be used for in replay protection; configured
1691 : * for Rx keys (in most cases, this is only used with broadcast
1692 : * keys and set to zero for unicast keys); %NULL if not set
1693 : * @seq_len: length of the seq, depends on the algorithm:
1694 : * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1695 : * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1696 : * 8-byte Rx Mic Key
1697 : * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1698 : * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1699 : *
1700 : * Returns: 0 on success, -1 on failure
1701 : *
1702 : * Configure the given key for the kernel driver. If the driver
1703 : * supports separate individual keys (4 default keys + 1 individual),
1704 : * addr can be used to determine whether the key is default or
1705 : * individual. If only 4 keys are supported, the default key with key
1706 : * index 0 is used as the individual key. STA must be configured to use
1707 : * it as the default Tx key (set_tx is set) and accept Rx for all the
1708 : * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1709 : * broadcast keys, so key index 0 is available for this kind of
1710 : * configuration.
1711 : *
1712 : * Please note that TKIP keys include separate TX and RX MIC keys and
1713 : * some drivers may expect them in different order than wpa_supplicant
1714 : * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1715 : * will trigger Michael MIC errors. This can be fixed by changing the
1716 : * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1717 : * in driver_*.c set_key() implementation, see driver_ndis.c for an
1718 : * example on how this can be done.
1719 : */
1720 : int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1721 : const u8 *addr, int key_idx, int set_tx,
1722 : const u8 *seq, size_t seq_len,
1723 : const u8 *key, size_t key_len);
1724 :
1725 : /**
1726 : * init - Initialize driver interface
1727 : * @ctx: context to be used when calling wpa_supplicant functions,
1728 : * e.g., wpa_supplicant_event()
1729 : * @ifname: interface name, e.g., wlan0
1730 : *
1731 : * Returns: Pointer to private data, %NULL on failure
1732 : *
1733 : * Initialize driver interface, including event processing for kernel
1734 : * driver events (e.g., associated, scan results, Michael MIC failure).
1735 : * This function can allocate a private configuration data area for
1736 : * @ctx, file descriptor, interface name, etc. information that may be
1737 : * needed in future driver operations. If this is not used, non-NULL
1738 : * value will need to be returned because %NULL is used to indicate
1739 : * failure. The returned value will be used as 'void *priv' data for
1740 : * all other driver_ops functions.
1741 : *
1742 : * The main event loop (eloop.c) of wpa_supplicant can be used to
1743 : * register callback for read sockets (eloop_register_read_sock()).
1744 : *
1745 : * See below for more information about events and
1746 : * wpa_supplicant_event() function.
1747 : */
1748 : void * (*init)(void *ctx, const char *ifname);
1749 :
1750 : /**
1751 : * deinit - Deinitialize driver interface
1752 : * @priv: private driver interface data from init()
1753 : *
1754 : * Shut down driver interface and processing of driver events. Free
1755 : * private data buffer if one was allocated in init() handler.
1756 : */
1757 : void (*deinit)(void *priv);
1758 :
1759 : /**
1760 : * set_param - Set driver configuration parameters
1761 : * @priv: private driver interface data from init()
1762 : * @param: driver specific configuration parameters
1763 : *
1764 : * Returns: 0 on success, -1 on failure
1765 : *
1766 : * Optional handler for notifying driver interface about configuration
1767 : * parameters (driver_param).
1768 : */
1769 : int (*set_param)(void *priv, const char *param);
1770 :
1771 : /**
1772 : * set_countermeasures - Enable/disable TKIP countermeasures
1773 : * @priv: private driver interface data
1774 : * @enabled: 1 = countermeasures enabled, 0 = disabled
1775 : *
1776 : * Returns: 0 on success, -1 on failure
1777 : *
1778 : * Configure TKIP countermeasures. When these are enabled, the driver
1779 : * should drop all received and queued frames that are using TKIP.
1780 : */
1781 : int (*set_countermeasures)(void *priv, int enabled);
1782 :
1783 : /**
1784 : * deauthenticate - Request driver to deauthenticate
1785 : * @priv: private driver interface data
1786 : * @addr: peer address (BSSID of the AP)
1787 : * @reason_code: 16-bit reason code to be sent in the deauthentication
1788 : * frame
1789 : *
1790 : * Returns: 0 on success, -1 on failure
1791 : */
1792 : int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1793 :
1794 : /**
1795 : * associate - Request driver to associate
1796 : * @priv: private driver interface data
1797 : * @params: association parameters
1798 : *
1799 : * Returns: 0 on success, -1 on failure
1800 : */
1801 : int (*associate)(void *priv,
1802 : struct wpa_driver_associate_params *params);
1803 :
1804 : /**
1805 : * add_pmkid - Add PMKSA cache entry to the driver
1806 : * @priv: private driver interface data
1807 : * @bssid: BSSID for the PMKSA cache entry
1808 : * @pmkid: PMKID for the PMKSA cache entry
1809 : *
1810 : * Returns: 0 on success, -1 on failure
1811 : *
1812 : * This function is called when a new PMK is received, as a result of
1813 : * either normal authentication or RSN pre-authentication.
1814 : *
1815 : * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1816 : * associate(), add_pmkid() can be used to add new PMKSA cache entries
1817 : * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1818 : * driver_ops function does not need to be implemented. Likewise, if
1819 : * the driver does not support WPA, this function is not needed.
1820 : */
1821 : int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1822 :
1823 : /**
1824 : * remove_pmkid - Remove PMKSA cache entry to the driver
1825 : * @priv: private driver interface data
1826 : * @bssid: BSSID for the PMKSA cache entry
1827 : * @pmkid: PMKID for the PMKSA cache entry
1828 : *
1829 : * Returns: 0 on success, -1 on failure
1830 : *
1831 : * This function is called when the supplicant drops a PMKSA cache
1832 : * entry for any reason.
1833 : *
1834 : * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1835 : * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1836 : * between the driver and wpa_supplicant. If the driver uses wpa_ie
1837 : * from wpa_supplicant, this driver_ops function does not need to be
1838 : * implemented. Likewise, if the driver does not support WPA, this
1839 : * function is not needed.
1840 : */
1841 : int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1842 :
1843 : /**
1844 : * flush_pmkid - Flush PMKSA cache
1845 : * @priv: private driver interface data
1846 : *
1847 : * Returns: 0 on success, -1 on failure
1848 : *
1849 : * This function is called when the supplicant drops all PMKSA cache
1850 : * entries for any reason.
1851 : *
1852 : * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1853 : * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1854 : * between the driver and wpa_supplicant. If the driver uses wpa_ie
1855 : * from wpa_supplicant, this driver_ops function does not need to be
1856 : * implemented. Likewise, if the driver does not support WPA, this
1857 : * function is not needed.
1858 : */
1859 : int (*flush_pmkid)(void *priv);
1860 :
1861 : /**
1862 : * get_capa - Get driver capabilities
1863 : * @priv: private driver interface data
1864 : *
1865 : * Returns: 0 on success, -1 on failure
1866 : *
1867 : * Get driver/firmware/hardware capabilities.
1868 : */
1869 : int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1870 :
1871 : /**
1872 : * poll - Poll driver for association information
1873 : * @priv: private driver interface data
1874 : *
1875 : * This is an option callback that can be used when the driver does not
1876 : * provide event mechanism for association events. This is called when
1877 : * receiving WPA EAPOL-Key messages that require association
1878 : * information. The driver interface is supposed to generate associnfo
1879 : * event before returning from this callback function. In addition, the
1880 : * driver interface should generate an association event after having
1881 : * sent out associnfo.
1882 : */
1883 : void (*poll)(void *priv);
1884 :
1885 : /**
1886 : * get_ifname - Get interface name
1887 : * @priv: private driver interface data
1888 : *
1889 : * Returns: Pointer to the interface name. This can differ from the
1890 : * interface name used in init() call. Init() is called first.
1891 : *
1892 : * This optional function can be used to allow the driver interface to
1893 : * replace the interface name with something else, e.g., based on an
1894 : * interface mapping from a more descriptive name.
1895 : */
1896 : const char * (*get_ifname)(void *priv);
1897 :
1898 : /**
1899 : * get_mac_addr - Get own MAC address
1900 : * @priv: private driver interface data
1901 : *
1902 : * Returns: Pointer to own MAC address or %NULL on failure
1903 : *
1904 : * This optional function can be used to get the own MAC address of the
1905 : * device from the driver interface code. This is only needed if the
1906 : * l2_packet implementation for the OS does not provide easy access to
1907 : * a MAC address. */
1908 : const u8 * (*get_mac_addr)(void *priv);
1909 :
1910 : /**
1911 : * set_operstate - Sets device operating state to DORMANT or UP
1912 : * @priv: private driver interface data
1913 : * @state: 0 = dormant, 1 = up
1914 : * Returns: 0 on success, -1 on failure
1915 : *
1916 : * This is an optional function that can be used on operating systems
1917 : * that support a concept of controlling network device state from user
1918 : * space applications. This function, if set, gets called with
1919 : * state = 1 when authentication has been completed and with state = 0
1920 : * when connection is lost.
1921 : */
1922 : int (*set_operstate)(void *priv, int state);
1923 :
1924 : /**
1925 : * mlme_setprotection - MLME-SETPROTECTION.request primitive
1926 : * @priv: Private driver interface data
1927 : * @addr: Address of the station for which to set protection (may be
1928 : * %NULL for group keys)
1929 : * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1930 : * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1931 : * Returns: 0 on success, -1 on failure
1932 : *
1933 : * This is an optional function that can be used to set the driver to
1934 : * require protection for Tx and/or Rx frames. This uses the layer
1935 : * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1936 : * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1937 : * set protection operation; instead, they set protection implicitly
1938 : * based on configured keys.
1939 : */
1940 : int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1941 : int key_type);
1942 :
1943 : /**
1944 : * get_hw_feature_data - Get hardware support data (channels and rates)
1945 : * @priv: Private driver interface data
1946 : * @num_modes: Variable for returning the number of returned modes
1947 : * flags: Variable for returning hardware feature flags
1948 : * Returns: Pointer to allocated hardware data on success or %NULL on
1949 : * failure. Caller is responsible for freeing this.
1950 : */
1951 : struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1952 : u16 *num_modes,
1953 : u16 *flags);
1954 :
1955 : /**
1956 : * send_mlme - Send management frame from MLME
1957 : * @priv: Private driver interface data
1958 : * @data: IEEE 802.11 management frame with IEEE 802.11 header
1959 : * @data_len: Size of the management frame
1960 : * @noack: Do not wait for this frame to be acked (disable retries)
1961 : * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
1962 : * driver decide
1963 : * Returns: 0 on success, -1 on failure
1964 : */
1965 : int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1966 : int noack, unsigned int freq);
1967 :
1968 : /**
1969 : * update_ft_ies - Update FT (IEEE 802.11r) IEs
1970 : * @priv: Private driver interface data
1971 : * @md: Mobility domain (2 octets) (also included inside ies)
1972 : * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1973 : * @ies_len: Length of FT IEs in bytes
1974 : * Returns: 0 on success, -1 on failure
1975 : *
1976 : * The supplicant uses this callback to let the driver know that keying
1977 : * material for FT is available and that the driver can use the
1978 : * provided IEs in the next message in FT authentication sequence.
1979 : *
1980 : * This function is only needed for driver that support IEEE 802.11r
1981 : * (Fast BSS Transition).
1982 : */
1983 : int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1984 : size_t ies_len);
1985 :
1986 : /**
1987 : * get_scan_results2 - Fetch the latest scan results
1988 : * @priv: private driver interface data
1989 : *
1990 : * Returns: Allocated buffer of scan results (caller is responsible for
1991 : * freeing the data structure) on success, NULL on failure
1992 : */
1993 : struct wpa_scan_results * (*get_scan_results2)(void *priv);
1994 :
1995 : /**
1996 : * set_country - Set country
1997 : * @priv: Private driver interface data
1998 : * @alpha2: country to which to switch to
1999 : * Returns: 0 on success, -1 on failure
2000 : *
2001 : * This function is for drivers which support some form
2002 : * of setting a regulatory domain.
2003 : */
2004 : int (*set_country)(void *priv, const char *alpha2);
2005 :
2006 : /**
2007 : * get_country - Get country
2008 : * @priv: Private driver interface data
2009 : * @alpha2: Buffer for returning country code (at least 3 octets)
2010 : * Returns: 0 on success, -1 on failure
2011 : */
2012 : int (*get_country)(void *priv, char *alpha2);
2013 :
2014 : /**
2015 : * global_init - Global driver initialization
2016 : * Returns: Pointer to private data (global), %NULL on failure
2017 : *
2018 : * This optional function is called to initialize the driver wrapper
2019 : * for global data, i.e., data that applies to all interfaces. If this
2020 : * function is implemented, global_deinit() will also need to be
2021 : * implemented to free the private data. The driver will also likely
2022 : * use init2() function instead of init() to get the pointer to global
2023 : * data available to per-interface initializer.
2024 : */
2025 : void * (*global_init)(void);
2026 :
2027 : /**
2028 : * global_deinit - Global driver deinitialization
2029 : * @priv: private driver global data from global_init()
2030 : *
2031 : * Terminate any global driver related functionality and free the
2032 : * global data structure.
2033 : */
2034 : void (*global_deinit)(void *priv);
2035 :
2036 : /**
2037 : * init2 - Initialize driver interface (with global data)
2038 : * @ctx: context to be used when calling wpa_supplicant functions,
2039 : * e.g., wpa_supplicant_event()
2040 : * @ifname: interface name, e.g., wlan0
2041 : * @global_priv: private driver global data from global_init()
2042 : * Returns: Pointer to private data, %NULL on failure
2043 : *
2044 : * This function can be used instead of init() if the driver wrapper
2045 : * uses global data.
2046 : */
2047 : void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2048 :
2049 : /**
2050 : * get_interfaces - Get information about available interfaces
2051 : * @global_priv: private driver global data from global_init()
2052 : * Returns: Allocated buffer of interface information (caller is
2053 : * responsible for freeing the data structure) on success, NULL on
2054 : * failure
2055 : */
2056 : struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2057 :
2058 : /**
2059 : * scan2 - Request the driver to initiate scan
2060 : * @priv: private driver interface data
2061 : * @params: Scan parameters
2062 : *
2063 : * Returns: 0 on success, -1 on failure
2064 : *
2065 : * Once the scan results are ready, the driver should report scan
2066 : * results event for wpa_supplicant which will eventually request the
2067 : * results with wpa_driver_get_scan_results2().
2068 : */
2069 : int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2070 :
2071 : /**
2072 : * authenticate - Request driver to authenticate
2073 : * @priv: private driver interface data
2074 : * @params: authentication parameters
2075 : * Returns: 0 on success, -1 on failure
2076 : *
2077 : * This is an optional function that can be used with drivers that
2078 : * support separate authentication and association steps, i.e., when
2079 : * wpa_supplicant can act as the SME. If not implemented, associate()
2080 : * function is expected to take care of IEEE 802.11 authentication,
2081 : * too.
2082 : */
2083 : int (*authenticate)(void *priv,
2084 : struct wpa_driver_auth_params *params);
2085 :
2086 : /**
2087 : * set_ap - Set Beacon and Probe Response information for AP mode
2088 : * @priv: Private driver interface data
2089 : * @params: Parameters to use in AP mode
2090 : *
2091 : * This function is used to configure Beacon template and/or extra IEs
2092 : * to add for Beacon and Probe Response frames for the driver in
2093 : * AP mode. The driver is responsible for building the full Beacon
2094 : * frame by concatenating the head part with TIM IE generated by the
2095 : * driver/firmware and finishing with the tail part. Depending on the
2096 : * driver architectue, this can be done either by using the full
2097 : * template or the set of additional IEs (e.g., WPS and P2P IE).
2098 : * Similarly, Probe Response processing depends on the driver design.
2099 : * If the driver (or firmware) takes care of replying to Probe Request
2100 : * frames, the extra IEs provided here needs to be added to the Probe
2101 : * Response frames.
2102 : *
2103 : * Returns: 0 on success, -1 on failure
2104 : */
2105 : int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
2106 :
2107 : /**
2108 : * set_acl - Set ACL in AP mode
2109 : * @priv: Private driver interface data
2110 : * @params: Parameters to configure ACL
2111 : * Returns: 0 on success, -1 on failure
2112 : *
2113 : * This is used only for the drivers which support MAC address ACL.
2114 : */
2115 : int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2116 :
2117 : /**
2118 : * hapd_init - Initialize driver interface (hostapd only)
2119 : * @hapd: Pointer to hostapd context
2120 : * @params: Configuration for the driver wrapper
2121 : * Returns: Pointer to private data, %NULL on failure
2122 : *
2123 : * This function is used instead of init() or init2() when the driver
2124 : * wrapper is used with hostapd.
2125 : */
2126 : void * (*hapd_init)(struct hostapd_data *hapd,
2127 : struct wpa_init_params *params);
2128 :
2129 : /**
2130 : * hapd_deinit - Deinitialize driver interface (hostapd only)
2131 : * @priv: Private driver interface data from hapd_init()
2132 : */
2133 : void (*hapd_deinit)(void *priv);
2134 :
2135 : /**
2136 : * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2137 : * @priv: Private driver interface data
2138 : * @params: BSS parameters
2139 : * Returns: 0 on success, -1 on failure
2140 : *
2141 : * This is an optional function to configure the kernel driver to
2142 : * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2143 : * can be left undefined (set to %NULL) if IEEE 802.1X support is
2144 : * always enabled and the driver uses set_ap() to set WPA/RSN IE
2145 : * for Beacon frames.
2146 : *
2147 : * DEPRECATED - use set_ap() instead
2148 : */
2149 : int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2150 :
2151 : /**
2152 : * set_privacy - Enable/disable privacy (AP only)
2153 : * @priv: Private driver interface data
2154 : * @enabled: 1 = privacy enabled, 0 = disabled
2155 : * Returns: 0 on success, -1 on failure
2156 : *
2157 : * This is an optional function to configure privacy field in the
2158 : * kernel driver for Beacon frames. This can be left undefined (set to
2159 : * %NULL) if the driver uses the Beacon template from set_ap().
2160 : *
2161 : * DEPRECATED - use set_ap() instead
2162 : */
2163 : int (*set_privacy)(void *priv, int enabled);
2164 :
2165 : /**
2166 : * get_seqnum - Fetch the current TSC/packet number (AP only)
2167 : * @ifname: The interface name (main or virtual)
2168 : * @priv: Private driver interface data
2169 : * @addr: MAC address of the station or %NULL for group keys
2170 : * @idx: Key index
2171 : * @seq: Buffer for returning the latest used TSC/packet number
2172 : * Returns: 0 on success, -1 on failure
2173 : *
2174 : * This function is used to fetch the last used TSC/packet number for
2175 : * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2176 : * keys, so there is no strict requirement on implementing support for
2177 : * unicast keys (i.e., addr != %NULL).
2178 : */
2179 : int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2180 : int idx, u8 *seq);
2181 :
2182 : /**
2183 : * flush - Flush all association stations (AP only)
2184 : * @priv: Private driver interface data
2185 : * Returns: 0 on success, -1 on failure
2186 : *
2187 : * This function requests the driver to disassociate all associated
2188 : * stations. This function does not need to be implemented if the
2189 : * driver does not process association frames internally.
2190 : */
2191 : int (*flush)(void *priv);
2192 :
2193 : /**
2194 : * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2195 : * @priv: Private driver interface data
2196 : * @elem: Information elements
2197 : * @elem_len: Length of the elem buffer in octets
2198 : * Returns: 0 on success, -1 on failure
2199 : *
2200 : * This is an optional function to add information elements in the
2201 : * kernel driver for Beacon and Probe Response frames. This can be left
2202 : * undefined (set to %NULL) if the driver uses the Beacon template from
2203 : * set_ap().
2204 : *
2205 : * DEPRECATED - use set_ap() instead
2206 : */
2207 : int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2208 :
2209 : /**
2210 : * read_sta_data - Fetch station data
2211 : * @priv: Private driver interface data
2212 : * @data: Buffer for returning station information
2213 : * @addr: MAC address of the station
2214 : * Returns: 0 on success, -1 on failure
2215 : */
2216 : int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2217 : const u8 *addr);
2218 :
2219 : /**
2220 : * hapd_send_eapol - Send an EAPOL packet (AP only)
2221 : * @priv: private driver interface data
2222 : * @addr: Destination MAC address
2223 : * @data: EAPOL packet starting with IEEE 802.1X header
2224 : * @data_len: Length of the EAPOL packet in octets
2225 : * @encrypt: Whether the frame should be encrypted
2226 : * @own_addr: Source MAC address
2227 : * @flags: WPA_STA_* flags for the destination station
2228 : *
2229 : * Returns: 0 on success, -1 on failure
2230 : */
2231 : int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2232 : size_t data_len, int encrypt,
2233 : const u8 *own_addr, u32 flags);
2234 :
2235 : /**
2236 : * sta_deauth - Deauthenticate a station (AP only)
2237 : * @priv: Private driver interface data
2238 : * @own_addr: Source address and BSSID for the Deauthentication frame
2239 : * @addr: MAC address of the station to deauthenticate
2240 : * @reason: Reason code for the Deauthentiation frame
2241 : * Returns: 0 on success, -1 on failure
2242 : *
2243 : * This function requests a specific station to be deauthenticated and
2244 : * a Deauthentication frame to be sent to it.
2245 : */
2246 : int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2247 : int reason);
2248 :
2249 : /**
2250 : * sta_disassoc - Disassociate a station (AP only)
2251 : * @priv: Private driver interface data
2252 : * @own_addr: Source address and BSSID for the Disassociation frame
2253 : * @addr: MAC address of the station to disassociate
2254 : * @reason: Reason code for the Disassociation frame
2255 : * Returns: 0 on success, -1 on failure
2256 : *
2257 : * This function requests a specific station to be disassociated and
2258 : * a Disassociation frame to be sent to it.
2259 : */
2260 : int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2261 : int reason);
2262 :
2263 : /**
2264 : * sta_remove - Remove a station entry (AP only)
2265 : * @priv: Private driver interface data
2266 : * @addr: MAC address of the station to be removed
2267 : * Returns: 0 on success, -1 on failure
2268 : */
2269 : int (*sta_remove)(void *priv, const u8 *addr);
2270 :
2271 : /**
2272 : * hapd_get_ssid - Get the current SSID (AP only)
2273 : * @priv: Private driver interface data
2274 : * @buf: Buffer for returning the SSID
2275 : * @len: Maximum length of the buffer
2276 : * Returns: Length of the SSID on success, -1 on failure
2277 : *
2278 : * This function need not be implemented if the driver uses Beacon
2279 : * template from set_ap() and does not reply to Probe Request frames.
2280 : */
2281 : int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2282 :
2283 : /**
2284 : * hapd_set_ssid - Set SSID (AP only)
2285 : * @priv: Private driver interface data
2286 : * @buf: SSID
2287 : * @len: Length of the SSID in octets
2288 : * Returns: 0 on success, -1 on failure
2289 : *
2290 : * DEPRECATED - use set_ap() instead
2291 : */
2292 : int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2293 :
2294 : /**
2295 : * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2296 : * @priv: Private driver interface data
2297 : * @enabled: 1 = countermeasures enabled, 0 = disabled
2298 : * Returns: 0 on success, -1 on failure
2299 : *
2300 : * This need not be implemented if the driver does not take care of
2301 : * association processing.
2302 : */
2303 : int (*hapd_set_countermeasures)(void *priv, int enabled);
2304 :
2305 : /**
2306 : * sta_add - Add a station entry
2307 : * @priv: Private driver interface data
2308 : * @params: Station parameters
2309 : * Returns: 0 on success, -1 on failure
2310 : *
2311 : * This function is used to add a station entry to the driver once the
2312 : * station has completed association. This is only used if the driver
2313 : * does not take care of association processing.
2314 : *
2315 : * With TDLS, this function is also used to add or set (params->set 1)
2316 : * TDLS peer entries.
2317 : */
2318 : int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2319 :
2320 : /**
2321 : * get_inact_sec - Get station inactivity duration (AP only)
2322 : * @priv: Private driver interface data
2323 : * @addr: Station address
2324 : * Returns: Number of seconds station has been inactive, -1 on failure
2325 : */
2326 : int (*get_inact_sec)(void *priv, const u8 *addr);
2327 :
2328 : /**
2329 : * sta_clear_stats - Clear station statistics (AP only)
2330 : * @priv: Private driver interface data
2331 : * @addr: Station address
2332 : * Returns: 0 on success, -1 on failure
2333 : */
2334 : int (*sta_clear_stats)(void *priv, const u8 *addr);
2335 :
2336 : /**
2337 : * set_freq - Set channel/frequency (AP only)
2338 : * @priv: Private driver interface data
2339 : * @freq: Channel parameters
2340 : * Returns: 0 on success, -1 on failure
2341 : */
2342 : int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2343 :
2344 : /**
2345 : * set_rts - Set RTS threshold
2346 : * @priv: Private driver interface data
2347 : * @rts: RTS threshold in octets
2348 : * Returns: 0 on success, -1 on failure
2349 : */
2350 : int (*set_rts)(void *priv, int rts);
2351 :
2352 : /**
2353 : * set_frag - Set fragmentation threshold
2354 : * @priv: Private driver interface data
2355 : * @frag: Fragmentation threshold in octets
2356 : * Returns: 0 on success, -1 on failure
2357 : */
2358 : int (*set_frag)(void *priv, int frag);
2359 :
2360 : /**
2361 : * sta_set_flags - Set station flags (AP only)
2362 : * @priv: Private driver interface data
2363 : * @addr: Station address
2364 : * @total_flags: Bitmap of all WPA_STA_* flags currently set
2365 : * @flags_or: Bitmap of WPA_STA_* flags to add
2366 : * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2367 : * Returns: 0 on success, -1 on failure
2368 : */
2369 : int (*sta_set_flags)(void *priv, const u8 *addr,
2370 : unsigned int total_flags, unsigned int flags_or,
2371 : unsigned int flags_and);
2372 :
2373 : /**
2374 : * set_tx_queue_params - Set TX queue parameters
2375 : * @priv: Private driver interface data
2376 : * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2377 : * @aifs: AIFS
2378 : * @cw_min: cwMin
2379 : * @cw_max: cwMax
2380 : * @burst_time: Maximum length for bursting in 0.1 msec units
2381 : */
2382 : int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2383 : int cw_max, int burst_time);
2384 :
2385 : /**
2386 : * if_add - Add a virtual interface
2387 : * @priv: Private driver interface data
2388 : * @type: Interface type
2389 : * @ifname: Interface name for the new virtual interface
2390 : * @addr: Local address to use for the interface or %NULL to use the
2391 : * parent interface address
2392 : * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2393 : * @drv_priv: Pointer for overwriting the driver context or %NULL if
2394 : * not allowed (applies only to %WPA_IF_AP_BSS type)
2395 : * @force_ifname: Buffer for returning an interface name that the
2396 : * driver ended up using if it differs from the requested ifname
2397 : * @if_addr: Buffer for returning the allocated interface address
2398 : * (this may differ from the requested addr if the driver cannot
2399 : * change interface address)
2400 : * @bridge: Bridge interface to use or %NULL if no bridge configured
2401 : * @use_existing: Whether to allow existing interface to be used
2402 : * Returns: 0 on success, -1 on failure
2403 : */
2404 : int (*if_add)(void *priv, enum wpa_driver_if_type type,
2405 : const char *ifname, const u8 *addr, void *bss_ctx,
2406 : void **drv_priv, char *force_ifname, u8 *if_addr,
2407 : const char *bridge, int use_existing);
2408 :
2409 : /**
2410 : * if_remove - Remove a virtual interface
2411 : * @priv: Private driver interface data
2412 : * @type: Interface type
2413 : * @ifname: Interface name of the virtual interface to be removed
2414 : * Returns: 0 on success, -1 on failure
2415 : */
2416 : int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2417 : const char *ifname);
2418 :
2419 : /**
2420 : * set_sta_vlan - Bind a station into a specific interface (AP only)
2421 : * @priv: Private driver interface data
2422 : * @ifname: Interface (main or virtual BSS or VLAN)
2423 : * @addr: MAC address of the associated station
2424 : * @vlan_id: VLAN ID
2425 : * Returns: 0 on success, -1 on failure
2426 : *
2427 : * This function is used to bind a station to a specific virtual
2428 : * interface. It is only used if when virtual interfaces are supported,
2429 : * e.g., to assign stations to different VLAN interfaces based on
2430 : * information from a RADIUS server. This allows separate broadcast
2431 : * domains to be used with a single BSS.
2432 : */
2433 : int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2434 : int vlan_id);
2435 :
2436 : /**
2437 : * commit - Optional commit changes handler (AP only)
2438 : * @priv: driver private data
2439 : * Returns: 0 on success, -1 on failure
2440 : *
2441 : * This optional handler function can be registered if the driver
2442 : * interface implementation needs to commit changes (e.g., by setting
2443 : * network interface up) at the end of initial configuration. If set,
2444 : * this handler will be called after initial setup has been completed.
2445 : */
2446 : int (*commit)(void *priv);
2447 :
2448 : /**
2449 : * send_ether - Send an ethernet packet (AP only)
2450 : * @priv: private driver interface data
2451 : * @dst: Destination MAC address
2452 : * @src: Source MAC address
2453 : * @proto: Ethertype
2454 : * @data: EAPOL packet starting with IEEE 802.1X header
2455 : * @data_len: Length of the EAPOL packet in octets
2456 : * Returns: 0 on success, -1 on failure
2457 : */
2458 : int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2459 : const u8 *data, size_t data_len);
2460 :
2461 : /**
2462 : * set_radius_acl_auth - Notification of RADIUS ACL change
2463 : * @priv: Private driver interface data
2464 : * @mac: MAC address of the station
2465 : * @accepted: Whether the station was accepted
2466 : * @session_timeout: Session timeout for the station
2467 : * Returns: 0 on success, -1 on failure
2468 : */
2469 : int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2470 : u32 session_timeout);
2471 :
2472 : /**
2473 : * set_radius_acl_expire - Notification of RADIUS ACL expiration
2474 : * @priv: Private driver interface data
2475 : * @mac: MAC address of the station
2476 : * Returns: 0 on success, -1 on failure
2477 : */
2478 : int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2479 :
2480 : /**
2481 : * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2482 : * @priv: Private driver interface data
2483 : * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2484 : * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2485 : * extra IE(s)
2486 : * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2487 : * to remove extra IE(s)
2488 : * Returns: 0 on success, -1 on failure
2489 : *
2490 : * This is an optional function to add WPS IE in the kernel driver for
2491 : * Beacon and Probe Response frames. This can be left undefined (set
2492 : * to %NULL) if the driver uses the Beacon template from set_ap()
2493 : * and does not process Probe Request frames. If the driver takes care
2494 : * of (Re)Association frame processing, the assocresp buffer includes
2495 : * WPS IE(s) that need to be added to (Re)Association Response frames
2496 : * whenever a (Re)Association Request frame indicated use of WPS.
2497 : *
2498 : * This will also be used to add P2P IE(s) into Beacon/Probe Response
2499 : * frames when operating as a GO. The driver is responsible for adding
2500 : * timing related attributes (e.g., NoA) in addition to the IEs
2501 : * included here by appending them after these buffers. This call is
2502 : * also used to provide Probe Response IEs for P2P Listen state
2503 : * operations for drivers that generate the Probe Response frames
2504 : * internally.
2505 : *
2506 : * DEPRECATED - use set_ap() instead
2507 : */
2508 : int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2509 : const struct wpabuf *proberesp,
2510 : const struct wpabuf *assocresp);
2511 :
2512 : /**
2513 : * set_supp_port - Set IEEE 802.1X Supplicant Port status
2514 : * @priv: Private driver interface data
2515 : * @authorized: Whether the port is authorized
2516 : * Returns: 0 on success, -1 on failure
2517 : */
2518 : int (*set_supp_port)(void *priv, int authorized);
2519 :
2520 : /**
2521 : * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2522 : * @priv: Private driver interface data
2523 : * @addr: MAC address of the associated station
2524 : * @aid: Association ID
2525 : * @val: 1 = bind to 4-address WDS; 0 = unbind
2526 : * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2527 : * to indicate that bridge is not to be used
2528 : * @ifname_wds: Buffer to return the interface name for the new WDS
2529 : * station or %NULL to indicate name is not returned.
2530 : * Returns: 0 on success, -1 on failure
2531 : */
2532 : int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2533 : const char *bridge_ifname, char *ifname_wds);
2534 :
2535 : /**
2536 : * send_action - Transmit an Action frame
2537 : * @priv: Private driver interface data
2538 : * @freq: Frequency (in MHz) of the channel
2539 : * @wait: Time to wait off-channel for a response (in ms), or zero
2540 : * @dst: Destination MAC address (Address 1)
2541 : * @src: Source MAC address (Address 2)
2542 : * @bssid: BSSID (Address 3)
2543 : * @data: Frame body
2544 : * @data_len: data length in octets
2545 : @ @no_cck: Whether CCK rates must not be used to transmit this frame
2546 : * Returns: 0 on success, -1 on failure
2547 : *
2548 : * This command can be used to request the driver to transmit an action
2549 : * frame to the specified destination.
2550 : *
2551 : * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2552 : * be transmitted on the given channel and the device will wait for a
2553 : * response on that channel for the given wait time.
2554 : *
2555 : * If the flag is not set, the wait time will be ignored. In this case,
2556 : * if a remain-on-channel duration is in progress, the frame must be
2557 : * transmitted on that channel; alternatively the frame may be sent on
2558 : * the current operational channel (if in associated state in station
2559 : * mode or while operating as an AP.)
2560 : */
2561 : int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2562 : const u8 *dst, const u8 *src, const u8 *bssid,
2563 : const u8 *data, size_t data_len, int no_cck);
2564 :
2565 : /**
2566 : * send_action_cancel_wait - Cancel action frame TX wait
2567 : * @priv: Private driver interface data
2568 : *
2569 : * This command cancels the wait time associated with sending an action
2570 : * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2571 : * set in the driver flags.
2572 : */
2573 : void (*send_action_cancel_wait)(void *priv);
2574 :
2575 : /**
2576 : * remain_on_channel - Remain awake on a channel
2577 : * @priv: Private driver interface data
2578 : * @freq: Frequency (in MHz) of the channel
2579 : * @duration: Duration in milliseconds
2580 : * Returns: 0 on success, -1 on failure
2581 : *
2582 : * This command is used to request the driver to remain awake on the
2583 : * specified channel for the specified duration and report received
2584 : * Action frames with EVENT_RX_MGMT events. Optionally, received
2585 : * Probe Request frames may also be requested to be reported by calling
2586 : * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2587 : *
2588 : * The driver may not be at the requested channel when this function
2589 : * returns, i.e., the return code is only indicating whether the
2590 : * request was accepted. The caller will need to wait until the
2591 : * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2592 : * completed the channel change. This may take some time due to other
2593 : * need for the radio and the caller should be prepared to timing out
2594 : * its wait since there are no guarantees on when this request can be
2595 : * executed.
2596 : */
2597 : int (*remain_on_channel)(void *priv, unsigned int freq,
2598 : unsigned int duration);
2599 :
2600 : /**
2601 : * cancel_remain_on_channel - Cancel remain-on-channel operation
2602 : * @priv: Private driver interface data
2603 : *
2604 : * This command can be used to cancel a remain-on-channel operation
2605 : * before its originally requested duration has passed. This could be
2606 : * used, e.g., when remain_on_channel() is used to request extra time
2607 : * to receive a response to an Action frame and the response is
2608 : * received when there is still unneeded time remaining on the
2609 : * remain-on-channel operation.
2610 : */
2611 : int (*cancel_remain_on_channel)(void *priv);
2612 :
2613 : /**
2614 : * probe_req_report - Request Probe Request frames to be indicated
2615 : * @priv: Private driver interface data
2616 : * @report: Whether to report received Probe Request frames
2617 : * Returns: 0 on success, -1 on failure (or if not supported)
2618 : *
2619 : * This command can be used to request the driver to indicate when
2620 : * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2621 : * Since this operation may require extra resources, e.g., due to less
2622 : * optimal hardware/firmware RX filtering, many drivers may disable
2623 : * Probe Request reporting at least in station mode. This command is
2624 : * used to notify the driver when the Probe Request frames need to be
2625 : * reported, e.g., during remain-on-channel operations.
2626 : */
2627 : int (*probe_req_report)(void *priv, int report);
2628 :
2629 : /**
2630 : * deinit_ap - Deinitialize AP mode
2631 : * @priv: Private driver interface data
2632 : * Returns: 0 on success, -1 on failure (or if not supported)
2633 : *
2634 : * This optional function can be used to disable AP mode related
2635 : * configuration. If the interface was not dynamically added,
2636 : * change the driver mode to station mode to allow normal station
2637 : * operations like scanning to be completed.
2638 : */
2639 : int (*deinit_ap)(void *priv);
2640 :
2641 : /**
2642 : * deinit_p2p_cli - Deinitialize P2P client mode
2643 : * @priv: Private driver interface data
2644 : * Returns: 0 on success, -1 on failure (or if not supported)
2645 : *
2646 : * This optional function can be used to disable P2P client mode. If the
2647 : * interface was not dynamically added, change the interface type back
2648 : * to station mode.
2649 : */
2650 : int (*deinit_p2p_cli)(void *priv);
2651 :
2652 : /**
2653 : * suspend - Notification on system suspend/hibernate event
2654 : * @priv: Private driver interface data
2655 : */
2656 : void (*suspend)(void *priv);
2657 :
2658 : /**
2659 : * resume - Notification on system resume/thaw event
2660 : * @priv: Private driver interface data
2661 : */
2662 : void (*resume)(void *priv);
2663 :
2664 : /**
2665 : * signal_monitor - Set signal monitoring parameters
2666 : * @priv: Private driver interface data
2667 : * @threshold: Threshold value for signal change events; 0 = disabled
2668 : * @hysteresis: Minimum change in signal strength before indicating a
2669 : * new event
2670 : * Returns: 0 on success, -1 on failure (or if not supported)
2671 : *
2672 : * This function can be used to configure monitoring of signal strength
2673 : * with the current AP. Whenever signal strength drops below the
2674 : * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2675 : * should be generated assuming the signal strength has changed at
2676 : * least %hysteresis from the previously indicated signal change event.
2677 : */
2678 : int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2679 :
2680 : /**
2681 : * send_frame - Send IEEE 802.11 frame (testing use only)
2682 : * @priv: Private driver interface data
2683 : * @data: IEEE 802.11 frame with IEEE 802.11 header
2684 : * @data_len: Size of the frame
2685 : * @encrypt: Whether to encrypt the frame (if keys are set)
2686 : * Returns: 0 on success, -1 on failure
2687 : *
2688 : * This function is only used for debugging purposes and is not
2689 : * required to be implemented for normal operations.
2690 : */
2691 : int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2692 : int encrypt);
2693 :
2694 : /**
2695 : * get_noa - Get current Notice of Absence attribute payload
2696 : * @priv: Private driver interface data
2697 : * @buf: Buffer for returning NoA
2698 : * @buf_len: Buffer length in octets
2699 : * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2700 : * advertized, or -1 on failure
2701 : *
2702 : * This function is used to fetch the current Notice of Absence
2703 : * attribute value from GO.
2704 : */
2705 : int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2706 :
2707 : /**
2708 : * set_noa - Set Notice of Absence parameters for GO (testing)
2709 : * @priv: Private driver interface data
2710 : * @count: Count
2711 : * @start: Start time in ms from next TBTT
2712 : * @duration: Duration in ms
2713 : * Returns: 0 on success or -1 on failure
2714 : *
2715 : * This function is used to set Notice of Absence parameters for GO. It
2716 : * is used only for testing. To disable NoA, all parameters are set to
2717 : * 0.
2718 : */
2719 : int (*set_noa)(void *priv, u8 count, int start, int duration);
2720 :
2721 : /**
2722 : * set_p2p_powersave - Set P2P power save options
2723 : * @priv: Private driver interface data
2724 : * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2725 : * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2726 : * @ctwindow: 0.. = change (msec), -1 = no change
2727 : * Returns: 0 on success or -1 on failure
2728 : */
2729 : int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2730 : int ctwindow);
2731 :
2732 : /**
2733 : * ampdu - Enable/disable aggregation
2734 : * @priv: Private driver interface data
2735 : * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2736 : * Returns: 0 on success or -1 on failure
2737 : */
2738 : int (*ampdu)(void *priv, int ampdu);
2739 :
2740 : /**
2741 : * get_radio_name - Get physical radio name for the device
2742 : * @priv: Private driver interface data
2743 : * Returns: Radio name or %NULL if not known
2744 : *
2745 : * The returned data must not be modified by the caller. It is assumed
2746 : * that any interface that has the same radio name as another is
2747 : * sharing the same physical radio. This information can be used to
2748 : * share scan results etc. information between the virtual interfaces
2749 : * to speed up various operations.
2750 : */
2751 : const char * (*get_radio_name)(void *priv);
2752 :
2753 : /**
2754 : * send_tdls_mgmt - for sending TDLS management packets
2755 : * @priv: private driver interface data
2756 : * @dst: Destination (peer) MAC address
2757 : * @action_code: TDLS action code for the mssage
2758 : * @dialog_token: Dialog Token to use in the message (if needed)
2759 : * @status_code: Status Code or Reason Code to use (if needed)
2760 : * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2761 : * @initiator: Is the current end the TDLS link initiator
2762 : * @buf: TDLS IEs to add to the message
2763 : * @len: Length of buf in octets
2764 : * Returns: 0 on success, negative (<0) on failure
2765 : *
2766 : * This optional function can be used to send packet to driver which is
2767 : * responsible for receiving and sending all TDLS packets.
2768 : */
2769 : int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2770 : u8 dialog_token, u16 status_code, u32 peer_capab,
2771 : int initiator, const u8 *buf, size_t len);
2772 :
2773 : /**
2774 : * tdls_oper - Ask the driver to perform high-level TDLS operations
2775 : * @priv: Private driver interface data
2776 : * @oper: TDLS high-level operation. See %enum tdls_oper
2777 : * @peer: Destination (peer) MAC address
2778 : * Returns: 0 on success, negative (<0) on failure
2779 : *
2780 : * This optional function can be used to send high-level TDLS commands
2781 : * to the driver.
2782 : */
2783 : int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2784 :
2785 : /**
2786 : * wnm_oper - Notify driver of the WNM frame reception
2787 : * @priv: Private driver interface data
2788 : * @oper: WNM operation. See %enum wnm_oper
2789 : * @peer: Destination (peer) MAC address
2790 : * @buf: Buffer for the driver to fill in (for getting IE)
2791 : * @buf_len: Return the len of buf
2792 : * Returns: 0 on success, negative (<0) on failure
2793 : */
2794 : int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2795 : u8 *buf, u16 *buf_len);
2796 :
2797 : /**
2798 : * set_qos_map - Set QoS Map
2799 : * @priv: Private driver interface data
2800 : * @qos_map_set: QoS Map
2801 : * @qos_map_set_len: Length of QoS Map
2802 : */
2803 : int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2804 : u8 qos_map_set_len);
2805 :
2806 : /**
2807 : * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2808 : * @priv: Private driver interface data
2809 : * @version: IP version of the IP address, 4 or 6
2810 : * @ipaddr: IP address for the neigh entry
2811 : * @prefixlen: IP address prefix length
2812 : * @addr: Corresponding MAC address
2813 : * Returns: 0 on success, negative (<0) on failure
2814 : */
2815 : int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2816 : int prefixlen, const u8 *addr);
2817 :
2818 : /**
2819 : * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2820 : * @priv: Private driver interface data
2821 : * @version: IP version of the IP address, 4 or 6
2822 : * @ipaddr: IP address for the neigh entry
2823 : * Returns: 0 on success, negative (<0) on failure
2824 : */
2825 : int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2826 :
2827 : /**
2828 : * br_port_set_attr - Set a bridge port attribute
2829 : * @attr: Bridge port attribute to set
2830 : * @val: Value to be set
2831 : * Returns: 0 on success, negative (<0) on failure
2832 : */
2833 : int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2834 : unsigned int val);
2835 :
2836 : /**
2837 : * br_port_set_attr - Set a bridge network parameter
2838 : * @param: Bridge parameter to set
2839 : * @val: Value to be set
2840 : * Returns: 0 on success, negative (<0) on failure
2841 : */
2842 : int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2843 : unsigned int val);
2844 :
2845 : /**
2846 : * set_wowlan - Set wake-on-wireless triggers
2847 : * @priv: Private driver interface data
2848 : * @triggers: wowlan triggers
2849 : */
2850 : int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2851 :
2852 : /**
2853 : * signal_poll - Get current connection information
2854 : * @priv: Private driver interface data
2855 : * @signal_info: Connection info structure
2856 : */
2857 : int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2858 :
2859 : /**
2860 : * set_authmode - Set authentication algorithm(s) for static WEP
2861 : * @priv: Private driver interface data
2862 : * @authmode: 1=Open System, 2=Shared Key, 3=both
2863 : * Returns: 0 on success, -1 on failure
2864 : *
2865 : * This function can be used to set authentication algorithms for AP
2866 : * mode when static WEP is used. If the driver uses user space MLME/SME
2867 : * implementation, there is no need to implement this function.
2868 : *
2869 : * DEPRECATED - use set_ap() instead
2870 : */
2871 : int (*set_authmode)(void *priv, int authmode);
2872 :
2873 : #ifdef ANDROID
2874 : /**
2875 : * driver_cmd - Execute driver-specific command
2876 : * @priv: Private driver interface data
2877 : * @cmd: Command to execute
2878 : * @buf: Return buffer
2879 : * @buf_len: Buffer length
2880 : * Returns: 0 on success, -1 on failure
2881 : */
2882 : int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2883 : #endif /* ANDROID */
2884 :
2885 : /**
2886 : * vendor_cmd - Execute vendor specific command
2887 : * @priv: Private driver interface data
2888 : * @vendor_id: Vendor id
2889 : * @subcmd: Vendor command id
2890 : * @data: Vendor command parameters (%NULL if no parameters)
2891 : * @data_len: Data length
2892 : * @buf: Return buffer (%NULL to ignore reply)
2893 : * Returns: 0 on success, negative (<0) on failure
2894 : *
2895 : * This function handles vendor specific commands that are passed to
2896 : * the driver/device. The command is identified by vendor id and
2897 : * command id. Parameters can be passed as argument to the command
2898 : * in the data buffer. Reply (if any) will be filled in the supplied
2899 : * return buffer.
2900 : *
2901 : * The exact driver behavior is driver interface and vendor specific. As
2902 : * an example, this will be converted to a vendor specific cfg80211
2903 : * command in case of the nl80211 driver interface.
2904 : */
2905 : int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2906 : unsigned int subcmd, const u8 *data, size_t data_len,
2907 : struct wpabuf *buf);
2908 :
2909 : /**
2910 : * set_rekey_info - Set rekey information
2911 : * @priv: Private driver interface data
2912 : * @kek: Current KEK
2913 : * @kek_len: KEK length in octets
2914 : * @kck: Current KCK
2915 : * @kck_len: KCK length in octets
2916 : * @replay_ctr: Current EAPOL-Key Replay Counter
2917 : *
2918 : * This optional function can be used to provide information for the
2919 : * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2920 : * while the host (including wpa_supplicant) is sleeping.
2921 : */
2922 : void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
2923 : const u8 *kck, size_t kck_len,
2924 : const u8 *replay_ctr);
2925 :
2926 : /**
2927 : * sta_assoc - Station association indication
2928 : * @priv: Private driver interface data
2929 : * @own_addr: Source address and BSSID for association frame
2930 : * @addr: MAC address of the station to associate
2931 : * @reassoc: flag to indicate re-association
2932 : * @status: association response status code
2933 : * @ie: assoc response ie buffer
2934 : * @len: ie buffer length
2935 : * Returns: 0 on success, -1 on failure
2936 : *
2937 : * This function indicates the driver to send (Re)Association
2938 : * Response frame to the station.
2939 : */
2940 : int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2941 : int reassoc, u16 status, const u8 *ie, size_t len);
2942 :
2943 : /**
2944 : * sta_auth - Station authentication indication
2945 : * @priv: Private driver interface data
2946 : * @own_addr: Source address and BSSID for authentication frame
2947 : * @addr: MAC address of the station to associate
2948 : * @seq: authentication sequence number
2949 : * @status: authentication response status code
2950 : * @ie: authentication frame ie buffer
2951 : * @len: ie buffer length
2952 : *
2953 : * This function indicates the driver to send Authentication frame
2954 : * to the station.
2955 : */
2956 : int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2957 : u16 seq, u16 status, const u8 *ie, size_t len);
2958 :
2959 : /**
2960 : * add_tspec - Add traffic stream
2961 : * @priv: Private driver interface data
2962 : * @addr: MAC address of the station to associate
2963 : * @tspec_ie: tspec ie buffer
2964 : * @tspec_ielen: tspec ie length
2965 : * Returns: 0 on success, -1 on failure
2966 : *
2967 : * This function adds the traffic steam for the station
2968 : * and fills the medium_time in tspec_ie.
2969 : */
2970 : int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2971 : size_t tspec_ielen);
2972 :
2973 : /**
2974 : * add_sta_node - Add a station node in the driver
2975 : * @priv: Private driver interface data
2976 : * @addr: MAC address of the station to add
2977 : * @auth_alg: authentication algorithm used by the station
2978 : * Returns: 0 on success, -1 on failure
2979 : *
2980 : * This function adds the station node in the driver, when
2981 : * the station gets added by FT-over-DS.
2982 : */
2983 : int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2984 :
2985 : /**
2986 : * sched_scan - Request the driver to initiate scheduled scan
2987 : * @priv: Private driver interface data
2988 : * @params: Scan parameters
2989 : * @interval: Interval between scan cycles in milliseconds
2990 : * Returns: 0 on success, -1 on failure
2991 : *
2992 : * This operation should be used for scheduled scan offload to
2993 : * the hardware. Every time scan results are available, the
2994 : * driver should report scan results event for wpa_supplicant
2995 : * which will eventually request the results with
2996 : * wpa_driver_get_scan_results2(). This operation is optional
2997 : * and if not provided or if it returns -1, we fall back to
2998 : * normal host-scheduled scans.
2999 : */
3000 : int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
3001 : u32 interval);
3002 :
3003 : /**
3004 : * stop_sched_scan - Request the driver to stop a scheduled scan
3005 : * @priv: Private driver interface data
3006 : * Returns: 0 on success, -1 on failure
3007 : *
3008 : * This should cause the scheduled scan to be stopped and
3009 : * results should stop being sent. Must be supported if
3010 : * sched_scan is supported.
3011 : */
3012 : int (*stop_sched_scan)(void *priv);
3013 :
3014 : /**
3015 : * poll_client - Probe (null data or such) the given station
3016 : * @priv: Private driver interface data
3017 : * @own_addr: MAC address of sending interface
3018 : * @addr: MAC address of the station to probe
3019 : * @qos: Indicates whether station is QoS station
3020 : *
3021 : * This function is used to verify whether an associated station is
3022 : * still present. This function does not need to be implemented if the
3023 : * driver provides such inactivity polling mechanism.
3024 : */
3025 : void (*poll_client)(void *priv, const u8 *own_addr,
3026 : const u8 *addr, int qos);
3027 :
3028 : /**
3029 : * radio_disable - Disable/enable radio
3030 : * @priv: Private driver interface data
3031 : * @disabled: 1=disable 0=enable radio
3032 : * Returns: 0 on success, -1 on failure
3033 : *
3034 : * This optional command is for testing purposes. It can be used to
3035 : * disable the radio on a testbed device to simulate out-of-radio-range
3036 : * conditions.
3037 : */
3038 : int (*radio_disable)(void *priv, int disabled);
3039 :
3040 : /**
3041 : * switch_channel - Announce channel switch and migrate the GO to the
3042 : * given frequency
3043 : * @priv: Private driver interface data
3044 : * @settings: Settings for CSA period and new channel
3045 : * Returns: 0 on success, -1 on failure
3046 : *
3047 : * This function is used to move the GO to the legacy STA channel to
3048 : * avoid frequency conflict in single channel concurrency.
3049 : */
3050 : int (*switch_channel)(void *priv, struct csa_settings *settings);
3051 :
3052 : /**
3053 : * add_tx_ts - Add traffic stream
3054 : * @priv: Private driver interface data
3055 : * @tsid: Traffic stream ID
3056 : * @addr: Receiver address
3057 : * @user_prio: User priority of the traffic stream
3058 : * @admitted_time: Admitted time for this TS in units of
3059 : * 32 microsecond periods (per second).
3060 : * Returns: 0 on success, -1 on failure
3061 : */
3062 : int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3063 : u16 admitted_time);
3064 :
3065 : /**
3066 : * del_tx_ts - Delete traffic stream
3067 : * @priv: Private driver interface data
3068 : * @tsid: Traffic stream ID
3069 : * @addr: Receiver address
3070 : * Returns: 0 on success, -1 on failure
3071 : */
3072 : int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3073 :
3074 : /**
3075 : * Enable channel-switching with TDLS peer
3076 : * @priv: Private driver interface data
3077 : * @addr: MAC address of the TDLS peer
3078 : * @oper_class: Operating class of the switch channel
3079 : * @params: Channel specification
3080 : * Returns: 0 on success, -1 on failure
3081 : *
3082 : * The function indicates to driver that it can start switching to a
3083 : * different channel with a specified TDLS peer. The switching is
3084 : * assumed on until canceled with tdls_disable_channel_switch().
3085 : */
3086 : int (*tdls_enable_channel_switch)(
3087 : void *priv, const u8 *addr, u8 oper_class,
3088 : const struct hostapd_freq_params *params);
3089 :
3090 : /**
3091 : * Disable channel switching with TDLS peer
3092 : * @priv: Private driver interface data
3093 : * @addr: MAC address of the TDLS peer
3094 : * Returns: 0 on success, -1 on failure
3095 : *
3096 : * This function indicates to the driver that it should stop switching
3097 : * with a given TDLS peer.
3098 : */
3099 : int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3100 :
3101 : /**
3102 : * start_dfs_cac - Listen for radar interference on the channel
3103 : * @priv: Private driver interface data
3104 : * @freq: Channel parameters
3105 : * Returns: 0 on success, -1 on failure
3106 : */
3107 : int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
3108 :
3109 : /**
3110 : * stop_ap - Removes beacon from AP
3111 : * @priv: Private driver interface data
3112 : * Returns: 0 on success, -1 on failure (or if not supported)
3113 : *
3114 : * This optional function can be used to disable AP mode related
3115 : * configuration. Unlike deinit_ap, it does not change to station
3116 : * mode.
3117 : */
3118 : int (*stop_ap)(void *priv);
3119 :
3120 : /**
3121 : * get_survey - Retrieve survey data
3122 : * @priv: Private driver interface data
3123 : * @freq: If set, survey data for the specified frequency is only
3124 : * being requested. If not set, all survey data is requested.
3125 : * Returns: 0 on success, -1 on failure
3126 : *
3127 : * Use this to retrieve:
3128 : *
3129 : * - the observed channel noise floor
3130 : * - the amount of time we have spent on the channel
3131 : * - the amount of time during which we have spent on the channel that
3132 : * the radio has determined the medium is busy and we cannot
3133 : * transmit
3134 : * - the amount of time we have spent receiving data
3135 : * - the amount of time we have spent transmitting data
3136 : *
3137 : * This data can be used for spectrum heuristics. One example is
3138 : * Automatic Channel Selection (ACS). The channel survey data is
3139 : * kept on a linked list on the channel data, one entry is added
3140 : * for each survey. The min_nf of the channel is updated for each
3141 : * survey.
3142 : */
3143 : int (*get_survey)(void *priv, unsigned int freq);
3144 :
3145 : /**
3146 : * status - Get driver interface status information
3147 : * @priv: Private driver interface data
3148 : * @buf: Buffer for printing tou the status information
3149 : * @buflen: Maximum length of the buffer
3150 : * Returns: Length of written status information or -1 on failure
3151 : */
3152 : int (*status)(void *priv, char *buf, size_t buflen);
3153 :
3154 : /**
3155 : * roaming - Set roaming policy for driver-based BSS selection
3156 : * @priv: Private driver interface data
3157 : * @allowed: Whether roaming within ESS is allowed
3158 : * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3159 : * Returns: Length of written status information or -1 on failure
3160 : *
3161 : * This optional callback can be used to update roaming policy from the
3162 : * associate() command (bssid being set there indicates that the driver
3163 : * should not roam before getting this roaming() call to allow roaming.
3164 : * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3165 : * capability, roaming policy is handled within wpa_supplicant and there
3166 : * is no need to implement or react to this callback.
3167 : */
3168 : int (*roaming)(void *priv, int allowed, const u8 *bssid);
3169 :
3170 : /**
3171 : * set_mac_addr - Set MAC address
3172 : * @priv: Private driver interface data
3173 : * @addr: MAC address to use or %NULL for setting back to permanent
3174 : * Returns: 0 on success, -1 on failure
3175 : */
3176 : int (*set_mac_addr)(void *priv, const u8 *addr);
3177 :
3178 : #ifdef CONFIG_MACSEC
3179 : int (*macsec_init)(void *priv, struct macsec_init_params *params);
3180 :
3181 : int (*macsec_deinit)(void *priv);
3182 :
3183 : /**
3184 : * enable_protect_frames - Set protect frames status
3185 : * @priv: Private driver interface data
3186 : * @enabled: TRUE = protect frames enabled
3187 : * FALSE = protect frames disabled
3188 : * Returns: 0 on success, -1 on failure (or if not supported)
3189 : */
3190 : int (*enable_protect_frames)(void *priv, Boolean enabled);
3191 :
3192 : /**
3193 : * set_replay_protect - Set replay protect status and window size
3194 : * @priv: Private driver interface data
3195 : * @enabled: TRUE = replay protect enabled
3196 : * FALSE = replay protect disabled
3197 : * @window: replay window size, valid only when replay protect enabled
3198 : * Returns: 0 on success, -1 on failure (or if not supported)
3199 : */
3200 : int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3201 :
3202 : /**
3203 : * set_current_cipher_suite - Set current cipher suite
3204 : * @priv: Private driver interface data
3205 : * @cs: EUI64 identifier
3206 : * @cs_len: Length of the cs buffer in octets
3207 : * Returns: 0 on success, -1 on failure (or if not supported)
3208 : */
3209 : int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3210 : size_t cs_len);
3211 :
3212 : /**
3213 : * enable_controlled_port - Set controlled port status
3214 : * @priv: Private driver interface data
3215 : * @enabled: TRUE = controlled port enabled
3216 : * FALSE = controlled port disabled
3217 : * Returns: 0 on success, -1 on failure (or if not supported)
3218 : */
3219 : int (*enable_controlled_port)(void *priv, Boolean enabled);
3220 :
3221 : /**
3222 : * get_receive_lowest_pn - Get receive lowest pn
3223 : * @priv: Private driver interface data
3224 : * @channel: secure channel
3225 : * @an: association number
3226 : * @lowest_pn: lowest accept pn
3227 : * Returns: 0 on success, -1 on failure (or if not supported)
3228 : */
3229 : int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3230 : u32 *lowest_pn);
3231 :
3232 : /**
3233 : * get_transmit_next_pn - Get transmit next pn
3234 : * @priv: Private driver interface data
3235 : * @channel: secure channel
3236 : * @an: association number
3237 : * @next_pn: next pn
3238 : * Returns: 0 on success, -1 on failure (or if not supported)
3239 : */
3240 : int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3241 : u32 *next_pn);
3242 :
3243 : /**
3244 : * set_transmit_next_pn - Set transmit next pn
3245 : * @priv: Private driver interface data
3246 : * @channel: secure channel
3247 : * @an: association number
3248 : * @next_pn: next pn
3249 : * Returns: 0 on success, -1 on failure (or if not supported)
3250 : */
3251 : int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3252 : u32 next_pn);
3253 :
3254 : /**
3255 : * get_available_receive_sc - get available receive channel
3256 : * @priv: Private driver interface data
3257 : * @channel: secure channel
3258 : * Returns: 0 on success, -1 on failure (or if not supported)
3259 : */
3260 : int (*get_available_receive_sc)(void *priv, u32 *channel);
3261 :
3262 : /**
3263 : * create_receive_sc - create secure channel for receiving
3264 : * @priv: Private driver interface data
3265 : * @channel: secure channel
3266 : * @sci_addr: secure channel identifier - address
3267 : * @sci_port: secure channel identifier - port
3268 : * @conf_offset: confidentiality offset (0, 30, or 50)
3269 : * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3270 : * 2 = Strict)
3271 : * Returns: 0 on success, -1 on failure (or if not supported)
3272 : */
3273 : int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3274 : u16 sci_port, unsigned int conf_offset,
3275 : int validation);
3276 :
3277 : /**
3278 : * delete_receive_sc - delete secure connection for receiving
3279 : * @priv: private driver interface data from init()
3280 : * @channel: secure channel
3281 : * Returns: 0 on success, -1 on failure
3282 : */
3283 : int (*delete_receive_sc)(void *priv, u32 channel);
3284 :
3285 : /**
3286 : * create_receive_sa - create secure association for receive
3287 : * @priv: private driver interface data from init()
3288 : * @channel: secure channel
3289 : * @an: association number
3290 : * @lowest_pn: the lowest packet number can be received
3291 : * @sak: the secure association key
3292 : * Returns: 0 on success, -1 on failure
3293 : */
3294 : int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3295 : u32 lowest_pn, const u8 *sak);
3296 :
3297 : /**
3298 : * enable_receive_sa - enable the SA for receive
3299 : * @priv: private driver interface data from init()
3300 : * @channel: secure channel
3301 : * @an: association number
3302 : * Returns: 0 on success, -1 on failure
3303 : */
3304 : int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3305 :
3306 : /**
3307 : * disable_receive_sa - disable SA for receive
3308 : * @priv: private driver interface data from init()
3309 : * @channel: secure channel index
3310 : * @an: association number
3311 : * Returns: 0 on success, -1 on failure
3312 : */
3313 : int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3314 :
3315 : /**
3316 : * get_available_transmit_sc - get available transmit channel
3317 : * @priv: Private driver interface data
3318 : * @channel: secure channel
3319 : * Returns: 0 on success, -1 on failure (or if not supported)
3320 : */
3321 : int (*get_available_transmit_sc)(void *priv, u32 *channel);
3322 :
3323 : /**
3324 : * create_transmit_sc - create secure connection for transmit
3325 : * @priv: private driver interface data from init()
3326 : * @channel: secure channel
3327 : * @sci_addr: secure channel identifier - address
3328 : * @sci_port: secure channel identifier - port
3329 : * Returns: 0 on success, -1 on failure
3330 : */
3331 : int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3332 : u16 sci_port, unsigned int conf_offset);
3333 :
3334 : /**
3335 : * delete_transmit_sc - delete secure connection for transmit
3336 : * @priv: private driver interface data from init()
3337 : * @channel: secure channel
3338 : * Returns: 0 on success, -1 on failure
3339 : */
3340 : int (*delete_transmit_sc)(void *priv, u32 channel);
3341 :
3342 : /**
3343 : * create_transmit_sa - create secure association for transmit
3344 : * @priv: private driver interface data from init()
3345 : * @channel: secure channel index
3346 : * @an: association number
3347 : * @next_pn: the packet number used as next transmit packet
3348 : * @confidentiality: True if the SA is to provide confidentiality
3349 : * as well as integrity
3350 : * @sak: the secure association key
3351 : * Returns: 0 on success, -1 on failure
3352 : */
3353 : int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3354 : Boolean confidentiality, const u8 *sak);
3355 :
3356 : /**
3357 : * enable_transmit_sa - enable SA for transmit
3358 : * @priv: private driver interface data from init()
3359 : * @channel: secure channel
3360 : * @an: association number
3361 : * Returns: 0 on success, -1 on failure
3362 : */
3363 : int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3364 :
3365 : /**
3366 : * disable_transmit_sa - disable SA for transmit
3367 : * @priv: private driver interface data from init()
3368 : * @channel: secure channel
3369 : * @an: association number
3370 : * Returns: 0 on success, -1 on failure
3371 : */
3372 : int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3373 : #endif /* CONFIG_MACSEC */
3374 :
3375 : /**
3376 : * init_mesh - Driver specific initialization for mesh
3377 : * @priv: Private driver interface data
3378 : * Returns: 0 on success, -1 on failure
3379 : */
3380 : int (*init_mesh)(void *priv);
3381 :
3382 : /**
3383 : * join_mesh - Join a mesh network
3384 : * @priv: Private driver interface data
3385 : * @params: Mesh configuration parameters
3386 : * Returns: 0 on success, -1 on failure
3387 : */
3388 : int (*join_mesh)(void *priv,
3389 : struct wpa_driver_mesh_join_params *params);
3390 :
3391 : /**
3392 : * leave_mesh - Leave a mesh network
3393 : * @priv: Private driver interface data
3394 : * Returns 0 on success, -1 on failure
3395 : */
3396 : int (*leave_mesh)(void *priv);
3397 :
3398 : /**
3399 : * do_acs - Automatically select channel
3400 : * @priv: Private driver interface data
3401 : * @params: Parameters for ACS
3402 : * Returns 0 on success, -1 on failure
3403 : *
3404 : * This command can be used to offload ACS to the driver if the driver
3405 : * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3406 : */
3407 : int (*do_acs)(void *priv, struct drv_acs_params *params);
3408 :
3409 : /**
3410 : * set_band - Notify driver of band selection
3411 : * @priv: Private driver interface data
3412 : * @band: The selected band(s)
3413 : * Returns 0 on success, -1 on failure
3414 : */
3415 : int (*set_band)(void *priv, enum set_band band);
3416 :
3417 : /**
3418 : * get_pref_freq_list - Get preferred frequency list for an interface
3419 : * @priv: Private driver interface data
3420 : * @if_type: Interface type
3421 : * @num: Number of channels
3422 : * @freq_list: Preferred channel frequency list encoded in MHz values
3423 : * Returns 0 on success, -1 on failure
3424 : *
3425 : * This command can be used to query the preferred frequency list from
3426 : * the driver specific to a particular interface type.
3427 : */
3428 : int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
3429 : unsigned int *num, unsigned int *freq_list);
3430 :
3431 : /**
3432 : * set_prob_oper_freq - Indicate probable P2P operating channel
3433 : * @priv: Private driver interface data
3434 : * @freq: Channel frequency in MHz
3435 : * Returns 0 on success, -1 on failure
3436 : *
3437 : * This command can be used to inform the driver of the operating
3438 : * frequency that an ongoing P2P group formation is likely to come up
3439 : * on. Local device is assuming P2P Client role.
3440 : */
3441 : int (*set_prob_oper_freq)(void *priv, unsigned int freq);
3442 : };
3443 :
3444 :
3445 : /**
3446 : * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3447 : */
3448 : enum wpa_event_type {
3449 : /**
3450 : * EVENT_ASSOC - Association completed
3451 : *
3452 : * This event needs to be delivered when the driver completes IEEE
3453 : * 802.11 association or reassociation successfully.
3454 : * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3455 : * after this event has been generated. In addition, optional
3456 : * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3457 : * more information about the association. If the driver interface gets
3458 : * both of these events at the same time, it can also include the
3459 : * assoc_info data in EVENT_ASSOC call.
3460 : */
3461 : EVENT_ASSOC,
3462 :
3463 : /**
3464 : * EVENT_DISASSOC - Association lost
3465 : *
3466 : * This event should be called when association is lost either due to
3467 : * receiving deauthenticate or disassociate frame from the AP or when
3468 : * sending either of these frames to the current AP. If the driver
3469 : * supports separate deauthentication event, EVENT_DISASSOC should only
3470 : * be used for disassociation and EVENT_DEAUTH for deauthentication.
3471 : * In AP mode, union wpa_event_data::disassoc_info is required.
3472 : */
3473 : EVENT_DISASSOC,
3474 :
3475 : /**
3476 : * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3477 : *
3478 : * This event must be delivered when a Michael MIC error is detected by
3479 : * the local driver. Additional data for event processing is
3480 : * provided with union wpa_event_data::michael_mic_failure. This
3481 : * information is used to request new encyption key and to initiate
3482 : * TKIP countermeasures if needed.
3483 : */
3484 : EVENT_MICHAEL_MIC_FAILURE,
3485 :
3486 : /**
3487 : * EVENT_SCAN_RESULTS - Scan results available
3488 : *
3489 : * This event must be called whenever scan results are available to be
3490 : * fetched with struct wpa_driver_ops::get_scan_results(). This event
3491 : * is expected to be used some time after struct wpa_driver_ops::scan()
3492 : * is called. If the driver provides an unsolicited event when the scan
3493 : * has been completed, this event can be used to trigger
3494 : * EVENT_SCAN_RESULTS call. If such event is not available from the
3495 : * driver, the driver wrapper code is expected to use a registered
3496 : * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3497 : * scan is expected to be completed. Optional information about
3498 : * completed scan can be provided with union wpa_event_data::scan_info.
3499 : */
3500 : EVENT_SCAN_RESULTS,
3501 :
3502 : /**
3503 : * EVENT_ASSOCINFO - Report optional extra information for association
3504 : *
3505 : * This event can be used to report extra association information for
3506 : * EVENT_ASSOC processing. This extra information includes IEs from
3507 : * association frames and Beacon/Probe Response frames in union
3508 : * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3509 : * EVENT_ASSOC. Alternatively, the driver interface can include
3510 : * assoc_info data in the EVENT_ASSOC call if it has all the
3511 : * information available at the same point.
3512 : */
3513 : EVENT_ASSOCINFO,
3514 :
3515 : /**
3516 : * EVENT_INTERFACE_STATUS - Report interface status changes
3517 : *
3518 : * This optional event can be used to report changes in interface
3519 : * status (interface added/removed) using union
3520 : * wpa_event_data::interface_status. This can be used to trigger
3521 : * wpa_supplicant to stop and re-start processing for the interface,
3522 : * e.g., when a cardbus card is ejected/inserted.
3523 : */
3524 : EVENT_INTERFACE_STATUS,
3525 :
3526 : /**
3527 : * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3528 : *
3529 : * This event can be used to inform wpa_supplicant about candidates for
3530 : * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3531 : * for scan request (ap_scan=2 mode), this event is required for
3532 : * pre-authentication. If wpa_supplicant is performing scan request
3533 : * (ap_scan=1), this event is optional since scan results can be used
3534 : * to add pre-authentication candidates. union
3535 : * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3536 : * candidate and priority of the candidate, e.g., based on the signal
3537 : * strength, in order to try to pre-authenticate first with candidates
3538 : * that are most likely targets for re-association.
3539 : *
3540 : * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3541 : * on the candidate list. In addition, it can be called for the current
3542 : * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3543 : * will automatically skip pre-authentication in cases where a valid
3544 : * PMKSA exists. When more than one candidate exists, this event should
3545 : * be generated once for each candidate.
3546 : *
3547 : * Driver will be notified about successful pre-authentication with
3548 : * struct wpa_driver_ops::add_pmkid() calls.
3549 : */
3550 : EVENT_PMKID_CANDIDATE,
3551 :
3552 : /**
3553 : * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3554 : *
3555 : * This event can be used to inform wpa_supplicant about desire to set
3556 : * up secure direct link connection between two stations as defined in
3557 : * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3558 : * STAKey negotiation. The caller will need to set peer address for the
3559 : * event.
3560 : */
3561 : EVENT_STKSTART,
3562 :
3563 : /**
3564 : * EVENT_TDLS - Request TDLS operation
3565 : *
3566 : * This event can be used to request a TDLS operation to be performed.
3567 : */
3568 : EVENT_TDLS,
3569 :
3570 : /**
3571 : * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3572 : *
3573 : * The driver is expected to report the received FT IEs from
3574 : * FT authentication sequence from the AP. The FT IEs are included in
3575 : * the extra information in union wpa_event_data::ft_ies.
3576 : */
3577 : EVENT_FT_RESPONSE,
3578 :
3579 : /**
3580 : * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3581 : *
3582 : * The driver can use this event to inform wpa_supplicant about a STA
3583 : * in an IBSS with which protected frames could be exchanged. This
3584 : * event starts RSN authentication with the other STA to authenticate
3585 : * the STA and set up encryption keys with it.
3586 : */
3587 : EVENT_IBSS_RSN_START,
3588 :
3589 : /**
3590 : * EVENT_AUTH - Authentication result
3591 : *
3592 : * This event should be called when authentication attempt has been
3593 : * completed. This is only used if the driver supports separate
3594 : * authentication step (struct wpa_driver_ops::authenticate).
3595 : * Information about authentication result is included in
3596 : * union wpa_event_data::auth.
3597 : */
3598 : EVENT_AUTH,
3599 :
3600 : /**
3601 : * EVENT_DEAUTH - Authentication lost
3602 : *
3603 : * This event should be called when authentication is lost either due
3604 : * to receiving deauthenticate frame from the AP or when sending that
3605 : * frame to the current AP.
3606 : * In AP mode, union wpa_event_data::deauth_info is required.
3607 : */
3608 : EVENT_DEAUTH,
3609 :
3610 : /**
3611 : * EVENT_ASSOC_REJECT - Association rejected
3612 : *
3613 : * This event should be called when (re)association attempt has been
3614 : * rejected by the AP. Information about the association response is
3615 : * included in union wpa_event_data::assoc_reject.
3616 : */
3617 : EVENT_ASSOC_REJECT,
3618 :
3619 : /**
3620 : * EVENT_AUTH_TIMED_OUT - Authentication timed out
3621 : */
3622 : EVENT_AUTH_TIMED_OUT,
3623 :
3624 : /**
3625 : * EVENT_ASSOC_TIMED_OUT - Association timed out
3626 : */
3627 : EVENT_ASSOC_TIMED_OUT,
3628 :
3629 : /**
3630 : * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3631 : */
3632 : EVENT_WPS_BUTTON_PUSHED,
3633 :
3634 : /**
3635 : * EVENT_TX_STATUS - Report TX status
3636 : */
3637 : EVENT_TX_STATUS,
3638 :
3639 : /**
3640 : * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3641 : */
3642 : EVENT_RX_FROM_UNKNOWN,
3643 :
3644 : /**
3645 : * EVENT_RX_MGMT - Report RX of a management frame
3646 : */
3647 : EVENT_RX_MGMT,
3648 :
3649 : /**
3650 : * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3651 : *
3652 : * This event is used to indicate when the driver has started the
3653 : * requested remain-on-channel duration. Information about the
3654 : * operation is included in union wpa_event_data::remain_on_channel.
3655 : */
3656 : EVENT_REMAIN_ON_CHANNEL,
3657 :
3658 : /**
3659 : * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3660 : *
3661 : * This event is used to indicate when the driver has completed
3662 : * remain-on-channel duration, i.e., may noot be available on the
3663 : * requested channel anymore. Information about the
3664 : * operation is included in union wpa_event_data::remain_on_channel.
3665 : */
3666 : EVENT_CANCEL_REMAIN_ON_CHANNEL,
3667 :
3668 : /**
3669 : * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3670 : *
3671 : * This event is used to indicate when a Probe Request frame has been
3672 : * received. Information about the received frame is included in
3673 : * union wpa_event_data::rx_probe_req. The driver is required to report
3674 : * these events only after successfully completed probe_req_report()
3675 : * commands to request the events (i.e., report parameter is non-zero)
3676 : * in station mode. In AP mode, Probe Request frames should always be
3677 : * reported.
3678 : */
3679 : EVENT_RX_PROBE_REQ,
3680 :
3681 : /**
3682 : * EVENT_NEW_STA - New wired device noticed
3683 : *
3684 : * This event is used to indicate that a new device has been detected
3685 : * in a network that does not use association-like functionality (i.e.,
3686 : * mainly wired Ethernet). This can be used to start EAPOL
3687 : * authenticator when receiving a frame from a device. The address of
3688 : * the device is included in union wpa_event_data::new_sta.
3689 : */
3690 : EVENT_NEW_STA,
3691 :
3692 : /**
3693 : * EVENT_EAPOL_RX - Report received EAPOL frame
3694 : *
3695 : * When in AP mode with hostapd, this event is required to be used to
3696 : * deliver the receive EAPOL frames from the driver.
3697 : */
3698 : EVENT_EAPOL_RX,
3699 :
3700 : /**
3701 : * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3702 : *
3703 : * This event is used to indicate changes in the signal strength
3704 : * observed in frames received from the current AP if signal strength
3705 : * monitoring has been enabled with signal_monitor().
3706 : */
3707 : EVENT_SIGNAL_CHANGE,
3708 :
3709 : /**
3710 : * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3711 : *
3712 : * This event is used to indicate that the interface was enabled after
3713 : * having been previously disabled, e.g., due to rfkill.
3714 : */
3715 : EVENT_INTERFACE_ENABLED,
3716 :
3717 : /**
3718 : * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3719 : *
3720 : * This event is used to indicate that the interface was disabled,
3721 : * e.g., due to rfkill.
3722 : */
3723 : EVENT_INTERFACE_DISABLED,
3724 :
3725 : /**
3726 : * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3727 : *
3728 : * This event is used to indicate that the channel list has changed,
3729 : * e.g., because of a regulatory domain change triggered by scan
3730 : * results including an AP advertising a country code.
3731 : */
3732 : EVENT_CHANNEL_LIST_CHANGED,
3733 :
3734 : /**
3735 : * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3736 : *
3737 : * This event is used to indicate that the driver cannot maintain this
3738 : * interface in its operation mode anymore. The most likely use for
3739 : * this is to indicate that AP mode operation is not available due to
3740 : * operating channel would need to be changed to a DFS channel when
3741 : * the driver does not support radar detection and another virtual
3742 : * interfaces caused the operating channel to change. Other similar
3743 : * resource conflicts could also trigger this for station mode
3744 : * interfaces. This event can be propagated when channel switching
3745 : * fails.
3746 : */
3747 : EVENT_INTERFACE_UNAVAILABLE,
3748 :
3749 : /**
3750 : * EVENT_BEST_CHANNEL
3751 : *
3752 : * Driver generates this event whenever it detects a better channel
3753 : * (e.g., based on RSSI or channel use). This information can be used
3754 : * to improve channel selection for a new AP/P2P group.
3755 : */
3756 : EVENT_BEST_CHANNEL,
3757 :
3758 : /**
3759 : * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3760 : *
3761 : * This event should be called when a Deauthentication frame is dropped
3762 : * due to it not being protected (MFP/IEEE 802.11w).
3763 : * union wpa_event_data::unprot_deauth is required to provide more
3764 : * details of the frame.
3765 : */
3766 : EVENT_UNPROT_DEAUTH,
3767 :
3768 : /**
3769 : * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3770 : *
3771 : * This event should be called when a Disassociation frame is dropped
3772 : * due to it not being protected (MFP/IEEE 802.11w).
3773 : * union wpa_event_data::unprot_disassoc is required to provide more
3774 : * details of the frame.
3775 : */
3776 : EVENT_UNPROT_DISASSOC,
3777 :
3778 : /**
3779 : * EVENT_STATION_LOW_ACK
3780 : *
3781 : * Driver generates this event whenever it detected that a particular
3782 : * station was lost. Detection can be through massive transmission
3783 : * failures for example.
3784 : */
3785 : EVENT_STATION_LOW_ACK,
3786 :
3787 : /**
3788 : * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3789 : */
3790 : EVENT_IBSS_PEER_LOST,
3791 :
3792 : /**
3793 : * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3794 : *
3795 : * This event carries the new replay counter to notify wpa_supplicant
3796 : * of the current EAPOL-Key Replay Counter in case the driver/firmware
3797 : * completed Group Key Handshake while the host (including
3798 : * wpa_supplicant was sleeping).
3799 : */
3800 : EVENT_DRIVER_GTK_REKEY,
3801 :
3802 : /**
3803 : * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3804 : */
3805 : EVENT_SCHED_SCAN_STOPPED,
3806 :
3807 : /**
3808 : * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3809 : *
3810 : * This event indicates that the station responded to the poll
3811 : * initiated with @poll_client.
3812 : */
3813 : EVENT_DRIVER_CLIENT_POLL_OK,
3814 :
3815 : /**
3816 : * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3817 : */
3818 : EVENT_EAPOL_TX_STATUS,
3819 :
3820 : /**
3821 : * EVENT_CH_SWITCH - AP or GO decided to switch channels
3822 : *
3823 : * Described in wpa_event_data.ch_switch
3824 : * */
3825 : EVENT_CH_SWITCH,
3826 :
3827 : /**
3828 : * EVENT_WNM - Request WNM operation
3829 : *
3830 : * This event can be used to request a WNM operation to be performed.
3831 : */
3832 : EVENT_WNM,
3833 :
3834 : /**
3835 : * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3836 : *
3837 : * This event indicates that the driver reported a connection failure
3838 : * with the specified client (for example, max client reached, etc.) in
3839 : * AP mode.
3840 : */
3841 : EVENT_CONNECT_FAILED_REASON,
3842 :
3843 : /**
3844 : * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
3845 : *
3846 : * A radar has been detected on the supplied frequency, hostapd should
3847 : * react accordingly (e.g., change channel).
3848 : */
3849 : EVENT_DFS_RADAR_DETECTED,
3850 :
3851 : /**
3852 : * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
3853 : *
3854 : * After a successful CAC, the channel can be marked clear and used.
3855 : */
3856 : EVENT_DFS_CAC_FINISHED,
3857 :
3858 : /**
3859 : * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
3860 : *
3861 : * The CAC was not successful, and the channel remains in the previous
3862 : * state. This may happen due to a radar beeing detected or other
3863 : * external influences.
3864 : */
3865 : EVENT_DFS_CAC_ABORTED,
3866 :
3867 : /**
3868 : * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
3869 : *
3870 : * The channel which was previously unavailable is now available again.
3871 : */
3872 : EVENT_DFS_NOP_FINISHED,
3873 :
3874 : /**
3875 : * EVENT_SURVEY - Received survey data
3876 : *
3877 : * This event gets triggered when a driver query is issued for survey
3878 : * data and the requested data becomes available. The returned data is
3879 : * stored in struct survey_results. The results provide at most one
3880 : * survey entry for each frequency and at minimum will provide one
3881 : * survey entry for one frequency. The survey data can be os_malloc()'d
3882 : * and then os_free()'d, so the event callback must only copy data.
3883 : */
3884 : EVENT_SURVEY,
3885 :
3886 : /**
3887 : * EVENT_SCAN_STARTED - Scan started
3888 : *
3889 : * This indicates that driver has started a scan operation either based
3890 : * on a request from wpa_supplicant/hostapd or from another application.
3891 : * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3892 : * completed (either successfully or by getting cancelled).
3893 : */
3894 : EVENT_SCAN_STARTED,
3895 :
3896 : /**
3897 : * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3898 : *
3899 : * This event indicates a set of frequency ranges that should be avoided
3900 : * to reduce issues due to interference or internal co-existence
3901 : * information in the driver.
3902 : */
3903 : EVENT_AVOID_FREQUENCIES,
3904 :
3905 : /**
3906 : * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3907 : */
3908 : EVENT_NEW_PEER_CANDIDATE,
3909 :
3910 : /**
3911 : * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
3912 : *
3913 : * Indicates a pair of primary and secondary channels chosen by ACS
3914 : * in device.
3915 : */
3916 : EVENT_ACS_CHANNEL_SELECTED,
3917 :
3918 : /**
3919 : * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
3920 : * been started.
3921 : *
3922 : * This event indicates that channel availability check has been started
3923 : * on a DFS frequency by a driver that supports DFS Offload.
3924 : */
3925 : EVENT_DFS_CAC_STARTED,
3926 : };
3927 :
3928 :
3929 : /**
3930 : * struct freq_survey - Channel survey info
3931 : *
3932 : * @ifidx: Interface index in which this survey was observed
3933 : * @freq: Center of frequency of the surveyed channel
3934 : * @nf: Channel noise floor in dBm
3935 : * @channel_time: Amount of time in ms the radio spent on the channel
3936 : * @channel_time_busy: Amount of time in ms the radio detected some signal
3937 : * that indicated to the radio the channel was not clear
3938 : * @channel_time_rx: Amount of time the radio spent receiving data
3939 : * @channel_time_tx: Amount of time the radio spent transmitting data
3940 : * @filled: bitmask indicating which fields have been reported, see
3941 : * SURVEY_HAS_* defines.
3942 : * @list: Internal list pointers
3943 : */
3944 : struct freq_survey {
3945 : u32 ifidx;
3946 : unsigned int freq;
3947 : s8 nf;
3948 : u64 channel_time;
3949 : u64 channel_time_busy;
3950 : u64 channel_time_rx;
3951 : u64 channel_time_tx;
3952 : unsigned int filled;
3953 : struct dl_list list;
3954 : };
3955 :
3956 : #define SURVEY_HAS_NF BIT(0)
3957 : #define SURVEY_HAS_CHAN_TIME BIT(1)
3958 : #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3959 : #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3960 : #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3961 :
3962 :
3963 : /**
3964 : * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3965 : */
3966 : union wpa_event_data {
3967 : /**
3968 : * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3969 : *
3970 : * This structure is optional for EVENT_ASSOC calls and required for
3971 : * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3972 : * driver interface does not need to generate separate EVENT_ASSOCINFO
3973 : * calls.
3974 : */
3975 : struct assoc_info {
3976 : /**
3977 : * reassoc - Flag to indicate association or reassociation
3978 : */
3979 : int reassoc;
3980 :
3981 : /**
3982 : * req_ies - (Re)Association Request IEs
3983 : *
3984 : * If the driver generates WPA/RSN IE, this event data must be
3985 : * returned for WPA handshake to have needed information. If
3986 : * wpa_supplicant-generated WPA/RSN IE is used, this
3987 : * information event is optional.
3988 : *
3989 : * This should start with the first IE (fixed fields before IEs
3990 : * are not included).
3991 : */
3992 : const u8 *req_ies;
3993 :
3994 : /**
3995 : * req_ies_len - Length of req_ies in bytes
3996 : */
3997 : size_t req_ies_len;
3998 :
3999 : /**
4000 : * resp_ies - (Re)Association Response IEs
4001 : *
4002 : * Optional association data from the driver. This data is not
4003 : * required WPA, but may be useful for some protocols and as
4004 : * such, should be reported if this is available to the driver
4005 : * interface.
4006 : *
4007 : * This should start with the first IE (fixed fields before IEs
4008 : * are not included).
4009 : */
4010 : const u8 *resp_ies;
4011 :
4012 : /**
4013 : * resp_ies_len - Length of resp_ies in bytes
4014 : */
4015 : size_t resp_ies_len;
4016 :
4017 : /**
4018 : * beacon_ies - Beacon or Probe Response IEs
4019 : *
4020 : * Optional Beacon/ProbeResp data: IEs included in Beacon or
4021 : * Probe Response frames from the current AP (i.e., the one
4022 : * that the client just associated with). This information is
4023 : * used to update WPA/RSN IE for the AP. If this field is not
4024 : * set, the results from previous scan will be used. If no
4025 : * data for the new AP is found, scan results will be requested
4026 : * again (without scan request). At this point, the driver is
4027 : * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4028 : * used).
4029 : *
4030 : * This should start with the first IE (fixed fields before IEs
4031 : * are not included).
4032 : */
4033 : const u8 *beacon_ies;
4034 :
4035 : /**
4036 : * beacon_ies_len - Length of beacon_ies */
4037 : size_t beacon_ies_len;
4038 :
4039 : /**
4040 : * freq - Frequency of the operational channel in MHz
4041 : */
4042 : unsigned int freq;
4043 :
4044 : /**
4045 : * wmm_params - WMM parameters used in this association.
4046 : */
4047 : struct wmm_params wmm_params;
4048 :
4049 : /**
4050 : * addr - Station address (for AP mode)
4051 : */
4052 : const u8 *addr;
4053 :
4054 : /**
4055 : * The following is the key management offload information
4056 : * @authorized
4057 : * @key_replay_ctr
4058 : * @key_replay_ctr_len
4059 : * @ptk_kck
4060 : * @ptk_kek_len
4061 : * @ptk_kek
4062 : * @ptk_kek_len
4063 : */
4064 :
4065 : /**
4066 : * authorized - Status of key management offload,
4067 : * 1 = successful
4068 : */
4069 : int authorized;
4070 :
4071 : /**
4072 : * key_replay_ctr - Key replay counter value last used
4073 : * in a valid EAPOL-Key frame
4074 : */
4075 : const u8 *key_replay_ctr;
4076 :
4077 : /**
4078 : * key_replay_ctr_len - The length of key_replay_ctr
4079 : */
4080 : size_t key_replay_ctr_len;
4081 :
4082 : /**
4083 : * ptk_kck - The derived PTK KCK
4084 : */
4085 : const u8 *ptk_kck;
4086 :
4087 : /**
4088 : * ptk_kek_len - The length of ptk_kck
4089 : */
4090 : size_t ptk_kck_len;
4091 :
4092 : /**
4093 : * ptk_kek - The derived PTK KEK
4094 : */
4095 : const u8 *ptk_kek;
4096 :
4097 : /**
4098 : * ptk_kek_len - The length of ptk_kek
4099 : */
4100 : size_t ptk_kek_len;
4101 : } assoc_info;
4102 :
4103 : /**
4104 : * struct disassoc_info - Data for EVENT_DISASSOC events
4105 : */
4106 : struct disassoc_info {
4107 : /**
4108 : * addr - Station address (for AP mode)
4109 : */
4110 : const u8 *addr;
4111 :
4112 : /**
4113 : * reason_code - Reason Code (host byte order) used in
4114 : * Deauthentication frame
4115 : */
4116 : u16 reason_code;
4117 :
4118 : /**
4119 : * ie - Optional IE(s) in Disassociation frame
4120 : */
4121 : const u8 *ie;
4122 :
4123 : /**
4124 : * ie_len - Length of ie buffer in octets
4125 : */
4126 : size_t ie_len;
4127 :
4128 : /**
4129 : * locally_generated - Whether the frame was locally generated
4130 : */
4131 : int locally_generated;
4132 : } disassoc_info;
4133 :
4134 : /**
4135 : * struct deauth_info - Data for EVENT_DEAUTH events
4136 : */
4137 : struct deauth_info {
4138 : /**
4139 : * addr - Station address (for AP mode)
4140 : */
4141 : const u8 *addr;
4142 :
4143 : /**
4144 : * reason_code - Reason Code (host byte order) used in
4145 : * Deauthentication frame
4146 : */
4147 : u16 reason_code;
4148 :
4149 : /**
4150 : * ie - Optional IE(s) in Deauthentication frame
4151 : */
4152 : const u8 *ie;
4153 :
4154 : /**
4155 : * ie_len - Length of ie buffer in octets
4156 : */
4157 : size_t ie_len;
4158 :
4159 : /**
4160 : * locally_generated - Whether the frame was locally generated
4161 : */
4162 : int locally_generated;
4163 : } deauth_info;
4164 :
4165 : /**
4166 : * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4167 : */
4168 : struct michael_mic_failure {
4169 : int unicast;
4170 : const u8 *src;
4171 : } michael_mic_failure;
4172 :
4173 : /**
4174 : * struct interface_status - Data for EVENT_INTERFACE_STATUS
4175 : */
4176 : struct interface_status {
4177 : char ifname[100];
4178 : enum {
4179 : EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4180 : } ievent;
4181 : } interface_status;
4182 :
4183 : /**
4184 : * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4185 : */
4186 : struct pmkid_candidate {
4187 : /** BSSID of the PMKID candidate */
4188 : u8 bssid[ETH_ALEN];
4189 : /** Smaller the index, higher the priority */
4190 : int index;
4191 : /** Whether RSN IE includes pre-authenticate flag */
4192 : int preauth;
4193 : } pmkid_candidate;
4194 :
4195 : /**
4196 : * struct stkstart - Data for EVENT_STKSTART
4197 : */
4198 : struct stkstart {
4199 : u8 peer[ETH_ALEN];
4200 : } stkstart;
4201 :
4202 : /**
4203 : * struct tdls - Data for EVENT_TDLS
4204 : */
4205 : struct tdls {
4206 : u8 peer[ETH_ALEN];
4207 : enum {
4208 : TDLS_REQUEST_SETUP,
4209 : TDLS_REQUEST_TEARDOWN,
4210 : TDLS_REQUEST_DISCOVER,
4211 : } oper;
4212 : u16 reason_code; /* for teardown */
4213 : } tdls;
4214 :
4215 : /**
4216 : * struct wnm - Data for EVENT_WNM
4217 : */
4218 : struct wnm {
4219 : u8 addr[ETH_ALEN];
4220 : enum {
4221 : WNM_OPER_SLEEP,
4222 : } oper;
4223 : enum {
4224 : WNM_SLEEP_ENTER,
4225 : WNM_SLEEP_EXIT
4226 : } sleep_action;
4227 : int sleep_intval;
4228 : u16 reason_code;
4229 : u8 *buf;
4230 : u16 buf_len;
4231 : } wnm;
4232 :
4233 : /**
4234 : * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4235 : *
4236 : * During FT (IEEE 802.11r) authentication sequence, the driver is
4237 : * expected to use this event to report received FT IEs (MDIE, FTIE,
4238 : * RSN IE, TIE, possible resource request) to the supplicant. The FT
4239 : * IEs for the next message will be delivered through the
4240 : * struct wpa_driver_ops::update_ft_ies() callback.
4241 : */
4242 : struct ft_ies {
4243 : const u8 *ies;
4244 : size_t ies_len;
4245 : int ft_action;
4246 : u8 target_ap[ETH_ALEN];
4247 : /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4248 : const u8 *ric_ies;
4249 : /** Length of ric_ies buffer in octets */
4250 : size_t ric_ies_len;
4251 : } ft_ies;
4252 :
4253 : /**
4254 : * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4255 : */
4256 : struct ibss_rsn_start {
4257 : u8 peer[ETH_ALEN];
4258 : } ibss_rsn_start;
4259 :
4260 : /**
4261 : * struct auth_info - Data for EVENT_AUTH events
4262 : */
4263 : struct auth_info {
4264 : u8 peer[ETH_ALEN];
4265 : u8 bssid[ETH_ALEN];
4266 : u16 auth_type;
4267 : u16 auth_transaction;
4268 : u16 status_code;
4269 : const u8 *ies;
4270 : size_t ies_len;
4271 : } auth;
4272 :
4273 : /**
4274 : * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4275 : */
4276 : struct assoc_reject {
4277 : /**
4278 : * bssid - BSSID of the AP that rejected association
4279 : */
4280 : const u8 *bssid;
4281 :
4282 : /**
4283 : * resp_ies - (Re)Association Response IEs
4284 : *
4285 : * Optional association data from the driver. This data is not
4286 : * required WPA, but may be useful for some protocols and as
4287 : * such, should be reported if this is available to the driver
4288 : * interface.
4289 : *
4290 : * This should start with the first IE (fixed fields before IEs
4291 : * are not included).
4292 : */
4293 : const u8 *resp_ies;
4294 :
4295 : /**
4296 : * resp_ies_len - Length of resp_ies in bytes
4297 : */
4298 : size_t resp_ies_len;
4299 :
4300 : /**
4301 : * status_code - Status Code from (Re)association Response
4302 : */
4303 : u16 status_code;
4304 : } assoc_reject;
4305 :
4306 : struct timeout_event {
4307 : u8 addr[ETH_ALEN];
4308 : } timeout_event;
4309 :
4310 : /**
4311 : * struct tx_status - Data for EVENT_TX_STATUS events
4312 : */
4313 : struct tx_status {
4314 : u16 type;
4315 : u16 stype;
4316 : const u8 *dst;
4317 : const u8 *data;
4318 : size_t data_len;
4319 : int ack;
4320 : } tx_status;
4321 :
4322 : /**
4323 : * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4324 : */
4325 : struct rx_from_unknown {
4326 : const u8 *bssid;
4327 : const u8 *addr;
4328 : int wds;
4329 : } rx_from_unknown;
4330 :
4331 : /**
4332 : * struct rx_mgmt - Data for EVENT_RX_MGMT events
4333 : */
4334 : struct rx_mgmt {
4335 : const u8 *frame;
4336 : size_t frame_len;
4337 : u32 datarate;
4338 :
4339 : /**
4340 : * drv_priv - Pointer to store driver private BSS information
4341 : *
4342 : * If not set to NULL, this is used for comparison with
4343 : * hostapd_data->drv_priv to determine which BSS should process
4344 : * the frame.
4345 : */
4346 : void *drv_priv;
4347 :
4348 : /**
4349 : * freq - Frequency (in MHz) on which the frame was received
4350 : */
4351 : int freq;
4352 :
4353 : /**
4354 : * ssi_signal - Signal strength in dBm (or 0 if not available)
4355 : */
4356 : int ssi_signal;
4357 : } rx_mgmt;
4358 :
4359 : /**
4360 : * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4361 : *
4362 : * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4363 : */
4364 : struct remain_on_channel {
4365 : /**
4366 : * freq - Channel frequency in MHz
4367 : */
4368 : unsigned int freq;
4369 :
4370 : /**
4371 : * duration - Duration to remain on the channel in milliseconds
4372 : */
4373 : unsigned int duration;
4374 : } remain_on_channel;
4375 :
4376 : /**
4377 : * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4378 : * @aborted: Whether the scan was aborted
4379 : * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4380 : * @num_freqs: Number of entries in freqs array
4381 : * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4382 : * SSID)
4383 : * @num_ssids: Number of entries in ssids array
4384 : */
4385 : struct scan_info {
4386 : int aborted;
4387 : const int *freqs;
4388 : size_t num_freqs;
4389 : struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4390 : size_t num_ssids;
4391 : } scan_info;
4392 :
4393 : /**
4394 : * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4395 : */
4396 : struct rx_probe_req {
4397 : /**
4398 : * sa - Source address of the received Probe Request frame
4399 : */
4400 : const u8 *sa;
4401 :
4402 : /**
4403 : * da - Destination address of the received Probe Request frame
4404 : * or %NULL if not available
4405 : */
4406 : const u8 *da;
4407 :
4408 : /**
4409 : * bssid - BSSID of the received Probe Request frame or %NULL
4410 : * if not available
4411 : */
4412 : const u8 *bssid;
4413 :
4414 : /**
4415 : * ie - IEs from the Probe Request body
4416 : */
4417 : const u8 *ie;
4418 :
4419 : /**
4420 : * ie_len - Length of ie buffer in octets
4421 : */
4422 : size_t ie_len;
4423 :
4424 : /**
4425 : * signal - signal strength in dBm (or 0 if not available)
4426 : */
4427 : int ssi_signal;
4428 : } rx_probe_req;
4429 :
4430 : /**
4431 : * struct new_sta - Data for EVENT_NEW_STA events
4432 : */
4433 : struct new_sta {
4434 : const u8 *addr;
4435 : } new_sta;
4436 :
4437 : /**
4438 : * struct eapol_rx - Data for EVENT_EAPOL_RX events
4439 : */
4440 : struct eapol_rx {
4441 : const u8 *src;
4442 : const u8 *data;
4443 : size_t data_len;
4444 : } eapol_rx;
4445 :
4446 : /**
4447 : * signal_change - Data for EVENT_SIGNAL_CHANGE events
4448 : */
4449 : struct wpa_signal_info signal_change;
4450 :
4451 : /**
4452 : * struct best_channel - Data for EVENT_BEST_CHANNEL events
4453 : * @freq_24: Best 2.4 GHz band channel frequency in MHz
4454 : * @freq_5: Best 5 GHz band channel frequency in MHz
4455 : * @freq_overall: Best channel frequency in MHz
4456 : *
4457 : * 0 can be used to indicate no preference in either band.
4458 : */
4459 : struct best_channel {
4460 : int freq_24;
4461 : int freq_5;
4462 : int freq_overall;
4463 : } best_chan;
4464 :
4465 : struct unprot_deauth {
4466 : const u8 *sa;
4467 : const u8 *da;
4468 : u16 reason_code;
4469 : } unprot_deauth;
4470 :
4471 : struct unprot_disassoc {
4472 : const u8 *sa;
4473 : const u8 *da;
4474 : u16 reason_code;
4475 : } unprot_disassoc;
4476 :
4477 : /**
4478 : * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4479 : * @addr: station address
4480 : */
4481 : struct low_ack {
4482 : u8 addr[ETH_ALEN];
4483 : } low_ack;
4484 :
4485 : /**
4486 : * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4487 : */
4488 : struct ibss_peer_lost {
4489 : u8 peer[ETH_ALEN];
4490 : } ibss_peer_lost;
4491 :
4492 : /**
4493 : * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4494 : */
4495 : struct driver_gtk_rekey {
4496 : const u8 *bssid;
4497 : const u8 *replay_ctr;
4498 : } driver_gtk_rekey;
4499 :
4500 : /**
4501 : * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4502 : * @addr: station address
4503 : */
4504 : struct client_poll {
4505 : u8 addr[ETH_ALEN];
4506 : } client_poll;
4507 :
4508 : /**
4509 : * struct eapol_tx_status
4510 : * @dst: Original destination
4511 : * @data: Data starting with IEEE 802.1X header (!)
4512 : * @data_len: Length of data
4513 : * @ack: Indicates ack or lost frame
4514 : *
4515 : * This corresponds to hapd_send_eapol if the frame sent
4516 : * there isn't just reported as EVENT_TX_STATUS.
4517 : */
4518 : struct eapol_tx_status {
4519 : const u8 *dst;
4520 : const u8 *data;
4521 : int data_len;
4522 : int ack;
4523 : } eapol_tx_status;
4524 :
4525 : /**
4526 : * struct ch_switch
4527 : * @freq: Frequency of new channel in MHz
4528 : * @ht_enabled: Whether this is an HT channel
4529 : * @ch_offset: Secondary channel offset
4530 : * @ch_width: Channel width
4531 : * @cf1: Center frequency 1
4532 : * @cf2: Center frequency 2
4533 : */
4534 : struct ch_switch {
4535 : int freq;
4536 : int ht_enabled;
4537 : int ch_offset;
4538 : enum chan_width ch_width;
4539 : int cf1;
4540 : int cf2;
4541 : } ch_switch;
4542 :
4543 : /**
4544 : * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4545 : * @addr: Remote client address
4546 : * @code: Reason code for connection failure
4547 : */
4548 : struct connect_failed_reason {
4549 : u8 addr[ETH_ALEN];
4550 : enum {
4551 : MAX_CLIENT_REACHED,
4552 : BLOCKED_CLIENT
4553 : } code;
4554 : } connect_failed_reason;
4555 :
4556 : /**
4557 : * struct dfs_event - Data for radar detected events
4558 : * @freq: Frequency of the channel in MHz
4559 : */
4560 : struct dfs_event {
4561 : int freq;
4562 : int ht_enabled;
4563 : int chan_offset;
4564 : enum chan_width chan_width;
4565 : int cf1;
4566 : int cf2;
4567 : } dfs_event;
4568 :
4569 : /**
4570 : * survey_results - Survey result data for EVENT_SURVEY
4571 : * @freq_filter: Requested frequency survey filter, 0 if request
4572 : * was for all survey data
4573 : * @survey_list: Linked list of survey data (struct freq_survey)
4574 : */
4575 : struct survey_results {
4576 : unsigned int freq_filter;
4577 : struct dl_list survey_list; /* struct freq_survey */
4578 : } survey_results;
4579 :
4580 : /**
4581 : * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4582 : * @initiator: Initiator of the regulatory change
4583 : * @type: Regulatory change type
4584 : * @alpha2: Country code (or "" if not available)
4585 : */
4586 : struct channel_list_changed {
4587 : enum reg_change_initiator initiator;
4588 : enum reg_type type;
4589 : char alpha2[3];
4590 : } channel_list_changed;
4591 :
4592 : /**
4593 : * freq_range - List of frequency ranges
4594 : *
4595 : * This is used as the data with EVENT_AVOID_FREQUENCIES.
4596 : */
4597 : struct wpa_freq_range_list freq_range;
4598 :
4599 : /**
4600 : * struct mesh_peer
4601 : *
4602 : * @peer: Peer address
4603 : * @ies: Beacon IEs
4604 : * @ie_len: Length of @ies
4605 : *
4606 : * Notification of new candidate mesh peer.
4607 : */
4608 : struct mesh_peer {
4609 : const u8 *peer;
4610 : const u8 *ies;
4611 : size_t ie_len;
4612 : } mesh_peer;
4613 :
4614 : /**
4615 : * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4616 : * @pri_channel: Selected primary channel
4617 : * @sec_channel: Selected secondary channel
4618 : * @vht_seg0_center_ch: VHT mode Segment0 center channel
4619 : * @vht_seg1_center_ch: VHT mode Segment1 center channel
4620 : * @ch_width: Selected Channel width by driver. Driver may choose to
4621 : * change hostapd configured ACS channel width due driver internal
4622 : * channel restrictions.
4623 : * hw_mode: Selected band (used with hw_mode=any)
4624 : */
4625 : struct acs_selected_channels {
4626 : u8 pri_channel;
4627 : u8 sec_channel;
4628 : u8 vht_seg0_center_ch;
4629 : u8 vht_seg1_center_ch;
4630 : u16 ch_width;
4631 : enum hostapd_hw_mode hw_mode;
4632 : } acs_selected_channels;
4633 : };
4634 :
4635 : /**
4636 : * wpa_supplicant_event - Report a driver event for wpa_supplicant
4637 : * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4638 : * with struct wpa_driver_ops::init()
4639 : * @event: event type (defined above)
4640 : * @data: possible extra data for the event
4641 : *
4642 : * Driver wrapper code should call this function whenever an event is received
4643 : * from the driver.
4644 : */
4645 : void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4646 : union wpa_event_data *data);
4647 :
4648 :
4649 : /*
4650 : * The following inline functions are provided for convenience to simplify
4651 : * event indication for some of the common events.
4652 : */
4653 :
4654 0 : static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4655 : size_t ielen, int reassoc)
4656 : {
4657 : union wpa_event_data event;
4658 0 : os_memset(&event, 0, sizeof(event));
4659 0 : event.assoc_info.reassoc = reassoc;
4660 0 : event.assoc_info.req_ies = ie;
4661 0 : event.assoc_info.req_ies_len = ielen;
4662 0 : event.assoc_info.addr = addr;
4663 0 : wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4664 0 : }
4665 :
4666 0 : static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4667 : {
4668 : union wpa_event_data event;
4669 0 : os_memset(&event, 0, sizeof(event));
4670 0 : event.disassoc_info.addr = addr;
4671 0 : wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4672 0 : }
4673 :
4674 8105 : static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4675 : size_t data_len)
4676 : {
4677 : union wpa_event_data event;
4678 8105 : os_memset(&event, 0, sizeof(event));
4679 8105 : event.eapol_rx.src = src;
4680 8105 : event.eapol_rx.data = data;
4681 8105 : event.eapol_rx.data_len = data_len;
4682 8105 : wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4683 8105 : }
4684 :
4685 : /* driver_common.c */
4686 : void wpa_scan_results_free(struct wpa_scan_results *res);
4687 :
4688 : /* Convert wpa_event_type to a string for logging */
4689 : const char * event_to_string(enum wpa_event_type event);
4690 :
4691 : /* Convert chan_width to a string for logging and control interfaces */
4692 : const char * channel_width_to_string(enum chan_width width);
4693 :
4694 : int ht_supported(const struct hostapd_hw_modes *mode);
4695 : int vht_supported(const struct hostapd_hw_modes *mode);
4696 :
4697 : struct wowlan_triggers *
4698 : wpa_get_wowlan_triggers(const char *wowlan_triggers,
4699 : const struct wpa_driver_capa *capa);
4700 :
4701 : /* NULL terminated array of linked in driver wrappers */
4702 : extern const struct wpa_driver_ops *const wpa_drivers[];
4703 :
4704 : #endif /* DRIVER_H */
|
