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