Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 73b589b85ec6194853f1474b76e62623468debdb
commit73b589b85ec6194853f1474b76e62623468debdb[log] [tgz]
authorSantosh Puranik <santosh.puranik@in.ibm.com>Tue May 19 18:02:49 2020 +0530
committerSantosh Puranik <santosh.puranik@in.ibm.com>Tue May 19 21:44:14 2020 +0530
treea3365c60ba0bd11d581b0407fb377a059e52e2ed
parent26a74af71e6123b965ca1d9666791bfe4b87bc8b [diff]
Add README and Update MAINTAINERS

Added a README that provides an overview of the VPD parsers
that this repository hosts.

Proposing Jinu and myself as maintainers.

Signed-off-by: Santosh Puranik <santosh.puranik@in.ibm.com>
Change-Id: If7b65bd5948994cf3edddfdc61b11d07b01c0eca
2 files changed
tree: a3365c60ba0bd11d581b0407fb377a059e52e2ed
  1. examples/
  2. test/
  3. .clang-format
  4. .gitignore
  5. app.cpp
  6. args.cpp
  7. args.hpp
  8. bootstrap.sh
  9. configure.ac
  10. defines.hpp
  11. extra-properties-example.yaml
  12. extra-properties.mako.hpp
  13. extra-properties.py
  14. impl.cpp
  15. impl.hpp
  16. ipz_app.cpp
  17. LICENSE
  18. MAINTAINERS
  19. Makefile.am
  20. parser.cpp
  21. parser.hpp
  22. README.md
  23. store.hpp
  24. types.hpp
  25. utils.cpp
  26. utils.hpp
  27. write.cpp
  28. write.hpp
  29. writefru.mako.hpp
  30. writefru.py
  31. 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.