L3 update -- p9_htm_setup/pause/start/stop HWPs

Change-Id: Ib08d967d8d70a8ec8ba9c1c53adb3291d1d2135c
RTC:139541
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/41498
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: Hostboot CI <hostboot-ci+hostboot@us.ibm.com>
Reviewed-by: Joseph J. McGill <jmcgill@us.ibm.com>
Reviewed-by: Benjamin Gass <bgass@us.ibm.com>
Reviewed-by: Jennifer A. Stofer <stofer@us.ibm.com>
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/41509
Reviewed-by: Hostboot Team <hostboot@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: Daniel M. Crowell <dcrowell@us.ibm.com>

10 files changed, 48 insertions, 43 deletions

diff --git a/src/import/chips/p9/procedures/hwp/nest/p9_htm_adu_ctrl.C b/src/import/chips/p9/procedures/hwp/nest/p9_htm_adu_ctrl.C
index af6d69e7a..6db4baf70 100644
--- a/src/import/chips/p9/procedures/hwp/nest/p9_htm_adu_ctrl.C
+++ b/src/import/chips/p9/procedures/hwp/nest/p9_htm_adu_ctrl.C
@@ -31,7 +31,7 @@
 /// *HWP HWP Owner   : Joe McGill <jmcgill@us.ibm.com>
 /// *HWP FW Owner    : Thi Tran <thi@us.ibm.com>
 /// *HWP Team        : Nest
-/// *HWP Level       : 2
+/// *HWP Level       : 3
 /// *HWP Consumed by : HB
 ///----------------------------------------------------------------------------
 
