Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / 6b1fe16ad1e10d30bef8a0a3b7345b3b963342c6
commit6b1fe16ad1e10d30bef8a0a3b7345b3b963342c6[log] [tgz]
authorZane Shelley <zshelle@us.ibm.com>Fri Nov 18 13:37:42 2022 -0600
committerZane Shelley <zshelle@us.ibm.com>Tue Nov 29 17:47:19 2022 +0000
tree1f04db94dc3a4164c1e4226a4d6b28a164780496
parent72fd2e4371be2356b8628d7968f33db6d6a03095 [diff]
Capture data support for an isolation bit

User applications can not specify registers to capture if there is an
active attention on a specific bit in an isolation node. This helps
reduce the number of registers captured by default when analyzing an
isolation node.

Change-Id: I50c88cb8a2fa3d89d2c7446dbc04d0f33bbb0cd2
Signed-off-by: Zane Shelley <zshelle@us.ibm.com>
5 files changed
tree: 1f04db94dc3a4164c1e4226a4d6b28a164780496
  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