Adding p9a_ocmb_enable

Change-Id: I0e28ee52ad9088e87dd02ce2deca4e88bfcd9d8f
Original-Change-Id: I40fbbf9a6323163d8c064ec435dc0cc666dcb0ab
Reviewed-on: http://rchgit01.rchland.ibm.com/gerrit1/68088
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Reviewed-by: STEPHEN GLANCY <sglancy@us.ibm.com>
Tested-by: HWSV CI <hwsv-ci+hostboot@us.ibm.com>
Tested-by: PPE CI <ppe-ci+hostboot@us.ibm.com>
Tested-by: Hostboot CI <hostboot-ci+hostboot@us.ibm.com>
Reviewed-by: RYAN P. KING <rpking@us.ibm.com>
Reviewed-by: Joseph J. McGill <jmcgill@us.ibm.com>
Reviewed-on: http://rchgit01.rchland.ibm.com/gerrit1/71215
Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins OP HW <op-hw-jenkins+hostboot@us.ibm.com>
Reviewed-by: Christian R. Geddes <crgeddes@us.ibm.com>

4 files changed, 277 insertions, 0 deletions

diff --git a/src/import/chips/p9/procedures/hwp/perv/p9a_ocmb_enable.C b/src/import/chips/p9/procedures/hwp/perv/p9a_ocmb_enable.C
new file mode 100644
index 000000000..c22b2042f
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/perv/p9a_ocmb_enable.C
@@ -0,0 +1,136 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/import/chips/p9/procedures/hwp/perv/p9a_ocmb_enable.C $   */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2016,2019                        */
+/* [+] International Business Machines Corp.                              */
+/*                                                                        */
+/*                                                                        */
+/* Licensed under the Apache License, Version 2.0 (the "License");        */
+/* you may not use this file except in compliance with the License.       */
+/* You may obtain a copy of the License at                                */
+/*                                                                        */
+/*     http://www.apache.org/licenses/LICENSE-2.0                         */
+/*                                                                        */
+/* Unless required by applicable law or agreed to in writing, software    */
+/* distributed under the License is distributed on an "AS IS" BASIS,      */
+/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        */
+/* implied. See the License for the specific language governing           */
+/* permissions and limitations under the License.                         */
+/*                                                                        */
+/* IBM_PROLOG_END_TAG                                                     */
+///
+/// @file p9a_ocmb_enable.C
+/// @brief Enable OCMB reference clocks and drop reset (FAPI2)
+///
+/// @author Ben Gass <bgass@us.ibm.com>
+///
+
+//
+// *HWP HWP Owner: Ben Gass <bgass@us.ibm.com>
+// *HWP FW Owner: Thi Tran <thi@us.ibm.com>
+// *HWP Team: Perv
+// *HWP Level: 2
+// *HWP Consumed by: HB
+//
+
+//------------------------------------------------------------------------------
+// Includes
+//------------------------------------------------------------------------------
+#include <p9a_ocmb_enable.H>
+#include <p9a_perv_scom_addresses.H>
+#include <p9a_perv_scom_addresses_fld.H>
+
+//------------------------------------------------------------------------------
+// Function definitions
+//------------------------------------------------------------------------------
+
+fapi2::ReturnCode
+p9a_ocmb_enable(const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target)
+{
+    FAPI_DBG("Start");
+#ifndef __HOSTBOOT_MODULE
+    const auto& l_omi_chiplets = i_target.getChildren<fapi2::TARGET_TYPE_OMI>(fapi2::TARGET_STATE_PRESENT);
+#else
+    const auto& l_omi_chiplets = i_target.getChildren<fapi2::TARGET_TYPE_OMI>(fapi2::TARGET_STATE_FUNCTIONAL);
+#endif
+    unsigned char l_omi_pos = 0;
+    fapi2::buffer<uint64_t> l_clk_enable_bit = 0;
+    fapi2::buffer<uint64_t> l_scom_buf = 0;
+
+    for (const auto& l_omi : l_omi_chiplets)
+    {
+        const auto& l_ocmb_chiplets = l_omi.getChildren<fapi2::TARGET_TYPE_OCMB_CHIP>();
+
+        // If there is a ocmb connected, means the ocmb chip is active
+        if (!l_ocmb_chiplets.empty())
+        {
+            uint8_t l_omi_refclock_swizzle = 0;
+            // Get the OMI pos (it is supposed to be the same as the ocmb
+            // chip pos)
+            // The intention here is to get the relative pos number of OMI<->Ocmb
+            // pair within the scope of a chip, and the OMI position unit pos is
+            // always the same as the connected Ocmb chip. For example,
+            // since we have up to 8 ocmbs connected per chip, the relative unit
+            // pos here should always be within 0~7 for each chip in a multi-socket system.
+            FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_CHIP_UNIT_POS, l_omi,
+                                   l_omi_pos), "Error from FAPI_ATTR_GET (ATTR_CHIP_UNIT_POS)");
+
+            FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_OMI_REFCLOCK_SWIZZLE, l_omi, l_omi_refclock_swizzle),
+                     "Error from FAPI_ATTR_GET (ATTR_OMI_REFCLOCK_SWIZZLE)");
+
+            FAPI_DBG("OCMB ID: %i, REFCLK DRIVE BIT: %i", l_omi_pos, l_omi_refclock_swizzle);
+
+            // Legal bits are from PERV_ROOT_CTRL7_TPFSI_OFFCHIP_REFCLK_EN_DC
+            // to PERV_ROOT_CTRL7_TPFSI_OFFCHIP_REFCLK_EN_DC_LEN - 4, there
+            // are 4 bits for NVLINK that shouldn't be used by ocmb.
+            const auto MAX_SWIZZLE = P9A_PERV_ROOT_CTRL7_TP_TPIO_OMI_REFCLK_EN_DC
+                                     + P9A_PERV_ROOT_CTRL7_TP_TPIO_OMI_REFCLK_EN_DC_LEN;
+            FAPI_ASSERT((l_omi_refclock_swizzle >= P9A_PERV_ROOT_CTRL7_TP_TPIO_OMI_REFCLK_EN_DC)
+                        && (l_omi_refclock_swizzle < MAX_SWIZZLE),
+                        fapi2::P9A_OCMB_ENABLE_SWIZZLE_BIT_OUT_OF_RANGE_ERROR()
+                        .set_TARGET(l_omi)
+                        .set_BIT(l_omi_refclock_swizzle)
+                        .set_MIN(P9A_PERV_ROOT_CTRL7_TP_TPIO_OMI_REFCLK_EN_DC)
+                        .set_MAX(MAX_SWIZZLE),
+                        "Swizzle bit: %i, allowed range: %i to %i", l_omi_refclock_swizzle,
+                        P9A_PERV_ROOT_CTRL7_TP_TPIO_OMI_REFCLK_EN_DC,
+                        MAX_SWIZZLE
+                       );
+
+            FAPI_TRY(l_clk_enable_bit.setBit(l_omi_refclock_swizzle),
+                     "Refclock bit [%i] out of range!", l_omi_refclock_swizzle);
+        }
+    }
+
+    // We have at least 1 ocmb active then proceed to set the register
+    if (l_clk_enable_bit != 0)
+    {
+        // Enable the reference clocks
+        FAPI_TRY(fapi2::getScom(i_target, P9A_PERV_ROOT_CTRL7_SCOM, l_scom_buf),
+                 "Error from getScom to PERV_ROOT_CTRL7_SCOM");
+        l_scom_buf |= l_clk_enable_bit;
+        FAPI_DBG("Setting ROOT_CTRL7 to: 0x%016lx", l_scom_buf);
+        FAPI_TRY(fapi2::putScom(i_target, P9A_PERV_ROOT_CTRL7_SCOM, l_scom_buf),
+                 "Error from putScom to PERV_ROOT_CTRL7_SCOM");
+
+        //100 microseconds
+        fapi2::delay(100000, 10000);
+
+        // Toggle the reset signal
+        FAPI_TRY(fapi2::getScom(i_target, P9A_PERV_ROOT_CTRL0_SCOM, l_scom_buf),
+                 "Error from getScom to PERV_ROOT_CTRL0_SCOM");
+        l_scom_buf.clearBit<P9A_PERV_ROOT_CTRL0_OCMB_RESET_EN_DC>();
+        FAPI_DBG("Setting ROOT_CTRL0 to: 0x%016lx", l_scom_buf);
+        FAPI_TRY(fapi2::putScom(i_target, P9A_PERV_ROOT_CTRL0_SCOM, l_scom_buf),
+                 "Error from putScom to PERV_ROOT_CTRL0_SCOM");
+    }
+
+    FAPI_DBG("End");
+
+fapi_try_exit:
+    return fapi2::current_err;
+}
diff --git a/src/import/chips/p9/procedures/hwp/perv/p9a_ocmb_enable.H b/src/import/chips/p9/procedures/hwp/perv/p9a_ocmb_enable.H
new file mode 100644
index 000000000..50da4ff84
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/perv/p9a_ocmb_enable.H
@@ -0,0 +1,73 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/import/chips/p9/procedures/hwp/perv/p9a_ocmb_enable.H $   */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2016,2019                        */
+/* [+] International Business Machines Corp.                              */
+/*                                                                        */
+/*                                                                        */
+/* Licensed under the Apache License, Version 2.0 (the "License");        */
+/* you may not use this file except in compliance with the License.       */
+/* You may obtain a copy of the License at                                */
+/*                                                                        */
+/*     http://www.apache.org/licenses/LICENSE-2.0                         */
+/*                                                                        */
+/* Unless required by applicable law or agreed to in writing, software    */
+/* distributed under the License is distributed on an "AS IS" BASIS,      */
+/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        */
+/* implied. See the License for the specific language governing           */
+/* permissions and limitations under the License.                         */
+/*                                                                        */
+/* IBM_PROLOG_END_TAG                                                     */
+///
+/// @file p9a_ocmb_enable.H
+/// @brief Enable OCMB reference clocks and drop reset (FAPI2)
+///
+/// @author Ben Gass <bgass@us.ibm.com>
+///
+
+//
+// *HWP HWP Owner: Ben Gass <bgass@us.ibm.com>
+// *HWP FW Owner: Thi Tran <thi@us.ibm.com>
+// *HWP Team: Perv
+// *HWP Level: 2
+// *HWP Consumed by: HB
+//
+
+#ifndef _P9A_OCMB_ENABLE_H_
+#define _P9A_OCMB_ENABLE_H_
+
+
+//------------------------------------------------------------------------------
+// Includes
+//------------------------------------------------------------------------------
+#include <fapi2.H>
+
+//------------------------------------------------------------------------------
+// Structure definitions
+//------------------------------------------------------------------------------
+
+/// function pointer typedef definition for HWP call support
+typedef fapi2::ReturnCode (*p9a_ocmb_enable_FP_t) (const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>&);
+
+//------------------------------------------------------------------------------
+// Function prototypes
+//------------------------------------------------------------------------------
+
+extern "C"
+{
+
+///
+/// @brief Enable reference clocks for attached ocmb chips and releases reset.
+///
+/// @param[in] i_target  Reference to processor chip target
+/// @return fapi::ReturnCode. FAPI2_RC_SUCCESS if success, else error code.
+///
+    fapi2::ReturnCode p9a_ocmb_enable(const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target);
+
+} // extern "C"
+
+#endif // _P9A_OCMB_ENABLE_H_
diff --git a/src/import/chips/p9/procedures/hwp/perv/p9a_ocmb_enable.mk b/src/import/chips/p9/procedures/hwp/perv/p9a_ocmb_enable.mk
new file mode 100644
index 000000000..46055c52f
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/perv/p9a_ocmb_enable.mk
@@ -0,0 +1,26 @@
+# IBM_PROLOG_BEGIN_TAG
+# This is an automatically generated prolog.
+#
+# $Source: src/import/chips/p9/procedures/hwp/perv/p9a_ocmb_enable.mk $
+#
+# OpenPOWER HostBoot Project
+#
+# Contributors Listed Below - COPYRIGHT 2016,2019
+# [+] International Business Machines Corp.
+#
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# permissions and limitations under the License.
+#
+# IBM_PROLOG_END_TAG
+PROCEDURE=p9a_ocmb_enable
+$(call BUILD_PROCEDURE)
diff --git a/src/import/chips/p9/procedures/xml/error_info/p9a_ocmb_enable_errors.xml b/src/import/chips/p9/procedures/xml/error_info/p9a_ocmb_enable_errors.xml
new file mode 100755
index 000000000..f030e4d11
--- /dev/null
+++ b/src/import/chips/p9/procedures/xml/error_info/p9a_ocmb_enable_errors.xml
@@ -0,0 +1,42 @@
+<!-- IBM_PROLOG_BEGIN_TAG                                                   -->
+<!-- This is an automatically generated prolog.                             -->
+<!--                                                                        -->
+<!-- $Source: src/import/chips/p9/procedures/xml/error_info/p9a_ocmb_enable_errors.xml $ -->
+<!--                                                                        -->
+<!-- OpenPOWER HostBoot Project                                             -->
+<!--                                                                        -->
+<!-- Contributors Listed Below - COPYRIGHT 2016,2019                        -->
+<!-- [+] International Business Machines Corp.                              -->
+<!--                                                                        -->
+<!--                                                                        -->
+<!-- Licensed under the Apache License, Version 2.0 (the "License");        -->
+<!-- you may not use this file except in compliance with the License.       -->
+<!-- You may obtain a copy of the License at                                -->
+<!--                                                                        -->
+<!--     http://www.apache.org/licenses/LICENSE-2.0                         -->
+<!--                                                                        -->
+<!-- Unless required by applicable law or agreed to in writing, software    -->
+<!-- distributed under the License is distributed on an "AS IS" BASIS,      -->
+<!-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        -->
+<!-- implied. See the License for the specific language governing           -->
+<!-- permissions and limitations under the License.                         -->
+<!--                                                                        -->
+<!-- IBM_PROLOG_END_TAG                                                     -->
+<hwpErrors>
+  <!-- ******************************************************************** -->
+  <hwpError>
+    <rc>RC_P9A_OCMB_ENABLE_SWIZZLE_BIT_OUT_OF_RANGE_ERROR</rc>
+    <description>
+      Procedure: p9a_ocmb_enable
+      Swizzle bit in Root CTRL7 is out of range
+    </description>
+    <ffdc>TARGET</ffdc>
+    <ffdc>BIT</ffdc>
+    <ffdc>MIN</ffdc>
+    <ffdc>MAX</ffdc>
+    <callout>
+        <procedure>CODE</procedure>
+        <priority>HIGH</priority>
+    </callout>
+  </hwpError>
+</hwpErrors>