xref: /openbmc/phosphor-dbus-interfaces/yaml/org/open_power/OCC/PassThrough.interface.yaml (revision a1347418307d31a94bd21f22897aa508df938dcf)
1b1b4d261SWilliam A. Kennington IIIdescription: >
2b1b4d261SWilliam A. Kennington III    Implement to provide pass-through mechanism to the On Chip Controller (OCC).
3b1b4d261SWilliam A. Kennington IIImethods:
4b1b4d261SWilliam A. Kennington III    - name: Send
5b1b4d261SWilliam A. Kennington III      description: >
6b1b4d261SWilliam A. Kennington III          Pass through a command to the OCC.
7b1b4d261SWilliam A. Kennington III      parameters:
8b1b4d261SWilliam A. Kennington III          - name: command
9b1b4d261SWilliam A. Kennington III            # TODO via https://github.com/openbmc/openbmc/issues/1160. This should
10b1b4d261SWilliam A. Kennington III            # change to array[byte]. As of now, the REST server maps any numeric
11b1b4d261SWilliam A. Kennington III            # data to int32.
12b1b4d261SWilliam A. Kennington III            type: array[int32]
13b1b4d261SWilliam A. Kennington III            description: >
14b1b4d261SWilliam A. Kennington III                An array of integers representing the command and payload. This
15*a1347418SPatrick Williams                should still be bytes worth of data (as though using
16*a1347418SPatrick Williams                array[byte]), so each entry in the array should pack as many
17*a1347418SPatrick Williams                bytes as possible.
18b1b4d261SWilliam A. Kennington III      returns:
19b1b4d261SWilliam A. Kennington III          - name: response
20b1b4d261SWilliam A. Kennington III            # TODO via https://github.com/openbmc/openbmc/issues/1160. This should
21b1b4d261SWilliam A. Kennington III            # change to array[byte]. As of now, the REST server maps any numeric
22b1b4d261SWilliam A. Kennington III            # data to int32.
23b1b4d261SWilliam A. Kennington III            type: array[int32]
24b1b4d261SWilliam A. Kennington III            description: >
25*a1347418SPatrick Williams                An array of integers representing the response. This should
26*a1347418SPatrick Williams                still be bytes worth of data (as though using array[byte]), so
27*a1347418SPatrick Williams                each entry in the array should pack as many bytes as possible.
28e0674c89SChris Cain
29e0674c89SChris Cain    - name: SetMode
30e0674c89SChris Cain      description: >
31e0674c89SChris Cain          Change the power mode of the system.
32e0674c89SChris Cain      parameters:
33e0674c89SChris Cain          - name: mode
34e0674c89SChris Cain            type: byte
35e0674c89SChris Cain            description: >
36e0674c89SChris Cain                Desired power mode of the system.
37e0674c89SChris Cain          - name: frequencyPoint
38e0674c89SChris Cain            type: uint16
39e0674c89SChris Cain            description: >
40e0674c89SChris Cain                Frequency point required by some power modes.
41e0674c89SChris Cain      returns:
42e0674c89SChris Cain          - name: status
43e0674c89SChris Cain            type: boolean
44e0674c89SChris Cain            description: >
45e0674c89SChris Cain                Returns true if the mode change was accepted.
46