1/* 2 * Driver interface definition 3 * Copyright (c) 2003-2017, 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 "common/ieee802_11_defs.h" 24#include "common/wpa_common.h" 25#ifdef CONFIG_MACSEC 26#include "pae/ieee802_1x_kay.h" 27#endif /* CONFIG_MACSEC */ 28#include "utils/list.h" 29 30#define HOSTAPD_CHAN_DISABLED 0x00000001 31#define HOSTAPD_CHAN_NO_IR 0x00000002 32#define HOSTAPD_CHAN_RADAR 0x00000008 33#define HOSTAPD_CHAN_HT40PLUS 0x00000010 34#define HOSTAPD_CHAN_HT40MINUS 0x00000020 35#define HOSTAPD_CHAN_HT40 0x00000040 36#define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080 37 38#define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000 39#define HOSTAPD_CHAN_DFS_USABLE 0x00000100 40#define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200 41#define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300 42#define HOSTAPD_CHAN_DFS_MASK 0x00000300 43 44#define HOSTAPD_CHAN_VHT_10_70 0x00000800 45#define HOSTAPD_CHAN_VHT_30_50 0x00001000 46#define HOSTAPD_CHAN_VHT_50_30 0x00002000 47#define HOSTAPD_CHAN_VHT_70_10 0x00004000 48 49#define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000 50#define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000 51 52#define HOSTAPD_CHAN_VHT_10_150 0x00100000 53#define HOSTAPD_CHAN_VHT_30_130 0x00200000 54#define HOSTAPD_CHAN_VHT_50_110 0x00400000 55#define HOSTAPD_CHAN_VHT_70_90 0x00800000 56#define HOSTAPD_CHAN_VHT_90_70 0x01000000 57#define HOSTAPD_CHAN_VHT_110_50 0x02000000 58#define HOSTAPD_CHAN_VHT_130_30 0x04000000 59#define HOSTAPD_CHAN_VHT_150_10 0x08000000 60 61/* Allowed bandwidth mask */ 62enum hostapd_chan_width_attr { 63 HOSTAPD_CHAN_WIDTH_10 = BIT(0), 64 HOSTAPD_CHAN_WIDTH_20 = BIT(1), 65 HOSTAPD_CHAN_WIDTH_40P = BIT(2), 66 HOSTAPD_CHAN_WIDTH_40M = BIT(3), 67 HOSTAPD_CHAN_WIDTH_80 = BIT(4), 68 HOSTAPD_CHAN_WIDTH_160 = BIT(5), 69}; 70 71/* Filter gratuitous ARP */ 72#define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0) 73/* Filter unsolicited Neighbor Advertisement */ 74#define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1) 75/* Filter unicast IP packets encrypted using the GTK */ 76#define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2) 77 78#define HOSTAPD_DFS_REGION_FCC 1 79#define HOSTAPD_DFS_REGION_ETSI 2 80#define HOSTAPD_DFS_REGION_JP 3 81 82/** 83 * enum reg_change_initiator - Regulatory change initiator 84 */ 85enum reg_change_initiator { 86 REGDOM_SET_BY_CORE, 87 REGDOM_SET_BY_USER, 88 REGDOM_SET_BY_DRIVER, 89 REGDOM_SET_BY_COUNTRY_IE, 90 REGDOM_BEACON_HINT, 91}; 92 93/** 94 * enum reg_type - Regulatory change types 95 */ 96enum reg_type { 97 REGDOM_TYPE_UNKNOWN, 98 REGDOM_TYPE_COUNTRY, 99 REGDOM_TYPE_WORLD, 100 REGDOM_TYPE_CUSTOM_WORLD, 101 REGDOM_TYPE_INTERSECTION, 102}; 103 104/** 105 * struct hostapd_wmm_rule - WMM regulatory rule 106 * @min_cwmin: Lower bound of CW_min value 107 * @min_cwmax: Lower bound of CW_max value 108 * @min_aifs: Lower bound of AIFS value 109 * @max_txop: Upper bound of TXOP, value in units of 32 usec 110 */ 111struct hostapd_wmm_rule { 112 int min_cwmin; 113 int min_cwmax; 114 int min_aifs; 115 int max_txop; 116}; 117 118/** 119 * struct hostapd_channel_data - Channel information 120 */ 121struct hostapd_channel_data { 122 /** 123 * chan - Channel number (IEEE 802.11) 124 */ 125 short chan; 126 127 /** 128 * freq - Frequency in MHz 129 */ 130 int freq; 131 132 /** 133 * flag - Channel flags (HOSTAPD_CHAN_*) 134 */ 135 int flag; 136 137 /** 138 * allowed_bw - Allowed channel width bitmask 139 * 140 * See enum hostapd_chan_width_attr. 141 */ 142 u32 allowed_bw; 143 144 /** 145 * max_tx_power - Regulatory transmit power limit in dBm 146 */ 147 u8 max_tx_power; 148 149 /** 150 * survey_list - Linked list of surveys (struct freq_survey) 151 */ 152 struct dl_list survey_list; 153 154 /** 155 * min_nf - Minimum observed noise floor, in dBm, based on all 156 * surveyed channel data 157 */ 158 s8 min_nf; 159 160#ifdef CONFIG_ACS 161 /** 162 * interference_factor - Computed interference factor on this 163 * channel (used internally in src/ap/acs.c; driver wrappers do not 164 * need to set this) 165 */ 166 long double interference_factor; 167#endif /* CONFIG_ACS */ 168 169 /** 170 * dfs_cac_ms - DFS CAC time in milliseconds 171 */ 172 unsigned int dfs_cac_ms; 173 174 /** 175 * wmm_rules_valid - Indicates wmm_rules state 176 */ 177 int wmm_rules_valid; 178 179 /** 180 * wmm_rules - WMM regulatory rules 181 */ 182 struct hostapd_wmm_rule wmm_rules[WMM_AC_NUM]; 183}; 184 185#define HE_MAX_MAC_CAPAB_SIZE 6 186#define HE_MAX_PHY_CAPAB_SIZE 11 187#define HE_MAX_MCS_CAPAB_SIZE 12 188#define HE_MAX_PPET_CAPAB_SIZE 25 189 190/** 191 * struct he_capabilities - IEEE 802.11ax HE capabilities 192 */ 193struct he_capabilities { 194 u8 he_supported; 195 u8 phy_cap[HE_MAX_PHY_CAPAB_SIZE]; 196 u8 mac_cap[HE_MAX_MAC_CAPAB_SIZE]; 197 u8 mcs[HE_MAX_MCS_CAPAB_SIZE]; 198 u8 ppet[HE_MAX_PPET_CAPAB_SIZE]; 199}; 200 201#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0) 202#define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1) 203 204 205enum ieee80211_op_mode { 206 IEEE80211_MODE_INFRA = 0, 207 IEEE80211_MODE_IBSS = 1, 208 IEEE80211_MODE_AP = 2, 209 IEEE80211_MODE_MESH = 5, 210 211 /* only add new entries before IEEE80211_MODE_NUM */ 212 IEEE80211_MODE_NUM 213}; 214 215/** 216 * struct hostapd_hw_modes - Supported hardware mode information 217 */ 218struct hostapd_hw_modes { 219 /** 220 * mode - Hardware mode 221 */ 222 enum hostapd_hw_mode mode; 223 224 /** 225 * num_channels - Number of entries in the channels array 226 */ 227 int num_channels; 228 229 /** 230 * channels - Array of supported channels 231 */ 232 struct hostapd_channel_data *channels; 233 234 /** 235 * num_rates - Number of entries in the rates array 236 */ 237 int num_rates; 238 239 /** 240 * rates - Array of supported rates in 100 kbps units 241 */ 242 int *rates; 243 244 /** 245 * ht_capab - HT (IEEE 802.11n) capabilities 246 */ 247 u16 ht_capab; 248 249 /** 250 * mcs_set - MCS (IEEE 802.11n) rate parameters 251 */ 252 u8 mcs_set[16]; 253 254 /** 255 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters 256 */ 257 u8 a_mpdu_params; 258 259 /** 260 * vht_capab - VHT (IEEE 802.11ac) capabilities 261 */ 262 u32 vht_capab; 263 264 /** 265 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters 266 */ 267 u8 vht_mcs_set[8]; 268 269 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */ 270 271 /** 272 * he_capab - HE (IEEE 802.11ax) capabilities 273 */ 274 struct he_capabilities he_capab[IEEE80211_MODE_NUM]; 275}; 276 277 278#define IEEE80211_CAP_ESS 0x0001 279#define IEEE80211_CAP_IBSS 0x0002 280#define IEEE80211_CAP_PRIVACY 0x0010 281#define IEEE80211_CAP_RRM 0x1000 282 283/* DMG (60 GHz) IEEE 802.11ad */ 284/* type - bits 0..1 */ 285#define IEEE80211_CAP_DMG_MASK 0x0003 286#define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */ 287#define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */ 288#define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */ 289 290#define WPA_SCAN_QUAL_INVALID BIT(0) 291#define WPA_SCAN_NOISE_INVALID BIT(1) 292#define WPA_SCAN_LEVEL_INVALID BIT(2) 293#define WPA_SCAN_LEVEL_DBM BIT(3) 294#define WPA_SCAN_ASSOCIATED BIT(5) 295 296/** 297 * struct wpa_scan_res - Scan result for an BSS/IBSS 298 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*) 299 * @bssid: BSSID 300 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1) 301 * @beacon_int: beacon interval in TUs (host byte order) 302 * @caps: capability information field in host byte order 303 * @qual: signal quality 304 * @noise: noise level 305 * @level: signal level 306 * @tsf: Timestamp 307 * @age: Age of the information in milliseconds (i.e., how many milliseconds 308 * ago the last Beacon or Probe Response frame was received) 309 * @est_throughput: Estimated throughput in kbps (this is calculated during 310 * scan result processing if left zero by the driver wrapper) 311 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing) 312 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms 313 * of TSF of the BSS specified by %tsf_bssid. 314 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to. 315 * @ie_len: length of the following IE field in octets 316 * @beacon_ie_len: length of the following Beacon IE field in octets 317 * 318 * This structure is used as a generic format for scan results from the 319 * driver. Each driver interface implementation is responsible for converting 320 * the driver or OS specific scan results into this format. 321 * 322 * If the driver does not support reporting all IEs, the IE data structure is 323 * constructed of the IEs that are available. This field will also need to 324 * include SSID in IE format. All drivers are encouraged to be extended to 325 * report all IEs to make it easier to support future additions. 326 * 327 * This structure data is followed by ie_len octets of IEs from Probe Response 328 * frame (or if the driver does not indicate source of IEs, these may also be 329 * from Beacon frame). After the first set of IEs, another set of IEs may follow 330 * (with beacon_ie_len octets of data) if the driver provides both IE sets. 331 */ 332struct wpa_scan_res { 333 unsigned int flags; 334 u8 bssid[ETH_ALEN]; 335 int freq; 336 u16 beacon_int; 337 u16 caps; 338 int qual; 339 int noise; 340 int level; 341 u64 tsf; 342 unsigned int age; 343 unsigned int est_throughput; 344 int snr; 345 u64 parent_tsf; 346 u8 tsf_bssid[ETH_ALEN]; 347 size_t ie_len; 348 size_t beacon_ie_len; 349 /* Followed by ie_len + beacon_ie_len octets of IE data */ 350}; 351 352/** 353 * struct wpa_scan_results - Scan results 354 * @res: Array of pointers to allocated variable length scan result entries 355 * @num: Number of entries in the scan result array 356 * @fetch_time: Time when the results were fetched from the driver 357 */ 358struct wpa_scan_results { 359 struct wpa_scan_res **res; 360 size_t num; 361 struct os_reltime fetch_time; 362}; 363 364/** 365 * struct wpa_interface_info - Network interface information 366 * @next: Pointer to the next interface or NULL if this is the last one 367 * @ifname: Interface name that can be used with init() or init2() 368 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if 369 * not available 370 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one 371 * is not an allocated copy, i.e., get_interfaces() caller will not free 372 * this) 373 */ 374struct wpa_interface_info { 375 struct wpa_interface_info *next; 376 char *ifname; 377 char *desc; 378 const char *drv_name; 379}; 380 381#define WPAS_MAX_SCAN_SSIDS 16 382 383/** 384 * struct wpa_driver_scan_ssid - SSIDs to scan for 385 * @ssid - specific SSID to scan for (ProbeReq) 386 * %NULL or zero-length SSID is used to indicate active scan 387 * with wildcard SSID. 388 * @ssid_len - Length of the SSID in octets 389 */ 390struct wpa_driver_scan_ssid { 391 const u8 *ssid; 392 size_t ssid_len; 393}; 394 395/** 396 * struct wpa_driver_scan_params - Scan parameters 397 * Data for struct wpa_driver_ops::scan2(). 398 */ 399struct wpa_driver_scan_params { 400 /** 401 * ssids - SSIDs to scan for 402 */ 403 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS]; 404 405 /** 406 * num_ssids - Number of entries in ssids array 407 * Zero indicates a request for a passive scan. 408 */ 409 size_t num_ssids; 410 411 /** 412 * extra_ies - Extra IE(s) to add into Probe Request or %NULL 413 */ 414 const u8 *extra_ies; 415 416 /** 417 * extra_ies_len - Length of extra_ies in octets 418 */ 419 size_t extra_ies_len; 420 421 /** 422 * freqs - Array of frequencies to scan or %NULL for all frequencies 423 * 424 * The frequency is set in MHz. The array is zero-terminated. 425 */ 426 int *freqs; 427 428 /** 429 * filter_ssids - Filter for reporting SSIDs 430 * 431 * This optional parameter can be used to request the driver wrapper to 432 * filter scan results to include only the specified SSIDs. %NULL 433 * indicates that no filtering is to be done. This can be used to 434 * reduce memory needs for scan results in environments that have large 435 * number of APs with different SSIDs. 436 * 437 * The driver wrapper is allowed to take this allocated buffer into its 438 * own use by setting the pointer to %NULL. In that case, the driver 439 * wrapper is responsible for freeing the buffer with os_free() once it 440 * is not needed anymore. 441 */ 442 struct wpa_driver_scan_filter { 443 u8 ssid[SSID_MAX_LEN]; 444 size_t ssid_len; 445 } *filter_ssids; 446 447 /** 448 * num_filter_ssids - Number of entries in filter_ssids array 449 */ 450 size_t num_filter_ssids; 451 452 /** 453 * filter_rssi - Filter by RSSI 454 * 455 * The driver may filter scan results in firmware to reduce host 456 * wakeups and thereby save power. Specify the RSSI threshold in s32 457 * dBm. 458 */ 459 s32 filter_rssi; 460 461 /** 462 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes 463 * 464 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11 465 * Mbps from the support rates element(s) in the Probe Request frames 466 * and not to transmit the frames at any of those rates. 467 */ 468 unsigned int p2p_probe:1; 469 470 /** 471 * only_new_results - Request driver to report only new results 472 * 473 * This is used to request the driver to report only BSSes that have 474 * been detected after this scan request has been started, i.e., to 475 * flush old cached BSS entries. 476 */ 477 unsigned int only_new_results:1; 478 479 /** 480 * low_priority - Requests driver to use a lower scan priority 481 * 482 * This is used to request the driver to use a lower scan priority 483 * if it supports such a thing. 484 */ 485 unsigned int low_priority:1; 486 487 /** 488 * mac_addr_rand - Requests driver to randomize MAC address 489 */ 490 unsigned int mac_addr_rand:1; 491 492 /** 493 * mac_addr - MAC address used with randomization. The address cannot be 494 * a multicast one, i.e., bit 0 of byte 0 should not be set. 495 */ 496 const u8 *mac_addr; 497 498 /** 499 * mac_addr_mask - MAC address mask used with randomization. 500 * 501 * Bits that are 0 in the mask should be randomized. Bits that are 1 in 502 * the mask should be taken as is from mac_addr. The mask should not 503 * allow the generation of a multicast address, i.e., bit 0 of byte 0 504 * must be set. 505 */ 506 const u8 *mac_addr_mask; 507 508 /** 509 * sched_scan_plans - Scan plans for scheduled scan 510 * 511 * Each scan plan consists of the number of iterations to scan and the 512 * interval between scans. When a scan plan finishes (i.e., it was run 513 * for the specified number of iterations), the next scan plan is 514 * executed. The scan plans are executed in the order they appear in 515 * the array (lower index first). The last scan plan will run infinitely 516 * (until requested to stop), thus must not specify the number of 517 * iterations. All other scan plans must specify the number of 518 * iterations. 519 */ 520 struct sched_scan_plan { 521 u32 interval; /* In seconds */ 522 u32 iterations; /* Zero to run infinitely */ 523 } *sched_scan_plans; 524 525 /** 526 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array 527 */ 528 unsigned int sched_scan_plans_num; 529 530 /** 531 * sched_scan_start_delay - Delay to use before starting the first scan 532 * 533 * Delay (in seconds) before scheduling first scan plan cycle. The 534 * driver may ignore this parameter and start immediately (or at any 535 * other time), if this feature is not supported. 536 */ 537 u32 sched_scan_start_delay; 538 539 /** 540 * bssid - Specific BSSID to scan for 541 * 542 * This optional parameter can be used to replace the default wildcard 543 * BSSID with a specific BSSID to scan for if results are needed from 544 * only a single BSS. 545 */ 546 const u8 *bssid; 547 548 /** 549 * scan_cookie - Unique identification representing the scan request 550 * 551 * This scan_cookie carries a unique identification representing the 552 * scan request if the host driver/kernel supports concurrent scan 553 * requests. This cookie is returned from the corresponding driver 554 * interface. 555 * 556 * Note: Unlike other parameters in this structure, scan_cookie is used 557 * only to return information instead of setting parameters for the 558 * scan. 559 */ 560 u64 scan_cookie; 561 562 /** 563 * duration - Dwell time on each channel 564 * 565 * This optional parameter can be used to set the dwell time on each 566 * channel. In TUs. 567 */ 568 u16 duration; 569 570 /** 571 * duration_mandatory - Whether the specified duration is mandatory 572 * 573 * If this is set, the duration specified by the %duration field is 574 * mandatory (and the driver should reject the scan request if it is 575 * unable to comply with the specified duration), otherwise it is the 576 * maximum duration and the actual duration may be shorter. 577 */ 578 unsigned int duration_mandatory:1; 579 580 /** 581 * relative_rssi_set - Whether relative RSSI parameters are set 582 */ 583 unsigned int relative_rssi_set:1; 584 585 /** 586 * relative_rssi - Relative RSSI for reporting better BSSs 587 * 588 * Amount of RSSI by which a BSS should be better than the current 589 * connected BSS to report the new BSS to user space. 590 */ 591 s8 relative_rssi; 592 593 /** 594 * relative_adjust_band - Band to which RSSI should be adjusted 595 * 596 * The relative_adjust_rssi should be added to the band specified 597 * by relative_adjust_band. 598 */ 599 enum set_band relative_adjust_band; 600 601 /** 602 * relative_adjust_rssi - RSSI to be added to relative_adjust_band 603 * 604 * An amount of relative_band_rssi should be added to the BSSs that 605 * belong to the band specified by relative_adjust_band while comparing 606 * with other bands for BSS reporting. 607 */ 608 s8 relative_adjust_rssi; 609 610 /** 611 * oce_scan 612 * 613 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0) 614 * - Accept broadcast Probe Response frame. 615 * - Probe Request frame deferral and suppression. 616 * - Max Channel Time - driver fills FILS request params IE with 617 * Maximum Channel Time. 618 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps. 619 */ 620 unsigned int oce_scan:1; 621 622 /* 623 * NOTE: Whenever adding new parameters here, please make sure 624 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with 625 * matching changes. 626 */ 627}; 628 629/** 630 * struct wpa_driver_auth_params - Authentication parameters 631 * Data for struct wpa_driver_ops::authenticate(). 632 */ 633struct wpa_driver_auth_params { 634 int freq; 635 const u8 *bssid; 636 const u8 *ssid; 637 size_t ssid_len; 638 int auth_alg; 639 const u8 *ie; 640 size_t ie_len; 641 const u8 *wep_key[4]; 642 size_t wep_key_len[4]; 643 int wep_tx_keyidx; 644 int local_state_change; 645 646 /** 647 * p2p - Whether this connection is a P2P group 648 */ 649 int p2p; 650 651 /** 652 * auth_data - Additional elements for Authentication frame 653 * 654 * This buffer starts with the Authentication transaction sequence 655 * number field. If no special handling of such elements is needed, this 656 * pointer is %NULL. This is used with SAE and FILS. 657 */ 658 const u8 *auth_data; 659 660 /** 661 * auth_data_len - Length of auth_data buffer in octets 662 */ 663 size_t auth_data_len; 664}; 665 666/** 667 * enum wps_mode - WPS mode 668 */ 669enum wps_mode { 670 /** 671 * WPS_MODE_NONE - No WPS provisioning being used 672 */ 673 WPS_MODE_NONE, 674 675 /** 676 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode 677 */ 678 WPS_MODE_OPEN, 679 680 /** 681 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection 682 */ 683 WPS_MODE_PRIVACY 684}; 685 686/** 687 * struct hostapd_freq_params - Channel parameters 688 */ 689struct hostapd_freq_params { 690 /** 691 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..) 692 */ 693 enum hostapd_hw_mode mode; 694 695 /** 696 * freq - Primary channel center frequency in MHz 697 */ 698 int freq; 699 700 /** 701 * channel - Channel number 702 */ 703 int channel; 704 705 /** 706 * ht_enabled - Whether HT is enabled 707 */ 708 int ht_enabled; 709 710 /** 711 * sec_channel_offset - Secondary channel offset for HT40 712 * 713 * 0 = HT40 disabled, 714 * -1 = HT40 enabled, secondary channel below primary, 715 * 1 = HT40 enabled, secondary channel above primary 716 */ 717 int sec_channel_offset; 718 719 /** 720 * vht_enabled - Whether VHT is enabled 721 */ 722 int vht_enabled; 723 724 /** 725 * he_enabled - Whether HE is enabled 726 */ 727 int he_enabled; 728 729 /** 730 * center_freq1 - Segment 0 center frequency in MHz 731 * 732 * Valid for both HT and VHT. 733 */ 734 int center_freq1; 735 736 /** 737 * center_freq2 - Segment 1 center frequency in MHz 738 * 739 * Non-zero only for bandwidth 80 and an 80+80 channel 740 */ 741 int center_freq2; 742 743 /** 744 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160) 745 */ 746 int bandwidth; 747}; 748 749/** 750 * struct wpa_driver_sta_auth_params - Authentication parameters 751 * Data for struct wpa_driver_ops::sta_auth(). 752 */ 753struct wpa_driver_sta_auth_params { 754 755 /** 756 * own_addr - Source address and BSSID for authentication frame 757 */ 758 const u8 *own_addr; 759 760 /** 761 * addr - MAC address of the station to associate 762 */ 763 const u8 *addr; 764 765 /** 766 * seq - authentication sequence number 767 */ 768 u16 seq; 769 770 /** 771 * status - authentication response status code 772 */ 773 u16 status; 774 775 /** 776 * ie - authentication frame ie buffer 777 */ 778 const u8 *ie; 779 780 /** 781 * len - ie buffer length 782 */ 783 size_t len; 784 785 /** 786 * fils_auth - Indicates whether FILS authentication is being performed 787 */ 788 int fils_auth; 789 790 /** 791 * fils_anonce - ANonce (required for FILS) 792 */ 793 u8 fils_anonce[WPA_NONCE_LEN]; 794 795 /** 796 * fils_snonce - SNonce (required for FILS) 797 */ 798 u8 fils_snonce[WPA_NONCE_LEN]; 799 800 /** 801 * fils_kek - key for encryption (required for FILS) 802 */ 803 u8 fils_kek[WPA_KEK_MAX_LEN]; 804 805 /** 806 * fils_kek_len - Length of the fils_kek in octets (required for FILS) 807 */ 808 size_t fils_kek_len; 809}; 810 811/** 812 * struct wpa_driver_associate_params - Association parameters 813 * Data for struct wpa_driver_ops::associate(). 814 */ 815struct wpa_driver_associate_params { 816 /** 817 * bssid - BSSID of the selected AP 818 * This can be %NULL, if ap_scan=2 mode is used and the driver is 819 * responsible for selecting with which BSS to associate. */ 820 const u8 *bssid; 821 822 /** 823 * bssid_hint - BSSID of a proposed AP 824 * 825 * This indicates which BSS has been found a suitable candidate for 826 * initial association for drivers that use driver/firmwate-based BSS 827 * selection. Unlike the @bssid parameter, @bssid_hint does not limit 828 * the driver from selecting other BSSes in the ESS. 829 */ 830 const u8 *bssid_hint; 831 832 /** 833 * ssid - The selected SSID 834 */ 835 const u8 *ssid; 836 837 /** 838 * ssid_len - Length of the SSID (1..32) 839 */ 840 size_t ssid_len; 841 842 /** 843 * freq - channel parameters 844 */ 845 struct hostapd_freq_params freq; 846 847 /** 848 * freq_hint - Frequency of the channel the proposed AP is using 849 * 850 * This provides a channel on which a suitable BSS has been found as a 851 * hint for the driver. Unlike the @freq parameter, @freq_hint does not 852 * limit the driver from selecting other channels for 853 * driver/firmware-based BSS selection. 854 */ 855 int freq_hint; 856 857 /** 858 * bg_scan_period - Background scan period in seconds, 0 to disable 859 * background scan, or -1 to indicate no change to default driver 860 * configuration 861 */ 862 int bg_scan_period; 863 864 /** 865 * beacon_int - Beacon interval for IBSS or 0 to use driver default 866 */ 867 int beacon_int; 868 869 /** 870 * wpa_ie - WPA information element for (Re)Association Request 871 * WPA information element to be included in (Re)Association 872 * Request (including information element id and length). Use 873 * of this WPA IE is optional. If the driver generates the WPA 874 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and 875 * key_mgmt_suite to select proper algorithms. In this case, 876 * the driver has to notify wpa_supplicant about the used WPA 877 * IE by generating an event that the interface code will 878 * convert into EVENT_ASSOCINFO data (see below). 879 * 880 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE 881 * instead. The driver can determine which version is used by 882 * looking at the first byte of the IE (0xdd for WPA, 0x30 for 883 * WPA2/RSN). 884 * 885 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE. 886 */ 887 const u8 *wpa_ie; 888 889 /** 890 * wpa_ie_len - length of the wpa_ie 891 */ 892 size_t wpa_ie_len; 893 894 /** 895 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2 896 */ 897 unsigned int wpa_proto; 898 899 /** 900 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*) 901 * 902 * This is usually ignored if @wpa_ie is used. 903 */ 904 unsigned int pairwise_suite; 905 906 /** 907 * group_suite - Selected group cipher suite (WPA_CIPHER_*) 908 * 909 * This is usually ignored if @wpa_ie is used. 910 */ 911 unsigned int group_suite; 912 913 /** 914 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*) 915 * 916 * This is usually ignored if @wpa_ie is used. 917 */ 918 unsigned int mgmt_group_suite; 919 920 /** 921 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*) 922 * 923 * This is usually ignored if @wpa_ie is used. 924 */ 925 unsigned int key_mgmt_suite; 926 927 /** 928 * auth_alg - Allowed authentication algorithms 929 * Bit field of WPA_AUTH_ALG_* 930 */ 931 int auth_alg; 932 933 /** 934 * mode - Operation mode (infra/ibss) IEEE80211_MODE_* 935 */ 936 int mode; 937 938 /** 939 * wep_key - WEP keys for static WEP configuration 940 */ 941 const u8 *wep_key[4]; 942 943 /** 944 * wep_key_len - WEP key length for static WEP configuration 945 */ 946 size_t wep_key_len[4]; 947 948 /** 949 * wep_tx_keyidx - WEP TX key index for static WEP configuration 950 */ 951 int wep_tx_keyidx; 952 953 /** 954 * mgmt_frame_protection - IEEE 802.11w management frame protection 955 */ 956 enum mfp_options mgmt_frame_protection; 957 958 /** 959 * passphrase - RSN passphrase for PSK 960 * 961 * This value is made available only for WPA/WPA2-Personal (PSK) and 962 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This 963 * is the 8..63 character ASCII passphrase, if available. Please note 964 * that this can be %NULL if passphrase was not used to generate the 965 * PSK. In that case, the psk field must be used to fetch the PSK. 966 */ 967 const char *passphrase; 968 969 /** 970 * psk - RSN PSK (alternative for passphrase for PSK) 971 * 972 * This value is made available only for WPA/WPA2-Personal (PSK) and 973 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This 974 * is the 32-octet (256-bit) PSK, if available. The driver wrapper 975 * should be prepared to handle %NULL value as an error. 976 */ 977 const u8 *psk; 978 979 /** 980 * drop_unencrypted - Enable/disable unencrypted frame filtering 981 * 982 * Configure the driver to drop all non-EAPOL frames (both receive and 983 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must 984 * still be allowed for key negotiation. 985 */ 986 int drop_unencrypted; 987 988 /** 989 * prev_bssid - Previously used BSSID in this ESS 990 * 991 * When not %NULL, this is a request to use reassociation instead of 992 * association. 993 */ 994 const u8 *prev_bssid; 995 996 /** 997 * wps - WPS mode 998 * 999 * If the driver needs to do special configuration for WPS association, 1000 * this variable provides more information on what type of association 1001 * is being requested. Most drivers should not need ot use this. 1002 */ 1003 enum wps_mode wps; 1004 1005 /** 1006 * p2p - Whether this connection is a P2P group 1007 */ 1008 int p2p; 1009 1010 /** 1011 * uapsd - UAPSD parameters for the network 1012 * -1 = do not change defaults 1013 * AP mode: 1 = enabled, 0 = disabled 1014 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE 1015 */ 1016 int uapsd; 1017 1018 /** 1019 * fixed_bssid - Whether to force this BSSID in IBSS mode 1020 * 1 = Fix this BSSID and prevent merges. 1021 * 0 = Do not fix BSSID. 1022 */ 1023 int fixed_bssid; 1024 1025 /** 1026 * fixed_freq - Fix control channel in IBSS mode 1027 * 0 = don't fix control channel (default) 1028 * 1 = fix control channel; this prevents IBSS merging with another 1029 * channel 1030 */ 1031 int fixed_freq; 1032 1033 /** 1034 * disable_ht - Disable HT (IEEE 802.11n) for this connection 1035 */ 1036 int disable_ht; 1037 1038 /** 1039 * htcaps - HT Capabilities over-rides 1040 * 1041 * Only bits set in the mask will be used, and not all values are used 1042 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used. 1043 * 1044 * Pointer to struct ieee80211_ht_capabilities. 1045 */ 1046 const u8 *htcaps; 1047 1048 /** 1049 * htcaps_mask - HT Capabilities over-rides mask 1050 * 1051 * Pointer to struct ieee80211_ht_capabilities. 1052 */ 1053 const u8 *htcaps_mask; 1054 1055#ifdef CONFIG_VHT_OVERRIDES 1056 /** 1057 * disable_vht - Disable VHT for this connection 1058 */ 1059 int disable_vht; 1060 1061 /** 1062 * VHT capability overrides. 1063 */ 1064 const struct ieee80211_vht_capabilities *vhtcaps; 1065 const struct ieee80211_vht_capabilities *vhtcaps_mask; 1066#endif /* CONFIG_VHT_OVERRIDES */ 1067 1068 /** 1069 * req_key_mgmt_offload - Request key management offload for connection 1070 * 1071 * Request key management offload for this connection if the device 1072 * supports it. 1073 */ 1074 int req_key_mgmt_offload; 1075 1076 /** 1077 * req_handshake_offload - Request EAPOL handshake offload 1078 * 1079 * Request EAPOL handshake offload for this connection if the device 1080 * supports it. 1081 */ 1082 int req_handshake_offload; 1083 1084 /** 1085 * Flag for indicating whether this association includes support for 1086 * RRM (Radio Resource Measurements) 1087 */ 1088 int rrm_used; 1089 1090 /** 1091 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an 1092 * AP as usual. Valid for DMG network only. 1093 */ 1094 int pbss; 1095 1096 /** 1097 * fils_kek - KEK for FILS association frame protection (AES-SIV) 1098 */ 1099 const u8 *fils_kek; 1100 1101 /** 1102 * fils_kek_len: Length of fils_kek in bytes 1103 */ 1104 size_t fils_kek_len; 1105 1106 /** 1107 * fils_nonces - Nonces for FILS association frame protection 1108 * (AES-SIV AAD) 1109 */ 1110 const u8 *fils_nonces; 1111 1112 /** 1113 * fils_nonces_len: Length of fils_nonce in bytes 1114 */ 1115 size_t fils_nonces_len; 1116 1117 /** 1118 * fils_erp_username - Username part of keyName-NAI 1119 */ 1120 const u8 *fils_erp_username; 1121 1122 /** 1123 * fils_erp_username_len - Length of fils_erp_username in bytes 1124 */ 1125 size_t fils_erp_username_len; 1126 1127 /** 1128 * fils_erp_realm - Realm/domain name to use in FILS ERP 1129 */ 1130 const u8 *fils_erp_realm; 1131 1132 /** 1133 * fils_erp_realm_len - Length of fils_erp_realm in bytes 1134 */ 1135 size_t fils_erp_realm_len; 1136 1137 /** 1138 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP 1139 * messages 1140 */ 1141 u16 fils_erp_next_seq_num; 1142 1143 /** 1144 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI 1145 * specified by fils_erp_username@fils_erp_realm. 1146 */ 1147 const u8 *fils_erp_rrk; 1148 1149 /** 1150 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes 1151 */ 1152 size_t fils_erp_rrk_len; 1153}; 1154 1155enum hide_ssid { 1156 NO_SSID_HIDING, 1157 HIDDEN_SSID_ZERO_LEN, 1158 HIDDEN_SSID_ZERO_CONTENTS 1159}; 1160 1161enum ch_switch_state { 1162 CH_SW_STARTED, 1163 CH_SW_FINISHED 1164}; 1165 1166struct wowlan_triggers { 1167 u8 any; 1168 u8 disconnect; 1169 u8 magic_pkt; 1170 u8 gtk_rekey_failure; 1171 u8 eap_identity_req; 1172 u8 four_way_handshake; 1173 u8 rfkill_release; 1174}; 1175 1176struct wpa_driver_ap_params { 1177 /** 1178 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE 1179 */ 1180 u8 *head; 1181 1182 /** 1183 * head_len - Length of the head buffer in octets 1184 */ 1185 size_t head_len; 1186 1187 /** 1188 * tail - Beacon tail following TIM IE 1189 */ 1190 u8 *tail; 1191 1192 /** 1193 * tail_len - Length of the tail buffer in octets 1194 */ 1195 size_t tail_len; 1196 1197 /** 1198 * dtim_period - DTIM period 1199 */ 1200 int dtim_period; 1201 1202 /** 1203 * beacon_int - Beacon interval 1204 */ 1205 int beacon_int; 1206 1207 /** 1208 * basic_rates: -1 terminated array of basic rates in 100 kbps 1209 * 1210 * This parameter can be used to set a specific basic rate set for the 1211 * BSS. If %NULL, default basic rate set is used. 1212 */ 1213 int *basic_rates; 1214 1215 /** 1216 * beacon_rate: Beacon frame data rate 1217 * 1218 * This parameter can be used to set a specific Beacon frame data rate 1219 * for the BSS. The interpretation of this value depends on the 1220 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS). If 1221 * beacon_rate == 0 and rate_type == 0 (BEACON_RATE_LEGACY), the default 1222 * Beacon frame data rate is used. 1223 */ 1224 unsigned int beacon_rate; 1225 1226 /** 1227 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT) 1228 */ 1229 enum beacon_rate_type rate_type; 1230 1231 /** 1232 * proberesp - Probe Response template 1233 * 1234 * This is used by drivers that reply to Probe Requests internally in 1235 * AP mode and require the full Probe Response template. 1236 */ 1237 u8 *proberesp; 1238 1239 /** 1240 * proberesp_len - Length of the proberesp buffer in octets 1241 */ 1242 size_t proberesp_len; 1243 1244 /** 1245 * ssid - The SSID to use in Beacon/Probe Response frames 1246 */ 1247 const u8 *ssid; 1248 1249 /** 1250 * ssid_len - Length of the SSID (1..32) 1251 */ 1252 size_t ssid_len; 1253 1254 /** 1255 * hide_ssid - Whether to hide the SSID 1256 */ 1257 enum hide_ssid hide_ssid; 1258 1259 /** 1260 * pairwise_ciphers - WPA_CIPHER_* bitfield 1261 */ 1262 unsigned int pairwise_ciphers; 1263 1264 /** 1265 * group_cipher - WPA_CIPHER_* 1266 */ 1267 unsigned int group_cipher; 1268 1269 /** 1270 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield 1271 */ 1272 unsigned int key_mgmt_suites; 1273 1274 /** 1275 * auth_algs - WPA_AUTH_ALG_* bitfield 1276 */ 1277 unsigned int auth_algs; 1278 1279 /** 1280 * wpa_version - WPA_PROTO_* bitfield 1281 */ 1282 unsigned int wpa_version; 1283 1284 /** 1285 * privacy - Whether privacy is used in the BSS 1286 */ 1287 int privacy; 1288 1289 /** 1290 * beacon_ies - WPS/P2P IE(s) for Beacon frames 1291 * 1292 * This is used to add IEs like WPS IE and P2P IE by drivers that do 1293 * not use the full Beacon template. 1294 */ 1295 const struct wpabuf *beacon_ies; 1296 1297 /** 1298 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames 1299 * 1300 * This is used to add IEs like WPS IE and P2P IE by drivers that 1301 * reply to Probe Request frames internally. 1302 */ 1303 const struct wpabuf *proberesp_ies; 1304 1305 /** 1306 * assocresp_ies - WPS IE(s) for (Re)Association Response frames 1307 * 1308 * This is used to add IEs like WPS IE by drivers that reply to 1309 * (Re)Association Request frames internally. 1310 */ 1311 const struct wpabuf *assocresp_ies; 1312 1313 /** 1314 * isolate - Whether to isolate frames between associated stations 1315 * 1316 * If this is non-zero, the AP is requested to disable forwarding of 1317 * frames between associated stations. 1318 */ 1319 int isolate; 1320 1321 /** 1322 * cts_protect - Whether CTS protection is enabled 1323 */ 1324 int cts_protect; 1325 1326 /** 1327 * preamble - Whether short preamble is enabled 1328 */ 1329 int preamble; 1330 1331 /** 1332 * short_slot_time - Whether short slot time is enabled 1333 * 1334 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do 1335 * not set (e.g., when 802.11g mode is not in use) 1336 */ 1337 int short_slot_time; 1338 1339 /** 1340 * ht_opmode - HT operation mode or -1 if HT not in use 1341 */ 1342 int ht_opmode; 1343 1344 /** 1345 * interworking - Whether Interworking is enabled 1346 */ 1347 int interworking; 1348 1349 /** 1350 * hessid - Homogeneous ESS identifier or %NULL if not set 1351 */ 1352 const u8 *hessid; 1353 1354 /** 1355 * access_network_type - Access Network Type (0..15) 1356 * 1357 * This is used for filtering Probe Request frames when Interworking is 1358 * enabled. 1359 */ 1360 u8 access_network_type; 1361 1362 /** 1363 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity 1364 * 1365 * This is used by driver which advertises this capability. 1366 */ 1367 int ap_max_inactivity; 1368 1369 /** 1370 * ctwindow - Client Traffic Window (in TUs) 1371 */ 1372 u8 p2p_go_ctwindow; 1373 1374 /** 1375 * smps_mode - SMPS mode 1376 * 1377 * SMPS mode to be used by the AP, specified as the relevant bits of 1378 * ht_capab (i.e. HT_CAP_INFO_SMPS_*). 1379 */ 1380 unsigned int smps_mode; 1381 1382 /** 1383 * disable_dgaf - Whether group-addressed frames are disabled 1384 */ 1385 int disable_dgaf; 1386 1387 /** 1388 * osen - Whether OSEN security is enabled 1389 */ 1390 int osen; 1391 1392 /** 1393 * freq - Channel parameters for dynamic bandwidth changes 1394 */ 1395 struct hostapd_freq_params *freq; 1396 1397 /** 1398 * reenable - Whether this is to re-enable beaconing 1399 */ 1400 int reenable; 1401 1402 /** 1403 * pbss - Whether to start a PCP (in PBSS) instead of an AP in 1404 * infrastructure BSS. Valid only for DMG network. 1405 */ 1406 int pbss; 1407 1408 /** 1409 * multicast_to_unicast - Whether to use multicast_to_unicast 1410 * 1411 * If this is non-zero, the AP is requested to perform multicast to 1412 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within 1413 * 802.1Q). If enabled, such frames are to be sent to each station 1414 * separately, with the DA replaced by their own MAC address rather 1415 * than the group address. 1416 * 1417 * Note that this may break certain expectations of the receiver, such 1418 * as the ability to drop unicast IP packets received within multicast 1419 * L2 frames, or the ability to not send ICMP destination unreachable 1420 * messages for packets received in L2 multicast (which is required, 1421 * but the receiver can't tell the difference if this new option is 1422 * enabled.) 1423 * 1424 * This also doesn't implement the 802.11 DMS (directed multicast 1425 * service). 1426 */ 1427 int multicast_to_unicast; 1428 1429 /** 1430 * ftm_responder - Whether FTM responder is enabled 1431 */ 1432 int ftm_responder; 1433 1434 /** 1435 * lci - Binary data, the content of an LCI report IE with type 8 as 1436 * defined in IEEE Std 802.11-2016, 9.4.2.22.10 1437 */ 1438 const struct wpabuf *lci; 1439 1440 /** 1441 * civic - Binary data, the content of a measurement report IE with 1442 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13 1443 */ 1444 const struct wpabuf *civic; 1445}; 1446 1447struct wpa_driver_mesh_bss_params { 1448#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001 1449#define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002 1450#define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004 1451#define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008 1452#define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010 1453 /* 1454 * TODO: Other mesh configuration parameters would go here. 1455 * See NL80211_MESHCONF_* for all the mesh config parameters. 1456 */ 1457 unsigned int flags; 1458 int auto_plinks; 1459 int peer_link_timeout; 1460 int max_peer_links; 1461 int rssi_threshold; 1462 u16 ht_opmode; 1463}; 1464 1465struct wpa_driver_mesh_join_params { 1466 const u8 *meshid; 1467 int meshid_len; 1468 const int *basic_rates; 1469 const u8 *ies; 1470 int ie_len; 1471 struct hostapd_freq_params freq; 1472 int beacon_int; 1473 int dtim_period; 1474 struct wpa_driver_mesh_bss_params conf; 1475#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001 1476#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002 1477#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004 1478#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008 1479 unsigned int flags; 1480}; 1481 1482/** 1483 * struct wpa_driver_capa - Driver capability information 1484 */ 1485struct wpa_driver_capa { 1486#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001 1487#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002 1488#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004 1489#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008 1490#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010 1491#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020 1492#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040 1493#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080 1494#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100 1495#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200 1496#define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400 1497#define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800 1498#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000 1499#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000 1500#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000 1501#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000 1502#define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000 1503 /** Bitfield of supported key management suites */ 1504 unsigned int key_mgmt; 1505 1506#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001 1507#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002 1508#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004 1509#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008 1510#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010 1511#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020 1512#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040 1513#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080 1514#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100 1515#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200 1516#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400 1517#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800 1518#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000 1519 /** Bitfield of supported cipher suites */ 1520 unsigned int enc; 1521 1522#define WPA_DRIVER_AUTH_OPEN 0x00000001 1523#define WPA_DRIVER_AUTH_SHARED 0x00000002 1524#define WPA_DRIVER_AUTH_LEAP 0x00000004 1525 /** Bitfield of supported IEEE 802.11 authentication algorithms */ 1526 unsigned int auth; 1527 1528/** Driver generated WPA/RSN IE */ 1529#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001 1530/** Driver needs static WEP key setup after association command */ 1531#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002 1532/** Driver takes care of all DFS operations */ 1533#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004 1534/** Driver takes care of RSN 4-way handshake internally; PMK is configured with 1535 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */ 1536#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008 1537/** Driver is for a wired Ethernet interface */ 1538#define WPA_DRIVER_FLAGS_WIRED 0x00000010 1539/** Driver provides separate commands for authentication and association (SME in 1540 * wpa_supplicant). */ 1541#define WPA_DRIVER_FLAGS_SME 0x00000020 1542/** Driver supports AP mode */ 1543#define WPA_DRIVER_FLAGS_AP 0x00000040 1544/** Driver needs static WEP key setup after association has been completed */ 1545#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080 1546/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */ 1547#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100 1548/** Driver supports concurrent P2P operations */ 1549#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200 1550/** 1551 * Driver uses the initial interface as a dedicated management interface, i.e., 1552 * it cannot be used for P2P group operations or non-P2P purposes. 1553 */ 1554#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400 1555/** This interface is P2P capable (P2P GO or P2P Client) */ 1556#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800 1557/** Driver supports station and key removal when stopping an AP */ 1558#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000 1559/** 1560 * Driver uses the initial interface for P2P management interface and non-P2P 1561 * purposes (e.g., connect to infra AP), but this interface cannot be used for 1562 * P2P group operations. 1563 */ 1564#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000 1565/** 1566 * Driver is known to use sane error codes, i.e., when it indicates that 1567 * something (e.g., association) fails, there was indeed a failure and the 1568 * operation does not end up getting completed successfully later. 1569 */ 1570#define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000 1571/** Driver supports off-channel TX */ 1572#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000 1573/** Driver indicates TX status events for EAPOL Data frames */ 1574#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000 1575/** Driver indicates TX status events for Deauth/Disassoc frames */ 1576#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000 1577/** Driver supports roaming (BSS selection) in firmware */ 1578#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000 1579/** Driver supports operating as a TDLS peer */ 1580#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000 1581/** Driver requires external TDLS setup/teardown/discovery */ 1582#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000 1583/** Driver indicates support for Probe Response offloading in AP mode */ 1584#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000 1585/** Driver supports U-APSD in AP mode */ 1586#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000 1587/** Driver supports inactivity timer in AP mode */ 1588#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000 1589/** Driver expects user space implementation of MLME in AP mode */ 1590#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000 1591/** Driver supports SAE with user space SME */ 1592#define WPA_DRIVER_FLAGS_SAE 0x02000000 1593/** Driver makes use of OBSS scan mechanism in wpa_supplicant */ 1594#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000 1595/** Driver supports IBSS (Ad-hoc) mode */ 1596#define WPA_DRIVER_FLAGS_IBSS 0x08000000 1597/** Driver supports radar detection */ 1598#define WPA_DRIVER_FLAGS_RADAR 0x10000000 1599/** Driver supports a dedicated interface for P2P Device */ 1600#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000 1601/** Driver supports QoS Mapping */ 1602#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000 1603/** Driver supports CSA in AP mode */ 1604#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000 1605/** Driver supports mesh */ 1606#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL 1607/** Driver support ACS offload */ 1608#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL 1609/** Driver supports key management offload */ 1610#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL 1611/** Driver supports TDLS channel switching */ 1612#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL 1613/** Driver supports IBSS with HT datarates */ 1614#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL 1615/** Driver supports IBSS with VHT datarates */ 1616#define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL 1617/** Driver supports automatic band selection */ 1618#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL 1619/** Driver supports simultaneous off-channel operations */ 1620#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL 1621/** Driver supports full AP client state */ 1622#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL 1623/** Driver supports P2P Listen offload */ 1624#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL 1625/** Driver supports FILS */ 1626#define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL 1627/** Driver supports Beacon frame TX rate configuration (legacy rates) */ 1628#define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL 1629/** Driver supports Beacon frame TX rate configuration (HT rates) */ 1630#define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL 1631/** Driver supports Beacon frame TX rate configuration (VHT rates) */ 1632#define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL 1633/** Driver supports mgmt_tx with random TX address in non-connected state */ 1634#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL 1635/** Driver supports mgmt_tx with random TX addr in connected state */ 1636#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL 1637/** Driver supports better BSS reporting with sched_scan in connected mode */ 1638#define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL 1639/** Driver supports HE capabilities */ 1640#define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL 1641/** Driver supports FILS shared key offload */ 1642#define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL 1643/** Driver supports all OCE STA specific mandatory features */ 1644#define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL 1645/** Driver supports all OCE AP specific mandatory features */ 1646#define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL 1647/** 1648 * Driver supports all OCE STA-CFON specific mandatory features only. 1649 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the 1650 * userspace shall assume that this driver may not support all OCE AP 1651 * functionality but can support only OCE STA-CFON functionality. 1652 */ 1653#define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL 1654/** Driver supports MFP-optional in the connect command */ 1655#define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL 1656/** Driver is a self-managed regulatory device */ 1657#define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL 1658/** Driver supports FTM responder functionality */ 1659#define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL 1660/** Driver support 4-way handshake offload for WPA-Personal */ 1661#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL 1662 u64 flags; 1663 1664#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \ 1665 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE) 1666 1667#define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001 1668#define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002 1669 unsigned int smps_modes; 1670 1671 unsigned int wmm_ac_supported:1; 1672 1673 unsigned int mac_addr_rand_scan_supported:1; 1674 unsigned int mac_addr_rand_sched_scan_supported:1; 1675 1676 /** Maximum number of supported active probe SSIDs */ 1677 int max_scan_ssids; 1678 1679 /** Maximum number of supported active probe SSIDs for sched_scan */ 1680 int max_sched_scan_ssids; 1681 1682 /** Maximum number of supported scan plans for scheduled scan */ 1683 unsigned int max_sched_scan_plans; 1684 1685 /** Maximum interval in a scan plan. In seconds */ 1686 u32 max_sched_scan_plan_interval; 1687 1688 /** Maximum number of iterations in a single scan plan */ 1689 u32 max_sched_scan_plan_iterations; 1690 1691 /** Whether sched_scan (offloaded scanning) is supported */ 1692 int sched_scan_supported; 1693 1694 /** Maximum number of supported match sets for sched_scan */ 1695 int max_match_sets; 1696 1697 /** 1698 * max_remain_on_chan - Maximum remain-on-channel duration in msec 1699 */ 1700 unsigned int max_remain_on_chan; 1701 1702 /** 1703 * max_stations - Maximum number of associated stations the driver 1704 * supports in AP mode 1705 */ 1706 unsigned int max_stations; 1707 1708 /** 1709 * probe_resp_offloads - Bitmap of supported protocols by the driver 1710 * for Probe Response offloading. 1711 */ 1712/** Driver Probe Response offloading support for WPS ver. 1 */ 1713#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001 1714/** Driver Probe Response offloading support for WPS ver. 2 */ 1715#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002 1716/** Driver Probe Response offloading support for P2P */ 1717#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004 1718/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */ 1719#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008 1720 unsigned int probe_resp_offloads; 1721 1722 unsigned int max_acl_mac_addrs; 1723 1724 /** 1725 * Number of supported concurrent channels 1726 */ 1727 unsigned int num_multichan_concurrent; 1728 1729 /** 1730 * extended_capa - extended capabilities in driver/device 1731 * 1732 * Must be allocated and freed by driver and the pointers must be 1733 * valid for the lifetime of the driver, i.e., freed in deinit() 1734 */ 1735 const u8 *extended_capa, *extended_capa_mask; 1736 unsigned int extended_capa_len; 1737 1738 struct wowlan_triggers wowlan_triggers; 1739 1740/** Driver adds the DS Params Set IE in Probe Request frames */ 1741#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001 1742/** Driver adds the WFA TPC IE in Probe Request frames */ 1743#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002 1744/** Driver handles quiet period requests */ 1745#define WPA_DRIVER_FLAGS_QUIET 0x00000004 1746/** 1747 * Driver is capable of inserting the current TX power value into the body of 1748 * transmitted frames. 1749 * Background: Some Action frames include a TPC Report IE. This IE contains a 1750 * TX power field, which has to be updated by lower layers. One such Action 1751 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part 1752 * of spectrum management). Note that this insertion takes place at a fixed 1753 * offset, namely the 6th byte in the Action frame body. 1754 */ 1755#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008 1756/** 1757 * Driver supports RRM. With this support, the driver will accept to use RRM in 1758 * (Re)Association Request frames, without supporting quiet period. 1759 */ 1760#define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010 1761 1762/** Driver supports setting the scan dwell time */ 1763#define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020 1764/** Driver supports Beacon Report Measurement */ 1765#define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040 1766 1767 u32 rrm_flags; 1768 1769 /* Driver concurrency capabilities */ 1770 unsigned int conc_capab; 1771 /* Maximum number of concurrent channels on 2.4 GHz */ 1772 unsigned int max_conc_chan_2_4; 1773 /* Maximum number of concurrent channels on 5 GHz */ 1774 unsigned int max_conc_chan_5_0; 1775 1776 /* Maximum number of supported CSA counters */ 1777 u16 max_csa_counters; 1778}; 1779 1780 1781struct hostapd_data; 1782 1783#define STA_DRV_DATA_TX_MCS BIT(0) 1784#define STA_DRV_DATA_RX_MCS BIT(1) 1785#define STA_DRV_DATA_TX_VHT_MCS BIT(2) 1786#define STA_DRV_DATA_RX_VHT_MCS BIT(3) 1787#define STA_DRV_DATA_TX_VHT_NSS BIT(4) 1788#define STA_DRV_DATA_RX_VHT_NSS BIT(5) 1789#define STA_DRV_DATA_TX_SHORT_GI BIT(6) 1790#define STA_DRV_DATA_RX_SHORT_GI BIT(7) 1791#define STA_DRV_DATA_LAST_ACK_RSSI BIT(8) 1792 1793struct hostap_sta_driver_data { 1794 unsigned long rx_packets, tx_packets; 1795 unsigned long long rx_bytes, tx_bytes; 1796 unsigned long long rx_airtime, tx_airtime; 1797 int bytes_64bit; /* whether 64-bit byte counters are supported */ 1798 unsigned long current_tx_rate; 1799 unsigned long current_rx_rate; 1800 unsigned long inactive_msec; 1801 unsigned long flags; /* bitfield of STA_DRV_DATA_* */ 1802 unsigned long num_ps_buf_frames; 1803 unsigned long tx_retry_failed; 1804 unsigned long tx_retry_count; 1805 s8 last_ack_rssi; 1806 unsigned long backlog_packets; 1807 unsigned long backlog_bytes; 1808 s8 signal; 1809 u8 rx_vhtmcs; 1810 u8 tx_vhtmcs; 1811 u8 rx_mcs; 1812 u8 tx_mcs; 1813 u8 rx_vht_nss; 1814 u8 tx_vht_nss; 1815}; 1816 1817struct hostapd_sta_add_params { 1818 const u8 *addr; 1819 u16 aid; 1820 u16 capability; 1821 const u8 *supp_rates; 1822 size_t supp_rates_len; 1823 u16 listen_interval; 1824 const struct ieee80211_ht_capabilities *ht_capabilities; 1825 const struct ieee80211_vht_capabilities *vht_capabilities; 1826 int vht_opmode_enabled; 1827 u8 vht_opmode; 1828 const struct ieee80211_he_capabilities *he_capab; 1829 size_t he_capab_len; 1830 u32 flags; /* bitmask of WPA_STA_* flags */ 1831 u32 flags_mask; /* unset bits in flags */ 1832#ifdef CONFIG_MESH 1833 enum mesh_plink_state plink_state; 1834 u16 peer_aid; 1835#endif /* CONFIG_MESH */ 1836 int set; /* Set STA parameters instead of add */ 1837 u8 qosinfo; 1838 const u8 *ext_capab; 1839 size_t ext_capab_len; 1840 const u8 *supp_channels; 1841 size_t supp_channels_len; 1842 const u8 *supp_oper_classes; 1843 size_t supp_oper_classes_len; 1844 int support_p2p_ps; 1845}; 1846 1847struct mac_address { 1848 u8 addr[ETH_ALEN]; 1849}; 1850 1851struct hostapd_acl_params { 1852 u8 acl_policy; 1853 unsigned int num_mac_acl; 1854 struct mac_address mac_acl[0]; 1855}; 1856 1857enum wpa_driver_if_type { 1858 /** 1859 * WPA_IF_STATION - Station mode interface 1860 */ 1861 WPA_IF_STATION, 1862 1863 /** 1864 * WPA_IF_AP_VLAN - AP mode VLAN interface 1865 * 1866 * This interface shares its address and Beacon frame with the main 1867 * BSS. 1868 */ 1869 WPA_IF_AP_VLAN, 1870 1871 /** 1872 * WPA_IF_AP_BSS - AP mode BSS interface 1873 * 1874 * This interface has its own address and Beacon frame. 1875 */ 1876 WPA_IF_AP_BSS, 1877 1878 /** 1879 * WPA_IF_P2P_GO - P2P Group Owner 1880 */ 1881 WPA_IF_P2P_GO, 1882 1883 /** 1884 * WPA_IF_P2P_CLIENT - P2P Client 1885 */ 1886 WPA_IF_P2P_CLIENT, 1887 1888 /** 1889 * WPA_IF_P2P_GROUP - P2P Group interface (will become either 1890 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known) 1891 */ 1892 WPA_IF_P2P_GROUP, 1893 1894 /** 1895 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the 1896 * abstracted P2P Device function in the driver 1897 */ 1898 WPA_IF_P2P_DEVICE, 1899 1900 /* 1901 * WPA_IF_MESH - Mesh interface 1902 */ 1903 WPA_IF_MESH, 1904 1905 /* 1906 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only) 1907 */ 1908 WPA_IF_TDLS, 1909 1910 /* 1911 * WPA_IF_IBSS - IBSS interface (used for pref freq only) 1912 */ 1913 WPA_IF_IBSS, 1914}; 1915 1916struct wpa_init_params { 1917 void *global_priv; 1918 const u8 *bssid; 1919 const char *ifname; 1920 const char *driver_params; 1921 int use_pae_group_addr; 1922 char **bridge; 1923 size_t num_bridge; 1924 1925 u8 *own_addr; /* buffer for writing own MAC address */ 1926}; 1927 1928 1929struct wpa_bss_params { 1930 /** Interface name (for multi-SSID/VLAN support) */ 1931 const char *ifname; 1932 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */ 1933 int enabled; 1934 1935 int wpa; 1936 int ieee802_1x; 1937 int wpa_group; 1938 int wpa_pairwise; 1939 int wpa_key_mgmt; 1940 int rsn_preauth; 1941 enum mfp_options ieee80211w; 1942}; 1943 1944#define WPA_STA_AUTHORIZED BIT(0) 1945#define WPA_STA_WMM BIT(1) 1946#define WPA_STA_SHORT_PREAMBLE BIT(2) 1947#define WPA_STA_MFP BIT(3) 1948#define WPA_STA_TDLS_PEER BIT(4) 1949#define WPA_STA_AUTHENTICATED BIT(5) 1950#define WPA_STA_ASSOCIATED BIT(6) 1951 1952enum tdls_oper { 1953 TDLS_DISCOVERY_REQ, 1954 TDLS_SETUP, 1955 TDLS_TEARDOWN, 1956 TDLS_ENABLE_LINK, 1957 TDLS_DISABLE_LINK, 1958 TDLS_ENABLE, 1959 TDLS_DISABLE 1960}; 1961 1962enum wnm_oper { 1963 WNM_SLEEP_ENTER_CONFIRM, 1964 WNM_SLEEP_ENTER_FAIL, 1965 WNM_SLEEP_EXIT_CONFIRM, 1966 WNM_SLEEP_EXIT_FAIL, 1967 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */ 1968 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */ 1969 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for 1970 * a STA */ 1971 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE 1972 * for a STA */ 1973 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */ 1974 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE 1975 * for a STA */ 1976 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */ 1977}; 1978 1979/* enum smps_mode - SMPS mode definitions */ 1980enum smps_mode { 1981 SMPS_AUTOMATIC, 1982 SMPS_OFF, 1983 SMPS_DYNAMIC, 1984 SMPS_STATIC, 1985 1986 /* Keep last */ 1987 SMPS_INVALID, 1988}; 1989 1990#define WPA_INVALID_NOISE 9999 1991 1992/** 1993 * struct wpa_signal_info - Information about channel signal quality 1994 * @frequency: control frequency 1995 * @above_threshold: true if the above threshold was crossed 1996 * (relevant for a CQM event) 1997 * @current_signal: in dBm 1998 * @avg_signal: in dBm 1999 * @avg_beacon_signal: in dBm 2000 * @current_noise: %WPA_INVALID_NOISE if not supported 2001 * @current_txrate: current TX rate 2002 * @chanwidth: channel width 2003 * @center_frq1: center frequency for the first segment 2004 * @center_frq2: center frequency for the second segment (if relevant) 2005 */ 2006struct wpa_signal_info { 2007 u32 frequency; 2008 int above_threshold; 2009 int current_signal; 2010 int avg_signal; 2011 int avg_beacon_signal; 2012 int current_noise; 2013 int current_txrate; 2014 enum chan_width chanwidth; 2015 int center_frq1; 2016 int center_frq2; 2017}; 2018 2019/** 2020 * struct wpa_channel_info - Information about the current channel 2021 * @frequency: Center frequency of the primary 20 MHz channel 2022 * @chanwidth: Width of the current operating channel 2023 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1). 2024 * This field is only filled in when using a 40 MHz channel. 2025 * @center_frq1: Center frequency of frequency segment 0 2026 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels) 2027 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is 2028 * derived from center_frq2 for convenience. 2029 */ 2030struct wpa_channel_info { 2031 u32 frequency; 2032 enum chan_width chanwidth; 2033 int sec_channel; 2034 int center_frq1; 2035 int center_frq2; 2036 u8 seg1_idx; 2037}; 2038 2039/** 2040 * struct beacon_data - Beacon data 2041 * @head: Head portion of Beacon frame (before TIM IE) 2042 * @tail: Tail portion of Beacon frame (after TIM IE) 2043 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL 2044 * @proberesp_ies: Extra information element(s) to add into Probe Response 2045 * frames or %NULL 2046 * @assocresp_ies: Extra information element(s) to add into (Re)Association 2047 * Response frames or %NULL 2048 * @probe_resp: Probe Response frame template 2049 * @head_len: Length of @head 2050 * @tail_len: Length of @tail 2051 * @beacon_ies_len: Length of beacon_ies in octets 2052 * @proberesp_ies_len: Length of proberesp_ies in octets 2053 * @proberesp_ies_len: Length of proberesp_ies in octets 2054 * @probe_resp_len: Length of probe response template (@probe_resp) 2055 */ 2056struct beacon_data { 2057 u8 *head, *tail; 2058 u8 *beacon_ies; 2059 u8 *proberesp_ies; 2060 u8 *assocresp_ies; 2061 u8 *probe_resp; 2062 2063 size_t head_len, tail_len; 2064 size_t beacon_ies_len; 2065 size_t proberesp_ies_len; 2066 size_t assocresp_ies_len; 2067 size_t probe_resp_len; 2068}; 2069 2070/** 2071 * struct csa_settings - Settings for channel switch command 2072 * @cs_count: Count in Beacon frames (TBTT) to perform the switch 2073 * @block_tx: 1 - block transmission for CSA period 2074 * @freq_params: Next channel frequency parameter 2075 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period 2076 * @beacon_after: Next beacon/probe resp/asooc resp info 2077 * @counter_offset_beacon: Offset to the count field in beacon's tail 2078 * @counter_offset_presp: Offset to the count field in probe resp. 2079 */ 2080struct csa_settings { 2081 u8 cs_count; 2082 u8 block_tx; 2083 2084 struct hostapd_freq_params freq_params; 2085 struct beacon_data beacon_csa; 2086 struct beacon_data beacon_after; 2087 2088 u16 counter_offset_beacon[2]; 2089 u16 counter_offset_presp[2]; 2090}; 2091 2092/* TDLS peer capabilities for send_tdls_mgmt() */ 2093enum tdls_peer_capability { 2094 TDLS_PEER_HT = BIT(0), 2095 TDLS_PEER_VHT = BIT(1), 2096 TDLS_PEER_WMM = BIT(2), 2097}; 2098 2099/* valid info in the wmm_params struct */ 2100enum wmm_params_valid_info { 2101 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0), 2102}; 2103 2104/** 2105 * struct wmm_params - WMM parameterss configured for this association 2106 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields 2107 * of the struct contain valid information. 2108 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if 2109 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set) 2110 */ 2111struct wmm_params { 2112 u8 info_bitmap; 2113 u8 uapsd_queues; 2114}; 2115 2116#ifdef CONFIG_MACSEC 2117struct macsec_init_params { 2118 Boolean always_include_sci; 2119 Boolean use_es; 2120 Boolean use_scb; 2121}; 2122#endif /* CONFIG_MACSEC */ 2123 2124enum drv_br_port_attr { 2125 DRV_BR_PORT_ATTR_PROXYARP, 2126 DRV_BR_PORT_ATTR_HAIRPIN_MODE, 2127}; 2128 2129enum drv_br_net_param { 2130 DRV_BR_NET_PARAM_GARP_ACCEPT, 2131 DRV_BR_MULTICAST_SNOOPING, 2132}; 2133 2134struct drv_acs_params { 2135 /* Selected mode (HOSTAPD_MODE_*) */ 2136 enum hostapd_hw_mode hw_mode; 2137 2138 /* Indicates whether HT is enabled */ 2139 int ht_enabled; 2140 2141 /* Indicates whether HT40 is enabled */ 2142 int ht40_enabled; 2143 2144 /* Indicates whether VHT is enabled */ 2145 int vht_enabled; 2146 2147 /* Configured ACS channel width */ 2148 u16 ch_width; 2149 2150 /* ACS channel list info */ 2151 unsigned int ch_list_len; 2152 const u8 *ch_list; 2153 const int *freq_list; 2154}; 2155 2156struct wpa_bss_trans_info { 2157 u8 mbo_transition_reason; 2158 u8 n_candidates; 2159 u8 *bssid; 2160}; 2161 2162struct wpa_bss_candidate_info { 2163 u8 num; 2164 struct candidate_list { 2165 u8 bssid[ETH_ALEN]; 2166 u8 is_accept; 2167 u32 reject_reason; 2168 } *candidates; 2169}; 2170 2171struct wpa_pmkid_params { 2172 const u8 *bssid; 2173 const u8 *ssid; 2174 size_t ssid_len; 2175 const u8 *fils_cache_id; 2176 const u8 *pmkid; 2177 const u8 *pmk; 2178 size_t pmk_len; 2179}; 2180 2181/* Mask used to specify which connection parameters have to be updated */ 2182enum wpa_drv_update_connect_params_mask { 2183 WPA_DRV_UPDATE_ASSOC_IES = BIT(0), 2184 WPA_DRV_UPDATE_FILS_ERP_INFO = BIT(1), 2185 WPA_DRV_UPDATE_AUTH_TYPE = BIT(2), 2186}; 2187 2188/** 2189 * struct external_auth - External authentication trigger parameters 2190 * 2191 * These are used across the external authentication request and event 2192 * interfaces. 2193 * @action: Action type / trigger for external authentication. Only significant 2194 * for the event interface. 2195 * @bssid: BSSID of the peer with which the authentication has to happen. Used 2196 * by both the request and event interface. 2197 * @ssid: SSID of the AP. Used by both the request and event interface. 2198 * @ssid_len: SSID length in octets. 2199 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for 2200 * the request interface. 2201 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication, 2202 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give 2203 * the real status code for failures. Used only for the request interface 2204 * from user space to the driver. 2205 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE). 2206 */ 2207struct external_auth { 2208 enum { 2209 EXT_AUTH_START, 2210 EXT_AUTH_ABORT, 2211 } action; 2212 const u8 *bssid; 2213 const u8 *ssid; 2214 size_t ssid_len; 2215 unsigned int key_mgmt_suite; 2216 u16 status; 2217 const u8 *pmkid; 2218}; 2219 2220/** 2221 * struct wpa_driver_ops - Driver interface API definition 2222 * 2223 * This structure defines the API that each driver interface needs to implement 2224 * for core wpa_supplicant code. All driver specific functionality is captured 2225 * in this wrapper. 2226 */ 2227struct wpa_driver_ops { 2228 /** Name of the driver interface */ 2229 const char *name; 2230 /** One line description of the driver interface */ 2231 const char *desc; 2232 2233 /** 2234 * get_bssid - Get the current BSSID 2235 * @priv: private driver interface data 2236 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes) 2237 * 2238 * Returns: 0 on success, -1 on failure 2239 * 2240 * Query kernel driver for the current BSSID and copy it to bssid. 2241 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not 2242 * associated. 2243 */ 2244 int (*get_bssid)(void *priv, u8 *bssid); 2245 2246 /** 2247 * get_ssid - Get the current SSID 2248 * @priv: private driver interface data 2249 * @ssid: buffer for SSID (at least 32 bytes) 2250 * 2251 * Returns: Length of the SSID on success, -1 on failure 2252 * 2253 * Query kernel driver for the current SSID and copy it to ssid. 2254 * Returning zero is recommended if the STA is not associated. 2255 * 2256 * Note: SSID is an array of octets, i.e., it is not nul terminated and 2257 * can, at least in theory, contain control characters (including nul) 2258 * and as such, should be processed as binary data, not a printable 2259 * string. 2260 */ 2261 int (*get_ssid)(void *priv, u8 *ssid); 2262 2263 /** 2264 * set_key - Configure encryption key 2265 * @ifname: Interface name (for multi-SSID/VLAN support) 2266 * @priv: private driver interface data 2267 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP, 2268 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK, 2269 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256, 2270 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256, 2271 * %WPA_ALG_BIP_CMAC_256); 2272 * %WPA_ALG_NONE clears the key. 2273 * @addr: Address of the peer STA (BSSID of the current AP when setting 2274 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for 2275 * broadcast keys, %NULL for default keys that are used both for 2276 * broadcast and unicast; when clearing keys, %NULL is used to 2277 * indicate that both the broadcast-only and default key of the 2278 * specified key index is to be cleared 2279 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for 2280 * IGTK 2281 * @set_tx: configure this key as the default Tx key (only used when 2282 * driver does not support separate unicast/individual key 2283 * @seq: sequence number/packet number, seq_len octets, the next 2284 * packet number to be used for in replay protection; configured 2285 * for Rx keys (in most cases, this is only used with broadcast 2286 * keys and set to zero for unicast keys); %NULL if not set 2287 * @seq_len: length of the seq, depends on the algorithm: 2288 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets 2289 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key, 2290 * 8-byte Rx Mic Key 2291 * @key_len: length of the key buffer in octets (WEP: 5 or 13, 2292 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16) 2293 * 2294 * Returns: 0 on success, -1 on failure 2295 * 2296 * Configure the given key for the kernel driver. If the driver 2297 * supports separate individual keys (4 default keys + 1 individual), 2298 * addr can be used to determine whether the key is default or 2299 * individual. If only 4 keys are supported, the default key with key 2300 * index 0 is used as the individual key. STA must be configured to use 2301 * it as the default Tx key (set_tx is set) and accept Rx for all the 2302 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for 2303 * broadcast keys, so key index 0 is available for this kind of 2304 * configuration. 2305 * 2306 * Please note that TKIP keys include separate TX and RX MIC keys and 2307 * some drivers may expect them in different order than wpa_supplicant 2308 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets 2309 * will trigger Michael MIC errors. This can be fixed by changing the 2310 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key 2311 * in driver_*.c set_key() implementation, see driver_ndis.c for an 2312 * example on how this can be done. 2313 */ 2314 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg, 2315 const u8 *addr, int key_idx, int set_tx, 2316 const u8 *seq, size_t seq_len, 2317 const u8 *key, size_t key_len); 2318 2319 /** 2320 * init - Initialize driver interface 2321 * @ctx: context to be used when calling wpa_supplicant functions, 2322 * e.g., wpa_supplicant_event() 2323 * @ifname: interface name, e.g., wlan0 2324 * 2325 * Returns: Pointer to private data, %NULL on failure 2326 * 2327 * Initialize driver interface, including event processing for kernel 2328 * driver events (e.g., associated, scan results, Michael MIC failure). 2329 * This function can allocate a private configuration data area for 2330 * @ctx, file descriptor, interface name, etc. information that may be 2331 * needed in future driver operations. If this is not used, non-NULL 2332 * value will need to be returned because %NULL is used to indicate 2333 * failure. The returned value will be used as 'void *priv' data for 2334 * all other driver_ops functions. 2335 * 2336 * The main event loop (eloop.c) of wpa_supplicant can be used to 2337 * register callback for read sockets (eloop_register_read_sock()). 2338 * 2339 * See below for more information about events and 2340 * wpa_supplicant_event() function. 2341 */ 2342 void * (*init)(void *ctx, const char *ifname); 2343 2344 /** 2345 * deinit - Deinitialize driver interface 2346 * @priv: private driver interface data from init() 2347 * 2348 * Shut down driver interface and processing of driver events. Free 2349 * private data buffer if one was allocated in init() handler. 2350 */ 2351 void (*deinit)(void *priv); 2352 2353 /** 2354 * set_param - Set driver configuration parameters 2355 * @priv: private driver interface data from init() 2356 * @param: driver specific configuration parameters 2357 * 2358 * Returns: 0 on success, -1 on failure 2359 * 2360 * Optional handler for notifying driver interface about configuration 2361 * parameters (driver_param). 2362 */ 2363 int (*set_param)(void *priv, const char *param); 2364 2365 /** 2366 * set_countermeasures - Enable/disable TKIP countermeasures 2367 * @priv: private driver interface data 2368 * @enabled: 1 = countermeasures enabled, 0 = disabled 2369 * 2370 * Returns: 0 on success, -1 on failure 2371 * 2372 * Configure TKIP countermeasures. When these are enabled, the driver 2373 * should drop all received and queued frames that are using TKIP. 2374 */ 2375 int (*set_countermeasures)(void *priv, int enabled); 2376 2377 /** 2378 * deauthenticate - Request driver to deauthenticate 2379 * @priv: private driver interface data 2380 * @addr: peer address (BSSID of the AP) 2381 * @reason_code: 16-bit reason code to be sent in the deauthentication 2382 * frame 2383 * 2384 * Returns: 0 on success, -1 on failure 2385 */ 2386 int (*deauthenticate)(void *priv, const u8 *addr, u16 reason_code); 2387 2388 /** 2389 * associate - Request driver to associate 2390 * @priv: private driver interface data 2391 * @params: association parameters 2392 * 2393 * Returns: 0 on success, -1 on failure 2394 */ 2395 int (*associate)(void *priv, 2396 struct wpa_driver_associate_params *params); 2397 2398 /** 2399 * add_pmkid - Add PMKSA cache entry to the driver 2400 * @priv: private driver interface data 2401 * @params: PMKSA parameters 2402 * 2403 * Returns: 0 on success, -1 on failure 2404 * 2405 * This function is called when a new PMK is received, as a result of 2406 * either normal authentication or RSN pre-authentication. The PMKSA 2407 * parameters are either a set of bssid, pmkid, and pmk; or a set of 2408 * ssid, fils_cache_id, pmkid, and pmk. 2409 * 2410 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 2411 * associate(), add_pmkid() can be used to add new PMKSA cache entries 2412 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this 2413 * driver_ops function does not need to be implemented. Likewise, if 2414 * the driver does not support WPA, this function is not needed. 2415 */ 2416 int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params); 2417 2418 /** 2419 * remove_pmkid - Remove PMKSA cache entry to the driver 2420 * @priv: private driver interface data 2421 * @params: PMKSA parameters 2422 * 2423 * Returns: 0 on success, -1 on failure 2424 * 2425 * This function is called when the supplicant drops a PMKSA cache 2426 * entry for any reason. The PMKSA parameters are either a set of 2427 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid. 2428 * 2429 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 2430 * associate(), remove_pmkid() can be used to synchronize PMKSA caches 2431 * between the driver and wpa_supplicant. If the driver uses wpa_ie 2432 * from wpa_supplicant, this driver_ops function does not need to be 2433 * implemented. Likewise, if the driver does not support WPA, this 2434 * function is not needed. 2435 */ 2436 int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params); 2437 2438 /** 2439 * flush_pmkid - Flush PMKSA cache 2440 * @priv: private driver interface data 2441 * 2442 * Returns: 0 on success, -1 on failure 2443 * 2444 * This function is called when the supplicant drops all PMKSA cache 2445 * entries for any reason. 2446 * 2447 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 2448 * associate(), remove_pmkid() can be used to synchronize PMKSA caches 2449 * between the driver and wpa_supplicant. If the driver uses wpa_ie 2450 * from wpa_supplicant, this driver_ops function does not need to be 2451 * implemented. Likewise, if the driver does not support WPA, this 2452 * function is not needed. 2453 */ 2454 int (*flush_pmkid)(void *priv); 2455 2456 /** 2457 * get_capa - Get driver capabilities 2458 * @priv: private driver interface data 2459 * 2460 * Returns: 0 on success, -1 on failure 2461 * 2462 * Get driver/firmware/hardware capabilities. 2463 */ 2464 int (*get_capa)(void *priv, struct wpa_driver_capa *capa); 2465 2466 /** 2467 * poll - Poll driver for association information 2468 * @priv: private driver interface data 2469 * 2470 * This is an option callback that can be used when the driver does not 2471 * provide event mechanism for association events. This is called when 2472 * receiving WPA EAPOL-Key messages that require association 2473 * information. The driver interface is supposed to generate associnfo 2474 * event before returning from this callback function. In addition, the 2475 * driver interface should generate an association event after having 2476 * sent out associnfo. 2477 */ 2478 void (*poll)(void *priv); 2479 2480 /** 2481 * get_ifindex - Get interface index 2482 * @priv: private driver interface data 2483 * 2484 * Returns: Interface index 2485 */ 2486 unsigned int (*get_ifindex)(void *priv); 2487 2488 /** 2489 * get_ifname - Get interface name 2490 * @priv: private driver interface data 2491 * 2492 * Returns: Pointer to the interface name. This can differ from the 2493 * interface name used in init() call. Init() is called first. 2494 * 2495 * This optional function can be used to allow the driver interface to 2496 * replace the interface name with something else, e.g., based on an 2497 * interface mapping from a more descriptive name. 2498 */ 2499 const char * (*get_ifname)(void *priv); 2500 2501 /** 2502 * get_mac_addr - Get own MAC address 2503 * @priv: private driver interface data 2504 * 2505 * Returns: Pointer to own MAC address or %NULL on failure 2506 * 2507 * This optional function can be used to get the own MAC address of the 2508 * device from the driver interface code. This is only needed if the 2509 * l2_packet implementation for the OS does not provide easy access to 2510 * a MAC address. */ 2511 const u8 * (*get_mac_addr)(void *priv); 2512 2513 /** 2514 * set_operstate - Sets device operating state to DORMANT or UP 2515 * @priv: private driver interface data 2516 * @state: 0 = dormant, 1 = up 2517 * Returns: 0 on success, -1 on failure 2518 * 2519 * This is an optional function that can be used on operating systems 2520 * that support a concept of controlling network device state from user 2521 * space applications. This function, if set, gets called with 2522 * state = 1 when authentication has been completed and with state = 0 2523 * when connection is lost. 2524 */ 2525 int (*set_operstate)(void *priv, int state); 2526 2527 /** 2528 * mlme_setprotection - MLME-SETPROTECTION.request primitive 2529 * @priv: Private driver interface data 2530 * @addr: Address of the station for which to set protection (may be 2531 * %NULL for group keys) 2532 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_* 2533 * @key_type: MLME_SETPROTECTION_KEY_TYPE_* 2534 * Returns: 0 on success, -1 on failure 2535 * 2536 * This is an optional function that can be used to set the driver to 2537 * require protection for Tx and/or Rx frames. This uses the layer 2538 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1 2539 * (MLME-SETPROTECTION.request). Many drivers do not use explicit 2540 * set protection operation; instead, they set protection implicitly 2541 * based on configured keys. 2542 */ 2543 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type, 2544 int key_type); 2545 2546 /** 2547 * get_hw_feature_data - Get hardware support data (channels and rates) 2548 * @priv: Private driver interface data 2549 * @num_modes: Variable for returning the number of returned modes 2550 * flags: Variable for returning hardware feature flags 2551 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*) 2552 * Returns: Pointer to allocated hardware data on success or %NULL on 2553 * failure. Caller is responsible for freeing this. 2554 */ 2555 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv, 2556 u16 *num_modes, 2557 u16 *flags, u8 *dfs); 2558 2559 /** 2560 * send_mlme - Send management frame from MLME 2561 * @priv: Private driver interface data 2562 * @data: IEEE 802.11 management frame with IEEE 802.11 header 2563 * @data_len: Size of the management frame 2564 * @noack: Do not wait for this frame to be acked (disable retries) 2565 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the 2566 * driver decide 2567 * @csa_offs: Array of CSA offsets or %NULL 2568 * @csa_offs_len: Number of elements in csa_offs 2569 * Returns: 0 on success, -1 on failure 2570 */ 2571 int (*send_mlme)(void *priv, const u8 *data, size_t data_len, 2572 int noack, unsigned int freq, const u16 *csa_offs, 2573 size_t csa_offs_len); 2574 2575 /** 2576 * update_ft_ies - Update FT (IEEE 802.11r) IEs 2577 * @priv: Private driver interface data 2578 * @md: Mobility domain (2 octets) (also included inside ies) 2579 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs 2580 * @ies_len: Length of FT IEs in bytes 2581 * Returns: 0 on success, -1 on failure 2582 * 2583 * The supplicant uses this callback to let the driver know that keying 2584 * material for FT is available and that the driver can use the 2585 * provided IEs in the next message in FT authentication sequence. 2586 * 2587 * This function is only needed for driver that support IEEE 802.11r 2588 * (Fast BSS Transition). 2589 */ 2590 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies, 2591 size_t ies_len); 2592 2593 /** 2594 * get_scan_results2 - Fetch the latest scan results 2595 * @priv: private driver interface data 2596 * 2597 * Returns: Allocated buffer of scan results (caller is responsible for 2598 * freeing the data structure) on success, NULL on failure 2599 */ 2600 struct wpa_scan_results * (*get_scan_results2)(void *priv); 2601 2602 /** 2603 * set_country - Set country 2604 * @priv: Private driver interface data 2605 * @alpha2: country to which to switch to 2606 * Returns: 0 on success, -1 on failure 2607 * 2608 * This function is for drivers which support some form 2609 * of setting a regulatory domain. 2610 */ 2611 int (*set_country)(void *priv, const char *alpha2); 2612 2613 /** 2614 * get_country - Get country 2615 * @priv: Private driver interface data 2616 * @alpha2: Buffer for returning country code (at least 3 octets) 2617 * Returns: 0 on success, -1 on failure 2618 */ 2619 int (*get_country)(void *priv, char *alpha2); 2620 2621 /** 2622 * global_init - Global driver initialization 2623 * @ctx: wpa_global pointer 2624 * Returns: Pointer to private data (global), %NULL on failure 2625 * 2626 * This optional function is called to initialize the driver wrapper 2627 * for global data, i.e., data that applies to all interfaces. If this 2628 * function is implemented, global_deinit() will also need to be 2629 * implemented to free the private data. The driver will also likely 2630 * use init2() function instead of init() to get the pointer to global 2631 * data available to per-interface initializer. 2632 */ 2633 void * (*global_init)(void *ctx); 2634 2635 /** 2636 * global_deinit - Global driver deinitialization 2637 * @priv: private driver global data from global_init() 2638 * 2639 * Terminate any global driver related functionality and free the 2640 * global data structure. 2641 */ 2642 void (*global_deinit)(void *priv); 2643 2644 /** 2645 * init2 - Initialize driver interface (with global data) 2646 * @ctx: context to be used when calling wpa_supplicant functions, 2647 * e.g., wpa_supplicant_event() 2648 * @ifname: interface name, e.g., wlan0 2649 * @global_priv: private driver global data from global_init() 2650 * Returns: Pointer to private data, %NULL on failure 2651 * 2652 * This function can be used instead of init() if the driver wrapper 2653 * uses global data. 2654 */ 2655 void * (*init2)(void *ctx, const char *ifname, void *global_priv); 2656 2657 /** 2658 * get_interfaces - Get information about available interfaces 2659 * @global_priv: private driver global data from global_init() 2660 * Returns: Allocated buffer of interface information (caller is 2661 * responsible for freeing the data structure) on success, NULL on 2662 * failure 2663 */ 2664 struct wpa_interface_info * (*get_interfaces)(void *global_priv); 2665 2666 /** 2667 * scan2 - Request the driver to initiate scan 2668 * @priv: private driver interface data 2669 * @params: Scan parameters 2670 * 2671 * Returns: 0 on success, -1 on failure 2672 * 2673 * Once the scan results are ready, the driver should report scan 2674 * results event for wpa_supplicant which will eventually request the 2675 * results with wpa_driver_get_scan_results2(). 2676 */ 2677 int (*scan2)(void *priv, struct wpa_driver_scan_params *params); 2678 2679 /** 2680 * authenticate - Request driver to authenticate 2681 * @priv: private driver interface data 2682 * @params: authentication parameters 2683 * Returns: 0 on success, -1 on failure 2684 * 2685 * This is an optional function that can be used with drivers that 2686 * support separate authentication and association steps, i.e., when 2687 * wpa_supplicant can act as the SME. If not implemented, associate() 2688 * function is expected to take care of IEEE 802.11 authentication, 2689 * too. 2690 */ 2691 int (*authenticate)(void *priv, 2692 struct wpa_driver_auth_params *params); 2693 2694 /** 2695 * set_ap - Set Beacon and Probe Response information for AP mode 2696 * @priv: Private driver interface data 2697 * @params: Parameters to use in AP mode 2698 * 2699 * This function is used to configure Beacon template and/or extra IEs 2700 * to add for Beacon and Probe Response frames for the driver in 2701 * AP mode. The driver is responsible for building the full Beacon 2702 * frame by concatenating the head part with TIM IE generated by the 2703 * driver/firmware and finishing with the tail part. Depending on the 2704 * driver architectue, this can be done either by using the full 2705 * template or the set of additional IEs (e.g., WPS and P2P IE). 2706 * Similarly, Probe Response processing depends on the driver design. 2707 * If the driver (or firmware) takes care of replying to Probe Request 2708 * frames, the extra IEs provided here needs to be added to the Probe 2709 * Response frames. 2710 * 2711 * Returns: 0 on success, -1 on failure 2712 */ 2713 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params); 2714 2715 /** 2716 * set_acl - Set ACL in AP mode 2717 * @priv: Private driver interface data 2718 * @params: Parameters to configure ACL 2719 * Returns: 0 on success, -1 on failure 2720 * 2721 * This is used only for the drivers which support MAC address ACL. 2722 */ 2723 int (*set_acl)(void *priv, struct hostapd_acl_params *params); 2724 2725 /** 2726 * hapd_init - Initialize driver interface (hostapd only) 2727 * @hapd: Pointer to hostapd context 2728 * @params: Configuration for the driver wrapper 2729 * Returns: Pointer to private data, %NULL on failure 2730 * 2731 * This function is used instead of init() or init2() when the driver 2732 * wrapper is used with hostapd. 2733 */ 2734 void * (*hapd_init)(struct hostapd_data *hapd, 2735 struct wpa_init_params *params); 2736 2737 /** 2738 * hapd_deinit - Deinitialize driver interface (hostapd only) 2739 * @priv: Private driver interface data from hapd_init() 2740 */ 2741 void (*hapd_deinit)(void *priv); 2742 2743 /** 2744 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only) 2745 * @priv: Private driver interface data 2746 * @params: BSS parameters 2747 * Returns: 0 on success, -1 on failure 2748 * 2749 * This is an optional function to configure the kernel driver to 2750 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This 2751 * can be left undefined (set to %NULL) if IEEE 802.1X support is 2752 * always enabled and the driver uses set_ap() to set WPA/RSN IE 2753 * for Beacon frames. 2754 * 2755 * DEPRECATED - use set_ap() instead 2756 */ 2757 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params); 2758 2759 /** 2760 * set_privacy - Enable/disable privacy (AP only) 2761 * @priv: Private driver interface data 2762 * @enabled: 1 = privacy enabled, 0 = disabled 2763 * Returns: 0 on success, -1 on failure 2764 * 2765 * This is an optional function to configure privacy field in the 2766 * kernel driver for Beacon frames. This can be left undefined (set to 2767 * %NULL) if the driver uses the Beacon template from set_ap(). 2768 * 2769 * DEPRECATED - use set_ap() instead 2770 */ 2771 int (*set_privacy)(void *priv, int enabled); 2772 2773 /** 2774 * get_seqnum - Fetch the current TSC/packet number (AP only) 2775 * @ifname: The interface name (main or virtual) 2776 * @priv: Private driver interface data 2777 * @addr: MAC address of the station or %NULL for group keys 2778 * @idx: Key index 2779 * @seq: Buffer for returning the latest used TSC/packet number 2780 * Returns: 0 on success, -1 on failure 2781 * 2782 * This function is used to fetch the last used TSC/packet number for 2783 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group 2784 * keys, so there is no strict requirement on implementing support for 2785 * unicast keys (i.e., addr != %NULL). 2786 */ 2787 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr, 2788 int idx, u8 *seq); 2789 2790 /** 2791 * flush - Flush all association stations (AP only) 2792 * @priv: Private driver interface data 2793 * Returns: 0 on success, -1 on failure 2794 * 2795 * This function requests the driver to disassociate all associated 2796 * stations. This function does not need to be implemented if the 2797 * driver does not process association frames internally. 2798 */ 2799 int (*flush)(void *priv); 2800 2801 /** 2802 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP) 2803 * @priv: Private driver interface data 2804 * @elem: Information elements 2805 * @elem_len: Length of the elem buffer in octets 2806 * Returns: 0 on success, -1 on failure 2807 * 2808 * This is an optional function to add information elements in the 2809 * kernel driver for Beacon and Probe Response frames. This can be left 2810 * undefined (set to %NULL) if the driver uses the Beacon template from 2811 * set_ap(). 2812 * 2813 * DEPRECATED - use set_ap() instead 2814 */ 2815 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len); 2816 2817 /** 2818 * read_sta_data - Fetch station data 2819 * @priv: Private driver interface data 2820 * @data: Buffer for returning station information 2821 * @addr: MAC address of the station 2822 * Returns: 0 on success, -1 on failure 2823 */ 2824 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data, 2825 const u8 *addr); 2826 2827 /** 2828 * hapd_send_eapol - Send an EAPOL packet (AP only) 2829 * @priv: private driver interface data 2830 * @addr: Destination MAC address 2831 * @data: EAPOL packet starting with IEEE 802.1X header 2832 * @data_len: Length of the EAPOL packet in octets 2833 * @encrypt: Whether the frame should be encrypted 2834 * @own_addr: Source MAC address 2835 * @flags: WPA_STA_* flags for the destination station 2836 * 2837 * Returns: 0 on success, -1 on failure 2838 */ 2839 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data, 2840 size_t data_len, int encrypt, 2841 const u8 *own_addr, u32 flags); 2842 2843 /** 2844 * sta_deauth - Deauthenticate a station (AP only) 2845 * @priv: Private driver interface data 2846 * @own_addr: Source address and BSSID for the Deauthentication frame 2847 * @addr: MAC address of the station to deauthenticate 2848 * @reason: Reason code for the Deauthentiation frame 2849 * Returns: 0 on success, -1 on failure 2850 * 2851 * This function requests a specific station to be deauthenticated and 2852 * a Deauthentication frame to be sent to it. 2853 */ 2854 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr, 2855 u16 reason); 2856 2857 /** 2858 * sta_disassoc - Disassociate a station (AP only) 2859 * @priv: Private driver interface data 2860 * @own_addr: Source address and BSSID for the Disassociation frame 2861 * @addr: MAC address of the station to disassociate 2862 * @reason: Reason code for the Disassociation frame 2863 * Returns: 0 on success, -1 on failure 2864 * 2865 * This function requests a specific station to be disassociated and 2866 * a Disassociation frame to be sent to it. 2867 */ 2868 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr, 2869 u16 reason); 2870 2871 /** 2872 * sta_remove - Remove a station entry (AP only) 2873 * @priv: Private driver interface data 2874 * @addr: MAC address of the station to be removed 2875 * Returns: 0 on success, -1 on failure 2876 */ 2877 int (*sta_remove)(void *priv, const u8 *addr); 2878 2879 /** 2880 * hapd_get_ssid - Get the current SSID (AP only) 2881 * @priv: Private driver interface data 2882 * @buf: Buffer for returning the SSID 2883 * @len: Maximum length of the buffer 2884 * Returns: Length of the SSID on success, -1 on failure 2885 * 2886 * This function need not be implemented if the driver uses Beacon 2887 * template from set_ap() and does not reply to Probe Request frames. 2888 */ 2889 int (*hapd_get_ssid)(void *priv, u8 *buf, int len); 2890 2891 /** 2892 * hapd_set_ssid - Set SSID (AP only) 2893 * @priv: Private driver interface data 2894 * @buf: SSID 2895 * @len: Length of the SSID in octets 2896 * Returns: 0 on success, -1 on failure 2897 * 2898 * DEPRECATED - use set_ap() instead 2899 */ 2900 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len); 2901 2902 /** 2903 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP) 2904 * @priv: Private driver interface data 2905 * @enabled: 1 = countermeasures enabled, 0 = disabled 2906 * Returns: 0 on success, -1 on failure 2907 * 2908 * This need not be implemented if the driver does not take care of 2909 * association processing. 2910 */ 2911 int (*hapd_set_countermeasures)(void *priv, int enabled); 2912 2913 /** 2914 * sta_add - Add a station entry 2915 * @priv: Private driver interface data 2916 * @params: Station parameters 2917 * Returns: 0 on success, -1 on failure 2918 * 2919 * This function is used to add or set (params->set 1) a station 2920 * entry in the driver. Adding STA entries is used only if the driver 2921 * does not take care of association processing. 2922 * 2923 * With drivers that don't support full AP client state, this function 2924 * is used to add a station entry to the driver once the station has 2925 * completed association. 2926 * 2927 * With TDLS, this function is used to add or set (params->set 1) 2928 * TDLS peer entries (even with drivers that do not support full AP 2929 * client state). 2930 */ 2931 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params); 2932 2933 /** 2934 * get_inact_sec - Get station inactivity duration (AP only) 2935 * @priv: Private driver interface data 2936 * @addr: Station address 2937 * Returns: Number of seconds station has been inactive, -1 on failure 2938 */ 2939 int (*get_inact_sec)(void *priv, const u8 *addr); 2940 2941 /** 2942 * sta_clear_stats - Clear station statistics (AP only) 2943 * @priv: Private driver interface data 2944 * @addr: Station address 2945 * Returns: 0 on success, -1 on failure 2946 */ 2947 int (*sta_clear_stats)(void *priv, const u8 *addr); 2948 2949 /** 2950 * set_freq - Set channel/frequency (AP only) 2951 * @priv: Private driver interface data 2952 * @freq: Channel parameters 2953 * Returns: 0 on success, -1 on failure 2954 */ 2955 int (*set_freq)(void *priv, struct hostapd_freq_params *freq); 2956 2957 /** 2958 * set_rts - Set RTS threshold 2959 * @priv: Private driver interface data 2960 * @rts: RTS threshold in octets 2961 * Returns: 0 on success, -1 on failure 2962 */ 2963 int (*set_rts)(void *priv, int rts); 2964 2965 /** 2966 * set_frag - Set fragmentation threshold 2967 * @priv: Private driver interface data 2968 * @frag: Fragmentation threshold in octets 2969 * Returns: 0 on success, -1 on failure 2970 */ 2971 int (*set_frag)(void *priv, int frag); 2972 2973 /** 2974 * sta_set_flags - Set station flags (AP only) 2975 * @priv: Private driver interface data 2976 * @addr: Station address 2977 * @total_flags: Bitmap of all WPA_STA_* flags currently set 2978 * @flags_or: Bitmap of WPA_STA_* flags to add 2979 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask 2980 * Returns: 0 on success, -1 on failure 2981 */ 2982 int (*sta_set_flags)(void *priv, const u8 *addr, 2983 unsigned int total_flags, unsigned int flags_or, 2984 unsigned int flags_and); 2985 2986 /** 2987 * sta_set_airtime_weight - Set station airtime weight (AP only) 2988 * @priv: Private driver interface data 2989 * @addr: Station address 2990 * @weight: New weight for station airtime assignment 2991 * Returns: 0 on success, -1 on failure 2992 */ 2993 int (*sta_set_airtime_weight)(void *priv, const u8 *addr, 2994 unsigned int weight); 2995 2996 /** 2997 * set_tx_queue_params - Set TX queue parameters 2998 * @priv: Private driver interface data 2999 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK) 3000 * @aifs: AIFS 3001 * @cw_min: cwMin 3002 * @cw_max: cwMax 3003 * @burst_time: Maximum length for bursting in 0.1 msec units 3004 */ 3005 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min, 3006 int cw_max, int burst_time); 3007 3008 /** 3009 * if_add - Add a virtual interface 3010 * @priv: Private driver interface data 3011 * @type: Interface type 3012 * @ifname: Interface name for the new virtual interface 3013 * @addr: Local address to use for the interface or %NULL to use the 3014 * parent interface address 3015 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces 3016 * @drv_priv: Pointer for overwriting the driver context or %NULL if 3017 * not allowed (applies only to %WPA_IF_AP_BSS type) 3018 * @force_ifname: Buffer for returning an interface name that the 3019 * driver ended up using if it differs from the requested ifname 3020 * @if_addr: Buffer for returning the allocated interface address 3021 * (this may differ from the requested addr if the driver cannot 3022 * change interface address) 3023 * @bridge: Bridge interface to use or %NULL if no bridge configured 3024 * @use_existing: Whether to allow existing interface to be used 3025 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces 3026 * Returns: 0 on success, -1 on failure 3027 */ 3028 int (*if_add)(void *priv, enum wpa_driver_if_type type, 3029 const char *ifname, const u8 *addr, void *bss_ctx, 3030 void **drv_priv, char *force_ifname, u8 *if_addr, 3031 const char *bridge, int use_existing, int setup_ap); 3032 3033 /** 3034 * if_remove - Remove a virtual interface 3035 * @priv: Private driver interface data 3036 * @type: Interface type 3037 * @ifname: Interface name of the virtual interface to be removed 3038 * Returns: 0 on success, -1 on failure 3039 */ 3040 int (*if_remove)(void *priv, enum wpa_driver_if_type type, 3041 const char *ifname); 3042 3043 /** 3044 * set_sta_vlan - Bind a station into a specific interface (AP only) 3045 * @priv: Private driver interface data 3046 * @ifname: Interface (main or virtual BSS or VLAN) 3047 * @addr: MAC address of the associated station 3048 * @vlan_id: VLAN ID 3049 * Returns: 0 on success, -1 on failure 3050 * 3051 * This function is used to bind a station to a specific virtual 3052 * interface. It is only used if when virtual interfaces are supported, 3053 * e.g., to assign stations to different VLAN interfaces based on 3054 * information from a RADIUS server. This allows separate broadcast 3055 * domains to be used with a single BSS. 3056 */ 3057 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname, 3058 int vlan_id); 3059 3060 /** 3061 * commit - Optional commit changes handler (AP only) 3062 * @priv: driver private data 3063 * Returns: 0 on success, -1 on failure 3064 * 3065 * This optional handler function can be registered if the driver 3066 * interface implementation needs to commit changes (e.g., by setting 3067 * network interface up) at the end of initial configuration. If set, 3068 * this handler will be called after initial setup has been completed. 3069 */ 3070 int (*commit)(void *priv); 3071 3072 /** 3073 * send_ether - Send an ethernet packet (AP only) 3074 * @priv: private driver interface data 3075 * @dst: Destination MAC address 3076 * @src: Source MAC address 3077 * @proto: Ethertype 3078 * @data: EAPOL packet starting with IEEE 802.1X header 3079 * @data_len: Length of the EAPOL packet in octets 3080 * Returns: 0 on success, -1 on failure 3081 */ 3082 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto, 3083 const u8 *data, size_t data_len); 3084 3085 /** 3086 * set_radius_acl_auth - Notification of RADIUS ACL change 3087 * @priv: Private driver interface data 3088 * @mac: MAC address of the station 3089 * @accepted: Whether the station was accepted 3090 * @session_timeout: Session timeout for the station 3091 * Returns: 0 on success, -1 on failure 3092 */ 3093 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted, 3094 u32 session_timeout); 3095 3096 /** 3097 * set_radius_acl_expire - Notification of RADIUS ACL expiration 3098 * @priv: Private driver interface data 3099 * @mac: MAC address of the station 3100 * Returns: 0 on success, -1 on failure 3101 */ 3102 int (*set_radius_acl_expire)(void *priv, const u8 *mac); 3103 3104 /** 3105 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP) 3106 * @priv: Private driver interface data 3107 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s) 3108 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove 3109 * extra IE(s) 3110 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL 3111 * to remove extra IE(s) 3112 * Returns: 0 on success, -1 on failure 3113 * 3114 * This is an optional function to add WPS IE in the kernel driver for 3115 * Beacon and Probe Response frames. This can be left undefined (set 3116 * to %NULL) if the driver uses the Beacon template from set_ap() 3117 * and does not process Probe Request frames. If the driver takes care 3118 * of (Re)Association frame processing, the assocresp buffer includes 3119 * WPS IE(s) that need to be added to (Re)Association Response frames 3120 * whenever a (Re)Association Request frame indicated use of WPS. 3121 * 3122 * This will also be used to add P2P IE(s) into Beacon/Probe Response 3123 * frames when operating as a GO. The driver is responsible for adding 3124 * timing related attributes (e.g., NoA) in addition to the IEs 3125 * included here by appending them after these buffers. This call is 3126 * also used to provide Probe Response IEs for P2P Listen state 3127 * operations for drivers that generate the Probe Response frames 3128 * internally. 3129 * 3130 * DEPRECATED - use set_ap() instead 3131 */ 3132 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon, 3133 const struct wpabuf *proberesp, 3134 const struct wpabuf *assocresp); 3135 3136 /** 3137 * set_supp_port - Set IEEE 802.1X Supplicant Port status 3138 * @priv: Private driver interface data 3139 * @authorized: Whether the port is authorized 3140 * Returns: 0 on success, -1 on failure 3141 */ 3142 int (*set_supp_port)(void *priv, int authorized); 3143 3144 /** 3145 * set_wds_sta - Bind a station into a 4-address WDS (AP only) 3146 * @priv: Private driver interface data 3147 * @addr: MAC address of the associated station 3148 * @aid: Association ID 3149 * @val: 1 = bind to 4-address WDS; 0 = unbind 3150 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL 3151 * to indicate that bridge is not to be used 3152 * @ifname_wds: Buffer to return the interface name for the new WDS 3153 * station or %NULL to indicate name is not returned. 3154 * Returns: 0 on success, -1 on failure 3155 */ 3156 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val, 3157 const char *bridge_ifname, char *ifname_wds); 3158 3159 /** 3160 * send_action - Transmit an Action frame 3161 * @priv: Private driver interface data 3162 * @freq: Frequency (in MHz) of the channel 3163 * @wait: Time to wait off-channel for a response (in ms), or zero 3164 * @dst: Destination MAC address (Address 1) 3165 * @src: Source MAC address (Address 2) 3166 * @bssid: BSSID (Address 3) 3167 * @data: Frame body 3168 * @data_len: data length in octets 3169 @ @no_cck: Whether CCK rates must not be used to transmit this frame 3170 * Returns: 0 on success, -1 on failure 3171 * 3172 * This command can be used to request the driver to transmit an action 3173 * frame to the specified destination. 3174 * 3175 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will 3176 * be transmitted on the given channel and the device will wait for a 3177 * response on that channel for the given wait time. 3178 * 3179 * If the flag is not set, the wait time will be ignored. In this case, 3180 * if a remain-on-channel duration is in progress, the frame must be 3181 * transmitted on that channel; alternatively the frame may be sent on 3182 * the current operational channel (if in associated state in station 3183 * mode or while operating as an AP.) 3184 * 3185 * If @src differs from the device MAC address, use of a random 3186 * transmitter address is requested for this message exchange. 3187 */ 3188 int (*send_action)(void *priv, unsigned int freq, unsigned int wait, 3189 const u8 *dst, const u8 *src, const u8 *bssid, 3190 const u8 *data, size_t data_len, int no_cck); 3191 3192 /** 3193 * send_action_cancel_wait - Cancel action frame TX wait 3194 * @priv: Private driver interface data 3195 * 3196 * This command cancels the wait time associated with sending an action 3197 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is 3198 * set in the driver flags. 3199 */ 3200 void (*send_action_cancel_wait)(void *priv); 3201 3202 /** 3203 * remain_on_channel - Remain awake on a channel 3204 * @priv: Private driver interface data 3205 * @freq: Frequency (in MHz) of the channel 3206 * @duration: Duration in milliseconds 3207 * Returns: 0 on success, -1 on failure 3208 * 3209 * This command is used to request the driver to remain awake on the 3210 * specified channel for the specified duration and report received 3211 * Action frames with EVENT_RX_MGMT events. Optionally, received 3212 * Probe Request frames may also be requested to be reported by calling 3213 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ. 3214 * 3215 * The driver may not be at the requested channel when this function 3216 * returns, i.e., the return code is only indicating whether the 3217 * request was accepted. The caller will need to wait until the 3218 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has 3219 * completed the channel change. This may take some time due to other 3220 * need for the radio and the caller should be prepared to timing out 3221 * its wait since there are no guarantees on when this request can be 3222 * executed. 3223 */ 3224 int (*remain_on_channel)(void *priv, unsigned int freq, 3225 unsigned int duration); 3226 3227 /** 3228 * cancel_remain_on_channel - Cancel remain-on-channel operation 3229 * @priv: Private driver interface data 3230 * 3231 * This command can be used to cancel a remain-on-channel operation 3232 * before its originally requested duration has passed. This could be 3233 * used, e.g., when remain_on_channel() is used to request extra time 3234 * to receive a response to an Action frame and the response is 3235 * received when there is still unneeded time remaining on the 3236 * remain-on-channel operation. 3237 */ 3238 int (*cancel_remain_on_channel)(void *priv); 3239 3240 /** 3241 * probe_req_report - Request Probe Request frames to be indicated 3242 * @priv: Private driver interface data 3243 * @report: Whether to report received Probe Request frames 3244 * Returns: 0 on success, -1 on failure (or if not supported) 3245 * 3246 * This command can be used to request the driver to indicate when 3247 * Probe Request frames are received with EVENT_RX_PROBE_REQ events. 3248 * Since this operation may require extra resources, e.g., due to less 3249 * optimal hardware/firmware RX filtering, many drivers may disable 3250 * Probe Request reporting at least in station mode. This command is 3251 * used to notify the driver when the Probe Request frames need to be 3252 * reported, e.g., during remain-on-channel operations. 3253 */ 3254 int (*probe_req_report)(void *priv, int report); 3255 3256 /** 3257 * deinit_ap - Deinitialize AP mode 3258 * @priv: Private driver interface data 3259 * Returns: 0 on success, -1 on failure (or if not supported) 3260 * 3261 * This optional function can be used to disable AP mode related 3262 * configuration. If the interface was not dynamically added, 3263 * change the driver mode to station mode to allow normal station 3264 * operations like scanning to be completed. 3265 */ 3266 int (*deinit_ap)(void *priv); 3267 3268 /** 3269 * deinit_p2p_cli - Deinitialize P2P client mode 3270 * @priv: Private driver interface data 3271 * Returns: 0 on success, -1 on failure (or if not supported) 3272 * 3273 * This optional function can be used to disable P2P client mode. If the 3274 * interface was not dynamically added, change the interface type back 3275 * to station mode. 3276 */ 3277 int (*deinit_p2p_cli)(void *priv); 3278 3279 /** 3280 * suspend - Notification on system suspend/hibernate event 3281 * @priv: Private driver interface data 3282 */ 3283 void (*suspend)(void *priv); 3284 3285 /** 3286 * resume - Notification on system resume/thaw event 3287 * @priv: Private driver interface data 3288 */ 3289 void (*resume)(void *priv); 3290 3291 /** 3292 * signal_monitor - Set signal monitoring parameters 3293 * @priv: Private driver interface data 3294 * @threshold: Threshold value for signal change events; 0 = disabled 3295 * @hysteresis: Minimum change in signal strength before indicating a 3296 * new event 3297 * Returns: 0 on success, -1 on failure (or if not supported) 3298 * 3299 * This function can be used to configure monitoring of signal strength 3300 * with the current AP. Whenever signal strength drops below the 3301 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event 3302 * should be generated assuming the signal strength has changed at 3303 * least %hysteresis from the previously indicated signal change event. 3304 */ 3305 int (*signal_monitor)(void *priv, int threshold, int hysteresis); 3306 3307 /** 3308 * send_frame - Send IEEE 802.11 frame (testing use only) 3309 * @priv: Private driver interface data 3310 * @data: IEEE 802.11 frame with IEEE 802.11 header 3311 * @data_len: Size of the frame 3312 * @encrypt: Whether to encrypt the frame (if keys are set) 3313 * Returns: 0 on success, -1 on failure 3314 * 3315 * This function is only used for debugging purposes and is not 3316 * required to be implemented for normal operations. 3317 */ 3318 int (*send_frame)(void *priv, const u8 *data, size_t data_len, 3319 int encrypt); 3320 3321 /** 3322 * get_noa - Get current Notice of Absence attribute payload 3323 * @priv: Private driver interface data 3324 * @buf: Buffer for returning NoA 3325 * @buf_len: Buffer length in octets 3326 * Returns: Number of octets used in buf, 0 to indicate no NoA is being 3327 * advertized, or -1 on failure 3328 * 3329 * This function is used to fetch the current Notice of Absence 3330 * attribute value from GO. 3331 */ 3332 int (*get_noa)(void *priv, u8 *buf, size_t buf_len); 3333 3334 /** 3335 * set_noa - Set Notice of Absence parameters for GO (testing) 3336 * @priv: Private driver interface data 3337 * @count: Count 3338 * @start: Start time in ms from next TBTT 3339 * @duration: Duration in ms 3340 * Returns: 0 on success or -1 on failure 3341 * 3342 * This function is used to set Notice of Absence parameters for GO. It 3343 * is used only for testing. To disable NoA, all parameters are set to 3344 * 0. 3345 */ 3346 int (*set_noa)(void *priv, u8 count, int start, int duration); 3347 3348 /** 3349 * set_p2p_powersave - Set P2P power save options 3350 * @priv: Private driver interface data 3351 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change 3352 * @opp_ps: 0 = disable, 1 = enable, -1 = no change 3353 * @ctwindow: 0.. = change (msec), -1 = no change 3354 * Returns: 0 on success or -1 on failure 3355 */ 3356 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps, 3357 int ctwindow); 3358 3359 /** 3360 * ampdu - Enable/disable aggregation 3361 * @priv: Private driver interface data 3362 * @ampdu: 1/0 = enable/disable A-MPDU aggregation 3363 * Returns: 0 on success or -1 on failure 3364 */ 3365 int (*ampdu)(void *priv, int ampdu); 3366 3367 /** 3368 * get_radio_name - Get physical radio name for the device 3369 * @priv: Private driver interface data 3370 * Returns: Radio name or %NULL if not known 3371 * 3372 * The returned data must not be modified by the caller. It is assumed 3373 * that any interface that has the same radio name as another is 3374 * sharing the same physical radio. This information can be used to 3375 * share scan results etc. information between the virtual interfaces 3376 * to speed up various operations. 3377 */ 3378 const char * (*get_radio_name)(void *priv); 3379 3380 /** 3381 * send_tdls_mgmt - for sending TDLS management packets 3382 * @priv: private driver interface data 3383 * @dst: Destination (peer) MAC address 3384 * @action_code: TDLS action code for the mssage 3385 * @dialog_token: Dialog Token to use in the message (if needed) 3386 * @status_code: Status Code or Reason Code to use (if needed) 3387 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield) 3388 * @initiator: Is the current end the TDLS link initiator 3389 * @buf: TDLS IEs to add to the message 3390 * @len: Length of buf in octets 3391 * Returns: 0 on success, negative (<0) on failure 3392 * 3393 * This optional function can be used to send packet to driver which is 3394 * responsible for receiving and sending all TDLS packets. 3395 */ 3396 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code, 3397 u8 dialog_token, u16 status_code, u32 peer_capab, 3398 int initiator, const u8 *buf, size_t len); 3399 3400 /** 3401 * tdls_oper - Ask the driver to perform high-level TDLS operations 3402 * @priv: Private driver interface data 3403 * @oper: TDLS high-level operation. See %enum tdls_oper 3404 * @peer: Destination (peer) MAC address 3405 * Returns: 0 on success, negative (<0) on failure 3406 * 3407 * This optional function can be used to send high-level TDLS commands 3408 * to the driver. 3409 */ 3410 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer); 3411 3412 /** 3413 * wnm_oper - Notify driver of the WNM frame reception 3414 * @priv: Private driver interface data 3415 * @oper: WNM operation. See %enum wnm_oper 3416 * @peer: Destination (peer) MAC address 3417 * @buf: Buffer for the driver to fill in (for getting IE) 3418 * @buf_len: Return the len of buf 3419 * Returns: 0 on success, negative (<0) on failure 3420 */ 3421 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer, 3422 u8 *buf, u16 *buf_len); 3423 3424 /** 3425 * set_qos_map - Set QoS Map 3426 * @priv: Private driver interface data 3427 * @qos_map_set: QoS Map 3428 * @qos_map_set_len: Length of QoS Map 3429 */ 3430 int (*set_qos_map)(void *priv, const u8 *qos_map_set, 3431 u8 qos_map_set_len); 3432 3433 /** 3434 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table 3435 * @priv: Private driver interface data 3436 * @version: IP version of the IP address, 4 or 6 3437 * @ipaddr: IP address for the neigh entry 3438 * @prefixlen: IP address prefix length 3439 * @addr: Corresponding MAC address 3440 * Returns: 0 on success, negative (<0) on failure 3441 */ 3442 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr, 3443 int prefixlen, const u8 *addr); 3444 3445 /** 3446 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table 3447 * @priv: Private driver interface data 3448 * @version: IP version of the IP address, 4 or 6 3449 * @ipaddr: IP address for the neigh entry 3450 * Returns: 0 on success, negative (<0) on failure 3451 */ 3452 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr); 3453 3454 /** 3455 * br_port_set_attr - Set a bridge port attribute 3456 * @attr: Bridge port attribute to set 3457 * @val: Value to be set 3458 * Returns: 0 on success, negative (<0) on failure 3459 */ 3460 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr, 3461 unsigned int val); 3462 3463 /** 3464 * br_port_set_attr - Set a bridge network parameter 3465 * @param: Bridge parameter to set 3466 * @val: Value to be set 3467 * Returns: 0 on success, negative (<0) on failure 3468 */ 3469 int (*br_set_net_param)(void *priv, enum drv_br_net_param param, 3470 unsigned int val); 3471 3472 /** 3473 * set_wowlan - Set wake-on-wireless triggers 3474 * @priv: Private driver interface data 3475 * @triggers: wowlan triggers 3476 */ 3477 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers); 3478 3479 /** 3480 * signal_poll - Get current connection information 3481 * @priv: Private driver interface data 3482 * @signal_info: Connection info structure 3483 */ 3484 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info); 3485 3486 /** 3487 * channel_info - Get parameters of the current operating channel 3488 * @priv: Private driver interface data 3489 * @channel_info: Channel info structure 3490 * Returns: 0 on success, negative (<0) on failure 3491 */ 3492 int (*channel_info)(void *priv, struct wpa_channel_info *channel_info); 3493 3494 /** 3495 * set_authmode - Set authentication algorithm(s) for static WEP 3496 * @priv: Private driver interface data 3497 * @authmode: 1=Open System, 2=Shared Key, 3=both 3498 * Returns: 0 on success, -1 on failure 3499 * 3500 * This function can be used to set authentication algorithms for AP 3501 * mode when static WEP is used. If the driver uses user space MLME/SME 3502 * implementation, there is no need to implement this function. 3503 * 3504 * DEPRECATED - use set_ap() instead 3505 */ 3506 int (*set_authmode)(void *priv, int authmode); 3507 3508#ifdef ANDROID 3509 /** 3510 * driver_cmd - Execute driver-specific command 3511 * @priv: Private driver interface data 3512 * @cmd: Command to execute 3513 * @buf: Return buffer 3514 * @buf_len: Buffer length 3515 * Returns: 0 on success, -1 on failure 3516 */ 3517 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len); 3518#endif /* ANDROID */ 3519 3520 /** 3521 * vendor_cmd - Execute vendor specific command 3522 * @priv: Private driver interface data 3523 * @vendor_id: Vendor id 3524 * @subcmd: Vendor command id 3525 * @data: Vendor command parameters (%NULL if no parameters) 3526 * @data_len: Data length 3527 * @buf: Return buffer (%NULL to ignore reply) 3528 * Returns: 0 on success, negative (<0) on failure 3529 * 3530 * This function handles vendor specific commands that are passed to 3531 * the driver/device. The command is identified by vendor id and 3532 * command id. Parameters can be passed as argument to the command 3533 * in the data buffer. Reply (if any) will be filled in the supplied 3534 * return buffer. 3535 * 3536 * The exact driver behavior is driver interface and vendor specific. As 3537 * an example, this will be converted to a vendor specific cfg80211 3538 * command in case of the nl80211 driver interface. 3539 */ 3540 int (*vendor_cmd)(void *priv, unsigned int vendor_id, 3541 unsigned int subcmd, const u8 *data, size_t data_len, 3542 struct wpabuf *buf); 3543 3544 /** 3545 * set_rekey_info - Set rekey information 3546 * @priv: Private driver interface data 3547 * @kek: Current KEK 3548 * @kek_len: KEK length in octets 3549 * @kck: Current KCK 3550 * @kck_len: KCK length in octets 3551 * @replay_ctr: Current EAPOL-Key Replay Counter 3552 * 3553 * This optional function can be used to provide information for the 3554 * driver/firmware to process EAPOL-Key frames in Group Key Handshake 3555 * while the host (including wpa_supplicant) is sleeping. 3556 */ 3557 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len, 3558 const u8 *kck, size_t kck_len, 3559 const u8 *replay_ctr); 3560 3561 /** 3562 * sta_assoc - Station association indication 3563 * @priv: Private driver interface data 3564 * @own_addr: Source address and BSSID for association frame 3565 * @addr: MAC address of the station to associate 3566 * @reassoc: flag to indicate re-association 3567 * @status: association response status code 3568 * @ie: assoc response ie buffer 3569 * @len: ie buffer length 3570 * Returns: 0 on success, -1 on failure 3571 * 3572 * This function indicates the driver to send (Re)Association 3573 * Response frame to the station. 3574 */ 3575 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr, 3576 int reassoc, u16 status, const u8 *ie, size_t len); 3577 3578 /** 3579 * sta_auth - Station authentication indication 3580 * @priv: private driver interface data 3581 * @params: Station authentication parameters 3582 * 3583 * Returns: 0 on success, -1 on failure 3584 */ 3585 int (*sta_auth)(void *priv, 3586 struct wpa_driver_sta_auth_params *params); 3587 3588 /** 3589 * add_tspec - Add traffic stream 3590 * @priv: Private driver interface data 3591 * @addr: MAC address of the station to associate 3592 * @tspec_ie: tspec ie buffer 3593 * @tspec_ielen: tspec ie length 3594 * Returns: 0 on success, -1 on failure 3595 * 3596 * This function adds the traffic steam for the station 3597 * and fills the medium_time in tspec_ie. 3598 */ 3599 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie, 3600 size_t tspec_ielen); 3601 3602 /** 3603 * add_sta_node - Add a station node in the driver 3604 * @priv: Private driver interface data 3605 * @addr: MAC address of the station to add 3606 * @auth_alg: authentication algorithm used by the station 3607 * Returns: 0 on success, -1 on failure 3608 * 3609 * This function adds the station node in the driver, when 3610 * the station gets added by FT-over-DS. 3611 */ 3612 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg); 3613 3614 /** 3615 * sched_scan - Request the driver to initiate scheduled scan 3616 * @priv: Private driver interface data 3617 * @params: Scan parameters 3618 * Returns: 0 on success, -1 on failure 3619 * 3620 * This operation should be used for scheduled scan offload to 3621 * the hardware. Every time scan results are available, the 3622 * driver should report scan results event for wpa_supplicant 3623 * which will eventually request the results with 3624 * wpa_driver_get_scan_results2(). This operation is optional 3625 * and if not provided or if it returns -1, we fall back to 3626 * normal host-scheduled scans. 3627 */ 3628 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params); 3629 3630 /** 3631 * stop_sched_scan - Request the driver to stop a scheduled scan 3632 * @priv: Private driver interface data 3633 * Returns: 0 on success, -1 on failure 3634 * 3635 * This should cause the scheduled scan to be stopped and 3636 * results should stop being sent. Must be supported if 3637 * sched_scan is supported. 3638 */ 3639 int (*stop_sched_scan)(void *priv); 3640 3641 /** 3642 * poll_client - Probe (null data or such) the given station 3643 * @priv: Private driver interface data 3644 * @own_addr: MAC address of sending interface 3645 * @addr: MAC address of the station to probe 3646 * @qos: Indicates whether station is QoS station 3647 * 3648 * This function is used to verify whether an associated station is 3649 * still present. This function does not need to be implemented if the 3650 * driver provides such inactivity polling mechanism. 3651 */ 3652 void (*poll_client)(void *priv, const u8 *own_addr, 3653 const u8 *addr, int qos); 3654 3655 /** 3656 * radio_disable - Disable/enable radio 3657 * @priv: Private driver interface data 3658 * @disabled: 1=disable 0=enable radio 3659 * Returns: 0 on success, -1 on failure 3660 * 3661 * This optional command is for testing purposes. It can be used to 3662 * disable the radio on a testbed device to simulate out-of-radio-range 3663 * conditions. 3664 */ 3665 int (*radio_disable)(void *priv, int disabled); 3666 3667 /** 3668 * switch_channel - Announce channel switch and migrate the GO to the 3669 * given frequency 3670 * @priv: Private driver interface data 3671 * @settings: Settings for CSA period and new channel 3672 * Returns: 0 on success, -1 on failure 3673 * 3674 * This function is used to move the GO to the legacy STA channel to 3675 * avoid frequency conflict in single channel concurrency. 3676 */ 3677 int (*switch_channel)(void *priv, struct csa_settings *settings); 3678 3679 /** 3680 * add_tx_ts - Add traffic stream 3681 * @priv: Private driver interface data 3682 * @tsid: Traffic stream ID 3683 * @addr: Receiver address 3684 * @user_prio: User priority of the traffic stream 3685 * @admitted_time: Admitted time for this TS in units of 3686 * 32 microsecond periods (per second). 3687 * Returns: 0 on success, -1 on failure 3688 */ 3689 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio, 3690 u16 admitted_time); 3691 3692 /** 3693 * del_tx_ts - Delete traffic stream 3694 * @priv: Private driver interface data 3695 * @tsid: Traffic stream ID 3696 * @addr: Receiver address 3697 * Returns: 0 on success, -1 on failure 3698 */ 3699 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr); 3700 3701 /** 3702 * Enable channel-switching with TDLS peer 3703 * @priv: Private driver interface data 3704 * @addr: MAC address of the TDLS peer 3705 * @oper_class: Operating class of the switch channel 3706 * @params: Channel specification 3707 * Returns: 0 on success, -1 on failure 3708 * 3709 * The function indicates to driver that it can start switching to a 3710 * different channel with a specified TDLS peer. The switching is 3711 * assumed on until canceled with tdls_disable_channel_switch(). 3712 */ 3713 int (*tdls_enable_channel_switch)( 3714 void *priv, const u8 *addr, u8 oper_class, 3715 const struct hostapd_freq_params *params); 3716 3717 /** 3718 * Disable channel switching with TDLS peer 3719 * @priv: Private driver interface data 3720 * @addr: MAC address of the TDLS peer 3721 * Returns: 0 on success, -1 on failure 3722 * 3723 * This function indicates to the driver that it should stop switching 3724 * with a given TDLS peer. 3725 */ 3726 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr); 3727 3728 /** 3729 * start_dfs_cac - Listen for radar interference on the channel 3730 * @priv: Private driver interface data 3731 * @freq: Channel parameters 3732 * Returns: 0 on success, -1 on failure 3733 */ 3734 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq); 3735 3736 /** 3737 * stop_ap - Removes beacon from AP 3738 * @priv: Private driver interface data 3739 * Returns: 0 on success, -1 on failure (or if not supported) 3740 * 3741 * This optional function can be used to disable AP mode related 3742 * configuration. Unlike deinit_ap, it does not change to station 3743 * mode. 3744 */ 3745 int (*stop_ap)(void *priv); 3746 3747 /** 3748 * get_survey - Retrieve survey data 3749 * @priv: Private driver interface data 3750 * @freq: If set, survey data for the specified frequency is only 3751 * being requested. If not set, all survey data is requested. 3752 * Returns: 0 on success, -1 on failure 3753 * 3754 * Use this to retrieve: 3755 * 3756 * - the observed channel noise floor 3757 * - the amount of time we have spent on the channel 3758 * - the amount of time during which we have spent on the channel that 3759 * the radio has determined the medium is busy and we cannot 3760 * transmit 3761 * - the amount of time we have spent receiving data 3762 * - the amount of time we have spent transmitting data 3763 * 3764 * This data can be used for spectrum heuristics. One example is 3765 * Automatic Channel Selection (ACS). The channel survey data is 3766 * kept on a linked list on the channel data, one entry is added 3767 * for each survey. The min_nf of the channel is updated for each 3768 * survey. 3769 */ 3770 int (*get_survey)(void *priv, unsigned int freq); 3771 3772 /** 3773 * status - Get driver interface status information 3774 * @priv: Private driver interface data 3775 * @buf: Buffer for printing the status information 3776 * @buflen: Maximum length of the buffer 3777 * Returns: Length of written status information or -1 on failure 3778 */ 3779 int (*status)(void *priv, char *buf, size_t buflen); 3780 3781 /** 3782 * roaming - Set roaming policy for driver-based BSS selection 3783 * @priv: Private driver interface data 3784 * @allowed: Whether roaming within ESS is allowed 3785 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set 3786 * Returns: Length of written status information or -1 on failure 3787 * 3788 * This optional callback can be used to update roaming policy from the 3789 * associate() command (bssid being set there indicates that the driver 3790 * should not roam before getting this roaming() call to allow roaming. 3791 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION 3792 * capability, roaming policy is handled within wpa_supplicant and there 3793 * is no need to implement or react to this callback. 3794 */ 3795 int (*roaming)(void *priv, int allowed, const u8 *bssid); 3796 3797 /** 3798 * disable_fils - Enable/disable FILS feature 3799 * @priv: Private driver interface data 3800 * @disable: 0-enable and 1-disable FILS feature 3801 * Returns: 0 on success, -1 on failure 3802 * 3803 * This callback can be used to configure driver and below layers to 3804 * enable/disable all FILS features. 3805 */ 3806 int (*disable_fils)(void *priv, int disable); 3807 3808 /** 3809 * set_mac_addr - Set MAC address 3810 * @priv: Private driver interface data 3811 * @addr: MAC address to use or %NULL for setting back to permanent 3812 * Returns: 0 on success, -1 on failure 3813 */ 3814 int (*set_mac_addr)(void *priv, const u8 *addr); 3815 3816#ifdef CONFIG_MACSEC 3817 int (*macsec_init)(void *priv, struct macsec_init_params *params); 3818 3819 int (*macsec_deinit)(void *priv); 3820 3821 /** 3822 * macsec_get_capability - Inform MKA of this driver's capability 3823 * @priv: Private driver interface data 3824 * @cap: Driver's capability 3825 * Returns: 0 on success, -1 on failure 3826 */ 3827 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap); 3828 3829 /** 3830 * enable_protect_frames - Set protect frames status 3831 * @priv: Private driver interface data 3832 * @enabled: TRUE = protect frames enabled 3833 * FALSE = protect frames disabled 3834 * Returns: 0 on success, -1 on failure (or if not supported) 3835 */ 3836 int (*enable_protect_frames)(void *priv, Boolean enabled); 3837 3838 /** 3839 * enable_encrypt - Set encryption status 3840 * @priv: Private driver interface data 3841 * @enabled: TRUE = encrypt outgoing traffic 3842 * FALSE = integrity-only protection on outgoing traffic 3843 * Returns: 0 on success, -1 on failure (or if not supported) 3844 */ 3845 int (*enable_encrypt)(void *priv, Boolean enabled); 3846 3847 /** 3848 * set_replay_protect - Set replay protect status and window size 3849 * @priv: Private driver interface data 3850 * @enabled: TRUE = replay protect enabled 3851 * FALSE = replay protect disabled 3852 * @window: replay window size, valid only when replay protect enabled 3853 * Returns: 0 on success, -1 on failure (or if not supported) 3854 */ 3855 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window); 3856 3857 /** 3858 * set_current_cipher_suite - Set current cipher suite 3859 * @priv: Private driver interface data 3860 * @cs: EUI64 identifier 3861 * Returns: 0 on success, -1 on failure (or if not supported) 3862 */ 3863 int (*set_current_cipher_suite)(void *priv, u64 cs); 3864 3865 /** 3866 * enable_controlled_port - Set controlled port status 3867 * @priv: Private driver interface data 3868 * @enabled: TRUE = controlled port enabled 3869 * FALSE = controlled port disabled 3870 * Returns: 0 on success, -1 on failure (or if not supported) 3871 */ 3872 int (*enable_controlled_port)(void *priv, Boolean enabled); 3873 3874 /** 3875 * get_receive_lowest_pn - Get receive lowest pn 3876 * @priv: Private driver interface data 3877 * @sa: secure association 3878 * Returns: 0 on success, -1 on failure (or if not supported) 3879 */ 3880 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa); 3881 3882 /** 3883 * get_transmit_next_pn - Get transmit next pn 3884 * @priv: Private driver interface data 3885 * @sa: secure association 3886 * Returns: 0 on success, -1 on failure (or if not supported) 3887 */ 3888 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa); 3889 3890 /** 3891 * set_transmit_next_pn - Set transmit next pn 3892 * @priv: Private driver interface data 3893 * @sa: secure association 3894 * Returns: 0 on success, -1 on failure (or if not supported) 3895 */ 3896 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa); 3897 3898 /** 3899 * set_receive_lowest_pn - Set receive lowest PN 3900 * @priv: Private driver interface data 3901 * @sa: secure association 3902 * Returns: 0 on success, -1 on failure (or if not supported) 3903 */ 3904 int (*set_receive_lowest_pn)(void *priv, struct receive_sa *sa); 3905 3906 /** 3907 * create_receive_sc - create secure channel for receiving 3908 * @priv: Private driver interface data 3909 * @sc: secure channel 3910 * @conf_offset: confidentiality offset (0, 30, or 50) 3911 * @validation: frame validation policy (0 = Disabled, 1 = Checked, 3912 * 2 = Strict) 3913 * Returns: 0 on success, -1 on failure (or if not supported) 3914 */ 3915 int (*create_receive_sc)(void *priv, struct receive_sc *sc, 3916 unsigned int conf_offset, 3917 int validation); 3918 3919 /** 3920 * delete_receive_sc - delete secure connection for receiving 3921 * @priv: private driver interface data from init() 3922 * @sc: secure channel 3923 * Returns: 0 on success, -1 on failure 3924 */ 3925 int (*delete_receive_sc)(void *priv, struct receive_sc *sc); 3926 3927 /** 3928 * create_receive_sa - create secure association for receive 3929 * @priv: private driver interface data from init() 3930 * @sa: secure association 3931 * Returns: 0 on success, -1 on failure 3932 */ 3933 int (*create_receive_sa)(void *priv, struct receive_sa *sa); 3934 3935 /** 3936 * delete_receive_sa - Delete secure association for receive 3937 * @priv: Private driver interface data from init() 3938 * @sa: Secure association 3939 * Returns: 0 on success, -1 on failure 3940 */ 3941 int (*delete_receive_sa)(void *priv, struct receive_sa *sa); 3942 3943 /** 3944 * enable_receive_sa - enable the SA for receive 3945 * @priv: private driver interface data from init() 3946 * @sa: secure association 3947 * Returns: 0 on success, -1 on failure 3948 */ 3949 int (*enable_receive_sa)(void *priv, struct receive_sa *sa); 3950 3951 /** 3952 * disable_receive_sa - disable SA for receive 3953 * @priv: private driver interface data from init() 3954 * @sa: secure association 3955 * Returns: 0 on success, -1 on failure 3956 */ 3957 int (*disable_receive_sa)(void *priv, struct receive_sa *sa); 3958 3959 /** 3960 * create_transmit_sc - create secure connection for transmit 3961 * @priv: private driver interface data from init() 3962 * @sc: secure channel 3963 * @conf_offset: confidentiality offset (0, 30, or 50) 3964 * Returns: 0 on success, -1 on failure 3965 */ 3966 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc, 3967 unsigned int conf_offset); 3968 3969 /** 3970 * delete_transmit_sc - delete secure connection for transmit 3971 * @priv: private driver interface data from init() 3972 * @sc: secure channel 3973 * Returns: 0 on success, -1 on failure 3974 */ 3975 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc); 3976 3977 /** 3978 * create_transmit_sa - create secure association for transmit 3979 * @priv: private driver interface data from init() 3980 * @sa: secure association 3981 * Returns: 0 on success, -1 on failure 3982 */ 3983 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa); 3984 3985 /** 3986 * delete_transmit_sa - Delete secure association for transmit 3987 * @priv: Private driver interface data from init() 3988 * @sa: Secure association 3989 * Returns: 0 on success, -1 on failure 3990 */ 3991 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa); 3992 3993 /** 3994 * enable_transmit_sa - enable SA for transmit 3995 * @priv: private driver interface data from init() 3996 * @sa: secure association 3997 * Returns: 0 on success, -1 on failure 3998 */ 3999 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa); 4000 4001 /** 4002 * disable_transmit_sa - disable SA for transmit 4003 * @priv: private driver interface data from init() 4004 * @sa: secure association 4005 * Returns: 0 on success, -1 on failure 4006 */ 4007 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa); 4008#endif /* CONFIG_MACSEC */ 4009 4010 /** 4011 * init_mesh - Driver specific initialization for mesh 4012 * @priv: Private driver interface data 4013 * Returns: 0 on success, -1 on failure 4014 */ 4015 int (*init_mesh)(void *priv); 4016 4017 /** 4018 * join_mesh - Join a mesh network 4019 * @priv: Private driver interface data 4020 * @params: Mesh configuration parameters 4021 * Returns: 0 on success, -1 on failure 4022 */ 4023 int (*join_mesh)(void *priv, 4024 struct wpa_driver_mesh_join_params *params); 4025 4026 /** 4027 * leave_mesh - Leave a mesh network 4028 * @priv: Private driver interface data 4029 * Returns 0 on success, -1 on failure 4030 */ 4031 int (*leave_mesh)(void *priv); 4032 4033 /** 4034 * probe_mesh_link - Inject a frame over direct mesh link to a given 4035 * peer skipping the next_hop lookup from mpath table. 4036 * @priv: Private driver interface data 4037 * @addr: Peer MAC address 4038 * @eth: Ethernet frame to be sent 4039 * @len: Ethernet frame lengtn in bytes 4040 * Returns 0 on success, -1 on failure 4041 */ 4042 int (*probe_mesh_link)(void *priv, const u8 *addr, const u8 *eth, 4043 size_t len); 4044 4045 /** 4046 * do_acs - Automatically select channel 4047 * @priv: Private driver interface data 4048 * @params: Parameters for ACS 4049 * Returns 0 on success, -1 on failure 4050 * 4051 * This command can be used to offload ACS to the driver if the driver 4052 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD). 4053 */ 4054 int (*do_acs)(void *priv, struct drv_acs_params *params); 4055 4056 /** 4057 * set_band - Notify driver of band selection 4058 * @priv: Private driver interface data 4059 * @band: The selected band(s) 4060 * Returns 0 on success, -1 on failure 4061 */ 4062 int (*set_band)(void *priv, enum set_band band); 4063 4064 /** 4065 * get_pref_freq_list - Get preferred frequency list for an interface 4066 * @priv: Private driver interface data 4067 * @if_type: Interface type 4068 * @num: Number of channels 4069 * @freq_list: Preferred channel frequency list encoded in MHz values 4070 * Returns 0 on success, -1 on failure 4071 * 4072 * This command can be used to query the preferred frequency list from 4073 * the driver specific to a particular interface type. 4074 */ 4075 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type, 4076 unsigned int *num, unsigned int *freq_list); 4077 4078 /** 4079 * set_prob_oper_freq - Indicate probable P2P operating channel 4080 * @priv: Private driver interface data 4081 * @freq: Channel frequency in MHz 4082 * Returns 0 on success, -1 on failure 4083 * 4084 * This command can be used to inform the driver of the operating 4085 * frequency that an ongoing P2P group formation is likely to come up 4086 * on. Local device is assuming P2P Client role. 4087 */ 4088 int (*set_prob_oper_freq)(void *priv, unsigned int freq); 4089 4090 /** 4091 * abort_scan - Request the driver to abort an ongoing scan 4092 * @priv: Private driver interface data 4093 * @scan_cookie: Cookie identifying the scan request. This is used only 4094 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN 4095 * was used to trigger scan. Otherwise, 0 is used. 4096 * Returns 0 on success, -1 on failure 4097 */ 4098 int (*abort_scan)(void *priv, u64 scan_cookie); 4099 4100 /** 4101 * configure_data_frame_filters - Request to configure frame filters 4102 * @priv: Private driver interface data 4103 * @filter_flags: The type of frames to filter (bitfield of 4104 * WPA_DATA_FRAME_FILTER_FLAG_*) 4105 * Returns: 0 on success or -1 on failure 4106 */ 4107 int (*configure_data_frame_filters)(void *priv, u32 filter_flags); 4108 4109 /** 4110 * get_ext_capab - Get extended capabilities for the specified interface 4111 * @priv: Private driver interface data 4112 * @type: Interface type for which to get extended capabilities 4113 * @ext_capab: Extended capabilities fetched 4114 * @ext_capab_mask: Extended capabilities mask 4115 * @ext_capab_len: Length of the extended capabilities 4116 * Returns: 0 on success or -1 on failure 4117 */ 4118 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type, 4119 const u8 **ext_capab, const u8 **ext_capab_mask, 4120 unsigned int *ext_capab_len); 4121 4122 /** 4123 * p2p_lo_start - Start offloading P2P listen to device 4124 * @priv: Private driver interface data 4125 * @freq: Listening frequency (MHz) for P2P listen 4126 * @period: Length of the listen operation in milliseconds 4127 * @interval: Interval for running the listen operation in milliseconds 4128 * @count: Number of times to run the listen operation 4129 * @device_types: Device primary and secondary types 4130 * @dev_types_len: Number of bytes for device_types 4131 * @ies: P2P IE and WSC IE for Probe Response frames 4132 * @ies_len: Length of ies in bytes 4133 * Returns: 0 on success or -1 on failure 4134 */ 4135 int (*p2p_lo_start)(void *priv, unsigned int freq, 4136 unsigned int period, unsigned int interval, 4137 unsigned int count, 4138 const u8 *device_types, size_t dev_types_len, 4139 const u8 *ies, size_t ies_len); 4140 4141 /** 4142 * p2p_lo_stop - Stop P2P listen offload 4143 * @priv: Private driver interface data 4144 * Returns: 0 on success or -1 on failure 4145 */ 4146 int (*p2p_lo_stop)(void *priv); 4147 4148 /** 4149 * set_default_scan_ies - Set default scan IEs 4150 * @priv: Private driver interface data 4151 * @ies: Scan default IEs buffer 4152 * @ies_len: Length of IEs in bytes 4153 * Returns: 0 on success or -1 on failure 4154 * 4155 * The driver can use these by default when there are no scan IEs coming 4156 * in the subsequent scan requests. Also in case of one or more of IEs 4157 * given in set_default_scan_ies() are missing in the subsequent scan 4158 * request, the driver should merge the missing scan IEs in the scan 4159 * request from the IEs set by set_default_scan_ies() in the Probe 4160 * Request frames sent. 4161 */ 4162 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len); 4163 4164 /** 4165 * set_tdls_mode - Set TDLS trigger mode to the host driver 4166 * @priv: Private driver interface data 4167 * @tdls_external_control: Represents if TDLS external trigger control 4168 * mode is enabled/disabled. 4169 * 4170 * This optional callback can be used to configure the TDLS external 4171 * trigger control mode to the host driver. 4172 */ 4173 int (*set_tdls_mode)(void *priv, int tdls_external_control); 4174 4175 /** 4176 * get_bss_transition_status - Get candidate BSS's transition status 4177 * @priv: Private driver interface data 4178 * @params: Candidate BSS list 4179 * 4180 * Get the accept or reject reason code for a list of BSS transition 4181 * candidates. 4182 */ 4183 struct wpa_bss_candidate_info * 4184 (*get_bss_transition_status)(void *priv, 4185 struct wpa_bss_trans_info *params); 4186 /** 4187 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow 4188 * @priv: Private driver interface data 4189 * @ignore_disallow: 0 to not ignore, 1 to ignore 4190 * Returns: 0 on success, -1 on failure 4191 */ 4192 int (*ignore_assoc_disallow)(void *priv, int ignore_disallow); 4193 4194 /** 4195 * set_bssid_blacklist - Set blacklist of BSSIDs to the driver 4196 * @priv: Private driver interface data 4197 * @num_bssid: Number of blacklist BSSIDs 4198 * @bssids: List of blacklisted BSSIDs 4199 */ 4200 int (*set_bssid_blacklist)(void *priv, unsigned int num_bssid, 4201 const u8 *bssid); 4202 4203 /** 4204 * update_connect_params - Update the connection parameters 4205 * @priv: Private driver interface data 4206 * @params: Association parameters 4207 * @mask: Bit mask indicating which parameters in @params have to be 4208 * updated 4209 * Returns: 0 on success, -1 on failure 4210 * 4211 * Update the connection parameters when in connected state so that the 4212 * driver uses the updated parameters for subsequent roaming. This is 4213 * used only with drivers that implement internal BSS selection and 4214 * roaming. 4215 */ 4216 int (*update_connect_params)( 4217 void *priv, struct wpa_driver_associate_params *params, 4218 enum wpa_drv_update_connect_params_mask mask); 4219 4220 /** 4221 * send_external_auth_status - Indicate the status of external 4222 * authentication processing to the host driver. 4223 * @priv: Private driver interface data 4224 * @params: Status of authentication processing. 4225 * Returns: 0 on success, -1 on failure 4226 */ 4227 int (*send_external_auth_status)(void *priv, 4228 struct external_auth *params); 4229 4230 /** 4231 * set_4addr_mode - Set 4-address mode 4232 * @priv: Private driver interface data 4233 * @bridge_ifname: Bridge interface name 4234 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode 4235 * Returns: 0 on success, < 0 on failure 4236 */ 4237 int (*set_4addr_mode)(void *priv, const char *bridge_ifname, int val); 4238 4239 /** 4240 * update_dh_ie - Update DH IE 4241 * @priv: Private driver interface data 4242 * @peer_mac: Peer MAC address 4243 * @reason_code: Reacon code 4244 * @ie: DH IE 4245 * @ie_len: DH IE length in bytes 4246 * Returns: 0 on success, -1 on failure 4247 * 4248 * This callback is used to let the driver know the DH processing result 4249 * and DH IE for a pending association. 4250 */ 4251 int (*update_dh_ie)(void *priv, const u8 *peer_mac, u16 reason_code, 4252 const u8 *ie, size_t ie_len); 4253}; 4254 4255/** 4256 * enum wpa_event_type - Event type for wpa_supplicant_event() calls 4257 */ 4258enum wpa_event_type { 4259 /** 4260 * EVENT_ASSOC - Association completed 4261 * 4262 * This event needs to be delivered when the driver completes IEEE 4263 * 802.11 association or reassociation successfully. 4264 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID 4265 * after this event has been generated. In addition, optional 4266 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide 4267 * more information about the association. If the driver interface gets 4268 * both of these events at the same time, it can also include the 4269 * assoc_info data in EVENT_ASSOC call. 4270 */ 4271 EVENT_ASSOC, 4272 4273 /** 4274 * EVENT_DISASSOC - Association lost 4275 * 4276 * This event should be called when association is lost either due to 4277 * receiving deauthenticate or disassociate frame from the AP or when 4278 * sending either of these frames to the current AP. If the driver 4279 * supports separate deauthentication event, EVENT_DISASSOC should only 4280 * be used for disassociation and EVENT_DEAUTH for deauthentication. 4281 * In AP mode, union wpa_event_data::disassoc_info is required. 4282 */ 4283 EVENT_DISASSOC, 4284 4285 /** 4286 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected 4287 * 4288 * This event must be delivered when a Michael MIC error is detected by 4289 * the local driver. Additional data for event processing is 4290 * provided with union wpa_event_data::michael_mic_failure. This 4291 * information is used to request new encyption key and to initiate 4292 * TKIP countermeasures if needed. 4293 */ 4294 EVENT_MICHAEL_MIC_FAILURE, 4295 4296 /** 4297 * EVENT_SCAN_RESULTS - Scan results available 4298 * 4299 * This event must be called whenever scan results are available to be 4300 * fetched with struct wpa_driver_ops::get_scan_results(). This event 4301 * is expected to be used some time after struct wpa_driver_ops::scan() 4302 * is called. If the driver provides an unsolicited event when the scan 4303 * has been completed, this event can be used to trigger 4304 * EVENT_SCAN_RESULTS call. If such event is not available from the 4305 * driver, the driver wrapper code is expected to use a registered 4306 * timeout to generate EVENT_SCAN_RESULTS call after the time that the 4307 * scan is expected to be completed. Optional information about 4308 * completed scan can be provided with union wpa_event_data::scan_info. 4309 */ 4310 EVENT_SCAN_RESULTS, 4311 4312 /** 4313 * EVENT_ASSOCINFO - Report optional extra information for association 4314 * 4315 * This event can be used to report extra association information for 4316 * EVENT_ASSOC processing. This extra information includes IEs from 4317 * association frames and Beacon/Probe Response frames in union 4318 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before 4319 * EVENT_ASSOC. Alternatively, the driver interface can include 4320 * assoc_info data in the EVENT_ASSOC call if it has all the 4321 * information available at the same point. 4322 */ 4323 EVENT_ASSOCINFO, 4324 4325 /** 4326 * EVENT_INTERFACE_STATUS - Report interface status changes 4327 * 4328 * This optional event can be used to report changes in interface 4329 * status (interface added/removed) using union 4330 * wpa_event_data::interface_status. This can be used to trigger 4331 * wpa_supplicant to stop and re-start processing for the interface, 4332 * e.g., when a cardbus card is ejected/inserted. 4333 */ 4334 EVENT_INTERFACE_STATUS, 4335 4336 /** 4337 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication 4338 * 4339 * This event can be used to inform wpa_supplicant about candidates for 4340 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible 4341 * for scan request (ap_scan=2 mode), this event is required for 4342 * pre-authentication. If wpa_supplicant is performing scan request 4343 * (ap_scan=1), this event is optional since scan results can be used 4344 * to add pre-authentication candidates. union 4345 * wpa_event_data::pmkid_candidate is used to report the BSSID of the 4346 * candidate and priority of the candidate, e.g., based on the signal 4347 * strength, in order to try to pre-authenticate first with candidates 4348 * that are most likely targets for re-association. 4349 * 4350 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates 4351 * on the candidate list. In addition, it can be called for the current 4352 * AP and APs that have existing PMKSA cache entries. wpa_supplicant 4353 * will automatically skip pre-authentication in cases where a valid 4354 * PMKSA exists. When more than one candidate exists, this event should 4355 * be generated once for each candidate. 4356 * 4357 * Driver will be notified about successful pre-authentication with 4358 * struct wpa_driver_ops::add_pmkid() calls. 4359 */ 4360 EVENT_PMKID_CANDIDATE, 4361 4362 /** 4363 * EVENT_TDLS - Request TDLS operation 4364 * 4365 * This event can be used to request a TDLS operation to be performed. 4366 */ 4367 EVENT_TDLS, 4368 4369 /** 4370 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs 4371 * 4372 * The driver is expected to report the received FT IEs from 4373 * FT authentication sequence from the AP. The FT IEs are included in 4374 * the extra information in union wpa_event_data::ft_ies. 4375 */ 4376 EVENT_FT_RESPONSE, 4377 4378 /** 4379 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS 4380 * 4381 * The driver can use this event to inform wpa_supplicant about a STA 4382 * in an IBSS with which protected frames could be exchanged. This 4383 * event starts RSN authentication with the other STA to authenticate 4384 * the STA and set up encryption keys with it. 4385 */ 4386 EVENT_IBSS_RSN_START, 4387 4388 /** 4389 * EVENT_AUTH - Authentication result 4390 * 4391 * This event should be called when authentication attempt has been 4392 * completed. This is only used if the driver supports separate 4393 * authentication step (struct wpa_driver_ops::authenticate). 4394 * Information about authentication result is included in 4395 * union wpa_event_data::auth. 4396 */ 4397 EVENT_AUTH, 4398 4399 /** 4400 * EVENT_DEAUTH - Authentication lost 4401 * 4402 * This event should be called when authentication is lost either due 4403 * to receiving deauthenticate frame from the AP or when sending that 4404 * frame to the current AP. 4405 * In AP mode, union wpa_event_data::deauth_info is required. 4406 */ 4407 EVENT_DEAUTH, 4408 4409 /** 4410 * EVENT_ASSOC_REJECT - Association rejected 4411 * 4412 * This event should be called when (re)association attempt has been 4413 * rejected by the AP. Information about the association response is 4414 * included in union wpa_event_data::assoc_reject. 4415 */ 4416 EVENT_ASSOC_REJECT, 4417 4418 /** 4419 * EVENT_AUTH_TIMED_OUT - Authentication timed out 4420 */ 4421 EVENT_AUTH_TIMED_OUT, 4422 4423 /** 4424 * EVENT_ASSOC_TIMED_OUT - Association timed out 4425 */ 4426 EVENT_ASSOC_TIMED_OUT, 4427 4428 /** 4429 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS 4430 */ 4431 EVENT_WPS_BUTTON_PUSHED, 4432 4433 /** 4434 * EVENT_TX_STATUS - Report TX status 4435 */ 4436 EVENT_TX_STATUS, 4437 4438 /** 4439 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA 4440 */ 4441 EVENT_RX_FROM_UNKNOWN, 4442 4443 /** 4444 * EVENT_RX_MGMT - Report RX of a management frame 4445 */ 4446 EVENT_RX_MGMT, 4447 4448 /** 4449 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started 4450 * 4451 * This event is used to indicate when the driver has started the 4452 * requested remain-on-channel duration. Information about the 4453 * operation is included in union wpa_event_data::remain_on_channel. 4454 */ 4455 EVENT_REMAIN_ON_CHANNEL, 4456 4457 /** 4458 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out 4459 * 4460 * This event is used to indicate when the driver has completed 4461 * remain-on-channel duration, i.e., may noot be available on the 4462 * requested channel anymore. Information about the 4463 * operation is included in union wpa_event_data::remain_on_channel. 4464 */ 4465 EVENT_CANCEL_REMAIN_ON_CHANNEL, 4466 4467 /** 4468 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame 4469 * 4470 * This event is used to indicate when a Probe Request frame has been 4471 * received. Information about the received frame is included in 4472 * union wpa_event_data::rx_probe_req. The driver is required to report 4473 * these events only after successfully completed probe_req_report() 4474 * commands to request the events (i.e., report parameter is non-zero) 4475 * in station mode. In AP mode, Probe Request frames should always be 4476 * reported. 4477 */ 4478 EVENT_RX_PROBE_REQ, 4479 4480 /** 4481 * EVENT_NEW_STA - New wired device noticed 4482 * 4483 * This event is used to indicate that a new device has been detected 4484 * in a network that does not use association-like functionality (i.e., 4485 * mainly wired Ethernet). This can be used to start EAPOL 4486 * authenticator when receiving a frame from a device. The address of 4487 * the device is included in union wpa_event_data::new_sta. 4488 */ 4489 EVENT_NEW_STA, 4490 4491 /** 4492 * EVENT_EAPOL_RX - Report received EAPOL frame 4493 * 4494 * When in AP mode with hostapd, this event is required to be used to 4495 * deliver the receive EAPOL frames from the driver. 4496 */ 4497 EVENT_EAPOL_RX, 4498 4499 /** 4500 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength 4501 * 4502 * This event is used to indicate changes in the signal strength 4503 * observed in frames received from the current AP if signal strength 4504 * monitoring has been enabled with signal_monitor(). 4505 */ 4506 EVENT_SIGNAL_CHANGE, 4507 4508 /** 4509 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled 4510 * 4511 * This event is used to indicate that the interface was enabled after 4512 * having been previously disabled, e.g., due to rfkill. 4513 */ 4514 EVENT_INTERFACE_ENABLED, 4515 4516 /** 4517 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled 4518 * 4519 * This event is used to indicate that the interface was disabled, 4520 * e.g., due to rfkill. 4521 */ 4522 EVENT_INTERFACE_DISABLED, 4523 4524 /** 4525 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed 4526 * 4527 * This event is used to indicate that the channel list has changed, 4528 * e.g., because of a regulatory domain change triggered by scan 4529 * results including an AP advertising a country code. 4530 */ 4531 EVENT_CHANNEL_LIST_CHANGED, 4532 4533 /** 4534 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable 4535 * 4536 * This event is used to indicate that the driver cannot maintain this 4537 * interface in its operation mode anymore. The most likely use for 4538 * this is to indicate that AP mode operation is not available due to 4539 * operating channel would need to be changed to a DFS channel when 4540 * the driver does not support radar detection and another virtual 4541 * interfaces caused the operating channel to change. Other similar 4542 * resource conflicts could also trigger this for station mode 4543 * interfaces. This event can be propagated when channel switching 4544 * fails. 4545 */ 4546 EVENT_INTERFACE_UNAVAILABLE, 4547 4548 /** 4549 * EVENT_BEST_CHANNEL 4550 * 4551 * Driver generates this event whenever it detects a better channel 4552 * (e.g., based on RSSI or channel use). This information can be used 4553 * to improve channel selection for a new AP/P2P group. 4554 */ 4555 EVENT_BEST_CHANNEL, 4556 4557 /** 4558 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received 4559 * 4560 * This event should be called when a Deauthentication frame is dropped 4561 * due to it not being protected (MFP/IEEE 802.11w). 4562 * union wpa_event_data::unprot_deauth is required to provide more 4563 * details of the frame. 4564 */ 4565 EVENT_UNPROT_DEAUTH, 4566 4567 /** 4568 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received 4569 * 4570 * This event should be called when a Disassociation frame is dropped 4571 * due to it not being protected (MFP/IEEE 802.11w). 4572 * union wpa_event_data::unprot_disassoc is required to provide more 4573 * details of the frame. 4574 */ 4575 EVENT_UNPROT_DISASSOC, 4576 4577 /** 4578 * EVENT_STATION_LOW_ACK 4579 * 4580 * Driver generates this event whenever it detected that a particular 4581 * station was lost. Detection can be through massive transmission 4582 * failures for example. 4583 */ 4584 EVENT_STATION_LOW_ACK, 4585 4586 /** 4587 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore 4588 */ 4589 EVENT_IBSS_PEER_LOST, 4590 4591 /** 4592 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey 4593 * 4594 * This event carries the new replay counter to notify wpa_supplicant 4595 * of the current EAPOL-Key Replay Counter in case the driver/firmware 4596 * completed Group Key Handshake while the host (including 4597 * wpa_supplicant was sleeping). 4598 */ 4599 EVENT_DRIVER_GTK_REKEY, 4600 4601 /** 4602 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped 4603 */ 4604 EVENT_SCHED_SCAN_STOPPED, 4605 4606 /** 4607 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll 4608 * 4609 * This event indicates that the station responded to the poll 4610 * initiated with @poll_client. 4611 */ 4612 EVENT_DRIVER_CLIENT_POLL_OK, 4613 4614 /** 4615 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status 4616 */ 4617 EVENT_EAPOL_TX_STATUS, 4618 4619 /** 4620 * EVENT_CH_SWITCH - AP or GO decided to switch channels 4621 * 4622 * Described in wpa_event_data.ch_switch 4623 * */ 4624 EVENT_CH_SWITCH, 4625 4626 /** 4627 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels 4628 * 4629 * This is a pre-switch event indicating the shortly following switch 4630 * of operating channels. 4631 * 4632 * Described in wpa_event_data.ch_switch 4633 */ 4634 EVENT_CH_SWITCH_STARTED, 4635 /** 4636 * EVENT_WNM - Request WNM operation 4637 * 4638 * This event can be used to request a WNM operation to be performed. 4639 */ 4640 EVENT_WNM, 4641 4642 /** 4643 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode 4644 * 4645 * This event indicates that the driver reported a connection failure 4646 * with the specified client (for example, max client reached, etc.) in 4647 * AP mode. 4648 */ 4649 EVENT_CONNECT_FAILED_REASON, 4650 4651 /** 4652 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection 4653 * 4654 * A radar has been detected on the supplied frequency, hostapd should 4655 * react accordingly (e.g., change channel). 4656 */ 4657 EVENT_DFS_RADAR_DETECTED, 4658 4659 /** 4660 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed 4661 * 4662 * After a successful CAC, the channel can be marked clear and used. 4663 */ 4664 EVENT_DFS_CAC_FINISHED, 4665 4666 /** 4667 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted 4668 * 4669 * The CAC was not successful, and the channel remains in the previous 4670 * state. This may happen due to a radar being detected or other 4671 * external influences. 4672 */ 4673 EVENT_DFS_CAC_ABORTED, 4674 4675 /** 4676 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over 4677 * 4678 * The channel which was previously unavailable is now available again. 4679 */ 4680 EVENT_DFS_NOP_FINISHED, 4681 4682 /** 4683 * EVENT_SURVEY - Received survey data 4684 * 4685 * This event gets triggered when a driver query is issued for survey 4686 * data and the requested data becomes available. The returned data is 4687 * stored in struct survey_results. The results provide at most one 4688 * survey entry for each frequency and at minimum will provide one 4689 * survey entry for one frequency. The survey data can be os_malloc()'d 4690 * and then os_free()'d, so the event callback must only copy data. 4691 */ 4692 EVENT_SURVEY, 4693 4694 /** 4695 * EVENT_SCAN_STARTED - Scan started 4696 * 4697 * This indicates that driver has started a scan operation either based 4698 * on a request from wpa_supplicant/hostapd or from another application. 4699 * EVENT_SCAN_RESULTS is used to indicate when the scan has been 4700 * completed (either successfully or by getting cancelled). 4701 */ 4702 EVENT_SCAN_STARTED, 4703 4704 /** 4705 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range 4706 * 4707 * This event indicates a set of frequency ranges that should be avoided 4708 * to reduce issues due to interference or internal co-existence 4709 * information in the driver. 4710 */ 4711 EVENT_AVOID_FREQUENCIES, 4712 4713 /** 4714 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification 4715 */ 4716 EVENT_NEW_PEER_CANDIDATE, 4717 4718 /** 4719 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS 4720 * 4721 * Indicates a pair of primary and secondary channels chosen by ACS 4722 * in device. 4723 */ 4724 EVENT_ACS_CHANNEL_SELECTED, 4725 4726 /** 4727 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has 4728 * been started. 4729 * 4730 * This event indicates that channel availability check has been started 4731 * on a DFS frequency by a driver that supports DFS Offload. 4732 */ 4733 EVENT_DFS_CAC_STARTED, 4734 4735 /** 4736 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped 4737 */ 4738 EVENT_P2P_LO_STOP, 4739 4740 /** 4741 * EVENT_BEACON_LOSS - Beacon loss detected 4742 * 4743 * This event indicates that no Beacon frames has been received from 4744 * the current AP. This may indicate that the AP is not anymore in 4745 * range. 4746 */ 4747 EVENT_BEACON_LOSS, 4748 4749 /** 4750 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check 4751 * done previously (Pre-CAC) on the channel has expired. This would 4752 * normally be on a non-ETSI DFS regulatory domain. DFS state of the 4753 * channel will be moved from available to usable. A new CAC has to be 4754 * performed before start operating on this channel. 4755 */ 4756 EVENT_DFS_PRE_CAC_EXPIRED, 4757 4758 /** 4759 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers 4760 * that do not define separate commands for authentication and 4761 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11 4762 * authentication to wpa_supplicant. This event carries all the 4763 * necessary information from the host driver for the authentication to 4764 * happen. 4765 */ 4766 EVENT_EXTERNAL_AUTH, 4767 4768 /** 4769 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized 4770 * 4771 * This event should be indicated when the driver completes the 4-way 4772 * handshake. This event should be preceded by an EVENT_ASSOC that 4773 * indicates the completion of IEEE 802.11 association. 4774 */ 4775 EVENT_PORT_AUTHORIZED, 4776 4777 /** 4778 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode 4779 * change event. 4780 */ 4781 EVENT_STATION_OPMODE_CHANGED, 4782 4783 /** 4784 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed 4785 * 4786 * This event is emitted when the MAC changes while the interface is 4787 * enabled. When an interface was disabled and becomes enabled, it 4788 * must be always assumed that the MAC possibly changed. 4789 */ 4790 EVENT_INTERFACE_MAC_CHANGED, 4791 4792 /** 4793 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status 4794 * 4795 * This event is emitted when an interface is added/removed for WDS STA. 4796 */ 4797 EVENT_WDS_STA_INTERFACE_STATUS, 4798 4799 /** 4800 * EVENT_UPDATE_DH - Notification of updated DH information 4801 */ 4802 EVENT_UPDATE_DH, 4803}; 4804 4805 4806/** 4807 * struct freq_survey - Channel survey info 4808 * 4809 * @ifidx: Interface index in which this survey was observed 4810 * @freq: Center of frequency of the surveyed channel 4811 * @nf: Channel noise floor in dBm 4812 * @channel_time: Amount of time in ms the radio spent on the channel 4813 * @channel_time_busy: Amount of time in ms the radio detected some signal 4814 * that indicated to the radio the channel was not clear 4815 * @channel_time_rx: Amount of time the radio spent receiving data 4816 * @channel_time_tx: Amount of time the radio spent transmitting data 4817 * @filled: bitmask indicating which fields have been reported, see 4818 * SURVEY_HAS_* defines. 4819 * @list: Internal list pointers 4820 */ 4821struct freq_survey { 4822 u32 ifidx; 4823 unsigned int freq; 4824 s8 nf; 4825 u64 channel_time; 4826 u64 channel_time_busy; 4827 u64 channel_time_rx; 4828 u64 channel_time_tx; 4829 unsigned int filled; 4830 struct dl_list list; 4831}; 4832 4833#define SURVEY_HAS_NF BIT(0) 4834#define SURVEY_HAS_CHAN_TIME BIT(1) 4835#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2) 4836#define SURVEY_HAS_CHAN_TIME_RX BIT(3) 4837#define SURVEY_HAS_CHAN_TIME_TX BIT(4) 4838 4839 4840/** 4841 * union wpa_event_data - Additional data for wpa_supplicant_event() calls 4842 */ 4843union wpa_event_data { 4844 /** 4845 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events 4846 * 4847 * This structure is optional for EVENT_ASSOC calls and required for 4848 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the 4849 * driver interface does not need to generate separate EVENT_ASSOCINFO 4850 * calls. 4851 */ 4852 struct assoc_info { 4853 /** 4854 * reassoc - Flag to indicate association or reassociation 4855 */ 4856 int reassoc; 4857 4858 /** 4859 * req_ies - (Re)Association Request IEs 4860 * 4861 * If the driver generates WPA/RSN IE, this event data must be 4862 * returned for WPA handshake to have needed information. If 4863 * wpa_supplicant-generated WPA/RSN IE is used, this 4864 * information event is optional. 4865 * 4866 * This should start with the first IE (fixed fields before IEs 4867 * are not included). 4868 */ 4869 const u8 *req_ies; 4870 4871 /** 4872 * req_ies_len - Length of req_ies in bytes 4873 */ 4874 size_t req_ies_len; 4875 4876 /** 4877 * resp_ies - (Re)Association Response IEs 4878 * 4879 * Optional association data from the driver. This data is not 4880 * required WPA, but may be useful for some protocols and as 4881 * such, should be reported if this is available to the driver 4882 * interface. 4883 * 4884 * This should start with the first IE (fixed fields before IEs 4885 * are not included). 4886 */ 4887 const u8 *resp_ies; 4888 4889 /** 4890 * resp_ies_len - Length of resp_ies in bytes 4891 */ 4892 size_t resp_ies_len; 4893 4894 /** 4895 * resp_frame - (Re)Association Response frame 4896 */ 4897 const u8 *resp_frame; 4898 4899 /** 4900 * resp_frame_len - (Re)Association Response frame length 4901 */ 4902 size_t resp_frame_len; 4903 4904 /** 4905 * beacon_ies - Beacon or Probe Response IEs 4906 * 4907 * Optional Beacon/ProbeResp data: IEs included in Beacon or 4908 * Probe Response frames from the current AP (i.e., the one 4909 * that the client just associated with). This information is 4910 * used to update WPA/RSN IE for the AP. If this field is not 4911 * set, the results from previous scan will be used. If no 4912 * data for the new AP is found, scan results will be requested 4913 * again (without scan request). At this point, the driver is 4914 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is 4915 * used). 4916 * 4917 * This should start with the first IE (fixed fields before IEs 4918 * are not included). 4919 */ 4920 const u8 *beacon_ies; 4921 4922 /** 4923 * beacon_ies_len - Length of beacon_ies */ 4924 size_t beacon_ies_len; 4925 4926 /** 4927 * freq - Frequency of the operational channel in MHz 4928 */ 4929 unsigned int freq; 4930 4931 /** 4932 * wmm_params - WMM parameters used in this association. 4933 */ 4934 struct wmm_params wmm_params; 4935 4936 /** 4937 * addr - Station address (for AP mode) 4938 */ 4939 const u8 *addr; 4940 4941 /** 4942 * The following is the key management offload information 4943 * @authorized 4944 * @key_replay_ctr 4945 * @key_replay_ctr_len 4946 * @ptk_kck 4947 * @ptk_kek_len 4948 * @ptk_kek 4949 * @ptk_kek_len 4950 */ 4951 4952 /** 4953 * authorized - Status of key management offload, 4954 * 1 = successful 4955 */ 4956 int authorized; 4957 4958 /** 4959 * key_replay_ctr - Key replay counter value last used 4960 * in a valid EAPOL-Key frame 4961 */ 4962 const u8 *key_replay_ctr; 4963 4964 /** 4965 * key_replay_ctr_len - The length of key_replay_ctr 4966 */ 4967 size_t key_replay_ctr_len; 4968 4969 /** 4970 * ptk_kck - The derived PTK KCK 4971 */ 4972 const u8 *ptk_kck; 4973 4974 /** 4975 * ptk_kek_len - The length of ptk_kck 4976 */ 4977 size_t ptk_kck_len; 4978 4979 /** 4980 * ptk_kek - The derived PTK KEK 4981 * This is used in key management offload and also in FILS SK 4982 * offload. 4983 */ 4984 const u8 *ptk_kek; 4985 4986 /** 4987 * ptk_kek_len - The length of ptk_kek 4988 */ 4989 size_t ptk_kek_len; 4990 4991 /** 4992 * subnet_status - The subnet status: 4993 * 0 = unknown, 1 = unchanged, 2 = changed 4994 */ 4995 u8 subnet_status; 4996 4997 /** 4998 * The following information is used in FILS SK offload 4999 * @fils_erp_next_seq_num 5000 * @fils_pmk 5001 * @fils_pmk_len 5002 * @fils_pmkid 5003 */ 5004 5005 /** 5006 * fils_erp_next_seq_num - The next sequence number to use in 5007 * FILS ERP messages 5008 */ 5009 u16 fils_erp_next_seq_num; 5010 5011 /** 5012 * fils_pmk - A new PMK if generated in case of FILS 5013 * authentication 5014 */ 5015 const u8 *fils_pmk; 5016 5017 /** 5018 * fils_pmk_len - Length of fils_pmk 5019 */ 5020 size_t fils_pmk_len; 5021 5022 /** 5023 * fils_pmkid - PMKID used or generated in FILS authentication 5024 */ 5025 const u8 *fils_pmkid; 5026 } assoc_info; 5027 5028 /** 5029 * struct disassoc_info - Data for EVENT_DISASSOC events 5030 */ 5031 struct disassoc_info { 5032 /** 5033 * addr - Station address (for AP mode) 5034 */ 5035 const u8 *addr; 5036 5037 /** 5038 * reason_code - Reason Code (host byte order) used in 5039 * Deauthentication frame 5040 */ 5041 u16 reason_code; 5042 5043 /** 5044 * ie - Optional IE(s) in Disassociation frame 5045 */ 5046 const u8 *ie; 5047 5048 /** 5049 * ie_len - Length of ie buffer in octets 5050 */ 5051 size_t ie_len; 5052 5053 /** 5054 * locally_generated - Whether the frame was locally generated 5055 */ 5056 int locally_generated; 5057 } disassoc_info; 5058 5059 /** 5060 * struct deauth_info - Data for EVENT_DEAUTH events 5061 */ 5062 struct deauth_info { 5063 /** 5064 * addr - Station address (for AP mode) 5065 */ 5066 const u8 *addr; 5067 5068 /** 5069 * reason_code - Reason Code (host byte order) used in 5070 * Deauthentication frame 5071 */ 5072 u16 reason_code; 5073 5074 /** 5075 * ie - Optional IE(s) in Deauthentication frame 5076 */ 5077 const u8 *ie; 5078 5079 /** 5080 * ie_len - Length of ie buffer in octets 5081 */ 5082 size_t ie_len; 5083 5084 /** 5085 * locally_generated - Whether the frame was locally generated 5086 */ 5087 int locally_generated; 5088 } deauth_info; 5089 5090 /** 5091 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE 5092 */ 5093 struct michael_mic_failure { 5094 int unicast; 5095 const u8 *src; 5096 } michael_mic_failure; 5097 5098 /** 5099 * struct interface_status - Data for EVENT_INTERFACE_STATUS 5100 */ 5101 struct interface_status { 5102 unsigned int ifindex; 5103 char ifname[100]; 5104 enum { 5105 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED 5106 } ievent; 5107 } interface_status; 5108 5109 /** 5110 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE 5111 */ 5112 struct pmkid_candidate { 5113 /** BSSID of the PMKID candidate */ 5114 u8 bssid[ETH_ALEN]; 5115 /** Smaller the index, higher the priority */ 5116 int index; 5117 /** Whether RSN IE includes pre-authenticate flag */ 5118 int preauth; 5119 } pmkid_candidate; 5120 5121 /** 5122 * struct tdls - Data for EVENT_TDLS 5123 */ 5124 struct tdls { 5125 u8 peer[ETH_ALEN]; 5126 enum { 5127 TDLS_REQUEST_SETUP, 5128 TDLS_REQUEST_TEARDOWN, 5129 TDLS_REQUEST_DISCOVER, 5130 } oper; 5131 u16 reason_code; /* for teardown */ 5132 } tdls; 5133 5134 /** 5135 * struct wnm - Data for EVENT_WNM 5136 */ 5137 struct wnm { 5138 u8 addr[ETH_ALEN]; 5139 enum { 5140 WNM_OPER_SLEEP, 5141 } oper; 5142 enum { 5143 WNM_SLEEP_ENTER, 5144 WNM_SLEEP_EXIT 5145 } sleep_action; 5146 int sleep_intval; 5147 u16 reason_code; 5148 u8 *buf; 5149 u16 buf_len; 5150 } wnm; 5151 5152 /** 5153 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE) 5154 * 5155 * During FT (IEEE 802.11r) authentication sequence, the driver is 5156 * expected to use this event to report received FT IEs (MDIE, FTIE, 5157 * RSN IE, TIE, possible resource request) to the supplicant. The FT 5158 * IEs for the next message will be delivered through the 5159 * struct wpa_driver_ops::update_ft_ies() callback. 5160 */ 5161 struct ft_ies { 5162 const u8 *ies; 5163 size_t ies_len; 5164 int ft_action; 5165 u8 target_ap[ETH_ALEN]; 5166 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */ 5167 const u8 *ric_ies; 5168 /** Length of ric_ies buffer in octets */ 5169 size_t ric_ies_len; 5170 } ft_ies; 5171 5172 /** 5173 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START 5174 */ 5175 struct ibss_rsn_start { 5176 u8 peer[ETH_ALEN]; 5177 } ibss_rsn_start; 5178 5179 /** 5180 * struct auth_info - Data for EVENT_AUTH events 5181 */ 5182 struct auth_info { 5183 u8 peer[ETH_ALEN]; 5184 u8 bssid[ETH_ALEN]; 5185 u16 auth_type; 5186 u16 auth_transaction; 5187 u16 status_code; 5188 const u8 *ies; 5189 size_t ies_len; 5190 } auth; 5191 5192 /** 5193 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events 5194 */ 5195 struct assoc_reject { 5196 /** 5197 * bssid - BSSID of the AP that rejected association 5198 */ 5199 const u8 *bssid; 5200 5201 /** 5202 * resp_ies - (Re)Association Response IEs 5203 * 5204 * Optional association data from the driver. This data is not 5205 * required WPA, but may be useful for some protocols and as 5206 * such, should be reported if this is available to the driver 5207 * interface. 5208 * 5209 * This should start with the first IE (fixed fields before IEs 5210 * are not included). 5211 */ 5212 const u8 *resp_ies; 5213 5214 /** 5215 * resp_ies_len - Length of resp_ies in bytes 5216 */ 5217 size_t resp_ies_len; 5218 5219 /** 5220 * status_code - Status Code from (Re)association Response 5221 */ 5222 u16 status_code; 5223 5224 /** 5225 * timed_out - Whether failure is due to timeout (etc.) rather 5226 * than explicit rejection response from the AP. 5227 */ 5228 int timed_out; 5229 5230 /** 5231 * timeout_reason - Reason for the timeout 5232 */ 5233 const char *timeout_reason; 5234 5235 /** 5236 * fils_erp_next_seq_num - The next sequence number to use in 5237 * FILS ERP messages 5238 */ 5239 u16 fils_erp_next_seq_num; 5240 } assoc_reject; 5241 5242 struct timeout_event { 5243 u8 addr[ETH_ALEN]; 5244 } timeout_event; 5245 5246 /** 5247 * struct tx_status - Data for EVENT_TX_STATUS events 5248 */ 5249 struct tx_status { 5250 u16 type; 5251 u16 stype; 5252 const u8 *dst; 5253 const u8 *data; 5254 size_t data_len; 5255 int ack; 5256 } tx_status; 5257 5258 /** 5259 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events 5260 */ 5261 struct rx_from_unknown { 5262 const u8 *bssid; 5263 const u8 *addr; 5264 int wds; 5265 } rx_from_unknown; 5266 5267 /** 5268 * struct rx_mgmt - Data for EVENT_RX_MGMT events 5269 */ 5270 struct rx_mgmt { 5271 const u8 *frame; 5272 size_t frame_len; 5273 u32 datarate; 5274 5275 /** 5276 * drv_priv - Pointer to store driver private BSS information 5277 * 5278 * If not set to NULL, this is used for comparison with 5279 * hostapd_data->drv_priv to determine which BSS should process 5280 * the frame. 5281 */ 5282 void *drv_priv; 5283 5284 /** 5285 * freq - Frequency (in MHz) on which the frame was received 5286 */ 5287 int freq; 5288 5289 /** 5290 * ssi_signal - Signal strength in dBm (or 0 if not available) 5291 */ 5292 int ssi_signal; 5293 } rx_mgmt; 5294 5295 /** 5296 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events 5297 * 5298 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events. 5299 */ 5300 struct remain_on_channel { 5301 /** 5302 * freq - Channel frequency in MHz 5303 */ 5304 unsigned int freq; 5305 5306 /** 5307 * duration - Duration to remain on the channel in milliseconds 5308 */ 5309 unsigned int duration; 5310 } remain_on_channel; 5311 5312 /** 5313 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events 5314 * @aborted: Whether the scan was aborted 5315 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned) 5316 * @num_freqs: Number of entries in freqs array 5317 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard 5318 * SSID) 5319 * @num_ssids: Number of entries in ssids array 5320 * @external_scan: Whether the scan info is for an external scan 5321 * @nl_scan_event: 1 if the source of this scan event is a normal scan, 5322 * 0 if the source of the scan event is a vendor scan 5323 * @scan_start_tsf: Time when the scan started in terms of TSF of the 5324 * BSS that the interface that requested the scan is connected to 5325 * (if available). 5326 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf 5327 * is set. 5328 */ 5329 struct scan_info { 5330 int aborted; 5331 const int *freqs; 5332 size_t num_freqs; 5333 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS]; 5334 size_t num_ssids; 5335 int external_scan; 5336 int nl_scan_event; 5337 u64 scan_start_tsf; 5338 u8 scan_start_tsf_bssid[ETH_ALEN]; 5339 } scan_info; 5340 5341 /** 5342 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events 5343 */ 5344 struct rx_probe_req { 5345 /** 5346 * sa - Source address of the received Probe Request frame 5347 */ 5348 const u8 *sa; 5349 5350 /** 5351 * da - Destination address of the received Probe Request frame 5352 * or %NULL if not available 5353 */ 5354 const u8 *da; 5355 5356 /** 5357 * bssid - BSSID of the received Probe Request frame or %NULL 5358 * if not available 5359 */ 5360 const u8 *bssid; 5361 5362 /** 5363 * ie - IEs from the Probe Request body 5364 */ 5365 const u8 *ie; 5366 5367 /** 5368 * ie_len - Length of ie buffer in octets 5369 */ 5370 size_t ie_len; 5371 5372 /** 5373 * signal - signal strength in dBm (or 0 if not available) 5374 */ 5375 int ssi_signal; 5376 } rx_probe_req; 5377 5378 /** 5379 * struct new_sta - Data for EVENT_NEW_STA events 5380 */ 5381 struct new_sta { 5382 const u8 *addr; 5383 } new_sta; 5384 5385 /** 5386 * struct eapol_rx - Data for EVENT_EAPOL_RX events 5387 */ 5388 struct eapol_rx { 5389 const u8 *src; 5390 const u8 *data; 5391 size_t data_len; 5392 } eapol_rx; 5393 5394 /** 5395 * signal_change - Data for EVENT_SIGNAL_CHANGE events 5396 */ 5397 struct wpa_signal_info signal_change; 5398 5399 /** 5400 * struct best_channel - Data for EVENT_BEST_CHANNEL events 5401 * @freq_24: Best 2.4 GHz band channel frequency in MHz 5402 * @freq_5: Best 5 GHz band channel frequency in MHz 5403 * @freq_overall: Best channel frequency in MHz 5404 * 5405 * 0 can be used to indicate no preference in either band. 5406 */ 5407 struct best_channel { 5408 int freq_24; 5409 int freq_5; 5410 int freq_overall; 5411 } best_chan; 5412 5413 struct unprot_deauth { 5414 const u8 *sa; 5415 const u8 *da; 5416 u16 reason_code; 5417 } unprot_deauth; 5418 5419 struct unprot_disassoc { 5420 const u8 *sa; 5421 const u8 *da; 5422 u16 reason_code; 5423 } unprot_disassoc; 5424 5425 /** 5426 * struct low_ack - Data for EVENT_STATION_LOW_ACK events 5427 * @addr: station address 5428 * @num_packets: Number of packets lost (consecutive packets not 5429 * acknowledged) 5430 */ 5431 struct low_ack { 5432 u8 addr[ETH_ALEN]; 5433 u32 num_packets; 5434 } low_ack; 5435 5436 /** 5437 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST 5438 */ 5439 struct ibss_peer_lost { 5440 u8 peer[ETH_ALEN]; 5441 } ibss_peer_lost; 5442 5443 /** 5444 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY 5445 */ 5446 struct driver_gtk_rekey { 5447 const u8 *bssid; 5448 const u8 *replay_ctr; 5449 } driver_gtk_rekey; 5450 5451 /** 5452 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events 5453 * @addr: station address 5454 */ 5455 struct client_poll { 5456 u8 addr[ETH_ALEN]; 5457 } client_poll; 5458 5459 /** 5460 * struct eapol_tx_status 5461 * @dst: Original destination 5462 * @data: Data starting with IEEE 802.1X header (!) 5463 * @data_len: Length of data 5464 * @ack: Indicates ack or lost frame 5465 * 5466 * This corresponds to hapd_send_eapol if the frame sent 5467 * there isn't just reported as EVENT_TX_STATUS. 5468 */ 5469 struct eapol_tx_status { 5470 const u8 *dst; 5471 const u8 *data; 5472 int data_len; 5473 int ack; 5474 } eapol_tx_status; 5475 5476 /** 5477 * struct ch_switch 5478 * @freq: Frequency of new channel in MHz 5479 * @ht_enabled: Whether this is an HT channel 5480 * @ch_offset: Secondary channel offset 5481 * @ch_width: Channel width 5482 * @cf1: Center frequency 1 5483 * @cf2: Center frequency 2 5484 */ 5485 struct ch_switch { 5486 int freq; 5487 int ht_enabled; 5488 int ch_offset; 5489 enum chan_width ch_width; 5490 int cf1; 5491 int cf2; 5492 } ch_switch; 5493 5494 /** 5495 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON 5496 * @addr: Remote client address 5497 * @code: Reason code for connection failure 5498 */ 5499 struct connect_failed_reason { 5500 u8 addr[ETH_ALEN]; 5501 enum { 5502 MAX_CLIENT_REACHED, 5503 BLOCKED_CLIENT 5504 } code; 5505 } connect_failed_reason; 5506 5507 /** 5508 * struct dfs_event - Data for radar detected events 5509 * @freq: Frequency of the channel in MHz 5510 */ 5511 struct dfs_event { 5512 int freq; 5513 int ht_enabled; 5514 int chan_offset; 5515 enum chan_width chan_width; 5516 int cf1; 5517 int cf2; 5518 } dfs_event; 5519 5520 /** 5521 * survey_results - Survey result data for EVENT_SURVEY 5522 * @freq_filter: Requested frequency survey filter, 0 if request 5523 * was for all survey data 5524 * @survey_list: Linked list of survey data (struct freq_survey) 5525 */ 5526 struct survey_results { 5527 unsigned int freq_filter; 5528 struct dl_list survey_list; /* struct freq_survey */ 5529 } survey_results; 5530 5531 /** 5532 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED 5533 * @initiator: Initiator of the regulatory change 5534 * @type: Regulatory change type 5535 * @alpha2: Country code (or "" if not available) 5536 */ 5537 struct channel_list_changed { 5538 enum reg_change_initiator initiator; 5539 enum reg_type type; 5540 char alpha2[3]; 5541 } channel_list_changed; 5542 5543 /** 5544 * freq_range - List of frequency ranges 5545 * 5546 * This is used as the data with EVENT_AVOID_FREQUENCIES. 5547 */ 5548 struct wpa_freq_range_list freq_range; 5549 5550 /** 5551 * struct mesh_peer 5552 * 5553 * @peer: Peer address 5554 * @ies: Beacon IEs 5555 * @ie_len: Length of @ies 5556 * 5557 * Notification of new candidate mesh peer. 5558 */ 5559 struct mesh_peer { 5560 const u8 *peer; 5561 const u8 *ies; 5562 size_t ie_len; 5563 } mesh_peer; 5564 5565 /** 5566 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED 5567 * @pri_channel: Selected primary channel 5568 * @sec_channel: Selected secondary channel 5569 * @vht_seg0_center_ch: VHT mode Segment0 center channel 5570 * @vht_seg1_center_ch: VHT mode Segment1 center channel 5571 * @ch_width: Selected Channel width by driver. Driver may choose to 5572 * change hostapd configured ACS channel width due driver internal 5573 * channel restrictions. 5574 * hw_mode: Selected band (used with hw_mode=any) 5575 */ 5576 struct acs_selected_channels { 5577 u8 pri_channel; 5578 u8 sec_channel; 5579 u8 vht_seg0_center_ch; 5580 u8 vht_seg1_center_ch; 5581 u16 ch_width; 5582 enum hostapd_hw_mode hw_mode; 5583 } acs_selected_channels; 5584 5585 /** 5586 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event 5587 * @reason_code: Reason for stopping offload 5588 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as 5589 * scheduled. 5590 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to 5591 * be stopped. 5592 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload 5593 * parameters. 5594 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not 5595 * supported by device. 5596 */ 5597 struct p2p_lo_stop { 5598 enum { 5599 P2P_LO_STOPPED_REASON_COMPLETE = 0, 5600 P2P_LO_STOPPED_REASON_RECV_STOP_CMD, 5601 P2P_LO_STOPPED_REASON_INVALID_PARAM, 5602 P2P_LO_STOPPED_REASON_NOT_SUPPORTED, 5603 } reason_code; 5604 } p2p_lo_stop; 5605 5606 /* For EVENT_EXTERNAL_AUTH */ 5607 struct external_auth external_auth; 5608 5609 /** 5610 * struct sta_opmode - Station's operation mode change event 5611 * @addr: The station MAC address 5612 * @smps_mode: SMPS mode of the station 5613 * @chan_width: Channel width of the station 5614 * @rx_nss: RX_NSS of the station 5615 * 5616 * This is used as data with EVENT_STATION_OPMODE_CHANGED. 5617 */ 5618 struct sta_opmode { 5619 const u8 *addr; 5620 enum smps_mode smps_mode; 5621 enum chan_width chan_width; 5622 u8 rx_nss; 5623 } sta_opmode; 5624 5625 /** 5626 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS. 5627 */ 5628 struct wds_sta_interface { 5629 const u8 *sta_addr; 5630 const char *ifname; 5631 enum { 5632 INTERFACE_ADDED, 5633 INTERFACE_REMOVED 5634 } istatus; 5635 } wds_sta_interface; 5636 5637 /** 5638 * struct update_dh - Data for EVENT_UPDATE_DH 5639 */ 5640 struct update_dh { 5641 const u8 *peer; 5642 const u8 *ie; 5643 size_t ie_len; 5644 } update_dh; 5645}; 5646 5647/** 5648 * wpa_supplicant_event - Report a driver event for wpa_supplicant 5649 * @ctx: Context pointer (wpa_s); this is the ctx variable registered 5650 * with struct wpa_driver_ops::init() 5651 * @event: event type (defined above) 5652 * @data: possible extra data for the event 5653 * 5654 * Driver wrapper code should call this function whenever an event is received 5655 * from the driver. 5656 */ 5657void wpa_supplicant_event(void *ctx, enum wpa_event_type event, 5658 union wpa_event_data *data); 5659 5660/** 5661 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant 5662 * @ctx: Context pointer (wpa_s); this is the ctx variable registered 5663 * with struct wpa_driver_ops::init() 5664 * @event: event type (defined above) 5665 * @data: possible extra data for the event 5666 * 5667 * Same as wpa_supplicant_event(), but we search for the interface in 5668 * wpa_global. 5669 */ 5670void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event, 5671 union wpa_event_data *data); 5672 5673/* 5674 * The following inline functions are provided for convenience to simplify 5675 * event indication for some of the common events. 5676 */ 5677 5678static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie, 5679 size_t ielen, int reassoc) 5680{ 5681 union wpa_event_data event; 5682 os_memset(&event, 0, sizeof(event)); 5683 event.assoc_info.reassoc = reassoc; 5684 event.assoc_info.req_ies = ie; 5685 event.assoc_info.req_ies_len = ielen; 5686 event.assoc_info.addr = addr; 5687 wpa_supplicant_event(ctx, EVENT_ASSOC, &event); 5688} 5689 5690static inline void drv_event_disassoc(void *ctx, const u8 *addr) 5691{ 5692 union wpa_event_data event; 5693 os_memset(&event, 0, sizeof(event)); 5694 event.disassoc_info.addr = addr; 5695 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event); 5696} 5697 5698static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data, 5699 size_t data_len) 5700{ 5701 union wpa_event_data event; 5702 os_memset(&event, 0, sizeof(event)); 5703 event.eapol_rx.src = src; 5704 event.eapol_rx.data = data; 5705 event.eapol_rx.data_len = data_len; 5706 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event); 5707} 5708 5709/* driver_common.c */ 5710void wpa_scan_results_free(struct wpa_scan_results *res); 5711 5712/* Convert wpa_event_type to a string for logging */ 5713const char * event_to_string(enum wpa_event_type event); 5714 5715/* Convert chan_width to a string for logging and control interfaces */ 5716const char * channel_width_to_string(enum chan_width width); 5717 5718int channel_width_to_int(enum chan_width width); 5719 5720int ht_supported(const struct hostapd_hw_modes *mode); 5721int vht_supported(const struct hostapd_hw_modes *mode); 5722 5723struct wowlan_triggers * 5724wpa_get_wowlan_triggers(const char *wowlan_triggers, 5725 const struct wpa_driver_capa *capa); 5726/* Convert driver flag to string */ 5727const char * driver_flag_to_string(u64 flag); 5728 5729/* NULL terminated array of linked in driver wrappers */ 5730extern const struct wpa_driver_ops *const wpa_drivers[]; 5731 5732 5733/* Available drivers */ 5734 5735#ifdef CONFIG_DRIVER_WEXT 5736extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */ 5737#endif /* CONFIG_DRIVER_WEXT */ 5738#ifdef CONFIG_DRIVER_NL80211 5739/* driver_nl80211.c */ 5740extern const struct wpa_driver_ops wpa_driver_nl80211_ops; 5741#endif /* CONFIG_DRIVER_NL80211 */ 5742#ifdef CONFIG_DRIVER_HOSTAP 5743extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */ 5744#endif /* CONFIG_DRIVER_HOSTAP */ 5745#ifdef CONFIG_DRIVER_BSD 5746extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */ 5747#endif /* CONFIG_DRIVER_BSD */ 5748#ifdef CONFIG_DRIVER_OPENBSD 5749/* driver_openbsd.c */ 5750extern const struct wpa_driver_ops wpa_driver_openbsd_ops; 5751#endif /* CONFIG_DRIVER_OPENBSD */ 5752#ifdef CONFIG_DRIVER_NDIS 5753extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */ 5754#endif /* CONFIG_DRIVER_NDIS */ 5755#ifdef CONFIG_DRIVER_WIRED 5756extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */ 5757#endif /* CONFIG_DRIVER_WIRED */ 5758#ifdef CONFIG_DRIVER_MACSEC_QCA 5759/* driver_macsec_qca.c */ 5760extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops; 5761#endif /* CONFIG_DRIVER_MACSEC_QCA */ 5762#ifdef CONFIG_DRIVER_MACSEC_LINUX 5763/* driver_macsec_linux.c */ 5764extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops; 5765#endif /* CONFIG_DRIVER_MACSEC_LINUX */ 5766#ifdef CONFIG_DRIVER_ROBOSWITCH 5767/* driver_roboswitch.c */ 5768extern const struct wpa_driver_ops wpa_driver_roboswitch_ops; 5769#endif /* CONFIG_DRIVER_ROBOSWITCH */ 5770#ifdef CONFIG_DRIVER_ATHEROS 5771/* driver_atheros.c */ 5772extern const struct wpa_driver_ops wpa_driver_atheros_ops; 5773#endif /* CONFIG_DRIVER_ATHEROS */ 5774#ifdef CONFIG_DRIVER_NONE 5775extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */ 5776#endif /* CONFIG_DRIVER_NONE */ 5777 5778#endif /* DRIVER_H */ 5779