Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / b6965f1358991c0b8beba67c7e481c81363d63da
commitb6965f1358991c0b8beba67c7e481c81363d63da[log] [tgz]
authorAlpana Kumari <alpankum@in.ibm.com>Mon Jun 01 00:32:21 2020 -0500
committerSantosh Puranik <santosh.puranik@in.ibm.com>Mon Nov 02 16:25:18 2020 +0530
tree9635b1e9e0088cd272096e20979c15fa523d3233
parent920408dd1ccbb8494f8e9e446bb3a5dc24edf2cd [diff]
Support FRU Type in vpd tool

Test:
./vpd-tool --dumpObject  --object  /system/chassis/motherboard/cpu0
[
    {
        "/system/chassis/motherboard/cpu0": {
            "CC": "CB41",
            "DR": "A WAY  PROC CUOD",
            "FN": "1234567",
            "LocationCode": "U78DA.ND1.1234567-P0-C15",
            "PN": "1345678",
            "SN": "YLAB41010000",
            "TYPE": "fruAndModule",  <=================================
            "type": "xyz.openbmc_project.Inventory.Item.Cpu"
        }
    }
]

./vpd-tool --dumpObject  --object  /system/chassis/motherboard/cpu1
[
    {
        "/system/chassis/motherboard/cpu1": {
            "CC": "BB41",
            "DR": "A WAY  PROC CUOD",
            "FN": "1234567",
            "LocationCode": "U78DA.ND1.1234567-P0-C15",
            "PN": "1345678",
            "SN": "YLAB41010000",
            "TYPE": "moduleOnly",    <==================================
            "type": "xyz.openbmc_project.Inventory.Item.Cpu"
        }
    }
]

 ./vpd-tool --dumpObject  --object  /system/chassis/motherboard/ebmc_card_bmc
[
    {
        "/system/chassis/motherboard/ebmc_card_bmc": {
            "CC": "6B58",
            "DR": "EBMC            ",
            "FN": "F191014",
            "LocationCode": "U78DA.ND1.1234567-P0-C5",
            "PN": "PN12345",
            "SN": "YL6B58010000",
            "TYPE": "FRU",             <=================================
            "type": "xyz.openbmc_project.Inventory.Item.Bmc"
        }
    }
]

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