diff options
| author | Matt Spinler <spinler@us.ibm.com> | 2019-06-18 16:24:05 -0500 |
|---|---|---|
| committer | Matt Spinler <spinler@us.ibm.com> | 2019-07-19 16:09:51 +0000 |
| commit | 3210a9f31e1fd5fbf37a33062ebb6844de6a178d (patch) | |
| tree | f8b1ee29dea3888c4a4483001b2bb5ae7f793f20 | |
| parent | 8ebfd3124c2e5312e09208ec03e740c56ff76723 (diff) | |
| download | phosphor-logging-3210a9f31e1fd5fbf37a33062ebb6844de6a178d.tar.gz phosphor-logging-3210a9f31e1fd5fbf37a33062ebb6844de6a178d.zip | |
Add initial OpenPower PEL specific documentation
Add a markdown file just for PEL specific documentation
starting with how to specify a raw PEL in an OpenBMC event log.
Signed-off-by: Matt Spinler <spinler@us.ibm.com>
Change-Id: I5bde74b3f271e334dc77f42fd38ca1fef84bd29a
| -rw-r--r-- | README.md | 12 | ||||
| -rw-r--r-- | extensions/openpower-pels/README.md | 28 |
2 files changed, 38 insertions, 2 deletions
@@ -242,6 +242,9 @@ PACKAGECONFIG_remove_class-target = "install_error_yaml" #### Local build * During local build use --prefix=/usr for the configure script. +**Reference** +* https://github.com/openbmc/openpower-debug-collector/blob/master/README.md + ## Event Log Extensions The extension concept is a way to allow code that creates other formats of @@ -338,6 +341,11 @@ void fooRemove(uint32_t id) REGISTER_EXTENSION_FUNCTION(fooRemove); ``` +### Extension List -**Reference** -* https://github.com/openbmc/openpower-debug-collector/blob/master/README.md +The supported extensions are: + +* OpenPower PELs + * Enabled with --enable-openpower-pel-extension + * Detailed information can be found + [here](extensions/openpower-pels/README.md) diff --git a/extensions/openpower-pels/README.md b/extensions/openpower-pels/README.md new file mode 100644 index 0000000..5fb5e8e --- /dev/null +++ b/extensions/openpower-pels/README.md @@ -0,0 +1,28 @@ +# OpenPower Platform Event Log (PEL) extension + +This extension will create PELs for every OpenBMC event log. It is also +possible to point to the raw PEL to use in the OpenBMC event, and then that +will be used instead of creating one. + +## Passing PEL related data within an OpenBMC event log + +An error log creator can pass in data that is relevant to a PEL by using +certain keywords in the AdditionalData property of the event log. + +### AdditionalData keywords + +#### RAWPEL + +This keyword is used to point to an existing PEL in a binary file that should +be associated with this event log. The syntax is: +``` +RAWPEL=<path to PEL File> +e.g. +RAWPEL="/tmp/pels/pel.5" +``` +The code will assign its own error log ID to this PEL, and also update the +commit timestamp field to the current time. + +## The PEL Message Registry + +## D-Bus Interfaces |

