Handle file mode for system VPD collection

This commit adds changes to read system VPD from designated file
location in case VPD collection mode is 'file mode' for the system.

In non-field mode, VPD collection mode is determined by reading u-boot
variable "vpdmode".

```
Test:
Good path:
1. Updated u-boot vpdmode to file mode.
2. Copied the system VPD to designated location for file mode.
3. After system reboot, observed that system VPD is collected successfully.

Bad path:
1. Updated u-boot vpdmode to file mode.
2. Skipped copying system VPD to designated file location.
3. After system reboot, observed that vpd-manger logged a critical PEL as system VPD parsing is failed.

Part of info from PEL:
"User Data 1": {
    "Section Version": "1",
    "Sub-section type": "1",
    "Created by": "bmc error logging",
    "DESCRIPTION": "Standard runtime exception. Reason: System VPD parsing failed, from path [/var/lib/vpd/file/sys/bus/i2c/drivers/at24/8-0050/eeprom]. Either file doesn't exist or error occurred while parsing the file.",
    "FileName": "/usr/src/debug/openpower-fru-vpd/1.0+git/vpd-manager/oem-handler/ibm_handler.cpp",
    "FunctionName": "performInitialSetup",
    "InteranlRc": "0",
    "UserData1": "",
    "UserData2": ""
}
```

Change-Id: Iae4eb64fe91e608f9ae61ab7f88ae41d36bc1007
Signed-off-by: Anupama B R <anupama.b.r1@ibm.com>
3 files changed
tree: dec7f030d7286e740a4b7fbf11d433c9614a35db
  1. configuration/
  2. docs/
  3. service_files/
  4. test/
  5. vpd-manager/
  6. vpd-tool/
  7. vpdecc/
  8. wait-vpd-parser/
  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.