Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / b7005caf42c088f22b47d37892aa83d9e7f7ec68
commitb7005caf42c088f22b47d37892aa83d9e7f7ec68[log] [tgz]
authorZane Shelley <zshelle@us.ibm.com>Fri Mar 24 15:23:59 2023 -0500
committerZane Shelley <zshelle@us.ibm.com>Fri Mar 24 15:41:36 2023 -0500
tree0b0bfb3ce9bc6f2ae31aa352cf10a8617e8f9aae
parentb9ea93c5cb15b8fed0f44780f9b2a6a0ffe34f28 [diff]
Redefining the checkstop attention type

ATTN_TYPE_CHECKSTOP previously had been used to indicate the system
has checkstopped. However, in hardware it really means that the chip has
checkstopped. It just happens to be when processor chips checkstop, the
entire system will checkstop. This does not work for memory buffer chips
because a memory buffer could checkstop, but it is not guaranteed the
system will checkstop like it does for processor chips. With memory
mirroring and other redundancies, it is possible for a system to recover
from a memory buffer chip checkstop. I added a new ATTN_TYPE_CHIP_CS
enum with the same value as its predecessor. The old enum will
eventually be removed once user applications have been given the time to
do so.

Signed-off-by: Zane Shelley <zshelle@us.ibm.com>
Change-Id: I884317d25630513eec45fbb2313bd6a274a84876
6 files changed
tree: 0b0bfb3ce9bc6f2ae31aa352cf10a8617e8f9aae
  1. chip_data/
  2. src/
  3. subprojects/
  4. test/
  5. xml/
  6. .clang-format
  7. .eslintignore
  8. .gitignore
  9. .prettierignore
  10. .prettierrc.yaml
  11. buildinfo.hpp.in
  12. LICENSE
  13. MAINTAINERS
  14. meson.build
  15. meson_options.txt
  16. OWNERS
  17. 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