phosphor-power-sequencer/docs/README.md

1 # phosphor-power-sequencer
5 The `phosphor-power-sequencer` application powers all the chassis in the system
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
19 the Ready state and before the system is powered on.
21 `phosphor-power-sequencer` is driven by an optional, system-specific JSON
22 configuration file. The config file is found and parsed at runtime. The parsing
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
48 ## Powering on the system
50 `phosphor-power-sequencer` uses the power sequencer device to power on all main
51 (non-standby) voltage rails in each chassis.
55 ## Powering off the system
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
72 fault has occurred. `phosphor-power-sequencer` uses information from the power
77 ## JSON configuration file
79 `phosphor-power-sequencer` is configured by an optional JSON configuration file.
80 The configuration file defines the voltage rails in the system and how they
83 JSON configuration files are system-specific and are stored in the
84 [config_files](../config_files/) sub-directory.
86 [Documentation](config_file/README.md) is available on the configuration file
89 If no configuration file is found for the current system,
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
105 the system hardware. It publishes the [`xyz.openbmc_project.State.Chassis`][1]
106 D-Bus interface.
108 ### phosphor-chassis-power
110 The `phosphor-chassis-power` application exists in the phosphor-power
113 ### phosphor-power-supply
115 The `phosphor-power-supply` application exists in the phosphor-power repository.
119 …https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/State/Cha…