Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 5e3ff854ef28012f719d6a62403716a52de949a3
commit5e3ff854ef28012f719d6a62403716a52de949a3[log] [tgz]
authorRekha Aparna <vrekhaaparna@ibm.com>Tue Aug 12 10:51:23 2025 -0500
committerSunnySrivastava <sunnsr25@in.ibm.com>Mon Aug 25 06:44:05 2025 +0000
treee49a7841cde21eb4873a420fc2bc73bcb4f40cd7
parent01285ad2d822b2f1fe17393ce01751128df915de [diff]
Define error codes for json_utility API's

This commit defines error codes for the errors that can be thrown by
json_utility APIs.

Change-Id: If783c6389d14fcba45662facfc98574643d7fe5c
Signed-off-by: Rekha Aparna <vrekhaaparna@ibm.com>
1 file changed
tree: e49a7841cde21eb4873a420fc2bc73bcb4f40cd7
  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 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.