Home | History | Annotate | Download | only in 1.1 
      1 /*
      2  * Copyright (C) 2017 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 
     17 package android.hardware.gnss@1.1;
     18 
     19 import @1.0::IGnss;
     20 import @1.0::GnssLocation;
     21 
     22 import IGnssCallback;
     23 import IGnssConfiguration;
     24 import IGnssMeasurement;
     25 
     26 /** Represents the standard GNSS (Global Navigation Satellite System) interface. */
     27 interface IGnss extends @1.0::IGnss {
     28     /**
     29      * Opens the interface and provides the callback routines to the implementation of this
     30      * interface.
     31      *
     32      * @param callback Callback interface for IGnss.
     33      *
     34      * @return success Returns true on success.
     35      */
     36     setCallback_1_1(IGnssCallback callback) generates (bool success);
     37 
     38     /**
     39      * Sets the GnssPositionMode parameter, its associated recurrence value,
     40      * the time between fixes, requested fix accuracy, time to first fix.
     41      *
     42      * @param mode Parameter must be one of MS_BASED or STANDALONE. It is allowed by the platform
     43      *     (and it is recommended) to fallback to MS_BASED if MS_ASSISTED is passed in, and MS_BASED
     44      *     is supported.
     45      * @param recurrence GNSS postion recurrence value, either periodic or single.
     46      * @param minIntervalMs Represents the time between fixes in milliseconds.
     47      * @param preferredAccuracyMeters Represents the requested fix accuracy in meters.
     48      * @param preferredTimeMs Represents the requested time to first fix in milliseconds.
     49      * @param lowPowerMode When true, and IGnss.hal is the only client to the GNSS hardware, the
     50      *     GNSS hardware must make strong tradeoffs to substantially restrict power use.
     51      *     Specifically, in the case of a several second long minIntervalMs, the GNSS hardware must
     52      *     not, on average, run power hungry operations like RF and signal searches for more than
     53      *     one second per interval, and must make exactly one call to gnssSvStatusCb(), and either
     54      *     zero or one call to GnssLocationCb() at each interval. When false, HAL must operate in
     55      *     the nominal mode (similar to V1.0 where this flag wasn't present) and is expected to make
     56      *     power and performance tradoffs such as duty-cycling when signal conditions are good and
     57      *     more active searches to reacquire GNSS signals when no signals are present.
     58      *     When there are additional clients using the GNSS hardware other than IGnss.hal, the GNSS
     59      *     hardware may operate in a higher power mode, on behalf of those clients.
     60      *
     61      * @return success Returns true if successful.
     62      */
     63     setPositionMode_1_1(GnssPositionMode mode,
     64                         GnssPositionRecurrence recurrence,
     65                         uint32_t minIntervalMs,
     66                         uint32_t preferredAccuracyMeters,
     67                         uint32_t preferredTimeMs,
     68                         bool lowPowerMode)
     69              generates (bool success);
     70 
     71    /**
     72     * This method returns the IGnssConfiguration interface.
     73     *
     74     * @return gnssConfigurationIface Handle to the IGnssConfiguration interface.
     75     */
     76     getExtensionGnssConfiguration_1_1() generates (IGnssConfiguration gnssConfigurationIface);
     77 
     78    /**
     79     * This method returns the IGnssMeasurement interface.
     80     *
     81     * @return gnssMeasurementIface Handle to the IGnssMeasurement interface.
     82     */
     83     getExtensionGnssMeasurement_1_1() generates (IGnssMeasurement gnssMeasurementIface);
     84 
     85     /**
     86      * Injects current location from the best available location provider.
     87      *
     88      * Unlike injectLocation, this method may inject a recent GNSS location from the HAL
     89      * implementation, if that is the best available location known to the framework.
     90      *
     91      * @param location Location information from the best available location provider.
     92      *
     93      * @return success Returns true if successful.
     94      */
     95     injectBestLocation(GnssLocation location) generates (bool success);
     96 };