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

1 files changed, 28 insertions, 0 deletions

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