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