Add customer error descriptions to error log headers.

Change-Id: Ibb2f1219b6f2ff27e9b09fea4d36c2616fb7ddf9
RTC: 110397
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/11079
Tested-by: Jenkins Server
Reviewed-by: Andrew J. Geissler <andrewg@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, 21 insertions, 3 deletions

diff --git a/src/usr/pnor/pnordd.C b/src/usr/pnor/pnordd.C
index bbd302ea1..0fcd8d7ef 100644
--- a/src/usr/pnor/pnordd.C
+++ b/src/usr/pnor/pnordd.C
@@ -754,6 +754,7 @@ errlHndl_t PnorDD::pollSfcOpComplete(uint64_t i_pollTime)
              * @userdata2[0:31]    ECCB Status Register
              * @devdesc      PnorDD::pollSfcOpComplete> Error or timeout from
              *               SFC Status Register
+             * @custdesc    A problem occurred while accessing the boot flash.
              */
             l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                             PNOR::MOD_PNORDD_POLLSFCOPCOMPLETE,
@@ -942,6 +943,7 @@ errlHndl_t PnorDD::checkForErrors( void )
          * @userdata2[32:63] <unused>
          * @devdesc      PnorDD::checkForErrors> Error(s) found in SFC
          *               and/or LPC Slave Status Registers
+         * @custdesc    A problem occurred while accessing the boot flash.
          */
         l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                         PNOR::MOD_PNORDD_CHECKFORERRORS,
@@ -1212,6 +1214,7 @@ errlHndl_t PnorDD::micronFlagStatus(uint64_t i_pollTime)
              * @userdata2[0:31]   Micron Flag status register
              * @devdesc      PnorDD::micronFlagStatus> Error or timeout from
              *               Micron Flag Status Register
+             * @custdesc    A problem occurred while accessing the boot flash.
              */
             l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                             PNOR::MOD_PNORDD_MICRONFLAGSTATUS,
