Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / 032bf9eca140e5c6302a7c05e368b92e8172cc5b
commit032bf9eca140e5c6302a7c05e368b92e8172cc5b[log] [tgz]
authorBen Tyner <ben.tyner@ibm.com>Wed May 06 21:27:54 2020 -0500
committerZane Shelley <zshelle@us.ibm.com>Fri May 08 18:42:56 2020 +0000
tree1b9f065ab951e6c53be8583129adca91f9921e2f
parent83a8d55dda5baa6da3381d62e90d49ae8f7d6715 [diff]
Build openpower-libhei as a static library

Build a static library that can be linked to by other applications.

Signed-off-by: Ben Tyner <ben.tyner@ibm.com>
Change-Id: I4dec91928381712674e6621792830f811c44c30d
15 files changed
tree: 1b9f065ab951e6c53be8583129adca91f9921e2f
  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 is intended to be integrated into containing user applications as a set of source files (either imported, or as a git subtree/submodule).

Details TBD.

User Application Requirements and APIs

  • The method to access hardware register data will vary per user application. Therefore, this library will declare the hardware access user APIs, but each containing 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. Specifically, FSP and Hostboot firmware utilize specialized macros as a mechanism to save code image space. Therefore, the user application will need to provide a specific header file that defines these macros. Details are in the common includes header.
  • Methods to assert programming bugs will vary per user application. Therefore, much like tracing, the user application will need to provide a specific header file that defines macros for assertion. Details are included in the common includes header.

Environment configuration

  • __HEI_READ_ONLY: When defined, it will ensure any hardware write support is disabled. 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 support 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.