DynamicTablesPkg: Minor updates and fix typos

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

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Sami Mujawar <sami.mujawar@arm.com>
Reviewed-by: Alexei Fedorov <alexei.fedorov@arm.com>
This commit is contained in:
Sami Mujawar 2019-02-21 15:38:26 +00:00
parent d3a15f435f
commit 07f4e26eb6
1 changed files with 55 additions and 11 deletions

View File

@ -59,6 +59,8 @@ typedef enum ArmObjectID {
/** A structure that describes the /** A structure that describes the
ARM Boot Architecture flags. ARM Boot Architecture flags.
ID: EArmObjBootArchInfo
*/ */
typedef struct CmArmBootArchInfo { typedef struct CmArmBootArchInfo {
/** This is the ARM_BOOT_ARCH flags field of the FADT Table /** This is the ARM_BOOT_ARCH flags field of the FADT Table
@ -71,13 +73,10 @@ typedef struct CmArmCpuInfo {
// Reserved for use when SMBIOS tables are implemented // Reserved for use when SMBIOS tables are implemented
} CM_ARM_CPU_INFO; } CM_ARM_CPU_INFO;
typedef struct CmArmCpuInfoList {
UINT32 CpuCount;
CM_ARM_CPU_INFO * CpuInfo;
} CM_ARM_CPU_INFO_LIST;
/** A structure that describes the /** A structure that describes the
Power Management Profile Information for the Platform. Power Management Profile Information for the Platform.
ID: EArmObjPowerManagementProfileInfo
*/ */
typedef struct CmArmPowerManagementProfileInfo { typedef struct CmArmPowerManagementProfileInfo {
/** This is the Preferred_PM_Profile field of the FADT Table /** This is the Preferred_PM_Profile field of the FADT Table
@ -88,6 +87,8 @@ typedef struct CmArmPowerManagementProfileInfo {
/** A structure that describes the /** A structure that describes the
GIC CPU Interface for the Platform. GIC CPU Interface for the Platform.
ID: EArmObjGicCInfo
*/ */
typedef struct CmArmGicCInfo { typedef struct CmArmGicCInfo {
/// The GIC CPU Interface number. /// The GIC CPU Interface number.
@ -164,6 +165,8 @@ typedef struct CmArmGicCInfo {
/** A structure that describes the /** A structure that describes the
GIC Distributor information for the Platform. GIC Distributor information for the Platform.
ID: EArmObjGicDInfo
*/ */
typedef struct CmArmGicDInfo { typedef struct CmArmGicDInfo {
/// The Physical Base address for the GIC Distributor. /// The Physical Base address for the GIC Distributor.
@ -184,6 +187,8 @@ typedef struct CmArmGicDInfo {
/** A structure that describes the /** A structure that describes the
GIC MSI Frame information for the Platform. GIC MSI Frame information for the Platform.
ID: EArmObjGicMsiFrameInfo
*/ */
typedef struct CmArmGicMsiFrameInfo { typedef struct CmArmGicMsiFrameInfo {
/// The GIC MSI Frame ID /// The GIC MSI Frame ID
@ -207,6 +212,8 @@ typedef struct CmArmGicMsiFrameInfo {
/** A structure that describes the /** A structure that describes the
GIC Redistributor information for the Platform. GIC Redistributor information for the Platform.
ID: EArmObjGicRedistributorInfo
*/ */
typedef struct CmArmGicRedistInfo { typedef struct CmArmGicRedistInfo {
/** The physical address of a page range /** The physical address of a page range
@ -220,6 +227,8 @@ typedef struct CmArmGicRedistInfo {
/** A structure that describes the /** A structure that describes the
GIC Interrupt Translation Service information for the Platform. GIC Interrupt Translation Service information for the Platform.
ID: EArmObjGicItsInfo
*/ */
typedef struct CmArmGicItsInfo { typedef struct CmArmGicItsInfo {
/// The GIC ITS ID /// The GIC ITS ID
@ -231,6 +240,9 @@ typedef struct CmArmGicItsInfo {
/** A structure that describes the /** A structure that describes the
Serial Port information for the Platform. Serial Port information for the Platform.
ID: EArmObjSerialConsolePortInfo or
EArmObjSerialDebugPortInfo
*/ */
typedef struct CmArmSerialPortInfo { typedef struct CmArmSerialPortInfo {
/// The physical base address for the serial port /// The physical base address for the serial port
@ -251,6 +263,8 @@ typedef struct CmArmSerialPortInfo {
/** A structure that describes the /** A structure that describes the
Generic Timer information for the Platform. Generic Timer information for the Platform.
ID: EArmObjGenericTimerInfo
*/ */
typedef struct CmArmGenericTimerInfo { typedef struct CmArmGenericTimerInfo {
/// The physical base address for the counter control frame /// The physical base address for the counter control frame
@ -286,6 +300,8 @@ typedef struct CmArmGenericTimerInfo {
/** A structure that describes the /** A structure that describes the
Platform Generic Block Timer Frame information for the Platform. Platform Generic Block Timer Frame information for the Platform.
ID: EArmObjGTBlockTimerFrameInfo
*/ */
typedef struct CmArmGTBlockTimerFrameInfo { typedef struct CmArmGTBlockTimerFrameInfo {
/// The Generic Timer frame number /// The Generic Timer frame number
@ -321,6 +337,8 @@ typedef struct CmArmGTBlockTimerFrameInfo {
/** A structure that describes the /** A structure that describes the
Platform Generic Block Timer information for the Platform. Platform Generic Block Timer information for the Platform.
ID: EArmObjPlatformGTBlockInfo
*/ */
typedef struct CmArmGTBlockInfo { typedef struct CmArmGTBlockInfo {
/// The physical base address for the GT Block Timer structure /// The physical base address for the GT Block Timer structure
@ -335,6 +353,8 @@ typedef struct CmArmGTBlockInfo {
/** A structure that describes the /** A structure that describes the
SBSA Generic Watchdog information for the Platform. SBSA Generic Watchdog information for the Platform.
ID: EArmObjPlatformGenericWatchdogInfo
*/ */
typedef struct CmArmGenericWatchdogInfo { typedef struct CmArmGenericWatchdogInfo {
/// The physical base address of the SBSA Watchdog control frame /// The physical base address of the SBSA Watchdog control frame
@ -354,6 +374,8 @@ typedef struct CmArmGenericWatchdogInfo {
/** A structure that describes the /** A structure that describes the
PCI Configuration Space information for the Platform. PCI Configuration Space information for the Platform.
ID: EArmObjPciConfigSpaceInfo
*/ */
typedef struct CmArmPciConfigSpaceInfo { typedef struct CmArmPciConfigSpaceInfo {
/// The physical base address for the PCI segment /// The physical base address for the PCI segment
@ -371,6 +393,8 @@ typedef struct CmArmPciConfigSpaceInfo {
/** A structure that describes the /** A structure that describes the
Hypervisor Vendor ID information for the Platform. Hypervisor Vendor ID information for the Platform.
ID: EArmObjHypervisorVendorIdentity
*/ */
typedef struct CmArmHypervisorVendorId { typedef struct CmArmHypervisorVendorId {
/// The hypervisor Vendor ID /// The hypervisor Vendor ID
@ -379,6 +403,8 @@ typedef struct CmArmHypervisorVendorId {
/** A structure that describes the /** A structure that describes the
Fixed feature flags for the Platform. Fixed feature flags for the Platform.
ID: EArmObjFixedFeatureFlags
*/ */
typedef struct CmArmFixedFeatureFlags { typedef struct CmArmFixedFeatureFlags {
/// The Fixed feature flags /// The Fixed feature flags
@ -387,9 +413,11 @@ typedef struct CmArmFixedFeatureFlags {
/** A structure that describes the /** A structure that describes the
ITS Group node for the Platform. ITS Group node for the Platform.
ID: EArmObjItsGroup
*/ */
typedef struct CmArmItsGroupNode { typedef struct CmArmItsGroupNode {
/// An unique token used to ideintify this object /// An unique token used to identify this object
CM_OBJECT_TOKEN Token; CM_OBJECT_TOKEN Token;
/// The number of ITS identifiers in the ITS node /// The number of ITS identifiers in the ITS node
UINT32 ItsIdCount; UINT32 ItsIdCount;
@ -399,6 +427,8 @@ typedef struct CmArmItsGroupNode {
/** A structure that describes the /** A structure that describes the
GIC ITS Identifiers for an ITS Group node. GIC ITS Identifiers for an ITS Group node.
ID: EArmObjGicItsIdentifierArray
*/ */
typedef struct CmArmGicItsIdentifier { typedef struct CmArmGicItsIdentifier {
/// The ITS Identifier /// The ITS Identifier
@ -407,9 +437,11 @@ typedef struct CmArmGicItsIdentifier {
/** A structure that describes the /** A structure that describes the
Named component node for the Platform. Named component node for the Platform.
ID: EArmObjNamedComponent
*/ */
typedef struct CmArmNamedComponentNode { typedef struct CmArmNamedComponentNode {
/// An unique token used to ideintify this object /// An unique token used to identify this object
CM_OBJECT_TOKEN Token; CM_OBJECT_TOKEN Token;
/// Number of ID mappings /// Number of ID mappings
UINT32 IdMappingCount; UINT32 IdMappingCount;
@ -436,9 +468,11 @@ typedef struct CmArmNamedComponentNode {
/** A structure that describes the /** A structure that describes the
Root complex node for the Platform. Root complex node for the Platform.
ID: EArmObjRootComplex
*/ */
typedef struct CmArmRootComplexNode { typedef struct CmArmRootComplexNode {
/// An unique token used to ideintify this object /// An unique token used to identify this object
CM_OBJECT_TOKEN Token; CM_OBJECT_TOKEN Token;
/// Number of ID mappings /// Number of ID mappings
UINT32 IdMappingCount; UINT32 IdMappingCount;
@ -462,9 +496,11 @@ typedef struct CmArmRootComplexNode {
/** A structure that describes the /** A structure that describes the
SMMUv1 or SMMUv2 node for the Platform. SMMUv1 or SMMUv2 node for the Platform.
ID: EArmObjSmmuV1SmmuV2
*/ */
typedef struct CmArmSmmuV1SmmuV2Node { typedef struct CmArmSmmuV1SmmuV2Node {
/// An unique token used to ideintify this object /// An unique token used to identify this object
CM_OBJECT_TOKEN Token; CM_OBJECT_TOKEN Token;
/// Number of ID mappings /// Number of ID mappings
UINT32 IdMappingCount; UINT32 IdMappingCount;
@ -502,9 +538,11 @@ typedef struct CmArmSmmuV1SmmuV2Node {
/** A structure that describes the /** A structure that describes the
SMMUv3 node for the Platform. SMMUv3 node for the Platform.
ID: EArmObjSmmuV3
*/ */
typedef struct CmArmSmmuV3Node { typedef struct CmArmSmmuV3Node {
/// An unique token used to ideintify this object /// An unique token used to identify this object
CM_OBJECT_TOKEN Token; CM_OBJECT_TOKEN Token;
/// Number of ID mappings /// Number of ID mappings
UINT32 IdMappingCount; UINT32 IdMappingCount;
@ -536,9 +574,11 @@ typedef struct CmArmSmmuV3Node {
/** A structure that describes the /** A structure that describes the
PMCG node for the Platform. PMCG node for the Platform.
ID: EArmObjPmcg
*/ */
typedef struct CmArmPmcgNode { typedef struct CmArmPmcgNode {
/// An unique token used to ideintify this object /// An unique token used to identify this object
CM_OBJECT_TOKEN Token; CM_OBJECT_TOKEN Token;
/// Number of ID mappings /// Number of ID mappings
UINT32 IdMappingCount; UINT32 IdMappingCount;
@ -558,6 +598,8 @@ typedef struct CmArmPmcgNode {
/** A structure that describes the /** A structure that describes the
ID Mappings for the Platform. ID Mappings for the Platform.
ID: EArmObjIdMappingArray
*/ */
typedef struct CmArmIdMapping { typedef struct CmArmIdMapping {
/// Input base /// Input base
@ -574,6 +616,8 @@ typedef struct CmArmIdMapping {
/** A structure that describes the /** A structure that describes the
SMMU interrupts for the Platform. SMMU interrupts for the Platform.
ID: EArmObjSmmuInterruptArray
*/ */
typedef struct CmArmSmmuInterrupt { typedef struct CmArmSmmuInterrupt {
/// Interrupt number /// Interrupt number