@@ -1764,6 +1767,7 @@ errlHndl_t PnorDD::readLPC(uint32_t i_addr,
              * @userdata2    ECCB Status Register
              * @devdesc      PnorDD::readLPC> Error or timeout from
              *               LPC Status Register
+             * @custdesc    A problem occurred while accessing the boot flash.
              */
             l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                             PNOR::MOD_PNORDD_READLPC,
@@ -1882,6 +1886,7 @@ errlHndl_t PnorDD::writeLPC(uint32_t i_addr,
              * @userdata2    ECCB Status Register
              * @devdesc      PnorDD::writeLPC> Error or timeout from
              *               LPC Status Register
+             * @custdesc    A problem occurred while accessing the boot flash.
              */
             l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                             PNOR::MOD_PNORDD_WRITELPC,
@@ -2088,6 +2093,7 @@ errlHndl_t PnorDD::eraseFlash(uint32_t i_address)
              * @userdata1    LPC Address
              * @userdata2    Nearest Erase Boundary
              * @devdesc      PnorDD::eraseFlash> Address not on erase boundary
+             * @custdesc    A problem occurred while accessing the boot flash.
              */
             l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                             PNOR::MOD_PNORDD_ERASEFLASH,
@@ -2181,6 +2187,7 @@ errlHndl_t PnorDD::eraseFlash(uint32_t i_address)
              * @userdata1    NOR Chip ID
              * @userdata2    LPC Address to erase
              * @devdesc      PnorDD::eraseFlash> No support for MODEL_REAL yet
+             * @custdesc    A problem occurred while accessing the boot flash.
              */
             l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                             PNOR::MOD_PNORDD_ERASEFLASH,
diff --git a/src/usr/pnor/pnorrp.C b/src/usr/pnor/pnorrp.C
index 84c25b292..9ec472384 100644
--- a/src/usr/pnor/pnorrp.C
+++ b/src/usr/pnor/pnorrp.C
@@ -135,9 +135,10 @@ void PnorRP::init( errlHndl_t   &io_rtaskRetErrl )
          *  @userdata2      0
          *
          *  @devdesc        PNOR startup task returned an error.
+         * @custdesc    A problem occurred while accessing the boot flash.
          */
         l_errl = new ERRORLOG::ErrlEntry(
-                                ERRORLOG::ERRL_SEV_CRITICAL_SYS_TERM,
+                                         ERRORLOG::ERRL_SEV_CRITICAL_SYS_TERM,
                                 PNOR::MOD_PNORRP_DIDSTARTUPFAIL,
                                 PNOR::RC_BAD_STARTUP_RC,
                                 rc,
@@ -234,6 +235,7 @@ void PnorRP::initDaemon()
              * @userdata1    Requested Address
              * @userdata2    rc from mm_alloc_block
              * @devdesc      PnorRP::initDaemon> Error from mm_alloc_block
+             * @custdesc    A problem occurred while accessing the boot flash.
              */
             l_errhdl = new ERRORLOG::ErrlEntry(
                            ERRORLOG::ERRL_SEV_UNRECOVERABLE,
@@ -298,6 +300,7 @@ errlHndl_t PnorRP::getSectionInfo( PNOR::SectionId i_section,
              * @userdata1    Requested Section
              * @userdata2    Startup RC
              * @devdesc      PnorRP::getSectionInfo> RP not properly initialized
+             * @custdesc    A problem occurred while accessing the boot flash.
              */
             l_errhdl = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                                PNOR::MOD_PNORRP_GETSECTIONINFO,
@@ -324,7 +327,8 @@ errlHndl_t PnorRP::getSectionInfo( PNOR::SectionId i_section,
              * @userdata1    Requested Section
              * @userdata2    TOC used
              * @devdesc      PnorRP::getSectionInfo> Invalid Address for read/write
-             */
+             * @custdesc    A problem occurred while accessing the boot flash.
+            */
             l_errhdl = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                                PNOR::MOD_PNORRP_GETSECTIONINFO,
                                                PNOR::RC_INVALID_SECTION,
@@ -697,6 +701,8 @@ void PnorRP::waitForMessage()
                          * @userdata2    Requested Virtual Address
                          * @devdesc      PnorRP::waitForMessage> Unrecognized
                          *               message type
+                         * @custdesc     A problem occurred while accessing
+                         *               the boot flash.
                          */
                         l_errhdl = new ERRORLOG::ErrlEntry(
                                            ERRORLOG::ERRL_SEV_UNRECOVERABLE,
@@ -719,7 +725,10 @@ void PnorRP::waitForMessage()
                  * @reasoncode   PNOR::RC_INVALID_ASYNC_MESSAGE
                  * @userdata1    Message type
                  * @userdata2    Requested Virtual Address
-                 * @devdesc      PnorRP::waitForMessage> Unrecognized message type
+                 * @devdesc      PnorRP::waitForMessage> Unrecognized message
+                 *               type
+                 * @custdesc     A problem occurred while accessing the boot
+                 *               flash.
                  */
                 l_errhdl = new ERRORLOG::ErrlEntry(
                                          ERRORLOG::ERRL_SEV_UNRECOVERABLE,
@@ -940,6 +949,7 @@ errlHndl_t PnorRP::computeDeviceAddr( void* i_vaddr,
          * @userdata2    Base PNOR Address
          * @devdesc      PnorRP::computeDeviceAddr> Virtual Address outside
          *               known PNOR range
+         * @custdesc    A problem occurred while accessing the boot flash.
          */
         l_errhdl = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                         PNOR::MOD_PNORRP_COMPUTEDEVICEADDR,
@@ -1021,6 +1031,7 @@ errlHndl_t PnorRP::computeSection( uint64_t i_vaddr,
          * @userdata1    Requested Virtual Address
          * @userdata2    <unused>
          * @devdesc      PnorRP::computeSection> Invalid Address
+         * @custdesc    A problem occurred while accessing the boot flash.
          */
         errhdl = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                          PNOR::MOD_PNORRP_COMPUTESECTION,