Tools for delivering SRC descriptions to PUBs

Change-Id: I1e909145a28c4cce750baee5d79f8f1672235ba9
RTC: 106255
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/12841
Tested-by: Jenkins Server
Reviewed-by: Corey V. Swenson <cswenson@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>

18 files changed, 257 insertions, 93 deletions

diff --git a/src/build/mkrules/dist.targets.mk b/src/build/mkrules/dist.targets.mk
index 03f63730d..310f2db9f 100644
--- a/src/build/mkrules/dist.targets.mk
+++ b/src/build/mkrules/dist.targets.mk
@@ -5,7 +5,9 @@
 #
 # OpenPOWER HostBoot Project
 #
-# COPYRIGHT International Business Machines Corp. 2012,2014
+# Contributors Listed Below - COPYRIGHT 2013,2014
+# [+] International Business Machines Corp.
+#
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -224,7 +226,8 @@ fsp.tar_CONTENTS = \
     $(addsuffix :plugins/,\
         $(call ROOTPATH_WILDCARD,src/usr/*/plugins/*)) \
     src/build/debug/fsp-memdump.sh:src/build/debug/ \
-    obj/genfiles/hbfw_term_rc.H
+    obj/genfiles/hbfw_term_rc.H \
+    obj/genfiles/srcListing
 
 #
 # Portions of the FSP sandbox which must be rebuilt based on file changes.
diff --git a/src/include/usr/errl/hberrltypes.H b/src/include/usr/errl/hberrltypes.H
index 9d137f676..94e3722a8 100644
--- a/src/include/usr/errl/hberrltypes.H
+++ b/src/include/usr/errl/hberrltypes.H
@@ -5,7 +5,9 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* COPYRIGHT International Business Machines Corp. 2011,2014              */
+/* Contributors Listed Below - COPYRIGHT 2012,2014                        */
+/* [+] International Business Machines Corp.                              */
+/*                                                                        */
 /*                                                                        */
 /* Licensed under the Apache License, Version 2.0 (the "License");        */
 /* you may not use this file except in compliance with the License.       */
@@ -228,15 +230,20 @@ enum srcType_t
  *
  * Refer to errentry.H and src/epub/fsp/epub_service_codes.H
  * in fips code.
+ *
+ * @note This enum is parsed by genErrlParsers.pl and requires the subsystem
+ *       name to start with EPUB_  and the value to start with 0x followed by
+ *       exactly two hex digits and a comma. Subsystems that have their SRCs
+ *       published separately (e.g. PRD) are marked as //@PUB_IGNORE
  */
 enum epubSubSystem_t
 {
-    EPUB_RESERVED_0                 = 0x00,
+    EPUB_RESERVED_0                 = 0x00, //@PUB_IGNORE
 
     // Processor subsystem
     EPUB_PROCESSOR_SUBSYS           = 0x10,
-    EPUB_PROCESSOR_FRU              = 0x11,
-    EPUB_PROCESSOR_CHIP_CACHE       = 0x12,
+    EPUB_PROCESSOR_FRU              = 0x11, //@PUB_IGNORE
+    EPUB_PROCESSOR_CHIP_CACHE       = 0x12, //@PUB_IGNORE
     EPUB_PROCESSOR_UNIT             = 0x13,
     EPUB_PROCESSOR_BUS_CTL          = 0x14,
 
@@ -245,20 +252,15 @@ enum epubSubSystem_t
     EPUB_MEMORY_CONTROLLER          = 0x21,
     EPUB_MEMORY_BUS                 = 0x22,
     EPUB_MEMORY_DIMM                = 0x23,
-    EPUB_MEMORY_FRU                 = 0x24,
-    EPUB_EXTERNAL_CACHE             = 0x25,
-
-    // I/O Subsystem: hub
-    EPUB_IO_HUB                     = 0x31,
+    EPUB_MEMORY_FRU                 = 0x24, //@PUB_IGNORE
+    EPUB_EXTERNAL_CACHE             = 0x25, //@PUB_IGNORE
 
     // CEC Hardware
     EPUB_CEC_HDW_SUBSYS             = 0x50,
     EPUB_CEC_HDW_VPD_INTF           = 0x55,
     EPUB_CEC_HDW_I2C_DEVS           = 0x56,
-    EPUB_CEC_HDW_JTAG               = 0x57,
-    EPUB_CEC_HDW_CHIP_INTF          = 0x57,  // includes JTAG, FSI, etc.
+    EPUB_CEC_HDW_CHIP_INTF          = 0x57, // includes JTAG, FSI, etc.
     EPUB_CEC_HDW_CLK_CTL            = 0x58,
-    EPUB_CEC_HDW_OP_PANEL           = 0x59,
     EPUB_CEC_HDW_TOD_HDW            = 0x5A,
     EPUB_CEC_HDW_SP_PHYP_INTF       = 0x5C,
 
@@ -267,18 +269,17 @@ enum epubSubSystem_t
 
     // Others
     EPUB_MISC_SUBSYS                = 0x70,
-    EPUB_MISC_TEST_TOOL             = 0x72,
-    EPUB_MISC_MULTIPLE_SUBSYS       = 0x74,
-    EPUB_MISC_UNKNOWN               = 0x75,
-    EPUB_MISC_INFORMATIONAL         = 0x76,
+    EPUB_MISC_TEST_TOOL             = 0x72, //@PUB_IGNORE
+    EPUB_MISC_MULTIPLE_SUBSYS       = 0x74, //@PUB_IGNORE
+    EPUB_MISC_UNKNOWN               = 0x75, //@PUB_IGNORE
+    EPUB_MISC_INFORMATIONAL         = 0x76, //@PUB_IGNORE
 
     // Platform Firmware
-    EPUB_FIRMWARE_SUBSYS            = 0x80,
+    EPUB_FIRMWARE_SUBSYS            = 0x80, //@PUB_IGNORE
     EPUB_FIRMWARE_SP                = 0x81,
     EPUB_FIRMWARE_PHYP              = 0x82,
 
     EPUB_FIRMWARE_HOSTBOOT          = 0x8A,
-    EPUB_FIRMWARE_OCC               = 0x8B,
     EPUB_UNKNOWN                    = 0xFF,
 };
 
diff --git a/src/include/usr/hwpf/hwpf_reasoncodes.H b/src/include/usr/hwpf/hwpf_reasoncodes.H
index d700cf857..24eb3ee33 100644
--- a/src/include/usr/hwpf/hwpf_reasoncodes.H
+++ b/src/include/usr/hwpf/hwpf_reasoncodes.H
@@ -145,6 +145,9 @@ namespace fapi
  * @moduleid     MOD_FAPI_RC_TO_ERRL
  * @reasoncode   RC_INVALID_ATTR_GET
  * @devdesc      InitFile HW Procedure requested an invalid attribute
+ * @custdesc     A problem was detected during the IPL of the system:
+ *               A hardware initialization procedure requested an invalid
+ *               attribute.
  */
 /*@
  * @errortype
diff --git a/src/usr/errl/parser/genErrlParsers.pl b/src/usr/errl/parser/genErrlParsers.pl
index a14c5c111..626b6b763 100755
--- a/src/usr/errl/parser/genErrlParsers.pl
+++ b/src/usr/errl/parser/genErrlParsers.pl
@@ -6,7 +6,9 @@
 #
 # OpenPOWER HostBoot Project
 #
-# COPYRIGHT International Business Machines Corp. 2013,2014
+# Contributors Listed Below - COPYRIGHT 2013,2014
+# [+] International Business Machines Corp.
+#
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -76,6 +78,7 @@ my $compIncPath = $base."/src/include/usr";
 my $genFilesPath = $base."/obj/genfiles";
 my $hbfwTermRcFile = $genFilesPath."/hbfw_term_rc.H";
 my $srcFileName = $genFilesPath."/srcListing";
+my $errlTypes = $compIncPath."/errl/hberrltypes.H";
 #------------------------------------------------------------------------------
 # Call subroutines to populate the following arrays:
 # - @reasonCodeFiles   (The list of files to parse through for reason codes)
@@ -639,8 +642,8 @@ foreach my $file (@filesToParse)
                 }
                 elsif ($line =~ /\@custdesc\s+(\S+.*)/i)
                 {
-                    # Found a customer description. Strip out any double-quotes
-                    # and trailing whitespace
+                    # Found a customer description. Strip out any
+                    # double-quotes and trailing whitespace
                     $cdesc = $1;
                     $cdesc =~ s/\"//g;
                     $cdesc =~ s/\s+$//;
@@ -657,8 +660,9 @@ foreach my $file (@filesToParse)
                             last;
                         }
 
-                        # Continuation of description, strip out any double-
-                        # quotes and leading / trailing whitespace
+                        # Continuation of description, strip out any
+                        # double-quotes and leading / trailing
+                        # whitespace
                         $line =~ s/^.+\*\s+//;
                         $line =~ s/\"//g;
                         $line =~ s/\s+$//;
@@ -701,11 +705,15 @@ foreach my $file (@filesToParse)
                 . " an error was encountered: $desc";
             }
 
-            # SRC list - eliminate dups
-            my $srcText = sprintf("%04X", hex($rcValue));
-            if($srcList{$srcText} eq "")
+            # SRC list - Don't add testcase SRCs
+            if(not $file =~ /\/test\//)
             {
-                $srcList{$srcText} .= $cdesc;
+                my $srcText = sprintf("%04X", hex($rcValue));
+                # eliminate dups
+                if($srcList{$srcText} eq "")
+                {
+                    $srcList{$srcText} .= $cdesc;
+                }
             }
 
             # Create the combined returncode/moduleid value that the parser looks for and
@@ -744,37 +752,103 @@ foreach my $file (@filesToParse)
     close(PARSE_FILE);
 }
 
-## all subsystems HB uses - not every combination is possible, but it makes
-#  the list of SRCs thourough.  It's not clear yet if we are going to put
-#  subsystem text in the output file or not.
-#  TODO RTC:106255  Get rid of hardcoded subsys values
-my %subsys = (
-    '10' => 'Processor',
-    '13' => 'Processor Unit',
-    '14' => 'Processor Bus',
-    '20' => 'Memory',
-    '21' => 'Memory Controller',
-    '22' => 'Memory Bus',
-    '23' => 'Memory DIMM',
-    '50' => 'Central Electronic Complex',
-    '55' => 'VPD Hardware Interface',
-    '56' => 'I2C Hardware',
-    '57' => 'Hardware Chip Interface',
-    '58' => 'Clock Controller',
-    '5A' => 'TOD Hardware',
-    '5C' => 'Service Processor to Hypervisor hardware interface',
-    '60' => 'Power',
-    '70' => 'Miscellaneous',
-    '81' => 'Service Processor Firmware',
-    '82' => 'Hypervisor Firmware',
-    '8A' => 'Hostboot Firmware');
+#------------------------------------------------------------------
+# Load the sybsystem values for the System Reference Codes (SRCs)
+#------------------------------------------------------------------
+my %subsysList;
+my $in_enum = 0;
+
+open(SUBSYSTEM_TYPES_FILE, $errlTypes) or die("Cannot open: $errlTypes: $!");
+
+while (my $line = <SUBSYSTEM_TYPES_FILE> and $in_enum lt 2)
+{
+    if($in_enum eq 0)
+    {
+        if($line =~ /^enum epubSubSystem_t/)
+        {
+            $in_enum = 1;
+        }
+    }
+    else
+    {
+        if(not $line =~/\@PUB_IGNORE/)
+        {
+            if($line =~ /^\s*EPUB_(\w+) += +0x([\dA-Fa-f]+),/)
+            {
+                my $epub_desc = $1;
+                my $epub_val = $2;
+                $subsysList{$epub_val} .= $epub_desc;
+            }
+            elsif($line =~ /.*^\}\;/)
+            {
+                $in_enum = 2;
+            }
+        }
+    }
+}
+
+close(SUBSYSTEM_TYPES_FILE);
 
+# ------------------------------------------------------------------
+# Generate a list of all possible SRCs and their descriptions
+# ------------------------------------------------------------------
 open(OFILE, ">", $srcFileName) or die ("Cannot open: $srcFileName: $!");
-foreach my $sub (sort keys %subsys)
+foreach my $sub (sort keys %subsysList)
 {
     foreach my $rcVal (sort keys %srcList)
     {
-        print OFILE "BC$sub$rcVal, $srcList{$rcVal}\n";
+        my $src = "BC$sub$rcVal";
+        print OFILE "//////////////////////////////////////////////////////\n";
+        print OFILE "/****************************************************/\n";
+        print OFILE "#define Refcode_$src 0x$src\n";
+        print OFILE "/****************************************************/\n";
+        print OFILE "\n/***** $src RCDL text starts here.\n";
+        print OFILE "\$OWNER = J.Patel\n";
+        print OFILE "\$LOCATION = Austin\n";
+        print OFILE "\$COMPONENT = FSP\n";
+        print OFILE "\$MODULE = NA\n";
+        print OFILE "\$TYPE = AUTO\n\n";
+        print OFILE "\@SubsystemOrProduct = FSP_SRC\n\n";
+        my $txt = "\$DESCRIPTION = $srcList{$rcVal}";
+        if(not $txt =~/.*\.$/)
+        {
+            $txt = $txt.".";
+        }
+        my @atxt = split(/ +/,$txt);
+        my $word = shift(@atxt);
+        my $line_sz = length($word);
+        print OFILE "$word";
+        while (my $word = shift(@atxt))
+        {
+            if (lc $word eq "fsp")
+            {
+                $word = "service processor";
+            }
+            elsif (lc $word eq "fsp.")
+            {
+                $word = "service processor.";
+            }
+            my $wordlen = length($word);
+            $line_sz = $line_sz + $wordlen + 1;
+            if($line_sz > 76 )
+            {
+                $line_sz = $wordlen;
+                print OFILE "\n$word";
+            }
+            else
+            {
+                print OFILE " $word";
+            }
+        }
+        print OFILE "\n\$ENDDESCRIPTION\n\n";
+        print OFILE "\$RepairAction = The FRU callouts are calculated at the ".
+                     "time of the failure.\n";
+        print OFILE "See the error log for the actual replacement strategy.\n";
+        print OFILE "\$ENDRepairAction\n\n";
+        print OFILE "\@REPORTING_LEVEL = Call_Home\n\n\n";
+        print OFILE "   |------          Callout List          ------|\n";
+        print OFILE "   \$FRU = \$NOFRU\n\n";
+        print OFILE "*****   $src RCDL text ends here.  */\n\n\n";
     }
 }
 close(OFILE);
