regulators: Add clearErrorHistory to Rail class
Add a clearErrorHistory() method to the Rail class. The method should
clear all data on previously logged errors. If the error occurs again
in the future, it will be logged again.
This method is normally called when the system is being powered on. For
code that runs repeatedly, errors are only logged once per boot.
When the system is powered off, hardware may be replaced that fixes the
problem. Thus, errors are cleared during power on.
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: I41e56162165186acb7a7872a288f0582874aa87d
diff --git a/phosphor-regulators/src/rail.hpp b/phosphor-regulators/src/rail.hpp
index ac55060..c661183 100644
--- a/phosphor-regulators/src/rail.hpp
+++ b/phosphor-regulators/src/rail.hpp
@@ -68,6 +68,16 @@
}
/**
+ * Clears all error history.
+ *
+ * All data on previously logged errors will be deleted. If errors occur
+ * again in the future they will be logged again.
+ *
+ * This method is normally called when the system is being powered on.
+ */
+ void clearErrorHistory();
+
+ /**
* Configure this rail.
*
* Applies the configuration changes that are defined for this rail, if any.