DynamicTablesPkg: Rename enum used for ID Mapping

[mirror_edk2.git] / DynamicTablesPkg / Include / ArmNameSpaceObjects.h

diff --git a/DynamicTablesPkg/Include/ArmNameSpaceObjects.h b/DynamicTablesPkg/Include/ArmNameSpaceObjects.h
index ec31c40449d0658f98a89ce0bb6f604b491f1f34..2adaa788083e4e15d049f5f6b6312f77f3c02488 100644 (file)
--- a/DynamicTablesPkg/Include/ArmNameSpaceObjects.h
+++ b/DynamicTablesPkg/Include/ArmNameSpaceObjects.h
@@ -1,6 +1,6 @@
 /** @file\r
 \r
 /** @file\r
 \r

-  Copyright (c) 2017 - 2019, ARM Limited. All rights reserved.\r
+  Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.\r

 \r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
 \r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r


@@ -59,8 +59,6 @@ typedef enum ArmObjectID {
 \r
 /** A structure that describes the\r
     ARM Boot Architecture flags.\r
 \r
 /** A structure that describes the\r
     ARM Boot Architecture flags.\r

-\r
-    ID: EArmObjBootArchInfo\r

 */\r
 typedef struct CmArmBootArchInfo {\r
   /** This is the ARM_BOOT_ARCH flags field of the FADT Table\r
 */\r
 typedef struct CmArmBootArchInfo {\r
   /** This is the ARM_BOOT_ARCH flags field of the FADT Table\r


@@ -73,10 +71,13 @@ typedef struct CmArmCpuInfo {
   // Reserved for use when SMBIOS tables are implemented\r
 } CM_ARM_CPU_INFO;\r
 \r
   // Reserved for use when SMBIOS tables are implemented\r
 } CM_ARM_CPU_INFO;\r
 \r

+typedef struct CmArmCpuInfoList {\r
+  UINT32             CpuCount;\r
+  CM_ARM_CPU_INFO  * CpuInfo;\r
+} CM_ARM_CPU_INFO_LIST;\r
+\r

 /** A structure that describes the\r
     Power Management Profile Information for the Platform.\r
 /** A structure that describes the\r
     Power Management Profile Information for the Platform.\r

-\r
-    ID: EArmObjPowerManagementProfileInfo\r

 */\r
 typedef struct CmArmPowerManagementProfileInfo {\r
   /** This is the Preferred_PM_Profile field of the FADT Table\r
 */\r
 typedef struct CmArmPowerManagementProfileInfo {\r
   /** This is the Preferred_PM_Profile field of the FADT Table\r


@@ -87,8 +88,6 @@ typedef struct CmArmPowerManagementProfileInfo {
 \r
 /** A structure that describes the\r
     GIC CPU Interface for the Platform.\r
 \r
 /** A structure that describes the\r
     GIC CPU Interface for the Platform.\r

-\r
-    ID: EArmObjGicCInfo\r

 */\r
 typedef struct CmArmGicCInfo {\r
   /// The GIC CPU Interface number.\r
 */\r
 typedef struct CmArmGicCInfo {\r
   /// The GIC CPU Interface number.\r


@@ -165,10 +164,11 @@ typedef struct CmArmGicCInfo {
 \r
 /** A structure that describes the\r
     GIC Distributor information for the Platform.\r
 \r
 /** A structure that describes the\r
     GIC Distributor information for the Platform.\r

-\r
-    ID: EArmObjGicDInfo\r

 */\r
 typedef struct CmArmGicDInfo {\r
 */\r
 typedef struct CmArmGicDInfo {\r

+  /// The GIC Distributor ID.\r
+  UINT32  GicId;\r
+\r

   /// The Physical Base address for the GIC Distributor.\r
   UINT64  PhysicalBaseAddress;\r
 \r
   /// The Physical Base address for the GIC Distributor.\r
   UINT64  PhysicalBaseAddress;\r
 \r


@@ -187,8 +187,6 @@ typedef struct CmArmGicDInfo {
 \r
 /** A structure that describes the\r
     GIC MSI Frame information for the Platform.\r
 \r
 /** A structure that describes the\r
     GIC MSI Frame information for the Platform.\r

-\r
-    ID: EArmObjGicMsiFrameInfo\r

 */\r
 typedef struct CmArmGicMsiFrameInfo {\r
   /// The GIC MSI Frame ID\r
 */\r
 typedef struct CmArmGicMsiFrameInfo {\r
   /// The GIC MSI Frame ID\r


@@ -212,8 +210,6 @@ typedef struct CmArmGicMsiFrameInfo {
 \r
 /** A structure that describes the\r
     GIC Redistributor information for the Platform.\r
 \r
 /** A structure that describes the\r
     GIC Redistributor information for the Platform.\r

-\r
-    ID: EArmObjGicRedistributorInfo\r

 */\r
 typedef struct CmArmGicRedistInfo {\r
   /** The physical address of a page range\r
 */\r
 typedef struct CmArmGicRedistInfo {\r
   /** The physical address of a page range\r


@@ -227,8 +223,6 @@ typedef struct CmArmGicRedistInfo {
 \r
 /** A structure that describes the\r
     GIC Interrupt Translation Service information for the Platform.\r
 \r
 /** A structure that describes the\r
     GIC Interrupt Translation Service information for the Platform.\r

-\r
-    ID: EArmObjGicItsInfo\r

 */\r
 typedef struct CmArmGicItsInfo {\r
   /// The GIC ITS ID\r
 */\r
 typedef struct CmArmGicItsInfo {\r
   /// The GIC ITS ID\r


@@ -240,9 +234,6 @@ typedef struct CmArmGicItsInfo {
 \r
 /** A structure that describes the\r
     Serial Port information for the Platform.\r
 \r
 /** A structure that describes the\r
     Serial Port information for the Platform.\r

-\r
-    ID: EArmObjSerialConsolePortInfo or\r
-        EArmObjSerialDebugPortInfo\r

 */\r
 typedef struct CmArmSerialPortInfo {\r
   /// The physical base address for the serial port\r
 */\r
 typedef struct CmArmSerialPortInfo {\r
   /// The physical base address for the serial port\r


@@ -263,8 +254,6 @@ typedef struct CmArmSerialPortInfo {
 \r
 /** A structure that describes the\r
     Generic Timer information for the Platform.\r
 \r
 /** A structure that describes the\r
     Generic Timer information for the Platform.\r

-\r
-    ID: EArmObjGenericTimerInfo\r

 */\r
 typedef struct CmArmGenericTimerInfo {\r
   /// The physical base address for the counter control frame\r
 */\r
 typedef struct CmArmGenericTimerInfo {\r
   /// The physical base address for the counter control frame\r


@@ -300,8 +289,6 @@ typedef struct CmArmGenericTimerInfo {
 \r
 /** A structure that describes the\r
     Platform Generic Block Timer Frame information for the Platform.\r
 \r
 /** A structure that describes the\r
     Platform Generic Block Timer Frame information for the Platform.\r

-\r
-    ID: EArmObjGTBlockTimerFrameInfo\r

 */\r
 typedef struct CmArmGTBlockTimerFrameInfo {\r
   /// The Generic Timer frame number\r
 */\r
 typedef struct CmArmGTBlockTimerFrameInfo {\r
   /// The Generic Timer frame number\r


@@ -337,8 +324,6 @@ typedef struct CmArmGTBlockTimerFrameInfo {
 \r
 /** A structure that describes the\r
     Platform Generic Block Timer information for the Platform.\r
 \r
 /** A structure that describes the\r
     Platform Generic Block Timer information for the Platform.\r

-\r
-    ID: EArmObjPlatformGTBlockInfo\r

 */\r
 typedef struct CmArmGTBlockInfo {\r
   /// The physical base address for the GT Block Timer structure\r
 */\r
 typedef struct CmArmGTBlockInfo {\r
   /// The physical base address for the GT Block Timer structure\r


@@ -353,8 +338,6 @@ typedef struct CmArmGTBlockInfo {
 \r
 /** A structure that describes the\r
     SBSA Generic Watchdog information for the Platform.\r
 \r
 /** A structure that describes the\r
     SBSA Generic Watchdog information for the Platform.\r

-\r
-    ID: EArmObjPlatformGenericWatchdogInfo\r

 */\r
 typedef struct CmArmGenericWatchdogInfo {\r
   /// The physical base address of the SBSA Watchdog control frame\r
 */\r
 typedef struct CmArmGenericWatchdogInfo {\r
   /// The physical base address of the SBSA Watchdog control frame\r


@@ -374,8 +357,6 @@ typedef struct CmArmGenericWatchdogInfo {
 \r
 /** A structure that describes the\r
     PCI Configuration Space information for the Platform.\r
 \r
 /** A structure that describes the\r
     PCI Configuration Space information for the Platform.\r

-\r
-    ID: EArmObjPciConfigSpaceInfo\r

 */\r
 typedef struct CmArmPciConfigSpaceInfo {\r
   /// The physical base address for the PCI segment\r
 */\r
 typedef struct CmArmPciConfigSpaceInfo {\r
   /// The physical base address for the PCI segment\r


@@ -393,8 +374,6 @@ typedef struct CmArmPciConfigSpaceInfo {
 \r
 /** A structure that describes the\r
     Hypervisor Vendor ID information for the Platform.\r
 \r
 /** A structure that describes the\r
     Hypervisor Vendor ID information for the Platform.\r

-\r
-    ID: EArmObjHypervisorVendorIdentity\r

 */\r
 typedef struct CmArmHypervisorVendorId {\r
   /// The hypervisor Vendor ID\r
 */\r
 typedef struct CmArmHypervisorVendorId {\r
   /// The hypervisor Vendor ID\r


@@ -403,8 +382,6 @@ typedef struct CmArmHypervisorVendorId {
 \r
 /** A structure that describes the\r
     Fixed feature flags for the Platform.\r
 \r
 /** A structure that describes the\r
     Fixed feature flags for the Platform.\r

-\r
-    ID: EArmObjFixedFeatureFlags\r

 */\r
 typedef struct CmArmFixedFeatureFlags {\r
   /// The Fixed feature flags\r
 */\r
 typedef struct CmArmFixedFeatureFlags {\r
   /// The Fixed feature flags\r


@@ -413,11 +390,9 @@ typedef struct CmArmFixedFeatureFlags {
 \r
 /** A structure that describes the\r
     ITS Group node for the Platform.\r
 \r
 /** A structure that describes the\r
     ITS Group node for the Platform.\r

-\r
-    ID: EArmObjItsGroup\r

 */\r
 typedef struct CmArmItsGroupNode {\r
 */\r
 typedef struct CmArmItsGroupNode {\r

-  /// An unique token used to identify this object\r
+  /// An unique token used to ideintify this object\r

   CM_OBJECT_TOKEN   Token;\r
   /// The number of ITS identifiers in the ITS node\r
   UINT32            ItsIdCount;\r
   CM_OBJECT_TOKEN   Token;\r
   /// The number of ITS identifiers in the ITS node\r
   UINT32            ItsIdCount;\r


@@ -427,8 +402,6 @@ typedef struct CmArmItsGroupNode {
 \r
 /** A structure that describes the\r
     GIC ITS Identifiers for an ITS Group node.\r
 \r
 /** A structure that describes the\r
     GIC ITS Identifiers for an ITS Group node.\r

-\r
-    ID: EArmObjGicItsIdentifierArray\r

 */\r
 typedef struct CmArmGicItsIdentifier {\r
   /// The ITS Identifier\r
 */\r
 typedef struct CmArmGicItsIdentifier {\r
   /// The ITS Identifier\r


@@ -437,11 +410,9 @@ typedef struct CmArmGicItsIdentifier {
 \r
 /** A structure that describes the\r
     Named component node for the Platform.\r
 \r
 /** A structure that describes the\r
     Named component node for the Platform.\r

-\r
-    ID: EArmObjNamedComponent\r

 */\r
 typedef struct CmArmNamedComponentNode {\r
 */\r
 typedef struct CmArmNamedComponentNode {\r

-  /// An unique token used to identify this object\r
+  /// An unique token used to ideintify this object\r

   CM_OBJECT_TOKEN   Token;\r
   /// Number of ID mappings\r
   UINT32            IdMappingCount;\r
   CM_OBJECT_TOKEN   Token;\r
   /// Number of ID mappings\r
   UINT32            IdMappingCount;\r


@@ -468,11 +439,9 @@ typedef struct CmArmNamedComponentNode {
 \r
 /** A structure that describes the\r
     Root complex node for the Platform.\r
 \r
 /** A structure that describes the\r
     Root complex node for the Platform.\r

-\r
-    ID: EArmObjRootComplex\r

 */\r
 typedef struct CmArmRootComplexNode {\r
 */\r
 typedef struct CmArmRootComplexNode {\r

-  /// An unique token used to identify this object\r
+  /// An unique token used to ideintify this object\r

   CM_OBJECT_TOKEN   Token;\r
   /// Number of ID mappings\r
   UINT32            IdMappingCount;\r
   CM_OBJECT_TOKEN   Token;\r
   /// Number of ID mappings\r
   UINT32            IdMappingCount;\r


@@ -496,11 +465,9 @@ typedef struct CmArmRootComplexNode {
 \r
 /** A structure that describes the\r
     SMMUv1 or SMMUv2 node for the Platform.\r
 \r
 /** A structure that describes the\r
     SMMUv1 or SMMUv2 node for the Platform.\r

-\r
-    ID: EArmObjSmmuV1SmmuV2\r

 */\r
 typedef struct CmArmSmmuV1SmmuV2Node {\r
 */\r
 typedef struct CmArmSmmuV1SmmuV2Node {\r

-  /// An unique token used to identify this object\r
+  /// An unique token used to ideintify this object\r

   CM_OBJECT_TOKEN   Token;\r
   /// Number of ID mappings\r
   UINT32            IdMappingCount;\r
   CM_OBJECT_TOKEN   Token;\r
   /// Number of ID mappings\r
   UINT32            IdMappingCount;\r


@@ -538,11 +505,9 @@ typedef struct CmArmSmmuV1SmmuV2Node {
 \r
 /** A structure that describes the\r
     SMMUv3 node for the Platform.\r
 \r
 /** A structure that describes the\r
     SMMUv3 node for the Platform.\r

-\r
-    ID: EArmObjSmmuV3\r

 */\r
 typedef struct CmArmSmmuV3Node {\r
 */\r
 typedef struct CmArmSmmuV3Node {\r

-  /// An unique token used to identify this object\r
+  /// An unique token used to ideintify this object\r

   CM_OBJECT_TOKEN   Token;\r
   /// Number of ID mappings\r
   UINT32            IdMappingCount;\r
   CM_OBJECT_TOKEN   Token;\r
   /// Number of ID mappings\r
   UINT32            IdMappingCount;\r


@@ -574,11 +539,9 @@ typedef struct CmArmSmmuV3Node {
 \r
 /** A structure that describes the\r
     PMCG node for the Platform.\r
 \r
 /** A structure that describes the\r
     PMCG node for the Platform.\r

-\r
-    ID: EArmObjPmcg\r

 */\r
 typedef struct CmArmPmcgNode {\r
 */\r
 typedef struct CmArmPmcgNode {\r

-  /// An unique token used to identify this object\r
+  /// An unique token used to ideintify this object\r

   CM_OBJECT_TOKEN   Token;\r
   /// Number of ID mappings\r
   UINT32            IdMappingCount;\r
   CM_OBJECT_TOKEN   Token;\r
   /// Number of ID mappings\r
   UINT32            IdMappingCount;\r


@@ -598,8 +561,6 @@ typedef struct CmArmPmcgNode {
 \r
 /** A structure that describes the\r
     ID Mappings for the Platform.\r
 \r
 /** A structure that describes the\r
     ID Mappings for the Platform.\r

-\r
-    ID: EArmObjIdMappingArray\r

 */\r
 typedef struct CmArmIdMapping {\r
   /// Input base\r
 */\r
 typedef struct CmArmIdMapping {\r
   /// Input base\r


@@ -616,8 +577,6 @@ typedef struct CmArmIdMapping {
 \r
 /** A structure that describes the\r
     SMMU interrupts for the Platform.\r
 \r
 /** A structure that describes the\r
     SMMU interrupts for the Platform.\r

-\r
-    ID: EArmObjSmmuInterruptArray\r

 */\r
 typedef struct CmArmSmmuInterrupt {\r
   /// Interrupt number\r
 */\r
 typedef struct CmArmSmmuInterrupt {\r
   /// Interrupt number\r