| Kuiying Wang | 11beff1 | 2019-04-11 15:54:49 +0800 | [diff] [blame] | 1 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 2 | Monitor Post code coming and buffer all of them based on boot cycle into |
| 3 | file system. |
| Kuiying Wang | 11beff1 | 2019-04-11 15:54:49 +0800 | [diff] [blame] | 4 | |
| 5 | properties: |
| Zhikui Ren | 8aec946 | 2020-02-12 09:09:00 -0800 | [diff] [blame] | 6 | - name: CurrentBootCycleCount |
| Kuiying Wang | 11beff1 | 2019-04-11 15:54:49 +0800 | [diff] [blame] | 7 | type: uint16 |
| 8 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 9 | It is used to indicate number of boot cycles that have post codes |
| 10 | archived. It starts from 1 and is limited to MaxBootCycleNum. |
| Kuiying Wang | 11beff1 | 2019-04-11 15:54:49 +0800 | [diff] [blame] | 11 | - name: MaxBootCycleNum |
| 12 | type: uint16 |
| 13 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 14 | The max cached boot cycles for post code. It is used to indicate end |
| 15 | user what's the max boot number, and make sure get command parameter |
| 16 | less than it. |
| Kuiying Wang | 11beff1 | 2019-04-11 15:54:49 +0800 | [diff] [blame] | 17 | methods: |
| Zhikui Ren | 8aec946 | 2020-02-12 09:09:00 -0800 | [diff] [blame] | 18 | - name: GetPostCodesWithTimeStamp |
| 19 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 20 | Method to get the cached post codes of the indicated boot cycle with |
| 21 | timestamp. |
| Zhikui Ren | 8aec946 | 2020-02-12 09:09:00 -0800 | [diff] [blame] | 22 | parameters: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 23 | - name: Index |
| 24 | type: uint16 |
| 25 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 26 | Index indicates which boot cycle of post codes is requested. 1 |
| 27 | is for the most recent boot cycle. CurrentBootCycleCount is for |
| 28 | the oldest boot cycle. |
| Zhikui Ren | 8aec946 | 2020-02-12 09:09:00 -0800 | [diff] [blame] | 29 | returns: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 30 | - name: Codes |
| 31 | type: dict[uint64, struct[uint64,array[byte]]] |
| 32 | description: > |
| 33 | An array of post codes and timestamp in microseconds since epoch |
| Kuiying Wang | 11beff1 | 2019-04-11 15:54:49 +0800 | [diff] [blame] | 34 | - name: GetPostCodes |
| 35 | description: > |
| 36 | Method to get the cached post codes of the indicated boot cycle. |
| 37 | parameters: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 38 | - name: Index |
| 39 | type: uint16 |
| 40 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 41 | Index indicates which boot cycle of post codes is requested. 1 |
| 42 | is for the most recent boot cycle. CurrentBootCycleCount is for |
| 43 | the oldest boot cycle. |
| Kuiying Wang | 11beff1 | 2019-04-11 15:54:49 +0800 | [diff] [blame] | 44 | returns: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 45 | - name: Codes |
| 46 | type: array[struct[uint64,array[byte]]] |
| 47 | description: > |
| 48 | An array of post codes of one boot cycle. |