Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / df0a1e1eeb52c68d97c4b2e9b6e1929e7a89cfb3
commitdf0a1e1eeb52c68d97c4b2e9b6e1929e7a89cfb3[log] [tgz]
authorSantosh Puranik <santosh.puranik@in.ibm.com>Mon May 03 16:06:35 2021 +0530
committerSantosh Puranik <santosh.puranik@in.ibm.com>Mon May 03 16:47:25 2021 +0530
tree1427a6897857f18cebb827ebee6638ebac1b95ba
parent414d5aef4abee12e24547b8528745d159321f4ba [diff]
Correct assertion when restoring system VPD

The vpd parser would assert if it found a FRU entry
tagged as system VPD in the JSON, but did not find a
Motherboard tagged item on D-Bus corresponding to that
entry.

This check was done before attempting to restore system
VPD. This check is no longer valid if we need the chassis
object to inherit properties from the Motherboard.

To simplify this, this commit just changes that assertion
to an if clause.

Tested:
Tested with a JSON where the chassis inherits properties
from the motehrboard EEPROM and verified that we no longer
assert.

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