DynamicTablesPkg: Minor updates and fix typos
authorSami Mujawar <sami.mujawar@arm.com>
Thu, 21 Feb 2019 15:38:26 +0000 (15:38 +0000)
committerSami Mujawar <sami.mujawar@arm.com>
Wed, 20 Mar 2019 11:00:44 +0000 (11:00 +0000)
This patch was originally merged in edk2 master at
07f4e26eb6fe5203028ecfe9bad90d3b67dc72c8. However, this was
later reverted at 4c20a7913333fdbd3b4c83dba060fefa84027313
as it was merged during the Soft Feature Freeze for
edk2-stable201903.

Resubmitting this patch as the edk2 merge window is now open.

Minor updates to comments and typo fixes. Also removed
unused structure CM_ARM_CPU_INFO_LIST.

Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Alexei Fedorov <alexei.fedorov@arm.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Sami Mujawar <sami.mujawar@arm.com>
Reviewed-by: Alexei Fedorov <alexei.fedorov@arm.com>
DynamicTablesPkg/Include/ArmNameSpaceObjects.h

index 73139eb..ec31c40 100644 (file)
@@ -59,6 +59,8 @@ typedef enum ArmObjectID {
 \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
@@ -71,13 +73,10 @@ typedef struct CmArmCpuInfo {
   // 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
+\r
+    ID: EArmObjPowerManagementProfileInfo\r
 */\r
 typedef struct CmArmPowerManagementProfileInfo {\r
   /** This is the Preferred_PM_Profile field of the FADT Table\r
@@ -88,6 +87,8 @@ typedef struct CmArmPowerManagementProfileInfo {
 \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
@@ -164,6 +165,8 @@ typedef struct CmArmGicCInfo {
 \r
 /** A structure that describes the\r
     GIC Distributor information for the Platform.\r
+\r
+    ID: EArmObjGicDInfo\r
 */\r
 typedef struct CmArmGicDInfo {\r
   /// The Physical Base address for the GIC Distributor.\r
@@ -184,6 +187,8 @@ typedef struct CmArmGicDInfo {
 \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
@@ -207,6 +212,8 @@ typedef struct CmArmGicMsiFrameInfo {
 \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
@@ -220,6 +227,8 @@ typedef struct CmArmGicRedistInfo {
 \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
@@ -231,6 +240,9 @@ typedef struct CmArmGicItsInfo {
 \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
@@ -251,6 +263,8 @@ typedef struct CmArmSerialPortInfo {
 \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
@@ -286,6 +300,8 @@ typedef struct CmArmGenericTimerInfo {
 \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
@@ -321,6 +337,8 @@ typedef struct CmArmGTBlockTimerFrameInfo {
 \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
@@ -335,6 +353,8 @@ typedef struct CmArmGTBlockInfo {
 \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
@@ -354,6 +374,8 @@ typedef struct CmArmGenericWatchdogInfo {
 \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
@@ -371,6 +393,8 @@ typedef struct CmArmPciConfigSpaceInfo {
 \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
@@ -379,6 +403,8 @@ typedef struct CmArmHypervisorVendorId {
 \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
@@ -387,9 +413,11 @@ typedef struct CmArmFixedFeatureFlags {
 \r
 /** A structure that describes the\r
     ITS Group node for the Platform.\r
+\r
+    ID: EArmObjItsGroup\r
 */\r
 typedef struct CmArmItsGroupNode {\r
-  /// An unique token used to ideintify this object\r
+  /// An unique token used to identify this object\r
   CM_OBJECT_TOKEN   Token;\r
   /// The number of ITS identifiers in the ITS node\r
   UINT32            ItsIdCount;\r
@@ -399,6 +427,8 @@ typedef struct CmArmItsGroupNode {
 \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
@@ -407,9 +437,11 @@ typedef struct CmArmGicItsIdentifier {
 \r
 /** A structure that describes the\r
     Named component node for the Platform.\r
+\r
+    ID: EArmObjNamedComponent\r
 */\r
 typedef struct CmArmNamedComponentNode {\r
-  /// An unique token used to ideintify this object\r
+  /// An unique token used to identify this object\r
   CM_OBJECT_TOKEN   Token;\r
   /// Number of ID mappings\r
   UINT32            IdMappingCount;\r
@@ -436,9 +468,11 @@ typedef struct CmArmNamedComponentNode {
 \r
 /** A structure that describes the\r
     Root complex node for the Platform.\r
+\r
+    ID: EArmObjRootComplex\r
 */\r
 typedef struct CmArmRootComplexNode {\r
-  /// An unique token used to ideintify this object\r
+  /// An unique token used to identify this object\r
   CM_OBJECT_TOKEN   Token;\r
   /// Number of ID mappings\r
   UINT32            IdMappingCount;\r
@@ -462,9 +496,11 @@ typedef struct CmArmRootComplexNode {
 \r
 /** A structure that describes the\r
     SMMUv1 or SMMUv2 node for the Platform.\r
+\r
+    ID: EArmObjSmmuV1SmmuV2\r
 */\r
 typedef struct CmArmSmmuV1SmmuV2Node {\r
-  /// An unique token used to ideintify this object\r
+  /// An unique token used to identify this object\r
   CM_OBJECT_TOKEN   Token;\r
   /// Number of ID mappings\r
   UINT32            IdMappingCount;\r
@@ -502,9 +538,11 @@ typedef struct CmArmSmmuV1SmmuV2Node {
 \r
 /** A structure that describes the\r
     SMMUv3 node for the Platform.\r
+\r
+    ID: EArmObjSmmuV3\r
 */\r
 typedef struct CmArmSmmuV3Node {\r
-  /// An unique token used to ideintify this object\r
+  /// An unique token used to identify this object\r
   CM_OBJECT_TOKEN   Token;\r
   /// Number of ID mappings\r
   UINT32            IdMappingCount;\r
@@ -536,9 +574,11 @@ typedef struct CmArmSmmuV3Node {
 \r
 /** A structure that describes the\r
     PMCG node for the Platform.\r
+\r
+    ID: EArmObjPmcg\r
 */\r
 typedef struct CmArmPmcgNode {\r
-  /// An unique token used to ideintify this object\r
+  /// An unique token used to identify this object\r
   CM_OBJECT_TOKEN   Token;\r
   /// Number of ID mappings\r
   UINT32            IdMappingCount;\r
@@ -558,6 +598,8 @@ typedef struct CmArmPmcgNode {
 \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
@@ -574,6 +616,8 @@ typedef struct CmArmIdMapping {
 \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