phosphor-regulators/docs/README.md

1 # phosphor-regulators
5 The `phosphor-regulators` application configures and monitors voltage
9 monitor their Power Good (pgood) status. Those operations are typically
10 performed by power sequencer hardware and the
11 [`phosphor-power-sequencer`](../../phosphor-power-sequencer/docs/README.md)
17 planned new `phosphor-chassis-power` application. This disclaimer will be
22 `phosphor-regulators` is a single-threaded C++ executable. It is a 'daemon'
26 The application is driven by a system-specific JSON configuration file. The JSON
35 `phosphor-regulators` can modify the configuration of voltage regulators, such
42 `phosphor-regulators` supports two types of regulator monitoring:
44 - Sensor monitoring
45   - Reading sensor values such as voltage output and temperature
46 - Phase fault monitoring
47   - Checking if a redundant regulator phase has failed
55 - Voltage regulators in the system.
56 - Operations to perform on those regulators, such as configuration or sensor
67 A BMC-based system can contain one or more chassis. A chassis is typically a
68 physical enclosure that contains system components such as CPUs, fans, power