Initial Abus Commit

Change-Id: Idfeea4c9929f8093f4088bed84264d0ae4fd71ce
Original-Change-Id: I696eea52aae38b8e75bd57a18ad64e32e9447dd1
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/40727
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: Hostboot CI <hostboot-ci+hostboot@us.ibm.com>
Reviewed-by: Richard J. Knight <rjknight@us.ibm.com>
Reviewed-by: Gary A. Peterson <garyp@us.ibm.com>
Reviewed-by: Matt K. Light <mklight@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>
Reviewed-by: Jennifer A. Stofer <stofer@us.ibm.com>
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/56327
Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins OP HW <op-hw-jenkins+hostboot@us.ibm.com>
Reviewed-by: William G. Hoffa <wghoffa@us.ibm.com>

6 files changed, 466 insertions, 0 deletions

diff --git a/src/import/chips/p9/procedures/hwp/io/p9_io_obus_post_trainadv.C b/src/import/chips/p9/procedures/hwp/io/p9_io_obus_post_trainadv.C
new file mode 100644
index 000000000..adabac23b
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/io/p9_io_obus_post_trainadv.C
@@ -0,0 +1,165 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/import/chips/p9/procedures/hwp/io/p9_io_obus_post_trainadv.C $ */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2015,2018                        */
+/* [+] 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 p9_io_obus_post_trainadv.H
+/// @brief Post-Training PHY Status Function.
+///
+///-----------------------------------------------------------------------------
+/// *HWP HWP Owner        : Chris Steffen <cwsteffen@us.ibm.com>
+/// *HWP HWP Backup Owner : Gary Peterson <garyp@us.ibm.com>
+/// *HWP FW Owner         : Jamie Knight <rjknight@us.ibm.com>
+/// *HWP Team             : IO
+/// *HWP Level            : 2
+/// *HWP Consumed by      : FSP:HB
+///-----------------------------------------------------------------------------
+///
+/// @verbatim
+/// High-level procedure flow:
+///
+/// Post-Training PHY Status Function.
+///
+/// Procedure Prereq:
+///   - System clocks are running.
+///   - Scominit Procedure is completed.
+///   - IO DCCAL Procedure is completed.
+///   - IO Run Training Procedure is completed.
+/// @endverbatim
+///----------------------------------------------------------------------------
+
+
+// ----------------------------------------------------------------------------
+// Includes
+// ----------------------------------------------------------------------------
+#include "p9_io_obus_post_trainadv.H"
+#include <p9_io_scom.H>
+#include <p9_io_regs.H>
+
+// ----------------------------------------------------------------------------
+// Procedure Function
+// ----------------------------------------------------------------------------
+
+
+fapi2::ReturnCode getDebugInfo(const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_tgt)
+{
+    FAPI_IMP("Entering...");
+
+    FAPI_IMP("Exiting...");
+    return fapi2::current_err;
+}
+
+fapi2::ReturnCode checkEyeWidth(const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_tgt)
+{
+    FAPI_IMP("Entering...");
+
+    const uint32_t ONE_MS        = 1000000; // 1,000,000ns = 1ms
+    const uint32_t DELAY_NS      = 100 * ONE_MS; // Delay for 100ms
+    const uint32_t DELAY_CYCLES  = 1; // We won't be using this feature in sim.
+    //const uint8_t LN0            = 0;
+    //uint64_t      data64         = 0;
+    uint8_t       minMfgEyeWidth = 0;
+    char tgt_str[fapi2::MAX_ECMD_STRING_LEN];
+
+    fapi2::toString(i_tgt, tgt_str, fapi2::MAX_ECMD_STRING_LEN);
+
+    // Get the minimum manufacturing eye width
+    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_IO_O_MFG_MIN_EYE_WIDTH, i_tgt, minMfgEyeWidth));
+
+    // We need to wait for each lane to get through recal before the historical eye
+    //   width values will be valid.  At 2ms per lane * 17 lanes = 34ms.  To be safe
+    //   we want this number to get through a few times.  We will wait 100ms
+    FAPI_TRY(fapi2::delay(DELAY_NS, DELAY_CYCLES));
+
+    /*
+        // Read the historical minimum eye width
+        FAPI_TRY(io::read(OPT_RX_CTL_CNTL13_EO_PG, i_tgt, i_grp, LN0, data64),
+                  "Reading EDI+ RX CTL CNTL13 EO PG Failed");
+
+        FAPI_DBG("tgt(%s:g%d) Min Eye Width(%d) Lane(%d) Valid(%d) :: MinMfgEyeWidth(%d)",
+                  tgt_str, i_grp,
+                  io::get(OPT_RX_HIST_MIN_EYE_WIDTH      , data64),
+                  io::get(OPT_RX_HIST_MIN_EYE_WIDTH_LANE , data64),
+                  io::get(OPT_RX_HIST_MIN_EYE_WIDTH_VALID, data64),
+                  minMfgEyeWidth);
+
+        // Check if the historical eye width is less then the manufacturing minimum eye width
+        FAPI_ASSERT((io::get(OPT_RX_HIST_MIN_EYE_WIDTH, data64) >= minMfgEyeWidth),
+                     fapi2::IO_OBUS_MFG_RX_EYE_WIDTH_FAILURE().set_TARGET(i_tgt)
+                     .set_EYE_WIDTH(io::get(OPT_RX_HIST_MIN_EYE_WIDTH, data64))
+                     .set_EYE_WIDTH_LANE(io::get(OPT_RX_HIST_MIN_EYE_WIDTH_LANE, data64))
+                     .set_EYE_WIDTH_VALID(io::get(OPT_RX_HIST_MIN_EYE_WIDTH_VALID, data64))
+                     .set_MIN_EYE_WIDTH(minMfgEyeWidth),
+                     "I/O OPT Abus Manufacturing Eye Width Failure.");
+
+    */
+fapi_try_exit:
+    FAPI_IMP("Exiting...");
+    return fapi2::current_err;
+}
+
+/**
+ * @brief A simple HWP that runs after io_run_trainig.
+ *  This function is called on every Abus(Obus PHY).
+ * @param[in] i_tgt   Fapi2 Target
+ * @param[in] i_ctgt  Fapi2 Connected Target
+ * @retval ReturnCode
+ */
+fapi2::ReturnCode p9_io_obus_post_trainadv(
+    const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_tgt,
+    const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_ctgt)
+{
+    FAPI_IMP("Entering...");
+    uint8_t l_status = 0x0;
+    char tgt_str[fapi2::MAX_ECMD_STRING_LEN];
+    char ctgt_str[fapi2::MAX_ECMD_STRING_LEN];
+
+    fapi2::toString(i_tgt, tgt_str, fapi2::MAX_ECMD_STRING_LEN);
+    fapi2::toString(i_ctgt, ctgt_str, fapi2::MAX_ECMD_STRING_LEN);
+
+    FAPI_INF("Checking %s - %s Post Link Training.", tgt_str, ctgt_str);
+
+    // Get Debug Info
+    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_IO_O_DEBUG, i_tgt, l_status));
+
+    if(l_status == fapi2::ENUM_ATTR_IO_O_DEBUG_TRUE)
+    {
+        FAPI_TRY(getDebugInfo(i_tgt));
+        FAPI_TRY(getDebugInfo(i_ctgt));
+    }
+
+    // Run Manufacturing Eye Width Check
+    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_IO_O_MFG_CHK, i_tgt, l_status));
+
+    if(l_status == fapi2::ENUM_ATTR_IO_O_MFG_CHK_TRUE)
+    {
+        FAPI_TRY(checkEyeWidth(i_tgt));
+        FAPI_TRY(checkEyeWidth(i_ctgt));
+    }
+
+
+
+fapi_try_exit:
+    FAPI_IMP("Exiting...");
+    return fapi2::current_err;
+}
diff --git a/src/import/chips/p9/procedures/hwp/io/p9_io_obus_post_trainadv.H b/src/import/chips/p9/procedures/hwp/io/p9_io_obus_post_trainadv.H
new file mode 100644
index 000000000..a3e0a75d8
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/io/p9_io_obus_post_trainadv.H
@@ -0,0 +1,78 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/import/chips/p9/procedures/hwp/io/p9_io_obus_post_trainadv.H $ */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2015,2018                        */
+/* [+] 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 p9_io_obus_post_trainadv.H
+/// @brief Post-Training PHY Status Function.
+///
+///-----------------------------------------------------------------------------
+/// *HWP HWP Owner        : Chris Steffen <cwsteffen@us.ibm.com>
+/// *HWP HWP Backup Owner : Gary Peterson <garyp@us.ibm.com>
+/// *HWP FW Owner         : Jamie Knight <rjknight@us.ibm.com>
+/// *HWP Team             : IO
+/// *HWP Level            : 2
+/// *HWP Consumed by      : FSP:HB
+///-----------------------------------------------------------------------------
+
+#ifndef _P9_IO_OBUS_POST_TRAINADV_H_
+#define _P9_IO_OBUS_POST_TRAINADV_H_
+
+// ----------------------------------------------------------------------------
+// Includes
+// ----------------------------------------------------------------------------
+#include <fapi2.H>
+
+//-----------------------------------------------------------------------------
+// Structure definitions
+//-----------------------------------------------------------------------------
+
+// function pointer typedef definition for HWP call support
+typedef fapi2::ReturnCode (*p9_io_obus_post_trainadv_FP_t)
+(const fapi2::Target<fapi2::TARGET_TYPE_OBUS>&,
+ const fapi2::Target<fapi2::TARGET_TYPE_OBUS>&);
+
+// ----------------------------------------------------------------------------
+// Constant Definitions
+// ----------------------------------------------------------------------------
+
+// ----------------------------------------------------------------------------
+// Function Protoypes
+// ----------------------------------------------------------------------------
+extern "C" {
+
+    /**
+     * @brief A simple HWP that runs after io_run_trainig.
+     *  This function is called on every Abus(Obus PHY).
+     * @param[in] i_tgt   Fapi2 Target
+     * @param[in] i_ctgt  Fapi2 Connected Target
+     * @retval ReturnCode
+     */
+    fapi2::ReturnCode p9_io_obus_post_trainadv(
+        const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_tgt,
+        const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_ctgt);
+
+
+} // extern "C"
+
+#endif // _P9_IO_OBUS_POST_TRAINADV_H_
diff --git a/src/import/chips/p9/procedures/hwp/io/p9_io_obus_post_trainadv.mk b/src/import/chips/p9/procedures/hwp/io/p9_io_obus_post_trainadv.mk
new file mode 100644
index 000000000..acc18a295
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/io/p9_io_obus_post_trainadv.mk
@@ -0,0 +1,26 @@
+# IBM_PROLOG_BEGIN_TAG
+# This is an automatically generated prolog.
+#
+# $Source: src/import/chips/p9/procedures/hwp/io/p9_io_obus_post_trainadv.mk $
+#
+# OpenPOWER HostBoot Project
+#
+# Contributors Listed Below - COPYRIGHT 2015,2018
+# [+] 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=p9_io_obus_post_trainadv
+$(call BUILD_PROCEDURE)
diff --git a/src/import/chips/p9/procedures/hwp/io/p9_io_obus_pre_trainadv.C b/src/import/chips/p9/procedures/hwp/io/p9_io_obus_pre_trainadv.C
new file mode 100644
index 000000000..dda7c65cd
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/io/p9_io_obus_pre_trainadv.C
@@ -0,0 +1,94 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/import/chips/p9/procedures/hwp/io/p9_io_obus_pre_trainadv.C $ */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2015,2018                        */
+/* [+] 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 p9_io_obus_pre_trainadv.H
+/// @brief Pre-Training PHY Status Function.
+///
+///----------------------------------------------------------------------------
+/// *HWP HWP Owner        : Chris Steffen <cwsteffen@us.ibm.com>
+/// *HWP HWP Backup Owner : Gary Peterson <garyp@us.ibm.com>
+/// *HWP FW Owner         : Jamie Knight <rjknight@us.ibm.com>
+/// *HWP Team             : IO
+/// *HWP Level            : 2
+/// *HWP Consumed by      : FSP:HB
+///----------------------------------------------------------------------------
+///
+/// @verbatim
+/// High-level procedure flow:
+///
+///   Pre-Training PHY Status Function.
+///
+/// Procedure Prereq:
+///   - System clocks are running.
+///   - Scominit Procedure is completed.
+///   - IO DCCAL Procedure is completed.
+/// @endverbatim
+///----------------------------------------------------------------------------
+
+
+// ----------------------------------------------------------------------------
+// Includes
+// ----------------------------------------------------------------------------
+#include "p9_io_obus_pre_trainadv.H"
+
+// ----------------------------------------------------------------------------
+// Procedure Function
+// ----------------------------------------------------------------------------
+
+/**
+ * @brief A simple HWP that runs prior to io_run_trainig.
+ *  This function is called on every Abus(Obus PHY).
+ * @param[in] i_tgt   Fapi2 Target
+ * @param[in] i_ctgt  Fapi2 Connected Target
+ * @retval ReturnCode
+ */
+fapi2::ReturnCode p9_io_obus_pre_trainadv(
+    const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_tgt,
+    const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_ctgt)
+{
+    FAPI_IMP("Entering...");
+    uint8_t l_status = 0x0;
+
+    char tgt_string[fapi2::MAX_ECMD_STRING_LEN];
+    char ctgt_string[fapi2::MAX_ECMD_STRING_LEN];
+    fapi2::toString(i_tgt, tgt_string, fapi2::MAX_ECMD_STRING_LEN);
+    fapi2::toString(i_ctgt, ctgt_string, fapi2::MAX_ECMD_STRING_LEN);
+
+    FAPI_INF("Checking %s - %s Debug Status.", tgt_string, ctgt_string);
+    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_IO_O_DEBUG, i_tgt, l_status));
+
+    if(l_status == fapi2::ENUM_ATTR_IO_O_DEBUG_TRUE)
+    {
+        FAPI_INF("Debug True.");
+    }
+    else
+    {
+        FAPI_INF("Debug False.");
+    }
+
+fapi_try_exit:
+    FAPI_IMP("Exiting...");
+    return fapi2::current_err;
+}
diff --git a/src/import/chips/p9/procedures/hwp/io/p9_io_obus_pre_trainadv.H b/src/import/chips/p9/procedures/hwp/io/p9_io_obus_pre_trainadv.H
new file mode 100644
index 000000000..07c62538b
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/io/p9_io_obus_pre_trainadv.H
@@ -0,0 +1,77 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/import/chips/p9/procedures/hwp/io/p9_io_obus_pre_trainadv.H $ */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2015,2018                        */
+/* [+] 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 p9_io_obus_pre_trainadv.H
+/// @brief Pre-Training PHY Status Function.
+///
+///----------------------------------------------------------------------------
+/// *HWP HWP Owner        : Chris Steffen <cwsteffen@us.ibm.com>
+/// *HWP HWP Backup Owner : Gary Peterson <garyp@us.ibm.com>
+/// *HWP FW Owner         : Jamie Knight <rjknight@us.ibm.com>
+/// *HWP Team             : IO
+/// *HWP Level            : 2
+/// *HWP Consumed by      : FSP:HB
+///----------------------------------------------------------------------------
+
+#ifndef _P9_IO_OBUS_PRE_TRAINADV_H_
+#define _P9_IO_OBUS_PRE_TRAINADV_H_
+
+// ----------------------------------------------------------------------------
+// Includes
+// ----------------------------------------------------------------------------
+#include <fapi2.H>
+
+//-----------------------------------------------------------------------------
+// Structure definitions
+//-----------------------------------------------------------------------------
+
+// function pointer typedef definition for HWP call support
+typedef fapi2::ReturnCode (*p9_io_obus_pre_trainadv_FP_t)
+(const fapi2::Target<fapi2::TARGET_TYPE_OBUS>&,
+ const fapi2::Target<fapi2::TARGET_TYPE_OBUS>&);
+
+// ----------------------------------------------------------------------------
+// Constant Definitions
+// ----------------------------------------------------------------------------
+
+// ----------------------------------------------------------------------------
+// Function Protoypes
+// ----------------------------------------------------------------------------
+extern "C" {
+
+    /**
+     * @brief A simple HWP that runs prior to io_run_trainig.
+     *  This function is called on every Abus(Obus PHY).
+     * @param[in] i_target   Fapi2 Target
+     * @param[in] i_ctarget  Fapi2 Connected Target
+     * @retval ReturnCode
+     */
+    fapi2::ReturnCode p9_io_obus_pre_trainadv(
+        const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_tgt,
+        const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_ctgt);
+
+} // extern "C"
+
+#endif // _P9_IO_OBUS_PRE_TRAINADV_H_
diff --git a/src/import/chips/p9/procedures/hwp/io/p9_io_obus_pre_trainadv.mk b/src/import/chips/p9/procedures/hwp/io/p9_io_obus_pre_trainadv.mk
new file mode 100644
index 000000000..27d878a80
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/io/p9_io_obus_pre_trainadv.mk
@@ -0,0 +1,26 @@
+# IBM_PROLOG_BEGIN_TAG
+# This is an automatically generated prolog.
+#
+# $Source: src/import/chips/p9/procedures/hwp/io/p9_io_obus_pre_trainadv.mk $
+#
+# OpenPOWER HostBoot Project
+#
+# Contributors Listed Below - COPYRIGHT 2015,2018
+# [+] 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=p9_io_obus_pre_trainadv
+$(call BUILD_PROCEDURE)