Update doc for SEAT_DEPTH
Part of a large doc update. Add doc for new supported value range
APIs. For be backward compatible with older VHAL clients still
using deprecated fields, we still require the old fields to be
populated.
Test: None
Bug: 383184445
Flag: EXEMPT no code change
Change-Id: I05a6edec49af6e69644e949e3536e7abbe432e46
diff --git a/automotive/vehicle/aidl_property/android/hardware/automotive/vehicle/VehicleProperty.aidl b/automotive/vehicle/aidl_property/android/hardware/automotive/vehicle/VehicleProperty.aidl
index f74538f..8f7995f 100644
--- a/automotive/vehicle/aidl_property/android/hardware/automotive/vehicle/VehicleProperty.aidl
+++ b/automotive/vehicle/aidl_property/android/hardware/automotive/vehicle/VehicleProperty.aidl
@@ -3233,12 +3233,22 @@
* The minInt32Value indicates the seat is in its shallowest position (i.e. the position with
* the smallest distance between the front edge of the seat cushion and the rear end of the
* seat).
+ *
* The maxInt32Value indicates the seat is in its deepest position (i.e. the position with the
* largest distance between the front edge of the seat cushion and the rear end of the seat).
*
* Values in between minInt32Value and maxInt32Value indicate a transition state between the
* shallowest and deepest positions.
*
+ * If {@code HasSupportedValueInfo} for a specific area ID is not {@code null}:
+ * {@code HasSupportedValueInfo.hasMinSupportedValue} and
+ * {@code HasSupportedValueInfo.hasMaxSupportedValue} must be {@code true} for the area ID.
+ * {@code MinMaxSupportedValueResult.minSupportedValue} has the same meaning as minInt32Value.
+ * {@code MinMaxSupportedValueResult.maxSupportedValue} has the same meaning as maxInt32Value.
+ * All integers between minSupportedValue and maxSupportedValue must be supported.
+ * At boot, minInt32Value is equal to minSupportedValue, maxInt32Value is equal to
+ * maxSupportedValue.
+ *
* This property is not in any particular unit but in a specified range of relative positions.
*
* This property is defined as VehiclePropertyAccess.READ_WRITE, but OEMs have the option to
@@ -3247,6 +3257,7 @@
* @change_mode VehiclePropertyChangeMode.ON_CHANGE
* @access VehiclePropertyAccess.READ_WRITE
* @access VehiclePropertyAccess.READ
+ * @require_min_max_supported_value
* @version 2
*/
SEAT_DEPTH_POS = 0x0B8D + 0x10000000 + 0x05000000
@@ -3257,14 +3268,24 @@
* The maxInt32Value and minInt32Value in each VehicleAreaConfig must be defined. All integers
* between minInt32Value and maxInt32Value must be supported.
*
- * The maxInt32Value represents the maximum movement speed of the seat while getting deeper
* The minInt32Value represents the maximum movement speed of the seat while getting shallower.
*
+ * The maxInt32Value represents the maximum movement speed of the seat while getting deeper.
+ *
* Larger absolute values, either positive or negative, indicate a faster movement speed. Once
* the seat backrest reaches the positional limit, the value must reset to 0. If
* SEAT_DEPTH_MOVE's value is currently 0, then that means there is no movement currently
* occurring.
*
+ * If {@code HasSupportedValueInfo} for a specific area ID is not {@code null}:
+ * {@code HasSupportedValueInfo.hasMinSupportedValue} and
+ * {@code HasSupportedValueInfo.hasMaxSupportedValue} must be {@code true} for the area ID.
+ * {@code MinMaxSupportedValueResult.minSupportedValue} has the same meaning as minInt32Value.
+ * {@code MinMaxSupportedValueResult.maxSupportedValue} has the same meaning as maxInt32Value.
+ * All integers between minSupportedValue and maxSupportedValue must be supported.
+ * At boot, minInt32Value is equal to minSupportedValue, maxInt32Value is equal to
+ * maxSupportedValue.
+ *
* This property is not in any particular unit but in a specified range of relative movement
* speeds.
*
@@ -3274,6 +3295,7 @@
* @change_mode VehiclePropertyChangeMode.ON_CHANGE
* @access VehiclePropertyAccess.READ_WRITE
* @access VehiclePropertyAccess.READ
+ * @require_min_max_supported_value
* @version 2
*/
SEAT_DEPTH_MOVE = 0x0B8E + 0x10000000 + 0x05000000