p9_pm_occ_gpe_init: Level 2 - Fapi 1.0 to Fapi 2.0 transliteration

Change-Id: Ib132e307eeee13899a1097509dbffd08cdf511b0
RTC: 137028
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/23358
Tested-by: Jenkins Server
Reviewed-by: Gregory S. Still <stillgs@us.ibm.com>
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/25635
Tested-by: FSP CI Jenkins
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>

3 files changed, 175 insertions, 63 deletions

diff --git a/src/import/chips/p9/procedures/hwp/pm/p9_pm_occ_gpe_init.C b/src/import/chips/p9/procedures/hwp/pm/p9_pm_occ_gpe_init.C
index 280f64b6b..96b331518 100644
--- a/src/import/chips/p9/procedures/hwp/pm/p9_pm_occ_gpe_init.C
+++ b/src/import/chips/p9/procedures/hwp/pm/p9_pm_occ_gpe_init.C
@@ -7,7 +7,7 @@
 /*                                                                        */
 /* EKB Project                                                            */
 /*                                                                        */
-/* COPYRIGHT 2015                                                         */
+/* COPYRIGHT 2015,2016                                                    */
 /* [+] International Business Machines Corp.                              */
 /*                                                                        */
 /*                                                                        */
@@ -18,94 +18,176 @@
 /* IBM_PROLOG_END_TAG                                                     */
 ///
 /// @file p9_pm_occ_gpe_init.C
-/// @brief Configure or reset the targeted GPE0 and/or GPE1
+/// @brief Initialize or reset the targeted GPE0 and/or GPE1
 ///
 // *HWP HWP Owner: Greg Still  <stillgs@us.ibm.com>
-// *HWP FW  Owner: Sunil Kumar <skumar8j@in.ibm.com>
+// *HWP FW  Owner: Sangeetha T S <sangeet2@in.ibm.com>
 // *HWP Team: PM
-// *HWP Level: 1
+// *HWP Level: 2
 // *HWP Consumed by: HS
 
 ///
-/// todo add to required proc ENUM requests
-///
 /// High-level procedure flow:
 /// \verbatim
 ///
 ///     Check for valid parameters
-///     if PM_CONFIG {
-///        Do nothing (done by OCC programs)
-///     } else if PM_RESET {
+///     if PM_RESET {
 ///         for each GPE,
-///             set and then reset bit 0 in the GPEx_RESET_REGISTER
-///
+///             halt the GPE
+///             wait for the GPE to become inactive
+///             clear instruction address register
+///             clear interrupt vector prefix register
+///     }
+///     if PM_INIT {
+///         operation performed by OC firmware.
+///         Thus, noop
 ///     }
 ///
 ///  Procedure Prereq:
 ///     - System clocks are running
+///
 /// \endverbatim
 ///
 
-// ----------------------------------------------------------------------
+// -----------------------------------------------------------------------------
 // Includes
-// ----------------------------------------------------------------------
-
-#include "p9_pm_occ_gpe_init.H"
+// -----------------------------------------------------------------------------
+#include <p9_pm_occ_gpe_init.H>
 
-// ----------------------------------------------------------------------
-// Constant definitions
-// ----------------------------------------------------------------------
+// -----------------------------------------------------------------------------
+// Constants
+// -----------------------------------------------------------------------------
+const uint64_t OCC_GPE_HALT = 0x1;
 
-// ----------------------------------------------------------------------
-// Global variables
-// ----------------------------------------------------------------------
-
-enum POREGPE_ENGINES
-{
-    GPE0        = 0x0,
-    GPE1        = 0x1,
-    GPEALL      = 0XF
-};
-
-// ----------------------------------------------------------------------
+// -----------------------------------------------------------------------------
 // Function prototypes
-// ----------------------------------------------------------------------
+// -----------------------------------------------------------------------------
 
+//------------------------------------------------------------------------------
+/// OCC GPE Reset Function
+//------------------------------------------------------------------------------
+/// @brief Reset the targeted GPE0 and/or GPE1
+///
+/// param[in] i_target   Chip target
+/// param[in] i_engine   Targeted engine:  GPE0, GPE1, GPEALL
+///
+/// @return FAPI2_RC_SUCCESS incase of success or error code
+///
 fapi2::ReturnCode pm_occ_gpe_reset(
     const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target,
-    const uint32_t i_engine);
+    const p9occgpe::GPE_ENGINES i_engine);
 
-// ----------------------------------------------------------------------
+// -----------------------------------------------------------------------------
 // Function definitions
