regulators: Remove monitoring freq from comments
Update doxygen comments to remove the exact frequency of sensor
monitoring and phase fault detection.
Currently sensors are monitored every second and phase faults are
detected every 15 seconds. However, that could change in the future.
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: I3ac39955721fde98dfe9e6059693ceeea7e504c2
diff --git a/phosphor-regulators/src/chassis.hpp b/phosphor-regulators/src/chassis.hpp
index b0f8561..dc86ed0 100644
--- a/phosphor-regulators/src/chassis.hpp
+++ b/phosphor-regulators/src/chassis.hpp
@@ -122,7 +122,7 @@
/**
* Detect redundant phase faults in regulator devices in this chassis.
*
- * This method should be called every 15 seconds.
+ * This method should be called repeatedly based on a timer.
*
* @param services system services like error logging and the journal
* @param system system that contains this chassis
@@ -166,7 +166,7 @@
* Monitors the sensors for the voltage rails produced by this chassis, if
* any.
*
- * This method should be called once per second.
+ * This method should be called repeatedly based on a timer.
*
* @param services system services like error logging and the journal
* @param system system that contains the chassis
diff --git a/phosphor-regulators/src/device.hpp b/phosphor-regulators/src/device.hpp
index af0e8ec..352daeb 100644
--- a/phosphor-regulators/src/device.hpp
+++ b/phosphor-regulators/src/device.hpp
@@ -137,7 +137,7 @@
*
* Does nothing if phase fault detection is not defined for this device.
*
- * This method should be called every 15 seconds.
+ * This method should be called repeatedly based on a timer.
*
* @param services system services like error logging and the journal
* @param system system that contains the chassis
@@ -255,7 +255,7 @@
* Monitors the sensors for the voltage rails produced by this device, if
* any.
*
- * This method should be called once per second.
+ * This method should be called repeatedly based on a timer.
*
* @param services system services like error logging and the journal
* @param system system that contains the chassis
diff --git a/phosphor-regulators/src/phase_fault_detection.hpp b/phosphor-regulators/src/phase_fault_detection.hpp
index 876d90e..6a84102 100644
--- a/phosphor-regulators/src/phase_fault_detection.hpp
+++ b/phosphor-regulators/src/phase_fault_detection.hpp
@@ -51,9 +51,9 @@
* hardware. Often a bit is checked in a status register. The status register
* could exist in the regulator or in a related I/O expander.
*
- * Phase fault detection is performed every 15 seconds. A phase fault must be
- * detected two consecutive times (15 seconds apart) before an error is logged.
- * This provides "de-glitching" to ignore transient hardware problems.
+ * Phase fault detection is executed repeatedly based on a timer. A phase fault
+ * must be detected two consecutive times before an error is logged. This
+ * provides "de-glitching" to ignore transient hardware problems.
*
* Phase faults are detected by executing actions.
*/
diff --git a/phosphor-regulators/src/rail.hpp b/phosphor-regulators/src/rail.hpp
index 5591c36..63d80eb 100644
--- a/phosphor-regulators/src/rail.hpp
+++ b/phosphor-regulators/src/rail.hpp
@@ -119,7 +119,7 @@
* Sensor monitoring is optional. If sensor monitoring is defined for this
* rail, the sensor values are read.
*
- * This method should be called once per second.
+ * This method should be called repeatedly based on a timer.
*
* @param services system services like error logging and the journal
* @param system system that contains the chassis
diff --git a/phosphor-regulators/src/sensor_monitoring.hpp b/phosphor-regulators/src/sensor_monitoring.hpp
index 00823af..fcb02a5 100644
--- a/phosphor-regulators/src/sensor_monitoring.hpp
+++ b/phosphor-regulators/src/sensor_monitoring.hpp
@@ -40,8 +40,8 @@
*
* Sensor values are measured, actual values rather than target values.
*
- * Sensors are read once per second. The sensor values are stored on D-Bus,
- * making them available to external interfaces like Redfish.
+ * Sensors are read repeatedly based on a timer. The sensor values are stored
+ * on D-Bus, making them available to external interfaces like Redfish.
*
* Sensors are read by executing actions, such as PMBusReadSensorAction. To
* read multiple sensors for a rail, multiple actions need to be executed.
diff --git a/phosphor-regulators/src/system.hpp b/phosphor-regulators/src/system.hpp
index caa3804..accd7f0 100644
--- a/phosphor-regulators/src/system.hpp
+++ b/phosphor-regulators/src/system.hpp
@@ -95,7 +95,7 @@
/**
* Detect redundant phase faults in regulator devices in the system.
*
- * This method should be called every 15 seconds.
+ * This method should be called repeatedly based on a timer.
*
* @param services system services like error logging and the journal
*/
@@ -138,7 +138,7 @@
* Monitors the sensors for the voltage rails produced by this system, if
* any.
*
- * This method should be called once per second.
+ * This method should be called repeatedly based on a timer.
*
* @param services system services like error logging and the journal
*/