Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / b9a8e762209bf43d13fac6955860df0642d815b3
commitb9a8e762209bf43d13fac6955860df0642d815b3[log] [tgz]
authorZane Shelley <zshelle@us.ibm.com>Mon May 11 21:41:32 2020 -0500
committerZane Shelley <zshelle@us.ibm.com>Thu May 14 18:49:04 2020 +0000
tree6a9f6cd2e41cfd10c91a2a997618044527a639e8
parent4caa043734b83f96a843139f61a621dffb9ef732 [diff]
Build HardwareRegister objects from Chip Data Files

Change-Id: I4fbcdd5ba012008000b8d1f324dd47d95ef2d932
Signed-off-by: Zane Shelley <zshelle@us.ibm.com>
5 files changed
tree: 6a9f6cd2e41cfd10c91a2a997618044527a639e8
  1. src/
  2. test/
  3. .clang-format
  4. .gitignore
  5. LICENSE
  6. MAINTAINERS
  7. meson.build
  8. meson_options.txt
  9. 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 setup -Dtests=disabled <build_dir>
ninja -C <build_dir>
ninja -C <build_dir> install

For a test / debug build, a typical configuration is:

meson setup -Dtests=enabled <build_dir>
meson test -C <build_dir>