Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / cfe788bdd48e7d4c1c86358c066023555231f5f4
commitcfe788bdd48e7d4c1c86358c066023555231f5f4[log] [tgz]
authorGeorge Liu <liuxiwei@ieisystem.com>Mon Aug 05 14:16:32 2024 +0800
committerGeorge Liu <liuxiwei@ieisystem.com>Tue Aug 06 09:31:02 2024 +0800
treec35f1a15ca255b5f5001874a06d0bcf95aa6e3dc
parent5119d963fc6f868d0ec08b92b1e90e86444e717f [diff]
README.md: Fix MD040 warnings

The following warnings are generated by using markdownlint analysis:
```
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
```
Refer to markdown-lint [1] to fix MD040
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/040-fenced-code-language.md

Signed-off-by: George Liu <liuxiwei@ieisystem.com>
Change-Id: I51aa5398d1be503d8db7af666312e7d30348b56d
1 file changed
tree: c35f1a15ca255b5f5001874a06d0bcf95aa6e3dc
  1. chip_data/
  2. src/
  3. subprojects/
  4. test/
  5. .clang-format
  6. .eslintignore
  7. .gitignore
  8. .prettierignore
  9. .prettierrc.yaml
  10. buildinfo.hpp.in
  11. LICENSE
  12. meson.build
  13. meson_options.txt
  14. OWNERS
  15. README.md
README.md

openpower-libhei: Hardware Error Isolation for POWER Systems

This library is a common, portable code base for isolating errors reported by hardware registers on POWER Systems chips.

The primary consumers (and requirements drivers) will be:

Core API

See the primary API definitions for details on how to use this library.

Integration

This library can be integrated into a user application's source (either imported, or as a git subtree/submodule) or built as static library.

User Application Requirements and APIs

  • The process to access hardware register data will vary per user application. Therefore, this library will declare the hardware access user APIs, but each user application must implement the APIs for their own environment.
  • This library will not contain data regarding hardware specific information. Instead, that information will be provided by the user application in the form of the Chip Data Files.
  • Tracing, or logging, methods will vary per user application. Therefore, this library will declare the tracing/logging user APIs, but each user application must implement the APIs for their own environment.

Environment configuration

  • __HEI_ENABLE_HW_WRITE: When defined, it will allow hardware write support. Note that the Chip Data Files will contain rules for clearing and masking register bits. Both of which will require modifying hardware registers, which is not allowed by user applications like OpenBMC or FSP firmware.

Development Notes

  • The Hostboot environment only supports up to C++14. Therefore, this library cannot use anything newer at this time.
  • Hostboot has a very limited environment. It does not include libc or libstdc++. However, Hostboot has implemented select functions from those libraries as needed. For details, you can reference src/include/ in the POWER Systems Hostboot firmware.

Building

For a standard OpenBMC release build, you want something like:

meson -Dtests=disabled <build_dir>
ninja -C <build_dir>
ninja -C <build_dir> install

For a test / debug build, a typical configuration is:

meson -Dtests=enabled <build_dir>
ninja -C <build_dir> test