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