summaryrefslogtreecommitdiffstats
path: root/org/open_power/OCC/PassThrough.interface.yaml
blob: 3fc968c94234ed652a5908055bb7d68d653230a6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
description: >
    Implement to provide pass-through mechanism to the On Chip Controller (OCC).
methods:
    - name: Send
      description: >
          Pass through a command to the OCC.
      parameters:
        - name: command
          # TODO via https://github.com/openbmc/openbmc/issues/1160. This should
          # change to array[byte]. As of now, the REST server maps any numeric
          # data to int32.
          type: array[int32]
          description: >
              An array of integers representing the command and payload. This
              should still be bytes worth of data (as though using array[byte]),
              so each entry in the array should pack as many bytes as possible.
      returns:
        - name: response
          # TODO via https://github.com/openbmc/openbmc/issues/1160. This should
          # change to array[byte]. As of now, the REST server maps any numeric
          # data to int32.
          type: array[int32]
          description: >
              An array of integers representing the response. This
              should still be bytes worth of data (as though using array[byte]),
              so each entry in the array should pack as many bytes as possible.

# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4
OpenPOWER on IntegriCloud