Centaur ring support - TOR API

Key_Cronus_Test=XIP_REGRESS

- Updates to TOR API codes to allow user codes to call TOR API
  function on a Centaur image. Note that the API no longer needs
  the caller to supply and XIP section ID.
- Updates to TOR API codes to take advantage of the improved
  data and meta-data representation in the ring Id codes and
  the more self-contained ring image which now has the TOR magic
  header.
- Updates to xip_tool to allow dissection of Centaur image.
- Additional updates to TOR API codes and ring Id codes to continue
  improving overall clarity of data, data structures and flow
  through TOR API, incl name changes to related data variables
  and structures.

Change-Id: I42891b9662cc0c443d2b16ce866ac945dc2c58dc
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/38018
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: Cronus HW CI <cronushw-ci+hostboot@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Thi N. Tran <thi@us.ibm.com>
Tested-by: Hostboot CI <hostboot-ci+hostboot@us.ibm.com>
Reviewed-by: Jennifer A. Stofer <stofer@us.ibm.com>
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/38563
Reviewed-by: Hostboot Team <hostboot@us.ibm.com>
Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins OP HW <op-hw-jenkins+hostboot@us.ibm.com>
Reviewed-by: Christian R. Geddes <crgeddes@us.ibm.com>

3 files changed, 105 insertions, 13 deletions

diff --git a/src/import/chips/centaur/utils/imageProcs/cen_ringId.C b/src/import/chips/centaur/utils/imageProcs/cen_ringId.C
index de68361c0..5df973921 100644
--- a/src/import/chips/centaur/utils/imageProcs/cen_ringId.C
+++ b/src/import/chips/centaur/utils/imageProcs/cen_ringId.C
@@ -23,6 +23,9 @@
 /*                                                                        */
 /* IBM_PROLOG_END_TAG                                                     */
 
+#include <string.h>
+#include <common_ringId.H>
+
 namespace CEN_RID
 {
 
@@ -140,4 +143,75 @@ const RingVariantOrder RING_VARIANT_ORDER[] = { BASE, RL, NOT_VALID };
 
 }; // namespace CEN
 
-}; // namespace CENTAUR
+}; // namespace CEN_RID
+
+
+using namespace CEN_RID;
+
+ChipletType_t CEN_RID::ringid_get_chiplet(RingId_t i_ringId)
+{
+    return RING_PROPERTIES[i_ringId].iv_type;
+}
+
+void CEN_RID::ringid_get_chiplet_properties(
+    ChipletType_t      i_chiplet,
+    ChipletData_t**    o_cpltData,
+    GenRingIdList**    o_ringComm,
+    GenRingIdList**    o_ringInst,
+    RingVariantOrder** o_varOrder,
+    uint8_t*           o_varNumb)
+{
+    switch (i_chiplet)
+    {
+        case CEN_TYPE :
+            *o_cpltData = (ChipletData_t*)   &CEN::g_chipletData;
+            *o_ringComm = (GenRingIdList*)    CEN::RING_ID_LIST_COMMON;
+            *o_ringInst = NULL;
+            *o_varOrder = (RingVariantOrder*) CEN::RING_VARIANT_ORDER;
+            *o_varNumb  = (*(*o_cpltData)).iv_num_ring_variants;
+            break;
+
+        default :
+            *o_cpltData = NULL;
+            *o_ringComm = NULL;
+            *o_ringInst = NULL;
+            *o_varOrder = NULL;
+            *o_varNumb = 0;
+            break;
+    }
+}
+
+GenRingIdList* CEN_RID::ringid_get_ring_properties(RingId_t i_ringId)
+{
+    ChipletData_t*    l_cpltData;
+    GenRingIdList*    l_ringList[2];    // 0: common, 1: instance
+    RingVariantOrder* l_varOrder;
+    uint8_t           l_varNumb;
+    int               i, j, n;
+
+    CEN_RID::ringid_get_chiplet_properties(
+        CEN_RID::ringid_get_chiplet(i_ringId),
+        &l_cpltData, &l_ringList[0], &l_ringList[1], &l_varOrder, &l_varNumb);
+
+    if (!l_ringList[0])
+    {
+        return NULL;
+    }
+
+    for (j = 0; j < 2; j++)     // 0: common, 1: instance
+    {
+        n = (j ? l_cpltData->iv_num_instance_rings
+             : l_cpltData->iv_num_common_rings);
+
+        for (i = 0; i < n; i++)
+        {
+            if (!strcmp(l_ringList[j][i].ringName,
+                        RING_PROPERTIES[i_ringId].iv_name))
+            {
+                return &(l_ringList[j][i]);
+            }
+        }
+    }
+
+    return NULL;
+}
diff --git a/src/import/chips/centaur/utils/imageProcs/cen_ringId.H b/src/import/chips/centaur/utils/imageProcs/cen_ringId.H
index d4f1b9ce6..134c3268a 100644
--- a/src/import/chips/centaur/utils/imageProcs/cen_ringId.H
+++ b/src/import/chips/centaur/utils/imageProcs/cen_ringId.H
@@ -42,12 +42,6 @@ namespace CEN
 extern const GenRingIdList RING_ID_LIST_COMMON[];
 extern const RingVariantOrder RING_VARIANT_ORDER[];
 
