create shells for IO OBUS pre, post training HWPs

  currently empty

Change-Id: I324720af79af6a4a3a23dedcbc4bad804829a84d
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/51799
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Reviewed-by: Thi N. Tran <thi@us.ibm.com>
Reviewed-by: Christopher W. Steffen <cwsteffen@us.ibm.com>
Reviewed-by: Jennifer A. Stofer <stofer@us.ibm.com>
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/56330
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, 337 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..94228551b
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/io/p9_io_obus_post_trainadv.C
@@ -0,0 +1,73 @@
+/* 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 2017,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            : 3
+/// *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>
+
+// ----------------------------------------------------------------------------
+// Procedure Function
+// ----------------------------------------------------------------------------
+
+/**
+ * @brief A simple HWP that runs after io_run_training.
+ *  This function is called on every Obus.
+ * @param[in] i_target Fapi2 OBUS Target
+ * @retval ReturnCode
+ */
+fapi2::ReturnCode p9_io_obus_post_trainadv(
+    const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_tgt)
+{
+    FAPI_IMP("Entering...");
+    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..6c31130fd
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/io/p9_io_obus_post_trainadv.H
@@ -0,0 +1,70 @@
+/* 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 2017,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            : 3
+/// *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>&);
+
+// ----------------------------------------------------------------------------
+// Function Protoypes
+// ----------------------------------------------------------------------------
+extern "C" {
+
+    /**
+     * @brief A simple HWP that runs after io_run_training.
+     *  This function is called on every Obus.
+     * @param[in] i_target Fapi2 OBUS Target
+     * @retval ReturnCode
+     */
+    fapi2::ReturnCode p9_io_obus_post_trainadv(
+        const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_target);
+
+} // 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..81dcff932
--- /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 2017,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..7c8a3604b
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/io/p9_io_obus_pre_trainadv.C
@@ -0,0 +1,72 @@
+/* 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 2017,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            : 3
+/// *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_trainibg.
+ *  This function is called on every Obus.
+ * @param[in] i_target Fapi2 OBUS Target
+ * @retval ReturnCode
+ */
+fapi2::ReturnCode
+p9_io_obus_pre_trainadv(
+    const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_target)
+{
+    FAPI_IMP("Entering...");
+    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..a5f6e6f32
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/io/p9_io_obus_pre_trainadv.H
@@ -0,0 +1,70 @@
+/* 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 2017,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            : 3
+/// *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>&);
+
+// ----------------------------------------------------------------------------
+// Function Protoypes
+// ----------------------------------------------------------------------------
+extern "C" {
+
+    /**
+     * @brief A simple HWP that runs prior to io_run_training.
+     *  This function is called on every Obus.
+     * @param[in] i_target Fapi2 OBUS Target
+     * @retval ReturnCode
+     */
+    fapi2::ReturnCode p9_io_obus_pre_trainadv(
+        const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_target);
+
+} // 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..7fc6ee3e3
--- /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 2017,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)