From a3afa5c65caf4bf48c4b8fc95c3760d0c38b6573 Mon Sep 17 00:00:00 2001 From: Anil Admal Date: Wed, 8 May 2019 18:18:19 -0700 Subject: [PATCH] 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 --- current.txt | 2 +- gnss/2.0/IGnss.hal | 12 +++++++++--- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/current.txt b/current.txt index 30839471c9..01053a0b12 100644 --- a/current.txt +++ b/current.txt @@ -467,7 +467,7 @@ f27baaa587bc3dd9b740cb6928ab812b9b7d105b5187663938aee578105f3c39 android.hardwar 7f460e795f5d1ed5e378935f98c6db4d39497de988aef1b4c2a4a07a6c400392 android.hardware.gnss@2.0::IAGnss 2e5ad983734069e84a760004b32da0d09e4170c05380abe27e6eb80e4aa70d5a android.hardware.gnss@2.0::IAGnssCallback 1f4ac068a88a72360280d94a7f6fd7c63813c1eea4891a0eb01394d3e7e775f2 android.hardware.gnss@2.0::IAGnssRil -4deafcdcffa2d002119e7f58810b767a84666e76475aae68e757ec2845d9756d android.hardware.gnss@2.0::IGnss +f5605f48c2fb9f231615dd932bf730ae9540f4f98b5b7ae2b269975f452f6d73 android.hardware.gnss@2.0::IGnss db6bdf6dfc5edf6c85d2944976db899227abb51079c893874353c322342c50b6 android.hardware.gnss@2.0::IGnssBatching 1f89392f1ebb693d8fa6f50324b1635fc79fab246d31900e63998e1b0e17511c android.hardware.gnss@2.0::IGnssBatchingCallback 64232037109a5e5f53ab0377e755ec494ae93fcb5279e6eea71dec2e7ac6fbfc android.hardware.gnss@2.0::IGnssCallback diff --git a/gnss/2.0/IGnss.hal b/gnss/2.0/IGnss.hal index f19f8d0566..9935bf914d 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. */