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