summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGunnar Mills <gmills@us.ibm.com>2017-08-17 14:33:27 -0500
committerPatrick Williams <patrick@stwcx.xyz>2017-09-06 20:06:34 +0000
commit55d03cac49adee4d0d9575bb8f6d00fd0c77e114 (patch)
treec371110e539f893729c9beac1eedca47eb05aa35
parent4be2eef8da8d742dcd63bb60e38d013f42a429b4 (diff)
downloadphosphor-dbus-interfaces-55d03cac49adee4d0d9575bb8f6d00fd0c77e114.zip
phosphor-dbus-interfaces-55d03cac49adee4d0d9575bb8f6d00fd0c77e114.tar.gz
Update Software interface README
Change-Id: I93764fc9c8e6f05d41ece7a6605452bbbac11c3b Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
-rw-r--r--xyz/openbmc_project/Software/README.md21
1 files changed, 11 insertions, 10 deletions
diff --git a/xyz/openbmc_project/Software/README.md b/xyz/openbmc_project/Software/README.md
index 15c0eaf..df7ffec 100644
--- a/xyz/openbmc_project/Software/README.md
+++ b/xyz/openbmc_project/Software/README.md
@@ -31,7 +31,7 @@ the location of the image.
It is assumed that the *ImageManager* has [at least] a bare minimum amount of
parsing knowledge, perhaps due to a common image format, to allow it to
populate all of the properties of `xyz.openbmc_project.Software.Version`.
-*ItemUpdater*s will likely listen for standard dbus signals to identify new
+*ItemUpdater*s will likely listen for standard D-Bus signals to identify new
images being created.
### *ItemUpdater*
@@ -40,12 +40,13 @@ The *ItemUpdater* is responsible for monitoring for new `Software.Version` eleme
being created to identify versions that are applicable to the inventory
element(s) it is managing. The *ItemUpdater* should dynamically create
an `xyz.openbmc_project.Software.Activation` interface under
-`/xyz/openbmc_project/software/active/`, an association of type
-`{activation,software_version}` between the `Software.Version` and
-`Software.Activation`, and an association of type `{active_image,item}` between
-the `Inventory.Item` and `Software.Activation`. Application of the software
-image is then handled through the `RequestedActivation` property of the
-`Software.Activation` interface.
+`/xyz/openbmc_project/software/`, an association of type
+`{active_image,software_version}` between the `Software.Version` and
+`Software.Activation` under `/xyz/openbmc_project/software/`, and an
+association of type `{activation,item}` between the `Inventory.Item`
+and `Software.Activation` under `/xyz/openbmc_project/software/<id>`.
+Application of the software image is then handled through the
+`RequestedActivation` property of the `Software.Activation` interface.
The *ItemUpdater* should, if possible, also create its own
`xyz.openbmc_project.Software.Version` objects, and appropriate associations
@@ -58,7 +59,7 @@ software versions when the *ImageManager* no longer contains a copy.
### Image Identifier
The *ImageManager* and *ItemUpdater* should use a common, though perhaps
-implementation specific, algorithm for the `<id>` portion of a dbus path for
+implementation specific, algorithm for the `<id>` portion of a D-Bus path for
each `Software.Version`. This allows the same software version to be contained
in multiple locations but represented by the same object path.
@@ -66,7 +67,7 @@ A reasonable algorithm might be:
`echo <Version.Version> <Version.Purpose> | sha512sum | cut -b 1-8`
> TODO: May need an issue against the REST server to 'merge' two copies of
-> a single dbus object into a single REST object.
+> a single D-Bus object into a single REST object.
### Activation States
@@ -140,7 +141,7 @@ association to retrieve version information.
### Find all software versions on a managed element.
-List `/xyz/openbmc_project/inventory/.../<item>/active_image` association.
+List `/xyz/openbmc_project/inventory/.../<item>/activation` association.
### Upload new version via REST
OpenPOWER on IntegriCloud