Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / dd109cc073ba4e5e8aa58b45598058ec1ff307e3
commitdd109cc073ba4e5e8aa58b45598058ec1ff307e3[log] [tgz]
authorZane Shelley <zshelle@us.ibm.com>Thu Apr 30 21:41:41 2020 -0500
committerZane Shelley <zshelle@us.ibm.com>Mon May 04 21:42:08 2020 -0500
treec3e9573c3414565cfc8c21627ed3bac7f9be4f33
parentaadf3bff95bb6a0dd16b29b799aade59aaf5b485 [diff]
Removed the force init option from initialize()

The ability to keep track of all objects that are specific to a given
chip type is more complicated than what it is worth to support the
ability to reinitialize a single chip type. Instead, the user
application will need to uninitialize and reinitialize all needed
chip types.

In addition, the user application must ensure it does not try to
initialize the same chip type more than once to prevent memory bloat.

Change-Id: I8b33012553fe1bea75cdd319c53e7bd5bff91726
Signed-off-by: Zane Shelley <zshelle@us.ibm.com>
5 files changed
tree: c3e9573c3414565cfc8c21627ed3bac7f9be4f33
  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 and FSP environments only support up to C++11. 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.