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