Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / e2e645e8c5e7469573d5bbae080bf553897052e4
commite2e645e8c5e7469573d5bbae080bf553897052e4[log] [tgz]
authorCaleb Palmer <cnpalmer@us.ibm.com>Tue Sep 03 15:34:45 2024 -0500
committerCaleb Palmer <cnpalmer@us.ibm.com>Thu Sep 05 11:45:52 2024 -0500
treef6f64f25e99c9f0c81499004aae9ef343cf59a85
parentae60d8e4e79ae456843297dd754f1003e72232bd [diff]
Update chip data chip-config option to work with distutil

Signed-off-by: Caleb Palmer <cnpalmer@us.ibm.com>
Change-Id: Iea68e7b89c96505e993b77951eac630ae6f81ef0
1 file changed
tree: f6f64f25e99c9f0c81499004aae9ef343cf59a85
  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