blob: daf545eb9c6a7261e1bba087b571a31f71ac9d33 [file] [log] [blame]
Roshan Piuse9d1e7d2020-11-04 11:44:16 -08001/*
2 * Copyright 2020 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
17package android.hardware.wifi@1.5;
18
19import @1.0::WifiStatus;
20import @1.3::IWifiStaIface;
21
22/**
23 * Interface used to represent a single STA iface.
24 *
25 * IWifiChip.createStaIface() must return a @1.5::IWifiStaIface when supported.
26 */
27interface IWifiStaIface extends @1.3::IWifiStaIface {
28 /**
29 * Retrieve the latest link layer stats.
30 * Must fail if |StaIfaceCapabilityMask.LINK_LAYER_STATS| is not set or if
31 * link layer stats collection hasn't been explicitly enabled.
32 *
33 * @return status WifiStatus of the operation.
34 * Possible status codes:
35 * |WifiStatusCode.SUCCESS|,
36 * |WifiStatusCode.ERROR_WIFI_IFACE_INVALID|,
37 * |WifiStatusCode.ERROR_NOT_SUPPORTED|,
38 * |WifiStatusCode.ERROR_NOT_STARTED|,
39 * |WifiStatusCode.ERROR_NOT_AVAILABLE|,
40 * |WifiStatusCode.ERROR_UNKNOWN|
41 * @return stats Instance of |LinkLayerStats|.
42 */
43 getLinkLayerStats_1_5() generates (WifiStatus status, StaLinkLayerStats stats);
Ye Jiaoc6b5f892021-01-15 15:42:09 +080044
45 /**
46 * Turn on/off scan only mode for the interface.
47 *
48 * @param enable Indicate if scan only mode is to be turned on/off.
49 * @return status Status of the operation.
50 * Possible status codes:
51 * |WifiStatusCode.SUCCESS|,
52 * |WifiStatusCode.ERROR_NOT_SUPPORTED|,
53 * |WifiStatusCode.ERROR_WIFI_IFACE_INVALID|,
54 * |WifiStatusCode.FAILURE_UNKNOWN|
55 */
56 setScanMode(bool enable) generates (WifiStatus status);
Roshan Piuse9d1e7d2020-11-04 11:44:16 -080057};