Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 84c3d23f9bf584a8363d55b1e300b3e7f9fb352c
commit84c3d23f9bf584a8363d55b1e300b3e7f9fb352c[log] [tgz]
authorSunny Srivastava <sunnsr25@in.ibm.com>Wed Sep 03 00:47:10 2025 -0500
committerJinu Joy Thomas <jinu.joy.thomas@in.ibm.com>Wed Sep 03 14:58:46 2025 +0000
treebbd4a2328644206505ae3650b3599b1ec779a39b
parent8f08f5ac9fff03045be817b723cf29f781e1e628 [diff]
Error code handling in processing specific tags

The change implements error code to handle failure while processing some
of the JSON tags.
Going forward, error code will be used by the caller to identify the
type of failure that occurred while processing the tags  and based
on that appropriate action will be taken.

Change-Id: I95783836d8829f0d50459a26da37a2e4e21638f5
Signed-off-by: Sunny Srivastava <sunnsr25@in.ibm.com>
3 files changed
tree: bbd4a2328644206505ae3650b3599b1ec779a39b
  1. configuration/
  2. docs/
  3. service_files/
  4. test/
  5. vpd-manager/
  6. vpd-tool/
  7. vpdecc/
  8. wait-vpd-parser/
  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 at a broken link.

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.