| 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 | |
| Matt Spinler | 4da53b2 | 2020-08-14 09:42:48 -0500 | [diff] [blame^] | 63 | - name: CreatePELWithFFDCFiles |
| 64 | description: > |
| 65 | Creates an OpenBMC event log and a corresponding PEL. This method |
| 66 | returns the IDs of the created PEL and OpenBMC event log, unlike the |
| 67 | 'xyz.openbmc_project.Logging.Create.CreateWithFFDCFiles' method which |
| 68 | doesn't return anything. |
| 69 | parameters: |
| 70 | - name: Message |
| 71 | type: string |
| 72 | description: > |
| 73 | The Message property of the OpenBMC event log entry. |
| 74 | This is also the key into the PEL message registry. |
| 75 | - name: Severity |
| 76 | type: enum[xyz.openbmc_project.Logging.Entry.Level] |
| 77 | description: > |
| 78 | The Severity property of the event entry. |
| 79 | - name: AdditionalData |
| 80 | type: dict[string, string] |
| 81 | description: > |
| 82 | The AdditionalData property of the event entry. |
| 83 | e.g.: |
| 84 | { |
| 85 | "key1": "value1", |
| 86 | "key2": "value2" |
| 87 | } |
| 88 | ends up in AdditionaData like: |
| 89 | ["KEY1=value1", "KEY2=value2"] |
| 90 | - name: FFDC |
| 91 | type: array[struct[enum[xyz.openbmc_project.Logging.Create.FFDCFormat], byte, byte, unixfd]] |
| 92 | description: > |
| 93 | File descriptors for any files containing FFDC, along with metadata |
| 94 | about the contents: |
| 95 | |
| 96 | FFDCFormat- The format type of the contained data. |
| 97 | subType - The format subtype, used for the 'Custom' type. |
| 98 | version - The version of the data format, used for the 'Custom' |
| 99 | type. |
| 100 | unixfd - The file descriptor to the data file. |
| 101 | |
| 102 | e.g.: |
| 103 | [ |
| 104 | {"xyz.openbmc_project.Logging.Create.FFDCFormat.JSON", 0, 0, 5}, |
| 105 | {"xyz.openbmc_project.Logging.Create.FFDCFormat.Custom", 1, 2, 6} |
| 106 | ] |
| 107 | returns: |
| 108 | - name: IDs |
| 109 | type: struct[uint32, uint32] |
| 110 | description: > |
| 111 | The IDs of the 2 created logs: |
| 112 | - OpenBMC event log ID |
| 113 | - PEL log ID: The unique ID of the PEL |
| 114 | Note that the PEL's platform log ID (PLID) field is always |
| 115 | equal to the PEL log ID for BMC created PELs. |
| 116 | |
| Matt Spinler | 1702368 | 2020-01-09 15:56:27 -0600 | [diff] [blame] | 117 | enumerations: |
| 118 | - name: RejectionReason |
| 119 | description: > |
| 120 | The reason the PEL was rejected |
| 121 | values: |
| 122 | - name: BadPEL |
| 123 | description: > |
| 124 | The PEL was malformed. |
| 125 | - name: HostFull |
| 126 | description: > |
| 127 | The host does not have room for more PELs at this time. |
| 128 | |