Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / d09d2ec1a082502890c246278a5d34c64e349f13
commitd09d2ec1a082502890c246278a5d34c64e349f13[log] [tgz]
authorPriyangaRamasamy <priyanga24@in.ibm.com>Thu Mar 12 14:11:50 2020 +0530
committerSunnySrivastava1984 <sunnsr25@in.ibm.com>Mon Jun 22 01:45:34 2020 -0500
tree3fa731b49b27c6e5bca5fbe4dacca1e0002049f4
parenta739259fedc6d390d61357a0f4a1dc95fd0e26c4 [diff]
VPD Tool: Write keyword command line interface

This commit has the command line interface
for writeKeyword option in the VPD tool.

--help option will provide the user - the argument format
for writeKeyword option.

Note:
	The application "vpd-manager" acts as the backend for the keyword updation.
	The vpd-manager executable should run in the background while testing in simics.
	The commits which points to the vpd-manager backend application are,
		< https://gerrit.openbmc-project.xyz/c/openbmc/openpower-vpd-parser/+/28991/43 >
		< https://gerrit.openbmc-project.xyz/c/openbmc/openpower-vpd-parser/+/29039/43 >
		< https://gerrit.openbmc-project.xyz/c/openbmc/openpower-vpd-parser/+/32439/10 >

Tested on rainier:
root@rainier:/tmp# ./vpd-tool -r -O /system/chassis/motherboard/vdd_vrm1 -R VINI -K FN
{
    "/system/chassis/motherboard/vdd_vrm1": {
        "FN": "F190827"
    }
}
root@rainier:/tmp#
root@rainier:/tmp# ./vpd-tool -w -O /system/chassis/motherboard/vdd_vrm1 -R VINI -K FN -V 0x616263
root@rainier:/tmp#
root@rainier:/tmp# ./vpd-tool -r -O /system/chassis/motherboard/vdd_vrm1 -R VINI -K FN
{
    "/system/chassis/motherboard/vdd_vrm1": {
        "FN": "abc0827"
    }
}

Change-Id: I6c586a9848497e44bf88eda78694989d0287cbba
Signed-off-by: Priyanga Ramasamy <priyanga24@in.ibm.com>
3 files changed
tree: 3fa731b49b27c6e5bca5fbe4dacca1e0002049f4
  1. examples/
  2. test/
  3. vpd-manager/
  4. vpdecc/
  5. .clang-format
  6. .gitignore
  7. app.cpp
  8. args.cpp
  9. args.hpp
  10. bootstrap.sh
  11. configure.ac
  12. const.hpp
  13. defines.hpp
  14. extra-properties-example.yaml
  15. extra-properties.mako.hpp
  16. extra-properties.py
  17. ibm_vpd_app.cpp
  18. ibm_vpd_type_check.cpp
  19. ibm_vpd_type_check.hpp
  20. impl.cpp
  21. impl.hpp
  22. keyword_vpd_parser.cpp
  23. keyword_vpd_parser.hpp
  24. keyword_vpd_types.hpp
  25. LICENSE
  26. MAINTAINERS
  27. Makefile.am
  28. meson.build
  29. meson_options.txt
  30. parser.cpp
  31. parser.hpp
  32. README.md
  33. store.hpp
  34. types.hpp
  35. utils.cpp
  36. utils.hpp
  37. vpd_tool.cpp
  38. vpd_tool_impl.cpp
  39. vpd_tool_impl.hpp
  40. write.cpp
  41. write.hpp
  42. writefru.mako.hpp
  43. writefru.py
  44. writefru.yaml
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.