Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 9d1a83942199280dfc556edf3db645c0d806aaae
commit9d1a83942199280dfc556edf3db645c0d806aaae[log] [tgz]
authorSunny Srivastava <sunnsr25@in.ibm.com>Tue Jan 21 22:05:10 2025 +0530
committerSunny Srivastava <sunnsr25@in.ibm.com>Wed Jan 22 17:54:06 2025 +0530
tree9a14313d395ab7be4a4bd5a83460471a154329ab
parentfa5e4d325ef9cea3c841fe89d202c340f92bd8c6 [diff]
Add tag for DIMMs and update back up Json

As DIMMs are not accessible for collection at runtime, it
should only be collected at chassis off state.
Hence marking DIMMs to be collected only at power off.

Also back up restore json link has been updated Json which
need a common set of keywords backed.
For now, other than everest all the rainier are made to point
to a common back up and restore Json.

Change-Id: I10b861136bc6a68c96223042a29a36a71ae480e5
Signed-off-by: Sunny Srivastava <sunnsr25@in.ibm.com>
6 files changed
tree: 9a14313d395ab7be4a4bd5a83460471a154329ab
  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.txt
  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.