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