platform_hardware_interfaces/wifi/1.5/IWifiStaIface.hal
Ye Jiao c6b5f89b08 Notify scan-only mode to driver for power saving
If Wi-Fi driver knows it's in scan-only mode, it can save more power
than connect mode.

This change adds setScanMode in IWifiStaIface to allow Wi-Fi framework
to notify scan-only mode change to Wi-Fi driver.

Bug: 177811719
Test: atest VtsHalWifiV1_5TargetTest

Change-Id: I1dfbc24a0a3272c1341223aff36656be4a6fd21b
2021-01-22 23:05:30 +00:00

57 lines
2.1 KiB
Text

/*
* Copyright 2020 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.
*/
package android.hardware.wifi@1.5;
import @1.0::WifiStatus;
import @1.3::IWifiStaIface;
/**
* Interface used to represent a single STA iface.
*
* IWifiChip.createStaIface() must return a @1.5::IWifiStaIface when supported.
*/
interface IWifiStaIface extends @1.3::IWifiStaIface {
/**
* Retrieve the latest link layer stats.
* Must fail if |StaIfaceCapabilityMask.LINK_LAYER_STATS| is not set or if
* link layer stats collection hasn't been explicitly enabled.
*
* @return status WifiStatus of the operation.
* Possible status codes:
* |WifiStatusCode.SUCCESS|,
* |WifiStatusCode.ERROR_WIFI_IFACE_INVALID|,
* |WifiStatusCode.ERROR_NOT_SUPPORTED|,
* |WifiStatusCode.ERROR_NOT_STARTED|,
* |WifiStatusCode.ERROR_NOT_AVAILABLE|,
* |WifiStatusCode.ERROR_UNKNOWN|
* @return stats Instance of |LinkLayerStats|.
*/
getLinkLayerStats_1_5() generates (WifiStatus status, StaLinkLayerStats stats);
/**
* Turn on/off scan only mode for the interface.
*
* @param enable Indicate if scan only mode is to be turned on/off.
* @return status Status of the operation.
* Possible status codes:
* |WifiStatusCode.SUCCESS|,
* |WifiStatusCode.ERROR_NOT_SUPPORTED|,
* |WifiStatusCode.ERROR_WIFI_IFACE_INVALID|,
* |WifiStatusCode.FAILURE_UNKNOWN|
*/
setScanMode(bool enable) generates (WifiStatus status);
};