1description: >
2    Implement to provide host interface support.
3    This will define the interfaces using which, a OpenPower
4    machine can communicate with host on agreed commands.
5
6    This is for Internal use by the Firmware only. The D-Bus object
7    is visible for the REST but it must not be used.
8
9methods:
10    - name: Execute
11      description: >
12          Execute the requested command by the caller. This command will be
13          processed in first in first out order. See the Command enum
14          description below for details on all supported commands.
15      parameters:
16          - name: command
17            type: enum[self.Command]
18            description: Requested command to execute against the host
19          - name: data
20            type: variant[byte]
21            description: Data associated with the command.
22
23signals:
24    - name: CommandComplete
25      description: >
26        Signal indicating that a command has completed
27      properties:
28        - name: command
29          type: enum[self.Command]
30          description: Executed command
31        - name: result
32          type: enum[self.Result]
33          description: Result of the command execution
34
35enumerations:
36    - name: Command
37      description: >
38        The command to execute against the host
39      values:
40        - name: OCCReset
41          description: >
42            Host firmware should reset the OCC. This is invoked by
43            OCC error monitor application on detecting the error.
44            Sensor ID of the failing OCC will be sent as data.
45            This command will return once the command has been placed
46            in command Queue.
47
48    - name: Result
49      description: >
50        The result of the command execution
51      values:
52        - name: Success
53          description: Command execution was a success
54        - name: Failure
55          description: Command execution was a failure
56