wifi/1.6/default/wifi_sta_iface.h

/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef WIFI_STA_IFACE_H_
#define WIFI_STA_IFACE_H_

#include <android-base/macros.h>
#include <android/hardware/wifi/1.0/IWifiStaIfaceEventCallback.h>
#include <android/hardware/wifi/1.6/IWifiStaIface.h>

#include "hidl_callback_util.h"
#include "wifi_iface_util.h"
#include "wifi_legacy_hal.h"

namespace android {
namespace hardware {
namespace wifi {
namespace V1_6 {
namespace implementation {
using namespace android::hardware::wifi::V1_0;

/**
 * HIDL interface object used to control a STA Iface instance.
 */
class WifiStaIface : public V1_6::IWifiStaIface {
  public:
    WifiStaIface(const std::string& ifname,
                 const std::weak_ptr<legacy_hal::WifiLegacyHal> legacy_hal,
                 const std::weak_ptr<iface_util::WifiIfaceUtil> iface_util);
    // Refer to |WifiChip::invalidate()|.
    void invalidate();
    bool isValid();
    std::set<sp<IWifiStaIfaceEventCallback>> getEventCallbacks();
    std::string getName();

    // HIDL methods exposed.
    Return<void> getName(getName_cb hidl_status_cb) override;
    Return<void> getType(getType_cb hidl_status_cb) override;
    Return<void> registerEventCallback(const sp<IWifiStaIfaceEventCallback>& callback,
                                       registerEventCallback_cb hidl_status_cb) override;
    Return<void> getCapabilities(getCapabilities_cb hidl_status_cb) override;
    Return<void> getApfPacketFilterCapabilities(
            getApfPacketFilterCapabilities_cb hidl_status_cb) override;
    Return<void> installApfPacketFilter(uint32_t cmd_id, const hidl_vec<uint8_t>& program,
                                        installApfPacketFilter_cb hidl_status_cb) override;
    Return<void> readApfPacketFilterData(readApfPacketFilterData_cb hidl_status_cb) override;
    Return<void> getBackgroundScanCapabilities(
            getBackgroundScanCapabilities_cb hidl_status_cb) override;
    Return<void> getValidFrequenciesForBand(V1_0::WifiBand band,
                                            getValidFrequenciesForBand_cb hidl_status_cb) override;
    Return<void> startBackgroundScan(uint32_t cmd_id, const StaBackgroundScanParameters& params,
                                     startBackgroundScan_cb hidl_status_cb) override;
    Return<void> stopBackgroundScan(uint32_t cmd_id, stopBackgroundScan_cb hidl_status_cb) override;
    Return<void> enableLinkLayerStatsCollection(
            bool debug, enableLinkLayerStatsCollection_cb hidl_status_cb) override;
    Return<void> disableLinkLayerStatsCollection(
            disableLinkLayerStatsCollection_cb hidl_status_cb) override;
    Return<void> getLinkLayerStats(getLinkLayerStats_cb hidl_status_cb) override;
    Return<void> getLinkLayerStats_1_3(getLinkLayerStats_1_3_cb hidl_status_cb) override;
    Return<void> getLinkLayerStats_1_5(getLinkLayerStats_1_5_cb hidl_status_cb) override;
    Return<void> getLinkLayerStats_1_6(getLinkLayerStats_1_6_cb hidl_status_cb) override;
    Return<void> startRssiMonitoring(uint32_t cmd_id, int32_t max_rssi, int32_t min_rssi,
                                     startRssiMonitoring_cb hidl_status_cb) override;
    Return<void> stopRssiMonitoring(uint32_t cmd_id, stopRssiMonitoring_cb hidl_status_cb) override;
    Return<void> getRoamingCapabilities(getRoamingCapabilities_cb hidl_status_cb) override;
    Return<void> configureRoaming(const StaRoamingConfig& config,
                                  configureRoaming_cb hidl_status_cb) override;
    Return<void> setRoamingState(StaRoamingState state, setRoamingState_cb hidl_status_cb) override;
    Return<void> enableNdOffload(bool enable, enableNdOffload_cb hidl_status_cb) override;
    Return<void> startSendingKeepAlivePackets(
            uint32_t cmd_id, const hidl_vec<uint8_t>& ip_packet_data, uint16_t ether_type,
            const hidl_array<uint8_t, 6>& src_address, const hidl_array<uint8_t, 6>& dst_address,
            uint32_t period_in_ms, startSendingKeepAlivePackets_cb hidl_status_cb) override;
    Return<void> stopSendingKeepAlivePackets(
            uint32_t cmd_id, stopSendingKeepAlivePackets_cb hidl_status_cb) override;
    Return<void> setScanningMacOui(const hidl_array<uint8_t, 3>& oui,
                                   setScanningMacOui_cb hidl_status_cb) override;
    Return<void> startDebugPacketFateMonitoring(
            startDebugPacketFateMonitoring_cb hidl_status_cb) override;
    Return<void> getDebugTxPacketFates(getDebugTxPacketFates_cb hidl_status_cb) override;
    Return<void> getDebugRxPacketFates(getDebugRxPacketFates_cb hidl_status_cb) override;
    Return<void> setMacAddress(const hidl_array<uint8_t, 6>& mac,
                               setMacAddress_cb hidl_status_cb) override;
    Return<void> getFactoryMacAddress(getFactoryMacAddress_cb hidl_status_cb) override;
    Return<void> setScanMode(bool enable, setScanMode_cb hidl_status_cb) override;

