Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / abb87eda2a79b2c371e3b329c3c911838e6e84c8
commitabb87eda2a79b2c371e3b329c3c911838e6e84c8[log] [tgz]
authorPriyangaRamasamy <priyanga24@in.ibm.com>Tue Nov 19 17:25:35 2019 +0530
committerPriyanga Ramasamy <priyanga24@in.ibm.com>Fri Jun 19 19:24:59 2020 +0530
tree677bc69f7b106ddc0712eb17b83f1cae1ecf1f97
parentc0aeac39da9efc460ca1c8a6e42f0a12234e306a [diff]
IBM VPD main app & KeywordVPD parser:

IBM VPD main application triggers either
'IPZ/Keyword' type VPD parser. This commit also has
keyword VPD parser code.

Flag to enable IBM VPD main parser is
"--enable-ibm-parser"
Flag to debug the keyword vpd parser is
"--enable-debug-kw-vpd".

Steps to build and execute:
 ./bootstrap.sh
 ./configure ${CONFIGURE_FLAGS} --enable-ibm-parser
 make
To run test cases:
 make check

Test:
Tested on a rainier system to parse
[IPZ and Keyword] types of VPD.

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