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>

3 files changed, 24 insertions, 14 deletions

diff --git a/src/usr/pnor/pnor_common.C b/src/usr/pnor/pnor_common.C
index 5ae0eed30..15e519f59 100644
--- a/src/usr/pnor/pnor_common.C
+++ b/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,
diff --git a/src/usr/pnor/pnorrp.C b/src/usr/pnor/pnorrp.C
index 9a7e6baa4..ce38d87ad 100644
--- a/src/usr/pnor/pnorrp.C
+++ b/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,
diff --git a/src/usr/pnor/pnorvalid.C b/src/usr/pnor/pnorvalid.C
index 58e3f71e0..a49dd63ea 100644
--- a/src/usr/pnor/pnorvalid.C
+++ b/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,