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
This commit is contained in:
Neil Fuller
2023-01-19 13:52:00 +00:00
parent 7f7dc605ce
commit 379ee87f1a
3 changed files with 15 additions and 2 deletions

View File

@@ -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.

View File

@@ -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,

View File

@@ -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.
*
* <p>Note:<em>The naming of "on demand" should be "periodic" instead. This
* is the result of a historic implementation bug, b/73893222.</em>
*/
const int CAPABILITY_ON_DEMAND_TIME = 1 << 4;
/** Capability bit mask indicating that GNSS supports Geofencing */