Code restruct: ring_apply

- Consolidating the three <ppe>_image_ring_generation functions
  into a single shared, and renamed, ring_section_generation
  function,
- Moving several data centric functions into common_ringId API,
- Use of sizeof(<type or var>) instead of hardcoded assumptions
  about structure or data type sizes,
- Renaming of variables which makes sense in the context of the
  scope of this commit, such as:
  - ringBuffer renamed to ringSection
  - ringBufSize renamed to ringSectionSize and type changed to
    uint32_t
- Removes the backward compatibility to TORV3/V4 and now only
  works with latest TOR version, i.e. 6 at this point.

About the Hw_ImageBuild_Prereq:
- 51511 must have fully propagated into all repos and drivers
  used in FSP CI tests before this commit (43175) can be merged.
  43175 removes the TORV3/V4 backwards compatibility to support
  TOR ring sections that have TOR level DD coordination.

Key_Cronus_Test=XIP_REGRESS

Change-Id: I0af25fa623c1c523eb0297e475066497787f3d15
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/43175
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: HWSV CI <hwsv-ci+hostboot@us.ibm.com>
Tested-by: PPE CI <ppe-ci+hostboot@us.ibm.com>
Tested-by: Hostboot CI <hostboot-ci+hostboot@us.ibm.com>
Tested-by: Cronus HW CI <cronushw-ci+hostboot@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Prachi Gupta <pragupta@us.ibm.com>
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/52211
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>
Tested-by: Daniel M. Crowell <dcrowell@us.ibm.com>

2 files changed, 4 insertions, 1 deletions

diff --git a/src/include/usr/fapi2/hwpf_fapi2_reasoncodes.H b/src/include/usr/fapi2/hwpf_fapi2_reasoncodes.H
index f516425ad..4ab4a3abb 100644
--- a/src/include/usr/fapi2/hwpf_fapi2_reasoncodes.H
+++ b/src/include/usr/fapi2/hwpf_fapi2_reasoncodes.H
@@ -143,6 +143,7 @@ namespace fapi2
         RC_INCORRECT_HW_IMAGE_TYPE     = FAPI2_COMP_ID | 0x3D,
         RC_DD_SUPPORT_CHECK_FAILED     = FAPI2_COMP_ID | 0x3E,
         RC_SET_ATTR_NOT_VALID          = FAPI2_COMP_ID | 0x3F,
+        RC_FAILED_TO_GET_RING_LIST     = FAPI2_COMP_ID | 0x40,
 
         // HWP generated errors
         RC_HWP_GENERATED_ERROR         = HWPF_COMP_ID | 0x0f,
diff --git a/src/include/usr/fapi2/plat_utils.H b/src/include/usr/fapi2/plat_utils.H
index 7e04e82f5..753d937d6 100644
--- a/src/include/usr/fapi2/plat_utils.H
+++ b/src/include/usr/fapi2/plat_utils.H
@@ -34,6 +34,7 @@
 #define PLAT_UTILS_H_
 
 #include <return_code.H>
+#include <common_ringId.H>
 
 namespace fapi2
 {
@@ -106,7 +107,8 @@ ReturnCode platSpecialWakeup( const Target<TARGET_TYPE_ALL>& i_target,
 ///
 template<fapi2::TargetType T>
 ReturnCode get_ring(fapi2::Target<T> i_target,
-        const uint16_t i_ringId, unsigned char *&o_ringData,
+        const RingId_t i_ringId, 
+        unsigned char *&o_ringData,
         uint64_t &o_ringLength,
         uint64_t &o_ringAddress);