Clean up of devdesc in hostboot code

Change-Id: I252b9bffe2ff66d700c82f090b2d3bb21c1e570f
RTC:118001
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/40558
Reviewed-by: William G. Hoffa <wghoffa@us.ibm.com>
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Reviewed-by: Prachi Gupta <pragupta@us.ibm.com>
Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Matthew A. Ploetz <maploetz@us.ibm.com>

src/usr/fsi/fsipres.C

@@ -5,7 +5,7 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* Contributors Listed Below - COPYRIGHT 2011,2016                        */
+/* Contributors Listed Below - COPYRIGHT 2011,2017                        */
 /* [+] Google Inc.                                                        */
 /* [+] International Business Machines Corp.                              */
 /*                                                                        */
@@ -82,6 +82,8 @@ errlHndl_t procPresenceDetect(DeviceFW::OperationType i_opType,
          * @reasoncode   FSI::RC_INVALID_LENGTH
          * @userdata1    Data Length
          * @devdesc      presenceDetect> Invalid data length (!= 1 bytes)
+         * @custdesc     FSI buffer length is not 1 byte when finding
+         *               processor
          */
         l_errl =
                 new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
@@ -163,6 +165,7 @@ errlHndl_t procPresenceDetect(DeviceFW::OperationType i_opType,
          * @userdata2[0:31]    FSI Presence
          * @userdata2[32:63]   MVPD Presence
          * @devdesc      presenceDetect> FSI and MVPD do not agree
+         * @custdesc     FSI and MVPD do not agree
          */
         l_errl =
                 new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
@@ -254,6 +257,8 @@ errlHndl_t membPresenceDetect(DeviceFW::OperationType i_opType,
          * @reasoncode   FSI::RC_INVALID_LENGTH
          * @userdata1    Data Length
          * @devdesc      presenceDetect> Invalid data length (!= 1 bytes)
+         * @custdesc     FSI buffer length is not 1 byte when finding
+         *               a memory buffer chip
          */
         l_errl =
                 new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
@@ -325,6 +330,7 @@ errlHndl_t membPresenceDetect(DeviceFW::OperationType i_opType,
          * @userdata2[0:31]    FSI Presence
          * @userdata2[32:63]   VPD Presence
          * @devdesc      presenceDetect> FSI and CVPD do not agree
+         * @custdesc     FSI and CVPD do not agree
          */
         l_errl =
                 new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,

src/usr/hwas/hwasPlat.C

@@ -116,6 +116,7 @@ errlHndl_t platReadIDEC(const TargetHandle_t &i_target)
          * @userdata1    Target HUID
          * @userdata2    <unused>
          * @devdesc      platReadIDEC> Invalid chipid from hardware (all FFs)
+         * @custdesc     Invalid chipid from hardware (all FFs)
          */
         errl = new ERRORLOG::ErrlEntry(
                                        ERRORLOG::ERRL_SEV_UNRECOVERABLE,
@@ -323,6 +324,7 @@ errlHndl_t platReadLx(const TargetHandle_t &i_mca,
          * @userdata1    0
          * @userdata2    0
          * @devdesc      platReadLx> Bad MCA target
+         * @custdesc     Bad MCA target
          */
         errl = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                        HWAS::MOD_PLAT_READLX,
@@ -355,6 +357,7 @@ errlHndl_t platReadLx(const TargetHandle_t &i_mca,
              * @userdata1    Target MCA HUID
              * @userdata2    Value of x for Lx keyword
              * @devdesc      platReadLx> Invalid Lx keyword
+             * @custdesc     Invalid Lx keyword
              */
             errl = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                            HWAS::MOD_PLAT_READLX,

src/usr/lpc/lpcdd.C

@@ -592,6 +592,7 @@ errlHndl_t LpcDD::hwReset( ResetLevels i_resetLevel )
                          * @userdata2    <unused>
                          * @devdesc      LpcDD::hwReset> Unsupported Reset Level
                          *               requested
+                         * @custdesc     Unsupported Reset Level requested
                          */
                         l_err = new ERRORLOG::ErrlEntry(
                                             ERRORLOG::ERRL_SEV_UNRECOVERABLE,
@@ -1007,6 +1008,7 @@ errlHndl_t LpcDD::checkForOpbErrors( ResetLevels &o_resetLevel )
          * @userdata2    Reset Level
          * @devdesc      LpcDD::checkForOpbErrors> Error(s) found in OPB
          *               and/or LPCHC Status Register
+         * @custdesc     Error(s) found in OPB and/or LPCHC Status Register
          */
         l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                         LPC::MOD_LPCDD_CHECKFOROPBERRORS,

src/usr/pnor/pnor_common.C

@@ -153,8 +153,8 @@ errlHndl_t PNOR::parseTOC( uint8_t* i_tocBuffer,SectionData_t * o_TOC)
             * @userdata2 Error code
             * @devdesc Expected buffer to have contents of TOC,
             *                      instead was NULL
-            * @custdesc A problem occurred while reading PNOR
-            *                       partition table
+            * @custdesc A problem occurred while reading
+            *           Processor NOR flash partition table
             */
             l_errhdl = new ERRORLOG::ErrlEntry(
                                     ERRORLOG::ERRL_SEV_UNRECOVERABLE,
@@ -183,8 +183,8 @@ errlHndl_t PNOR::parseTOC( uint8_t* i_tocBuffer,SectionData_t * o_TOC)
             * @userdata1 Address of toc buffer
             * @userdata2 Error Code
             * @devdesc Hdr of TOC of PNOR failed checksum
-            * @custdesc A problem occurred while reading PNOR
-            *                     partition table
+            * @custdesc A problem occurred while reading
+            *           Processor NOR flash partition table
             */
             l_errhdl = new ERRORLOG::ErrlEntry(
                                     ERRORLOG::ERRL_SEV_UNRECOVERABLE,
@@ -211,8 +211,8 @@ errlHndl_t PNOR::parseTOC( uint8_t* i_tocBuffer,SectionData_t * o_TOC)
             * @userdata1 Address of toc buffer
             * @userdata2 Error Code
             * @devdesc Hdr of TOC of PNOR failed series of tests
-            * @custdesc A problem occurred while reading PNOR
-            *                     partition table
+            * @custdesc A problem occurred while reading
+            *           Processor NOR flash partition table
             */
             l_errhdl = new ERRORLOG::ErrlEntry(
                                     ERRORLOG::ERRL_SEV_UNRECOVERABLE,
@@ -251,8 +251,8 @@ errlHndl_t PNOR::parseTOC( uint8_t* i_tocBuffer,SectionData_t * o_TOC)
             * @userdata1 Address of toc buffer
             * @userdata2 Error Code
             * @devdesc Error while parsing pnor TOC entries
-            * @custdesc A problem occurred while reading PNOR
-            *                     partition table
+            * @custdesc A problem occurred while reading
+            *           Processor NOR flash partition table
             */
             l_errhdl = new ERRORLOG::ErrlEntry(
                                     ERRORLOG::ERRL_SEV_UNRECOVERABLE,

src/usr/pnor/pnorrp.C

@@ -130,6 +130,7 @@ errlHndl_t PNOR::flush( PNOR::SectionId i_section)
              *  @userdata1      section Id
              *  @userdata2      RC
              *  @devdesc        mm_remove_pages failed
+             *  @custdesc       Failed to remove pages
              */
             l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                         PNOR::MOD_PNORRP_FLUSH,
@@ -445,6 +446,7 @@ errlHndl_t PnorRP::getSideInfo( PNOR::SideId i_side,
              * @userdata1    Requested SIDE
              * @userdata2    0
              * @devdesc      PnorRP::getSideInfo> Side not supported
+             * @custdesc     Processor NOR flash: Side not supported
              */
             l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                             PNOR::MOD_PNORRP_GETSIDEINFO,
@@ -481,7 +483,8 @@ 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.
+             * @custdesc     Processor NOR flash:
+             *               A problem occurred while accessing the boot flash.
              */
             l_errhdl = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                                PNOR::MOD_PNORRP_GETSECTIONINFO,
@@ -1063,6 +1066,8 @@ errlHndl_t PnorRP::setSideInfo ()
                  * @userdata2[00:31] primary toc
                  * @userdata2[32:63] backup toc
                  * @devdesc          PnorRP::setSideInfo> No valid TOCs found
+                 * @custdesc         No valid Table of Contents (TOC) found
+                 *                   for Processor NOR flash
                  */
                 l_err = new ERRORLOG::ErrlEntry(
                             ERRORLOG::ERRL_SEV_INFORMATIONAL,
@@ -1773,9 +1778,9 @@ errlHndl_t PnorRP::setVirtAddrs(void)
                 * @userdata1 PNOR section id
                 * @userdata2 PNOR section vaddr
                 * @devdesc Could not set permissions of the
-                * given PNOR section to WRITABLE
+                *          given PNOR section to WRITABLE
                 * @custdesc A problem occurred while reading
-                *           PNOR partition table
+                *           Processor NOR flash partition table
                 */
                 l_errhdl = new ERRORLOG::ErrlEntry(
                                 ERRORLOG::ERRL_SEV_UNRECOVERABLE,
@@ -1806,10 +1811,10 @@ errlHndl_t PnorRP::setVirtAddrs(void)
                 * @userdata1 PNOR section id
                 * @userdata2 PNOR section vaddr
                 * @devdesc Could not set permissions of the
-                * given PNOR section to
-                * WRITABLE/WRITE_TRACKED
+                *          given PNOR section to
+                *          WRITABLE/WRITE_TRACKED
                 * @custdesc A problem occurred while reading
-                * PNOR partition table
+                *           Processor NOR flash partition table
                 */
                 l_errhdl = new ERRORLOG::ErrlEntry(
                                 ERRORLOG::ERRL_SEV_UNRECOVERABLE,

src/usr/pnor/pnorvalid.C

@@ -246,6 +246,9 @@ errlHndl_t validateAltMaster( void )
                  * @userdata2    <unused>
                  * @devdesc      PNOR::validateAltMaster> Fail verifying FFS
                  *               Header on Master Candidate PNOR TOC0
+                 * @custdesc     Fail verifying Flash File System (FFS) Header
+                 *               on Master Candidate Processor NOR flash Table
+                 *               of Contents 0 (TOC)
                  */
                 l_err = new ERRORLOG::ErrlEntry(
                                       ERRORLOG::ERRL_SEV_UNRECOVERABLE,
@@ -375,6 +378,8 @@ errlHndl_t validateMagic(PnorDD*  i_pnordd,
                  * @userdata2    <unused>
                  * @devdesc      PNOR::validateMagic> Fail verifying FFS Magic
                  *               Number in Header on Master
+                 * @custdesc     Fail verifying Flash File System (FFS) Magic
+                 *               Number in Header on Master
                  */
                 l_err = new ERRORLOG::ErrlEntry(
                                       ERRORLOG::ERRL_SEV_UNRECOVERABLE,

src/usr/sbe/sbe_update.C

@@ -2355,6 +2355,8 @@ namespace SBE
                      * @userdata2[32:63]    Size - ECC
                      * @devdesc      ECC or Data Miscompare Fail Reading Back
                      *               SBE Version Information
+                     * @custdesc     ECC or Data Miscompare Fail Reading Back
+                     *               Self Boot Engine (SBE) Version Information
                      */
                     err = new ErrlEntry(ERRL_SEV_PREDICTIVE,
                                         SBE_UPDATE_SEEPROMS,
@@ -3531,6 +3533,8 @@ namespace SBE
              * @userdata2[32:63]  Original SEEPROM 1 CRC
              * @devdesc      Successful Update of SBE SEEPROM
              *               SBE Version Information
+             * @custdesc     Successful Update of Self Boot Engine
+             *               (SBE) SEEPROM SBE Version Information
              */
             err_info = new ErrlEntry(ERRL_SEV_INFORMATIONAL,
                                      SBE_PERFORM_UPDATE_ACTIONS,
@@ -4230,6 +4234,8 @@ namespace SBE
                          * @userdata2    Master Target Loop Index
                          * @devdesc      SBE Image Version Miscompare with
                          *               Master Target
+                         * @custdesc     Self Boot Engine (SBE) Image Version
+                         *               Miscompare with Master Target
                          */
                         err = new ErrlEntry(ERRL_SEV_PREDICTIVE,
                                             SBE_MASTER_VERSION_COMPARE,
@@ -4387,6 +4393,8 @@ namespace SBE
                      * @userdata1    Master Target HUID
                      * @userdata2    Comparison Target HUID
                      * @devdesc      SBE Version Miscompare with Master Target
+                     * @custdesc     Self Boot Engine (SBE) Version Miscompare
+                     *               with Master Target
                      */
                     err = new ErrlEntry(ERRL_SEV_UNRECOVERABLE,
                                         SBE_MASTER_VERSION_COMPARE,

src/usr/targeting/attrPlatOverride.C

@@ -102,7 +102,8 @@ errlHndl_t getAttrOverrides(PNOR::SectionInfo_t &i_sectionInfo,
                  * @userdata2    Size of AttrOverrideSection
                  * @devdesc      AttrOverrideSection too big to fit in remaining
                  *               chunck of pnor section
-                 * @custdesc     Invalid configuration data in firmware pnor
+                 * @custdesc     Invalid configuration data in firmware Processor
+                 *               NOR flash
                  */
                 l_err =
                     new ERRORLOG::ErrlEntry
@@ -131,7 +132,8 @@ errlHndl_t getAttrOverrides(PNOR::SectionInfo_t &i_sectionInfo,
                  * @userdata2    Size of Serialized attribute override
                  * @devdesc      Serialized attribute override chunk too big to
                  *               fit in remaining chunck of pnor section
-                 * @custdesc     Invalid configuration data in firmware pnor
+                 * @custdesc     Invalid configuration data in firmware Processor
+                 *               NOR flash
                  */
                 l_err =
                     new ERRORLOG::ErrlEntry
@@ -159,7 +161,8 @@ errlHndl_t getAttrOverrides(PNOR::SectionInfo_t &i_sectionInfo,
                  * @userdata2    Chunk location with no tank layer
                  * @devdesc      No tank layer was specified for attribute
                  *               override.
-                 * @custdesc     Invalid configuration data in firmware pnor
+                 * @custdesc     Invalid configuration data in firmware Processor
+                 *               NOR flash
                  */
                 l_err =
                     new ERRORLOG::ErrlEntry
@@ -191,7 +194,8 @@ errlHndl_t getAttrOverrides(PNOR::SectionInfo_t &i_sectionInfo,
                  * @devdesc      Attribute override is in the wrong pnor section
                  *               needs to be moved to the section associated
                  *               with its attribute tank layer
-                 * @custdesc     Invalid configuration data in firmware pnor
+                 * @custdesc     Invalid configuration data in firmware Processor
+                 *               NOR flash
                  */
                 l_err =
                     new ERRORLOG::ErrlEntry