blob: 3c3e01c03966b22cdc283f2be179d515199d5aaf [file] [log] [blame]
Dhruvaraj Subhashchandran5006cdf2020-01-20 04:08:10 -06001description: >
2 Implement this to add system dump management.
3
Patrick Williamsa1347412022-12-06 10:56:22 -06004 System dumps are dump of the host memory and hardware states generated
5 during a failure in the host firmware. This can be a huge dump stored in the
6 host memory, the BMC doesnt store this dump but stream this dump to an
7 external client based on the offload request. Apart from system generated
8 system dump, users can also request for this kind of dump.
Dhruvaraj Subhashchandran5006cdf2020-01-20 04:08:10 -06009
10properties:
11 - name: SourceDumpId
12 type: uint32
13 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -060014 The dump id provided by the source of the dump. There are dumps which
15 get generated outside the BMC, like a system dump which gets generated
16 and stored in the host memory. All dumps will have a unique id but
17 when communicating to the source of the dump the SourceDumpId will be
18 used.
Dhruvaraj Subhashchandran27afd1f2023-07-08 13:07:21 -050019 - name: Token
20 type: uint32
21 description: >
22 A token exchanged with an external firmware subsystem when creating a
23 dump outside of the BMC. This token can be used to identify the dump
24 entry once the collection is completed.