| Matt Spinler | f7616bc | 2019-11-19 09:23:37 -0600 | [diff] [blame] | 1 | description: > |
| 2 | Provides D-Bus access to OpenPower Platform Event Logs |
| 3 | methods: |
| 4 | - name: GetPEL |
| 5 | description: > |
| 6 | Returns a file desciptor to a PEL. |
| 7 | parameters: |
| 8 | - name: pelID |
| 9 | type: uint32 |
| 10 | description: > |
| 11 | The PEL log ID of the PEL to retrieve. |
| 12 | returns: |
| 13 | - name: data |
| 14 | type: unixfd |
| 15 | description: > |
| 16 | A file descriptor for a file that contains the PEL. |
| 17 | errors: |
| 18 | - xyz.openbmc_project.Common.Error.InternalFailure |
| 19 | - xyz.openbmc_project.Common.Error.InvalidArgument |
| 20 | |
| 21 | - name: GetPELFromOBMCID |
| 22 | description: > |
| 23 | Returns PEL data based on the OpenBMC event log ID. |
| 24 | parameters: |
| 25 | - name: obmcLogID |
| 26 | type: uint32 |
| 27 | description: > |
| 28 | The OpenBMC event log ID of the PEL to retrieve. |
| 29 | returns: |
| 30 | - name: data |
| 31 | type: array[byte] |
| 32 | description: > |
| 33 | The PEL data |
| 34 | errors: |
| Matt Spinler | f7616bc | 2019-11-19 09:23:37 -0600 | [diff] [blame] | 35 | - xyz.openbmc_project.Common.Error.InvalidArgument |
| Matt Spinler | 1702368 | 2020-01-09 15:56:27 -0600 | [diff] [blame^] | 36 | |
| 37 | - name: HostAck |
| 38 | description: > |
| 39 | Notifies the PEL handler that the host (usually the OS) acked a PEL. |
| 40 | parameters: |
| 41 | - name: pelID |
| 42 | type: uint32 |
| 43 | description: > |
| 44 | The PEL log ID |
| 45 | errors: |
| 46 | - xyz.openbmc_project.Common.Error.InvalidArgument |
| 47 | |
| 48 | - name: HostReject |
| 49 | description: > |
| 50 | Notifies the PEL handler that the host could not process a PEL. |
| 51 | parameters: |
| 52 | - name: pelID |
| 53 | type: uint32 |
| 54 | description: > |
| 55 | The PEL log ID |
| 56 | - name: reason |
| 57 | type: enum[self.RejectionReason] |
| 58 | description: > |
| 59 | The reason the PEL was rejected |
| 60 | errors: |
| 61 | - xyz.openbmc_project.Common.Error.InvalidArgument |
| 62 | |
| 63 | enumerations: |
| 64 | - name: RejectionReason |
| 65 | description: > |
| 66 | The reason the PEL was rejected |
| 67 | values: |
| 68 | - name: BadPEL |
| 69 | description: > |
| 70 | The PEL was malformed. |
| 71 | - name: HostFull |
| 72 | description: > |
| 73 | The host does not have room for more PELs at this time. |
| 74 | |