1*80689db1SShawn McCarney# Regulator Monitoring 2*80689db1SShawn McCarney 3*80689db1SShawn McCarney## Overview 4*80689db1SShawn McCarney 5*80689db1SShawn McCarneyThe `phosphor-regulators` application supports two types of regulator 6*80689db1SShawn McCarneymonitoring: 7*80689db1SShawn McCarney 8*80689db1SShawn McCarney- [Sensor monitoring](sensor_monitoring.md) 9*80689db1SShawn McCarney - Reading sensor values such as voltage output and temperature 10*80689db1SShawn McCarney- [Phase fault monitoring](phase_fault_monitoring.md) 11*80689db1SShawn McCarney - Checking if a redundant regulator phase has failed 12*80689db1SShawn McCarney 13*80689db1SShawn McCarneyMonitoring is optional and is defined in the 14*80689db1SShawn McCarney[JSON config file](config_file/README.md) 15*80689db1SShawn McCarney 16*80689db1SShawn McCarney## How monitoring is enabled 17*80689db1SShawn McCarney 18*80689db1SShawn McCarneyRegulator monitoring is enabled during the system boot after regulators are 19*80689db1SShawn McCarneyenabled (turned on). 20*80689db1SShawn McCarney 21*80689db1SShawn McCarneyThe systemd service file 22*80689db1SShawn McCarney[phosphor-regulators-monitor-enable.service](../../services/phosphor-regulators-monitor-enable.service) 23*80689db1SShawn McCarneyis started. This runs the `regsctl` utility. This utility invokes the D-Bus 24*80689db1SShawn McCarney`monitor` method on the `phosphor-regulators` application. The parameter value 25*80689db1SShawn McCarney`true` is passed to the method. 26*80689db1SShawn McCarney 27*80689db1SShawn McCarney`phosphor-regulators` will start performing the monitoring defined in the JSON 28*80689db1SShawn McCarneyconfig file. Monitoring is done periodically based on a timer. 29*80689db1SShawn McCarney 30*80689db1SShawn McCarney## How monitoring is disabled 31*80689db1SShawn McCarney 32*80689db1SShawn McCarneyRegulator monitoring is disabled at the beginning of system shutdown before 33*80689db1SShawn McCarneyregulators are disabled (turned off). 34*80689db1SShawn McCarney 35*80689db1SShawn McCarneyThe systemd service file 36*80689db1SShawn McCarney[phosphor-regulators-monitor-disable.service](../../services/phosphor-regulators-monitor-disable.service) 37*80689db1SShawn McCarneyis started. This runs the `regsctl` utility. This utility invokes the D-Bus 38*80689db1SShawn McCarney`monitor` method on the `phosphor-regulators` application. The parameter value 39*80689db1SShawn McCarney`false` is passed to the method. 40*80689db1SShawn McCarney 41*80689db1SShawn McCarney`phosphor-regulators` will stop performing the monitoring defined in the JSON 42*80689db1SShawn McCarneyconfig file. 43