xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/State/Boot/PostCode.interface.yaml (revision 839d6c0acb015e84b0df236cf432d88b825a0e53)
1b1b4d261SWilliam A. Kennington IIIdescription: >
2a1347418SPatrick Williams    Monitor Post code coming and buffer all of them based on boot cycle into
3a1347418SPatrick Williams    file system.
4b1b4d261SWilliam A. Kennington III
5b1b4d261SWilliam A. Kennington IIIproperties:
6b1b4d261SWilliam A. Kennington III    - name: CurrentBootCycleCount
7b1b4d261SWilliam A. Kennington III      type: uint16
8b1b4d261SWilliam A. Kennington III      description: >
9a1347418SPatrick Williams          It is used to indicate number of boot cycles that have post codes
10a1347418SPatrick Williams          archived. It starts from 1 and is limited to MaxBootCycleNum.
11b1b4d261SWilliam A. Kennington III    - name: MaxBootCycleNum
12b1b4d261SWilliam A. Kennington III      type: uint16
13b1b4d261SWilliam A. Kennington III      description: >
14a1347418SPatrick Williams          The max cached boot cycles for post code. It is used to indicate end
15a1347418SPatrick Williams          user what's the max boot number, and make sure get command parameter
16a1347418SPatrick Williams          less than it.
17b1b4d261SWilliam A. Kennington IIImethods:
18b1b4d261SWilliam A. Kennington III    - name: GetPostCodesWithTimeStamp
19b1b4d261SWilliam A. Kennington III      description: >
20a1347418SPatrick Williams          Method to get the cached post codes of the indicated boot cycle with
21a1347418SPatrick Williams          timestamp.
22b1b4d261SWilliam A. Kennington III      parameters:
23b1b4d261SWilliam A. Kennington III          - name: Index
24b1b4d261SWilliam A. Kennington III            type: uint16
25b1b4d261SWilliam A. Kennington III            description: >
26a1347418SPatrick Williams                Index indicates which boot cycle of post codes is requested. 1
27a1347418SPatrick Williams                is for the most recent boot cycle. CurrentBootCycleCount is for
28a1347418SPatrick Williams                the oldest boot cycle.
29b1b4d261SWilliam A. Kennington III      returns:
30b1b4d261SWilliam A. Kennington III          - name: Codes
31*839d6c0aSPotin Lai            type: dict[uint64, struct[array[byte],array[byte]]]
32b1b4d261SWilliam A. Kennington III            description: >
33b1b4d261SWilliam A. Kennington III                An array of post codes and timestamp in microseconds since epoch
34b1b4d261SWilliam A. Kennington III    - name: GetPostCodes
35b1b4d261SWilliam A. Kennington III      description: >
36b1b4d261SWilliam A. Kennington III          Method to get the cached post codes of the indicated boot cycle.
37b1b4d261SWilliam A. Kennington III      parameters:
38b1b4d261SWilliam A. Kennington III          - name: Index
39b1b4d261SWilliam A. Kennington III            type: uint16
40b1b4d261SWilliam A. Kennington III            description: >
41a1347418SPatrick Williams                Index indicates which boot cycle of post codes is requested. 1
42a1347418SPatrick Williams                is for the most recent boot cycle. CurrentBootCycleCount is for
43a1347418SPatrick Williams                the oldest boot cycle.
44b1b4d261SWilliam A. Kennington III      returns:
45b1b4d261SWilliam A. Kennington III          - name: Codes
46*839d6c0aSPotin Lai            type: array[struct[array[byte],array[byte]]]
47b1b4d261SWilliam A. Kennington III            description: >
48b1b4d261SWilliam A. Kennington III                An array of post codes of one boot cycle.
49a8f47e7fSPatrick Williams
50a8f47e7fSPatrick Williamspaths:
51a8f47e7fSPatrick Williams    - namespace: /xyz/openbmc_project/State/Boot
52a8f47e7fSPatrick Williams      segments:
53a8f47e7fSPatrick Williams          - name: Host
54a8f47e7fSPatrick Williams            value: PostCode
55