1845b8e555
This commit improves some of the comments for the Wifi Hidl APIs. Bug: 148236141 Test: No test is done Change-Id: Iff6b191c8b258615ddaacad570b81f0ada968ed4
56 lines
2 KiB
Text
56 lines
2 KiB
Text
/*
|
|
* Copyright 2018 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.3;
|
|
|
|
import @1.0::WifiStatus;
|
|
import @1.0::MacAddress;
|
|
import @1.2::IWifiStaIface;
|
|
|
|
/**
|
|
* Interface used to represent a single STA iface.
|
|
*
|
|
* IWifiChip.createStaIface() must return a @1.3::IWifiStaIface when supported.
|
|
*/
|
|
interface IWifiStaIface extends @1.2::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_3() generates (WifiStatus status, StaLinkLayerStats stats);
|
|
|
|
/**
|
|
* Gets the factory MAC address of the Sta Interface
|
|
* @return status WifiStatus of the operation
|
|
* Possible status codes:
|
|
* |WifiStatusCode.SUCCESS|,
|
|
* |WifiStatusCode.ERROR_WIFI_IFACE_INVALID|,
|
|
* |WifiStatusCode.ERROR_UNKNOWN|
|
|
* @return mac Factory MAC address of the Sta Interface
|
|
*/
|
|
getFactoryMacAddress() generates (WifiStatus status, MacAddress mac);
|
|
};
|