xref: /aosp_15_r20/hardware/interfaces/gnss/2.1/IGnssAntennaInfo.hal (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)

/*
 * Copyright (C) 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 IGnssAntennaInfoCallback;

/**
 * Extended interface for GNSS antenna information support.
 */
interface IGnssAntennaInfo {
    enum GnssAntennaInfoStatus : int32_t {
        SUCCESS = 0,
        ERROR_ALREADY_INIT = -100,
        ERROR_GENERIC = -101,
    };

    /**
     * Registers the callback routines with the HAL.
     *
     * @param callback Handle to the GnssAntennaInfo callback interface.
     */
    setCallback(IGnssAntennaInfoCallback callback) generates (GnssAntennaInfoStatus initRet);

    /**
     * Stops updates from the HAL, and unregisters the callback routines.
     * After a call to close(), the previously registered callbacks must be
     * considered invalid by the HAL.
     * If close() is invoked without a previous setCallback, this function must perform
     * no work.
     */
    close();
};