Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / de3c60de2dd55f8f5038b804723983dbb46bade6
commitde3c60de2dd55f8f5038b804723983dbb46bade6[log] [tgz]
authorSunnySrivastava1984 <sunnsr25@in.ibm.com>Mon Feb 03 10:34:33 2020 -0600
committerSunnySrivastava1984 <sunnsr25@in.ibm.com>Mon Jun 22 01:45:33 2020 -0500
treeab33f9fc1112cb565269ade20f4b8ec121c412bc
parentb59fd09e6e91b8563b38777ef565e365b537dbe2 [diff]
JSON parser for VPD manager app

This commit implements a parser which parse and store vpd JSON at the
launch of the application.
An applicatin specific parser is required to support write keyword
functionality as reverse mapping of JSON items is required.
In this case the user passes an invetory path and EEPROM VPD for that
inventory path needs to be extracted.

Signed-off-by: Sunny Srivastava <sunnsr25@in.ibm.com>
Change-Id: I7f91b45982c59dfb0d36fe8e80ebd7373a93f147
4 files changed
tree: ab33f9fc1112cb565269ade20f4b8ec121c412bc
  1. examples/
  2. test/
  3. vpd-manager/
  4. vpdecc/
  5. .clang-format
  6. .gitignore
  7. app.cpp
  8. args.cpp
  9. args.hpp
  10. bootstrap.sh
  11. configure.ac
  12. defines.hpp
  13. extra-properties-example.yaml
  14. extra-properties.mako.hpp
  15. extra-properties.py
  16. ibm_vpd_app.cpp
  17. ibm_vpd_type_check.cpp
  18. ibm_vpd_type_check.hpp
  19. impl.cpp
  20. impl.hpp
  21. keyword_vpd_parser.cpp
  22. keyword_vpd_parser.hpp
  23. keyword_vpd_types.hpp
  24. LICENSE
  25. MAINTAINERS
  26. Makefile.am
  27. meson.build
  28. meson_options.txt
  29. parser.cpp
  30. parser.hpp
  31. README.md
  32. store.hpp
  33. types.hpp
  34. utils.cpp
  35. utils.hpp
  36. vpd_tool.cpp
  37. vpd_tool_impl.cpp
  38. vpd_tool_impl.hpp
  39. write.cpp
  40. write.hpp
  41. writefru.mako.hpp
  42. writefru.py
  43. 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.