extensions/openpower-pels/README.md

1 # OpenPower Platform Event Log (PEL) extension
4 to point to the raw PEL to use in the OpenBMC event, and then that will be used
11 - [The PEL Message Registry](#the-pel-message-registry)
15 - [PEL Retention](#pel-retention)
16 - [Adding python3 modules for PEL UserData and SRC parsing](#adding-python3-modules-for-pel-userdat…
19 - [PEL Archiving](#pel-archiving)
22 ## Passing PEL related data within an OpenBMC event log
24 An error log creator can pass in data that is relevant to a PEL by using certain
31 This keyword is used to point to an existing PEL in a binary file that should be
35 RAWPEL=<path to PEL File>
40 The code will assign its own error log ID to this PEL, and also update the
45 This keyword is used to set the power fault bit in PEL. The syntax is:
57 This is used when the passed in event log severity determines the PEL severity
58 and a more granular PEL severity is needed beyond what the normal event log to
59 PEL severity conversion could give.
75 This keyword's data contains a full PEL in string format. This is how hostboot
76 sends down PELs when it is configured in IPMI communication mode. The PEL is
77 handled just like the PEL obtained using the RAWPEL keyword.
86 Note that there are 16 bytes of IPMI SEL data before the PEL data starts.
93 `Create` API wishes to have their PID captured in the PEL this should be used.
95 This will be added to the PEL in a section of type User Data (UD), along with
140 ### FFDC Intended For UserData PEL sections
142 When one needs to add FFDC into the PEL UserData sections, the
145 of files to store in the PEL UserData sections.
191 Upon receiving this data, the PEL code will create UserData sections for each
207 the PEL size will remain under the maximum size of 16KB. If not, the UserData
213 PEL:
224 ## The PEL Message Registry
226 The PEL message registry is used to create PELs from OpenBMC event logs.
232 be from zero to ten of them in each PEL, where they are located in the SRC
235 There are a few different ways to add callouts to a PEL. In all cases, the
236 callouts will be sorted from highest to lowest priority within the PEL after
241 The PEL code can add callouts based on the values of special entries in the
247   inventory path. When the PEL code sees this, it will create a single FRU
266   usually detected by a failure accessing a device at that sysfs path. The PEL
295 Callouts can be completely defined inside that error's definition in the PEL
312 then the PEL code will first add the callouts stemming from the CALLOUT items,
317 Multiple callouts can be passed in by the creator at the time of PEL creation.
320 added into a PEL UserData section for debug.
340 away as there is no room for them in the PEL. The format looks like:
375 path, and priority. Even though the PEL code doesn't do any guarding or
377 there are status bits in the PEL to reflect them. The Guarded and Deconfigured
381 When the inventory path of a sub-FRU is passed in, the PEL code will put the
428 characters of the Procedure field will be used by the PEL.
440 PEL.
458 The `Action Flags` and `Event Type` PEL fields are optional in the message
460 out in the PEL spec.
486 See the org.open_power.Logging.PEL interface definition for the most up to date
489 ## PEL Retention
491 The PEL repository is allocated a set amount of space on the BMC. When that
494 number of PELs allowed. Note that removing a PEL will also remove the
500 PEL has been added and the method to create the PEL has returned to the caller,
538 ## Adding python3 modules for PEL UserData and SRC parsing
540 In order to support python3 modules for the parsing of PEL User Data sections
670 PEL infrastructure provides support to process SBE FFDC packets created by FAPI
676 CreatePELWithFFDCFiles D-Bus method on the `org.open_power.Logging.PEL`
708 ## PEL Archiving
710 When an OpenBMC event log is deleted its corresponding PEL is moved to an
720 - Archived PEL logs can be viewed using peltool with flag --archive.
721 - If a PEL is deleted using peltool its not archived.
737 To handle this, the PEL daemon will watch the inventory D-Bus objects that have
742 that location code in the callout list and clear the deconfig flag in the PEL.