FAPI Plat Cleanup

-- Remove src and include subdirs

Change-Id: I47d2b7d0b3667e7765692fb014932ae23a6325f7
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/41085
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Sachin Gupta <sgupta2m@in.ibm.com>
Reviewed-by: Shakeeb A. Pasha B K <shakeebbk@in.ibm.com>
Reviewed-by: Santosh S. Puranik <santosh.puranik@in.ibm.com>

1 files changed, 116 insertions, 0 deletions

diff --git a/src/hwpf/plat_ring_traverse.H b/src/hwpf/plat_ring_traverse.H
new file mode 100644
index 00000000..cd5fbc29
--- /dev/null
+++ b/src/hwpf/plat_ring_traverse.H
@@ -0,0 +1,116 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/hwpf/plat_ring_traverse.H $                               */
+/*                                                                        */
+/* OpenPOWER sbe Project                                                  */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2016,2017                        */
+/*                                                                        */
+/*                                                                        */
+/* 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                                                     */
+
+#ifndef _PLAT_RING_TRAVERSE_H_
+#define _PLAT_RING_TRAVERSE_H_
+
+#include <p9_putRingUtils.H> // for RS4 decompression utilities
+
+using namespace RING_TYPES;
+
+/// @brief This structure represents the layout of the Section-TOR
+///        Section-TOR has the offsets to the different chiplet's
+///        Common Ring section and Instance Ring section
+struct SectionTOR
+{
+    uint32_t TOC_PERV_COMMON_RING;   // Offset of Perv Common Ring section
+    uint32_t TOC_PERV_INSTANCE_RING; // Offset of Perv Instance Ring section
+
+    uint32_t TOC_N0_COMMON_RING;   // Offset of N0 Common Ring section
+    uint32_t TOC_N0_INSTANCE_RING; // Offset of N0 Instance Ring section
+
+    uint32_t TOC_N1_COMMON_RING;   // Offset of N1 Common Ring section
+    uint32_t TOC_N1_INSTANCE_RING; // Offset of N1 Instance Ring section
+
+    uint32_t TOC_N2_COMMON_RING;   // Offset of N2 Common Ring section
+    uint32_t TOC_N2_INSTANCE_RING; // Offset of N2 Instance Ring section
+
+    uint32_t TOC_N3_COMMON_RING;   // Offset of N3 Common Ring section
+    uint32_t TOC_N3_INSTANCE_RING; // Offset of N3 Instance Ring section
+
+    uint32_t TOC_XB_COMMON_RING;   // Offset of XB Common Ring section
+    uint32_t TOC_XB_INSTANCE_RING; // Offset of XB Instance Ring section
+
+    uint32_t TOC_MC_COMMON_RING;   // Offset of MC Common Ring section
+    uint32_t TOC_MC_INSTANCE_RING; // Offset of MC Instance Ring section
+
+    uint32_t TOC_OB0_COMMON_RING;   // Offset of OB0 Common Ring section
+    uint32_t TOC_OB0_INSTANCE_RING; // Offset of OB0 Instance Ring section
+
+    uint32_t TOC_OB1_COMMON_RING;   // Offset of OB1 Common Ring section
+    uint32_t TOC_OB1_INSTANCE_RING; // Offset of OB1 Instance Ring section
+
+    uint32_t TOC_OB2_COMMON_RING;   // Offset of OB2 Common Ring section
+    uint32_t TOC_OB2_INSTANCE_RING; // Offset of OB2 Instance Ring section
+
+    uint32_t TOC_OB3_COMMON_RING;   // Offset of OB3 Common Ring section
+    uint32_t TOC_OB3_INSTANCE_RING; // Offset of OB3 Instance Ring section
+
+    uint32_t TOC_PCI0_COMMON_RING;   // Offset of PCI0 Common Ring section
+    uint32_t TOC_PCI0_INSTANCE_RING; // Offset of PCI0 Instance Ring section
+
+    uint32_t TOC_PCI1_COMMON_RING;   // Offset of PCI1 Common Ring section
+    uint32_t TOC_PCI1_INSTANCE_RING; // Offset of PCI1 Instance Ring section
+
+    uint32_t TOC_PCI2_COMMON_RING;   // Offset of PCI2 Common Ring section
+    uint32_t TOC_PCI2_INSTANCE_RING; // Offset of PCI2 Instance Ring section
+
+    uint32_t TOC_EQ_COMMON_RING;   // Offset of Quad Common Ring section
+    uint32_t TOC_EQ_INSTANCE_RING; // Offset of Quad Instance Ring section
+
+    uint32_t TOC_EC_COMMON_RING;   // Offset of Core Common Ring section
+    uint32_t TOC_EC_INSTANCE_RING; // Offset of Core Instance Ring section
+};
+
+
+///
+/// @brief This is a plat pecific (SBE Plat) function that locates the
+///        Ring Container in the image and calls the functin to decompress the
+///        RS4 string and apply it to the hardware.
+/// @param i_target The target of Ring apply.
+/// @param i_ringID The Ring ID that identifies the ring to be applied.
+/// @return FAPI2_RC_SUCCESS on success, else error code.
+///
+fapi2::ReturnCode findRS4InImageAndApply(
+                    const fapi2::Target<fapi2::TARGET_TYPE_ALL>& i_target,
+                    const RingID i_ringID,
+                    const fapi2::RingMode i_ringMode);
+///
+/// @brief This is a plat pecific (SBE Plat) function that locates the
+///        Ring Container in the image and calls the functin to decompress the
+///        RS4 string and apply it to the hardware.
+/// @param i_target The target of Ring apply.
+/// @param i_ringID The Ring ID that identifies the ring to be applied.
+/// @param i_sectionTOR TOR section address
+/// @param i_applyOverride override is enabled or not
+/// @return FAPI2_RC_SUCCESS on success, else error code.
+///
+fapi2::ReturnCode getRS4ImageFromTor(
+                        const fapi2::Target<fapi2::TARGET_TYPE_ALL>& i_target,
+                        const RingID i_ringID,
+                        SectionTOR *i_sectionTOR,
+                        bool i_applyOverride,
+                        const uint32_t i_sectionOffset,
+                        const fapi2::RingMode i_ringMode);
+#endif