Move json symlink before populating dbus interfaces

This commit reorders the flow of ibm-read-vpd app execution by
first allowing the app to create symbolink link to the respective json
and then populate dbus interfaces by having the right json.

Without this change, only those motherboard subfrus which are present
in the default inventory json will gets its interfaces populated during
genesis boot. Thus leaving machine specific motherboard's subfru's
(powersupply, pcieslots, etc.,) dbus interfaces unpopulated.

With this change, all of the motherboard subfrus which are present in
the symlink json will get its interfaces populated on dbus during
genesis boot.

Test:
Tested on simics rainier2s2u. Able to see all of the interfaces of
motherboard's
subfrus after the genesis boot.

1. motherboard's subfru - powersupply0

root@p10bmc:~# busctl introspect xyz.openbmc_project.Inventory.Manager /xyz/openbmc_project/inventory/system/chassis/motherboard/powersupply0
NAME                                                  TYPE      SIGNATURE RESULT/VALUE                             FLAGS
com.ibm.ipzvpd.DINF                                   interface -         -                                        -
.FL                                                   property  ay        20 69 48 32 32 32 32 32 32 32 32 32 32 … emits-change writable
.RI                                                   property  ay        4 0 3 16 0                               emits-change writable
.RT                                                   property  ay        0                                        emits-change writable
com.ibm.ipzvpd.Location                               interface -         -                                        -
.LocationCode                                         property  s         "U78DA.ND0.1234567-E0"                   emits-change writable
com.ibm.ipzvpd.VINI                                   interface -         -                                        -
.B3                                                   property  ay        0                                        emits-change writable
.B4                                                   property  ay        0                                        emits-change writable
.B7                                                   property  ay        0                                        emits-change writable
.CC                                                   property  ay        4 53 49 69 57                            emits-change writable
.CE                                                   property  ay        0                                        emits-change writable
.CT                                                   property  ay        0                                        emits-change writable
.DR                                                   property  ay        6 73 66 77 32 80 83                      emits-change writable
.FG                                                   property  ay        0                                        emits-change writable
.FN                                                   property  ay        1 99                                     emits-change writable
.HE                                                   property  ay        0                                        emits-change writable
.HW                                                   property  ay        0                                        emits-change writable
.HX                                                   property  ay        0                                        emits-change writable
.PN                                                   property  ay        8 114 101 118 105 115 105 111 110        emits-change writable
.PR                                                   property  ay        0                                        emits-change writable
.RT                                                   property  ay        0                                        emits-change writable
.SN                                                   property  ay        12 89 76 49 48 75 115 101 114 105 97 10… emits-change writable
.TS                                                   property  ay        0                                        emits-change writable
.VN                                                   property  ay        0                                        emits-change writable
.VZ                                                   property  ay        0                                        emits-change writable
org.freedesktop.DBus.Introspectable                   interface -         -                                        -
.Introspect                                           method    -         s                                        -
org.freedesktop.DBus.Peer                             interface -         -                                        -
.GetMachineId                                         method    -         s                                        -
.Ping                                                 method    -         -                                        -
org.freedesktop.DBus.Properties                       interface -         -                                        -
.Get                                                  method    ss        v                                        -
.GetAll                                               method    s         a{sv}                                    -
.Set                                                  method    ssv       -                                        -
.PropertiesChanged                                    signal    sa{sv}as  -                                        -
xyz.openbmc_project.Association.Definitions           interface -         -                                        -
.Associations                                         property  a(sss)    3 "fault_led_group" "fault_inventory_ob… emits-change writable
xyz.openbmc_project.Inventory.Decorator.Asset         interface -         -                                        -
.BuildDate                                            property  s         ""                                       emits-change writable
.Manufacturer                                         property  s         ""                                       emits-change writable
.Model                                                property  s         "51E9"                                   emits-change writable
.PartNumber                                           property  s         "revision"                               emits-change writable
.SerialNumber                                         property  s         "serial"                                 emits-change writable
.SparePartNumber                                      property  s         "c"                                      emits-change writable
.SubModel                                             property  s         ""                                       emits-change writable
xyz.openbmc_project.Inventory.Decorator.LocationCode  interface -         -                                        -
.LocationCode                                         property  s         "U78DA.ND0.1234567-E0"                   emits-change writable
xyz.openbmc_project.Inventory.Item                    interface -         -                                        -
.Present                                              property  b         true                                     emits-change writable
.PrettyName                                           property  s         "powersupply0"                           emits-change writable
xyz.openbmc_project.Inventory.Item.PowerSupply        interface -         -                                        -
xyz.openbmc_project.Object.Enable                     interface -         -                                        -
.Enabled                                              property  b         false                                    emits-change writable
xyz.openbmc_project.Software.Version                  interface -         -                                        -
.Purpose                                              property  s         "xyz.openbmc_project.Software.Version.V… emits-change writable
.Version                                              property  s         "313033323330"                           emits-change writable
xyz.openbmc_project.State.Decorator.OperationalStatus interface -         -                                        -
.Functional                                           property  b         true                                     emits-change writable
root@p10bmc:~#

