Merge "Update doc for PERF_VEHICLE_SPEED" into sc-dev am: ad33f38cc2
Original change: https://googleplex-android-review.googlesource.com/c/platform/hardware/interfaces/+/13591481
MUST ONLY BE SUBMITTED BY AUTOMERGER
Change-Id: Idfe2f281cbbdf0a423b7c58423845d5a4bdb5278
diff --git a/automotive/vehicle/2.0/types.hal b/automotive/vehicle/2.0/types.hal
index ed75e1d..e3fd16d 100644
--- a/automotive/vehicle/2.0/types.hal
+++ b/automotive/vehicle/2.0/types.hal
@@ -354,6 +354,12 @@
/**
* Speed of the vehicle
*
+ * The value must be positive when the vehicle is moving forward and negative when
+ * the vehicle is moving backward. This value is independent of gear value
+ * (CURRENT_GEAR or GEAR_SELECTION), for example, if GEAR_SELECTION is GEAR_NEUTRAL,
+ * PERF_VEHICLE_SPEED is positive when the vehicle is moving forward, negative when moving
+ * backward, and zero when not moving.
+ *
* @change_mode VehiclePropertyChangeMode:CONTINUOUS
* @access VehiclePropertyAccess:READ
* @unit VehicleUnit:METER_PER_SEC