Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / 3b2760b2a61b29ad70bf6b222973b992b495fdbf
commit3b2760b2a61b29ad70bf6b222973b992b495fdbf[log] [tgz]
authorCaleb Palmer <cnpalmer@us.ibm.com>Wed Mar 08 15:01:33 2023 -0600
committerCaleb Palmer <cnpalmer@us.ibm.com>Thu Mar 09 17:28:33 2023 -0600
tree34426da70d6643a72f8a61f12fa2160ee7919fc8
parent2d2534f6259bdf86621bb0583087800a24953fe4 [diff]
Add chip_config meson build option

There will not be a need to build all chip data
files in every release so this option is being
added to allow for more control over what is built.

Change-Id: I059640525f6826d67c406fe4a25bcec301582d6e
Signed-off-by: Caleb Palmer <cnpalmer@us.ibm.com>
2 files changed
tree: 34426da70d6643a72f8a61f12fa2160ee7919fc8
  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