Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / 552992a66a275a046a93922dc14fa551da5a7f05
commit552992a66a275a046a93922dc14fa551da5a7f05[log] [tgz]
authorBen Tyner <ben.tyner@ibm.com>Thu Apr 15 10:57:17 2021 -0500
committerBen Tyner <ben.tyner@ibm.com>Thu Apr 15 14:53:17 2021 -0500
tree97d25cd6edbefbbe8b83d6f928c49af039af078a
parent995be6c72a49a5e4fd0d6fd8d4b9d080a245af85 [diff]
Add build information to binary

Build information will be compiled into the binary. An associated
function was added to retrieve this information for displaying in
applications that consume this library.

Signed-off-by: Ben Tyner <ben.tyner@ibm.com>
Change-Id: I68e467c714ea11c0f5639670396617bc0ff51334
4 files changed
tree: 97d25cd6edbefbbe8b83d6f928c49af039af078a
  1. src/
  2. test/
  3. xml/
  4. .clang-format
  5. .gitignore
  6. buildinfo.hpp.in
  7. LICENSE
  8. MAINTAINERS
  9. meson.build
  10. meson_options.txt
  11. 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