Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / 53d15e1ea927c5ee93fc8ca6eac6124a9e499b30
commit53d15e1ea927c5ee93fc8ca6eac6124a9e499b30[log] [tgz]
authorZane Shelley <zshelle@us.ibm.com>Thu Apr 06 17:08:26 2023 -0500
committerZane Shelley <zshelle@us.ibm.com>Tue Apr 11 18:36:39 2023 +0000
treebfe831799ea17ff1ebae1f2a6340cb8c47fbe89d
parent68a2e82a9a80b87e4973011b7fbec6b3483f33a4 [diff]
Remove queryCheckstop() function

This function was intended to be used to query if a system checkstop
attention was detected. The query can only check for chip checkstops,
but not all chip checkstops are system checkstops and this project is
agnostic to chip type specifics. So, this query could give invalid
results if a signature was from a chip that would not directly result in
a system checkstop.

Signed-off-by: Zane Shelley <zshelle@us.ibm.com>
Change-Id: I82b7a5d7d9e0ad9164b8974edd122f60d6f53606
1 file changed
tree: bfe831799ea17ff1ebae1f2a6340cb8c47fbe89d
  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. meson.build
  14. meson_options.txt
  15. OWNERS
  16. 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