phosphor-power-sequencer/docs/README.md

1 # phosphor-power-sequencer
5 The `phosphor-power-sequencer` application powers all the chassis in the system
6 on and off. It also monitors the power good (pgood) state in each chassis.
11 `phosphor-chassis-state-manager` application and the planned new
12 `phosphor-chassis-power` application. This disclaimer will be removed when this
17 `phosphor-power-sequencer` is a single-threaded C++ executable. It is a daemon
21 `phosphor-power-sequencer` is driven by an optional, system-specific JSON
24 chassis, power sequencer devices, voltage rails, GPIOs, and fault checks to
29 ## Power sequencer device
31 A power sequencer device enables (turns on) the voltage rails in the correct
34 `phosphor-power-sequencer` currently supports the following power sequencer
37 - UCD90160
38 - UCD90320
40 Additional device types can be supported by creating a new sub-class within the
44 If the power sequencer device type is not supported, `phosphor-power-sequencer`
45 can still power the system on/off and detect chassis pgood faults. However, it
50 `phosphor-power-sequencer` uses the power sequencer device to power on all main
51 (non-standby) voltage rails in each chassis.
57 `phosphor-power-sequencer` uses the power sequencer device to power off all main
58 (non-standby) voltage rails in each chassis.
64 `phosphor-power-sequencer` periodically reads the chassis pgood state from the
65 power sequencer device. See
66 [Monitoring Chassis Power Good](monitoring_chassis_pgood.md) for more
72 fault has occurred. `phosphor-power-sequencer` uses information from the power
75 See [Power Good Faults](pgood_faults.md) for more information.
79 `phosphor-power-sequencer` is configured by an optional JSON configuration file.
83 JSON configuration files are system-specific and are stored in the
84 [config_files](../config_files/) sub-directory.
90 `phosphor-power-sequencer` can still power the system on/off and detect chassis
101 ### phosphor-chassis-state-manager
103 The `phosphor-chassis-state-manager` application exists in the
104 phosphor-state-manager repository. It supports user requests to power on and off
106 D-Bus interface.
108 ### phosphor-chassis-power
110 The `phosphor-chassis-power` application exists in the phosphor-power
111 repository. It monitors the chassis input power state using GPIOs.
113 ### phosphor-power-supply
115 The `phosphor-power-supply` application exists in the phosphor-power repository.
116 It monitors the power supply devices within each chassis.
119 …https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/State/Cha…