xref: /openbmc/phosphor-power/phosphor-regulators/docs/monitoring.md (revision 8b38b177315d40f1f9bc1e4d0784d45ea17cbd5c)
1# Regulator Monitoring
2
3## Overview
4
5The `phosphor-regulators` application supports two types of regulator
6monitoring:
7
8- [Sensor monitoring](sensor_monitoring.md)
9  - Reading sensor values such as voltage output and temperature
10- [Phase fault monitoring](phase_fault_monitoring.md)
11  - Checking if a redundant regulator phase has failed
12
13Monitoring is optional and is defined in the
14[JSON config file](config_file/README.md)
15
16## How monitoring is enabled
17
18Regulator monitoring is enabled during the system boot after regulators are
19enabled (turned on).
20
21The systemd service file
22[phosphor-regulators-monitor-enable.service](../../services/phosphor-regulators-monitor-enable.service)
23is started. This runs the `regsctl` utility. This utility invokes the D-Bus
24`monitor` method on the `phosphor-regulators` application. The parameter value
25`true` is passed to the method.
26
27`phosphor-regulators` will start performing the monitoring defined in the JSON
28config file. Monitoring is done periodically based on a timer.
29
30## How monitoring is disabled
31
32Regulator monitoring is disabled at the beginning of system shutdown before
33regulators are disabled (turned off).
34
35The systemd service file
36[phosphor-regulators-monitor-disable.service](../../services/phosphor-regulators-monitor-disable.service)
37is started. This runs the `regsctl` utility. This utility invokes the D-Bus
38`monitor` method on the `phosphor-regulators` application. The parameter value
39`false` is passed to the method.
40
41`phosphor-regulators` will stop performing the monitoring defined in the JSON
42config file.
43
44## Multiple chassis
45
46In a [multiple chassis](multiple_chassis.md) system, `phosphor-regulators` will
47only monitor regulators in chassis with the proper status:
48
49- `Present` property is true
50- `pgood` property is 1
51- `Available` property is true (if interface exists)
52
53See [Chassis Status](../phosphor-power-sequencer/docs/chassis_status.md) for
54more information on these properties.
55