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