Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 1bb8716b2df2c40a0a3f33d4bcffaf8a30f41438
commit1bb8716b2df2c40a0a3f33d4bcffaf8a30f41438[log] [tgz]
authorSunny Srivastava <sunnsr25@in.ibm.com>Tue Feb 13 00:09:09 2024 -0600
committerJinu Joy Thomas <jinu.joy.thomas@in.ibm.com>Wed Feb 14 13:08:03 2024 +0000
tree2abbe309bd22502adf80397eaa644df5db99302c
parentdf5a0eb1cdf8cb4ebd6977d488c9a8f4dd42dddd [diff]
Publish all EI while priming inventory

The change is to publish all the interfaces marked as extra interfaces
in config JSONs while priming the inventory.

The change was done so that code can pick up any interfac eadded under
extra interface without any change.

Test:
Inventory objects published all the interfaces listed under EI in the
JSON.

Change-Id: I6fedf5c98345faca864b1e1d8644f84b7dee7ae5
Signed-off-by: Sunny Srivastava <sunnsr25@in.ibm.com>
1 file changed
tree: 2abbe309bd22502adf80397eaa644df5db99302c
  1. config/
  2. examples/
  3. rules/
  4. scripts/
  5. service_files/
  6. subprojects/
  7. test/
  8. vpd-manager/
  9. vpd-parser/
  10. vpdecc/
  11. .clang-format
  12. .gitignore
  13. app.cpp
  14. args.cpp
  15. args.hpp
  16. common_utility.cpp
  17. common_utility.hpp
  18. const.hpp
  19. defines.hpp
  20. extra-properties-example.yaml
  21. extra-properties.mako.hpp
  22. extra-properties.py
  23. ibm_vpd_app.cpp
  24. ibm_vpd_utils.cpp
  25. ibm_vpd_utils.hpp
  26. impl.cpp
  27. impl.hpp
  28. LICENSE
  29. meson.build
  30. meson.options
  31. OWNERS
  32. README.md
  33. store.hpp
  34. types.hpp
  35. utilInterface.hpp
  36. vpd_exceptions.hpp
  37. vpd_tool.cpp
  38. vpd_tool_impl.cpp
  39. vpd_tool_impl.hpp
  40. write.cpp
  41. write.hpp
  42. writefru.mako.hpp
  43. writefru.py
  44. 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) tocf 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.