xref: /openbmc/phosphor-dbus-interfaces/yaml/com/ibm/Dump/Entry/Hardware.interface.yaml (revision 0cd3adbafa0ca712645b5c01722ff4c7a49fea6f)
1a2eb94f6SDhruvaraj Subhashchandrandescription: >
2a2eb94f6SDhruvaraj Subhashchandran    Implement this to add Hardware dump management.
3a2eb94f6SDhruvaraj Subhashchandran
4a1347418SPatrick Williams    Hardware dump is a collection hardware state information, including various
5a1347418SPatrick Williams    registers, and it is used for debugging system checkstop. checkstop is the
6a1347418SPatrick Williams    descriptive term for entire system termination by the hardware due to a
7a1347418SPatrick Williams    detected error.
8*0cd3adbaSDhruvaraj Subhashchandran
9*0cd3adbaSDhruvaraj Subhashchandranproperties:
10*0cd3adbaSDhruvaraj Subhashchandran    - name: ErrorLogId
11*0cd3adbaSDhruvaraj Subhashchandran      type: uint32
12*0cd3adbaSDhruvaraj Subhashchandran      description: >
13*0cd3adbaSDhruvaraj Subhashchandran          The id of the log associated with the action which triggered the dump.
14*0cd3adbaSDhruvaraj Subhashchandran          This ID is a reference to an error log entry in the logging system.
15*0cd3adbaSDhruvaraj Subhashchandran          The value should be a 32-bit unsigned integer.
16*0cd3adbaSDhruvaraj Subhashchandran
17*0cd3adbaSDhruvaraj Subhashchandran    - name: FailingUnitId
18*0cd3adbaSDhruvaraj Subhashchandran      type: uint32
19*0cd3adbaSDhruvaraj Subhashchandran      description: >
20*0cd3adbaSDhruvaraj Subhashchandran          A unique id of the failing hardware unit which is causing the dump.
21*0cd3adbaSDhruvaraj Subhashchandran          This ID could be used to identify the specific piece of hardware
22*0cd3adbaSDhruvaraj Subhashchandran          within the system. The value should be a 32-bit unsigned integer.
23