Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 42914f4b9b2fae3c9f882b7d590c36bb4164e20f
commit42914f4b9b2fae3c9f882b7d590c36bb4164e20f[log] [tgz]
authorAnupama B R <anupama.b.r1@ibm.com>Fri Apr 04 01:29:54 2025 -0500
committerJinu Joy Thomas <jinu.joy.thomas@in.ibm.com>Mon Apr 07 09:56:26 2025 +0000
tree05a41caf977bf170944df5f0fb31c6dd4b87de22
parent1334be3683d66bccd34de8f3d11f52184bcae82f [diff]
Updating help for vpd-tool

This commit updates the vpd-tool help section for ‘--file’ and for
‘-w’(write keyword) option to provide more information to the user.

Change-Id: I0c2f922a75219339775a6f18188ba8b13a783df5
Signed-off-by: Anupama B R <anupama.b.r1@ibm.com>
1 file changed
tree: 05a41caf977bf170944df5f0fb31c6dd4b87de22
  1. configuration/
  2. scripts/
  3. service_files/
  4. test/
  5. vpd-manager/
  6. vpd-tool/
  7. vpdecc/
  8. .clang-format
  9. .gitignore
  10. LICENSE
  11. meson.build
  12. meson.options
  13. OWNERS
  14. 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.