Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / 119c3f79ecec0b3bf95d44eb217146771c5e5724
commit119c3f79ecec0b3bf95d44eb217146771c5e5724[log] [tgz]
authorMatt Spinler <spinler@us.ibm.com>Wed May 18 09:55:48 2022 -0500
committerMatt Spinler <spinler@us.ibm.com>Wed May 18 10:06:08 2022 -0500
tree883c79cd550c9b6cda9d821f30c7201a30d29942
parent88eb202418eb62faa93945f2d4aedb9ff3badf2d [diff]
setup.py: Fail on parse_chip_data_xml failures

It could fail if the right perl packages aren't installed.

Signed-off-by: Matt Spinler <spinler@us.ibm.com>
Change-Id: Icc4501e9d8b513a4cad4c197525fd99853ef7c19
1 file changed
tree: 883c79cd550c9b6cda9d821f30c7201a30d29942
  1. src/
  2. subprojects/
  3. test/
  4. xml/
  5. .clang-format
  6. .eslintignore
  7. .gitignore
  8. buildinfo.hpp.in
  9. LICENSE
  10. MAINTAINERS
  11. meson.build
  12. meson_options.txt
  13. OWNERS
  14. 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