Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / 738276af00c74b57e1bd1c91b76d917066fcdea1
commit738276af00c74b57e1bd1c91b76d917066fcdea1[log] [tgz]
authorZane Shelley <zshelle@us.ibm.com>Mon May 24 12:55:34 2021 -0500
committerZane Shelley <zshelle@us.ibm.com>Thu May 27 20:41:38 2021 -0500
treee309a97c8d6dc71a0ac06267c698cb495414d429
parent0a905012d0e90ea32ca651883413cd84b56804d1 [diff]
Separate building of chip data and parser data files

The PEL parser data files will eventually need to be put in a separate
location from the chip data binary files.

Signed-off-by: Zane Shelley <zshelle@us.ibm.com>
Change-Id: I83fabd1da51ba04cae0d1cee07b5a820675e98a2
2 files changed
tree: e309a97c8d6dc71a0ac06267c698cb495414d429
  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