Clarify restore policy behavior
It's the choice of the implementer on whether to apply the
policy on just a power loss or on a power loss and a BMC
reboot
Partially Resolves openbmc/openbmc#2454
Change-Id: Ia52a92a23d8e66f667a2c7d6ca163ae78915232f
Signed-off-by: Andrew Geissler <andrewg@us.ibm.com>
diff --git a/xyz/openbmc_project/Control/Power/RestorePolicy.interface.yaml b/xyz/openbmc_project/Control/Power/RestorePolicy.interface.yaml
index 1a29980..1f90937 100644
--- a/xyz/openbmc_project/Control/Power/RestorePolicy.interface.yaml
+++ b/xyz/openbmc_project/Control/Power/RestorePolicy.interface.yaml
@@ -1,12 +1,13 @@
description: >
- Implement to specify power transition behavior on restoration of lost main
- power source.
+ Implement to specify power transition behavior on a BMC reset.
+ The implementation may choose to only enforce the policy on
+ a power loss or on both a power loss and BMC reboot.
properties:
- name: PowerRestorePolicy
type: enum[self.Policy]
description: >
- The policy to adopt on restoration of power.
+ The policy to adopt after the BMC reset.
enumerations:
- name: Policy
@@ -21,5 +22,5 @@
Remain powered off.
- name: Restore
description: >
- Restore power to a state that was known, just before the main power
- was lost.
+ Restore power to last requested state recorded before the BMC was
+ reset.