Backup & restore changes for bonnell's system VPD

This commit implements the changes of system backplane VPD backup on
the base banel VPD and restoring it from the base panel VPD

The bonnell BMC is embedded in the system backplane, so if either fails,
the backplane should be replaced as a whole. So the changes have been
made to backup the system backplane critical keywords on the operator
panel base EEPROM under the VSBK record.

Test:
Case 1: A PEL with error severity is created when the base
panel EEPROM file doesn't exist.

Case 2: A PEL with error severity is created when the base
panel VPD has ecc exceptions.

Case 3: A PEL with error severity is created when the base
panel EEPROM doesn't contain VSBK record.

Case 4: System VPD's critical keywords are backing up in the base panel
VPD

Case 5: System VPD's critical keywords are restoring from the base panel
VPD

Case 6: The VSBK record creation and population of properties on dbus

Case 7: A PEL with warning serverity is created when there is a
mismatch between system VPD & base panel keyword values.

Case 8: A PEL with error serverity is created when both the system VPD
& base panel keyword values are default.

Tests above works as expected.

Change-Id: Ieea6ff4e267518f010c924e2d51a2b080b47e91c
Signed-off-by: Kantesh Nagaradder <kantesh.nagaradder@ibm.com>
6 files changed
tree: 3ef6a98b4d8e5b1646730968f5c180a7925b2ecb
  1. examples/
  2. ibm_vpd/
  3. subprojects/
  4. test/
  5. vpd-manager/
  6. vpd-parser/
  7. vpdecc/
  8. .clang-format
  9. .gitignore
  10. app.cpp
  11. args.cpp
  12. args.hpp
  13. common_utility.cpp
  14. common_utility.hpp
  15. const.hpp
  16. defines.hpp
  17. extra-properties-example.yaml
  18. extra-properties.mako.hpp
  19. extra-properties.py
  20. ibm_vpd_app.cpp
  21. ibm_vpd_utils.cpp
  22. ibm_vpd_utils.hpp
  23. impl.cpp
  24. impl.hpp
  25. LICENSE
  26. meson.build
  27. meson_options.txt
  28. OWNERS
  29. README.md
  30. store.hpp
  31. types.hpp
  32. utilInterface.hpp
  33. vpd_exceptions.hpp
  34. vpd_tool.cpp
  35. vpd_tool_impl.cpp
  36. vpd_tool_impl.hpp
  37. write.cpp
  38. write.hpp
  39. writefru.mako.hpp
  40. writefru.py
  41. writefru.yaml
README.md

Overview

This repository hosts code for OpenPower and IBM IPZ format VPD parsers. Both OpenPower VPD and IPZ VPD formats are structured binaries that consist of records and keywords. A record is a collection of multiple keywords. More information about the format can be found here.

The repository consists of two distinct applications, which are:

OpenPower VPD Parser

This is a build-time YAML driven application that parses the OpenPower VPD format and uses the YAML configuration (see extra-properties-example.yaml and writefru.yaml) to determine:

  • The supported records and keywords.
  • How VPD data is translated into D-Bus interfaces and properties.

The application instance must be passed in the file path to the VPD (this can, for example, be a sysfs path exposed by the EEPROM device driver) and also the D-Bus object path(s) that EEPROM data needs to be published under.

IBM VPD Parser

This parser is can be built by passing in the --enable-ibm-parser configure option. This parser differs from the OpenPower VPD parser in the following ways:

  • It parses all the records and keywords from the VPD, including large keywords (Keywords that begin with a # and are > 255 bytes in length).
  • It relies on a runtime JSON configuration (see examples/inventory.json) to determine the D-Bus object path(s) that hold interfaces and properties representing the VPD for a given VPD file path.

Making the application runtime JSON driven allows us to support multiple systems (with different FRU configurations) to be supported in a single code image as well as making the application more flexible for future improvements.

TODOs and Future Improvements

  1. The long-term goal is to completely do away with the build time YAML driven configurations and instead reconcile the OpenPower VPD parser and the IBM VPD parser applications into a single runtime JSON driven application.
  2. Add details to the README on how to configure and build the application.
  3. More JSON documentation.
  4. Support for more IBM VPD formats.
  5. VPD Write and tool documentation.