1 /* 2 * Copyright (C) 2022 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #ifndef WIFI_LEGACY_HAL_H_ 18 #define WIFI_LEGACY_HAL_H_ 19 20 #include <hardware_legacy/wifi_hal.h> 21 #include <wifi_system/interface_tool.h> 22 23 #include <condition_variable> 24 #include <functional> 25 #include <map> 26 #include <mutex> 27 #include <thread> 28 #include <vector> 29 30 namespace aidl { 31 namespace android { 32 namespace hardware { 33 namespace wifi { 34 // This is in a separate namespace to prevent typename conflicts between 35 // the legacy HAL types and the AIDL interface types. 36 namespace legacy_hal { 37 // Import all the types defined inside the legacy HAL header files into this 38 // namespace. 39 using ::chre_nan_rtt_state; 40 using ::frame_info; 41 using ::frame_type; 42 using ::FRAME_TYPE_80211_MGMT; 43 using ::FRAME_TYPE_ETHERNET_II; 44 using ::FRAME_TYPE_UNKNOWN; 45 using ::fw_roaming_state_t; 46 using ::mac_addr; 47 using ::NAN_BOOTSTRAPPING_INITIATOR_RESPONSE; 48 using ::NAN_BOOTSTRAPPING_RESPONDER_RESPONSE; 49 using ::NAN_CHANNEL_24G_BAND; 50 using ::NAN_CHANNEL_5G_BAND_HIGH; 51 using ::NAN_CHANNEL_5G_BAND_LOW; 52 using ::NAN_DISABLE_RANGE_REPORT; 53 using ::NAN_DO_NOT_USE_SRF; 54 using ::NAN_DP_CHANNEL_NOT_REQUESTED; 55 using ::NAN_DP_CONFIG_NO_SECURITY; 56 using ::NAN_DP_CONFIG_SECURITY; 57 using ::NAN_DP_END; 58 using ::NAN_DP_FORCE_CHANNEL_SETUP; 59 using ::NAN_DP_INITIATOR_RESPONSE; 60 using ::NAN_DP_INTERFACE_CREATE; 61 using ::NAN_DP_INTERFACE_DELETE; 62 using ::NAN_DP_REQUEST_ACCEPT; 63 using ::NAN_DP_REQUEST_CHANNEL_SETUP; 64 using ::NAN_DP_REQUEST_REJECT; 65 using ::NAN_DP_RESPONDER_RESPONSE; 66 using ::NAN_GET_CAPABILITIES; 67 using ::NAN_MATCH_ALG_MATCH_CONTINUOUS; 68 using ::NAN_MATCH_ALG_MATCH_NEVER; 69 using ::NAN_MATCH_ALG_MATCH_ONCE; 70 using ::NAN_PAIRING_END; 71 using ::NAN_PAIRING_INITIATOR_RESPONSE; 72 using ::NAN_PAIRING_RESPONDER_RESPONSE; 73 using ::NAN_PAIRING_SETUP; 74 using ::NAN_PAIRING_VERIFICATION; 75 using ::NAN_PUBLISH_TYPE_SOLICITED; 76 using ::NAN_PUBLISH_TYPE_UNSOLICITED; 77 using ::NAN_PUBLISH_TYPE_UNSOLICITED_SOLICITED; 78 using ::NAN_RANGING_AUTO_RESPONSE_DISABLE; 79 using ::NAN_RANGING_AUTO_RESPONSE_ENABLE; 80 using ::NAN_RANGING_DISABLE; 81 using ::NAN_RANGING_ENABLE; 82 using ::NAN_RESPONSE_BEACON_SDF_PAYLOAD; 83 using ::NAN_RESPONSE_CONFIG; 84 using ::NAN_RESPONSE_DISABLED; 85 using ::NAN_RESPONSE_ENABLED; 86 using ::NAN_RESPONSE_ERROR; 87 using ::NAN_RESPONSE_PUBLISH; 88 using ::NAN_RESPONSE_PUBLISH_CANCEL; 89 using ::NAN_RESPONSE_STATS; 90 using ::NAN_RESPONSE_SUBSCRIBE; 91 using ::NAN_RESPONSE_SUBSCRIBE_CANCEL; 92 using ::NAN_RESPONSE_TCA; 93 using ::NAN_RESPONSE_TRANSMIT_FOLLOWUP; 94 using ::NAN_RESUME_REQUEST_RESPONSE; 95 using ::NAN_SECURITY_KEY_INPUT_PASSPHRASE; 96 using ::NAN_SECURITY_KEY_INPUT_PMK; 97 using ::NAN_SERVICE_ACCEPT_POLICY_ALL; 98 using ::NAN_SERVICE_ACCEPT_POLICY_NONE; 99 using ::NAN_SRF_ATTR_BLOOM_FILTER; 100 using ::NAN_SRF_ATTR_PARTIAL_MAC_ADDR; 101 using ::NAN_SRF_INCLUDE_DO_NOT_RESPOND; 102 using ::NAN_SRF_INCLUDE_RESPOND; 103 using ::NAN_SSI_NOT_REQUIRED_IN_MATCH_IND; 104 using ::NAN_SSI_REQUIRED_IN_MATCH_IND; 105 using ::NAN_STATUS_ALREADY_ENABLED; 106 using ::NAN_STATUS_FOLLOWUP_QUEUE_FULL; 107 using ::NAN_STATUS_INTERNAL_FAILURE; 108 using ::NAN_STATUS_INVALID_BOOTSTRAPPING_ID; 109 using ::NAN_STATUS_INVALID_NDP_ID; 110 using ::NAN_STATUS_INVALID_PAIRING_ID; 111 using ::NAN_STATUS_INVALID_PARAM; 112 using ::NAN_STATUS_INVALID_PUBLISH_SUBSCRIBE_ID; 113 using ::NAN_STATUS_INVALID_REQUESTOR_INSTANCE_ID; 114 using ::NAN_STATUS_NAN_NOT_ALLOWED; 115 using ::NAN_STATUS_NO_CONNECTION; 116 using ::NAN_STATUS_NO_OTA_ACK; 117 using ::NAN_STATUS_NO_RESOURCE_AVAILABLE; 118 using ::NAN_STATUS_NOT_SUPPORTED; 119 using ::NAN_STATUS_PROTOCOL_FAILURE; 120 using ::NAN_STATUS_REDUNDANT_REQUEST; 121 using ::NAN_STATUS_SUCCESS; 122 using ::NAN_STATUS_UNSUPPORTED_CONCURRENCY_NAN_DISABLED; 123 using ::NAN_SUBSCRIBE_TYPE_ACTIVE; 124 using ::NAN_SUBSCRIBE_TYPE_PASSIVE; 125 using ::NAN_SUSPEND_REQUEST_RESPONSE; 126 using ::NAN_TRANSMIT_IN_DW; 127 using ::NAN_TRANSMIT_IN_FAW; 128 using ::NAN_TX_PRIORITY_HIGH; 129 using ::NAN_TX_PRIORITY_NORMAL; 130 using ::NAN_TX_TYPE_BROADCAST; 131 using ::NAN_TX_TYPE_UNICAST; 132 using ::NAN_USE_SRF; 133 using ::NanAkm; 134 using ::NanBeaconSdfPayloadInd; 135 using ::NanBootstrappingConfirmInd; 136 using ::NanBootstrappingIndicationResponse; 137 using ::NanBootstrappingRequest; 138 using ::NanBootstrappingRequestInd; 139 using ::NanBootstrappingRequestResponse; 140 using ::NanBootstrappingResponseCode; 141 using ::NanCapabilities; 142 using ::NanChannelInfo; 143 using ::NanConfigRequest; 144 using ::NanDataPathChannelCfg; 145 using ::NanDataPathConfirmInd; 146 using ::NanDataPathEndInd; 147 using ::NanDataPathIndicationResponse; 148 using ::NanDataPathInitiatorRequest; 149 using ::NanDataPathRequestInd; 150 using ::NanDataPathScheduleUpdateInd; 151 using ::NanDisabledInd; 152 using ::NanDiscEngEventInd; 153 using ::NanEnableRequest; 154 using ::NanFollowupInd; 155 using ::NanIdentityResolutionAttribute; 156 using ::NanMatchAlg; 157 using ::NanMatchExpiredInd; 158 using ::NanMatchInd; 159 using ::NanPairingConfig; 160 using ::NanPairingConfirmInd; 161 using ::NanPairingEndRequest; 162 using ::NanPairingIndicationResponse; 163 using ::NanPairingRequest; 164 using ::NanPairingRequestInd; 165 using ::NanPairingRequestResponse; 166 using ::NanPairingRequestType; 167 using ::NanPairingResponseCode; 168 using ::NanPublishCancelRequest; 169 using ::NanPublishRequest; 170 using ::NanPublishTerminatedInd; 171 using ::NanPublishType; 172 using ::NanRangeReportInd; 173 using ::NanRangeRequestInd; 174 using ::NanResponseMsg; 175 using ::NanResumeRequest; 176 using ::NanSRFType; 177 using ::NanStatusType; 178 using ::NanSubscribeCancelRequest; 179 using ::NanSubscribeRequest; 180 using ::NanSubscribeTerminatedInd; 181 using ::NanSubscribeType; 182 using ::NanSuspendRequest; 183 using ::NanSuspensionModeChangeInd; 184 using ::NanTransmitFollowupInd; 185 using ::NanTransmitFollowupRequest; 186 using ::NanTxType; 187 using ::NpkSecurityAssociation; 188 using ::PASN; 189 using ::ROAMING_DISABLE; 190 using ::ROAMING_ENABLE; 191 using ::RTT_PEER_AP; 192 using ::RTT_PEER_NAN; 193 using ::RTT_PEER_P2P_CLIENT; 194 using ::RTT_PEER_P2P_GO; 195 using ::RTT_PEER_STA; 196 using ::rtt_peer_type; 197 using ::RTT_STATUS_ABORTED; 198 using ::RTT_STATUS_FAIL_AP_ON_DIFF_CHANNEL; 199 using ::RTT_STATUS_FAIL_BUSY_TRY_LATER; 200 using ::RTT_STATUS_FAIL_FTM_PARAM_OVERRIDE; 201 using ::RTT_STATUS_FAIL_INVALID_TS; 202 using ::RTT_STATUS_FAIL_NO_CAPABILITY; 203 using ::RTT_STATUS_FAIL_NO_RSP; 204 using ::RTT_STATUS_FAIL_NOT_SCHEDULED_YET; 205 using ::RTT_STATUS_FAIL_PROTOCOL; 206 using ::RTT_STATUS_FAIL_REJECTED; 207 using ::RTT_STATUS_FAIL_SCHEDULE; 208 using ::RTT_STATUS_FAIL_TM_TIMEOUT; 209 using ::RTT_STATUS_FAILURE; 210 using ::RTT_STATUS_INVALID_REQ; 211 using ::RTT_STATUS_NAN_RANGING_CONCURRENCY_NOT_SUPPORTED; 212 using ::RTT_STATUS_NAN_RANGING_PROTOCOL_FAILURE; 213 using ::RTT_STATUS_NO_WIFI; 214 using ::RTT_STATUS_SUCCESS; 215 using ::RTT_TYPE_1_SIDED; 216 using ::RTT_TYPE_2_SIDED; 217 using ::RX_PKT_FATE_DRV_DROP_FILTER; 218 using ::RX_PKT_FATE_DRV_DROP_INVALID; 219 using ::RX_PKT_FATE_DRV_DROP_NOBUFS; 220 using ::RX_PKT_FATE_DRV_DROP_OTHER; 221 using ::RX_PKT_FATE_DRV_QUEUED; 222 using ::RX_PKT_FATE_FW_DROP_FILTER; 223 using ::RX_PKT_FATE_FW_DROP_INVALID; 224 using ::RX_PKT_FATE_FW_DROP_NOBUFS; 225 using ::RX_PKT_FATE_FW_DROP_OTHER; 226 using ::RX_PKT_FATE_FW_QUEUED; 227 using ::RX_PKT_FATE_SUCCESS; 228 using ::SAE; 229 using ::ssid_t; 230 using ::transaction_id; 231 using ::TX_PKT_FATE_ACKED; 232 using ::TX_PKT_FATE_DRV_DROP_INVALID; 233 using ::TX_PKT_FATE_DRV_DROP_NOBUFS; 234 using ::TX_PKT_FATE_DRV_DROP_OTHER; 235 using ::TX_PKT_FATE_DRV_QUEUED; 236 using ::TX_PKT_FATE_FW_DROP_INVALID; 237 using ::TX_PKT_FATE_FW_DROP_NOBUFS; 238 using ::TX_PKT_FATE_FW_DROP_OTHER; 239 using ::TX_PKT_FATE_FW_QUEUED; 240 using ::TX_PKT_FATE_SENT; 241 using ::WIFI_AC_BE; 242 using ::WIFI_AC_BK; 243 using ::WIFI_AC_VI; 244 using ::WIFI_AC_VO; 245 using ::WIFI_ANTENNA_1X1; 246 using ::WIFI_ANTENNA_2X2; 247 using ::WIFI_ANTENNA_3X3; 248 using ::WIFI_ANTENNA_4X4; 249 using ::WIFI_ANTENNA_UNSPECIFIED; 250 using ::wifi_band; 251 using ::WIFI_BAND_A; 252 using ::WIFI_BAND_A_DFS; 253 using ::WIFI_BAND_A_WITH_DFS; 254 using ::WIFI_BAND_ABG; 255 using ::WIFI_BAND_ABG_WITH_DFS; 256 using ::WIFI_BAND_BG; 257 using ::WIFI_BAND_UNSPECIFIED; 258 using ::wifi_cached_scan_report; 259 using ::wifi_cached_scan_results; 260 using ::WIFI_CHAN_WIDTH_10; 261 using ::WIFI_CHAN_WIDTH_160; 262 using ::WIFI_CHAN_WIDTH_20; 263 using ::WIFI_CHAN_WIDTH_320; 264 using ::WIFI_CHAN_WIDTH_40; 265 using ::WIFI_CHAN_WIDTH_5; 266 using ::WIFI_CHAN_WIDTH_80; 267 using ::WIFI_CHAN_WIDTH_80P80; 268 using ::WIFI_CHAN_WIDTH_INVALID; 269 using ::wifi_channel_category; 270 using ::wifi_channel_info; 271 using ::wifi_channel_stat; 272 using ::wifi_channel_width; 273 using ::wifi_chip_capabilities; 274 using ::wifi_coex_restriction; 275 using ::wifi_coex_unsafe_channel; 276 using ::WIFI_DFS_CHANNEL; 277 using ::WIFI_DUAL_STA_NON_TRANSIENT_UNBIASED; 278 using ::WIFI_DUAL_STA_TRANSIENT_PREFER_PRIMARY; 279 using ::wifi_error; 280 using ::WIFI_ERROR_BUSY; 281 using ::WIFI_ERROR_INVALID_ARGS; 282 using ::WIFI_ERROR_INVALID_REQUEST_ID; 283 using ::WIFI_ERROR_NONE; 284 using ::WIFI_ERROR_NOT_AVAILABLE; 285 using ::WIFI_ERROR_NOT_SUPPORTED; 286 using ::WIFI_ERROR_OUT_OF_MEMORY; 287 using ::WIFI_ERROR_TIMED_OUT; 288 using ::WIFI_ERROR_TOO_MANY_REQUESTS; 289 using ::WIFI_ERROR_UNINITIALIZED; 290 using ::WIFI_ERROR_UNKNOWN; 291 using ::wifi_gscan_capabilities; 292 using ::wifi_hal_fn; 293 using ::wifi_iface_concurrency_matrix; 294 using ::WIFI_INDOOR_CHANNEL; 295 using ::wifi_information_element; 296 using ::WIFI_INTERFACE_IBSS; 297 using ::WIFI_INTERFACE_MESH; 298 using ::wifi_interface_mode; 299 using ::WIFI_INTERFACE_NAN; 300 using ::WIFI_INTERFACE_P2P_CLIENT; 301 using ::WIFI_INTERFACE_P2P_GO; 302 using ::WIFI_INTERFACE_SOFTAP; 303 using ::WIFI_INTERFACE_STA; 304 using ::WIFI_INTERFACE_TDLS; 305 using ::wifi_interface_type; 306 using ::WIFI_INTERFACE_TYPE_AP; 307 using ::WIFI_INTERFACE_TYPE_NAN; 308 using ::WIFI_INTERFACE_TYPE_P2P; 309 using ::WIFI_INTERFACE_TYPE_STA; 310 using ::WIFI_INTERFACE_UNKNOWN; 311 using ::wifi_latency_mode; 312 using ::WIFI_LATENCY_MODE_LOW; 313 using ::WIFI_LATENCY_MODE_NORMAL; 314 using ::wifi_lci_information; 315 using ::wifi_lcr_information; 316 using ::WIFI_LOGGER_CONNECT_EVENT_SUPPORTED; 317 using ::WIFI_LOGGER_DRIVER_DUMP_SUPPORTED; 318 using ::WIFI_LOGGER_MEMORY_DUMP_SUPPORTED; 319 using ::WIFI_LOGGER_PACKET_FATE_SUPPORTED; 320 using ::WIFI_LOGGER_POWER_EVENT_SUPPORTED; 321 using ::WIFI_LOGGER_WAKE_LOCK_SUPPORTED; 322 using ::wifi_mlo_mode; 323 using ::WIFI_MOTION_EXPECTED; 324 using ::WIFI_MOTION_NOT_EXPECTED; 325 using ::wifi_motion_pattern; 326 using ::WIFI_MOTION_UNKNOWN; 327 using ::wifi_multi_sta_use_case; 328 using ::wifi_power_scenario; 329 using ::WIFI_POWER_SCENARIO_ON_BODY_CELL_OFF; 330 using ::WIFI_POWER_SCENARIO_ON_BODY_CELL_ON; 331 using ::WIFI_POWER_SCENARIO_ON_HEAD_CELL_OFF; 332 using ::WIFI_POWER_SCENARIO_ON_HEAD_CELL_ON; 333 using ::WIFI_POWER_SCENARIO_VOICE_CALL; 334 using ::wifi_radio_combination; 335 using ::wifi_radio_combination_matrix; 336 using ::wifi_radio_configuration; 337 using ::wifi_rate; 338 using ::wifi_request_id; 339 using ::wifi_ring_buffer_status; 340 using ::wifi_roaming_capabilities; 341 using ::wifi_roaming_config; 342 using ::wifi_rtt_bw; 343 using ::WIFI_RTT_BW_10; 344 using ::WIFI_RTT_BW_160; 345 using ::WIFI_RTT_BW_20; 346 using ::WIFI_RTT_BW_320; 347 using ::WIFI_RTT_BW_40; 348 using ::WIFI_RTT_BW_5; 349 using ::WIFI_RTT_BW_80; 350 using ::WIFI_RTT_BW_UNSPECIFIED; 351 using ::wifi_rtt_capabilities; 352 using ::wifi_rtt_config; 353 using ::wifi_rtt_preamble; 354 using ::WIFI_RTT_PREAMBLE_EHT; 355 using ::WIFI_RTT_PREAMBLE_HE; 356 using ::WIFI_RTT_PREAMBLE_HT; 357 using ::WIFI_RTT_PREAMBLE_LEGACY; 358 using ::WIFI_RTT_PREAMBLE_VHT; 359 using ::wifi_rtt_responder; 360 using ::wifi_rtt_result; 361 using ::wifi_rtt_result_v2; 362 using ::wifi_rtt_status; 363 using ::wifi_rtt_type; 364 using ::wifi_rx_packet_fate; 365 using ::wifi_rx_report; 366 using ::wifi_scan_bucket_spec; 367 using ::wifi_scan_cmd_params; 368 using ::WIFI_SCAN_FLAG_INTERRUPTED; 369 using ::wifi_scan_result; 370 using ::WIFI_SUCCESS; 371 using ::wifi_tx_packet_fate; 372 using ::wifi_tx_report; 373 using ::wifi_usable_channel; 374 using ::WIFI_USABLE_CHANNEL_FILTER_CELLULAR_COEXISTENCE; 375 using ::WIFI_USABLE_CHANNEL_FILTER_CONCURRENCY; 376 using ::WLAN_MAC_2_4_BAND; 377 using ::WLAN_MAC_5_0_BAND; 378 using ::WLAN_MAC_60_0_BAND; 379 using ::WLAN_MAC_6_0_BAND; 380 381 // APF capabilities supported by the iface. 382 struct PacketFilterCapabilities { 383 uint32_t version; 384 uint32_t max_len; 385 }; 386 387 // WARNING: We don't care about the variable sized members of either 388 // |wifi_iface_stat|, |wifi_radio_stat| structures. So, using the pragma 389 // to escape the compiler warnings regarding this. 390 #pragma GCC diagnostic push 391 #pragma GCC diagnostic ignored "-Wgnu-variable-sized-type-not-at-end" 392 // The |wifi_radio_stat.tx_time_per_levels| stats is provided as a pointer in 393 // |wifi_radio_stat| structure in the legacy HAL API. Separate that out 394 // into a separate return element to avoid passing pointers around. 395 struct LinkLayerRadioStats { 396 wifi_radio_stat stats; 397 std::vector<uint32_t> tx_time_per_levels; 398 std::vector<wifi_channel_stat> channel_stats; 399 }; 400 401 struct WifiPeerInfo { 402 wifi_peer_info peer_info; 403 std::vector<wifi_rate_stat> rate_stats; 404 }; 405 406 struct LinkLayerStats { 407 wifi_iface_stat iface; 408 std::vector<LinkLayerRadioStats> radios; 409 std::vector<WifiPeerInfo> peers; 410 bool valid; 411 }; 412 413 struct LinkStats { 414 wifi_link_stat stat; 415 std::vector<WifiPeerInfo> peers; 416 }; 417 418 struct LinkLayerMlStats { 419 wifi_iface_ml_stat iface; 420 std::vector<LinkStats> links; 421 std::vector<LinkLayerRadioStats> radios; 422 bool valid; 423 }; 424 425 #pragma GCC diagnostic pop 426 427 // The |WLAN_DRIVER_WAKE_REASON_CNT.cmd_event_wake_cnt| and 428 // |WLAN_DRIVER_WAKE_REASON_CNT.driver_fw_local_wake_cnt| stats is provided 429 // as a pointer in |WLAN_DRIVER_WAKE_REASON_CNT| structure in the legacy HAL 430 // API. Separate that out into a separate return elements to avoid passing 431 // pointers around. 432 struct WakeReasonStats { 433 WLAN_DRIVER_WAKE_REASON_CNT wake_reason_cnt; 434 std::vector<uint32_t> cmd_event_wake_cnt; 435 std::vector<uint32_t> driver_fw_local_wake_cnt; 436 }; 437 438 // NAN response and event callbacks struct. 439 struct NanCallbackHandlers { 440 // NotifyResponse invoked to notify the status of the Request. 441 std::function<void(transaction_id, const NanResponseMsg&)> on_notify_response; 442 // Various event callbacks. 443 std::function<void(const NanPublishTerminatedInd&)> on_event_publish_terminated; 444 std::function<void(const NanMatchInd&)> on_event_match; 445 std::function<void(const NanMatchExpiredInd&)> on_event_match_expired; 446 std::function<void(const NanSubscribeTerminatedInd&)> on_event_subscribe_terminated; 447 std::function<void(const NanFollowupInd&)> on_event_followup; 448 std::function<void(const NanDiscEngEventInd&)> on_event_disc_eng_event; 449 std::function<void(const NanDisabledInd&)> on_event_disabled; 450 std::function<void(const NanTCAInd&)> on_event_tca; 451 std::function<void(const NanBeaconSdfPayloadInd&)> on_event_beacon_sdf_payload; 452 std::function<void(const NanDataPathRequestInd&)> on_event_data_path_request; 453 std::function<void(const NanDataPathConfirmInd&)> on_event_data_path_confirm; 454 std::function<void(const NanDataPathEndInd&)> on_event_data_path_end; 455 std::function<void(const NanTransmitFollowupInd&)> on_event_transmit_follow_up; 456 std::function<void(const NanRangeRequestInd&)> on_event_range_request; 457 std::function<void(const NanRangeReportInd&)> on_event_range_report; 458 std::function<void(const NanDataPathScheduleUpdateInd&)> on_event_schedule_update; 459 std::function<void(const NanPairingRequestInd&)> on_event_pairing_request; 460 std::function<void(const NanPairingConfirmInd&)> on_event_pairing_confirm; 461 std::function<void(const NanBootstrappingRequestInd&)> on_event_bootstrapping_request; 462 std::function<void(const NanBootstrappingConfirmInd&)> on_event_bootstrapping_confirm; 463 std::function<void(const NanSuspensionModeChangeInd&)> on_event_suspension_mode_change; 464 }; 465 466 // Full scan results contain IE info and are hence passed by reference, to 467 // preserve the variable length array member |ie_data|. Callee must not retain 468 // the pointer. 469 using on_gscan_full_result_callback = 470 std::function<void(wifi_request_id, const wifi_scan_result*, uint32_t)>; 471 // These scan results don't contain any IE info, so no need to pass by 472 // reference. 473 using on_gscan_results_callback = 474 std::function<void(wifi_request_id, const std::vector<wifi_cached_scan_results>&)>; 475 476 // Invoked when the rssi value breaches the thresholds set. 477 using on_rssi_threshold_breached_callback = 478 std::function<void(wifi_request_id, std::array<uint8_t, ETH_ALEN>, int8_t)>; 479 480 // Callback for RTT range request results. 481 // Rtt results contain IE info and are hence passed by reference, to 482 // preserve the |LCI| and |LCR| pointers. Callee must not retain 483 // the pointer. 484 using on_rtt_results_callback = 485 std::function<void(wifi_request_id, const std::vector<const wifi_rtt_result*>&)>; 486 using on_rtt_results_callback_v2 = 487 std::function<void(wifi_request_id, const std::vector<const wifi_rtt_result_v2*>&)>; 488 489 // Callback for ring buffer data. 490 using on_ring_buffer_data_callback = std::function<void( 491 const std::string&, const std::vector<uint8_t>&, const wifi_ring_buffer_status&)>; 492 493 // Callback for alerts. 494 using on_error_alert_callback = std::function<void(int32_t, const std::vector<uint8_t>&)>; 495 496 // Callback for subsystem restart 497 using on_subsystem_restart_callback = std::function<void(const std::string&)>; 498 499 // Struct for the mac info from the legacy HAL. This is a cleaner version 500 // of the |wifi_mac_info| & |wifi_iface_info|. 501 typedef struct { 502 std::string name; 503 wifi_channel channel; 504 } WifiIfaceInfo; 505 506 typedef struct { 507 uint32_t wlan_mac_id; 508 /* BIT MASK of BIT(WLAN_MAC*) as represented by wlan_mac_band */ 509 uint32_t mac_band; 510 /* Represents the connected Wi-Fi interfaces associated with each MAC */ 511 std::vector<WifiIfaceInfo> iface_infos; 512 } WifiMacInfo; 513 514 // Callback for radio mode change 515 using on_radio_mode_change_callback = std::function<void(const std::vector<WifiMacInfo>&)>; 516 517 // TWT response and event callbacks struct. 518 struct TwtCallbackHandlers { 519 // Callback for TWT setup response 520 std::function<void(const TwtSetupResponse&)> on_setup_response; 521 // Callback for TWT teardown completion 522 std::function<void(const TwtTeardownCompletion&)> on_teardown_completion; 523 // Callback for TWT info frame received event 524 std::function<void(const TwtInfoFrameReceived&)> on_info_frame_received; 525 // Callback for TWT notification from the device 526 std::function<void(const TwtDeviceNotify&)> on_device_notify; 527 }; 528 529 // CHRE response and event callbacks struct. 530 struct ChreCallbackHandlers { 531 // Callback for CHRE NAN RTT 532 std::function<void(chre_nan_rtt_state)> on_wifi_chre_nan_rtt_state; 533 }; 534 535 // Cached Scan Results response and event callbacks struct. 536 struct CachedScanResultsCallbackHandlers { 537 // Callback for Cached Scan Results 538 std::function<void(wifi_cached_scan_report*)> on_cached_scan_results; 539 }; 540 541 /** 542 * Class that encapsulates all legacy HAL interactions. 543 * This class manages the lifetime of the event loop thread used by legacy HAL. 544 * 545 * Note: There will only be a single instance of this class created in the Wifi 546 * object and will be valid for the lifetime of the process. 547 */ 548 class WifiLegacyHal { 549 public: 550 WifiLegacyHal(const std::weak_ptr<::android::wifi_system::InterfaceTool> iface_tool, 551 const wifi_hal_fn& fn, bool is_primary); 552 virtual ~WifiLegacyHal() = default; 553 554 // Initialize the legacy HAL function table. 555 virtual wifi_error initialize(); 556 // Start the legacy HAL and the event looper thread. 557 virtual wifi_error start(); 558 // Deinitialize the legacy HAL and wait for the event loop thread to exit 559 // using a predefined timeout. 560 virtual wifi_error stop(std::unique_lock<std::recursive_mutex>* lock, 561 const std::function<void()>& on_complete_callback); 562 virtual wifi_error waitForDriverReady(); 563 // Checks if legacy HAL has successfully started 564 bool isStarted(); 565 // Wrappers for all the functions in the legacy HAL function table. 566 virtual std::pair<wifi_error, std::string> getDriverVersion(const std::string& iface_name); 567 virtual std::pair<wifi_error, std::string> getFirmwareVersion(const std::string& iface_name); 568 std::pair<wifi_error, std::vector<uint8_t>> requestDriverMemoryDump( 569 const std::string& iface_name); 570 std::pair<wifi_error, std::vector<uint8_t>> requestFirmwareMemoryDump( 571 const std::string& iface_name); 572 virtual std::pair<wifi_error, uint64_t> getSupportedFeatureSet(const std::string& iface_name); 573 // APF functions. 574 std::pair<wifi_error, PacketFilterCapabilities> getPacketFilterCapabilities( 575 const std::string& iface_name); 576 wifi_error setPacketFilter(const std::string& iface_name, const std::vector<uint8_t>& program); 577 std::pair<wifi_error, std::vector<uint8_t>> readApfPacketFilterData( 578 const std::string& iface_name); 579 // Gscan functions. 580 std::pair<wifi_error, wifi_gscan_capabilities> getGscanCapabilities( 581 const std::string& iface_name); 582 // These API's provides a simplified interface over the legacy Gscan API's: 583 // a) All scan events from the legacy HAL API other than the 584 // |WIFI_SCAN_FAILED| are treated as notification of results. 585 // This method then retrieves the cached scan results from the legacy 586 // HAL API and triggers the externally provided 587 // |on_results_user_callback| on success. 588 // b) |WIFI_SCAN_FAILED| scan event or failure to retrieve cached scan 589 // results 590 // Triggers the externally provided |on_failure_user_callback|. 591 // c) Full scan result event triggers the externally provided 592 // |on_full_result_user_callback|. 593 wifi_error startGscan(const std::string& iface_name, wifi_request_id id, 594 const wifi_scan_cmd_params& params, 595 const std::function<void(wifi_request_id)>& on_failure_callback, 596 const on_gscan_results_callback& on_results_callback, 597 const on_gscan_full_result_callback& on_full_result_callback); 598 wifi_error stopGscan(const std::string& iface_name, wifi_request_id id); 599 std::pair<wifi_error, std::vector<uint32_t>> getValidFrequenciesForBand( 600 const std::string& iface_name, wifi_band band); 601 virtual wifi_error setDfsFlag(const std::string& iface_name, bool dfs_on); 602 // Link layer stats functions. 603 wifi_error enableLinkLayerStats(const std::string& iface_name, bool debug); 604 wifi_error disableLinkLayerStats(const std::string& iface_name); 605 wifi_error getLinkLayerStats(const std::string& iface_name, 606 legacy_hal::LinkLayerStats& legacy_stats, 607 legacy_hal::LinkLayerMlStats& legacy_ml_stats); 608 // RSSI monitor functions. 609 wifi_error startRssiMonitoring( 610 const std::string& iface_name, wifi_request_id id, int8_t max_rssi, int8_t min_rssi, 611 const on_rssi_threshold_breached_callback& on_threshold_breached_callback); 612 wifi_error stopRssiMonitoring(const std::string& iface_name, wifi_request_id id); 613 std::pair<wifi_error, wifi_roaming_capabilities> getRoamingCapabilities( 614 const std::string& iface_name); 615 wifi_error configureRoaming(const std::string& iface_name, const wifi_roaming_config& config); 616 wifi_error enableFirmwareRoaming(const std::string& iface_name, fw_roaming_state_t state); 617 wifi_error configureNdOffload(const std::string& iface_name, bool enable); 618 wifi_error startSendingOffloadedPacket(const std::string& iface_name, int32_t cmd_id, 619 uint16_t ether_type, 620 const std::vector<uint8_t>& ip_packet_data, 621 const std::array<uint8_t, 6>& src_address, 622 const std::array<uint8_t, 6>& dst_address, 623 int32_t period_in_ms); 624 wifi_error stopSendingOffloadedPacket(const std::string& iface_name, uint32_t cmd_id); 625 virtual wifi_error selectTxPowerScenario(const std::string& iface_name, 626 wifi_power_scenario scenario); 627 virtual wifi_error resetTxPowerScenario(const std::string& iface_name); 628 wifi_error setLatencyMode(const std::string& iface_name, wifi_latency_mode mode); 629 wifi_error setThermalMitigationMode(wifi_thermal_mode mode, uint32_t completion_window); 630 wifi_error setDscpToAccessCategoryMapping(uint32_t start, uint32_t end, 631 uint32_t access_category); 632 wifi_error resetDscpToAccessCategoryMapping(); 633 // Logger/debug functions. 634 std::pair<wifi_error, uint32_t> getLoggerSupportedFeatureSet(const std::string& iface_name); 635 wifi_error startPktFateMonitoring(const std::string& iface_name); 636 std::pair<wifi_error, std::vector<wifi_tx_report>> getTxPktFates(const std::string& iface_name); 637 std::pair<wifi_error, std::vector<wifi_rx_report>> getRxPktFates(const std::string& iface_name); 638 std::pair<wifi_error, WakeReasonStats> getWakeReasonStats(const std::string& iface_name); 639 wifi_error registerRingBufferCallbackHandler( 640 const std::string& iface_name, const on_ring_buffer_data_callback& on_data_callback); 641 wifi_error deregisterRingBufferCallbackHandler(const std::string& iface_name); 642 virtual wifi_error registerSubsystemRestartCallbackHandler( 643 const on_subsystem_restart_callback& on_restart_callback); 644 std::pair<wifi_error, std::vector<wifi_ring_buffer_status>> getRingBuffersStatus( 645 const std::string& iface_name); 646 wifi_error startRingBufferLogging(const std::string& iface_name, const std::string& ring_name, 647 uint32_t verbose_level, uint32_t max_interval_sec, 648 uint32_t min_data_size); 649 wifi_error getRingBufferData(const std::string& iface_name, const std::string& ring_name); 650 wifi_error registerErrorAlertCallbackHandler(const std::string& iface_name, 651 const on_error_alert_callback& on_alert_callback); 652 wifi_error deregisterErrorAlertCallbackHandler(const std::string& iface_name); 653 // Radio mode functions. 654 virtual wifi_error registerRadioModeChangeCallbackHandler( 655 const std::string& iface_name, 656 const on_radio_mode_change_callback& on_user_change_callback); 657 // RTT functions. 658 wifi_error startRttRangeRequest(const std::string& iface_name, wifi_request_id id, 659 const std::vector<wifi_rtt_config>& rtt_configs, 660 const on_rtt_results_callback& on_results_callback, 661 const on_rtt_results_callback_v2& on_results_callback_v2); 662 wifi_error cancelRttRangeRequest(const std::string& iface_name, wifi_request_id id, 663 const std::vector<std::array<uint8_t, ETH_ALEN>>& mac_addrs); 664 std::pair<wifi_error, wifi_rtt_capabilities> getRttCapabilities(const std::string& iface_name); 665 std::pair<wifi_error, wifi_rtt_responder> getRttResponderInfo(const std::string& iface_name); 666 wifi_error enableRttResponder(const std::string& iface_name, wifi_request_id id, 667 const wifi_channel_info& channel_hint, uint32_t max_duration_secs, 668 const wifi_rtt_responder& info); 669 wifi_error disableRttResponder(const std::string& iface_name, wifi_request_id id); 670 wifi_error setRttLci(const std::string& iface_name, wifi_request_id id, 671 const wifi_lci_information& info); 672 wifi_error setRttLcr(const std::string& iface_name, wifi_request_id id, 673 const wifi_lcr_information& info); 674 // NAN functions. 675 virtual wifi_error nanRegisterCallbackHandlers(const std::string& iface_name, 676 const NanCallbackHandlers& callbacks); 677 wifi_error nanEnableRequest(const std::string& iface_name, transaction_id id, 678 const NanEnableRequest& msg); 679 virtual wifi_error nanDisableRequest(const std::string& iface_name, transaction_id id); 680 wifi_error nanPublishRequest(const std::string& iface_name, transaction_id id, 681 const NanPublishRequest& msg); 682 wifi_error nanPublishCancelRequest(const std::string& iface_name, transaction_id id, 683 const NanPublishCancelRequest& msg); 684 wifi_error nanSubscribeRequest(const std::string& iface_name, transaction_id id, 685 const NanSubscribeRequest& msg); 686 wifi_error nanSubscribeCancelRequest(const std::string& iface_name, transaction_id id, 687 const NanSubscribeCancelRequest& msg); 688 wifi_error nanTransmitFollowupRequest(const std::string& iface_name, transaction_id id, 689 const NanTransmitFollowupRequest& msg); 690 wifi_error nanStatsRequest(const std::string& iface_name, transaction_id id, 691 const NanStatsRequest& msg); 692 wifi_error nanConfigRequest(const std::string& iface_name, transaction_id id, 693 const NanConfigRequest& msg); 694 wifi_error nanTcaRequest(const std::string& iface_name, transaction_id id, 695 const NanTCARequest& msg); 696 wifi_error nanBeaconSdfPayloadRequest(const std::string& iface_name, transaction_id id, 697 const NanBeaconSdfPayloadRequest& msg); 698 std::pair<wifi_error, NanVersion> nanGetVersion(); 699 wifi_error nanGetCapabilities(const std::string& iface_name, transaction_id id); 700 wifi_error nanDataInterfaceCreate(const std::string& iface_name, transaction_id id, 701 const std::string& data_iface_name); 702 virtual wifi_error nanDataInterfaceDelete(const std::string& iface_name, transaction_id id, 703 const std::string& data_iface_name); 704 wifi_error nanDataRequestInitiator(const std::string& iface_name, transaction_id id, 705 const NanDataPathInitiatorRequest& msg); 706 wifi_error nanDataIndicationResponse(const std::string& iface_name, transaction_id id, 707 const NanDataPathIndicationResponse& msg); 708 wifi_error nanPairingRequest(const std::string& iface_name, transaction_id id, 709 const NanPairingRequest& msg); 710 wifi_error nanPairingIndicationResponse(const std::string& iface_name, transaction_id id, 711 const NanPairingIndicationResponse& msg); 712 wifi_error nanBootstrappingRequest(const std::string& iface_name, transaction_id id, 713 const NanBootstrappingRequest& msg); 714 wifi_error nanBootstrappingIndicationResponse(const std::string& iface_name, transaction_id id, 715 const NanBootstrappingIndicationResponse& msg); 716 wifi_error nanDataEnd(const std::string& iface_name, transaction_id id, uint32_t ndpInstanceId); 717 wifi_error nanPairingEnd(const std::string& iface_name, transaction_id id, uint32_t pairingId); 718 wifi_error nanSuspendRequest(const std::string& iface_name, transaction_id id, 719 const NanSuspendRequest& msg); 720 wifi_error nanResumeRequest(const std::string& iface_name, transaction_id id, 721 const NanResumeRequest& msg); 722 // AP functions. 723 wifi_error setCountryCode(const std::string& iface_name, const std::array<uint8_t, 2> code); 724 725 // Interface functions. 726 virtual wifi_error createVirtualInterface(const std::string& ifname, 727 wifi_interface_type iftype); 728 virtual wifi_error deleteVirtualInterface(const std::string& ifname); 729 virtual wifi_error getSupportedIfaceName(uint32_t iface_type, std::string& ifname); 730 731 // STA + STA functions 732 virtual wifi_error multiStaSetPrimaryConnection(const std::string& ifname); 733 virtual wifi_error multiStaSetUseCase(wifi_multi_sta_use_case use_case); 734 735 // Coex functions. 736 virtual wifi_error setCoexUnsafeChannels(std::vector<wifi_coex_unsafe_channel> unsafe_channels, 737 uint32_t restrictions); 738 739 wifi_error setVoipMode(const std::string& iface_name, wifi_voip_mode mode); 740 741 wifi_error twtRegisterHandler(const std::string& iface_name, 742 const TwtCallbackHandlers& handler); 743 744 std::pair<wifi_error, TwtCapabilitySet> twtGetCapability(const std::string& iface_name); 745 746 wifi_error twtSetupRequest(const std::string& iface_name, const TwtSetupRequest& msg); 747 748 wifi_error twtTearDownRequest(const std::string& iface_name, const TwtTeardownRequest& msg); 749 750 wifi_error twtInfoFrameRequest(const std::string& iface_name, const TwtInfoFrameRequest& msg); 751 752 std::pair<wifi_error, TwtStats> twtGetStats(const std::string& iface_name, uint8_t configId); 753 754 wifi_error twtClearStats(const std::string& iface_name, uint8_t configId); 755 756 wifi_error setScanMode(const std::string& iface_name, bool enable); 757 758 wifi_error setDtimConfig(const std::string& iface_name, uint32_t multiplier); 759 760 // Retrieve the list of usable channels in the requested bands 761 // for the requested modes 762 std::pair<wifi_error, std::vector<wifi_usable_channel>> getUsableChannels( 763 uint32_t band_mask, uint32_t iface_mode_mask, uint32_t filter_mask); 764 765 wifi_error triggerSubsystemRestart(); 766 767 wifi_error setIndoorState(bool isIndoor); 768 769 std::pair<wifi_error, wifi_radio_combination_matrix*> getSupportedRadioCombinationsMatrix(); 770 771 // CHRE NAN RTT function 772 wifi_error chreNanRttRequest(const std::string& iface_name, bool enable); 773 774 wifi_error chreRegisterHandler(const std::string& iface_name, 775 const ChreCallbackHandlers& handler); 776 777 wifi_error enableWifiTxPowerLimits(const std::string& iface_name, bool enable); 778 wifi_error getWifiCachedScanResults(const std::string& iface_name, 779 const CachedScanResultsCallbackHandlers& handler); 780 std::pair<wifi_error, wifi_chip_capabilities> getWifiChipCapabilities(); 781 wifi_error enableStaChannelForPeerNetwork(uint32_t channelCategoryEnableFlag); 782 wifi_error setMloMode(wifi_mlo_mode mode); 783 std::pair<wifi_error, wifi_iface_concurrency_matrix> getSupportedIfaceConcurrencyMatrix(); 784 785 private: 786 // Retrieve interface handles for all the available interfaces. 787 wifi_error retrieveIfaceHandles(); 788 wifi_interface_handle getIfaceHandle(const std::string& iface_name); 789 // Run the legacy HAL event loop thread. 790 void runEventLoop(); 791 // Retrieve the cached gscan results to pass the results back to the 792 // external callbacks. 793 std::pair<wifi_error, std::vector<wifi_cached_scan_results>> getGscanCachedResults( 794 const std::string& iface_name); 795 void invalidate(); 796 // Handles wifi (error) status of Virtual interface create/delete 797 wifi_error handleVirtualInterfaceCreateOrDeleteStatus(const std::string& ifname, 798 wifi_error status); 799 wifi_link_stat* copyLinkStat(wifi_link_stat* stat_ptr, std::vector<LinkStats>& stats); 800 wifi_peer_info* copyPeerInfo(wifi_peer_info* peer_ptr, std::vector<WifiPeerInfo>& peers); 801 802 // Global function table of legacy HAL. 803 wifi_hal_fn global_func_table_; 804 // Opaque handle to be used for all global operations. 805 wifi_handle global_handle_; 806 // Map of interface name to handle that is to be used for all interface 807 // specific operations. 808 std::map<std::string, wifi_interface_handle> iface_name_to_handle_; 809 // Flag to indicate if we have initiated the cleanup of legacy HAL. 810 std::atomic<bool> awaiting_event_loop_termination_; 811 std::condition_variable_any stop_wait_cv_; 812 // Flag to indicate if the legacy HAL has been started. 813 bool is_started_; 814 std::weak_ptr<::android::wifi_system::InterfaceTool> iface_tool_; 815 // Flag to indicate if this HAL is for the primary chip. This is used 816 // in order to avoid some hard-coded behavior used with older HALs, 817 // such as bring wlan0 interface up/down on start/stop HAL. 818 // it may be removed once vendor HALs are updated. 819 bool is_primary_; 820 }; 821 822 } // namespace legacy_hal 823 } // namespace wifi 824 } // namespace hardware 825 } // namespace android 826 } // namespace aidl 827 828 #endif // WIFI_LEGACY_HAL_H_ 829