Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 945a02d3dfb05cff83f01863ce1157502f43dbad
commit945a02d3dfb05cff83f01863ce1157502f43dbad[log] [tgz]
authorSunnySrivastava1984 <sunnsr25@in.ibm.com>Wed May 06 01:55:41 2020 -0500
committerSantosh Puranik <santosh.puranik@in.ibm.com>Sun Nov 01 17:27:55 2020 +0530
tree8f1d225caaa15d0b9eb701bfa6780f0d31ea335c
parent8ea3f6d0f56650565ddea3ef36b0f31d2c1bb591 [diff]
Code refactoring

Moved all the constants to const.hpp and utility method to
utils.cpp/hpp.
Removed file ibm_vpd_type_check.cpp/hpp and keyword_vpd_types.hpp.

Signed-off-by: SunnySrivastava1984 <sunnsr25@in.ibm.com>
Change-Id: Ie7b54e6fd03a499fab7c3124e17292c6d525e471
12 files changed
tree: 8f1d225caaa15d0b9eb701bfa6780f0d31ea335c
  1. examples/
  2. test/
  3. vpd-manager/
  4. vpdecc/
  5. .clang-format
  6. .gitignore
  7. app.cpp
  8. args.cpp
  9. args.hpp
  10. const.hpp
  11. defines.hpp
  12. extra-properties-example.yaml
  13. extra-properties.mako.hpp
  14. extra-properties.py
  15. ibm_vpd_app.cpp
  16. impl.cpp
  17. impl.hpp
  18. keyword_vpd_parser.cpp
  19. keyword_vpd_parser.hpp
  20. LICENSE
  21. MAINTAINERS
  22. meson.build
  23. meson_options.txt
  24. parser.cpp
  25. parser.hpp
  26. README.md
  27. store.hpp
  28. types.hpp
  29. utilInterface.hpp
  30. utils.cpp
  31. utils.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.