Backup or restore keyword implementation

This commits implements backup or restore keyword’s value on the
system. Conditions for updating the value,
* System’s primary and backup VPD’s should be on the hardware.
* Record and keyword should be found in the backup and restore config
JSON.

Backup or restore keyword’s value is triggered based on the following,
* Backup - While updating VPD on the primary path, VPD on backup path
gets updated.
* Restore - While updating VPD on the backup path, VPD on primary path
gets updated.

Output:
```
Before updating keyword’s value:
vpd-tool -O /sys/bus/i2c/drivers/at24/7-0050/eeprom -R VSBK -K BR -r -H; vpd-tool -O /system/chassis/motherboard/base_op_panel_blyth -R VSBK -K BR -r; vpd-tool -O /sys/bus/i2c/drivers/at24/8-0050/eeprom -R VSYS -K BR -r -H; vpd-tool -O /system/chassis/motherboard -R VSYS -K BR -r

{
    "/sys/bus/i2c/drivers/at24/7-0050/eeprom": {
        "BR": "S0"
    }
}
{
    "/system/chassis/motherboard/base_op_panel_blyth": {
        "BR": "S0"
    }
}

{
    "/sys/bus/i2c/drivers/at24/8-0050/eeprom": {
        "BR": "S0"
    }
}
{
    "/system/chassis/motherboard": {
        "BR": "S0"
    }
}

Update keyword’s value:
root@bonn026bmc:~# vpd-tool -O /system/chassis/motherboard -R VSYS -K BR -w -V 89
Data updated successfully

After updating keyword’s value:
root@bonn026bmc:~# vpd-tool -O /sys/bus/i2c/drivers/at24/7-0050/eeprom -R VSBK -K BR -r -H; vpd-tool -O /system/chassis/motherboard/base_op_panel_blyth -R VSBK -K BR -r; vpd-tool -O /sys/bus/i2c/drivers/at24/8-0050/eeprom -R VSYS -K BR -r -H; vpd-tool -O /system/chassis/motherboard -R VSYS -K BR -r
{
    "/sys/bus/i2c/drivers/at24/7-0050/eeprom": {
        "BR": "89"
    }
}
{
    "/system/chassis/motherboard/base_op_panel_blyth": {
        "BR": "89"
    }
}
{
    "/sys/bus/i2c/drivers/at24/8-0050/eeprom": {
        "BR": "89"
    }
}
{
    "/system/chassis/motherboard": {
        "BR": "89"
    }
}

Note: similarly, tested by updating backup path, observed that both primary and backup keyword’s value got updated with provided new value.
```

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