Fix NVDIMM update error log comments

First line of error log comment must include /*@
or error log will not be documented.  Also fixed
in other HB files.

Change-Id: Ifa5eba6d6abd7f8565a4cc8d62a25a2b833725f2
Reviewed-on: http://rchgit01.rchland.ibm.com/gerrit1/82497
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Nicholas E Bofferding <bofferdn@us.ibm.com>
Reviewed-by: Matt Derksen <mderkse1@us.ibm.com>
Reviewed-by: Daniel M Crowell <dcrowell@us.ibm.com>

6 files changed, 68 insertions, 65 deletions

diff --git a/src/usr/hwas/common/hwas.C b/src/usr/hwas/common/hwas.C
index 580d6ef60..8498b12b7 100644
--- a/src/usr/hwas/common/hwas.C
+++ b/src/usr/hwas/common/hwas.C
@@ -3850,7 +3850,7 @@ errlHndl_t updateProcCompatibilityRiskLevel()
                         "force compatibility of invalid MRW risk level %d",
                         l_risk);
 
-                    /*
+                    /*@
                      * @errortype
                      * @severity           ERRL_SEV_UNRECOVERABLE
                      * @moduleid           MOD_UPDATE_PROC_COMPAT_RISK_LEVEL
@@ -3917,7 +3917,7 @@ errlHndl_t updateProcCompatibilityRiskLevel()
                     "force native compatibility of mixed processor levels",
                     " (0x%02X and 0x%02X)", l_firstEc, l_lastEc );
 
-                /*
+                /*@
                  * @errortype
                  * @severity           ERRL_SEV_UNRECOVERABLE
                  * @moduleid           MOD_UPDATE_PROC_COMPAT_RISK_LEVEL
@@ -3988,7 +3988,7 @@ errlHndl_t updateProcCompatibilityRiskLevel()
                     "force native compatibility of DD2.3 for risk level %d",
                     l_risk);
 
-                /*
+                /*@
                  * @errortype
                  * @severity           ERRL_SEV_UNRECOVERABLE
                  * @moduleid           MOD_UPDATE_PROC_COMPAT_RISK_LEVEL
diff --git a/src/usr/isteps/nvdimm/nvdimm_update.C b/src/usr/isteps/nvdimm/nvdimm_update.C
index afaa03e04..ecf9a768d 100644
--- a/src/usr/isteps/nvdimm/nvdimm_update.C
+++ b/src/usr/isteps/nvdimm/nvdimm_update.C
@@ -383,7 +383,7 @@ errlHndl_t NvdimmInstalledImage::updateImage(NvdimmLidImage * i_lidImage)
             TRACFCOMP(g_trac_nvdimm_upd,ERR_MRK"updateImage: "
                 "NV controller is busy (0x%08X) for NVDIMM 0x%.8X",
                 l_status.whole, TARGETING::get_huid(iv_dimm));
-            /*
+            /*@
              *@errortype
              *@moduleid         UPDATE_IMAGE
              *@reasoncode       NVDIMM_OPERATION_IN_PROGRESS
@@ -551,7 +551,7 @@ errlHndl_t NvdimmInstalledImage::updateImage(NvdimmLidImage * i_lidImage)
                 "NVDIMM 0x%.8X: data checksums mismatch (calc host: 0x%X "
                 "and nv: 0x%X) for first part (header + SMART signature)",
                 TARGETING::get_huid(iv_dimm), hostCksm, nvCksm);
-            /*
+            /*@
              *@errortype
              *@moduleid         UPDATE_IMAGE
              *@reasoncode       NVDIMM_CHECKSUM_ERROR
@@ -767,7 +767,7 @@ errlHndl_t NvdimmInstalledImage::updateImageData(NvdimmLidImage * i_lidImage)
         }
         if (fw_img_total_regions == 0)
         {
-            /*
+            /*@
              *@errortype
              *@moduleid         UPDATE_IMAGE_DATA
              *@reasoncode       NVDIMM_ZERO_TOTAL_REGIONS
@@ -923,7 +923,7 @@ errlHndl_t NvdimmInstalledImage::updateImageData(NvdimmLidImage * i_lidImage)
                     "(calc host: 0x%X and nv: 0x%X)",
                     region, TARGETING::get_huid(iv_dimm), hostCksm, nvCksm);
 
-                /*
+                /*@
                  *@errortype
                  *@moduleid         UPDATE_IMAGE_DATA
                  *@reasoncode       NVDIMM_CHECKSUM_ERROR
@@ -994,7 +994,7 @@ errlHndl_t NvdimmInstalledImage::changeFwUpdateMode(fw_update_mode i_mode)
                       ((i_mode == FW_UPDATE_MODE_DISABLED) &&
                        (opStatus.fw_ops_update_mode == 0))) )
                 {
-                    /*
+                    /*@
                      *@errortype
                      *@moduleid         CHANGE_FW_UPDATE_MODE
                      *@reasoncode       NVDIMM_UPDATE_MODE_UNCHANGED
@@ -1071,7 +1071,7 @@ errlHndl_t NvdimmInstalledImage::waitFwOpsBlockReceived()
 
     if (!blockReceived && !l_err)
     {
-        /*
+        /*@
          *@errortype
          *@moduleid         WAIT_FW_OPS_BLOCK_RECEIVED
          *@reasoncode       NVDIMM_BLOCK_NOT_RECEIVED
@@ -1150,7 +1150,7 @@ errlHndl_t NvdimmInstalledImage::waitFwOpsComplete()
 
         if (!opsComplete && !l_err)
         {
-            /*
+            /*@
              *@errortype
              *@moduleid         WAIT_FW_OPS_COMPLETE
              *@reasoncode       NVDIMM_FW_OPS_IN_PROGRESS_TIMEOUT
@@ -1322,7 +1322,7 @@ errlHndl_t NvdimmInstalledImage::byteRegionBlockTransfer(const uint8_t * i_data,
             }
             if (blocks_per_region > max_blocks_per_region)
             {
-                /*
+                /*@
                  *@errortype
                  *@moduleid         BYTE_REGION_BLOCK_TRANSFER
                  *@reasoncode       NVDIMM_DATA_SIZE_TOO_LARGE
@@ -1357,7 +1357,7 @@ errlHndl_t NvdimmInstalledImage::byteRegionBlockTransfer(const uint8_t * i_data,
 
         if (i_data_size > (BYTES_PER_BLOCK*blocks_per_region))
         {
-            /*
+            /*@
              *@errortype
              *@moduleid         BYTE_REGION_BLOCK_TRANSFER
              *@reasoncode       NVDIMM_DATA_SIZE_INVALID
@@ -1523,7 +1523,7 @@ errlHndl_t NvdimmInstalledImage::validateFwHeader()
                 l_err = isFwOpsSuccess(opsSuccessful);
                 if (!l_err && !opsSuccessful)
                 {
-                    /*
+                    /*@
                      *@errortype
                      *@moduleid         VALIDATE_FW_HEADER
                      *@reasoncode       NVDIMM_FW_OPS_NOT_SUCCESSFUL
@@ -1572,7 +1572,7 @@ errlHndl_t NvdimmInstalledImage::commitFwRegion()
                 l_err = isFwOpsSuccess(opsSuccessful);
                 if (!l_err && !opsSuccessful)
                 {
-                    /*
+                    /*@
                      *@errortype
                      *@moduleid         COMMIT_FW_REGION
                      *@reasoncode       NVDIMM_FW_OPS_NOT_SUCCESSFUL
@@ -1622,7 +1622,7 @@ errlHndl_t NvdimmInstalledImage::clearFwDataBlock()
             l_err = isFwOpsSuccess(ops_success);
             if (!l_err && !ops_success)
             {
-                /*
+                /*@
                  *@errortype
                  *@moduleid         CLEAR_FW_DATA_BLOCK
                  *@reasoncode       NVDIMM_FW_OPS_NOT_SUCCESSFUL
@@ -1671,7 +1671,7 @@ errlHndl_t NvdimmInstalledImage::validateFwImage()
                 // create an error if operation not successful
                 if (!l_err && !opsSuccessful)
                 {
-                    /*
+                    /*@
                      *@errortype
                      *@moduleid         VALIDATE_FW_IMAGE
                      *@reasoncode       NVDIMM_FW_OPS_NOT_SUCCESSFUL
@@ -1799,7 +1799,7 @@ bool NvdimmsUpdate::runUpdateUsingLid(NvdimmLidImage * i_lidImage,
             TRACFCOMP(g_trac_nvdimm_upd,"Updating with flash size: 0x%08X",
                 i_lidImage->getFlashImageSize());
 
-            /*
+            /*@
              *@errortype        INFORMATIONAL
              *@reasoncode       NVDIMM_START_UPDATE
              *@moduleid         NVDIMM_RUN_UPDATE_USING_LID
@@ -1857,7 +1857,7 @@ bool NvdimmsUpdate::runUpdateUsingLid(NvdimmLidImage * i_lidImage,
                     l_err = nullptr;
                 }
 
-                /*
+                /*@
                  *@errortype        INFORMATIONAL
                  *@reasoncode       NVDIMM_UPDATE_COMPLETE
                  *@moduleid         NVDIMM_RUN_UPDATE_USING_LID
@@ -1950,7 +1950,7 @@ bool NvdimmsUpdate::runUpdate(void)
             TRACFCOMP(g_trac_nvdimm_upd, "NvdimmsUpdate::runUpdate() - unknown "
                 "nvdimm[%X] installed type 0x%04X, skipping update",
                 TARGETING::get_huid(l_nvdimm), l_installed_type);
-            /*
+            /*@
              *@errortype
              *@reasoncode       NVDIMM_UNSUPPORTED_NVDIMM_TYPE
              *@moduleid         NVDIMM_RUN_UPDATE
@@ -2172,7 +2172,7 @@ errlHndl_t NvdimmsUpdate::isUpdateNeeded(bool & o_update_needed,
                     "isUpdateNeeded(): non-updatable SMART NVDIMM 0x%.8X "
                     "(0x%04X)",
                     TARGETING::get_huid(l_dimm), le16toh(curVersion));
-                /*
+                /*@
                  *@errortype
                  *@reasoncode       NVDIMM_UPDATE_NOT_SUPPORTED
                  *@moduleid         NVDIMM_IS_UPDATE_NEEDED
diff --git a/src/usr/pnor/pnor_common.C b/src/usr/pnor/pnor_common.C
index 0bdb3ebcb..2ea6f838f 100644
--- a/src/usr/pnor/pnor_common.C
+++ b/src/usr/pnor/pnor_common.C
@@ -164,16 +164,16 @@ errlHndl_t PNOR::parseTOC( uint8_t* i_tocBuffer,SectionData_t * o_TOC,
                    "Null TOC Buffer found while checking TOC"
                    " during pnor initialization");
             /*@
-            * @errortype
-            * @moduleid PNOR::MOD_PNORRP_READTOC
-            * @reasoncode PNOR::RC_NULL_TOC_BUFFER
-            * @userdata1 Address of toc buffer
-            * @userdata2 Error code
-            * @devdesc Expected buffer to have contents of TOC,
-            *                      instead was NULL
-            * @custdesc A problem occurred while reading
-            *           Processor NOR flash partition table
-            */
+             * @errortype
+             * @moduleid PNOR::MOD_PNORRP_READTOC
+             * @reasoncode PNOR::RC_NULL_TOC_BUFFER
+             * @userdata1 Address of toc buffer
+             * @userdata2 Error code
+             * @devdesc Expected buffer to have contents of TOC,
+             *                      instead was NULL
+             * @custdesc A problem occurred while reading
+             *           Processor NOR flash partition table
+             */
             l_errhdl = new ERRORLOG::ErrlEntry(
                                     ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                     PNOR::MOD_PNORRP_READTOC,
@@ -201,15 +201,16 @@ errlHndl_t PNOR::parseTOC( uint8_t* i_tocBuffer,SectionData_t * o_TOC,
                       "PNOR::parseTOC Found checksum error in TOC's header"
                       " during pnor initialization");
 
-            /* @errortype
-            * @moduleid PNOR::MOD_PNORRP_READTOC
-            * @reasoncode PNOR::RC_TOC_HDR_CHECKSUM_ERR
-            * @userdata1 Address of toc buffer
-            * @userdata2 Error Code
-            * @devdesc Hdr of TOC of PNOR failed checksum
-            * @custdesc A problem occurred while reading
-            *           Processor NOR flash partition table
-            */
+            /*@
+             * @errortype
+             * @moduleid PNOR::MOD_PNORRP_READTOC
+             * @reasoncode PNOR::RC_TOC_HDR_CHECKSUM_ERR
+             * @userdata1 Address of toc buffer
+             * @userdata2 Error Code
+             * @devdesc Hdr of TOC of PNOR failed checksum
+             * @custdesc A problem occurred while reading
+             *           Processor NOR flash partition table
+             */
             l_errhdl = new ERRORLOG::ErrlEntry(
                                     ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                     PNOR::MOD_PNORRP_READTOC,
@@ -234,15 +235,16 @@ errlHndl_t PNOR::parseTOC( uint8_t* i_tocBuffer,SectionData_t * o_TOC,
             assert(i_pnorInitialized,
                       "PNOR::parseTOC Error found parsing hdr of TOC"
                       " during pnor initialization");
-            /* @errortype
-            * @moduleid PNOR::MOD_PNORRP_READTOC
-            * @reasoncode PNOR::RC_BAD_TOC_HEADER
-            * @userdata1 Address of toc buffer
-            * @userdata2 Error Code
-            * @devdesc Hdr of TOC of PNOR failed series of tests
-            * @custdesc A problem occurred while reading
-            *           Processor NOR flash partition table
-            */
+            /*@
+             * @errortype
+             * @moduleid PNOR::MOD_PNORRP_READTOC
+             * @reasoncode PNOR::RC_BAD_TOC_HEADER
+             * @userdata1 Address of toc buffer
+             * @userdata2 Error Code
+             * @devdesc Hdr of TOC of PNOR failed series of tests
+             * @custdesc A problem occurred while reading
+             *           Processor NOR flash partition table
+             */
             l_errhdl = new ERRORLOG::ErrlEntry(
                                     ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                     PNOR::MOD_PNORRP_READTOC,
@@ -280,15 +282,16 @@ errlHndl_t PNOR::parseTOC( uint8_t* i_tocBuffer,SectionData_t * o_TOC,
                     "PNOR::parseTOC parseEntries returned an error code"
                     " during pnor initialization");
 
-            /* @errortype
-            * @moduleid PNOR::MOD_PNORRP_READTOC
-            * @reasoncode PNOR::RC_PNOR_PARSE_ENTRIES_ERR
-            * @userdata1 Address of toc buffer
-            * @userdata2 Error Code
-            * @devdesc Error while parsing pnor TOC entries
-            * @custdesc A problem occurred while reading
-            *           Processor NOR flash partition table
-            */
+            /*@
+             * @errortype
+             * @moduleid PNOR::MOD_PNORRP_READTOC
+             * @reasoncode PNOR::RC_PNOR_PARSE_ENTRIES_ERR
+             * @userdata1 Address of toc buffer
+             * @userdata2 Error Code
+             * @devdesc Error while parsing pnor TOC entries
+             * @custdesc A problem occurred while reading
+             *           Processor NOR flash partition table
+             */
             l_errhdl = new ERRORLOG::ErrlEntry(
                                     ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                     PNOR::MOD_PNORRP_READTOC,
diff --git a/src/usr/secureboot/ext/service_ext.C b/src/usr/secureboot/ext/service_ext.C
index 1f8595a71..dd5c08a78 100644
--- a/src/usr/secureboot/ext/service_ext.C
+++ b/src/usr/secureboot/ext/service_ext.C
@@ -5,7 +5,7 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* Contributors Listed Below - COPYRIGHT 2018                             */
+/* Contributors Listed Below - COPYRIGHT 2018,2019                        */
 /* [+] International Business Machines Corp.                              */
 /*                                                                        */
 /*                                                                        */
@@ -69,7 +69,7 @@ void lockAbusSecMailboxes()
             ERRORLOG::ErrlUserDetailsTarget(*l_pProc).addToLog(l_errl);
             ERRORLOG::errlCommit(l_errl, SECURE_COMP_ID);
 
-            /*
+            /*@
              * @errortype
              * @reasoncode RC_LOCK_MAILBOXES_FAILED
              * @moduleid   MOD_LOCK_ABUS_SEC_MAILBOXES
diff --git a/src/usr/secureboot/trusted/base/trustedboot_base.C b/src/usr/secureboot/trusted/base/trustedboot_base.C
index 2e5182d2f..75ea8fecb 100644
--- a/src/usr/secureboot/trusted/base/trustedboot_base.C
+++ b/src/usr/secureboot/trusted/base/trustedboot_base.C
@@ -1165,7 +1165,7 @@ errlHndl_t expandTpmLog(TpmTarget* i_target)
     int l_rc = msg_sendrecv(systemData.msgQ, l_msg->iv_msg);
     if(l_rc)
     {
-        /**
+        /*@
          * @errortype ERRL_SEV_UNRECOVERABLE
          * @moduleid MOD_EXPAND_TPM_LOG
          * @reasoncode RC_SENDRECV_FAIL
diff --git a/src/usr/targeting/common/associationmanager.C b/src/usr/targeting/common/associationmanager.C
index 984eb17ec..b811f1861 100644
--- a/src/usr/targeting/common/associationmanager.C
+++ b/src/usr/targeting/common/associationmanager.C
@@ -5,7 +5,7 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* Contributors Listed Below - COPYRIGHT 2018                             */
+/* Contributors Listed Below - COPYRIGHT 2018,2019                        */
 /* [+] International Business Machines Corp.                              */
 /*                                                                        */
 /*                                                                        */
@@ -199,7 +199,7 @@ errlHndl_t AssociationManager::reconnectSyAndNodeTargets()
     {
         TARG_ERR("Failed to find master system target");
 
-        /*
+        /*@
          * @errortype
          * @refcode      LIC_REFCODE
          * @subsys       EPUB_FIRMWARE_SP
@@ -304,7 +304,7 @@ errlHndl_t AssociationManager::_clearAssocsOfTypeFromSysOrNodeTarget(
             pAssocsItrPreTrans,
             i_pSysOrNodeTarget->getAttr<TARGETING::ATTR_HUID>(),
             i_pSysOrNodeTarget);
-        /*
+        /*@
          * @errortype
          * @refcode      LIC_REFCODE
          * @subsys       EPUB_FIRMWARE_SP
@@ -447,7 +447,7 @@ errlHndl_t AssociationManager::_addAssocToSysOrNodeTarget(
             pAssocsItrPreTrans,
             i_pSourceSysOrNodeTarget->getAttr<TARGETING::ATTR_HUID>(),
             i_pSourceSysOrNodeTarget);
-        /*
+        /*@
          * @errortype
          * @refcode      LIC_REFCODE
          * @subsys       EPUB_FIRMWARE_SP
@@ -482,7 +482,7 @@ errlHndl_t AssociationManager::_addAssocToSysOrNodeTarget(
             "maxLinks = %d, i_assocType = 0x%08X, HUID = 0x%08X",
             association, maxLinks, i_assocType,
             i_pSourceSysOrNodeTarget->getAttr<TARGETING::ATTR_HUID>());
-        /*
+        /*@
          * @errortype
          * @refcode      LIC_REFCODE
          * @subsys       EPUB_FIRMWARE_SP