Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 96f44c34 authored by Yu Shan's avatar Yu Shan
Browse files

Update doc for SEAT_TILT 

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: Ie1369cea3b699a0ba84ed0912190e55ff6611cf8
parent 8ce3a7db

automotive/vehicle/aidl_property/android/hardware/automotive/vehicle/VehicleProperty.aidl

+24 −2
Original line number Diff line number Diff line
@@ -3309,6 +3309,7 @@ enum VehicleProperty { 
     * The minInt32Value indicates the seat bottom is angled at its lowest angular position. This

     * corresponds to the seat's front edge at its lowest possible position relative to the rear

     * end of the seat.

     *

     * The maxInt32Value indicates the seat bottom is angled at its highest angular position. This

     * corresponds to the seat's front edge at its highest possible position relative to the rear

     * end of the seat.
@@ -3316,6 +3317,15 @@ enum VehicleProperty { 
     * Values in between minInt32Value and maxInt32Value indicate a transition state between the

     * lowest and highest 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
@@ -3324,6 +3334,7 @@ enum VehicleProperty { 
     * @change_mode VehiclePropertyChangeMode.ON_CHANGE

     * @access VehiclePropertyAccess.READ_WRITE

     * @access VehiclePropertyAccess.READ

     * @require_min_max_supported_value

     * @version 2

     */

    SEAT_TILT_POS = 0x0B8F + 0x10000000 + 0x05000000
@@ -3334,15 +3345,25 @@ enum VehicleProperty { 
     * 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 front edge of the seat while

     * moving upward.

     * The minInt32Value represents the maximum movement speed of the front edge of the seat while

     * moving downward.

     *

     * The maxInt32Value represents the maximum movement speed of the front edge of the seat while

     * moving upward.

     *

     * Larger absolute values, either positive or negative, indicate a faster movement speed. Once

     * the seat bottom reaches the positional limit, the value must reset to 0. If SEAT_TILT_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.

     *
@@ -3352,6 +3373,7 @@ enum VehicleProperty { 
     * @change_mode VehiclePropertyChangeMode.ON_CHANGE

     * @access VehiclePropertyAccess.READ_WRITE

     * @access VehiclePropertyAccess.READ

     * @require_min_max_supported_value

     * @version 2

     */

    SEAT_TILT_MOVE = 0x0B90 + 0x10000000 + 0x05000000