| Dhruvaraj Subhashchandran | 2189251 | 2023-07-08 03:46:30 -0500 | [diff] [blame] | 1 | description: > |
| 2 | Implement to notify the creation of new dump. This interface is used when a |
| 3 | dump is already created and ready to be offloaded. This interface will |
| 4 | update an existing dump object or add a new one with the provided |
| 5 | properties. The existing create interface should be used when the data is |
| 6 | being collected and the dump needs to be packaged. |
| 7 | |
| 8 | Specifically for IBM OpenPOWER systems, dumps are collected and stored in |
| 9 | the host. Post dump completion, the host notifies via PLDM, which calls this |
| 10 | interface with dump type, dump source id (an id assigned by the host and |
| 11 | used for all communication with the host), and the size of the newly created |
| 12 | dump. |
| 13 | |
| 14 | Any OpenBMC implementation must provide exactly one implementation of |
| 15 | com.ibm.Dump.Notify on /xyz/openbmc_project/dump. |
| 16 | methods: |
| 17 | - name: NotifyDump |
| 18 | description: > |
| 19 | Create or update a dump entry based on the parameters and the specific |
| 20 | dump type. |
| 21 | parameters: |
| 22 | - name: SourceDumpId |
| 23 | type: uint32 |
| 24 | description: > |
| 25 | The dump id provided by the source of the dump. In IBM OpenPOWER |
| 26 | systems, some types of dumps are generated and stored in the |
| 27 | host memory. All dumps have a unique id, but when communicating |
| 28 | to the source of the dump, the SourceDumpId will be used. |
| 29 | - name: Size |
| 30 | type: uint64 |
| 31 | description: > |
| 32 | Size of the dump in bytes. On large systems, the size of the |
| 33 | dump can be up to 32GB. |
| 34 | - name: DumpType |
| 35 | type: enum [self.DumpType] |
| 36 | description: > |
| 37 | The type of the dump. |
| 38 | - name: Token |
| 39 | type: uint32 |
| 40 | default: 0 |
| 41 | description: > |
| 42 | Sometimes the dump is created in the host based on the request |
| 43 | from the user, such requests come through the BMC first and then |
| 44 | get forwaded to host in such cases host will be sending a token |
| 45 | to identify the dump request. If the token is not valid it |
| 46 | should be defaulted to 0. |
| 47 | errors: |
| 48 | - xyz.openbmc_project.Dump.Create.Error.Disabled |
| 49 | |
| 50 | enumerations: |
| 51 | - name: DumpType |
| 52 | description: > |
| 53 | The type of the host dump to be collected. |
| 54 | values: |
| 55 | - name: "System" |
| 56 | description: > |
| 57 | System Dump: A dump that contains certain hardware register data |
| 58 | and host memory. |
| 59 | - name: "Resource" |
| 60 | description: > |
| 61 | Resource Dump: A dump of host resources, created for various |
| 62 | host components. The content may vary accordingly. |