-// ----------------------------------------------------------------------
+// -----------------------------------------------------------------------------
 
 fapi2::ReturnCode p9_pm_occ_gpe_init(
     const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target,
-    const p9pm::P9_PM_FLOW_MODE i_mode, const uint32_t i_engine)
+    const p9pm::PM_FLOW_MODE i_mode,
+    const p9occgpe::GPE_ENGINES i_engine)
 {
     FAPI_IMP("p9_pm_occ_gpe_init Enter");
 
+    // Initialization:  perform order or dynamic operations to initialize
+    // the GPEs using necessary Platform or Feature attributes.
+    if (i_mode == p9pm::PM_INIT)
+    {
+        FAPI_INF("OCC-GPE initialization and start-up is performed by "
+                 "OCC firmware. No action taken here");
+    }
+    // Reset:  perform reset of GPE engines so that they can be reconfigured
+    // and reinitialized
+    else if (i_mode == p9pm::PM_RESET)
+    {
+        if (i_engine == p9occgpe::GPE0 || i_engine == p9occgpe::GPEALL)
+        {
+            FAPI_TRY(pm_occ_gpe_reset(i_target, p9occgpe::GPE0),
+                     "ERROR: Failed to reset GPE0");
+        }
+
+        if (i_engine == p9occgpe::GPE1 || i_engine == p9occgpe::GPEALL)
+        {
+            FAPI_TRY(pm_occ_gpe_reset(i_target, p9occgpe::GPE1),
+                     "ERROR: Failed to reset GPE1");
+        }
+    }
+    else
+    {
+        FAPI_ASSERT(false,
+                    fapi2::PM_OCC_GPE_BAD_MODE().set_BADMODE(i_mode),
+                    "Unknown mode 0x%X passed to p9_pm_occ_gpe_init", i_mode);
+    }
+
+fapi_try_exit:
     FAPI_IMP("p9_pm_occ_gpe_init Exit");
-    return fapi2::FAPI2_RC_SUCCESS;
+    return fapi2::current_err;
 }
 
-//--------------------------------------------------------------------------
-/// PORE GPE Reset Function
-//--------------------------------------------------------------------------
-/// @brief Reset the targeted GPE0 and/or GPE1
-///
-/// param[in] i_target   Chip target
-/// param[in] i_engine   Targeted engine:  GPE0, GPE1, GPEALL
-///
-/// @return FAPI2_RC_SUCCESS incase of success
-///         error code otherwise
-
-fapi2::ReturnCode
-pm_occ_gpe_reset(const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target,
-                 const uint32_t i_engine)
+fapi2::ReturnCode pm_occ_gpe_reset(
+    const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target,
+    const p9occgpe::GPE_ENGINES i_engine)
 {
     FAPI_IMP("pm_occ_gpe_reset Enter");
 
-    return fapi2::FAPI2_RC_SUCCESS;
-}
+    fapi2::buffer<uint64_t> l_data64;
+    uint64_t l_controlReg = 0;
+    uint64_t l_statusReg = 0;
+    uint64_t l_instrAddrReg = 0;
+    uint64_t l_intVecReg = 0;
+    uint32_t l_pollCount = 10; // poll 10 times
+    uint32_t l_timeout = 1; // in micro seconds;
+
+    if (i_engine == p9occgpe::GPE0)
+    {
+        l_controlReg = PU_GPE0_PPE_XIXCR;
+        l_statusReg = PU_GPE0_GPEXIXSR_SCOM;
+        l_instrAddrReg = PU_GPE0_PPE_XIDBGPRO;
+        l_intVecReg = PU_GPE0_GPEIVPR_SCOM;
+    }
+    else if (i_engine == p9occgpe::GPE1)
+    {
+        l_controlReg = PU_GPE1_PPE_XIXCR;
+        l_statusReg = PU_GPE1_GPEXIXSR_SCOM;
+        l_instrAddrReg = PU_GPE1_PPE_XIDBGPRO;
+        l_intVecReg = PU_GPE1_GPEIVPR_SCOM;
+    }
 
+    // Halt the OCC GPE
+    l_data64.flush<0>().insertFromRight(OCC_GPE_HALT, 1, 3);
+    FAPI_TRY(putScom(i_target, l_controlReg, l_data64),
+             "ERROR: Failed to halt the OCC GPE");
+
+    // Wait for OCC GPE to halt
+    do
+    {
+        FAPI_TRY(fapi2::getScom(i_target, l_statusReg, l_data64),
+                 "ERROR: Failed to get the OCC GPE status");
+
+        if (l_data64.getBit<0>() == 1)
+        {
+            FAPI_INF("OCC GPE has been halted");
+            break;
+        }
+
+        FAPI_TRY(fapi2::delay(l_timeout * 1000, 200000),
+                 " fapi2::delay Failed. ");   // In microseconds
+    }
+    while(--l_pollCount != 0);
+
+    FAPI_ASSERT((l_pollCount != 0),
+                fapi2::PM_OCC_GPE_RESET_TIMEOUT()
+                .set_OCCGPESTATUS(l_data64),
+                "OCC GPE could not be halted during reset operation.");
+
+    //Clear status (Instruction Address) register
+    l_data64.flush<0>();
+    FAPI_TRY(fapi2::putScom(i_target, l_instrAddrReg, l_data64),
+             "ERROR: Failed to Clear the status register");
+
+    //Clear Interrupt vector prefix register
+    FAPI_TRY(putScom(i_target, l_intVecReg, l_data64),
+             "ERROR: Failed to clear interrupt vector prefix register");
+
+fapi_try_exit:
+    return fapi2::current_err;
+}
diff --git a/src/import/chips/p9/procedures/hwp/pm/p9_pm_occ_gpe_init.H b/src/import/chips/p9/procedures/hwp/pm/p9_pm_occ_gpe_init.H
index 0ceab6e03..64b1eb38b 100644
--- a/src/import/chips/p9/procedures/hwp/pm/p9_pm_occ_gpe_init.H
+++ b/src/import/chips/p9/procedures/hwp/pm/p9_pm_occ_gpe_init.H
@@ -7,7 +7,7 @@
 /*                                                                        */
 /* EKB Project                                                            */
 /*                                                                        */
