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

Commit cb963866 authored by Yu Shan's avatar Yu Shan
Browse files

Update doc for MIRROR_MOVE. 

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: I39bab1be9a41c7c50213a38baa40129617eb0f21
parent cabeb8e2

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

+24 −2
Original line number Diff line number Diff line
@@ -2579,14 +2579,24 @@ 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 mirror while tilting upwards.

     * The minInt32Value represents the maximum movement speed of the mirror while tilting

     * downwards.

     *

     * The maxInt32Value represents the maximum movement speed of the mirror while tilting upwards.

     *

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

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

     *
@@ -2596,6 +2606,7 @@ enum VehicleProperty { 
     * @change_mode VehiclePropertyChangeMode.ON_CHANGE

     * @access VehiclePropertyAccess.READ_WRITE

     * @access VehiclePropertyAccess.READ

     * @require_min_max_supported_value

     * @version 2

     */

    MIRROR_Z_MOVE = 0x0B41 + 0x10000000 + 0x04000000
@@ -2647,13 +2658,23 @@ 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 mirror while tilting right.

     * The minInt32Value represents the maximum movement speed of the mirror while tilting left.

     *

     * The maxInt32Value represents the maximum movement speed of the mirror while tilting right.

     *

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

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

     *
@@ -2663,6 +2684,7 @@ enum VehicleProperty { 
     * @change_mode VehiclePropertyChangeMode.ON_CHANGE

     * @access VehiclePropertyAccess.READ_WRITE

     * @access VehiclePropertyAccess.READ

     * @require_min_max_supported_value

     * @version 2

     */

    MIRROR_Y_MOVE = 0x0B43 + 0x10000000 + 0x04000000