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