Filter for root cause attention in analyzer
Signed-off-by: Zane Shelley <zshelle@us.ibm.com>
Change-Id: Ie9abf7de093140316bf30d7a2c11799a3654192c
diff --git a/analyzer/analyzer_main.hpp b/analyzer/analyzer_main.hpp
index 922179f..951fc6b 100644
--- a/analyzer/analyzer_main.hpp
+++ b/analyzer/analyzer_main.hpp
@@ -7,12 +7,24 @@
{
/**
- * @brief Analyze and isolate hardware errors
+ * @brief Queries the host hardware for all attentions reported by each active
+ * chip. Then it performs all approriate RAS actions based on the active
+ * attentions.
*
- * If any error conditions are found on the host isolate the hardware
- * component that caused the error(s).
+ * @param o_errors A map for storing information about errors that were
+ * detected by the hardware error isolator.
+ *
+ * @return True if an active attenion was successfully analyzed, false
+ * otherwise.
+ * For system checkstop handling:
+ * If analysis fails, there likely is a defect in the design because
+ * an active attention is required to trigger the interrupt.
+ * For TI handling:
+ * It is possible that a recoverable attention could cause a TI,
+ * however, it is not required. Therefore, it is expected that
+ * analysis could fail to find an attention and it should not be
+ * treated as a defect.
*/
-
bool analyzeHardware(std::map<std::string, std::string>& i_errors);
} // namespace analyzer