gnss/3.0/IGnssPsds.hal

/*
 * 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 android.hardware.gnss@3.0;

import @1.0::IGnssXtra;
import IGnssPsdsCallback;

/**
 * This interface is used by the GNSS HAL to request the framework to download Predicted Satellite
 * Data Service data.
 */
interface IGnssPsds extends @1.0::IGnssXtra {
    /**
     * Opens the PSDS interface and provides the callback routines to the implementation of this
     * interface.
     *
     * @param callback Handle to the IGnssPsdsCallback interface.
     *
     * @return success True if the operation is successful.
     */
    setCallback_3_0(IGnssPsdsCallback callback) generates (bool success);

    /**
     * Inject the downloaded PSDS data into the GNSS receiver.
     *
     * @param psdsType Type of PSDS as defined in IGnssPsdsCallback.hal
     * @param psdsData GNSS PSDS data. Framework must not parse the data since the data format is
     *                 opaque to framework.
     *
     * @return success True if the operation is successful.
     */
    injectPsdsData_3_0(int32_t psdsType, string psdsData) generates (bool success);
};