/*
 * Copyright (C) 2016 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.net.wifi.nl80211;

import android.net.wifi.nl80211.IApInterface;
import android.net.wifi.nl80211.IClientInterface;
import android.net.wifi.nl80211.IInterfaceEventCallback;
import android.net.wifi.nl80211.IWificondEventCallback;
import android.net.wifi.nl80211.DeviceWiphyCapabilities;

/**
 * Service interface that exposes primitives for controlling the WiFi
 * subsystems of a device.
 * @hide
 */
interface IWificond {

    // Create a network interface suitable for use as an AP.
    @nullable IApInterface createApInterface(@utf8InCpp String iface_name);

    // Create a network interface suitable for use as a WiFi client.
    @nullable IClientInterface createClientInterface(@utf8InCpp String iface_name);

    // Remove a previously created AP network interface.
    boolean tearDownApInterface(@utf8InCpp String iface_name);

    // Remove a previously created STA network interface.
    boolean tearDownClientInterface(@utf8InCpp String iface_name);

    // Tear down all existing interfaces.  This should enable clients to create
    // future interfaces immediately after this method returns.
    void tearDownInterfaces();

    // @return list of the currently configured IClientInterface instances.
    List<IBinder> GetClientInterfaces();

    // @return list of the currently configured IApInterface instances.
    List<IBinder> GetApInterfaces();

    // Returns an array of available frequencies for 2.4GHz channels.
    // Returrns null on failure.
    @nullable int[] getAvailable2gChannels();

    // Returns an array of available frequencies for 5GHz non-DFS channels.
    // Returrns null on failure.
    @nullable int[] getAvailable5gNonDFSChannels();

    // Returns an array of available frequencies for DFS channels.
    // This also includes passive only frequecies which are not for DFS channels.
    // Returrns null on failure.
    @nullable int[] getAvailableDFSChannels();

    // Returns an array of available frequencies for 6GHz channels.
    // Returrns null on failure.
    @nullable int[] getAvailable6gChannels();

    // Returns an array of available frequencies for 60GHz channels.
    // Returrns null on failure.
    @nullable int[] getAvailable60gChannels();

    // Register a callback to receive interface status updates.
    //
    // Multiple callbacks can be registered simultaneously.
    // Duplicate registrations of the same callback will be ignored.
    //
    // @param callback object to add to the set of registered callbacks.
    oneway void RegisterCallback(IInterfaceEventCallback callback);

    // Remove a callback from the set of registered callbacks.
    //
    // This must be the same instance as previously registered.
    // Requests to remove unknown callbacks will be ignored.
    //
    // @param callback object to remove from the set of registered callbacks.
    oneway void UnregisterCallback(IInterfaceEventCallback callback);

    // Register a callback to receive wificond event.
    //
    // Multiple callbacks can be registered simultaneously.
    // Duplicate registrations of the same callback will be ignored.
    //
    // @param callback object to add to the set of registered callbacks.
    oneway void registerWificondEventCallback(IWificondEventCallback callback);

    // Remove a callback from the set of registered wificond event callbacks.
    //
    // This must be the same instance as previously registered.
    // Requests to remove unknown callbacks will be ignored.
    //
    // @param callback object to remove from the set of registered callbacks.
    oneway void unregisterWificondEventCallback(IWificondEventCallback callback);

    // @return a device wiphy capabilities for an interface
    @nullable DeviceWiphyCapabilities getDeviceWiphyCapabilities(@utf8InCpp String iface_name);

    // Notify wificond country code changed. It is being used when the driver doesn't support
    // NL80211_CMD_REG_CHANGE or NL80211_CMD_WIPHY_REG_CHANGE
    oneway void notifyCountryCodeChanged();
}