xref: /aosp_15_r20/hardware/interfaces/wifi/1.5/IWifiApIface.hal (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)

/*
 * 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 [email protected];

import @1.4::IWifiApIface;
import @1.0::MacAddress;
import @1.0::WifiStatus;

/**
 * Represents a network interface in AP mode.
 *
 * This can be obtained through @1.0::IWifiChip.getApIface() and casting
 * IWifiApIface up to 1.5.
 */
interface IWifiApIface extends @1.4::IWifiApIface {
    /**
     * Reset all of the AP interfaces MAC address to the factory MAC address.
     *
     * @return status WifiStatus of the operation
     *         Possible status codes:
     *         |WifiStatusCode.SUCCESS|,
     *         |WifiStatusCode.ERROR_WIFI_IFACE_INVALID|,
     *         |WifiStatusCode.ERROR_UNKNOWN|
     */
    resetToFactoryMacAddress() generates (WifiStatus status);

    /**
     * Get the names of the bridged AP instances.
     *
     * @return status WifiStatus of the operation
     *         Possible status codes:
     *         |WifiStatusCode.SUCCESS|,
     *         |WifiStatusCode.ERROR_WIFI_IFACE_INVALID|,
     *         |WifiStatusCode.ERROR_UNKNOWN|
     *
     * @return instances A vector which contains the names of the bridged AP
     * instances. Note: Returns an empty vector for a non-bridged AP.
     */
    getBridgedInstances() generates (WifiStatus status, vec<string> instances);
};