Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-inventory-manager / 14a9fe5e15c588e82efa002faaac8d38a087b779
commit14a9fe5e15c588e82efa002faaac8d38a087b779[log] [tgz]
authorBrad Bishop <bradleyb@fuzziesquirrel.com>Sat Nov 12 12:51:26 2016 -0500
committerBrad Bishop <bradleyb@fuzziesquirrel.com>Mon Nov 21 11:28:33 2016 -0500
tree5c873e10bc94d87f306a9c80d1eefa28d50bc0cc
parentf4666f595797910fec3c8b314d1219215e425f6d [diff]
pimgen: Add list-interfaces command option

list-interfaces simply prints out all the interfaces
found in interfaces.d.  This intended user is configure.

Change-Id: I5e2c6b59ae4addb04f2e82b084122a948e46d29f
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
1 file changed
tree: 5c873e10bc94d87f306a9c80d1eefa28d50bc0cc
  1. example/
  2. test/
  3. xyz/
  4. actions.hpp
  5. app.cpp
  6. bootstrap.sh
  7. configure.ac
  8. filters.hpp
  9. generated.mako.cpp
  10. LICENSE
  11. Makefile.am
  12. manager.cpp
  13. manager.hpp
  14. pimgen.py
  15. README.md
  16. 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