Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 50f60bf835979289c9404c575feef639154d7b6f
commit50f60bf835979289c9404c575feef639154d7b6f[log] [tgz]
authorSantosh Puranik <santosh.puranik@in.ibm.com>Wed May 26 17:55:06 2021 +0530
committerSantosh Puranik <santosh.puranik@in.ibm.com>Fri May 28 05:33:20 2021 +0000
tree6816bf65d7b084616fc9ad2433b138e54a25b355
parent6fb0ef90a5ad4522e674a0022f7cf88ad0fa3258 [diff]
Do not query JSON to determine system VPD

This commit removes the dependency on the VPD JSON to
determine if an inventory items is to be classified as
belonging to "system" VPD. The prior code would use the
"isSystemVpd" key from the JSON to determine this, but this
leads to inconsistencies where some sub-items may not have
this flag set. The net result being, it would cause us
to skip certain actions such as resetting GPIOs/setting the
right udev environment variable when collecting system VPD.

By using the system VPD eeprom path - which is the same for
all IBM systems, we get rid of the JSON dependency.

Tested: I ran with this fix and verified that the udev environment
variable check/set if properly performed now, as is priming the
inventory when we collect system VPD.

Signed-off-by: Santosh Puranik <santosh.puranik@in.ibm.com>
Change-Id: I7d6f8b108fa9bb131760a8fde7d6264fea67b627
1 file changed
tree: 6816bf65d7b084616fc9ad2433b138e54a25b355
  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.