191090e41SShawn McCarney## Overview 291090e41SShawn McCarney 391090e41SShawn McCarneyThe `phosphor-regulators` application configures and monitors voltage 491090e41SShawn McCarneyregulators. The application is controlled by a JSON configuration file. 591090e41SShawn McCarney 691090e41SShawn McCarneyThe application does not control how voltage regulators are enabled or how to 791090e41SShawn McCarneymonitor their Power Good (pgood) status. Those operations are typically 891090e41SShawn McCarneyperformed by power sequencer hardware and related firmware. 991090e41SShawn McCarney 1091090e41SShawn McCarney## Configuring Voltage Regulators 1191090e41SShawn McCarney 1291090e41SShawn McCarneyThe configuration of voltage regulators can be modified. Configuration changes 1391090e41SShawn McCarneyusually override hardware default settings. 1491090e41SShawn McCarney 1591090e41SShawn McCarneyThe most common configuration change is setting the output voltage for a 1691090e41SShawn McCarneyregulator rail. Other examples include modifying pgood thresholds and 1791090e41SShawn McCarneyovercurrent settings. 1891090e41SShawn McCarney 1991090e41SShawn McCarneyThe configuration changes are applied early in the boot process before 2091090e41SShawn McCarneyregulators are enabled. 2191090e41SShawn McCarney 2291090e41SShawn McCarney## Monitoring Voltage Regulators 2391090e41SShawn McCarney 2491090e41SShawn McCarneyTwo types of regulator monitoring are supported: 25*0dbce568SPatrick Williams 26*0dbce568SPatrick Williams- Sensor monitoring 27*0dbce568SPatrick Williams- Phase fault monitoring 2891090e41SShawn McCarney 2991090e41SShawn McCarney### Sensor Monitoring 3091090e41SShawn McCarney 3191090e41SShawn McCarneyThe sensor values for a voltage rail are read, such as voltage output, current 3291090e41SShawn McCarneyoutput, and temperature. Sensor values are measured, actual values rather than 3391090e41SShawn McCarneytarget values. 3491090e41SShawn McCarney 3591090e41SShawn McCarneySensors are read once per second. The sensor values are stored on D-Bus on the 3691090e41SShawn McCarneyBMC, making them available to external interfaces like Redfish. 3791090e41SShawn McCarney 3891090e41SShawn McCarney### Phase Fault Monitoring 3991090e41SShawn McCarney 4091090e41SShawn McCarneySome voltage regulators contain redundant phases. If a redundant phase fails, 4191090e41SShawn McCarneythe regulator can continue functioning normally. However redundancy has been 4291090e41SShawn McCarneylost, and the regulator may fail if another phase fails. 4391090e41SShawn McCarney 4491090e41SShawn McCarneyVoltage regulators can be monitored for redundant phase faults. If a fault is 4591090e41SShawn McCarneydetected, an error is logged on the BMC. 4691090e41SShawn McCarney 4791090e41SShawn McCarney## JSON Configuration File 4891090e41SShawn McCarney 4991090e41SShawn McCarneyThe JSON configuration file defines the following: 50*0dbce568SPatrick Williams 51*0dbce568SPatrick Williams- Voltage regulators in the system. 52*0dbce568SPatrick Williams- Operations to perform on those regulators, such as configuration or sensor 5391090e41SShawn McCarney monitoring. 5491090e41SShawn McCarney 5591090e41SShawn McCarneyConfiguration files are stored in the `config_files` directory. 5691090e41SShawn McCarney 5791090e41SShawn McCarneySee the [configuration file documentation](docs/config_file/README.md) for 5891090e41SShawn McCarneyinformation on the file format, validation tool, and installation directories. 59