clarify quiesce use cases for host
This interface will be utilized on some systems to represent the
hypervisor state. Clarify that Quiesce can represent different
host states based on which object is implementing it.
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
Change-Id: Ib5abc5f95dedbdb6e6184cf18f50aca1bb267852
diff --git a/xyz/openbmc_project/State/Host.interface.yaml b/xyz/openbmc_project/State/Host.interface.yaml
index 616f9c3..a495e80 100644
--- a/xyz/openbmc_project/State/Host.interface.yaml
+++ b/xyz/openbmc_project/State/Host.interface.yaml
@@ -66,7 +66,11 @@
Host firmware is transitioning to a Running state
- name: 'Quiesced'
description: >
- Host firmware is quiesced
+ Host firmware is quiesced. The host firmware is enabled but either
+ unresponsive or only processing a restricted set of commands. This
+ state can be a result of the host entering an error state or booting
+ into a BIOS setup environment. The BootProgress property will
+ provide details on which it is.
- name: 'DiagnosticMode'
description: >
Host firmware is capturing debug information. Powering off your