docs/designs/state-management-and-external-interfaces.md

16 Please note that the focus of this document is on the following `ResetType`
17 instance: `redfish/v1/Systems/system/Actions/ComputerSystem.Reset`
23 [phoshor-state-manager][2] implements the xyz.openbmc_project.State.\*
28 the appropriate xyz.openbmc_project.State.\* D-Bus interface.
32 looking to support the capability to reboot an operating system on a system
33 without cycling power to the chassis.
35 Currently phosphor-state-manager supports the following:
37 - Chassis: On/Off
38 - Host: On/Off/Reboot
40 The `Reboot` to the host currently causes a power cycle to the chassis.
49         "On",
60         "ForceOff": "Turn off the unit immediately (non-graceful shutdown).",
61         "ForceOn": "Turn on the unit immediately.",
62         "ForceRestart": "Shut down immediately and non-gracefully and restart
65         "GracefulShutdown": "Shut down gracefully and power off.",
66         "Nmi": "Generate a diagnostic interrupt, which is usually an NMI on x86
69         "On": "Turn on the unit.",
70         "PowerCycle": "Power cycle the unit.",
71         "PushPowerButton": "Simulate the pressing of the physical power button
72           on this unit."
84 …------------------------------ | -----------------------------------------------------------------…
85 …power down                     | Force system into soft off (S4/S45) state. This is for ‘emergency…
86 | power up                       |                                                                 …
87 …power cycle                    | This command provides a power off interval of at least 1 second f…
88 …reset                     | In some implementations, the BMC may not know whether a reset will cau…
90 | Initiate a soft-shutdown of OS |                                                                 …
94 - Keep legacy support where `xyz.openbmc_project.State.Host.Transition.Reboot`
95   causes a graceful shutdown of the host, a power cycle of the chassis, and a
97 - Support a reboot of the host with chassis power on
98   - Support `GracefulRestart` (where the host is notified of the reboot)
99   - Support `ForceRestart` (where the host is not notified of the reboot)
100 - Map `PowerCycle` to a host or chassis operation depending on the current state
102   - If host is running, then a `PowerCycle` should cycle power to the chassis
104   - If host is not running, then a `PowerCycle` should only cycle power to the
111 - `ForceWarmReboot`, `GracefulWarmReboot`
115 - `PowerCycle`
118 interfaces that are not defined within phosphor-dbus-interfaces. These are
119 implemented within the x86-power-control repository which is an alternate
120 implementation to phosphor-state-manager. It has the following mapping for these
121 non-phosphor-dbus-interfaces
123 - `ForceRestart` -> `xyz.openbmc_project.State.Chassis.Transition.Reset`
124 - `PowerCycle` -> `xyz.openbmc_project.State.Chassis.Transition.PowerCycle`
133 The `PowerCycle` operation is dependent on the current state of the host. If
134 host is on, it will map to `xyz.openbmc_project.State.Host.Transition.Reboot`
140 - `ForceRestart` -> `xyz.openbmc_project.State.Host.Transition.ForceWarmReboot`
141 - `GracefulRestart`->
143 - `PowerCycle`:
144   - If host on: `xyz.openbmc_project.State.Host.Transition.Reboot`
145   - If host off: `xyz.openbmc_project.State.Chassis.Transition.PowerCycle`
151 | --------------------- | ----------- | ------------------------------------ |
152 | ForceOff              | power down  | Chassis.Off                          |
153 | ForceOn               | power up    | Host.On                              |
154 | ForceRestart          | hard reset  | Host.ForceWarmReboot                 |
157 | On                    | power up    | Host.On                              |
158 | PowerCycle (host on)  | power cycle | Host.Reboot                          |
167 Existing interfaces will be kept the same. Some changes in x86-power-control
171 Some changes in phosphor-host-ipmid would be needed to support the new state
181 [2]: https://github.com/openbmc/phosphor-state-manager