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