Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / refs/heads/master
commitbba4223af822970f36540c2ff33d8913f15f22e6[log] [tgz]
authorJayanth Othayoth <ojayanth@gmail.com>Wed Dec 31 08:09:40 2025 -0600
committerJayanth Othayoth <ojayanth@gmail.com>Wed Dec 31 08:28:29 2025 -0600
treec48aad579f4e6adb1f94da069cd99e4d1efdeb33
parente9aaf13e4daac6d139567781f6149ad0001f8eeb [diff]
clang-tidy: Initial commit

Added initial .clang-tidy configuration file with recommended C++ checks
aligned with the OpenBMC-approved checklist. This setup enforces modern
C++ best practices and helps catch common issues early in development.

Change-Id: I1ab2f8f0501025179dbb74713989a768c638f46c
Signed-off-by: Jayanth Othayoth <ojayanth@gmail.com>
1 file changed
tree: c48aad579f4e6adb1f94da069cd99e4d1efdeb33
  1. chip_data/
  2. src/
  3. subprojects/
  4. test/
  5. .clang-format
  6. .clang-tidy
  7. .eslintignore
  8. .gitignore
  9. .prettierignore
  10. .prettierrc.yaml
  11. buildinfo.hpp.in
  12. LICENSE
  13. meson.build
  14. meson.options
  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