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