openpower-pels/registry/README.md

4 phosphor-logging using a message registry that provides the PEL related fields.
15 A component ID is a 2 byte value of the form 0xYY00 used in a PEL to:
19 2. Reside in the section header of the Private Header PEL section to specify the
33 [here](O_component_ids.json). That file can used by PEL parsers to display a
48 OpenBMC event log that the PEL is being created from.
56 This field is part of the PEL User Header section, and is used to specify the
58 PEL value. If the subsystem isn't known ahead of time, it can be passed in at
59 the time of PEL creation using the 'PEL_SUBSYSTEM' AdditionalData field. In this
79 This field is part of the PEL User Header section, and is used to specify the
80 PEL severity. It is an optional field, if it isn't specified, then the severity
81 of the OpenBMC event log will be converted into a PEL severity value.
119 This field is part of the PEL User Header section, and is used to specify the
120 event scope, as defined by the PEL spec. It is optional and defaults to "entire
129 This field is part of the PEL User Header section, and is used to specify the
130 event type, as defined by the PEL spec. It is optional and defaults to "not
140 This field is part of the PEL User Header section, and is used to specify the
141 PEL action flags, as defined by the PEL spec. It is an array of enumerations.
143 The action flags can usually be deduced from other PEL fields, such as the
166 This is the component ID of the PEL creator, in the form 0xYY00. For `BD` SRCs,
178 the 8 character ASCII string field of the PEL. The allowed types are `BD`, for
185 - BB = PEL subsystem as mentioned above
207 The symptom ID is in the Extended User Header section and is defined in the PEL
223 In a PEL, these SRC words are free format and can be filled in by the user as
228 words will be set to zero in the PEL.
257 This is used to indicate the PEL is for a hardware checkstop, and causes bit 0
266 The documentation fields are used by PEL parsers to display a human readable
267 description of a PEL. They are also the source for the Redfish event log
272 This field is used by the BMC's PEL parser as the description of the error log.
300 generate a Redfish message entry, but is not used in Redfish or PEL output.
321 The callout fields allow one to specify the PEL callouts (either a hardware FRU,
324 AdditionalData property field. Callouts will be added to the PEL in the order
326 CALLOUT_INVENTORY_PATH, then that callout will be added to the PEL before the
329 There is room for up to 10 callouts in a PEL.
573 The PEL daemon can be told to capture pieces of the journal in PEL UserData
610 If a UserData section would make the PEL exceed its maximum size of 16KB, it
645    3. Check the PEL that was created using peltool.