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
diff --git a/gnss/1.0/IGnssCallback.hal b/gnss/1.0/IGnssCallback.hal
index 311ab21..512763e 100644
--- a/gnss/1.0/IGnssCallback.hal
+++ b/gnss/1.0/IGnssCallback.hal
@@ -37,7 +37,13 @@
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 ff9feea..ee21011 100644
--- a/gnss/aidl/android/hardware/gnss/IGnssCallback.aidl
+++ b/gnss/aidl/android/hardware/gnss/IGnssCallback.aidl
@@ -49,7 +49,13 @@
/** 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 */