Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / 5ec8810e76bb15ae7f18aaa948a0a97ba9f6b805
commit5ec8810e76bb15ae7f18aaa948a0a97ba9f6b805[log] [tgz]
authorZane Shelley <zshelle@us.ibm.com>Mon May 11 21:08:25 2020 -0500
committerZane Shelley <zshelle@us.ibm.com>Wed May 13 21:23:54 2020 +0000
tree312663478c2ddf0e4b3e7ec475ee2ee3aa5f4f9b
parent7667b719704b1a8143e6843578a491730491ab58 [diff]
Removed ChipType_t dependency in HardwareRegister

This dependency defeated the purpose of the flyweights because a
register that does not differ between chip model/EC would end up having
an instance for each model/EC. The explodes the memory used for these
objects.

This does expose a problem where someone may try to access a register
that does not exist for a specific chip type. However, they should be
getting the register objects from the IsolationChip class for the
specific chip type anyway. Therefore, the exposure is minimal compared
to the memory savings.

Change-Id: I926a71ea180fca7e39572ffe17d9f64e35395e53
Signed-off-by: Zane Shelley <zshelle@us.ibm.com>
3 files changed
tree: 312663478c2ddf0e4b3e7ec475ee2ee3aa5f4f9b
  1. src/
  2. test/
  3. .clang-format
  4. .gitignore
  5. LICENSE
  6. MAINTAINERS
  7. meson.build
  8. meson_options.txt
  9. 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 setup -Dtests=disabled <build_dir>
ninja -C <build_dir>
ninja -C <build_dir> install

For a test / debug build, a typical configuration is:

meson setup -Dtests=enabled <build_dir>
meson test -C <build_dir>