blob: 2ea20b4f9f025f7ccbb7d786daf583a9cdb921fc [file] [log] [blame]
Kuiying Wang11beff12019-04-11 15:54:49 +08001description: >
2 Monitor Post code coming and buffer all of them based on boot cycle
3 into file system.
4
5properties:
Zhikui Ren8aec9462020-02-12 09:09:00 -08006 - name: CurrentBootCycleCount
Kuiying Wang11beff12019-04-11 15:54:49 +08007 type: uint16
8 description: >
Zhikui Ren8aec9462020-02-12 09:09:00 -08009 It is used to indicate number of boot cycles that have
10 post codes archived. It starts from 1 and is limited to
11 MaxBootCycleNum.
Kuiying Wang11beff12019-04-11 15:54:49 +080012 - name: MaxBootCycleNum
13 type: uint16
14 description: >
15 The max cached boot cycles for post code.
16 It is used to indicate end user what's the max boot number,
17 and make sure get command parameter less than it.
18methods:
Zhikui Ren8aec9462020-02-12 09:09:00 -080019 - name: GetPostCodesWithTimeStamp
20 description: >
21 Method to get the cached post codes of the indicated boot cycle with timestamp.
22 parameters:
23 - name: Index
24 type: uint16
25 description: >
26 Index indicates which boot cycle of post codes is requested.
27 1 is for the most recent boot cycle. CurrentBootCycleCount is for the
28 oldest boot cycle.
29 returns:
30 - name: Codes
31 type: dict[uint64, uint64]
32 description: >
33 An array of post codes and timestamp in microseconds since epoch
Kuiying Wang11beff12019-04-11 15:54:49 +080034 - name: GetPostCodes
35 description: >
36 Method to get the cached post codes of the indicated boot cycle.
37 parameters:
38 - name: Index
39 type: uint16
40 description: >
41 Index indicates which boot cycle of post codes is requested.
Zhikui Ren8aec9462020-02-12 09:09:00 -080042 1 is for the most recent boot cycle. CurrentBootCycleCount is for the
43 oldest boot cycle.
Kuiying Wang11beff12019-04-11 15:54:49 +080044 returns:
45 - name: Codes
46 type: array[uint64]
47 description: >
48 An array of post codes of one boot cycle.