  private:
    // Corresponding worker functions for the HIDL methods.
    std::pair<WifiStatus, std::string> getNameInternal();
    std::pair<WifiStatus, IfaceType> getTypeInternal();
    WifiStatus registerEventCallbackInternal(const sp<IWifiStaIfaceEventCallback>& callback);
    std::pair<WifiStatus, uint32_t> getCapabilitiesInternal();
    std::pair<WifiStatus, StaApfPacketFilterCapabilities> getApfPacketFilterCapabilitiesInternal();
    WifiStatus installApfPacketFilterInternal(uint32_t cmd_id, const std::vector<uint8_t>& program);
    std::pair<WifiStatus, std::vector<uint8_t>> readApfPacketFilterDataInternal();
    std::pair<WifiStatus, StaBackgroundScanCapabilities> getBackgroundScanCapabilitiesInternal();
    std::pair<WifiStatus, std::vector<WifiChannelInMhz>> getValidFrequenciesForBandInternal(
            V1_0::WifiBand band);
    WifiStatus startBackgroundScanInternal(uint32_t cmd_id,
                                           const StaBackgroundScanParameters& params);
    WifiStatus stopBackgroundScanInternal(uint32_t cmd_id);
    WifiStatus enableLinkLayerStatsCollectionInternal(bool debug);
    WifiStatus disableLinkLayerStatsCollectionInternal();
    std::pair<WifiStatus, V1_0::StaLinkLayerStats> getLinkLayerStatsInternal();
    std::pair<WifiStatus, V1_3::StaLinkLayerStats> getLinkLayerStatsInternal_1_3();
    std::pair<WifiStatus, V1_5::StaLinkLayerStats> getLinkLayerStatsInternal_1_5();
    std::pair<WifiStatus, V1_6::StaLinkLayerStats> getLinkLayerStatsInternal_1_6();
    WifiStatus startRssiMonitoringInternal(uint32_t cmd_id, int32_t max_rssi, int32_t min_rssi);
    WifiStatus stopRssiMonitoringInternal(uint32_t cmd_id);
    std::pair<WifiStatus, StaRoamingCapabilities> getRoamingCapabilitiesInternal();
    WifiStatus configureRoamingInternal(const StaRoamingConfig& config);
    WifiStatus setRoamingStateInternal(StaRoamingState state);
    WifiStatus enableNdOffloadInternal(bool enable);
    WifiStatus startSendingKeepAlivePacketsInternal(uint32_t cmd_id,
                                                    const std::vector<uint8_t>& ip_packet_data,
                                                    uint16_t ether_type,
                                                    const std::array<uint8_t, 6>& src_address,
                                                    const std::array<uint8_t, 6>& dst_address,
                                                    uint32_t period_in_ms);
    WifiStatus stopSendingKeepAlivePacketsInternal(uint32_t cmd_id);
    WifiStatus setScanningMacOuiInternal(const std::array<uint8_t, 3>& oui);
    WifiStatus startDebugPacketFateMonitoringInternal();
    std::pair<WifiStatus, std::vector<WifiDebugTxPacketFateReport>> getDebugTxPacketFatesInternal();
    std::pair<WifiStatus, std::vector<WifiDebugRxPacketFateReport>> getDebugRxPacketFatesInternal();
    WifiStatus setMacAddressInternal(const std::array<uint8_t, 6>& mac);
    std::pair<WifiStatus, std::array<uint8_t, 6>> getFactoryMacAddressInternal();
    WifiStatus setScanModeInternal(bool enable);

    std::string ifname_;
    std::weak_ptr<legacy_hal::WifiLegacyHal> legacy_hal_;
    std::weak_ptr<iface_util::WifiIfaceUtil> iface_util_;
    bool is_valid_;
    hidl_callback_util::HidlCallbackHandler<IWifiStaIfaceEventCallback> event_cb_handler_;

    DISALLOW_COPY_AND_ASSIGN(WifiStaIface);
};

}  // namespace implementation
}  // namespace V1_6
}  // namespace wifi
}  // namespace hardware
}  // namespace android

#endif  // WIFI_STA_IFACE_H_