@@ -70,21 +70,16 @@ fapi2::ReturnCode aduNHTMControl(
     l_adu_oper_flag.setTransactionSize(p9_ADU_oper_flag::TSIZE_2);
 
     // Acquire ADU lock
-    l_rc = p9_adu_coherent_manage_lock( i_target,
-                                        false,
-                                        true,           // Acquire lock
-                                        l_num_attempts);
-
-    if (l_rc)
-    {
-        FAPI_ERR("Error from p9_adu_coherent_manage_lock (acquire all)");
-        goto fapi_try_exit;
-    }
+    FAPI_TRY(p9_adu_coherent_manage_lock( i_target,
+                                          false,
+                                          true,           // Acquire lock
+                                          l_num_attempts),
+             "Error from p9_adu_coherent_manage_lock (acquire all)");
 
     // NOTE: lock is now held, if an operation fails from this point
-    //       to the end of the procedure.
-    // Reset lock
+    //       to the end of the procedure, need to reset and unlock.
     l_adu_is_dirty = true;
+
     // Reset ADU
     l_rc = p9_adu_coherent_utils_reset_adu(i_target);
 
@@ -94,7 +89,7 @@ fapi2::ReturnCode aduNHTMControl(
         goto adu_reset_unlock;
     }
 
-    // issue operation
+    // Issue operation
     l_rc = p9_adu_coherent_setup_adu(i_target,
                                      i_addr,
                                      false,      // write
@@ -156,7 +151,7 @@ fapi2::ReturnCode aduNHTMControl(
     }
 
     FAPI_DBG("All ADU locks released");
-    // no error for entire operation
+    // No error for entire operation
     l_adu_is_dirty = false;
 
 adu_reset_unlock:
diff --git a/src/import/chips/p9/procedures/hwp/nest/p9_htm_adu_ctrl.H b/src/import/chips/p9/procedures/hwp/nest/p9_htm_adu_ctrl.H
index f65da3107..d06fad33a 100644
--- a/src/import/chips/p9/procedures/hwp/nest/p9_htm_adu_ctrl.H
+++ b/src/import/chips/p9/procedures/hwp/nest/p9_htm_adu_ctrl.H
@@ -5,7 +5,7 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* Contributors Listed Below - COPYRIGHT 2016                             */
+/* Contributors Listed Below - COPYRIGHT 2016,2017                        */
 /* [+] International Business Machines Corp.                              */
 /*                                                                        */
 /*                                                                        */
@@ -31,7 +31,7 @@
 /// *HWP HWP Owner   : Joe McGill <jmcgill@us.ibm.com>
 /// *HWP FW Owner    : Thi Tran <thi@us.ibm.com>
 /// *HWP Team        : Nest
-/// *HWP Level       : 2
+/// *HWP Level       : 3
 /// *HWP Consumed by : HB
 /// ----------------------------------------------------------------------------
 
@@ -47,10 +47,10 @@
 // Function prototypes
 //------------------------------------------------------------------------------
 ///
-/// @brief Use ADU to trigger start/stop globally the NHTM engines
+/// @brief Use ADU to globally trigger start/stop NHTM engines
 ///
 /// @param[in] i_target        Reference to target
-/// @param[in] i_address       Address of PMISC command that should have
+/// @param[in] i_addr          Address of PMISC command that should have
 ///                            the start/stop/pause bits set accordingly.
 ///
 ///
diff --git a/src/import/chips/p9/procedures/hwp/nest/p9_htm_def.H b/src/import/chips/p9/procedures/hwp/nest/p9_htm_def.H
index c5928eb3d..b9a37b66b 100644
--- a/src/import/chips/p9/procedures/hwp/nest/p9_htm_def.H
+++ b/src/import/chips/p9/procedures/hwp/nest/p9_htm_def.H
@@ -5,7 +5,7 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* Contributors Listed Below - COPYRIGHT 2016                             */
+/* Contributors Listed Below - COPYRIGHT 2016,2017                        */
 /* [+] International Business Machines Corp.                              */
 /*                                                                        */
 /*                                                                        */
@@ -31,7 +31,7 @@
 /// *HWP HWP Owner   : Joe McGill <jmcgill@us.ibm.com>
 /// *HWP FW Owner    : Thi Tran <thi@us.ibm.com>
 /// *HWP Team        : Nest
-/// *HWP Level       : 2
+/// *HWP Level       : 3
 /// *HWP Consumed by : HB
 /// ----------------------------------------------------------------------------
 #ifndef _P9_HTM_DEF_H_
diff --git a/src/import/chips/p9/procedures/hwp/nest/p9_htm_reset.C b/src/import/chips/p9/procedures/hwp/nest/p9_htm_reset.C
index 27ec982cf..ecb20a9f7 100644
--- a/src/import/chips/p9/procedures/hwp/nest/p9_htm_reset.C
+++ b/src/import/chips/p9/procedures/hwp/nest/p9_htm_reset.C
@@ -5,7 +5,7 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* Contributors Listed Below - COPYRIGHT 2016                             */
+/* Contributors Listed Below - COPYRIGHT 2016,2017                        */
 /* [+] International Business Machines Corp.                              */
 /*                                                                        */
 /*                                                                        */
@@ -23,7 +23,7 @@
 /*                                                                        */
 /* IBM_PROLOG_END_TAG                                                     */
 /// ----------------------------------------------------------------------------
-/// @file  p9_htm_reset.H
+/// @file  p9_htm_reset.C
 ///
 /// @brief Reset the HTM engines on a processor chip
 ///
@@ -31,7 +31,7 @@
 /// *HWP HWP Owner   : Joe McGill <jmcgill@us.ibm.com>
 /// *HWP FW Owner    : Thi Tran <thi@us.ibm.com>
 /// *HWP Team        : Nest
-/// *HWP Level       : 2
+/// *HWP Level       : 3
 /// *HWP Consumed by : HB
 ///----------------------------------------------------------------------------
 
@@ -175,7 +175,7 @@ fapi2::ReturnCode resetHTM(const fapi2::Target<fapi2::TARGET_TYPE_CORE>& i_targe
     FAPI_DBG("Entering");
     fapi2::ReturnCode l_rc;
 
-    // TODO: Need to find out what to do to reset IMA trace.
+    // Place holder to reset IMA trace.
 
     FAPI_DBG("Exiting");
     return fapi2::current_err;
diff --git a/src/import/chips/p9/procedures/hwp/nest/p9_htm_reset.H b/src/import/chips/p9/procedures/hwp/nest/p9_htm_reset.H
index 74a1b2d97..3b742f458 100644
--- a/src/import/chips/p9/procedures/hwp/nest/p9_htm_reset.H
+++ b/src/import/chips/p9/procedures/hwp/nest/p9_htm_reset.H
@@ -5,7 +5,7 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* Contributors Listed Below - COPYRIGHT 2016                             */
+/* Contributors Listed Below - COPYRIGHT 2016,2017                        */
 /* [+] International Business Machines Corp.                              */
 /*                                                                        */
 /*                                                                        */
@@ -31,7 +31,7 @@
 /// *HWP HWP Owner   : Joe McGill <jmcgill@us.ibm.com>
 /// *HWP FW Owner    : Thi Tran <thi@us.ibm.com>
 /// *HWP Team        : Nest
-/// *HWP Level       : 2
+/// *HWP Level       : 3
 /// *HWP Consumed by : HB
 /// ----------------------------------------------------------------------------
 
@@ -61,7 +61,6 @@ typedef fapi2::ReturnCode (*p9_htm_reset_FP_t)(
 ///
 extern "C"
 {
-
     fapi2::ReturnCode p9_htm_reset(
         const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target);
 
diff --git a/src/import/chips/p9/procedures/hwp/nest/p9_htm_setup.C b/src/import/chips/p9/procedures/hwp/nest/p9_htm_setup.C
index a7e6d79c8..ec3d16153 100755
--- a/src/import/chips/p9/procedures/hwp/nest/p9_htm_setup.C
+++ b/src/import/chips/p9/procedures/hwp/nest/p9_htm_setup.C
@@ -35,7 +35,7 @@
 /// *HWP HWP Owner   : Joe McGill <jmcgill@us.ibm.com>
 /// *HWP FW Owner    : Thi Tran <thi@us.ibm.com>
 /// *HWP Team        : Nest
-/// *HWP Level       : 2
+/// *HWP Level       : 3
 /// *HWP Consumed by : HB
 ///----------------------------------------------------------------------------
 
diff --git a/src/import/chips/p9/procedures/hwp/nest/p9_htm_setup.H b/src/import/chips/p9/procedures/hwp/nest/p9_htm_setup.H
index a63fd3992..b5f751f3d 100755
--- a/src/import/chips/p9/procedures/hwp/nest/p9_htm_setup.H
+++ b/src/import/chips/p9/procedures/hwp/nest/p9_htm_setup.H
@@ -5,7 +5,7 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* Contributors Listed Below - COPYRIGHT 2015,2016                        */
+/* Contributors Listed Below - COPYRIGHT 2015,2017                        */
 /* [+] International Business Machines Corp.                              */
 /*                                                                        */
 /*                                                                        */
@@ -27,8 +27,7 @@
 ///
 /// @brief Perform p9_htm_setup on a processor chip
 ///
-/// The purpose of this procedure is to setup HTM on a processor
-/// chip.
+/// The purpose of this procedure is to setup HTM on a processor chip.
 ///
 /// Some start/setup attributes are used as part of the setup process.
 ///
@@ -36,7 +35,7 @@
 /// *HWP HWP Owner   : Joe McGill <jmcgill@us.ibm.com>
 /// *HWP FW Owner    : Thi Tran <thi@us.ibm.com>
 /// *HWP Team        : Nest
-/// *HWP Level       : 2
+/// *HWP Level       : 3
 /// *HWP Consumed by : HB
 /// ----------------------------------------------------------------------------
 
@@ -80,11 +79,10 @@ extern "C"
 ///
 /// @brief p9_htm_setup procedure
 ///
-/// The purpose of this procedure is to setup HTM on a processor
-/// chip.
+/// The purpose of this procedure is to setup HTM on a processor chip.
 ///
 /// @param[in]    i_target   Reference to TARGET_TYPE_PROC_CHIP target.
-/// @param[in]    i_start    Start HTM after setup.
+/// @param[in]    i_start    Call HTM start after setting up.
 ///
 /// @return FAPI2_RC_SUCCESS if success, else error code.
 ///
diff --git a/src/import/chips/p9/procedures/hwp/nest/p9_htm_start.C b/src/import/chips/p9/procedures/hwp/nest/p9_htm_start.C
index 6541930da..5750155db 100755
--- a/src/import/chips/p9/procedures/hwp/nest/p9_htm_start.C
+++ b/src/import/chips/p9/procedures/hwp/nest/p9_htm_start.C
@@ -5,7 +5,7 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* Contributors Listed Below - COPYRIGHT 2015,2016                        */
+/* Contributors Listed Below - COPYRIGHT 2015,2017                        */
 /* [+] International Business Machines Corp.                              */
 /*                                                                        */
 /*                                                                        */
@@ -35,7 +35,7 @@
 /// *HWP HWP Owner   : Joe McGill <jmcgill@us.ibm.com>
 /// *HWP FW Owner    : Thi Tran <thi@us.ibm.com>
 /// *HWP Team        : Nest
-/// *HWP Level       : 2
+/// *HWP Level       : 3
 /// *HWP Consumed by : HB
 ///----------------------------------------------------------------------------
 
@@ -242,7 +242,6 @@ extern "C" {
                          "p9_htm_start: startHTM() returns error: CHTM %u, "
                          "l_rc 0x%.8X", l_corePos, (uint64_t)fapi2::current_err );
             }
-
         }
 
     fapi_try_exit:
diff --git a/src/import/chips/p9/procedures/hwp/nest/p9_htm_start.H b/src/import/chips/p9/procedures/hwp/nest/p9_htm_start.H
index ab4f67dce..5123a8808 100755
--- a/src/import/chips/p9/procedures/hwp/nest/p9_htm_start.H
+++ b/src/import/chips/p9/procedures/hwp/nest/p9_htm_start.H
@@ -5,7 +5,7 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* Contributors Listed Below - COPYRIGHT 2015,2016                        */
+/* Contributors Listed Below - COPYRIGHT 2015,2017                        */
 /* [+] International Business Machines Corp.                              */
 /*                                                                        */
 /*                                                                        */
@@ -35,7 +35,7 @@
 /// *HWP HWP Owner   : Joe McGill <jmcgill@us.ibm.com>
 /// *HWP FW Owner    : Thi Tran <thi@us.ibm.com>
 /// *HWP Team        : Nest
-/// *HWP Level       : 2
+/// *HWP Level       : 3
 /// *HWP Consumed by : HB
 /// ----------------------------------------------------------------------------
 
@@ -66,7 +66,6 @@ typedef fapi2::ReturnCode (*p9_htm_start_FP_t)(
 ///
 extern "C"
 {
-
     fapi2::ReturnCode p9_htm_start(
         const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target);
 
diff --git a/src/import/chips/p9/procedures/xml/error_info/p9_htm_setup_errors.xml b/src/import/chips/p9/procedures/xml/error_info/p9_htm_setup_errors.xml
index 7effa577e..2c4134ec0 100644
--- a/src/import/chips/p9/procedures/xml/error_info/p9_htm_setup_errors.xml
+++ b/src/import/chips/p9/procedures/xml/error_info/p9_htm_setup_errors.xml
@@ -5,7 +5,7 @@
 <!--                                                                        -->
 <!-- OpenPOWER HostBoot Project                                             -->
 <!--                                                                        -->
-<!-- Contributors Listed Below - COPYRIGHT 2015,2016                        -->
+<!-- Contributors Listed Below - COPYRIGHT 2015,2017                        -->
 <!-- [+] International Business Machines Corp.                              -->
 <!--                                                                        -->
 <!--                                                                        -->
@@ -49,9 +49,14 @@
     <ffdc>HTM_STATUS_REG_NHTM0</ffdc>
     <ffdc>HTM_STATUS_REG_NHTM1</ffdc>
     <callout>
+      <target>TARGET</target>
+      <priority>HIGH</priority>
+    </callout>
+    <callout>
       <procedure>CODE</procedure>
       <priority>LOW</priority>
     </callout>
+    <!-- No need to deconfigure/gard chip as this is a debug functionality -->
 </hwpError>
 
 <hwpError>
@@ -62,9 +67,14 @@
     <ffdc>TARGET</ffdc>
     <ffdc>HTM_STATUS_REG</ffdc>
     <callout>
+      <target>TARGET</target>
+      <priority>HIGH</priority>
+    </callout>
+    <callout>
       <procedure>CODE</procedure>
       <priority>LOW</priority>
     </callout>
+    <!-- No need to deconfigure/gard chip as this is a debug functionality -->
 </hwpError>
 
 <hwpError>
@@ -77,9 +87,14 @@
     <ffdc>HTM_STATUS_REG_NHTM0</ffdc>
     <ffdc>HTM_STATUS_REG_NHTM1</ffdc>
     <callout>
+      <target>TARGET</target>
+      <priority>HIGH</priority>
+    </callout>
+    <callout>
       <procedure>CODE</procedure>
       <priority>LOW</priority>
     </callout>
+    <!-- No need to deconfigure/gard chip as this is a debug functionality -->
 </hwpError>
 
 <hwpError>