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

Commit 7cb57f09 authored by Aaqib Ismail's avatar Aaqib Ismail
Browse files

Update Cruise Control properties HAL docs 

Specify the exact StatusCode that should be returned when the property
is not available.

Bug: 271302963
Test: presubmit
Change-Id: I448071ca970985f20d1e414104c90142ca58e0f2
parent c3ac3a46

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

+11 −4
Original line number Diff line number Diff line
@@ -4054,7 +4054,10 @@ enum VehicleProperty { 
     *

     * For the global area ID (0), the VehicleAreaConfig#supportedEnumValues array must be defined

     * unless all states of CruiseControlState are supported. Any unsupported commands sent through

     * this property should return StatusCode.INVALID_ARG.

     * this property must return StatusCode#INVALID_ARG.

     *

     * When this property is not available because CC is disabled (i.e. CRUISE_CONTROL_ENABLED is

     * false), this property must return StatusCode#NOT_AVAILABLE_DISABLED.

     *

     * @change_mode VehiclePropertyChangeMode.ON_CHANGE

     * @access VehiclePropertyAccess.WRITE
@@ -4072,8 +4075,8 @@ enum VehicleProperty { 
     * The maxFloatValue represents the upper bound of the target speed.

     * The minFloatValue represents the lower bound of the target speed.

     *

     * When this property is not available (for example when CRUISE_CONTROL_ENABLED is false), it

     * should return StatusCode.NOT_AVAILABLE_DISABLED.

     * When this property is not available because CC is disabled (i.e. CRUISE_CONTROL_ENABLED is

     * false), this property must return StatusCode#NOT_AVAILABLE_DISABLED.

     *

     * @change_mode VehiclePropertyChangeMode.ON_CHANGE

     * @access VehiclePropertyAccess.READ
@@ -4095,7 +4098,8 @@ enum VehicleProperty { 
     * ascending order. All values must be positive. If the property is writable, all values must be

     * writable.

     *

     * Writing to this property when it is not available should return StatusCode.NOT_AVAILABLE.

     * When this property is not available because CC is disabled (i.e. CRUISE_CONTROL_ENABLED is

     * false), this property must return StatusCode#NOT_AVAILABLE_DISABLED.

     *

     * @change_mode VehiclePropertyChangeMode.ON_CHANGE

     * @access VehiclePropertyAccess.READ_WRITE
@@ -4119,6 +4123,9 @@ enum VehicleProperty { 
     * vehicle is too far away for the sensor to detect), this property should return

     * StatusCode.NOT_AVAILABLE.

     *

     * When this property is not available because CC is disabled (i.e. CRUISE_CONTROL_ENABLED is

     * false), this property must return StatusCode#NOT_AVAILABLE_DISABLED.

     *

     * @change_mode VehiclePropertyChangeMode.CONTINUOUS

     * @access VehiclePropertyAccess.READ

     * @unit VehicleUnit:MILLIMETER