Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-libhei / 21a2354c80b70153e875d74e0a8ccfcbe398484a
commit21a2354c80b70153e875d74e0a8ccfcbe398484a[log] [tgz]
authorMatt Spinler <spinler@us.ibm.com>Thu May 19 14:38:33 2022 -0500
committerZane Shelley <zshelle@us.ibm.com>Tue May 31 16:21:03 2022 +0000
tree4376e19eedd3b6eff1aaf215a8e4c61668407379
parent1252846796f4ca677e026b1681abe5b5a718639f [diff]
setup.py: Check for version in env var

In order to allow the python package to have incrementing versions
without having to change the version manually every time the code
changes, check for the version to use in a PELTOOL_VERSION environment
variable.  If it isn't present, just use a default version of 1.0.

The plan is that build tools will call setup.py with the env var set to
a version based on the tag of the openbmc build they are being pulled
into.  This has the added bonus that it allows people to know which BMC
code level the tool matches up with.

Signed-off-by: Matt Spinler <spinler@us.ibm.com>
Change-Id: Ia736d9ff2029b120235d3ef57d561ba43e75fe2a
1 file changed
tree: 4376e19eedd3b6eff1aaf215a8e4c61668407379
  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