From 379ee87f1ac4bdc62e721d94376117c626bb54c8 Mon Sep 17 00:00:00 2001 From: Neil Fuller Date: Thu, 19 Jan 2023 13:52:00 +0000 Subject: [PATCH] Improve docs around "on demand time" capability Update the docs to record how the behavior differs from the name. current.txt has been updated by hand using information from: hidl-gen -L hash -r android.hardware:hardware/interfaces \ android.hardware.gnss@1.0::IGnssCallback As per instructions at https://source.android.com/docs/core/architecture/hidl/hashing This is acceptable because it's just a docs change that documents existing, historic behavior. Previous docs were misleading. Test: hidl-gen -L check -r android.hardware:hardware/interfaces android.hardware.gnss@1.0::IGnssCallback Bug: 222295093 Bug: 73893222 Change-Id: I935354be52239482d559962e9a9ee1faaf73f4b1 --- current.txt | 1 + gnss/1.0/IGnssCallback.hal | 8 +++++++- gnss/aidl/android/hardware/gnss/IGnssCallback.aidl | 8 +++++++- 3 files changed, 15 insertions(+), 2 deletions(-) diff --git a/current.txt b/current.txt index fbdd3fe648..ef1f65a4b6 100644 --- a/current.txt +++ b/current.txt @@ -933,5 +933,6 @@ b7ce2d87841585551b082fca6d099622e63b7099e0d8013f687ea1a1dc35c4dc android.hardwar 2aa559cda86c358c6429114ef6bc72c1b43281e98f9eb6b4df5e7073c8d05767 android.hardware.automotive.vehicle@2.0::types 42abd285a4293dadb8c89bc63b90cae2872fbffe90c4517aa3ea4965e8aecff7 android.hardware.graphics.common@1.2::types 4f1a02d21a22104c734f71cdbba19b6f7e93d4ee107ff79f0dbdd171a8430e0e android.hardware.automotive.vehicle@2.0::types +a2fbd9747fbb9ceb8c1090b5a24138312246502d5af0654a8c2b603a9bf521fc android.hardware.gnss@1.0::IGnssCallback # There will be no more HIDL HALs. Use AIDL instead. diff --git a/gnss/1.0/IGnssCallback.hal b/gnss/1.0/IGnssCallback.hal index 311ab2166c..512763e717 100644 --- a/gnss/1.0/IGnssCallback.hal +++ b/gnss/1.0/IGnssCallback.hal @@ -37,7 +37,13 @@ interface IGnssCallback { MSA = 1 << 2, /** GNSS supports single-shot fixes */ SINGLE_SHOT = 1 << 3, - /** GNSS supports on demand time injection */ + /** + * The platform periodically injects time to GNSS in addition to + * on-demand and occasional time updates. + * + * Note: The naming of "on demand" should be "periodic" instead. This + * is the result of a historic implementation bug, b/73893222. + */ ON_DEMAND_TIME = 1 << 4, /** GNSS supports Geofencing */ GEOFENCING = 1 << 5, diff --git a/gnss/aidl/android/hardware/gnss/IGnssCallback.aidl b/gnss/aidl/android/hardware/gnss/IGnssCallback.aidl index ff9feeacbd..ee21011a6d 100644 --- a/gnss/aidl/android/hardware/gnss/IGnssCallback.aidl +++ b/gnss/aidl/android/hardware/gnss/IGnssCallback.aidl @@ -49,7 +49,13 @@ interface IGnssCallback { /** Capability bit mask indicating that GNSS supports single-shot fixes */ const int CAPABILITY_SINGLE_SHOT = 1 << 3; - /** Capability bit mask indicating that GNSS supports on demand time injection */ + /** + * Capability bit indicating that the platform should periodically inject + * time to GNSS in addition to on-demand and occasional time updates. + * + *

Note:The naming of "on demand" should be "periodic" instead. This + * is the result of a historic implementation bug, b/73893222. + */ const int CAPABILITY_ON_DEMAND_TIME = 1 << 4; /** Capability bit mask indicating that GNSS supports Geofencing */