• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_IFACE_UTIL_H_
18 #define WIFI_IFACE_UTIL_H_
19 
20 #include <aidl/android/hardware/wifi/IWifi.h>
21 #include <wifi_system/interface_tool.h>
22 
23 #include "wifi_legacy_hal.h"
24 
25 namespace aidl {
26 namespace android {
27 namespace hardware {
28 namespace wifi {
29 namespace iface_util {
30 
31 // Iface event handlers.
32 struct IfaceEventHandlers {
33     // Callback to be invoked when the iface is set down & up for MAC address
34     // change.
35     std::function<void(const std::string& iface_name)> on_state_toggle_off_on;
36 };
37 
38 /**
39  * Util class for common iface operations.
40  */
41 class WifiIfaceUtil {
42   public:
43     WifiIfaceUtil(const std::weak_ptr<::android::wifi_system::InterfaceTool> iface_tool,
44                   const std::weak_ptr<legacy_hal::WifiLegacyHal> legacy_hal);
45     virtual ~WifiIfaceUtil() = default;
46 
47     virtual std::array<uint8_t, 6> getFactoryMacAddress(const std::string& iface_name);
48     virtual bool setMacAddress(const std::string& iface_name, const std::array<uint8_t, 6>& mac);
49     // Get or create a random MAC address. The MAC address returned from
50     // this method will remain the same throughout the lifetime of the HAL
51     // daemon. (So, changes on every reboot)
52     virtual std::array<uint8_t, 6> getOrCreateRandomMacAddress();
53 
54     // Register for any iface event callbacks for the provided interface.
55     virtual void registerIfaceEventHandlers(const std::string& iface_name,
56                                             IfaceEventHandlers handlers);
57     virtual void unregisterIfaceEventHandlers(const std::string& iface_name);
58     virtual bool setUpState(const std::string& iface_name, bool request_up);
59     virtual unsigned ifNameToIndex(const std::string& iface_name);
60 
61     virtual bool createBridge(const std::string& br_name);
62 
63     virtual bool deleteBridge(const std::string& br_name);
64 
65     virtual bool addIfaceToBridge(const std::string& br_name, const std::string& if_name);
66 
67     virtual bool removeIfaceFromBridge(const std::string& br_name, const std::string& if_name);
68     // Get a random MAC address.
69     virtual std::array<uint8_t, 6> createRandomMacAddress();
70 
71   private:
72     std::weak_ptr<::android::wifi_system::InterfaceTool> iface_tool_;
73     std::weak_ptr<legacy_hal::WifiLegacyHal> legacy_hal_;
74     std::unique_ptr<std::array<uint8_t, 6>> random_mac_address_;
75     std::map<std::string, IfaceEventHandlers> event_handlers_map_;
76 };
77 
78 }  // namespace iface_util
79 }  // namespace wifi
80 }  // namespace hardware
81 }  // namespace android
82 }  // namespace aidl
83 
84 #endif  // WIFI_IFACE_UTIL_H_
85