Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / 2d2534f6259bdf86621bb0583087800a24953fe4
commit2d2534f6259bdf86621bb0583087800a24953fe4[log] [tgz]
authorZane Shelley <zshelle@us.ibm.com>Wed Dec 14 11:34:01 2022 -0600
committerZane Shelley <zshelle@us.ibm.com>Thu Dec 15 11:25:28 2022 -0600
tree210cc8a6c4022f8408306f3f7cbb616203bc5b9d
parentd5d236365f8e4f02f7621f17c8a02b6728d2178a [diff]
Add prettier RC file

This file is copied from openbmc-build-scripts:config/prettierrc.yaml,
which is the default for BMC CI. The presence of the RC file is so that
autoformat plugins/extensions will now if this project should be
formatted.

Change-Id: I31430dd26d7c2ddd2d46fa125e164d31b157982b
Signed-off-by: Zane Shelley <zshelle@us.ibm.com>
2 files changed
tree: 210cc8a6c4022f8408306f3f7cbb616203bc5b9d
  1. src/
  2. subprojects/
  3. test/
  4. xml/
  5. .clang-format
  6. .eslintignore
  7. .gitignore
  8. .prettierignore
  9. .prettierrc.yaml
  10. buildinfo.hpp.in
  11. LICENSE
  12. MAINTAINERS
  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