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