Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / c6e7ea925e1d8e1322a9820498532bdd3679c42f
commitc6e7ea925e1d8e1322a9820498532bdd3679c42f[log] [tgz]
authorSunny Srivastava <55740008+SunnySrivastava1984@users.noreply.github.com>Fri Nov 03 21:10:43 2023 +0530
committerSunnySrivastava <sunnsr25@in.ibm.com>Thu Jan 04 05:53:13 2024 +0000
treee8e4180ccc3471482b54134fe2a5bbb3a9e79214
parente2b0383a10c8e9511ebd443737cbeb0b8f065f5b [diff]
Clear inventory data on removal

In case any FRU is removed from the system, the data w.r.t the
FRU, as it is persisted continues to stay on DBus. This sometimes
can be mis-leading as data is displayed for FRU which is actually
not present in the system.

The commit, in case the FRU is removed via delete FRU procedure,
clears all the VPD related data for the FRU and update its
present and functional status.

Test:
Delete any FRU using "deleteFRUVPD" exposed via VPD-Manager,
check the DBus, data related to VPD should be cleared.

Change-Id: Ic61e9a9934333ef9558ac4294a1935575042cb11
Signed-off-by: Anupama B R <anupama.b.r1@ibm.com>
5 files changed
tree: e8e4180ccc3471482b54134fe2a5bbb3a9e79214
  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
  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.