-/* COPYRIGHT 2015                                                         */
+/* COPYRIGHT 2015,2016                                                    */
 /* [+] International Business Machines Corp.                              */
 /*                                                                        */
 /*                                                                        */
@@ -18,28 +18,37 @@
 /* IBM_PROLOG_END_TAG                                                     */
 ///
 /// @file p9_pm_occ_gpe_init.H
-/// @brief Configure or reset the targeted GPE0 and/or GPE1
+/// @brief Initialize or reset the targeted GPE0 and/or GPE1
 ///
 /// *HWP HWP Owner: Greg Still  <stillgs@us.ibm.com>
-/// *HWP FW  Owner: Sunil Kumar <skumar8j@in.ibm.com>
+/// *HWP FW  Owner: Sangeetha T S <sangeet2@in.ibm.com>
 /// *HWP Team: PM
-/// *HWP Level: 1
+/// *HWP Level: 2
 /// *HWP Consumed by: HS
 ///
 
 #ifndef _P9_PM_OCC_GPE_INIT_H
 #define _P9_PM_OCC_GPE_INIT_H
 
-#include <fapi2.H>
-#include <p9_pm.H>
-
 //------------------------------------------------------------------------------
 // Includes
 //------------------------------------------------------------------------------
+#include <fapi2.H>
+#include <p9_pm.H>
+#include <p9_misc_scom_addresses.H>
 
 //------------------------------------------------------------------------------
 // Constant definitions
 //------------------------------------------------------------------------------
+namespace p9occgpe
+{
+enum GPE_ENGINES
+{
+    GPE0        = 0x0,
+    GPE1        = 0x1,
+    GPEALL      = 0XF
+};
+}
 
 //------------------------------------------------------------------------------
 // Parameter structure definitions
@@ -48,8 +57,8 @@
 // function pointer typedef definition for HWP call support
 typedef fapi2::ReturnCode (*p9_pm_occ_gpe_init_FP_t) (
     const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>&,
-    const p9pm::P9_PM_FLOW_MODE,
-    const uint32_t);
+    const p9pm::PM_FLOW_MODE,
+    const p9occgpe::GPE_ENGINES);
 
 extern "C"
 {
@@ -61,7 +70,7 @@ extern "C"
 /// @brief Configure or reset the targeted GPE0 and/or GPE1
 ///
 /// param[in] i_target   Chip target
-/// param[in] i_mode     Control mode for the procedure (PM_CONFIG, PM_RESET)
+/// param[in] i_mode     Control mode for the procedure (PM_INIT, PM_RESET)
 /// param[in] i_engine   Targeted engine:  GPE0, GPE1, GPEALL
 
 /// @return FAPI2_RC_SUCCESS in case of success
@@ -69,6 +78,7 @@ extern "C"
 
     fapi2::ReturnCode
     p9_pm_occ_gpe_init(const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target,
-                       const p9pm::P9_PM_FLOW_MODE i_mode, const uint32_t i_engine);
+                       const p9pm::PM_FLOW_MODE i_mode,
+                       const p9occgpe::GPE_ENGINES i_engine);
 } //extern "C"
 #endif // P9_PM_OCC_GPE_INIT_H
diff --git a/src/import/chips/p9/procedures/hwp/pm/p9_pm_occ_gpe_init.mk b/src/import/chips/p9/procedures/hwp/pm/p9_pm_occ_gpe_init.mk
new file mode 100644
index 000000000..36c102549
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/pm/p9_pm_occ_gpe_init.mk
@@ -0,0 +1,20 @@
+# IBM_PROLOG_BEGIN_TAG
+# This is an automatically generated prolog.
+#
+# $Source: chips/p9/procedures/hwp/pm/p9_pm_occ_gpe_init.mk $
+#
+# IBM CONFIDENTIAL
+#
+# EKB Project
+#
+# COPYRIGHT 2016
+# [+] International Business Machines Corp.
+#
+#
+# The source code for this program is not published or otherwise
+# divested of its trade secrets, irrespective of what has been
+# deposited with the U.S. Copyright Office.
+#
+# IBM_PROLOG_END_TAG
+PROCEDURE=p9_pm_occ_gpe_init
+$(call BUILD_PROCEDURE)