1 /*
2  * Copyright (C) 2016 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_RTT_CONTROLLER_H_
18 #define WIFI_RTT_CONTROLLER_H_
19 
20 #include <android-base/macros.h>
21 #include <android/hardware/wifi/1.0/IWifiIface.h>
22 #include <android/hardware/wifi/1.4/IWifiRttController.h>
23 #include <android/hardware/wifi/1.4/IWifiRttControllerEventCallback.h>
24 
25 #include "wifi_legacy_hal.h"
26 
27 namespace android {
28 namespace hardware {
29 namespace wifi {
30 namespace V1_4 {
31 namespace implementation {
32 
33 /**
34  * HIDL interface object used to control all RTT operations.
35  */
36 class WifiRttController : public V1_4::IWifiRttController {
37    public:
38     WifiRttController(
39         const std::string& iface_name, const sp<IWifiIface>& bound_iface,
40         const std::weak_ptr<legacy_hal::WifiLegacyHal> legacy_hal);
41     // Refer to |WifiChip::invalidate()|.
42     void invalidate();
43     bool isValid();
44     std::vector<sp<IWifiRttControllerEventCallback>> getEventCallbacks();
45     std::string getIfaceName();
46 
47     // HIDL methods exposed.
48     Return<void> getBoundIface(getBoundIface_cb hidl_status_cb) override;
49     Return<void> registerEventCallback(
50         const sp<V1_0::IWifiRttControllerEventCallback>& callback,
51         registerEventCallback_cb hidl_status_cb) override;
52     Return<void> rangeRequest(uint32_t cmd_id,
53                               const hidl_vec<V1_0::RttConfig>& rtt_configs,
54                               rangeRequest_cb hidl_status_cb) override;
55     Return<void> rangeCancel(uint32_t cmd_id,
56                              const hidl_vec<hidl_array<uint8_t, 6>>& addrs,
57                              rangeCancel_cb hidl_status_cb) override;
58     Return<void> getCapabilities(getCapabilities_cb hidl_status_cb) override;
59     Return<void> setLci(uint32_t cmd_id, const RttLciInformation& lci,
60                         setLci_cb hidl_status_cb) override;
61     Return<void> setLcr(uint32_t cmd_id, const RttLcrInformation& lcr,
62                         setLcr_cb hidl_status_cb) override;
63     Return<void> getResponderInfo(getResponderInfo_cb hidl_status_cb) override;
64     Return<void> enableResponder(uint32_t cmd_id,
65                                  const WifiChannelInfo& channel_hint,
66                                  uint32_t max_duration_seconds,
67                                  const V1_0::RttResponder& info,
68                                  enableResponder_cb hidl_status_cb) override;
69     Return<void> disableResponder(uint32_t cmd_id,
70                                   disableResponder_cb hidl_status_cb) override;
71     Return<void> registerEventCallback_1_4(
72         const sp<IWifiRttControllerEventCallback>& callback,
73         registerEventCallback_1_4_cb hidl_status_cb) override;
74     Return<void> rangeRequest_1_4(uint32_t cmd_id,
75                                   const hidl_vec<RttConfig>& rtt_configs,
76                                   rangeRequest_1_4_cb hidl_status_cb) override;
77     Return<void> getCapabilities_1_4(
78         getCapabilities_1_4_cb hidl_status_cb) override;
79     Return<void> getResponderInfo_1_4(
80         getResponderInfo_1_4_cb hidl_status_cb) override;
81     Return<void> enableResponder_1_4(
82         uint32_t cmd_id, const WifiChannelInfo& channel_hint,
83         uint32_t max_duration_seconds, const RttResponder& info,
84         enableResponder_1_4_cb hidl_status_cb) override;
85 
86    private:
87     // Corresponding worker functions for the HIDL methods.
88     std::pair<WifiStatus, sp<IWifiIface>> getBoundIfaceInternal();
89     WifiStatus registerEventCallbackInternal(
90         const sp<V1_0::IWifiRttControllerEventCallback>& callback);
91     WifiStatus rangeRequestInternal(
92         uint32_t cmd_id, const std::vector<V1_0::RttConfig>& rtt_configs);
93     WifiStatus rangeCancelInternal(
94         uint32_t cmd_id, const std::vector<hidl_array<uint8_t, 6>>& addrs);
95     std::pair<WifiStatus, V1_0::RttCapabilities> getCapabilitiesInternal();
96     WifiStatus setLciInternal(uint32_t cmd_id, const RttLciInformation& lci);
97     WifiStatus setLcrInternal(uint32_t cmd_id, const RttLcrInformation& lcr);
98     std::pair<WifiStatus, V1_0::RttResponder> getResponderInfoInternal();
99     WifiStatus enableResponderInternal(uint32_t cmd_id,
100                                        const WifiChannelInfo& channel_hint,
101                                        uint32_t max_duration_seconds,
102                                        const V1_0::RttResponder& info);
103     WifiStatus disableResponderInternal(uint32_t cmd_id);
104     WifiStatus registerEventCallbackInternal_1_4(
105         const sp<IWifiRttControllerEventCallback>& callback);
106     WifiStatus rangeRequestInternal_1_4(
107         uint32_t cmd_id, const std::vector<RttConfig>& rtt_configs);
108     std::pair<WifiStatus, RttCapabilities> getCapabilitiesInternal_1_4();
109     std::pair<WifiStatus, RttResponder> getResponderInfoInternal_1_4();
110     WifiStatus enableResponderInternal_1_4(uint32_t cmd_id,
111                                            const WifiChannelInfo& channel_hint,
112                                            uint32_t max_duration_seconds,
113                                            const RttResponder& info);
114 
115     std::string ifname_;
116     sp<IWifiIface> bound_iface_;
117     std::weak_ptr<legacy_hal::WifiLegacyHal> legacy_hal_;
118     std::vector<sp<IWifiRttControllerEventCallback>> event_callbacks_;
119     bool is_valid_;
120 
121     DISALLOW_COPY_AND_ASSIGN(WifiRttController);
122 };
123 
124 }  // namespace implementation
125 }  // namespace V1_4
126 }  // namespace wifi
127 }  // namespace hardware
128 }  // namespace android
129 
130 #endif  // WIFI_RTT_CONTROLLER_H_
131