Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / d12b8fd3e27ca2663bcbcb94c75e3c4632a65e00
commitd12b8fd3e27ca2663bcbcb94c75e3c4632a65e00[log] [tgz]
authorZane Shelley <zshelle@us.ibm.com>Wed Jan 19 09:32:06 2022 -0600
committerZane Shelley <zshelle@us.ibm.com>Wed Jan 19 09:32:06 2022 -0600
tree98ebc352b92de35e8b6fb626584a899eb1ed20b9
parent72b755f43bf04b1dd5bdc4dec1c071e16ac2fa37 [diff]
install header hei_util.hpp for external use

Signed-off-by: Zane Shelley <zshelle@us.ibm.com>
Change-Id: Iad4205bee94fe1298fdccf1a792bb99e1c33621b
1 file changed
tree: 98ebc352b92de35e8b6fb626584a899eb1ed20b9
  1. src/
  2. subprojects/
  3. test/
  4. xml/
  5. .clang-format
  6. .eslintignore
  7. .gitignore
  8. buildinfo.hpp.in
  9. LICENSE
  10. MAINTAINERS
  11. meson.build
  12. meson_options.txt
  13. OWNERS
  14. 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