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

Commit 00e5a5e1 authored by Yu Shan's avatar Yu Shan
Browse files

Update doc for CURRENT_GEAR. 

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: 371636116
Flag: EXEMPT no code change
Change-Id: I3418696cb21756c567abf7c1bc7fec11116f34bf
parent 1a7ac6a7

automotive/vehicle/aidl/emu_metadata/android.hardware.automotive.vehicle-types-meta.json

+1 −1
Original line number Diff line number Diff line
@@ -231,7 +231,7 @@ 
                    "VehicleGear"

                ],

                "data_enum": "VehicleGear",

                "description": "Current gear. In non-manual case, selected gear may not match the current gear. For example, if the selected gear is GEAR_DRIVE, the current gear will be one of GEAR_1, GEAR_2 etc, which reflects the actual gear the transmission is currently running in.\nValues in the config data must represent the list of supported gears for this vehicle.  For example, config data for an automatic transmission must contain {GEAR_NEUTRAL, GEAR_REVERSE, GEAR_PARK, GEAR_1, GEAR_2,...} and for manual transmission the list must be {GEAR_NEUTRAL, GEAR_REVERSE, GEAR_1, GEAR_2,...}. This list need not be the same as that of the supported gears reported in GEAR_SELECTION."

                "description": "Current gear. In non-manual case, selected gear may not match the current gear. For example, if the selected gear is GEAR_DRIVE, the current gear will be one of GEAR_1, GEAR_2 etc, which reflects the actual gear the transmission is currently running in.\n{@code VehicleAreaConfig.HasSupportedValueInfo.hasSupportedValuesList} for the global area ID (0) must be {@code true}.\n{@code getSupportedValuesList} for [GEAR_SELECTION, areaId=0] must return a {@code SupportedValuesListResult} that contains non-null {@code supportedValuesList}.\nThe supported values list must represent the list of supported gears for this vehicle.  For example, for an automatic transmission, this list can be {GEAR_NEUTRAL, GEAR_REVERSE, GEAR_PARK, GEAR_1, GEAR_2,...} and for manual transmission the list can be {GEAR_NEUTRAL, GEAR_REVERSE, GEAR_1, GEAR_2,...}. This list need not be the same as that of the supported gears reported in GEAR_SELECTION.\nFor backward compatibility, config array for this property must be a list of values same as the supported values at boot-time."

            },

            {

                "name": "Parking brake state.",

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

+15 −4
Original line number Diff line number Diff line
@@ -653,16 +653,27 @@ enum VehicleProperty { 
     * the current gear will be one of GEAR_1, GEAR_2 etc, which reflects

     * the actual gear the transmission is currently running in.

     *

     * Values in the config data must represent the list of supported gears

     * for this vehicle.  For example, config data for an automatic transmission

     * must contain {GEAR_NEUTRAL, GEAR_REVERSE, GEAR_PARK, GEAR_1, GEAR_2,...}

     * and for manual transmission the list must be

     * {@code VehicleAreaConfig.HasSupportedValueInfo.hasSupportedValuesList} for the global area ID

     * (0) must be {@code true}.

     *

     * {@code getSupportedValuesList} for [GEAR_SELECTION, areaId=0] must return a

     * {@code SupportedValuesListResult} that contains non-null {@code supportedValuesList}.

     *

     * The supported values list must represent the list of supported gears

     * for this vehicle.  For example, for an automatic transmission, this list can be

     * {GEAR_NEUTRAL, GEAR_REVERSE, GEAR_PARK, GEAR_1, GEAR_2,...}

     * and for manual transmission the list can be

     * {GEAR_NEUTRAL, GEAR_REVERSE, GEAR_1, GEAR_2,...}. This list need not be the

     * same as that of the supported gears reported in GEAR_SELECTION.

     *

     * For backward compatibility, config array for this property must be a list of values

     * same as the supported values at boot-time.

     *

     * @change_mode VehiclePropertyChangeMode.ON_CHANGE

     * @access VehiclePropertyAccess.READ

     * @data_enum VehicleGear

     * @require_supported_values_list

     * @legacy_supported_values_in_config

     * @version 2

     */

    CURRENT_GEAR = 0x0401 + 0x10000000 + 0x01000000