diff --git a/src/usr/errl/test/errluserdetailtest.H b/src/usr/errl/test/errluserdetailtest.H
index e80d038b4..714f7f0d9 100644
--- a/src/usr/errl/test/errluserdetailtest.H
+++ b/src/usr/errl/test/errluserdetailtest.H
@@ -5,7 +5,9 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* COPYRIGHT International Business Machines Corp. 2011,2014              */
+/* Contributors Listed Below - COPYRIGHT 2011,2014                        */
+/* [+] International Business Machines Corp.                              */
+/*                                                                        */
 /*                                                                        */
 /* Licensed under the Apache License, Version 2.0 (the "License");        */
 /* you may not use this file except in compliance with the License.       */
@@ -71,7 +73,8 @@ public:
         * @reasoncode ERRL_TEST_STRING_UD
         * @userdata1 Test data 1
         * @userdata2 Test data 2
-        * @devdesc  User Details unit test - create string user detail data
+        * @devdesc  User Details unit test - create string user detail data.
+        * @custdesc A problem occurred during the IPL of the system.
         */
         errl = new ErrlEntry(
                 ERRL_SEV_INFORMATIONAL,
@@ -122,7 +125,8 @@ public:
         * @reasoncode ERRL_TEST_ATTRIBUTE_UD
         * @userdata1 Test data 1
         * @userdata2 Test data 2
-        * @devdesc  User Details unit test - create string user detail data
+        * @devdesc  User Details unit test - create string user detail data.
+        * @custdesc A problem occurred during the IPL of the system.
         */
         errl = new ErrlEntry(
                 ERRL_SEV_INFORMATIONAL,
@@ -281,7 +285,9 @@ public:
         * @reasoncode ERRL_TEST_LOGREGISTER_UD
         * @userdata1 Test data 1
         * @userdata2 Test data 2
-        * @devdesc User Details unit test - create log register user detail data
+        * @devdesc User Details unit test
+        *          - create log register user detail data.
+        * @custdesc A problem occurred during the IPL of the system.
         */
         errl = new ERRORLOG::ErrlEntry(
                 ERRORLOG::ERRL_SEV_INFORMATIONAL,
diff --git a/src/usr/fsiscom/fsiscom.C b/src/usr/fsiscom/fsiscom.C
index aade95479..728f58b0b 100644
--- a/src/usr/fsiscom/fsiscom.C
+++ b/src/usr/fsiscom/fsiscom.C
@@ -5,7 +5,9 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* COPYRIGHT International Business Machines Corp. 2011,2014              */
+/* Contributors Listed Below - COPYRIGHT 2011,2014                        */
+/* [+] International Business Machines Corp.                              */
+/*                                                                        */
 /*                                                                        */
 /* Licensed under the Apache License, Version 2.0 (the "License");        */
 /* you may not use this file except in compliance with the License.       */
@@ -180,6 +182,8 @@ errlHndl_t fsiScomPerformOp(DeviceFW::OperationType i_opType,
              * @userdata1    SCOM Address
              * @userdata2    Data Length
              * @devdesc      fsiScomPerformOp> Invalid data length (!= 8 bytes)
+             * @custdesc     A problem occurred during the IPL of the system:
+             *               Invalid data length for a SCOM operation.
              */
             l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                             FSISCOM::MOD_FSISCOM_PERFORMOP,
@@ -204,6 +208,8 @@ errlHndl_t fsiScomPerformOp(DeviceFW::OperationType i_opType,
              * @userdata2    Target HUID
              * @devdesc      fsiScomPerformOp> Address contains
              *               more than 31 bits.
+             * @custdesc     A problem occurred during the IPL of the system:
+             *               Invalid address on a SCOM operation.
              */
             l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                             FSISCOM::MOD_FSISCOM_PERFORMOP,
@@ -294,6 +300,8 @@ errlHndl_t fsiScomPerformOp(DeviceFW::OperationType i_opType,
                  * @userdata2[32:63]  SCOM Status Reg
                  * @devdesc      fsiScomPerformOp> Error returned
                  *               from SCOM Engine after write
+                 * @custdesc     A problem occurred during the IPL of the system:
+                 *               Error returned from SCOM engine after write.
                  */
                 l_err = new ERRORLOG::ErrlEntry(
                                 ERRORLOG::ERRL_SEV_UNRECOVERABLE,
@@ -382,6 +390,8 @@ errlHndl_t fsiScomPerformOp(DeviceFW::OperationType i_opType,
                  * @userdata2[00:31]  Target HUID
                  * @userdata2[32:63]  SCOM Status Reg
                  * @devdesc      fsiScomPerformOp> Error returned from SCOM Engine after read.
+                 * @custdesc     A problem occurred during the IPL of the system:
+                 *               Error returned from SCOM engine after read.
                  */
                 l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                                 FSISCOM::MOD_FSISCOM_PERFORMOP,
@@ -439,6 +449,8 @@ errlHndl_t fsiScomPerformOp(DeviceFW::OperationType i_opType,
              * @userdata1[32:64]   Input scom address
              * @userdata2    Target HUID
              * @devdesc      fsiScomPerformOp> Unsupported Operation Type specified
+             * @custdesc     A problem occurred during the IPL of the system:
+             *               Unsupported SCOM operation type.
              */
             l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                             FSISCOM::MOD_FSISCOM_PERFORMOP,
diff --git a/src/usr/hwas/common/deconfigGard.C b/src/usr/hwas/common/deconfigGard.C
index c9bf12246..d3d82a141 100644
--- a/src/usr/hwas/common/deconfigGard.C
+++ b/src/usr/hwas/common/deconfigGard.C
@@ -560,8 +560,7 @@ errlHndl_t DeconfigGard::deconfigureTarget(
              * @moduleid          HWAS::MOD_DECONFIG_GARD
              * @reasoncode        HWAS::RC_TARGET_NOT_DECONFIGURABLE
              * @devdesc           Attempt to deconfigure a target that is not
-             *                    deconfigurable
-             *                    (not DECONFIG_GARDABLE or not present)
+             *                    deconfigurable or not present.
              * @userdata1[00:31]  HUID of input target
              * @userdata1[32:63]  GARD errlog EID
              * @userdata2[00:31]  ATTR_DECONFIG_GARDABLE
diff --git a/src/usr/hwas/common/hwas.C b/src/usr/hwas/common/hwas.C
index 3932bfd0b..3ac0a3ad0 100644
--- a/src/usr/hwas/common/hwas.C
+++ b/src/usr/hwas/common/hwas.C
@@ -706,6 +706,9 @@ errlHndl_t checkMinimumHardware(const TARGETING::ConstTargetHandle_t i_node)
                  * @reasoncode        RC_SYSAVAIL_NO_NODES_FUNC
                  * @devdesc           checkMinimumHardware found no functional
                  *                    nodes on the system
+                 * @custdesc          A problem occurred during the IPL of the
+                 *                    system: No functional nodes were found on
+                 *                    the system.
                  */
                 l_errl = hwasError(ERRL_SEV_UNRECOVERABLE,
                                     MOD_CHECK_MIN_HW,
@@ -770,6 +773,9 @@ errlHndl_t checkMinimumHardware(const TARGETING::ConstTargetHandle_t i_node)
              * @reasoncode        RC_SYSAVAIL_NO_PROCS_FUNC
              * @devdesc           checkMinimumHardware found no functional
              *                    master processor on this node
+             * @custdesc          A problem occurred during the IPL of the
+             *                    system: No functional master processor
+             *                    was found on this node.
              * @userdata1[00:31]  HUID of node
              * @userdata2[00:31]  number of present procs
              * @userdata2[32:63]  number of present functional non-master procs
@@ -825,6 +831,9 @@ errlHndl_t checkMinimumHardware(const TARGETING::ConstTargetHandle_t i_node)
                  * @reasoncode        RC_SYSAVAIL_NO_CORES_FUNC
                  * @devdesc           checkMinimumHardware found no functional
                  *                    processor cores on the master proc
+                 * @custdesc          A problem occurred during the IPL of the
+                 *                    system: No functional processor cores
+                 *                    were found on the master processor.
                  * @userdata1[00:31]  HUID of node
                  * @userdata1[32:63]  HUID of master proc
                  * @userdata2[00:31]  number of present, non-functional cores
@@ -884,6 +893,8 @@ errlHndl_t checkMinimumHardware(const TARGETING::ConstTargetHandle_t i_node)
              * @reasoncode        RC_SYSAVAIL_NO_MEMORY_FUNC
              * @devdesc           checkMinimumHardware found no
              *                    functional dimm cards.
+             * @custdesc          A problem occurred during the IPL of the
+             *                    system: Found no functional dimm cards.
              * @userdata1[00:31]  HUID of node
              * @userdata2[00:31]  number of present, non-functional dimms
              */
diff --git a/src/usr/hwas/common/hwasCallout.C b/src/usr/hwas/common/hwasCallout.C
index b5e1b6be2..1186fe48f 100644
--- a/src/usr/hwas/common/hwasCallout.C
+++ b/src/usr/hwas/common/hwasCallout.C
@@ -5,7 +5,9 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* COPYRIGHT International Business Machines Corp. 2012,2014              */
+/* Contributors Listed Below - COPYRIGHT 2012,2014                        */
+/* [+] International Business Machines Corp.                              */
+/*                                                                        */
 /*                                                                        */
 /* Licensed under the Apache License, Version 2.0 (the "License");        */
 /* you may not use this file except in compliance with the License.       */
@@ -74,7 +76,7 @@ bool retrieveTarget(uint8_t * & io_uData,
              * @errortype
              * @moduleid     HWAS::MOD_PROCESS_CALLOUT
              * @reasoncode   HWAS::RC_INVALID_TARGET
-             * @devdesc      Invalid Target encountered in
+             * @devdesc      Invalid target encountered in
              *               processing of HW callout
              * @userdata1    callout errlog PLID
              */
diff --git a/src/usr/hwas/hwasPlatDeconfigGard.C b/src/usr/hwas/hwasPlatDeconfigGard.C
index 9438b042d..912f7d410 100644
--- a/src/usr/hwas/hwasPlatDeconfigGard.C
+++ b/src/usr/hwas/hwasPlatDeconfigGard.C
@@ -225,6 +225,9 @@ errlHndl_t DeconfigGard::platCreateGardRecord(
              * @devdesc      Attempt to create a GARD Record for a target that
              *               is not GARDable
              *               (not DECONFIG_GARDABLE or not present)
+             * @custdesc     A problem occurred during the IPL of the system.
+             *               Attempt to create a deconfiguration record for a
+             *               target that is not deconfigurable or not present.
              * @userdata1    HUID of input target // GARD errlog EID
              * @userdata2    ATTR_DECONFIG_GARDABLE // ATTR_HWAS_STATE.present
              */
@@ -340,6 +343,9 @@ errlHndl_t DeconfigGard::platCreateGardRecord(
              * @reasoncode   HWAS::RC_GARD_REPOSITORY_FULL
              * @devdesc      Attempt to create a GARD Record and the GARD
              *               Repository is full
+             * @custdesc     A problem occurred during the IPL of the system.
+             *               Attempt to create a deconfiguration record for a
+             *               target, but the deconfiguration repository is full.
              * @userdata1    HUID of input target // GARD errlog EID
              */
             const uint64_t userdata1 =
diff --git a/src/usr/hwpf/plat/fapiPlatSystemConfig.C b/src/usr/hwpf/plat/fapiPlatSystemConfig.C
index 22f03e98f..0ba70b916 100644
--- a/src/usr/hwpf/plat/fapiPlatSystemConfig.C
+++ b/src/usr/hwpf/plat/fapiPlatSystemConfig.C
@@ -97,6 +97,7 @@ fapi::ReturnCode fapiGetOtherSideOfMemChannel(
              * @userdata2    MCS HUID
              * @devdesc      fapiGetOtherSideOfMemChannel could not find exactly
              *               one target on the other side of the correct state
+             * @custdesc  A problem occurrred during the IPL of the system.
              */
             const bool hbSwError = true;
             errlHndl_t l_pError = new ERRORLOG::ErrlEntry(
@@ -136,6 +137,7 @@ fapi::ReturnCode fapiGetOtherSideOfMemChannel(
              * @userdata2    Membuf HUID
              * @devdesc      fapiGetOtherSideOfMemChannel could not find exactly
              *               one target on the other side of the correct state
+             * @custdesc  A problem occurrred during the IPL of the system.
              */
             const bool hbSwError = true;
             errlHndl_t l_pError = new ERRORLOG::ErrlEntry(
@@ -168,6 +170,8 @@ fapi::ReturnCode fapiGetOtherSideOfMemChannel(
          * @userdata2    Unsupported Target HUID
          * @devdesc      fapiGetOtherSideOfMemChannel request for unsupported
          *               or invalid target type
+         * @custdesc  A problem occurrred during the IPL of the system: Request
+         *            for unsupported or invalid target type.
          */
         const bool hbSwError = true;
         errlHndl_t l_pError = new ERRORLOG::ErrlEntry(
@@ -199,6 +203,8 @@ fapi::ReturnCode fapiGetOtherSideOfMemChannel(
             * @userdata2    Other Target HUID
             * @devdesc      fapiGetOtherSideOfMemChannel target not present or
             *               functional as requested
+            * @custdesc     A problem occurred during the IPL of the system:
+            *               Requested target not present or not functional.
             */
            const bool hbSwError = true;
            errlHndl_t l_pError = new ERRORLOG::ErrlEntry(
@@ -252,6 +258,7 @@ fapi::ReturnCode fapiGetChildChiplets(
          * @userdata1    Type of input target
          * @userdata2    Input Target HUID
          * @devdesc      fapiGetChildChiplets request for non-chip
+         * @custdesc     A problem occurred during the IPL of the system.
          */
         const bool hbSwError = true;
         errlHndl_t l_pError = new ERRORLOG::ErrlEntry(
@@ -305,6 +312,8 @@ fapi::ReturnCode fapiGetChildChiplets(
              * @userdata2    Input Chip Target HUID
              * @devdesc      fapiGetChildChiplets request for unsupported
              *               or invalid chiplet type
+            * @custdesc     A problem occurred during the IPL of the system:
+            *               Request for an unsupported or invalid chiplet type.
              */
             const bool hbSwError = true;
             errlHndl_t l_pError = new ERRORLOG::ErrlEntry(
@@ -481,6 +490,7 @@ fapi::ReturnCode fapiGetParentChip(
          * @userdata1    Type of input target
          * @userdata2    Input Target HUID
          * @devdesc      fapiGetParentChip request for non-chiplet
+         * @custdesc     A problem occurred during the IPL of the system.
          */
         const bool hbSwError = true;
         errlHndl_t l_pError = new ERRORLOG::ErrlEntry(
@@ -528,6 +538,7 @@ fapi::ReturnCode fapiGetParentChip(
                  * @reasoncode   fapi::RC_NO_SINGLE_PARENT
                  * @userdata1    Input Chiplet Target HUID
                  * @devdesc      fapiGetParentChip did not find one parent
+                 * @custdesc     A problem occurred during the IPL of the system.
                  */
                 const bool hbSwError = true;
                 errlHndl_t l_pError = new ERRORLOG::ErrlEntry(
diff --git a/src/usr/i2c/eepromdd.C b/src/usr/i2c/eepromdd.C
index 5507b9e4e..b913665e9 100755
--- a/src/usr/i2c/eepromdd.C
+++ b/src/usr/i2c/eepromdd.C
@@ -5,7 +5,9 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* COPYRIGHT International Business Machines Corp. 2011,2014              */
+/* Contributors Listed Below - COPYRIGHT 2011,2014                        */
+/* [+] International Business Machines Corp.                              */
+/*                                                                        */
 /*                                                                        */
 /* Licensed under the Apache License, Version 2.0 (the "License");        */
 /* you may not use this file except in compliance with the License.       */
@@ -162,6 +164,8 @@ errlHndl_t eepromPerformOp( DeviceFW::OperationType i_opType,
              * @userdata1[32:63] Buffer Length
              * @userdata2        Device Max Size (in KB)
              * @devdesc          I2C Buffer Length + Offset > Max Size
+             * @custdesc         A problem occurred during the IPL of the
+             *                   system: I2C buffer offset is too large.
              */
             err = new ERRORLOG::ErrlEntry( ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                            EEPROM_PERFORM_OP,
@@ -217,7 +221,7 @@ errlHndl_t eepromPerformOp( DeviceFW::OperationType i_opType,
              * @moduleid       EEPROM_PERFORM_OP
              * @userdata1      Operation Type
              * @userdata2      Chip to Access
-             * @devdesc        Invalid Operation type.
+             * @devdesc        Invalid operation type.
              */
             err = new ERRORLOG::ErrlEntry( ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                            EEPROM_PERFORM_OP,
@@ -835,6 +839,8 @@ errlHndl_t eepromPrepareAddress ( void * io_buffer,
                  * @userdata1        Address Size (aka Device Type)
                  * @userdata2        EEPROM chip
                  * @devdesc          The Device type not supported (addrSize)
+                 * @custdesc         A problem was detected during the IPL of
+                 *                   the system: Device type not supported.
                  */
                 err = new ERRORLOG::ErrlEntry( ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                                EEPROM_PREPAREADDRESS,
@@ -965,7 +971,7 @@ errlHndl_t eepromReadAttributes ( TARGETING::Target * i_target,
                  * @moduleid         EEPROM_READATTRIBUTES
                  * @userdata1        HUID of target
                  * @userdata2        EEPROM chip
-                 * @devdesc          EEPROM Attribute was not found
+                 * @devdesc          EEPROM attribute was not found
                  */
                 err = new ERRORLOG::ErrlEntry(
                                     ERRORLOG::ERRL_SEV_UNRECOVERABLE,
@@ -1022,7 +1028,7 @@ errlHndl_t eepromReadAttributes ( TARGETING::Target * i_target,
                  * @moduleid         EEPROM_READATTRIBUTES
                  * @userdata1        HUID of target
                  * @userdata2        Address Offset Size
-                 * @devdesc          Invalid Address Offset Size
+                 * @devdesc          Invalid address offset size
                  */
                 err = new ERRORLOG::ErrlEntry(
                                     ERRORLOG::ERRL_SEV_UNRECOVERABLE,
@@ -1099,7 +1105,7 @@ errlHndl_t eepromGetI2CMasterTarget ( TARGETING::Target * i_target,
                  * @moduleid         EEPROM_GETI2CMASTERTARGET
                  * @userdata1        Attribute Chip Type Enum
                  * @userdata2        HUID of target
-                 * @devdesc          DIMM I2C Master Entity path doesn't exist.
+                 * @devdesc          DIMM I2C master entity path doesn't exist.
                  */
                 err = new ERRORLOG::ErrlEntry(
                                     ERRORLOG::ERRL_SEV_UNRECOVERABLE,
@@ -1130,7 +1136,7 @@ errlHndl_t eepromGetI2CMasterTarget ( TARGETING::Target * i_target,
                  * @moduleid         EEPROM_GETI2CMASTERTARGET
                  * @userdata1        Attribute Chip Type Enum
                  * @userdata2        HUID of target
-                 * @devdesc          I2C Master Path Target is NULL.
+                 * @devdesc          I2C master path target is null.
                  */
                 err = new ERRORLOG::ErrlEntry( ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                                EEPROM_GETI2CMASTERTARGET,
diff --git a/src/usr/i2c/i2c.C b/src/usr/i2c/i2c.C
index 65911271f..b3a723e44 100755
--- a/src/usr/i2c/i2c.C
+++ b/src/usr/i2c/i2c.C
@@ -5,7 +5,9 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* COPYRIGHT International Business Machines Corp. 2011,2014              */
+/* Contributors Listed Below - COPYRIGHT 2011,2014                        */
+/* [+] International Business Machines Corp.                              */
+/*                                                                        */
 /*                                                                        */
 /* Licensed under the Apache License, Version 2.0 (the "License");        */
 /* you may not use this file except in compliance with the License.       */
@@ -190,7 +192,7 @@ errlHndl_t i2cPerformOp( DeviceFW::OperationType i_opType,
              * @userdata1      Operation Type requested
              * @userdata2      <UNUSED>
              * @devdesc        Master Sentinel chip was used as a target for an
-             *                 I2C operation.  This is NOT permitted.
+             *                 I2C operation.  This is not permitted.
              */
             err = new ERRORLOG::ErrlEntry( ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                            I2C_PERFORM_OP,
@@ -379,7 +381,7 @@ errlHndl_t i2cPerformOp( DeviceFW::OperationType i_opType,
              * @userdata2[16:31] Master Port
              * @userdata2[32:47] Master Engine
              * @userdata2[48:63] Slave Device Address
-             * @devdesc          Invalid Operation type.
+             * @devdesc          Invalid operation type.
              */
             err = new ERRORLOG::ErrlEntry( ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                            I2C_PERFORM_OP,
@@ -1085,9 +1087,12 @@ errlHndl_t i2cCheckForErrors ( TARGETING::Target * i_target,
              * @severity       ERRL_SEV_UNRECOVERABLE
              * @moduleid       I2C_CHECK_FOR_ERRORS
              * @userdata1      Status Register Value
-             * @userdata2      Interrupt Register Value (only valid in Interrupt case)
-             * @devdesc        Error was found in I2C status register.  Check userdata1
-             *                 to determine what the error was.
+             * @userdata2      Interrupt Register Value (only valid in
+             *                 Interrupt case)
+             * @devdesc        Error was found in I2C status register.
+             *                 Check userdata1 to determine what the error was.
+             * @custdesc       A problem occurred during the IPL of the system:
+             *                 An error was found in the I2C status register.
              */
             err = new ERRORLOG::ErrlEntry( ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                            I2C_CHECK_FOR_ERRORS,
@@ -1127,6 +1132,8 @@ errlHndl_t i2cCheckForErrors ( TARGETING::Target * i_target,
              * @userdata2      Interrupt Register Value
              * @devdesc        Error was found in I2C status register.  Check
              *                 userdata1 to determine what the error was.
+             * @custdesc       A problem occurred during the IPL of the system:
+             *                 An error was found in the I2C status register.
              */
             err = new ERRORLOG::ErrlEntry( ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                            I2C_CHECK_FOR_ERRORS,
diff --git a/src/usr/targeting/attrrp.C b/src/usr/targeting/attrrp.C
index de11879b9..4b5ea6baf 100644
--- a/src/usr/targeting/attrrp.C
+++ b/src/usr/targeting/attrrp.C
@@ -5,7 +5,9 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* COPYRIGHT International Business Machines Corp. 2011,2014              */
+/* Contributors Listed Below - COPYRIGHT 2011,2014                        */
+/* [+] International Business Machines Corp.                              */
+/*                                                                        */
 /*                                                                        */
 /* Licensed under the Apache License, Version 2.0 (the "License");        */
 /* you may not use this file except in compliance with the License.       */
@@ -221,7 +223,7 @@ namespace TARGETING
                  *   @userdata1         Virtual Address
                  *   @userdata2         (Msg Type << 32) | Section #
                  *
-                 *   @devdesc   The Attribute Resource Provider was unable to
+                 *   @devdesc   The attribute resource provider was unable to
                  *              satisfy a message request from the VMM portion
                  *              of the kernel.  This was either due to an
                  *              address outside a valid range or a message
@@ -282,7 +284,13 @@ namespace TARGETING
                  *              PNOR_TARG_EYE_CATCHER and therefore the
                  *              contents of the Attribute PNOR section are
                  *              unable to be parsed.
-                 */
+                 *   @custdesc  A problem occurred during the IPL of the
+                 *              system.
+                 *              The eyecatch value observed in memory does not
+                 *              match the expected value and therefore the
+                 *              contents of the attribute sections are unable
+                 *              to be parsed.
+                */
                 l_errl = new ErrlEntry(ERRL_SEV_UNRECOVERABLE,
                                        TARG_MOD_ATTRRP,
                                        TARG_RC_BAD_EYECATCH,
diff --git a/src/usr/targeting/attrsync.C b/src/usr/targeting/attrsync.C
index dbefa328f..738285932 100644
--- a/src/usr/targeting/attrsync.C
+++ b/src/usr/targeting/attrsync.C
@@ -277,8 +277,8 @@ namespace TARGETING
                          *   @reasoncode    TARG_RC_ATTR_SYNC_TO_HB_FAIL
                          *   @userdata1     return code
                          *   @userdata2     section to sync
-                         *   @devdesc       The Attribute synchronization from FSP
-                         *                  failed.
+                         *   @devdesc       The attribute synchronization from
+                         *                  the FSP failed.
                          */
                          l_errl = new ErrlEntry(ERRL_SEV_UNRECOVERABLE,
                                                 TARG_MOD_ATTR_SYNC,
@@ -363,7 +363,7 @@ namespace TARGETING
                  *   @userdata1     return code from FSP attribute sync
                  *   @userdata2     section ID of for section being sync'd
                  *
-                 *   @devdesc       The Attribute synchronization code on the
+                 *   @devdesc       The attribute synchronization code on the
                  *                  FSP side was unable to complete the sync
                  *                  operation successfully.
                  */
@@ -415,9 +415,9 @@ namespace TARGETING
                  *   @reasoncode    TARG_RC_ATTR_SYNC_REQUEST_TO_HB_FAIL
                  *   @userdata1     return code from FSP
                  *   @userdata2     section to sync
-                 *   @devdesc       The Attribute synchronization code on the
+                 *   @devdesc       The attribute synchronization code on the
                  *                  FSP side was unable to fulfill the sync to
-                 *                  HB request.
+                 *                  HostBoot request.
                  */
                  l_err = new ErrlEntry(ERRL_SEV_UNRECOVERABLE,
                                        TARG_MOD_ATTR_SYNC,
diff --git a/src/usr/targeting/common/targetservice.C b/src/usr/targeting/common/targetservice.C
index 270c0bc13..d7b512d30 100644
--- a/src/usr/targeting/common/targetservice.C
+++ b/src/usr/targeting/common/targetservice.C
@@ -752,8 +752,8 @@ errlHndl_t TargetService::queryMasterProcChipTargetHandle(
          * @moduleid   TARG_MOD_QUERY_MASTER_PROC_CHIP
          * @reasoncode TARG_RC_INVALID_NODE
          * @userData1  HUID of Target Passed
-         * @devdesc    Error: User Passed an invalid Node Target to find the
-         * master proc handle
+         * @devdesc    The caller passed an invalid node target to find the
+         *             master proc handle.
          */
         UTIL::createTracingError(
             TARG_MOD_QUERY_MASTER_PROC_CHIP,
@@ -777,8 +777,8 @@ errlHndl_t TargetService::queryMasterProcChipTargetHandle(
          * @moduleid   TARG_MOD_QUERY_MASTER_PROC_CHIP
          * @reasoncode TARG_RC_TARGET_NOT_FOUND
          * @userData1  HUID of Target Passed
-         * @devdesc    Error: User Passed an invalid Node Target to find the
-         *     master proc handle
+         * @devdesc    The caller passed an invalid node target to find the
+         *             master proc handle
          */
         UTIL::createTracingError(
             TARG_MOD_QUERY_MASTER_PROC_CHIP,
@@ -1206,7 +1206,7 @@ errlHndl_t TargetService::setMasterNode(const Target* i_pTarget)
          * @moduleid   TARG_MOD_SET_MASTER_NODE
          * @reasoncode TARG_RC_INVALID_NODE
          * @userData1  HUID of Target Passed
-         * @devdesc    Error: User Passed an invalid Node Target
+         * @devdesc    The caller passed an invalid node target.
          */
         UTIL::createTracingError(
                 TARG_MOD_SET_MASTER_NODE,
diff --git a/src/usr/targeting/runtime/attrrp_rt.C b/src/usr/targeting/runtime/attrrp_rt.C
index 1ebb87f36..8c49837ac 100644
--- a/src/usr/targeting/runtime/attrrp_rt.C
+++ b/src/usr/targeting/runtime/attrrp_rt.C
@@ -5,7 +5,9 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* COPYRIGHT International Business Machines Corp. 2013,2014              */
+/* Contributors Listed Below - COPYRIGHT 2013,2014                        */
+/* [+] International Business Machines Corp.                              */
+/*                                                                        */
 /*                                                                        */
 /* Licensed under the Apache License, Version 2.0 (the "License");        */
 /* you may not use this file except in compliance with the License.       */
@@ -58,6 +60,12 @@ namespace TARGETING
                  *              PNOR_TARG_EYE_CATCHER and therefore the
                  *              contents of the Attribute sections are
                  *              unable to be parsed.
+                 *   @custdesc  A problem occurred during the IPL of the
+                 *              system.
+                 *              The eyecatch value observed in memory does not
+                 *              match the expected value and therefore the
+                 *              contents of the attribute sections are unable
+                 *              to be parsed.
                  */
                 l_errl = new ErrlEntry(ERRL_SEV_UNRECOVERABLE,
                                        TARG_MOD_ATTRRP_RT,
diff --git a/src/usr/vfs/vfsrp.C b/src/usr/vfs/vfsrp.C
index dbe05525c..fdeb81f72 100644
--- a/src/usr/vfs/vfsrp.C
+++ b/src/usr/vfs/vfsrp.C
@@ -5,7 +5,9 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* COPYRIGHT International Business Machines Corp. 2011,2014              */
+/* Contributors Listed Below - COPYRIGHT 2011,2014                        */
+/* [+] International Business Machines Corp.                              */
+/*                                                                        */
 /*                                                                        */
 /* Licensed under the Apache License, Version 2.0 (the "License");        */
 /* you may not use this file except in compliance with the License.       */
@@ -218,6 +220,8 @@ void VfsRp::_vfsWatcher()
          * @userdata2       task Rc
          *
          * @devdesc         VFS RP Task crashed.
+         * @custdesc  A problem was detected during the IPL of they system:
+         *            Task crashed.
          *
          */
         errlHndl_t err = new ERRORLOG::ErrlEntry
@@ -363,7 +367,8 @@ void VfsRp::_loadUnloadMonitored(msg_t * i_msg)
          * @userdata2       Task Status
          *
          * @devdesc         VFS Task crashed.
-         *
+         * @custdesc  A problem was detected during the IPL of they system:
+         *            Task crashed.
          */
         errlHndl_t err = new ERRORLOG::ErrlEntry
             (
@@ -500,7 +505,7 @@ void VfsRp::_loadUnload(msg_t * i_msg)
              * @userdata1       first 8 bytes of module name
              * @userdata2       next 8 bytes of module name
              *
-             * @devdesc         Requested Module does not exist.
+             * @devdesc         Requested module does not exist.
              *
              */
             err = new ERRORLOG::ErrlEntry
@@ -549,6 +554,8 @@ void VfsRp::_execMonitored(msg_t * i_msg)
          * @userdata2       task Rc
          *
          * @devdesc         VFS Task crashed.
+         * @custdesc  A problem was detected during the IPL of they system:
+         *            Task crashed.
          *
          */
         errlHndl_t err = new ERRORLOG::ErrlEntry