Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 124ae6c58fbcde082c6b12e58b6e93454cb2b145
commit124ae6c58fbcde082c6b12e58b6e93454cb2b145[log] [tgz]
authorPriyanga Ramasamy <priyanga24@in.ibm.com>Tue Oct 18 12:46:14 2022 -0500
committerJinu Joy Thomas <jinu.joy.thomas@in.ibm.com>Fri Jan 13 04:29:13 2023 +0000
tree233764b5beda235eff893d7ec081c97bcd136ce8
parent6d5e734d1b4c0872d780a084df421aae94f7ff8b [diff]
vpd-tool --mfgClean implementation

vpd-tool supports a new option --mfgClean, which cleans specific
keywords in system backplane VPD and restore it with their default
value.

This option will be used to ensure that the VPD is properly defaulted
in the FRU stock.

The FAB test will make use this option to reset system
backplane VPD keywords to its defaults.

vpd-tool --mfgClean --yes

====================
Test:

./vpd-tool --mfgClean

This option resets some of the critical keywords in System Backplane VPD
to its default value. Do you really wish to proceed further?[yes/no]: yes

 The critical keywords from system backplane VPD has been reset successfully.

./vpd-tool --mfgClean --yes

 The critical keywords from system backplane VPD has been reset successfully.

Verified that the critical keywords have been reset to defaults.

Signed-off-by: Priyanga Ramasamy <priyanga24@in.ibm.com>
Change-Id: Ia53498d222f2828d07a7d170291e641b7f69f9ac
4 files changed
tree: 233764b5beda235eff893d7ec081c97bcd136ce8
  1. examples/
  2. ibm_vpd/
  3. subprojects/
  4. test/
  5. vpd-manager/
  6. vpd-parser/
  7. vpdecc/
  8. .clang-format
  9. .gitignore
  10. app.cpp
  11. args.cpp
  12. args.hpp
  13. common_utility.cpp
  14. common_utility.hpp
  15. const.hpp
  16. defines.hpp
  17. extra-properties-example.yaml
  18. extra-properties.mako.hpp
  19. extra-properties.py
  20. ibm_vpd_app.cpp
  21. ibm_vpd_utils.cpp
  22. ibm_vpd_utils.hpp
  23. impl.cpp
  24. impl.hpp
  25. LICENSE
  26. meson.build
  27. meson_options.txt
  28. OWNERS
  29. README.md
  30. store.hpp
  31. types.hpp
  32. utilInterface.hpp
  33. vpd_exceptions.hpp
  34. vpd_tool.cpp
  35. vpd_tool_impl.cpp
  36. vpd_tool_impl.hpp
  37. write.cpp
  38. write.hpp
  39. writefru.mako.hpp
  40. writefru.py
  41. 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.