summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDeepak Kodihalli <dkodihal@in.ibm.com>2017-08-27 06:49:27 -0500
committerPatrick Williams <patrick@stwcx.xyz>2017-09-08 16:49:40 +0000
commitdb17b50dcdd485ee01a8188c46f87dcbe617c037 (patch)
tree48db23c798eddfbd3c832f7da1d6574a475b3220
parent55d03cac49adee4d0d9575bb8f6d00fd0c77e114 (diff)
downloadphosphor-dbus-interfaces-db17b50dcdd485ee01a8188c46f87dcbe617c037.zip
phosphor-dbus-interfaces-db17b50dcdd485ee01a8188c46f87dcbe617c037.tar.gz
Add interface to enable an object
The interface consists of a boolean property called 'Enabled'. Setting that to true or false helps determine whether an object implementing this interface is usable or not. This will help users to select an object from a collection of similar objects. For instance, given these objects : setting/permanent/boot and setting/one-time/boot, one or both of these objects could implement the Enable interface to allow a user to state how the boot setting should be applied - the next boot versus all subsequent boots. Change-Id: I35df5384d459ba7d6cd9afab630f145b5a5c9948 Signed-off-by: Deepak Kodihalli <dkodihal@in.ibm.com>
-rw-r--r--xyz/openbmc_project/Object/Enable.interface.yaml22
1 files changed, 22 insertions, 0 deletions
diff --git a/xyz/openbmc_project/Object/Enable.interface.yaml b/xyz/openbmc_project/Object/Enable.interface.yaml
new file mode 100644
index 0000000..cf31849
--- /dev/null
+++ b/xyz/openbmc_project/Object/Enable.interface.yaml
@@ -0,0 +1,22 @@
+description: >
+ Implement to enable an object.
+
+ A d-bus object under certain circumstances may have the need to be denoted
+ as "disabled". So the object exists, but it's current state (described by
+ the object properties) can't be relied upon, until the object is "enabled"
+ again. What causes the object to be enabled or disabled - whether it's via
+ an external interface or internal logic - depends on a specific
+ implementation and use-case.
+
+ An example could be a d-bus object that denotes boot settings. However let's
+ say there's a permanent settings object versus a one-time (the next boot)
+ settings object. In this case, one of these objects, typically the one which
+ is not supposed to be used as a default, can implement the Enable interface
+ so that a user can indicate whether this setting object is to be used or
+ not, by setting the Enabled property.
+properties:
+ - name: Enabled
+ type: boolean
+ description: >
+ Whether the object is enabled or not.
+ default: false
OpenPOWER on IntegriCloud