docs/designs/hw-fault-monitor.md

1 # Hardware Fault Monitor
12 The goal is to create a new hardware fault monitor which will provide a
17 information through BMC interfaces, the hardware fault monitor will also receive
22 Future expansion of the hardware fault monitor would include adding the means to
25 hardware fault monitor could receive repair action requests via Redfish from
32 - Host Error Monitor logs CPU error information such as CATERR details and takes
34   https://github.com/openbmc/host-error-monitor
53   https://github.com/openbmc/phosphor-led-manager/blob/master/fault-monitor/fru-fault-monitor.hpp
67   goal of the fault monitor is to enable rich error logging (OEM and CPU vendor
68   specific) for data center tools to monitor servers, manage repairs, predict
71 - The fault monitor must be able to handle receiving fault information that is
75 - The fault monitor should allow for logging of a variety of sizes of fault
85 - The fault monitor must allow for custom overwrite rules for its log entries
93 A generic fault monitor will be created to collect fault information. First we
96 - On CATERR, the Host Error Monitor requests a crash dump (this is an existing
98   platform-specific system-level data. The fault monitor would therefore
104 - The fault monitor would monitor link level retries and link retrainings of
107   crash. The fault monitor in the BMC could check link level retries and link
109   the fault monitor could then add additional information such as high speed
112 - In order to monitor memory out of band, a system could be configured to give
116   monitor could log error registers either through polling or interrupts. Data
120 The fault monitor will not have its own dedicated OpenBMC repository, but will
122 host-error-monitor, bmcweb, and phosphor-debug-collector.
124 In the existing Host Error Monitor module, new monitors will be created to add
125 functionality needed for the fault monitor. For instance, based on the needs of
126 the OEM, the fault monitor will register to be notified of D-Bus signals of
127 interest in order to be alerted when fault events occur. The fault monitor will
131 resource collection). When the fault monitor becomes aware of a new fault
133 log. The fault monitor may also gather relevant sensor data (read via D-Bus from
162 send external notifications, such as when the fault monitor needs to notify
179 There may be situations where external consumers of fault monitor logs (e.g.
183 monitor that they are not prepared to handle.
191 error conditions that will be logged by the fault monitor module.
194 intend to add unit testing for the fault monitor.