Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-inventory-manager / b83a21ea3eb4848ae7009d6010062aa01620edd5
commitb83a21ea3eb4848ae7009d6010062aa01620edd5[log] [tgz]
authorBrad Bishop <bradleyb@fuzziesquirrel.com>Wed Nov 30 13:43:37 2016 -0500
committerBrad Bishop <bradleyb@fuzziesquirrel.com>Thu Jan 12 16:53:38 2017 -0500
tree090188e1bd8131f91be8dfcb8b91972e29b60c3b
parent432e35277738a03f1ce71614a95d79750795d238 [diff]
Add interface exposing utility functions

Add utility functions enabling easy method calls on sdbusplus interface
binding objects.

Change-Id: Ie1d01f82604406705869fea0ec19d84c95d90474
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
3 files changed
tree: 090188e1bd8131f91be8dfcb8b91972e29b60c3b
  1. example/
  2. test/
  3. xyz/
  4. .gitignore
  5. actions.hpp
  6. app.cpp
  7. bootstrap.sh
  8. configure.ac
  9. events.hpp
  10. generated.mako.cpp
  11. LICENSE
  12. Makefile.am
  13. manager.cpp
  14. manager.hpp
  15. pimgen.py
  16. README.md
  17. utils.hpp
  18. xyz.openbmc_project.Inventory.Manager.cpp
README.md

Phosphor Inventory Manager (PIM) is an implementation of the xyz.openbmc_project.Inventory.Manager DBus interface, and supporting tools. PIM uses a combination of build-time YAML files and run-time calls to the Notify method of the Manager interface to provide a generalized inventory state management solution.

YAML

PIM includes a YAML parser (pimgen.py). For PIM to do anything useful, a set of YAML files must be provided externally that tell it what to do. An example can be found in the examples directory.

The following top level YAML tags are supported:

  • description - An optional description of the file.
  • events - One or more events that PIM should monitor.

events

Supported event tags are:

  • name - A globally unique event name.
  • type - The event type. Supported types are: match.
  • action - The response to the event.

Subsequent tags are defined by the event type.

action

Supported action tags are:

  • type - The action to perform.
  • args - An optional list of arguments to pass to the action.
    • value - The argument value.
    • type - The argument type (defaults to string if unspecified).

The available actions provided by PIM are:

  • noop - A non-action.
  • destroyObject - Destroy the specified DBus object.

match

Supported match tags are:

  • signature - A DBus match specification.
  • filter - A filter to apply when a match occurs.

filter

Supported filter tags are:

  • type - The filter to use.
  • args - An optional list of arguments to pass to the filter.
    • value - The argument value.
    • type - The argument type (defaults to string if unspecified).

The available filters provided by PIM are:

  • none - A non-filter.
  • propertyChangedTo - Only match events when the specified property has the specified value.

Building

After running pimgen.py, build PIM using the following steps:

    ./bootstrap.sh
    ./configure ${CONFIGURE_FLAGS}
    make

To clean the repository run:

 ./bootstrap.sh clean