summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVishwanatha Subbanna <vishwa@linux.vnet.ibm.com>2017-07-10 15:28:50 +0530
committerVishwanatha Subbanna <vishwa@linux.vnet.ibm.com>2017-07-18 12:07:48 +0530
commit93ff4bbfc7857a395e066c3ffa45587bbcba1cc5 (patch)
tree26aa7b2f5737ace8fc091f1efc4d0776e9843e0d
parent874cf889e45d4ba26825ff6d0c46757c73c4c3d4 (diff)
downloadopenpower-dbus-interfaces-93ff4bbfc7857a395e066c3ffa45587bbcba1cc5.zip
openpower-dbus-interfaces-93ff4bbfc7857a395e066c3ffa45587bbcba1cc5.tar.gz
Define interface yaml file for interacting with host
phosphor-dbus-interfaces already has the interface yaml file that facilitates communication with Host. However, it is only to be used in the implementations that are common to all platforms. This commit is enabling commands that are applicable to OpenPower specific implementations only. Change-Id: Ifa7c09d4c9aa8ae2205257752af8f8fdf6ca806a Signed-off-by: Vishwanatha Subbanna <vishwa@linux.vnet.ibm.com>
-rw-r--r--org/open_power/Control/Host.interface.yaml51
1 files changed, 51 insertions, 0 deletions
diff --git a/org/open_power/Control/Host.interface.yaml b/org/open_power/Control/Host.interface.yaml
new file mode 100644
index 0000000..c5ac672
--- /dev/null
+++ b/org/open_power/Control/Host.interface.yaml
@@ -0,0 +1,51 @@
+description: >
+ Implement to provide host interface support.
+ This will define the interfaces using which, a OpenPower
+ machine can communicate with host on agreed commands.
+
+ This is for Internal use by the Firmware only. The D-Bus object
+ is visible for the REST but it must not be used.
+
+methods:
+ - name: Execute
+ description: >
+ Execute the requested command by the caller. This command will be
+ processed in first in first out order. See the Command enum
+ description below for details on all supported commands.
+ parameters:
+ - name: command
+ type: enum[self.Command]
+ description: Requested command to execute against the host
+
+signals:
+ - name: CommandComplete
+ description: >
+ Signal indicating that a Command has completed
+ properties:
+ - name: command
+ type: enum[self.Command]
+ description: Executed command
+ - name: result
+ type: enum[self.Result]
+ description: Result of the command execution
+
+enumerations:
+ - name: Command
+ description: >
+ The command to execute against the host
+ values:
+ - name: OCCReset
+ description: >
+ Host firmware should reset the OCC. This is invoked by
+ OCC error monitor application on detecting the error.
+ This command will return once the command has been placed
+ in command Queue.
+
+ - name: Result
+ description: >
+ The result of the command execution
+ values:
+ - name: Success
+ description: Command execution was a success
+ - name: Failure
+ description: Command execution was a failure
OpenPOWER on IntegriCloud