diff options
author | Anil Admal <aadmal@google.com> | 2019-05-08 18:18:19 -0700 |
---|---|---|
committer | Anil Admal <aadmal@google.com> | 2019-05-09 15:58:00 -0700 |
commit | a3afa5c65caf4bf48c4b8fc95c3760d0c38b6573 (patch) | |
tree | 1885a29f70dd513b061f08588fd45b4a6695358d /gnss | |
parent | e5289f618c6c614ab30a1a5b8d66ba9a917b623b (diff) | |
download | android_hardware_interfaces-a3afa5c65caf4bf48c4b8fc95c3760d0c38b6573.tar.gz android_hardware_interfaces-a3afa5c65caf4bf48c4b8fc95c3760d0c38b6573.tar.bz2 android_hardware_interfaces-a3afa5c65caf4bf48c4b8fc95c3760d0c38b6573.zip |
Update @2.0::IGnss.hal setCallback() method documentation
The IGnss.hal setCallback() and cleanup() methods need to be updated
to clarify when the framework calls them so that that the GNSS engine
knows when to shut down for power savings.
This CL updates the @2.0::IGnss.hal setCallback() method documenation
only. The @1.1::IGnss.hal and @1.0::IGnss.hal setCallback() and cleanup()
method documentation is updated in another CL.
Bug: 124104175
Test: Existing tests pass
Change-Id: I6a2dd6f82becc0adef8b4b56fe83e7c004aefd7a
Diffstat (limited to 'gnss')
-rw-r--r-- | gnss/2.0/IGnss.hal | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/gnss/2.0/IGnss.hal b/gnss/2.0/IGnss.hal index f19f8d056..9935bf914 100644 --- a/gnss/2.0/IGnss.hal +++ b/gnss/2.0/IGnss.hal @@ -36,13 +36,18 @@ import IGnssBatching; * the interface @1.0::IGnssNi.hal and @1.0::IGnssNiCallback.hal are deprecated in this version * and are not supported by the framework. The GNSS HAL implementation of this interface * must return nullptr for the following @1.0::IGnss method. - * getExtensionGnssNi() generates (IGnssNi gnssNiIface); + * getExtensionGnssNi() generates (IGnssNi gnssNiIface); */ interface IGnss extends @1.1::IGnss { /** * Opens the interface and provides the callback routines to the implementation of this * interface. * + * The framework calls this method to instruct the GPS engine to prepare for serving requests + * from the framework. The GNSS HAL implementation must respond to all GNSS requests from the + * framework upon successful return from this method until cleanup() method is called to + * close this interface. + * * @param callback Callback interface for IGnss. * * @return success Returns true on success. @@ -83,8 +88,9 @@ interface IGnss extends @1.1::IGnss { /** * This method returns the IGnssMeasurement interface. * - * Exactly one of getExtensionGnssMeasurement_1_1() and getExtensionGnssMeasurement_2_0() must - * return a non-null handle, and the other method must return nullptr. + * Exactly one of getExtensionGnssMeasurement(), getExtensionGnssMeasurement_1_1(), and + * getExtensionGnssMeasurement_2_0() methods must return a non-null handle, and the other + * methods must return nullptr. * * @return gnssMeasurementIface Handle to the IGnssMeasurement interface. */ |