Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 9ce8de3bad526c45bd49d9c6258bf365025e7291
commit9ce8de3bad526c45bd49d9c6258bf365025e7291[log] [tgz]
authorSunny Srivastava <sunnsr25@in.ibm.com>Mon Apr 14 19:12:35 2025 +0530
committerSunnySrivastava <sunnsr25@in.ibm.com>Tue Apr 15 04:38:46 2025 +0000
tree6dbbb5486d46604336b4c35179a82de9a8952697
parentb7818d1fab88d058fe0928b94d4a5b2399ba2f1e [diff]
Add folder for documents

The commit adds folder "Docs" in the repository to store documentations
related to different feature, working, jsons used in the repository.

Change-Id: I60e147a9b90fb270fe33fad880ac2c2c5c750ade
Signed-off-by: Sunny Srivastava <sunnsr25@in.ibm.com>
2 files changed
tree: 6dbbb5486d46604336b4c35179a82de9a8952697
  1. configuration/
  2. docs/
  3. scripts/
  4. service_files/
  5. test/
  6. vpd-manager/
  7. vpd-tool/
  8. vpdecc/
  9. .clang-format
  10. .gitignore
  11. LICENSE
  12. meson.build
  13. meson.options
  14. OWNERS
  15. README.md
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.