Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 9d4f11290013e8204365d6d2a60706326a882756
commit9d4f11290013e8204365d6d2a60706326a882756[log] [tgz]
authorSunnySrivastava1984 <sunnsr25@in.ibm.com>Wed Aug 26 02:41:46 2020 -0500
committerSunnySrivastava1984 <sunnsr25@in.ibm.com>Mon Nov 23 08:55:15 2020 -0600
tree71b4e4010c3b88e0c30eae3fd045a3ef8467cd90
parent9d149345b92074c07e7dfc2432cbbd020ccd79d9 [diff]
Custom Exception type for openpower-vpd-parser.

This commit implements custom exception type for openpower-vpd-parser
repo.
With this runtime exceptions can be classified into categories and
appropriate actions can be taken based on their type.

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