Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / dd453be997178ba042cc99b04fc32e23582eab9c
commitdd453be997178ba042cc99b04fc32e23582eab9c[log] [tgz]
authorSantosh Puranik <santosh.puranik@in.ibm.com>Wed Feb 10 21:45:25 2021 +0530
committerSantosh Puranik <santosh.puranik@in.ibm.com>Fri Feb 12 13:34:11 2021 +0000
treef2136309e9b80a473e057598753f81c270069d98
parent81671f6d52da047aa487d8e08c4435505e3fe61b [diff]
Fix Bad VPD Handling

This commit fixes two issues discovered with handling VPD that
cannot be parsed:

* If a parser object cannot be identified, return a VPDDataException
  and not a runtime_error.
* Fix a code bug which was causing us to run the parser twice.

Tested: Tested agsinst bad VPD data and verified that the right exception
is now thrown.

Signed-off-by: Santosh Puranik <santosh.puranik@in.ibm.com>
Change-Id: I5ed10519b26f16b69b4b8b3f8a6f1f4ef2fa3cdb
2 files changed
tree: f2136309e9b80a473e057598753f81c270069d98
  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. const.hpp
  12. defines.hpp
  13. extra-properties-example.yaml
  14. extra-properties.mako.hpp
  15. extra-properties.py
  16. ibm_vpd_app.cpp
  17. impl.cpp
  18. impl.hpp
  19. LICENSE
  20. MAINTAINERS
  21. meson.build
  22. meson_options.txt
  23. README.md
  24. store.hpp
  25. types.hpp
  26. utilInterface.hpp
  27. utils.cpp
  28. utils.hpp
  29. vpd_exceptions.hpp
  30. vpd_tool.cpp
  31. vpd_tool_impl.cpp
  32. vpd_tool_impl.hpp
  33. write.cpp
  34. write.hpp
  35. writefru.mako.hpp
  36. writefru.py
  37. 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.