Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / d507351381a58a0c663e9ef65e6a46c50ca55cc6
commitd507351381a58a0c663e9ef65e6a46c50ca55cc6[log] [tgz]
authorZane Shelley <zshelle@us.ibm.com>Thu Jan 14 12:51:18 2021 -0600
committerZane Shelley <zshelle@us.ibm.com>Thu Jan 14 12:53:26 2021 -0600
tree90e7ec39886970ea00df30b834db0b687992b95b
parentc888dff65c3ad38b2e52d25b6c01eef9f615093f [diff]
scope hei_includes.hpp for internal use

This file should not be included in any headers consumed by the user
application.

Signed-off-by: Zane Shelley <zshelle@us.ibm.com>
Change-Id: Ifc3ff2faa03b96c8a7ace2feb7132d74df24f5cc
9 files changed
tree: 90e7ec39886970ea00df30b834db0b687992b95b
  1. src/
  2. test/
  3. xml/
  4. .clang-format
  5. .gitignore
  6. LICENSE
  7. MAINTAINERS
  8. meson.build
  9. meson_options.txt
  10. 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