Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / d90aadbf53587ff24837e26e69431fd0eed543a7
commitd90aadbf53587ff24837e26e69431fd0eed543a7[log] [tgz]
authorPriyanga Ramasamy <priyanga24@in.ibm.com>Tue Mar 28 12:25:14 2023 -0500
committerpriyanga24 <priyanga24@in.ibm.com>Tue Apr 18 09:10:44 2023 +0000
tree6b446999159bdd8e616c723a9c0ec8e140409012
parentc68829ad97f8de8e2b58eecc1c0011a2a2f82df9 [diff]
Remove adding parent's presence for child FRUs

In the existing code, vpd-tool emplaces the parent FRU's presence for
child FRU whose "Present" property is not available on d-bus. This
gives a misleading information on presence state of non embedded FRU's,
which can either be present or absent on a machine.

Fix:
This commit modifies the vpd-tool code to print "Unknown" if the FRU's
Present property is not available on d-bus.

Test:
1. When Present property is not published on d-bus
vpd-tool -o -O /system/chassis/motherboard/powersupply0
[
    {
        "/system/chassis/motherboard/powersupply0": {
            "LocationCode": "U78DA.ND0.WZS0065-E0",
            "Present": "Unknown",
            "TYPE": "FRU",
            "type": "xyz.openbmc_project.Inventory.Item.PowerSupply"
        }
    }
]

2. When Present property is set to true on dbus
:~# vpd-tool -o -O /system/chassis/motherboard/powersupply0
[
    {
        "/system/chassis/motherboard/powersupply0": {
            "CC": "51DA",
            "DR": "IBM PS",
            "FN": "03FP221",
            "LocationCode": "U780C.ND0.RCH0014-E0",
            "PN": "03FP207",
            "Present": "true",
            "SN": "YL31KY12K0CX",
            "TYPE": "FRU",
            "type": "xyz.openbmc_project.Inventory.Item.PowerSupply"
        }
    }
]

3. When Present property is set to false on dbus
:~# vpd-tool -o -O /system/chassis/motherboard/powersupply0
[
    {
        "/system/chassis/motherboard/powersupply0": {
            "CC": "51DA",
            "DR": "IBM PS",
            "FN": "03FP221",
            "LocationCode": "U780C.ND0.RCH0014-E0",
            "PN": "03FP207",
            "Present": "false",
            "SN": "YL31KY12K0CX",
            "TYPE": "FRU",
            "type": "xyz.openbmc_project.Inventory.Item.PowerSupply"
        }
    }
]

Signed-off-by: Priyanga Ramasamy <priyanga24@in.ibm.com>
Change-Id: I4c8ce2141b9ae7c46f1421c59de5d627b8aad429
2 files changed
tree: 6b446999159bdd8e616c723a9c0ec8e140409012
  1. examples/
  2. ibm_vpd/
  3. subprojects/
  4. test/
  5. vpd-manager/
  6. vpd-parser/
  7. vpdecc/
  8. .clang-format
  9. .gitignore
  10. app.cpp
  11. args.cpp
  12. args.hpp
  13. common_utility.cpp
  14. common_utility.hpp
  15. const.hpp
  16. defines.hpp
  17. extra-properties-example.yaml
  18. extra-properties.mako.hpp
  19. extra-properties.py
  20. ibm_vpd_app.cpp
  21. ibm_vpd_utils.cpp
  22. ibm_vpd_utils.hpp
  23. impl.cpp
  24. impl.hpp
  25. LICENSE
  26. meson.build
  27. meson_options.txt
  28. OWNERS
  29. README.md
  30. store.hpp
  31. types.hpp
  32. utilInterface.hpp
  33. vpd_exceptions.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.