diff options
author | Andrew Geissler <andrewg@us.ibm.com> | 2017-04-18 14:35:45 -0500 |
---|---|---|
committer | Patrick Williams <patrick@stwcx.xyz> | 2017-04-21 20:19:39 +0000 |
commit | b36148b13cd34d796398845a7b7bcfefae57318b (patch) | |
tree | 6f0593b505a225bc9522513fbb52de09fbd89b21 /xyz/openbmc_project | |
parent | 8d885b9c28e63b36e13de50e56f17f63bc4ab448 (diff) | |
download | phosphor-dbus-interfaces-b36148b13cd34d796398845a7b7bcfefae57318b.tar.gz phosphor-dbus-interfaces-b36148b13cd34d796398845a7b7bcfefae57318b.zip |
Minor updates to doc for soft and hard power off terms
Change-Id: I7ef803d834b3d91a4ea5404e1977f56e91716a43
Signed-off-by: Andrew Geissler <andrewg@us.ibm.com>
Diffstat (limited to 'xyz/openbmc_project')
-rw-r--r-- | xyz/openbmc_project/State/README.md | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/xyz/openbmc_project/State/README.md b/xyz/openbmc_project/State/README.md index 2e0bc00..a2e85d0 100644 --- a/xyz/openbmc_project/State/README.md +++ b/xyz/openbmc_project/State/README.md @@ -27,7 +27,7 @@ can request the host be in a (Off), (On), or (Reboot) state. More details on different Reboot options below. Quiesced means the host OS is in a quiesce state and the system should be checked for errors. For more information refer to -(Error Handling of systemd)[https://github.com/openbmc/docs/blob/master/openbmc-systemd.md#error-handling-of-systemd] +[Error Handling of systemd](https://github.com/openbmc/docs/blob/master/openbmc-systemd.md#error-handling-of-systemd) 3. *Chassis* : The chassis is either (Off) or (On) This represents the state of power to the chassis. The Chassis being on @@ -56,14 +56,14 @@ The *Host* would provide interfaces at The *Chassis* would provide interfaces at `/xyz/openbmc_project/state/chassis<instance>` -## Cold vs. Warm Host Reboots - -A cold reboot is where you simply cut power to a chassis, and then reapply -power. You don't give the software running on that chassis any chance to -cleanly shut down. A warm reboot is where you send a notification to the host -that is running on that chassis that a shutdown is requested, and wait for that -host firmware to indicate it has shut itself down. You then remove power from -the chassis. By default, a reboot transition request against the host object -will result in a warm reboot. If a user desires a cold reboot then they should -simply issue a power off transition request to the chassis, and then issue an on -transition request to the host. +## Hard vs. Soft Power Off + +A hard power off is where you simply cut power to a chassis. You don't give +the software running on that chassis any chance to cleanly shut down. +A soft power off is where you send a notification to the host that is running +on that chassis that a shutdown is requested, and wait for that host firmware +to indicate it has shut itself down. Once complete, power is then removed +from the chassis. By default, a host off or reboot request does the soft +power off. If a user desires a cold reboot then they should simply issue a +power off transition request to the chassis, and then issue an on transition +request to the host. |