xref: /aosp_15_r20/hardware/interfaces/wifi/1.6/IWifiStaIface.hal (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)
1/*
2 * Copyright 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
17package [email protected];
18
19import @1.0::WifiStatus;
20import @1.5::IWifiStaIface;
21
22/**
23 * Interface used to represent a single STA iface.
24 *
25 * IWifiChip.createStaIface() must return a @1.6::IWifiStaIface when supported.
26 */
27interface IWifiStaIface extends @1.5::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_6() generates (WifiStatus status, StaLinkLayerStats stats);
44};
45