xref: /aosp_15_r20/hardware/interfaces/wifi/1.6/IWifiNanIface.hal (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)

/*
 * Copyright 2022 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.0::WifiStatus;
import @1.0::CommandIdShort;
import @1.4::NanConfigRequest;
import @1.4::NanEnableRequest;
import @1.5::IWifiNanIface;
import IWifiNanIfaceEventCallback;
import NanConfigRequestSupplemental;
import NanInitiateDataPathRequest;
import NanPublishRequest;
import NanRespondToDataPathIndicationRequest;

/**
 * Interface used to represent a single NAN (Neighbour Aware Network) iface.
 *
 * References to "NAN Spec" are to the Wi-Fi Alliance "Wi-Fi Neighbor Awareness
 * Networking (NAN) Technical Specification".
 */
interface IWifiNanIface extends @1.5::IWifiNanIface {
    /**
     * Requests notifications of significant events on this iface. Multiple calls
     * to this must register multiple callbacks each of which must receive all
     * events.
     *
     * @param callback An instance of the |IWifiNanIfaceEventCallback| HIDL interface
     *        object.
     * @return status WifiStatus of the operation.
     *         Possible status codes:
     *         |WifiStatusCode.SUCCESS|,
     *         |WifiStatusCode.ERROR_WIFI_IFACE_INVALID|
     */
    registerEventCallback_1_6(IWifiNanIfaceEventCallback callback) generates (WifiStatus status);

    /**
     * Initiate a data-path (NDP) setup operation: Initiator.
     * Asynchronous response is with |IWifiNanIfaceEventCallback.notifyInitiateDataPathResponse|.
     *
     * Note: supersedes the @1.0::IWifiNanIface.respondToDataPathIndicationRequest() method which is
     * deprecated as of HAL version 1.6.
     *
     * @param cmdId command Id to use for this invocation.
     * @param msg Instance of |NanInitiateDataPathRequest|.
     * @return status WifiStatus of the operation.
     *         Possible status codes:
     *         |WifiStatusCode.SUCCESS|,
     *         |WifiStatusCode.ERROR_WIFI_IFACE_INVALID|,
     *         |WifiStatusCode.ERROR_INVALID_ARGS|,
     *         |WifiStatusCode.ERROR_UNKNOWN|
     */
    initiateDataPathRequest_1_6(CommandIdShort cmdId, NanInitiateDataPathRequest msg)
        generates (WifiStatus status);

    /**
     * Respond to a received data indication as part of a data-path (NDP) setup operation. An
     * indication is received by the Responder from the Initiator.
     * Asynchronous response is with
     * |IWifiNanIfaceEventCallback.notifyRespondToDataPathIndicationResponse|.
     *
     * Note: supersedes the @1.0::IWifiNanIface.respondToDataPathIndicationRequest() method which is
     * deprecated as of HAL version 1.6.
     *
     * @param cmdId command Id to use for this invocation.
     * @param msg Instance of |NanRespondToDataPathIndicationRequest|.
     * @return status WifiStatus of the operation.
     *         Possible status codes:
     *         |WifiStatusCode.SUCCESS|,
     *         |WifiStatusCode.ERROR_WIFI_IFACE_INVALID|,
     *         |WifiStatusCode.ERROR_INVALID_ARGS|,
     *         |WifiStatusCode.ERROR_UNKNOWN|
     */
    respondToDataPathIndicationRequest_1_6(CommandIdShort cmdId,
        NanRespondToDataPathIndicationRequest msg) generates (WifiStatus status);

    /**
     * Enable NAN: configures and activates NAN clustering (does not start
     * a discovery session or set up data-interfaces or data-paths). Use the
     * |IWifiNanIface.configureRequest| method to change the configuration of an already enabled
     * NAN interface.
     * Asynchronous response is with |IWifiNanIfaceEventCallback.notifyEnableResponse|.
     *
     * Note: supersedes the @1.5::IWifiNanIface.enableRequest() method which is deprecated as of
     * HAL version 1.6.
     *
     * @param cmdId command Id to use for this invocation.
     * @param msg1 Instance of |NanEnableRequest|.
     * @param msg2 Instance of |NanConfigRequestSupplemental|.
     * @return status WifiStatus of the operation.
     *         Possible status codes:
     *         |WifiStatusCode.SUCCESS|,
     *         |WifiStatusCode.ERROR_NOT_SUPPORTED|,
     *         |WifiStatusCode.ERROR_WIFI_IFACE_INVALID|,
     *         |WifiStatusCode.ERROR_INVALID_ARGS|,
     *         |WifiStatusCode.ERROR_UNKNOWN|
     */
    enableRequest_1_6(CommandIdShort cmdId, NanEnableRequest msg1,
        NanConfigRequestSupplemental msg2) generates (WifiStatus status);

    /**
     * Configure NAN: configures an existing NAN functionality (i.e. assumes
     * |IWifiNanIface.enableRequest| already submitted and succeeded).
     * Asynchronous response is with |IWifiNanIfaceEventCallback.notifyConfigResponse|.
     *
     * Note: supersedes the @1.5::IWifiNanIface.configRequest() method which is deprecated as of
     * HAL version 1.6.
     *
     * @param cmdId command Id to use for this invocation.
     * @param msg1 Instance of |NanConfigRequest|.
     * @param msg2 Instance of |NanConfigRequestSupplemental|.
     * @return status WifiStatus of the operation.
     *         Possible status codes:
     *         |WifiStatusCode.SUCCESS|,
     *         |WifiStatusCode.ERROR_NOT_SUPPORTED|,
     *         |WifiStatusCode.ERROR_WIFI_IFACE_INVALID|,
     *         |WifiStatusCode.ERROR_INVALID_ARGS|,
     *         |WifiStatusCode.ERROR_UNKNOWN|
     */
    configRequest_1_6(CommandIdShort cmdId, NanConfigRequest msg1,
        NanConfigRequestSupplemental msg2) generates (WifiStatus status);

    /**
     * Publish request to start advertising a discovery service.
     * Asynchronous response is with |IWifiNanIfaceEventCallback.notifyStartPublishResponse|.
     *
     * Note: supersedes the @1.0::IWifiNanIface.startPublishRequest() method which is deprecated as
     * of HAL version 1.6.
     *
     * @param cmdId command Id to use for this invocation.
     * @param msg Instance of |NanPublishRequest|.
     * @return status WifiStatus of the operation.
     *         Possible status codes:
     *         |WifiStatusCode.SUCCESS|,
     *         |WifiStatusCode.ERROR_WIFI_IFACE_INVALID|,
     *         |WifiStatusCode.ERROR_INVALID_ARGS|,
     *         |WifiStatusCode.ERROR_UNKNOWN|
     */
    startPublishRequest_1_6(CommandIdShort cmdId, NanPublishRequest msg)
        generates (WifiStatus status);
};