Merge "Added supportedEnums logic description to enum files" into main

This commit is contained in:
Treehugger Robot 2024-06-12 18:21:53 +00:00 committed by Android (Google) Code Review
commit 2a60fca9a6
40 changed files with 123 additions and 0 deletions

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the state of Automatic Emergency Braking (AEB). * Used to enumerate the state of Automatic Emergency Braking (AEB).
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the state of Blind Spot Warning State (BSW). * Used to enumerate the state of Blind Spot Warning State (BSW).
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the state of Cross Traffic Monitoring Warning system. * Used to enumerate the state of Cross Traffic Monitoring Warning system.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -20,6 +20,9 @@ package android.hardware.automotive.vehicle;
* Used to enumerate the Cruise Control (CC) commands. * Used to enumerate the Cruise Control (CC) commands.
* *
* This enum could be extended in future releases to include additional feature states. * This enum could be extended in future releases to include additional feature states.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -20,6 +20,9 @@ package android.hardware.automotive.vehicle;
* Used to enumerate the current state of Cruise Control (CC). * Used to enumerate the current state of Cruise Control (CC).
* *
* This enum could be extended in future releases to include additional feature states. * This enum could be extended in future releases to include additional feature states.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -20,6 +20,9 @@ package android.hardware.automotive.vehicle;
* Used to enumerate the current type of Cruise Control (CC). * Used to enumerate the current type of Cruise Control (CC).
* *
* This enum could be extended in future releases to include additional feature states. * This enum could be extended in future releases to include additional feature states.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -20,6 +20,9 @@ package android.hardware.automotive.vehicle;
* Used to enumerate the current state of driver distraction monitoring. * Used to enumerate the current state of driver distraction monitoring.
* *
* This enum could be extended in future releases to include additional feature states. * This enum could be extended in future releases to include additional feature states.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the current warning state of the driver distraction monitoring system. * Used to enumerate the current warning state of the driver distraction monitoring system.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -20,6 +20,9 @@ package android.hardware.automotive.vehicle;
* Used to enumerate the current state of driver drowsiness and attention monitoring. * Used to enumerate the current state of driver drowsiness and attention monitoring.
* *
* This enum could be extended in future releases to include additional feature states. * This enum could be extended in future releases to include additional feature states.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -19,6 +19,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the current warning state of the driver drowsiness and attention monitoring * Used to enumerate the current warning state of the driver drowsiness and attention monitoring
* system. * system.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the state of Electronic Stability Control (ESC). * Used to enumerate the state of Electronic Stability Control (ESC).
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used by ELECTRONIC_TOLL_COLLECTION_CARD_STATUS. * Used by ELECTRONIC_TOLL_COLLECTION_CARD_STATUS.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used by ELECTRONIC_TOLL_COLLECTION_CARD_TYPE. * Used by ELECTRONIC_TOLL_COLLECTION_CARD_TYPE.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -20,6 +20,9 @@ package android.hardware.automotive.vehicle;
* Used by emergency lane keep assist to enumerate state. * Used by emergency lane keep assist to enumerate state.
* *
* This enum could be extended in future releases to include additional feature states. * This enum could be extended in future releases to include additional feature states.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -19,6 +19,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the possible error states. For version 2 of this interface, ErrorState is used * Used to enumerate the possible error states. For version 2 of this interface, ErrorState is used
* by ADAS STATE properties, but its use may be expanded in future releases. * by ADAS STATE properties, but its use may be expanded in future releases.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used by EV charging properties to enumerate the current state of the battery charging. * Used by EV charging properties to enumerate the current state of the battery charging.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -19,6 +19,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used by the regenerative braking property to enumerate the current state * Used by the regenerative braking property to enumerate the current state
* of the regenerative braking. * of the regenerative braking.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -20,6 +20,9 @@ package android.hardware.automotive.vehicle;
* Used by EV_STOPPING_MODE to enumerate the current state of the stopping mode. * Used by EV_STOPPING_MODE to enumerate the current state of the stopping mode.
* *
* This enum may be extended to include more states in the future. * This enum may be extended to include more states in the future.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the state of Forward Collision Warning State (FCW). * Used to enumerate the state of Forward Collision Warning State (FCW).
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the current driver state of Hands On Detection (HOD). * Used to enumerate the current driver state of Hands On Detection (HOD).
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the current warning state of Hands On Detection (HOD). * Used to enumerate the current warning state of Hands On Detection (HOD).
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the various impact sensor locations on the car. * Used to enumerate the various impact sensor locations on the car.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used by Lane Centering Assist (LCA) to enumerate commands. * Used by Lane Centering Assist (LCA) to enumerate commands.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the state of Lane Centering Assist (LCA). * Used to enumerate the state of Lane Centering Assist (LCA).
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the state of Lane Departure Warning (LDW). * Used to enumerate the state of Lane Departure Warning (LDW).
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the state of Lane Keep Assist (LKA). * Used to enumerate the state of Lane Keep Assist (LKA).
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the state of Low Speed Automatic Emergency Braking. * Used to enumerate the state of Low Speed Automatic Emergency Braking.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the state of Low Speed Collision Warning State. * Used to enumerate the state of Low Speed Collision Warning State.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the current state of VehicleProperty#TRAILER_PRESENT. * Used to enumerate the current state of VehicleProperty#TRAILER_PRESENT.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the various airbag locations per seat. * Used to enumerate the various airbag locations per seat.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -19,6 +19,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the various level of automation that can be expressed by the * Used to enumerate the various level of automation that can be expressed by the
* VEHICLE_DRIVING_AUTOMATION_CURRENT_LEVEL property. * VEHICLE_DRIVING_AUTOMATION_CURRENT_LEVEL property.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Various gears which can be selected by user and chosen in system. * Various gears which can be selected by user and chosen in system.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Bit flags for fan direction * Bit flags for fan direction
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -16,6 +16,12 @@
package android.hardware.automotive.vehicle; package android.hardware.automotive.vehicle;
/**
* Used to enumerate the different states the ignition of the vehicle can be in.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")
enum VehicleIgnitionState { enum VehicleIgnitionState {

View file

@ -21,6 +21,9 @@ package android.hardware.automotive.vehicle;
* *
* Most XXX_LIGHTS_STATE properties will only report ON and OFF states. Only * Most XXX_LIGHTS_STATE properties will only report ON and OFF states. Only
* the HEADLIGHTS_STATE property will report DAYTIME_RUNNING. * the HEADLIGHTS_STATE property will report DAYTIME_RUNNING.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -22,6 +22,9 @@ package android.hardware.automotive.vehicle;
* XXX_LIGHTS_SWITCH properties report the switch settings that the user * XXX_LIGHTS_SWITCH properties report the switch settings that the user
* selects. The switch setting may be decoupled from the state reported if the * selects. The switch setting may be decoupled from the state reported if the
* user selects AUTOMATIC. * user selects AUTOMATIC.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the current level of VehicleProperty#ENGINE_OIL_LEVEL. * Used to enumerate the current level of VehicleProperty#ENGINE_OIL_LEVEL.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used by seat occupancy to enumerate the current occupancy state of the seat. * Used by seat occupancy to enumerate the current occupancy state of the seat.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the current state of VehicleProperty#WINDSHIELD_WIPERS_STATE. * Used to enumerate the current state of VehicleProperty#WINDSHIELD_WIPERS_STATE.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")

View file

@ -18,6 +18,9 @@ package android.hardware.automotive.vehicle;
/** /**
* Used to enumerate the current position of VehicleProperty#WINDSHIELD_WIPERS_SWITCH. * Used to enumerate the current position of VehicleProperty#WINDSHIELD_WIPERS_SWITCH.
*
* Through the use of VehicleAreaConfig#supportedEnumValues, OEMs may specify they only support a
* subset of the enums that are defined here.
*/ */
@VintfStability @VintfStability
@Backing(type="int") @Backing(type="int")