Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / refs/heads/master
commit7f23d4d9a2398da0f4a88a7f8764ada2fed18fe7[log] [tgz]
authorGunnar Mills <gmills@us.ibm.com>Tue Dec 10 10:47:41 2024 -0600
committerGunnar Mills <gunnar@gmills.xyz>Wed Dec 11 15:35:08 2024 +0000
tree3e7ae2c776d46c71b4ea567003345fc589fc4ed4
parente0e1549e82c4691ad41703cfb6563c77b76cf2c4 [diff]
Add Type = RackMount to Chassis

Most IBM servers are RackMount Chassis so anywhere we create the
/system/chassis, set Type to
xyz.openbmc_project.Inventory.Item.Chassis.ChassisType.RackMount.
One day, we could set this dynamically for tower models.

This is needed because
https://gerrit.openbmc.org/c/openbmc/bmcweb/+/75914 added support for
dynamic ChassisType. Before 75914, ChassisType was hardcoded to
RackMount. If you implement Inventory.Item.Chassis the default Chassis
Type is Unknown. Unknown in 75914 maps to Invalid and ChassisType is
left off the Redfish Chassis resource. The Redfish Validator flags this
as an error since ChassisType is a required property in the Chassis
schema.

bmcweb bumps are failing with
'''
ERROR - ChassisType: Mandatory prop does not exist
'''
Discussed in discord at [1].
[1]: https://discord.com/channels/775381525260664832/855566794994221117/1316067028242661397

Tested: With the latest bmcweb see "ChassisType": "RackMount", for
/redfish/v1/Chassis/chassis

Change-Id: Ib30e7610d0dbe21d52b90764863085bc47d75e00
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
8 files changed
tree: 3e7ae2c776d46c71b4ea567003345fc589fc4ed4
  1. config/
  2. examples/
  3. rules/
  4. scripts/
  5. service_files/
  6. subprojects/
  7. test/
  8. vpd-manager/
  9. vpd-parser/
  10. vpdecc/
  11. .clang-format
  12. .gitignore
  13. app.cpp
  14. args.cpp
  15. args.hpp
  16. common_utility.cpp
  17. common_utility.hpp
  18. const.hpp
  19. defines.hpp
  20. extra-properties-example.yaml
  21. extra-properties.mako.hpp
  22. extra-properties.py
  23. ibm_vpd_app.cpp
  24. ibm_vpd_utils.cpp
  25. ibm_vpd_utils.hpp
  26. impl.cpp
  27. impl.hpp
  28. LICENSE
  29. meson.build
  30. meson.options
  31. OWNERS
  32. README.md
  33. store.hpp
  34. types.hpp
  35. utilInterface.hpp
  36. vpd_exceptions.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) tocf 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.