Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 6a1bd39b2aae6e97b6d804a2f71667cd9aee4532
commit6a1bd39b2aae6e97b6d804a2f71667cd9aee4532[log] [tgz]
authorSunny Srivastava <sunnsr25@in.ibm.com>Wed Jun 02 04:39:24 2021 -0500
committerSantosh Puranik <santosh.puranik@in.ibm.com>Fri Dec 16 10:54:32 2022 +0530
tree7b0aa826724295304b82c29dfe7c0d0d3a2bc3df
parent28abd6e43576cdf62681544cc5da69aa7fe09de9 [diff]
Single FRU VPD collection

This commit implements a Dbus Api to collect VPD of a given FRU
by launching the parser exe asynchronously.

The caller is supposed to update Present property for that FRU
as false on Dbus before calling this Api and need to listen for
Present property change signal to mark the collection of VPD
complete for the FRU.

One of the use case for this api is to collect VPD for FRU
undergoing concurrent maintenance.

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