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