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

Commit 1d2cbbbe authored by Yu Shan's avatar Yu Shan
Browse files

Update doc for EV_CHARGE_PERCENT_LIMIT.

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: I962cb8ae444c48250e2b27aed751af3383e2fc32
parent 80073ea4
Loading
Loading
Loading
Loading
+12 −1
Original line number Diff line number Diff line
@@ -5952,18 +5952,29 @@ enum VehicleProperty {
     *
     * Returns a float value from 0 to 100.
     *
     * configArray is used to specify the valid values.
     * configArray is used to specify the valid values at boot time.
     *   For example, if the vehicle supports the following charge percent limit values:
     *     [20, 40, 60, 80, 100]
     *   then the configArray should be {20, 40, 60, 80, 100}
     * If the configArray is empty then all values from 0 to 100 must be valid.
     *
     * If {@code HasSupportedValueInfo} for the global area ID (0) is not {@code null},
     * {@code HasSupportedValueInfo.hasSupportedValuesList} must be {@code true}.
     * {@code SupportedValuesListResult#supportedValuesList} specifies the
     * valid maximum charge percent threshold options at the current moment.
     * At boot, configArray content must match the supported values list.
     *
     * If the valid values may change dynamically,
     * {@code HasSupportedValueInfo.hasSupportedValuesList} must be {@code true} and
     * {@code SupportedValuesListResult#supportedValuesList} must be implemented.
     *
     * This property is defined as VehiclePropertyAccess.READ_WRITE, but OEMs have the option to
     * implement it as VehiclePropertyAccess.READ only.
     *
     * @change_mode VehiclePropertyChangeMode.ON_CHANGE
     * @access VehiclePropertyAccess.READ_WRITE
     * @access VehiclePropertyAccess.READ
     * @legacy_supported_values_in_config
     * @version 2
     */
    EV_CHARGE_PERCENT_LIMIT = 0x0F40 + 0x10000000 + 0x01000000