Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / d5d236365f8e4f02f7621f17c8a02b6728d2178a
commitd5d236365f8e4f02f7621f17c8a02b6728d2178a[log] [tgz]
authorZane Shelley <zshelle@us.ibm.com>Tue Dec 13 09:34:31 2022 -0600
committerZane Shelley <zshelle@us.ibm.com>Tue Dec 13 15:34:38 2022 -0600
tree8bcbc5d45f25b438b91d7d5326585637a6b92bf5
parent79cfb64ab95351e76d10e1e404084adf12f63775 [diff]
Remove use of std::unique_ptr

The Hostboot user application has poor support for std::unique_ptr,
particularly using std::unique_ptr and std::map. Their implementation of
std::map does not have support for move-only objects like
std::unique_ptr. At this time it is much easier to change the current
use to std::shared_ptr. It is not as memory efficient, but will still
work. The memory impact is minimal since we only plan to used these
for each supported chip type, which we only have a few at this point.

Signed-off-by: Zane Shelley <zshelle@us.ibm.com>
Change-Id: Ibed3e72f6f2c52fc044a442a2893fb07a3fa5d73
2 files changed
tree: 8bcbc5d45f25b438b91d7d5326585637a6b92bf5
  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