CORE/CACHE: add Level1 cache/l2/core stopclocks procedures

Change-Id: I9c7bc5470e09fa456a68b59122be4ab94a6e8e12
Original-Change-Id: Id407ffa51ea9a7fb9a0056a7faaf1e33e4433e50
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/26276
Tested-by: Jenkins Server <pfd-jenkins+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: Soma Bhanutej <soma.bhanu@in.ibm.com>
Reviewed-by: Gregory S. Still <stillgs@us.ibm.com>
Reviewed-by: Jennifer A. Stofer <stofer@us.ibm.com>
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/27581
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>

3 files changed, 142 insertions, 0 deletions

diff --git a/src/import/chips/p9/procedures/hwp/cache/p9_hcd_cache_stopclocks.C b/src/import/chips/p9/procedures/hwp/cache/p9_hcd_cache_stopclocks.C
new file mode 100644
index 000000000..1215b2143
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/cache/p9_hcd_cache_stopclocks.C
@@ -0,0 +1,60 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: chips/p9/procedures/hwp/cache/p9_hcd_cache_stopclocks.C $     */
+/*                                                                        */
+/* IBM CONFIDENTIAL                                                       */
+/*                                                                        */
+/* EKB Project                                                            */
+/*                                                                        */
+/* COPYRIGHT 2015,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                                                     */
+///
+/// @file  p9_hcd_cache_stopclocks.C
+/// @brief Quad Clock Stop
+///
+/// Procedure Summary:
+
+// *HWP HWP Owner          : David Du       <daviddu@us.ibm.com>
+// *HWP Backup HWP Owner   : Greg Still     <stillgs@us.ibm.com>
+// *HWP FW Owner           : Sangeetha T S  <sangeet2@in.ibm.com>
+// *HWP Team               : PM
+// *HWP Consumed by        : HB:PREV
+// *HWP Level              : 2
+
+//------------------------------------------------------------------------------
+// Includes
+//------------------------------------------------------------------------------
+
+#include <p9_misc_scom_addresses.H>
+#include <p9_quad_scom_addresses.H>
+#include <p9_hcd_common.H>
+#include "p9_hcd_cache_stopclocks.H"
+
+//------------------------------------------------------------------------------
+// Constant Definitions
+//------------------------------------------------------------------------------
+
+//------------------------------------------------------------------------------
+// Procedure: Quad Clock Stop
+//------------------------------------------------------------------------------
+
+fapi2::ReturnCode
+p9_hcd_cache_stopclocks(
+    const fapi2::Target<fapi2::TARGET_TYPE_EQ>& i_target,
+    const p9hcd::P9_HCD_CLK_CTRL_CONSTANTS      i_select_regions,
+    const p9hcd::P9_HCD_EX_CTRL_CONSTANTS       i_select_ex)
+{
+    FAPI_INF(">>p9_hcd_cache_stopclocks");
+
+    FAPI_INF("<<p9_hcd_cache_stopclocks");
+    return fapi2::FAPI2_RC_SUCCESS;
+}
+
diff --git a/src/import/chips/p9/procedures/hwp/cache/p9_hcd_cache_stopclocks.H b/src/import/chips/p9/procedures/hwp/cache/p9_hcd_cache_stopclocks.H
new file mode 100644
index 000000000..50ee08a8b
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/cache/p9_hcd_cache_stopclocks.H
@@ -0,0 +1,60 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: chips/p9/procedures/hwp/cache/p9_hcd_cache_stopclocks.H $     */
+/*                                                                        */
+/* IBM CONFIDENTIAL                                                       */
+/*                                                                        */
+/* EKB Project                                                            */
+/*                                                                        */
+/* COPYRIGHT 2015,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                                                     */
+///
+/// @file  p9_hcd_cache_stopclocks.H
+/// @brief Quad Clock Stop
+///
+
+// *HWP HWP Owner          : David Du       <daviddu@us.ibm.com>
+// *HWP Backup HWP Owner   : Greg Still     <stillgs@us.ibm.com>
+// *HWP FW Owner           : Sangeetha T S  <sangeet2@in.ibm.com>
+// *HWP Team               : PM
+// *HWP Consumed by        : HB:PREV
+// *HWP Level              : 2
+
+#ifndef __P9_HCD_CACHE_STOPCLOCKS_H__
+#define __P9_HCD_CACHE_STOPCLOCKS_H__
+
+#include <fapi2.H>
+#include <p9_hcd_common.H>
+
+/// @typedef p9_hcd_cache_stopclocks_FP_t
+/// function pointer typedef definition for HWP call support
+typedef fapi2::ReturnCode (*p9_hcd_cache_stopclocks_FP_t) (
+    const fapi2::Target<fapi2::TARGET_TYPE_EQ>&,
+    const p9hcd::P9_HCD_CLK_CTRL_CONSTANTS,
+    const p9hcd::P9_HCD_EX_CTRL_CONSTANTS);
+
+extern "C"
+{
+
+/// @brief Quad Clock Stop
+/// @param [in] i_target TARGET_TYPE_EQ target
+/// @param [in] i_skip_regions select clk regions to skip on stopclocks
+/// @param [in] i_skip_ex select ex, odd and/or even, to skip on stopclocks
+/// @return FAPI2_RC_SUCCESS if success, else error code
+    fapi2::ReturnCode
+    p9_hcd_cache_stopclocks(
+        const fapi2::Target<fapi2::TARGET_TYPE_EQ>& i_target,
+        const p9hcd::P9_HCD_CLK_CTRL_CONSTANTS      i_select_regions,
+        const p9hcd::P9_HCD_EX_CTRL_CONSTANTS       i_select_ex);
+
+}
+
+#endif  // __P9_HCD_CACHE_STOPCLOCKS_H__
diff --git a/src/import/chips/p9/procedures/hwp/cache/p9_hcd_cache_stopclocks.mk b/src/import/chips/p9/procedures/hwp/cache/p9_hcd_cache_stopclocks.mk
new file mode 100644
index 000000000..23c8c23f7
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/cache/p9_hcd_cache_stopclocks.mk
@@ -0,0 +1,22 @@
+# IBM_PROLOG_BEGIN_TAG
+# This is an automatically generated prolog.
+#
+# $Source: chips/p9/procedures/hwp/cache/p9_hcd_cache_stopclocks.mk $
+#
+# IBM CONFIDENTIAL
+#
+# EKB Project
+#
+# COPYRIGHT 2015,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_hcd_cache_stopclocks
+$(call ADD_MODULE_SRCDIR,$(PROCEDURE),$(ROOTPATH)/chips/p9/procedures/hwp/lib)
+OBJS+=p9_hcd_cache_stopclocks.o
+$(call BUILD_PROCEDURE)