phosphor-power-sequencer/docs/chassis_status.md

5 There are multiple D-Bus interfaces and properties that describe the chassis
6 status. The `phosphor-power-sequencer` application publishes one of those
8 used as input by `phosphor-power-sequencer.`
12 The `state` and `pgood` properties exist on the `org.openbmc.control.Power`
13 D-Bus interface.
15 `state` has a value of 0 or 1. `state` represents the desired power state for
16 the chassis. 0 means off, and 1 means on. This property is set when the system
17 is being powered [on](powering_on.md) or [off](powering_off.md).
19 `pgood` has a value of 0 or 1. `pgood` represents the power good (pgood) state
20 of the chassis. 0 means off, and 1 means on. This is the actual, current power
21 state. This property is set based on the chassis power good signal from the
22 power sequencer device.
24 `phosphor-power-sequencer` publishes the `org.openbmc.control.Power` interface
25 on the following object paths:
27 - `/org/openbmc/control/power0`: Represents the entire system
28 - `/org/openbmc/control/power1`: Represents chassis 1
29 - `/org/openbmc/control/power2`: Represents chassis 2
30 - ...
31 - `/org/openbmc/control/powerN`: Represents chassis N
35 On a single chassis system, only the first two object paths are published,
42 When the system is being powered on, the `state` property of both object paths
43 is set to 1. When the chassis has successfully powered on, the `pgood` property
52 On a multiple chassis system with N chassis, all of the object paths above are
59 When the system is being powered on, the `state` will be changed to 1 for the
60 system and for all chassis that **can** be powered on. It may not be possible to
61 power on some chassis, such as if they are missing or have no input power. See
62 [Powering On](powering_on.md) for more information.
64 When an individual chassis has successfully powered on, the `pgood` property for
66 have successfully powered on, the `pgood` property for the system object path
69 If a power good fault occurs in a chassis after the system powered on, the
72 Eventually the system will be powered off due to the power good fault. See
73 [Power Good Faults](pgood_faults.md) for more information.
84 When `phosphor-power-sequencer` is started, it needs to set initial values for
86 input power or after the BMC is reset.
88 The chassis power good signal is read from the power sequencer device. Both the
89 `state` and `pgood` properties are set to the value of the power good signal.
90 For example, if the chassis power good is true, both `state` and `pgood` are set
91 to the value 1. Thus, `phosphor-power-sequencer` assumes the chassis `state`
92 based on the chassis `pgood`.
94 In a multiple chassis system, it might not be possible to read the chassis power
96 input power. See the sections below for information about how the `pgood`
102 D-Bus interface.
104 This interface is published on the D-Bus inventory path for each chassis.
105 `phosphor-power-sequencer` does not publish this interface, but it checks the
106 `Present` property on multiple chassis systems.
112 - The chassis power good signal from the power sequencer will **not** be read.
113   Since the chassis is not present, the `pgood` property on the
114   `org.openbmc.control.Power` interface for the chassis will be set to 0.
115 - The chassis will **not** be powered on when the system is being powered on.
116   The `state` property on the `org.openbmc.control.Power` interface for the
122 [`xyz.openbmc_project.State.Decorator.Availability`][2] D-Bus interface.
124 This interface is published on the D-Bus inventory path for each chassis.
125 `phosphor-power-sequencer` does not publish this interface, but it checks the
126 `Available` property on multiple chassis systems.
130 the chassis does not have any input power ([blackout](power_loss.md)) or
135 - The chassis power good signal from the power sequencer will **not** be read.
136   Since communication to the chassis is not possible, the value of the power
138   - If the chassis is experiencing a blackout, the chassis has no input power
140   - If all other chassis have a `pgood` value of 0, the `pgood` value will be
142   - If at least one other chassis has a `pgood` value of 1, the `pgood` value
144 - The chassis will **not** be powered on when the system is being powered on.
145   The `state` property on the `org.openbmc.control.Power` interface for the
151 D-Bus interface.
153 This interface is published on the D-Bus inventory path for each chassis.
154 `phosphor-power-sequencer` does not publish this interface, but it checks the
155 `Enabled` property on multiple chassis systems.
160 the system is powered on.
164 - The chassis power good signal from the power sequencer will be read. The
165   `pgood` property on the `org.openbmc.control.Power` interface for the chassis
167 - The chassis will **not** be powered on when the system is being powered on.
168   The `state` property on the `org.openbmc.control.Power` interface for the
174 [`xyz.openbmc_project.State.Decorator.PowerSystemInputs`][4] D-Bus interface.
176 `phosphor-power-sequencer` does not publish this interface, but it checks the
177 `Status` property on multiple chassis systems.
181 [power loss](power_loss.md) is occurring, such as a power company utility
182 failure or an unplugged power cord. See the sub-sections below for more
185 ### Chassis power status
187 The `phosphor-chassis-power` application publishes the
188 `xyz.openbmc_project.State.Decorator.PowerSystemInputs` interface on the
191 - `/xyz/openbmc_project/power/chassis/chassis1`
192 - `/xyz/openbmc_project/power/chassis/chassis2`
193 - ...
194 - `/xyz/openbmc_project/power/chassis/chassisN`
198 - The chassis is experiencing a blackout.
199 - The chassis power good signal from the power sequencer will **not** be read.
200   Since the chassis has no input power, the `pgood` property on the
201   `org.openbmc.control.Power` interface for the chassis will be set to 0.
202 - The chassis will **not** be powered on when the system is being powered on.
203   The `state` property on the `org.openbmc.control.Power` interface for the
205   chassis was not powered on due to an input power problem.
207 ### Power supplies power status
209 The `phosphor-power-supply` application publishes the
210 `xyz.openbmc_project.State.Decorator.PowerSystemInputs` interface on the
213 - `/xyz/openbmc_project/power/power_supplies/chassis1/psus`
214 - `/xyz/openbmc_project/power/power_supplies/chassis2/psus`
215 - ...
216 - `/xyz/openbmc_project/power/power_supplies/chassisN/psus`
220 - The chassis is experiencing a brownout.
221 - The chassis power good signal from the power sequencer will be read. The
222   `pgood` property on the `org.openbmc.control.Power` interface for the chassis
224 - The chassis will **not** be powered on when the system is being powered on.
225   The `state` property on the `org.openbmc.control.Power` interface for the
227   chassis was not powered on due to an input power problem.
230 …https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Inventory…
232 …https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/State/Dec…
234 …https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Object/En…
236 …https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/State/Dec…