===========
2. motherboard's subfru - pcieslot0

root@p10bmc:~# busctl introspect xyz.openbmc_project.Inventory.Manager /xyz/openbmc_project/inventory/system/chassis/motherboard/pcieslot0
NAME                                                  TYPE      SIGNATURE RESULT/VALUE                             FLAGS
com.ibm.ipzvpd.Location                               interface -         -                                        -
.LocationCode                                         property  s         "U78DA.ND0.1234567-P0-C0"                emits-change writable
org.freedesktop.DBus.Introspectable                   interface -         -                                        -
.Introspect                                           method    -         s                                        -
org.freedesktop.DBus.Peer                             interface -         -                                        -
.GetMachineId                                         method    -         s                                        -
.Ping                                                 method    -         -                                        -
org.freedesktop.DBus.Properties                       interface -         -                                        -
.Get                                                  method    ss        v                                        -
.GetAll                                               method    s         a{sv}                                    -
.Set                                                  method    ssv       -                                        -
.PropertiesChanged                                    signal    sa{sv}as  -                                        -
xyz.openbmc_project.Association.Definitions           interface -         -                                        -
.Associations                                         property  a(sss)    3 "fault_led_group" "fault_inventory_ob… emits-change writable
xyz.openbmc_project.Inventory.Decorator.LocationCode  interface -         -                                        -
.LocationCode                                         property  s         "U78DA.ND0.1234567-P0-C0"                emits-change writable
xyz.openbmc_project.Inventory.Item.PCIeSlot           interface -         -                                        -
.Generation                                           property  s         "xyz.openbmc_project.Inventory.Item.PCI… emits-change writable
.HotPluggable                                         property  b         false                                    emits-change writable
.Lanes                                                property  u         0                                        emits-change writable
.SlotType                                             property  s         "xyz.openbmc_project.Inventory.Item.PCI… emits-change writable
xyz.openbmc_project.Object.Enable                     interface -         -                                        -
.Enabled                                              property  b         false                                    emits-change writable
xyz.openbmc_project.State.Decorator.OperationalStatus interface -         -                                        -
.Functional                                           property  b         true                                     emits-change writable
xyz.openbmc_project.State.Decorator.PowerState        interface -         -                                        -
.PowerState                                           property  s         "xyz.openbmc_project.State.Decorator.Po… emits-change writable
root@p10bmc:~#

Signed-off-by: Priyanga Ramasamy <priyanga24@in.ibm.com>
Change-Id: I7a5c6dc23ef5b09a99f013c0540ecc59913c92c6
1 file changed
tree: be8fa1001ad8309917f5d382e8db06acc698e68d
  1. examples/
  2. subprojects/
  3. test/
  4. vpd-manager/
  5. vpd-parser/
  6. vpdecc/
  7. .clang-format
  8. .gitignore
  9. app.cpp
  10. args.cpp
  11. args.hpp
  12. common_utility.cpp
  13. common_utility.hpp
  14. const.hpp
  15. defines.hpp
  16. extra-properties-example.yaml
  17. extra-properties.mako.hpp
  18. extra-properties.py
  19. ibm_vpd_app.cpp
  20. ibm_vpd_utils.cpp
  21. ibm_vpd_utils.hpp
  22. impl.cpp
  23. impl.hpp
  24. LICENSE
  25. MAINTAINERS
  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.