1/*
2 * Copyright (C) 2019 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.hardware.gnss@2.1;
18
19import @1.0::IGnssMeasurement;
20import @1.1::IGnssMeasurement;
21import @2.0::IGnssMeasurement;
22import IGnssMeasurementCallback;
23
24/**
25 * Extended interface for GNSS Measurements support.
26 */
27interface IGnssMeasurement extends @2.0::IGnssMeasurement {
28    /**
29     * Initializes the interface and registers the callback routines with the HAL. After a
30     * successful call to 'setCallback_2_1' the HAL must begin to provide updates at an average
31     * output rate of 1Hz (occasional intra-measurement time offsets in the range from 0-2000msec
32     * can be tolerated.)
33     *
34     * @param callback Handle to GnssMeasurement callback interface.
35     * @param enableFullTracking If true, GNSS chipset must switch off duty cycling. In such mode
36     *     no clock discontinuities are expected and, when supported, carrier phase should be
37     *     continuous in good signal conditions. All non-blacklisted, healthy constellations,
38     *     satellites and frequency bands that the chipset supports must be reported in this mode.
39     *     The GNSS chipset is allowed to consume more power in this mode. If false, API must behave
40     *     as in HAL V1_0, optimizing power via duty cycling, constellations and frequency limits,
41     *     etc.
42     *
43     * @return initRet Returns SUCCESS if successful. Returns ERROR_ALREADY_INIT if a callback has
44     *     already been registered without a corresponding call to 'close'. Returns ERROR_GENERIC
45     *     for any other error. The HAL must not generate any other updates upon returning this
46     *     error code.
47     */
48    setCallback_2_1(IGnssMeasurementCallback callback, bool enableFullTracking)
49        generates (GnssMeasurementStatus initRet);
50};
51