Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 2ee8a21910258b4bba1731e79f2df3a336f4e38e
commit2ee8a21910258b4bba1731e79f2df3a336f4e38e[log] [tgz]
authorSouvik Roy <souvikroyofficial10@gmail.com>Thu Apr 24 02:37:59 2025 -0500
committerSouvik Roy <souvikroyofficial10@gmail.com>Wed Apr 30 08:20:54 2025 -0500
tree1ef9a6e8dc5920046f67711009c8316840d4bcb0
parent50731e434cf1ca691d336aa2202311ba76f2a03b [diff]
Sync keyword update to inherited FRUs

This commit syncs keyword update to all inherited FRUs.
When a keyword value is updated either from vpd-tool or from vpd-manager
WriteKeyword API, the keyword update should also be synced to all
inherited FRUs on PIM to prevent mismatch.

Test:
```
Tested on a rainier 2s2u simics setup.

1. Ensure BMC is in Ready state
2. Read VINI PN of /system/chassis/motherboard using vpd-tool
3. Update VINI PN of /system/chassis/motherboard using vpd-tool
4. Once vpd-tool returns success, read VINI PN of inherited FRUs
   /system/chassis and /system/chassis/motherboard/tod_battery
5. VINI PN value should be same on the inherited FRUs.
```

Change-Id: Iff7340a111722f9e5336c0c846a79ffec8bbb8db
Signed-off-by: Souvik Roy <souvikroyofficial10@gmail.com>
2 files changed
tree: 1ef9a6e8dc5920046f67711009c8316840d4bcb0
  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 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.