SBE move import`

Change-Id: I726951318cdb19fd445af2f7910e0d6872eff18c
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/29086
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Reviewed-by: Sachin Gupta <sgupta2m@in.ibm.com>
Reviewed-by: AMIT J. TENDOLKAR <amit.tendolkar@in.ibm.com>

1 files changed, 99 insertions, 0 deletions

diff --git a/src/import/chips/p9/procedures/hwp/nest/p9_adu_setup.H b/src/import/chips/p9/procedures/hwp/nest/p9_adu_setup.H
new file mode 100644
index 00000000..ffdd38b0
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/nest/p9_adu_setup.H
@@ -0,0 +1,99 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: import/chips/p9/procedures/hwp/nest/p9_adu_setup.H $          */
+/*                                                                        */
+/* OpenPOWER sbe Project                                                  */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2015,2016                        */
+/* [+] 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_adu_setup.H
+/// @brief Setup the adu to do reads/writes
+//
+// *HWP HWP Owner: Christina Graves clgraves@us.ibm.com
+// *HWP FW Owner: Thi Tran thi@us.ibm.com
+// *HWP Team: Nest
+// *HWP Level: 1
+// *HWP Consumed by:
+//-----------------------------------------------------------------------------------
+// *! ADDITIONAL COMMENTS:
+// *!
+// *! The purpose of this procedure is to setup the ADU to do reads/writes
+// *! and to return the number of granules (number of 8B reads/writes) that
+// *! can be done before setup needs to be called again
+// *!
+// *! Successful operation assumes that:
+// *!
+// *! High-level procedure flow:
+// *!
+// *!
+//------------------------------------------------------------------------------------
+
+#ifndef _P9_ADU_SETUP_H_
+#define _P9_ADU_SETUP_H_
+
+//-----------------------------------------------------------------------------------
+// Includes
+//-----------------------------------------------------------------------------------
+
+#include <fapi2.H>
+#include <p9_adu_constants.H>
+
+//-----------------------------------------------------------------------------------
+// Structure definitions
+//-----------------------------------------------------------------------------------
+
+//function pointer typedef definition for HWP call support
+typedef fapi2::ReturnCode
+(*p9_adu_setup_FP_t) (const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>&,
+                      const uint64_t,
+                      const bool,
+                      const uint32_t,
+                      uint32_t&);
+
+//-----------------------------------------------------------------------------------
+// Constant definitions
+//-----------------------------------------------------------------------------------
+
+extern "C" {
+
+//-----------------------------------------------------------------------------------
+// Function prototype
+//-----------------------------------------------------------------------------------
+
+/// @brief setup for reads/writes from the ADU
+/// @param[in] i_target       => P9 chip target
+/// @param[in] i_address      => base real address for read/write operation (expected to be 8B aligned)
+/// @param[in] i_rnw          => if the operation is read not write (1 for read, 0 for write)
+/// @param[in] i_flags        => other information that is needed - see the p9_adu_constants adu_flags enums for bit definitions
+///                              Note: To construct the flag you can use p9_ADU_oper_flag class
+/// @param[out] o_numGranules  => number of 8B granules that can be read/written before setup needs to be called again
+//
+/// @return FAPI_RC_SUCCESS if the setup completes successfully,
+//
+    fapi2::ReturnCode p9_adu_setup(
+        const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target,
+        const uint64_t i_address,
+        const bool i_rnw,
+        const uint32_t i_flags,
+        uint32_t& o_numGranules);
+} //extern "C"
+
+#endif //_P9_ADU_SETUP_H_