README.md: Fix MD001 warnings

The following warnings are generated by using markdownlint analysis:
```
MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
```
Refer to markdown-lint [1] to fix MD001
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/001-header-increment.md

Signed-off-by: George Liu <liuxiwei@ieisystem.com>
Change-Id: Ib0c663fd3ba731018287af81efe4820914ab6e95
1 file changed
tree: ef9fa9f7c2668e59e3836b5f5e863311b0dbdd12
  1. .clang-format
  2. ecc_main.cpp
  3. ecc_manager.cpp
  4. ecc_manager.hpp
  5. LICENSE
  6. maxlog.conf
  7. meson.build
  8. OWNERS
  9. phosphor-ecc.service.in
  10. README.md
README.md

phosphor-ecc

Overview

This function is to provide the BMC with the ability to record ECC error SELs. The EDAC driver of BMC can detects and corrects memory errors, which helps identify problems before they become catastrophic faulty memory module.

Requirements

  • The EDAC driver must be supported and enabled
  • The phosphor-sel-logger package must be installed

Monitor Daemon

Run the application and look up the ECC error count every second after service is started. On first start, it resets all correctable ECC counts and uncorrectable ECC counts in the EDAC driver.

it also provide the following path on D-Bus:

  • bus name : xyz.openbmc_project.Memory.ECC
  • object path : /xyz/openbmc_project/metrics/memory/BmcECC
  • interface : xyz.openbmc_project.Memory.MemoryECC

The interface with the following properties:

PropertyTypeDescription
isLoggingLimitReachedboolECC logging reach limits
ceCountint64correctable ECC events
ueCountint64uncorrectable ECC events
statestringbmc ECC event state

It also devised a mechanism to limit the "maximum number" of logs to avoid creating a large number of correctable ECC logs. When the maximum quantity is reached, the ECC service will stop to record the ECC log. The maximum quantity (default:100) is saved in the configuration file, and the user can modify the value if necessary.

Create the ECC SEL

Use the phosphor-sel-logger package to record the following logs in BMC SEL format.

  • correctable ECC log : when fetching the ce_count from EDAC driver parameter and the count exceeds previous count.
  • uncorrectable ECC log : when fetching the ue_count from EDAC driver parameter and the count exceeds previous count.
  • logging limit reached log : When the correctable ECC log reaches the maximum quantity.