summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-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