Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 42ca494b7cb724aba0d88d04c382b8f6744621ae
commit42ca494b7cb724aba0d88d04c382b8f6744621ae[log] [tgz]
authorAnupama B R <anupama.b.r1@ibm.com>Wed Feb 12 00:13:33 2025 -0600
committerSunnySrivastava <sunnsr25@in.ibm.com>Mon Feb 17 14:26:27 2025 +0000
tree5d55bd60bbd16b3eecf19fae45d45b4047a4cf08
parentdf9e554f24b31d5f9048ba8c1610c3cdb36cdac6 [diff]
vpd-tool: handle error code

This commit handles error code for write keyword command, as the
std::error_code should be checked only when filesystem::exists call
returns with false.

Change-Id: If90170f32a8e8798ba88b932da479dc3609afd22
Signed-off-by: Anupama B R <anupama.b.r1@ibm.com>
1 file changed
tree: 5d55bd60bbd16b3eecf19fae45d45b4047a4cf08
  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.