Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / 925c3edccffa1a8d9baeb806da56a8709e57f705
commit925c3edccffa1a8d9baeb806da56a8709e57f705[log] [tgz]
authorZane Shelley <zshelle@us.ibm.com>Fri Apr 14 13:42:22 2023 -0500
committerZane Shelley <zshelle@us.ibm.com>Fri Apr 14 14:47:26 2023 -0500
tree386bc4dbb7cc819711dd783c8543df04bb7d7a91
parenta8658733bc6ab33cc949829f92162a09057f18d9 [diff]
Rename chip data attention types to be more descriptive

Instead of CS, UCS, RE, SPA, and HA, using CHIP_CS, UNIT_CS, RECOV,
SP_ATTN, and HOST_ATTN. This is mostly in an effort to clarify a chip
checkstop is not necessarily a system checkstop. Notice that I didn't
change any of the register names for P10 or Explorer. This is to prevent
the inevitable code level mismatches between drivers and the peltool
parsers used to parse field data.

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