180689db1SShawn McCarney# Regulator Monitoring 280689db1SShawn McCarney 380689db1SShawn McCarney## Overview 480689db1SShawn McCarney 580689db1SShawn McCarneyThe `phosphor-regulators` application supports two types of regulator 680689db1SShawn McCarneymonitoring: 780689db1SShawn McCarney 880689db1SShawn McCarney- [Sensor monitoring](sensor_monitoring.md) 980689db1SShawn McCarney - Reading sensor values such as voltage output and temperature 1080689db1SShawn McCarney- [Phase fault monitoring](phase_fault_monitoring.md) 1180689db1SShawn McCarney - Checking if a redundant regulator phase has failed 1280689db1SShawn McCarney 1380689db1SShawn McCarneyMonitoring is optional and is defined in the 1480689db1SShawn McCarney[JSON config file](config_file/README.md) 1580689db1SShawn McCarney 1680689db1SShawn McCarney## How monitoring is enabled 1780689db1SShawn McCarney 1880689db1SShawn McCarneyRegulator monitoring is enabled during the system boot after regulators are 1980689db1SShawn McCarneyenabled (turned on). 2080689db1SShawn McCarney 2180689db1SShawn McCarneyThe systemd service file 2280689db1SShawn McCarney[phosphor-regulators-monitor-enable.service](../../services/phosphor-regulators-monitor-enable.service) 2380689db1SShawn McCarneyis started. This runs the `regsctl` utility. This utility invokes the D-Bus 2480689db1SShawn McCarney`monitor` method on the `phosphor-regulators` application. The parameter value 2580689db1SShawn McCarney`true` is passed to the method. 2680689db1SShawn McCarney 2780689db1SShawn McCarney`phosphor-regulators` will start performing the monitoring defined in the JSON 2880689db1SShawn McCarneyconfig file. Monitoring is done periodically based on a timer. 2980689db1SShawn McCarney 3080689db1SShawn McCarney## How monitoring is disabled 3180689db1SShawn McCarney 3280689db1SShawn McCarneyRegulator monitoring is disabled at the beginning of system shutdown before 3380689db1SShawn McCarneyregulators are disabled (turned off). 3480689db1SShawn McCarney 3580689db1SShawn McCarneyThe systemd service file 3680689db1SShawn McCarney[phosphor-regulators-monitor-disable.service](../../services/phosphor-regulators-monitor-disable.service) 3780689db1SShawn McCarneyis started. This runs the `regsctl` utility. This utility invokes the D-Bus 3880689db1SShawn McCarney`monitor` method on the `phosphor-regulators` application. The parameter value 3980689db1SShawn McCarney`false` is passed to the method. 4080689db1SShawn McCarney 4180689db1SShawn McCarney`phosphor-regulators` will stop performing the monitoring defined in the JSON 4280689db1SShawn McCarneyconfig file. 43*8b38b177SShawn McCarney 44*8b38b177SShawn McCarney## Multiple chassis 45*8b38b177SShawn McCarney 46*8b38b177SShawn McCarneyIn a [multiple chassis](multiple_chassis.md) system, `phosphor-regulators` will 47*8b38b177SShawn McCarneyonly monitor regulators in chassis with the proper status: 48*8b38b177SShawn McCarney 49*8b38b177SShawn McCarney- `Present` property is true 50*8b38b177SShawn McCarney- `pgood` property is 1 51*8b38b177SShawn McCarney- `Available` property is true (if interface exists) 52*8b38b177SShawn McCarney 53*8b38b177SShawn McCarneySee [Chassis Status](../phosphor-power-sequencer/docs/chassis_status.md) for 54*8b38b177SShawn McCarneymore information on these properties. 55