Healthd develops more and more routines, our clients use them as part of their diagnostic flow. However, clients want to know if a certain routine is supported or not so that they can decide to render an icon on the UI or not. Hence, we release an interface CrosHealthdRoutinesService.IsRoutineArgumentSupported for our clients to query the routine support status.
This document focuses on the following things:
This document assumes that OEMs/ODMs understand how to make changes to the Boxster config. If OEMs/ODMs have any trouble on this, please contact us.
Some commands help you debug issues or have a quick try:
cros-health-tool diag --help Use this command to check all possible routine types.cros-health-tool diag $routine --help Use this command to see the parameters of each routine.cros-health-tool diag $routine {parameters...} --check_supported Use this command to see if the routine with specific parameters is supported or not. When the flag --check_supported is enabled, we won't run the routine. An example: cros-health-tool diag disk_read_v2 --file_size_mib=0 --check_supported shows Not supported with message: Test file size should not be zero.Please understand that routine supportability differs from event supportability. The status check will also verify routine parameters. For example, you may think that the Disk read routine is always supported but it‘s not the truth. If the read file size is set to zero, it’s obviously not supported.
Always supported.
Always supported.
Always supported.
Supported only when mmc utility is present and storage-type is explicitly configured as “EMMC”. (temporarily workaround: also supported if the storage-type is missing or “STORAGE_TYPE_UNKNOWN”)
You can run the following commands on your DUT:
cros_config /hardware-properties storage-type This is helpful to understand what the value of storage-type is.To configure storage-type in Boxster, you can use the create_non_volatile_storage function defined in hw_topology.star to set it up.
Supported only when storage-type is explicitly configured as “UFS”.
You can run the following commands on your DUT:
cros_config /hardware-properties storage-type This is helpful to understand what the value of storage-type is.cros-health-tool diag ufs_lifetime --check_supported Use this to see if healthd reports the correct support status.To configure storage-type in Boxster, you can use the create_non_volatile_storage function defined in hw_topology.star to set it up.
Supported only when the routine parameters are well provided.
| Parameter | Type | Description | Rule |
|---|---|---|---|
| type | DiskReadTypeEnum | Type of how disk reading is performed. | Only accept one of the [“linear”, “random”]. |
| disk_read_duration | ash.cros_healthd.external.mojo_base.mojom.TimeDelta | Expected duration to read the test file in the routine. | Should be greater than or equal to 1 second. |
| file_size_mib | uint32 | Test file size, in megabytes (MiB). | Should be greater than or equal to 1. |
You can run the following command on your DUT:
cros-health-tool diag disk_read_v2 {parameters...} --check_supported Use this to see if healthd reports the correct support status.Some examples:
# cros-health-tool diag disk_read_v2 --type=ab --check_supported
{
"debug_message": "Unexpected disk read type",
"status": "Not supported"
}
# cros-health-tool diag disk_read_v2 --file_size_mib=0 --check_supported
{
"debug_message": "Test file size should not be zero",
"status": "Not supported"
}
# cros-health-tool diag disk_read_v2 --file_size_mib=1 --check_supported
{
"status": "Supported"
}
Always supported.
Supported only when has-side-volume-button is explicitly configured as “true”.
You can run the following commands on your DUT:
cros_config /hardware-properties has-side-volume-button This is helpful to understand what the value of has-side-volume-button is.cros-health-tool diag volume_button --button_type=up --check_supported Use this to see if healthd reports the correct support status.To configure has-side-volume-button in Boxster, you can use create_volume_button function defined in hw_topology.star to set it up.
Supported only on a device with a CrOS EC.
You can run the following commands on your DUT:
ls /sys/class/chromeos/cros_ec This is helpful to understand if the device has a CrOS EC. If not, the output will contain No such file or directory.cros-health-tool diag led_lit_up --led_name=power --led_color=red --check_supported Use this to see if healthd reports the correct support status.Supported only when ChromeOS uses Floss as Bluetooth stack.
Supported only when ChromeOS uses Floss as Bluetooth stack.
Supported only when ChromeOS uses Floss as Bluetooth stack and the routine parameters are well provided.
| Parameter | Type | Description | Rule |
|---|---|---|---|
| exec_duration | ash.cros_healthd.external.mojo_base.mojom.TimeDelta | Expected duration to run the routine. | Should be strictly greater than 0 second. |
You can run the following command on your DUT:
cros-health-tool diag bluetooth_scanning_v2 {parameters...} --check_supported Use this to see if healthd reports the correct support status.Some examples:
# cros-health-tool diag bluetooth_scanning_v2 --length_seconds=0 --check_supported
{
"debug_message": "Execution duration should be strictly greater than zero",
"status": "Not supported"
}
Supported only when ChromeOS uses Floss as Bluetooth stack.
Supported on devices that satisfies the below criteria:
fan-count is set and is a non-zero value.You can run the following commands on your DUT:
cros_config /hardware-properties fan-count This is helpful to understand what the value of fan-count is.cros-health-tool diag fan --check_supported Use this to see if healthd reports the correct support status.To configure fan-count in Boxster, you can use the create_fan function defined in hw_topology.star to set it up.
Supported only when /camera count is set and is a non-zero value.
You can run the following commands on your DUT:
cros_config /camera count This is helpful to understand what the value of count is.cros-health-tool diag camera_availability --check_supported Use this to see if healthd reports the correct support status.To configure count in Boxster, you can use create_camera function defined in hw_topology.star to set it up.
Always supported.
Supported only when oem-name is set and not empty string. The external service for the routine is not available for the unrecognized devices.
You can run the following commands on your DUT:
cros_config /branding oem-name This is helpful to understand what the value of oem-name is.cros-health-tool diag network_bandwidth --check_supported Use this to see if healthd reports the correct support status.Supported only when /camera count is set and is a non-zero value.
You can run the following commands on your DUT:
cros_config /camera count This is helpful to understand what the value of count is.cros-health-tool diag camera_availability --check_supported Use this to see if healthd reports the correct support status.To configure count in Boxster, you can use create_camera function defined in hw_topology.star to set it up.