Documentation for eSEL conversion
Resolves openbmc/openbmc-test-automation#1383
Change-Id: I015e81ad93c7aa178ef39fba4678f23368c330a3
Signed-off-by: George Keishing <gkeishin@in.ibm.com>
diff --git a/Tools.md b/Tools.md
index ae1ac93..260e2ec 100644
--- a/Tools.md
+++ b/Tools.md
@@ -5,6 +5,53 @@
HTX is a suite of test tools for stressing system hardware. It is routinely
used by the test suites under `systest/`. Refer to [README](https://github.com/open-power/HTX)
+* SEL to error log conversion procedure:
+
+ Pre-requisite: A Power Linux system is required to build the tools.
+
+ ** Obtaining SEL parser tools: **
+ - Go to https://openpower.xyz/job/openpower-op-build/
+ - Click the link for the BMC system of interest (e.g. witherspoon)
+ - Click the "host_fw_debug.tar" link in order to download the tar file.
+ - On your Power Linux system, untar the file with the following command:
+ ```
+ $ tar -xvf host_fw_debug.tar
+ ```
+
+ - Run the following to rename the untarred files:
+ ```
+ $ for file_name in host_fw_debug* ; do mv $file_name ${file_name#host_fw_debug} ; done
+ ```
+
+ The files of interest are as follows:
+ eSEL.pl
+ hbotStringFile
+ hbicore.syms
+
+ An error log binary parser is also required:
+ - Go to https://sourceforge.net/projects/linux-diag/files/ppc64-diag/
+ - Download the latest release version of the source tar zipped.
+ - Extract the tarball and compile. Refer to README in the source.
+ - On successful compilation, get `opal-elog-parse` binary.
+
+ **Generating error log from SEL binary data:**
+
+ Run the following command:
+
+ Create a directory and copy all the required binaries and script.
+
+ ```
+ $ export PATH=$PATH:<path to directory>
+ ```
+
+ ```
+ $ eSEL.pl -l SEL_data -p decode_obmc_data --op
+ ```
+ where `SEL_data` is the file containing SEL binary data and option "--op"
+ will refer "opal-elog-parse" instead or errl.
+
+ This command will generate a SEL_data.txt file.
+
**This document describes the tools available in the /tools directory.**