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>

2 files changed, 25 insertions, 12 deletions

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,