Add proc_revert_sbe_mcs_setup HWP to Hostboot

This was a late addition to the 07/15 milestone (Run Grub)

Change-Id: I5a72c83e1481207e47d5351a116174b180021ab6
RTC: 44247
Reviewed-on: http://gfw160.austin.ibm.com:8080/gerrit/1289
Tested-by: Jenkins Server
Reviewed-by: Van H. Lee <vanlee@us.ibm.com>
Reviewed-by: CAMVAN T. NGUYEN <ctnguyen@us.ibm.com>
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>

5 files changed, 560 insertions, 0 deletions

diff --git a/src/usr/hwpf/hwp/slave_sbe/makefile b/src/usr/hwpf/hwp/slave_sbe/makefile
new file mode 100644
index 000000000..6788d7d5c
--- /dev/null
+++ b/src/usr/hwpf/hwp/slave_sbe/makefile
@@ -0,0 +1,49 @@
+#   IBM_PROLOG_BEGIN_TAG
+#  This is an automatically generated prolog.
+#
+#  $Source: src/usr/hwpf/hwp/slave_sbe/makefile $
+#
+#  IBM CONFIDENTIAL
+#
+#  COPYRIGHT International Business Machines Corp. 2012
+#
+#  p1
+#
+#  Object Code Only (OCO) source materials
+#  Licensed Internal Code Source Materials
+#  IBM HostBoot Licensed Internal Code
+#
+#  The source code for this program is not published or other-
+#  wise divested of its trade secrets, irrespective of what has
+#  been deposited with the U.S. Copyright Office.
+#
+#  Origin: 30
+#
+#  IBM_PROLOG_END_TAG
+ROOTPATH = ../../../../..
+
+MODULE = slave_sbe
+
+##      support for Targeting and fapi
+EXTRAINCDIR += ${ROOTPATH}/src/include/usr/ecmddatabuffer
+EXTRAINCDIR += ${ROOTPATH}/src/include/usr/hwpf/fapi
+EXTRAINCDIR += ${ROOTPATH}/src/include/usr/hwpf/plat
+EXTRAINCDIR += ${ROOTPATH}/src/include/usr/hwpf/hwp
+
+## pointer to common HWP files
+EXTRAINCDIR += ${ROOTPATH}/src/usr/hwpf/hwp/include
+
+##  Include sub dirs
+##  NOTE: add a new EXTRAINCDIR when you add a new HWP
+EXTRAINCDIR += ${ROOTPATH}/src/usr/hwpf/hwp/slave_sbe
+EXTRAINCDIR += ${ROOTPATH}/src/usr/hwpf/hwp/slave_sbe/proc_revert_sbe_mcs_setup
+
+##  NOTE: add new object files when you add a new HWP
+OBJS =  slave_sbe.o \
+		proc_revert_sbe_mcs_setup.o
+        
+##  NOTE: add a new directory onto the vpaths when you add a new HWP
+VPATH += ${ROOTPATH}/src/usr/hwpf/hwp/slave_sbe/proc_revert_sbe_mcs_setup
+
+include ${ROOTPATH}/config.mk
+
diff --git a/src/usr/hwpf/hwp/slave_sbe/proc_revert_sbe_mcs_setup/proc_revert_sbe_mcs_setup.C b/src/usr/hwpf/hwp/slave_sbe/proc_revert_sbe_mcs_setup/proc_revert_sbe_mcs_setup.C
new file mode 100644
index 000000000..af93f6006
--- /dev/null
+++ b/src/usr/hwpf/hwp/slave_sbe/proc_revert_sbe_mcs_setup/proc_revert_sbe_mcs_setup.C
@@ -0,0 +1,224 @@
+/*  IBM_PROLOG_BEGIN_TAG
+ *  This is an automatically generated prolog.
+ *
+ *  $Source: src/usr/hwpf/hwp/slave_sbe/proc_revert_sbe_mcs_setup/proc_revert_sbe_mcs_setup.C $
+ *
+ *  IBM CONFIDENTIAL
+ *
+ *  COPYRIGHT International Business Machines Corp. 2012
+ *
+ *  p1
+ *
+ *  Object Code Only (OCO) source materials
+ *  Licensed Internal Code Source Materials
+ *  IBM HostBoot Licensed Internal Code
+ *
+ *  The source code for this program is not published or other-
+ *  wise divested of its trade secrets, irrespective of what has
+ *  been deposited with the U.S. Copyright Office.
+ *
+ *  Origin: 30
+ *
+ *  IBM_PROLOG_END_TAG
+ */
+// $Id: proc_revert_sbe_mcs_setup.C,v 1.2 2012/06/29 06:15:33 jmcgill Exp $
+// $Source: /afs/awd/projects/eclipz/KnowledgeBase/.cvsroot/eclipz/chips/p8/working/procedures/ipl/fapi/proc_revert_sbe_mcs_setup.C,v $
+//------------------------------------------------------------------------------
+// *|
+// *! (C) Copyright International Business Machines Corp. 2011
+// *! All Rights Reserved -- Property of IBM
+// *! *** IBM Confidential ***
+// *|
+// *! TITLE       : proc_revert_sbe_mcs_setup.C
+// *! DESCRIPTION : Revert MCS configuration applied by SBE (FAPI)
+// *!
+// *! OWNER NAME  : Joe McGill              Email: jmcgill@us.ibm.com
+// *!
+//------------------------------------------------------------------------------
+
+
+//------------------------------------------------------------------------------
+// Includes
+//------------------------------------------------------------------------------
+#include "proc_revert_sbe_mcs_setup.H"
+
+extern "C"
+{
+
+//------------------------------------------------------------------------------
+// Function definitions
+//------------------------------------------------------------------------------
+
+
+//------------------------------------------------------------------------------
+// function: reset MCFGP BAR valid bit, base address and size fields to restore
+//           register flush state
+// parameters: i_target => MCS chiplet target
+// returns: FAPI_RC_SUCCESS if register write is successful,
+//          else failing return code
+//------------------------------------------------------------------------------
+fapi::ReturnCode proc_revert_sbe_mcs_setup_reset_mcfgp(
+    const fapi::Target& i_target)
+{
+    fapi::ReturnCode rc;
+    uint32_t rc_ecmd = 0x0;
+    ecmdDataBufferBase mcfgp_data(64);
+    ecmdDataBufferBase mcfgp_mask(64);
+
+    // mark function entry
+    FAPI_DBG("proc_revert_sbe_mcs_setup_reset_mcfgp: Start");
+
+    do
+    {
+        // clear fields manipulated by SBE (to restore logic flush state)
+        rc_ecmd |= mcfgp_mask.setBit(MCFGP_VALID_BIT);
+        rc_ecmd |= mcfgp_mask.setBit(
+            MCFGP_UNITS_PER_GROUP_START_BIT,
+            (MCFGP_UNITS_PER_GROUP_END_BIT -
+             MCFGP_UNITS_PER_GROUP_START_BIT + 1));
+        rc_ecmd |= mcfgp_mask.setBit(
+            MCFGP_GROUP_MEMBER_ID_START_BIT,
+            (MCFGP_GROUP_MEMBER_ID_END_BIT -
+             MCFGP_GROUP_MEMBER_ID_START_BIT + 1));
+        rc_ecmd |= mcfgp_mask.setBit(
+            MCFGP_GROUP_SIZE_START_BIT,
+            (MCFGP_GROUP_SIZE_END_BIT -
+             MCFGP_GROUP_SIZE_START_BIT + 1));
+        rc_ecmd |= mcfgp_mask.setBit(MCFGP_FASTPATH_ENABLE_BIT);
+        rc_ecmd |= mcfgp_mask.setBit(
+            MCFGP_GROUP_BASE_ADDR_START_BIT,
+            (MCFGP_GROUP_BASE_ADDR_END_BIT -
+             MCFGP_GROUP_BASE_ADDR_START_BIT + 1));
+
+        // check buffer manipulation return code
+        if (rc_ecmd)
+        {
+            FAPI_ERR("proc_revert_sbe_mcs_setup_reset_mcfgp: Error 0x%X setting up MCFGP mask data buffer",
+                     rc_ecmd);
+            rc.setEcmdError(rc_ecmd);
+            break;
+        }
+
+        // write register
+        rc = fapiPutScomUnderMask(i_target,
+                                  MCS_MCFGP_0x02011800,
+                                  mcfgp_data,
+                                  mcfgp_mask);
+        if (!rc.ok())
+        {
+            FAPI_ERR("proc_revert_sbe_mcs_setup_reset_mcfgp: fapiPutScomUnderMask error (MCS_MCFGP_0x02011800)");
+            break;
+        }
+    } while(0);
+
+    // mark function exit
+    FAPI_DBG("proc_revert_sbe_mcs_setup_reset_mcfgp: End");
+    return rc;
+}
+
+
+//------------------------------------------------------------------------------
+// function: set MCI FIR Mask channel timeout bit, to restore register flush
+//           state
+// parameters: i_target => MCS chiplet target
+// returns: FAPI_RC_SUCCESS if register write is successful,
+//          else failing return code
+//------------------------------------------------------------------------------
+fapi::ReturnCode proc_revert_sbe_mcs_setup_reset_mcifirmask(
+    const fapi::Target& i_target)
+{
+    fapi::ReturnCode rc;
+    uint32_t rc_ecmd = 0x0;
+    ecmdDataBufferBase mcifirmask_or_data(64);
+
+    // mark function entry
+    FAPI_DBG("proc_revert_sbe_mcs_setup_reset_mcifirmask: Start");
+
+    do
+    {
+        // set fields manipulated by SBE (to restore logic flush state)
+        rc_ecmd |= mcifirmask_or_data.setBit(
+            MCIFIR_CL_TIMEOUT_DUE_TO_CHANNEL_BIT);
+
+        // check buffer manipulation return code
+        if (rc_ecmd)
+        {
+            FAPI_ERR("proc_revert_sbe_mcs_setup_reset_mcifirmask: Error 0x%X setting up MCI FIR Mask register data buffer",
+                     rc_ecmd);
+            rc.setEcmdError(rc_ecmd);
+            break;
+        }
+
+        // write register
+        rc = fapiPutScom(i_target,
+                         MCS_MCIFIRMASK_OR_0x02011845,
+                         mcifirmask_or_data);
+        if (!rc.ok())
+        {
+            FAPI_ERR("proc_revert_sbe_mcs_setup_reset_mcifirmask: fapiPutScom error (MCS_MCIFIRMASK_OR_0x02011845)");
+            break;
+        }
+    } while(0);
+
+    // mark function exit
+    FAPI_DBG("proc_revert_sbe_mcs_setup_reset_mcifirmask: End");
+    return rc;
+}
+
+
+//------------------------------------------------------------------------------
+// function: proc_revert_sbe_mcs_setup HWP entry point
+//           NOTE: see comments above function prototype in header
+//------------------------------------------------------------------------------
+fapi::ReturnCode proc_revert_sbe_mcs_setup(
+    const fapi::Target& i_target)
+{
+    fapi::ReturnCode rc;
+
+    // vector to hold MCS chiplet targets
+    std::vector<fapi::Target> mcs_chiplets;
+
+    // mark HWP entry
+    FAPI_IMP("proc_revert_sbe_mcs_setup: Entering ...");
+
+    do
+    {
+        // loop over all functional MCS chiplets, revert SBE configuration
+        // of BAR/FIR mask registers back to flush state
+        rc = fapiGetChildChiplets(i_target,
+                                  fapi::TARGET_TYPE_MCS_CHIPLET,
+                                  mcs_chiplets,
+                                  fapi::TARGET_STATE_FUNCTIONAL);
+        if (!rc.ok())
+        {
+            FAPI_ERR("proc_revert_sbe_mcs_setup: Error from fapiGetChildChiplets");
+            break;
+        }
+
+        for (std::vector<fapi::Target>::iterator i = mcs_chiplets.begin();
+             i != mcs_chiplets.end();
+             i++)
+        {
+            rc = proc_revert_sbe_mcs_setup_reset_mcfgp(*i);
+            if (!rc.ok())
+            {
+                FAPI_ERR("proc_revert_sbe_mcs_setup: Error from proc_revert_sbe_mcs_setup_reset_mcfgp");
+                break;
+            }
+
+            rc = proc_revert_sbe_mcs_setup_reset_mcifirmask(*i);
+            if (!rc.ok())
+            {
+                FAPI_ERR("proc_revert_sbe_mcs_setup: Error from proc_revert_sbe_mcs_setup_reset_mcfgp");
+                break;
+            }
+        }
+    } while(0);
+
+    // log function exit
+    FAPI_IMP("proc_revert_sbe_mcs_setup: Exiting ...");
+    return rc;
+}
+
+
+} // extern "C"
diff --git a/src/usr/hwpf/hwp/slave_sbe/proc_revert_sbe_mcs_setup/proc_revert_sbe_mcs_setup.H b/src/usr/hwpf/hwp/slave_sbe/proc_revert_sbe_mcs_setup/proc_revert_sbe_mcs_setup.H
new file mode 100644
index 000000000..f2aeb162b
--- /dev/null
+++ b/src/usr/hwpf/hwp/slave_sbe/proc_revert_sbe_mcs_setup/proc_revert_sbe_mcs_setup.H
@@ -0,0 +1,108 @@
+/*  IBM_PROLOG_BEGIN_TAG
+ *  This is an automatically generated prolog.
+ *
+ *  $Source: src/usr/hwpf/hwp/slave_sbe/proc_revert_sbe_mcs_setup/proc_revert_sbe_mcs_setup.H $
+ *
+ *  IBM CONFIDENTIAL
+ *
+ *  COPYRIGHT International Business Machines Corp. 2012
+ *
+ *  p1
+ *
+ *  Object Code Only (OCO) source materials
+ *  Licensed Internal Code Source Materials
+ *  IBM HostBoot Licensed Internal Code
+ *
+ *  The source code for this program is not published or other-
+ *  wise divested of its trade secrets, irrespective of what has
+ *  been deposited with the U.S. Copyright Office.
+ *
+ *  Origin: 30
+ *
+ *  IBM_PROLOG_END_TAG
+ */
+// $Id: proc_revert_sbe_mcs_setup.H,v 1.1 2012/06/05 07:03:39 jmcgill Exp $
+// $Source: /afs/awd/projects/eclipz/KnowledgeBase/.cvsroot/eclipz/chips/p8/working/procedures/ipl/fapi/proc_revert_sbe_mcs_setup.H,v $
+//------------------------------------------------------------------------------
+// *|
+// *! (C) Copyright International Business Machines Corp. 2011
+// *! All Rights Reserved -- Property of IBM
+// *! *** IBM Confidential ***
+// *|
+// *! TITLE       : proc_revert_sbe_mcs_setup.H
+// *! DESCRIPTION : Revert MCS configuration applied by SBE (FAPI)
+// *!
+// *! OWNER NAME  : Joe McGill              Email: jmcgill@us.ibm.com
+// *!
+// *! ADDITIONAL COMMENTS:
+// *!
+// *! Disable MCS configuration written by SBE to enable initial phase of
+// *! HBI execution (providing lpc_ack for dcbz prior to initialization
+// *! of memory).  Registers touched by SBE (MCFGP, MCIFIRMASK) will be
+// *! reset to flush state by this procedure.
+// *!
+//------------------------------------------------------------------------------
+
+#ifndef _PROC_REVERT_SBE_MCS_SETUP_H_
+#define _PROC_REVERT_SBE_MCS_SETUP_H_
+
+//------------------------------------------------------------------------------
+// Includes
+//------------------------------------------------------------------------------
+
+#include <vector>
+#include <fapi.H>
+#include "p8_scom_addresses.H"
+
+
+//------------------------------------------------------------------------------
+// Constant definitions
+//------------------------------------------------------------------------------
+
+// MCFGP register constants
+const uint32_t MCFGP_VALID_BIT = 0;
+const uint32_t MCFGP_UNITS_PER_GROUP_START_BIT = 1;
+const uint32_t MCFGP_UNITS_PER_GROUP_END_BIT = 3;
+const uint32_t MCFGP_GROUP_MEMBER_ID_START_BIT = 4;
+const uint32_t MCFGP_GROUP_MEMBER_ID_END_BIT = 8;
+const uint32_t MCFGP_GROUP_SIZE_START_BIT = 11;
+const uint32_t MCFGP_GROUP_SIZE_END_BIT = 23;
+const uint32_t MCFGP_FASTPATH_ENABLE_BIT = 25;
+const uint32_t MCFGP_GROUP_BASE_ADDR_START_BIT = 26;
+const uint32_t MCFGP_GROUP_BASE_ADDR_END_BIT = 43;
+
+// MCIFIR register constants
+const uint32_t MCIFIR_CL_TIMEOUT_DUE_TO_CHANNEL_BIT = 28;
+
+
+//------------------------------------------------------------------------------
+// Structure definitions
+//------------------------------------------------------------------------------
+
+// function pointer typedef definition for HWP call support
+typedef fapi::ReturnCode
+(*proc_revert_sbe_mcs_setup_FP_t)(const fapi::Target&);
+
+
+extern "C"
+{
+
+//------------------------------------------------------------------------------
+// Function prototypes
+//------------------------------------------------------------------------------
+
+//------------------------------------------------------------------------------
+// function: disable MCS configuration written by SBE to enable initial phase of
+//           HBI execution (providing lpc_ack for dcbz prior to initialization
+//           of memory)
+// parameters: i_target => P8 master chip target
+// returns: FAPI_RC_SUCCESS if all register writes are successful,
+//          else failing return code
+fapi::ReturnCode proc_revert_sbe_mcs_setup(
+    const fapi::Target& i_target);
+
+
+} // extern "C"
+
+
+#endif // _PROC_REVERT_SBE_MCS_SETUP_H_
diff --git a/src/usr/hwpf/hwp/slave_sbe/slave_sbe.C b/src/usr/hwpf/hwp/slave_sbe/slave_sbe.C
new file mode 100644
index 000000000..295898233
--- /dev/null
+++ b/src/usr/hwpf/hwp/slave_sbe/slave_sbe.C
@@ -0,0 +1,107 @@
+/*  IBM_PROLOG_BEGIN_TAG
+ *  This is an automatically generated prolog.
+ *
+ *  $Source: src/usr/hwpf/hwp/slave_sbe/slave_sbe.C $
+ *
+ *  IBM CONFIDENTIAL
+ *
+ *  COPYRIGHT International Business Machines Corp. 2012
+ *
+ *  p1
+ *
+ *  Object Code Only (OCO) source materials
+ *  Licensed Internal Code Source Materials
+ *  IBM HostBoot Licensed Internal Code
+ *
+ *  The source code for this program is not published or other-
+ *  wise divested of its trade secrets, irrespective of what has
+ *  been deposited with the U.S. Copyright Office.
+ *
+ *  Origin: 30
+ *
+ *  IBM_PROLOG_END_TAG
+ */
+/**
+ *  @file slave_sbe.C
+ *
+ *  Support file for IStep: slave_sbe
+ *   Slave SBE
+ */
+
+/******************************************************************************/
+// Includes
+/******************************************************************************/
+#include <stdint.h>
+
+#include <trace/interface.H>
+#include <initservice/taskargs.H>
+#include <errl/errlentry.H>
+#include <initservice/isteps_trace.H>
+
+//  targeting support
+#include <targeting/common/commontargeting.H>
+#include <targeting/common/utilFilter.H>
+
+//  fapi support
+#include <fapi.H>
+#include <fapiPlatHwpInvoker.H>
+
+#include "slave_sbe.H"
+#include "proc_revert_sbe_mcs_setup/proc_revert_sbe_mcs_setup.H"
+
+namespace SLAVE_SBE
+{
+//
+//  Wrapper function to call 6.8 :
+//      proc_revert_sbe_mcs_setup
+//
+void call_proc_revert_sbe_mcs_setup(void *io_pArgs)
+{
+    errlHndl_t  l_errl = NULL;
+
+    TRACDCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
+               "call_proc_revert_sbe_mcs_setup entry" );
+
+    // TODO
+    // This currently fails on Simics because this touches a Murano chip
+    // register that doesn't exist in the Venice chip. When Simcs supports
+    // a Murano chip, this HWP can be executed. For now, just execute the
+    // HWP on VPO
+    TARGETING::Target * l_pSysTarget = NULL;
+    TARGETING::targetService().getTopLevelTarget(l_pSysTarget);
+    uint8_t l_vpoMode = l_pSysTarget->getAttr<TARGETING::ATTR_IS_SIMULATION>();
+    if (!l_vpoMode)
+    {
+        TRACFCOMP(ISTEPS_TRACE::g_trac_isteps_trace,
+                  "INFO : not executing proc_revert_sbe_mcs_setup until murano chip in Simics");
+    }
+    else
+    {
+        TARGETING::Target* l_pProcTarget = NULL;
+        TARGETING::targetService().masterProcChipTargetHandle(l_pProcTarget);
+
+        fapi::Target l_fapiProcTarget(fapi::TARGET_TYPE_PROC_CHIP, l_pProcTarget);
+
+        // Invoke the HWP
+        FAPI_INVOKE_HWP(l_errl, proc_revert_sbe_mcs_setup, l_fapiProcTarget);
+
+        if (l_errl)
+        {
+            TRACFCOMP(ISTEPS_TRACE::g_trac_isteps_trace,
+                      "ERROR : failed executing proc_revert_sbe_mcs_setup returning error");
+        }
+        else
+        {
+            TRACFCOMP(ISTEPS_TRACE::g_trac_isteps_trace,
+                      "SUCCESS : proc_revert_sbe_mcs_setup completed ok");
+        }
+    }
+
+    TRACDCOMP(ISTEPS_TRACE::g_trac_isteps_trace,
+              "call_proc_revert_sbe_mcs_setup exit");
+
+    // end task, returning any errorlogs to IStepDisp
+    task_end2(l_errl);
+}
+
+}
diff --git a/src/usr/hwpf/hwp/slave_sbe/slave_sbe.H b/src/usr/hwpf/hwp/slave_sbe/slave_sbe.H
new file mode 100644
index 000000000..58800deff
--- /dev/null
+++ b/src/usr/hwpf/hwp/slave_sbe/slave_sbe.H
@@ -0,0 +1,72 @@
+/*  IBM_PROLOG_BEGIN_TAG
+ *  This is an automatically generated prolog.
+ *
+ *  $Source: src/usr/hwpf/hwp/slave_sbe/slave_sbe.H $
+ *
+ *  IBM CONFIDENTIAL
+ *
+ *  COPYRIGHT International Business Machines Corp. 2012
+ *
+ *  p1
+ *
+ *  Object Code Only (OCO) source materials
+ *  Licensed Internal Code Source Materials
+ *  IBM HostBoot Licensed Internal Code
+ *
+ *  The source code for this program is not published or other-
+ *  wise divested of its trade secrets, irrespective of what has
+ *  been deposited with the U.S. Copyright Office.
+ *
+ *  Origin: 30
+ *
+ *  IBM_PROLOG_END_TAG
+ */
+
+#ifndef  __SLAVE_SBE_SLAVE_SBE_H
+#define  __SLAVE_SBE_SLAVE_SBE_H
+
+/**
+ *  @file slave_sbe.H
+ *
+ *  Slave SBE Isteps that invoke HWPs.
+ *  
+ *  Note that a number of IStep 6 substeps are done by Hostboot specific
+ *  functions, this file is for the substeps that invoke HWPs
+ *
+ *  All of the following routines are "named isteps" - they are invoked as
+ *  tasks by the @ref IStepDispatcher.
+ *
+ */
+
+ /*  @tag isteplist
+ *  @docversion     v1.05 (06/28/12)
+ *  @istepname      slave_sbe
+ *  @istepnum       6
+ *  @istepdesc      Slave SBE
+ *
+ *  @{
+ *      @substepnum     8
+ *      @substepname    proc_revert_sbe_mcs_setup
+ *      @substepdesc    : Clean up MCS Extent regs
+ *          @target_sched   serial
+ *  @}
+ *
+ */
+
+namespace SLAVE_SBE
+{
+
+/**
+ *  @brief proc_revert_sbe_mcs_setup
+ *
+ *  6.8 : : Clean up MCS Extent regs
+ *
+ *  param[in,out]   -   pointer to any arguments, usually NULL
+ *
+ *  return none
+ */
+void call_proc_revert_sbe_mcs_setup(void *io_pArgs);
+
+};   // end namespace
+
+#endif