p9_suspend_io procedure with updates from review feedback

Change-Id: I911f17d72d36ad43fb03cdf86b5ce3d4b07a71fc
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/27218
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Reviewed-by: Jennifer A. Stofer <stofer@us.ibm.com>
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/38267
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Sachin Gupta <sgupta2m@in.ibm.com>

1 files changed, 90 insertions, 0 deletions

diff --git a/src/import/chips/p9/procedures/hwp/nest/p9_suspend_io.H b/src/import/chips/p9/procedures/hwp/nest/p9_suspend_io.H
new file mode 100644
index 00000000..697c5410
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/nest/p9_suspend_io.H
@@ -0,0 +1,90 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/import/chips/p9/procedures/hwp/nest/p9_suspend_io.H $     */
+/*                                                                        */
+/* OpenPOWER sbe Project                                                  */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2016,2017                        */
+/* [+] 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_suspend_io.H
+/// @brief Procedure to suspend PCIe traffic. (FAPI2)
+///
+// *HWP HWP Owner: Ricardo Mata Jr. ricmata@us.ibm.com
+// *HWP FW Owner: Thi Tran thi@us.ibm.com
+// *HWP Team: Nest
+// *HWP Level: 2
+// *HWP Consumed by: HB
+
+#ifndef _P9_SUSPEND_IO_H_
+#define _P9_SUSPEND_IO_H_
+
+//-----------------------------------------------------------------------------------
+// Includes
+//-----------------------------------------------------------------------------------
+#include <fapi2.H>
+
+//-----------------------------------------------------------------------------------
+// Structure definitions
+//-----------------------------------------------------------------------------------
+
+//function pointer typedef definition for HWP call support
+typedef fapi2::ReturnCode (*p9_suspend_io_FP_t) (const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>&, const bool);
+
+//-----------------------------------------------------------------------------------
+// Constant definitions
+//-----------------------------------------------------------------------------------
+
+const uint8_t PHB_NFIR_REG_SW_DEFINED_FREEZE = 26; //PCI Nest FIR Register bit26 for SW Freeze enablement
+
+const uint32_t MAX_NUM_POLLS = 100; //Maximum number of iterations (So, 20ms * 100 = 2s before timeout)
+const uint64_t PBCQ_NANO_SEC_DELAY =
+    40000000; //(40000000 ns = 20 ms) to wait for PBCQ inbound and outbound to become inactive
+const uint64_t PBCQ_SIM_CYC_DELAY =
+    400000; //400,000 simulation cycles to wait for PBCQ inbound and outbound to become inactive
+
+
+extern "C" {
+
+//-----------------------------------------------------------------------------------
+// Function prototype
+//-----------------------------------------------------------------------------------
+//------------------------------------------------------------------------------
+// name: p9_suspend_io
+//------------------------------------------------------------------------------
+// purpose:
+// Freeze PEC and drive reset to PHB to suspend all IO traffic.
+//
+// parameters:
+// 'i_target' is reference to chip target
+// 'i_enable_mpipl' is Boolean flag indicating whether you're running this procedure during MPIPL (true) or non-MPIPL (false)
+//
+// returns:
+// FAPI_RC_SUCCESS (success, forced PCIe PHBs into reset)
+// RC_P9_PBCQ_CQ_NOT_IDLE (error, timed out while waiting for traffic to become idle for PBCQ of PCIe controller)
+// (Note: refer to file eclipz/chips/p9/working/procedures/xml/error_info/p9_suspend_io_errors.xml)
+// getscom/putscom fapi errors
+// fapi error assigned from eCMD function failure
+//
+//------------------------------------------------------------------------------
+    fapi2::ReturnCode p9_suspend_io(const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target, const bool i_enable_mpipl);
+
+} //extern"C"
+
+#endif //_P9_SUSPEND_IO_H_