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