1/*
2 * Copyright 2018 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.3;
18
19import @1.0::WifiStatus;
20import @1.0::MacAddress;
21import @1.2::IWifiStaIface;
22
23/**
24 * Interface used to represent a single STA iface.
25 *
26 * IWifiChip.createStaIface() must return a @1.3::IWifiStaIface when supported.
27 */
28interface IWifiStaIface extends @1.2::IWifiStaIface {
29    /**
30     * Retrieve the latest link layer stats.
31     * Must fail if |StaIfaceCapabilityMask.LINK_LAYER_STATS| is not set or if
32     * link layer stats collection hasn't been explicitly enabled.
33     *
34     * @return status WifiStatus of the operation.
35     *     Possible status codes:
36     *     |WifiStatusCode.SUCCESS|,
37     *     |WifiStatusCode.ERROR_WIFI_IFACE_INVALID|,
38     *     |WifiStatusCode.ERROR_NOT_SUPPORTED|,
39     *     |WifiStatusCode.ERROR_NOT_STARTED|,
40     *     |WifiStatusCode.ERROR_NOT_AVAILABLE|,
41     *     |WifiStatusCode.ERROR_UNKNOWN|
42     * @return stats Instance of |LinkLayerStats|.
43     */
44    getLinkLayerStats_1_3() generates (WifiStatus status, StaLinkLayerStats stats);
45
46    /**
47     * Gets the factory MAC address of the Sta Interface
48     * @return status WifiStatus of the operation
49     *         Possible status codes:
50     *         |WifiStatusCode.SUCCESS|,
51     *         |WifiStatusCode.ERROR_WIFI_IFACE_INVALID|,
52     *         |WifiStatusCode.ERROR_UNKNOWN|
53     * @return mac Factory MAC address of the Sta Interface
54     */
55     getFactoryMacAddress() generates (WifiStatus status, MacAddress mac);
56};
57