L3 update -- p9_psi_scominit

Change-Id: I955bcb7d9cf03bdd21660183e377d0428e75fc84
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/41036
Reviewed-by: Thi N. Tran <thi@us.ibm.com>
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: Hostboot CI <hostboot-ci+hostboot@us.ibm.com>
Reviewed-by: Benjamin Gass <bgass@us.ibm.com>
Reviewed-by: Peng Fei Gou <shgoupf@cn.ibm.com>
Reviewed-by: Jennifer A. Stofer <stofer@us.ibm.com>
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/41048
Reviewed-by: Hostboot Team <hostboot@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>

2 files changed, 46 insertions, 56 deletions

diff --git a/src/import/chips/p9/procedures/hwp/nest/p9_psi_scominit.C b/src/import/chips/p9/procedures/hwp/nest/p9_psi_scominit.C
index 642c31a84..b83f9310c 100644
--- a/src/import/chips/p9/procedures/hwp/nest/p9_psi_scominit.C
+++ b/src/import/chips/p9/procedures/hwp/nest/p9_psi_scominit.C
@@ -5,7 +5,7 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* Contributors Listed Below - COPYRIGHT 2015,2016                        */
+/* Contributors Listed Below - COPYRIGHT 2015,2017                        */
 /* [+] International Business Machines Corp.                              */
 /*                                                                        */
 /*                                                                        */
@@ -22,49 +22,40 @@
 /* permissions and limitations under the License.                         */
 /*                                                                        */
 /* IBM_PROLOG_END_TAG                                                     */
-/// ----------------------------------------------------------------------------
-/// @file  p9_psi_scominit.H
 ///
-/// Initializes PSI SCOM of the target proc.
+/// @file p9_psi_scominit.C
+/// @brief Perform PSI SCOM initialization (FAPI2)
 ///
-/// ----------------------------------------------------------------------------
-/// *HWP HWP Owner   : Joe McGill <jmcgill@us.ibm.com>
-/// *HWP FW Owner    : Thi Tran <thi@us.ibm.com>
-/// *HWP Team        : Nest
-/// *HWP Level       : 1
-/// *HWP Consumed by : HB
-/// ----------------------------------------------------------------------------
+/// @author Joe McGill <jmcgill@us.ibm.com>
+///
+
+//
+// *HWP HWP Owner : Joe McGill <jmcgill@us.ibm.com>
+// *HWP FW Owner : Thi Tran <thi@us.ibm.com>
+// *HWP Team : Nest
+// *HWP Level : 3
+// *HWP Consumed by : HB
+//
 
 //------------------------------------------------------------------------------
 // Includes
 //------------------------------------------------------------------------------
 #include <p9_psi_scominit.H>
-#include "p9_psi_scom.H"
-///----------------------------------------------------------------------------
-/// Constant definitions
-///----------------------------------------------------------------------------
+#include <p9_psi_scom.H>
 
-extern "C" {
 
-///----------------------------------------------------------------------------
+///-----------------------------------------------------------------------------
 /// Function definitions
-///----------------------------------------------------------------------------
-
-///
-/// @brief p9_psi_scominit procedure entry point
-/// See doxygen in p9_psi_scominit.H
-///
-    fapi2::ReturnCode p9_psi_scominit(
-        const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target)
-    {
-        FAPI_DBG("Entering p9_psi_scominit");
-        fapi2::ReturnCode rc;
-
-        FAPI_EXEC_HWP(rc, p9_psi_scom, i_target);
-
-        FAPI_DBG("Exiting p9_psi_scominit");
-
-        return rc;
-    }
-
-} // extern "C"
+///-----------------------------------------------------------------------------
+
+fapi2::ReturnCode
+p9_psi_scominit(
+    const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target)
+{
+    fapi2::ReturnCode l_rc;
+
+    FAPI_DBG("Start");
+    FAPI_EXEC_HWP(l_rc, p9_psi_scom, i_target);
+    FAPI_DBG("End");
+    return l_rc;
+}
diff --git a/src/import/chips/p9/procedures/hwp/nest/p9_psi_scominit.H b/src/import/chips/p9/procedures/hwp/nest/p9_psi_scominit.H
index 805018c33..fe866740b 100644
--- a/src/import/chips/p9/procedures/hwp/nest/p9_psi_scominit.H
+++ b/src/import/chips/p9/procedures/hwp/nest/p9_psi_scominit.H
@@ -5,7 +5,7 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* Contributors Listed Below - COPYRIGHT 2015,2016                        */
+/* Contributors Listed Below - COPYRIGHT 2015,2017                        */
 /* [+] International Business Machines Corp.                              */
 /*                                                                        */
 /*                                                                        */
@@ -22,20 +22,20 @@
 /* permissions and limitations under the License.                         */
 /*                                                                        */
 /* IBM_PROLOG_END_TAG                                                     */
-/// ----------------------------------------------------------------------------
-/// @file  p9_psi_scominit.H
 ///
-/// @brief p9_psi_scominit HWP
+/// @file  p9_psi_scominit.H
+/// @brief Perform PSI SCOM initialization (FAPI2)
 ///
-/// Initializes PSI SCOM of the target proc.
+/// @author Joe McGill <jmcgill@us.ibm.com>
 ///
-/// ----------------------------------------------------------------------------
-/// *HWP HWP Owner   : Joe McGill <jmcgill@us.ibm.com>
-/// *HWP FW Owner    : Thi Tran <thi@us.ibm.com>
-/// *HWP Team        : Nest
-/// *HWP Level       : 1
-/// *HWP Consumed by : HB
-/// ----------------------------------------------------------------------------
+
+//
+// *HWP HWP Owner : Joe McGill <jmcgill@us.ibm.com>
+// *HWP FW Owner : Thi Tran <thi@us.ibm.com>
+// *HWP Team : Nest
+// *HWP Level : 3
+// *HWP Consumed by : HB
+//
 
 #ifndef _P9_PSI_SCOMINIT_H_
 #define _P9_PSI_SCOMINIT_H_
@@ -45,13 +45,13 @@
 //------------------------------------------------------------------------------
 #include <fapi2.H>
 
-// Function pointer typedef definition for HWP call support
-typedef fapi2::ReturnCode (*p9_psi_scominit_FP_t)(
-    const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>&);
 
 //----------------------------------------------------------------------------
-// Constant definitions
+// Structure definitions
 //----------------------------------------------------------------------------
+// Function pointer typedef definition for HWP call support
+typedef fapi2::ReturnCode (*p9_psi_scominit_FP_t)(
+    const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>&);
 
 
 //------------------------------------------------------------------------------
@@ -64,10 +64,9 @@ extern "C"
 ///
 /// @brief p9_psi_scominit procedure
 ///
-/// Initializes PSI SCOM of the target proc.
-///
-/// @param[in]  i_target   Reference to TARGET_TYPE_PROC_CHIP target
+/// Initializes PSI unit SCOM registers of the target processor
 ///
+/// @param[in] i_target Reference to TARGET_TYPE_PROC_CHIP target
 /// @return FAPI2_RC_SUCCESS if success, else error code.
 ///