-struct RingVariants
-{
-    uint16_t iv_base;
-    uint16_t iv_riskLevel;
-};
-
 enum RingOffset
 {
     // Common Rings
@@ -156,19 +150,19 @@ enum RingOffset
     // ** none **
 };
 
-static const CHIPLET_DATA g_cenData =
+static const ChipletData_t g_chipletData =
 {
     0x01,         // Centaur chiplet ID
     NUM_RING_IDS, // Num of common rings for Centaur chiplet
     0,            // Num of instance rings for Centaur chiplet
-    0
+    0,
+    2,            // Num of ring variants: BASE, RL
 };
-
 }; // namespace CEN
 
 #ifndef __PPE__
 
-static const ringProperties_t RING_PROPERTIES[NUM_RING_IDS] =
+static const RingProperties_t RING_PROPERTIES[NUM_RING_IDS] =
 {
     { CEN::tcm_perv_cmsk, "tcm_perv_cmsk", CEN_TYPE },
     { CEN::tcm_perv_lbst, "tcm_perv_lbst", CEN_TYPE },
@@ -275,7 +269,7 @@ static const ringProperties_t RING_PROPERTIES[NUM_RING_IDS] =
 
 #else
 
-static const ringProperties_t RING_PROPERTIES[NUM_RING_IDS] =
+static const RingProperties_t RING_PROPERTIES[NUM_RING_IDS] =
 {
     { CEN::tcm_perv_cmsk, CEN_TYPE },
     { CEN::tcm_perv_lbst, CEN_TYPE },
@@ -382,4 +376,28 @@ static const ringProperties_t RING_PROPERTIES[NUM_RING_IDS] =
 
 #endif // __PPE__
 
+
+
+// returns our own chiplet enum value for this ringId
+ChipletType_t
+ringid_get_chiplet(
+    RingId_t i_ringId);
+
+// returns data structures defined for chiplet type
+// as determined by ringId
+void
+ringid_get_chiplet_properties(
+    ChipletType_t      i_chiplet,
+    ChipletData_t**    o_cpltData,
+    GenRingIdList**    o_ringComm,
+    GenRingIdList**    o_ringInst,
+    RingVariantOrder** o_varOrder,
+    uint8_t*           o_varNumb);
+
+// returns properties of a ring as determined by ringId
+GenRingIdList*
+ringid_get_ring_properties(
+    RingId_t i_ringId);
+
+
 #endif // _CEN_RINGID_H_
diff --git a/src/import/chips/centaur/utils/imageProcs/cen_ringId.mk b/src/import/chips/centaur/utils/imageProcs/cen_ringId.mk
index 5828fa2b2..92737c83b 100644
--- a/src/import/chips/centaur/utils/imageProcs/cen_ringId.mk
+++ b/src/import/chips/centaur/utils/imageProcs/cen_ringId.mk
@@ -22,7 +22,7 @@
 # permissions and limitations under the License.
 #
 # IBM_PROLOG_END_TAG
-PROCEDURE = cen_ringId
+PROCEDURE=cen_ringId
 $(call ADD_MODULE_INCDIR,$(PROCEDURE),$(ROOTPATH)/chips/common/utils/imageProcs)
 $(call BUILD_PROCEDURE)