Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 83a1d5dec47b78b82f5997a18c7779f1b24e96db
commit83a1d5dec47b78b82f5997a18c7779f1b24e96db[log] [tgz]
authorPriyangaRamasamy <priyanga24@in.ibm.com>Thu Apr 30 19:15:43 2020 +0530
committerSantosh Puranik <santosh.puranik@in.ibm.com>Sun Nov 01 00:00:21 2020 +0530
tree6538e57cfb63e1688e686f68ec16a83cf81b8e2d
parent8e140a1c8076adf45e8dd975a8c6e4bcfc6ea578 [diff]
IBM VPD Parser support for both 2U & 4U system

Based on motherboard IM keyword the type of the system is identified
and the corresponding json is linked at the runtime.

Currently 2U system has support for single dasd-backplane
whereas 4U system has support for more than one dasd-backplanes.

Tested on simics.

Change-Id: Ia3eb48661fe565f6286c079a8f87736bb136210a
Signed-off-by: Priyanga Ramasamy <priyanga24@in.ibm.com>
4 files changed
tree: 6538e57cfb63e1688e686f68ec16a83cf81b8e2d
  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. 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. meson.build
  26. meson_options.txt
  27. parser.cpp
  28. parser.hpp
  29. README.md
  30. store.hpp
  31. types.hpp
  32. utilInterface.hpp
  33. utils.cpp
  34. utils.hpp
  35. vpd_tool.cpp
  36. vpd_tool_impl.cpp
  37. vpd_tool_impl.hpp
  38. write.cpp
  39. write.hpp
  40. writefru.mako.hpp
  41. writefru.py
  42. 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.