Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / b9ea93c5cb15b8fed0f44780f9b2a6a0ffe34f28
commitb9ea93c5cb15b8fed0f44780f9b2a6a0ffe34f28[log] [tgz]
authorZane Shelley <zshelle@us.ibm.com>Fri Mar 10 10:41:41 2023 -0600
committerZane Shelley <zshelle@us.ibm.com>Wed Mar 22 21:57:19 2023 +0000
treec262acb6865e2ba8c1ff0db982c740092985daa4
parent3b2760b2a61b29ad70bf6b222973b992b495fdbf [diff]
Copied P10, Explorer, and Odyssey chip data from PRD project

Signed-off-by: Zane Shelley <zshelle@us.ibm.com>
Change-Id: I7d0b1571242fb2da9378bcbfa7c2f0541b8ac915
174 files changed
tree: c262acb6865e2ba8c1ff0db982c740092985daa4
  1. chip_data/
  2. src/
  3. subprojects/
  4. test/
  5. xml/
  6. .clang-format
  7. .eslintignore
  8. .gitignore
  9. .prettierignore
  10. .prettierrc.yaml
  11. buildinfo.hpp.in
  12. LICENSE
  13. MAINTAINERS
  14. meson.build
  15. meson_options.txt
  16. OWNERS
  17. 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