Use doxygen comment style for document entity such as struct, enum, variable that...

[mirror_edk2.git] / MdePkg / Include / IndustryStandard / Acpi2_0.h

diff --git a/MdePkg/Include/IndustryStandard/Acpi2_0.h b/MdePkg/Include/IndustryStandard/Acpi2_0.h
index 9d46813f8ef444c8e88c5e4d0e65796673f254be..8462caab3f99cb984c31d38bfbba4588c7f705de 100644 (file)
--- a/MdePkg/Include/IndustryStandard/Acpi2_0.h
+++ b/MdePkg/Include/IndustryStandard/Acpi2_0.h
@@ -1,5 +1,4 @@
-/** \r
-       @file   \r
+/** @file   \r
        ACPI 2.0 definitions from the ACPI Specification, revision 2.0\r
 \r
   Copyright (c) 2006 - 2007, Intel Corporation\r
@@ -15,7 +14,7 @@
 #ifndef _ACPI_2_0_H_\r
 #define _ACPI_2_0_H_\r
 \r
-#include "Acpi.h"\r
+#include <IndustryStandard/Acpi1_0.h>\r
 \r
 //\r
 // Ensure proper structure formats\r
@@ -26,31 +25,9 @@
 //\r
 #define EFI_ACPI_2_0_REVISION 0x02\r
 \r
-//\r
-// BUGBUG: OEM values need to be moved somewhere else, probably read from data hub\r
-// and produced by a platform specific driver.\r
-//\r
-//\r
-// ACPI OEM ID\r
-//\r
-#define EFI_ACPI_2_0_OEM_ID       "INTEL "\r
-#define EFI_ACPI_2_0_OEM_TABLE_ID 0x5034303738543245  // "E2T8704P"\r
-//\r
-// ACPI OEM Revision\r
-//\r
-#define EFI_ACPI_2_0_OEM_REVISION 0x00000002\r
-\r
-//\r
-// ACPI table creator ID\r
-//\r
-#define EFI_ACPI_2_0_CREATOR_ID 0x5446534D  // TBD "MSFT"\r
-//\r
-// ACPI table creator revision\r
-//\r
-#define EFI_ACPI_2_0_CREATOR_REVISION 0x01000013  // TBD\r
-//\r
-// ACPI 2.0 Generic Address Space definition\r
-//\r
+///\r
+/// ACPI 2.0 Generic Address Space definition\r
+///\r
 typedef struct {\r
   UINT8   AddressSpaceId;\r
   UINT8   RegisterBitWidth;\r
@@ -72,9 +49,10 @@ typedef struct {
 //\r
 // ACPI 2.0 table structures\r
 //\r
-//\r
-// Root System Description Pointer Structure\r
-//\r
+\r
+///\r
+/// Root System Description Pointer Structure\r
+///\r
 typedef struct {\r
   UINT64  Signature;\r
   UINT8   Checksum;\r
@@ -87,15 +65,15 @@ typedef struct {
   UINT8   Reserved[3];\r
 } EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER;\r
 \r
-//\r
-// RSD_PTR Revision (as defined in ACPI 2.0 spec.)\r
-//\r
+///\r
+/// RSD_PTR Revision (as defined in ACPI 2.0 spec.)\r
+///\r
 #define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02\r
 \r
-//\r
-// Common table header, this prefaces all ACPI tables, including FACS, but\r
-// excluding the RSD PTR structure\r
-//\r
+///\r
+/// Common table header, this prefaces all ACPI tables, including FACS, but\r
+/// excluding the RSD PTR structure\r
+///\r
 typedef struct {\r
   UINT32  Signature;\r
   UINT32  Length;\r
@@ -106,9 +84,10 @@ typedef struct {
 // No definition needed as it is a common description table header followed by a\r
 // variable number of UINT32 table pointers.\r
 //\r
-//\r
-// RSDT Revision (as defined in ACPI 2.0 spec.)\r
-//\r
+\r
+///\r
+/// RSDT Revision (as defined in ACPI 2.0 spec.)\r
+///\r
 #define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01\r
 \r
 //\r
@@ -116,14 +95,15 @@ typedef struct {
 // No definition needed as it is a common description table header followed by a\r
 // variable number of UINT64 table pointers.\r
 //\r
-//\r
-// XSDT Revision (as defined in ACPI 2.0 spec.)\r
-//\r
+\r
+///\r
+/// XSDT Revision (as defined in ACPI 2.0 spec.)\r
+///\r
 #define EFI_ACPI_2_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01\r
 \r
-//\r
-// Fixed ACPI Description Table Structure (FADT)\r
-//\r
+///\r
+/// Fixed ACPI Description Table Structure (FADT)\r
+///\r
 typedef struct {\r
   EFI_ACPI_DESCRIPTION_HEADER             Header;\r
   UINT32                                  FirmwareCtrl;\r
@@ -179,15 +159,15 @@ typedef struct {
   EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE  XGpe1Blk;\r
 } EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE;\r
 \r
-//\r
-// FADT Version (as defined in ACPI 2.0 spec.)\r
-//\r
+///\r
+/// FADT Version (as defined in ACPI 2.0 spec.)\r
+///\r
 #define EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION  0x03\r
 \r
-//\r
-// Fixed ACPI Description Table Boot Architecture Flags\r
-// All other bits are reserved and must be set to 0.\r
-//\r
+///\r
+/// Fixed ACPI Description Table Boot Architecture Flags\r
+/// All other bits are reserved and must be set to 0.\r
+///\r
 #define EFI_ACPI_2_0_LEGACY_DEVICES (1 << 0)\r
 #define EFI_ACPI_2_0_8042           (1 << 1)\r
 \r
@@ -210,9 +190,9 @@ typedef struct {
 #define EFI_ACPI_2_0_HEADLESS       (1 << 12)\r
 #define EFI_ACPI_2_0_CPU_SW_SLP     (1 << 13)\r
 \r
-//\r
-// Firmware ACPI Control Structure\r
-//\r
+///\r
+/// Firmware ACPI Control Structure\r
+///\r
 typedef struct {\r
   UINT32  Signature;\r
   UINT32  Length;\r
@@ -225,36 +205,36 @@ typedef struct {
   UINT8   Reserved[31];\r
 } EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;\r
 \r
-//\r
-// FACS Version (as defined in ACPI 2.0 spec.)\r
-//\r
+///\r
+/// FACS Version (as defined in ACPI 2.0 spec.)\r
+///\r
 #define EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION  0x01\r
 \r
-//\r
-// Firmware Control Structure Feature Flags\r
-// All other bits are reserved and must be set to 0.\r
-//\r
+///\r
+/// Firmware Control Structure Feature Flags\r
+/// All other bits are reserved and must be set to 0.\r
+///\r
 #define EFI_ACPI_2_0_S4BIOS_F (1 << 0)\r
 \r
-//\r
-// Multiple APIC Description Table header definition.  The rest of the table\r
-// must be defined in a platform specific manner.\r
-//\r
+///\r
+/// Multiple APIC Description Table header definition.  The rest of the table\r
+/// must be defined in a platform specific manner.\r
+///\r
 typedef struct {\r
   EFI_ACPI_DESCRIPTION_HEADER Header;\r
   UINT32                      LocalApicAddress;\r
   UINT32                      Flags;\r
 } EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;\r
 \r
-//\r
-// MADT Revision (as defined in ACPI 2.0 spec.)\r
-//\r
+///\r
+/// MADT Revision (as defined in ACPI 2.0 spec.)\r
+///\r
 #define EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x01\r
 \r
-//\r
-// Multiple APIC Flags\r
-// All other bits are reserved and must be set to 0.\r
-//\r
+///\r
+/// Multiple APIC Flags\r
+/// All other bits are reserved and must be set to 0.\r
+///\r
 #define EFI_ACPI_2_0_PCAT_COMPAT  (1 << 0)\r
 \r
 //\r
@@ -275,9 +255,10 @@ typedef struct {
 //\r
 // APIC Structure Definitions\r
 //\r
-//\r
-// Processor Local APIC Structure Definition\r
-//\r
+\r
+///\r
+/// Processor Local APIC Structure Definition\r
+///\r
 typedef struct {\r
   UINT8   Type;\r
   UINT8   Length;\r
@@ -286,14 +267,14 @@ typedef struct {
   UINT32  Flags;\r
 } EFI_ACPI_2_0_PROCESSOR_LOCAL_APIC_STRUCTURE;\r
 \r
-//\r
-// Local APIC Flags.  All other bits are reserved and must be 0.\r
-//\r
+///\r
+/// Local APIC Flags.  All other bits are reserved and must be 0.\r
+///\r
 #define EFI_ACPI_2_0_LOCAL_APIC_ENABLED (1 << 0)\r
 \r
-//\r
-// IO APIC Structure\r
-//\r
+///\r
+/// IO APIC Structure\r
+///\r
 typedef struct {\r
   UINT8   Type;\r
   UINT8   Length;\r
@@ -303,9 +284,9 @@ typedef struct {
   UINT32  GlobalSystemInterruptBase;\r
 } EFI_ACPI_2_0_IO_APIC_STRUCTURE;\r
 \r
-//\r
-// Interrupt Source Override Structure\r
-//\r
+///\r
+/// Interrupt Source Override Structure\r
+///\r
 typedef struct {\r
   UINT8   Type;\r
   UINT8   Length;\r
@@ -315,9 +296,9 @@ typedef struct {
   UINT16  Flags;\r
 } EFI_ACPI_2_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;\r
 \r
-//\r
-// Non-Maskable Interrupt Source Structure\r
-//\r
+///\r
+/// Non-Maskable Interrupt Source Structure\r
+///\r
 typedef struct {\r
   UINT8   Type;\r
   UINT8   Length;\r
@@ -325,9 +306,9 @@ typedef struct {
   UINT32  GlobalSystemInterrupt;\r
 } EFI_ACPI_2_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;\r
 \r
-//\r
-// Local APIC NMI Structure\r
-//\r
+///\r
+/// Local APIC NMI Structure\r
+///\r
 typedef struct {\r
   UINT8   Type;\r
   UINT8   Length;\r
@@ -336,9 +317,9 @@ typedef struct {
   UINT8   LocalApicLint;\r
 } EFI_ACPI_2_0_LOCAL_APIC_NMI_STRUCTURE;\r
 \r
-//\r
-// Local APIC Address Override Structure\r
-//\r
+///\r
+/// Local APIC Address Override Structure\r
+///\r
 typedef struct {\r
   UINT8   Type;\r
   UINT8   Length;\r
@@ -346,9 +327,9 @@ typedef struct {
   UINT64  LocalApicAddress;\r
 } EFI_ACPI_2_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE;\r
 \r
-//\r
-// IO SAPIC Structure\r
-//\r
+///\r
+/// IO SAPIC Structure\r
+///\r
 typedef struct {\r
   UINT8   Type;\r
   UINT8   Length;\r
@@ -358,9 +339,9 @@ typedef struct {
   UINT64  IoSapicAddress;\r
 } EFI_ACPI_2_0_IO_SAPIC_STRUCTURE;\r
 \r
-//\r
-// Local SAPIC Structure\r
-//\r
+///\r
+/// Local SAPIC Structure\r
+///\r
 typedef struct {\r
   UINT8   Type;\r
   UINT8   Length;\r
@@ -371,9 +352,9 @@ typedef struct {
   UINT32  Flags;\r
 } EFI_ACPI_2_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE;\r
 \r
-//\r
-// Platform Interrupt Sources Structure\r
-//\r
+///\r
+/// Platform Interrupt Sources Structure\r
+///\r
 typedef struct {\r
   UINT8   Type;\r
   UINT8   Length;\r
@@ -386,9 +367,9 @@ typedef struct {
   UINT32  Reserved;\r
 } EFI_ACPI_2_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE;\r
 \r
-//\r
-// Smart Battery Description Table (SBST)\r
-//\r
+///\r
+/// Smart Battery Description Table (SBST)\r
+///\r
 typedef struct {\r
   EFI_ACPI_DESCRIPTION_HEADER Header;\r
   UINT32                      WarningEnergyLevel;\r
@@ -396,16 +377,16 @@ typedef struct {
   UINT32                      CriticalEnergyLevel;\r
 } EFI_ACPI_2_0_SMART_BATTERY_DESCRIPTION_TABLE;\r
 \r
-//\r
-// SBST Version (as defined in ACPI 2.0 spec.)\r
-//\r
+///\r
+/// SBST Version (as defined in ACPI 2.0 spec.)\r
+///\r
 #define EFI_ACPI_2_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01\r
 \r
-//\r
-// Embedded Controller Boot Resources Table (ECDT)\r
-// The table is followed by a null terminated ASCII string that contains\r
-// a fully qualified reference to the name space object.\r
-//\r
+///\r
+/// Embedded Controller Boot Resources Table (ECDT)\r
+/// The table is followed by a null terminated ASCII string that contains\r
+/// a fully qualified reference to the name space object.\r
+///\r
 typedef struct {\r
   EFI_ACPI_DESCRIPTION_HEADER             Header;\r
   EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE  EcControl;\r
@@ -414,112 +395,118 @@ typedef struct {
   UINT8                                   GpeBit;\r
 } EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE;\r
 \r
-//\r
-// ECDT Version (as defined in ACPI 2.0 spec.)\r
-//\r
+///\r
+/// ECDT Version (as defined in ACPI 2.0 spec.)\r
+///\r
 #define EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_REVISION  0x01\r
 \r
 //\r
 // Known table signatures\r
 //\r
-//\r
-// "RSD PTR " Root System Description Pointer\r
-//\r
+\r
+///\r
+/// "RSD PTR " Root System Description Pointer\r
+///\r
 #define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE  0x2052545020445352\r
 \r
-//\r
-// "SPIC" Multiple SAPIC Description Table\r
-//\r
-// BUGBUG: Don't know where this came from except SR870BN4 uses it.\r
-// #define EFI_ACPI_2_0_MULTIPLE_SAPIC_DESCRIPTION_TABLE_SIGNATURE 0x43495053\r
-//\r
+///\r
+/// "SPIC" Multiple SAPIC Description Table\r
+///\r
+/// BUGBUG: Don't know where this came from except SR870BN4 uses it.\r
+/// #define EFI_ACPI_2_0_MULTIPLE_SAPIC_DESCRIPTION_TABLE_SIGNATURE 0x43495053\r
+///\r
 #define EFI_ACPI_2_0_MULTIPLE_SAPIC_DESCRIPTION_TABLE_SIGNATURE 0x43495041\r
 \r
-//\r
-// "BOOT" MS Simple Boot Spec\r
-//\r
+///\r
+/// "BOOT" MS Simple Boot Spec\r
+///\r
 #define EFI_ACPI_2_0_SIMPLE_BOOT_FLAG_TABLE_SIGNATURE 0x544F4F42\r
 \r
-//\r
-// "DBGP" MS Bebug Port Spec\r
-//\r
+///\r
+/// "DBGP" MS Bebug Port Spec\r
+///\r
 #define EFI_ACPI_2_0_DEBUG_PORT_TABLE_SIGNATURE 0x50474244\r
 \r
-//\r
-// "DSDT" Differentiated System Description Table\r
-//\r
+///\r
+/// "DSDT" Differentiated System Description Table\r
+///\r
 #define EFI_ACPI_2_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  0x54445344\r
 \r
-//\r
-// "ECDT" Embedded Controller Boot Resources Table\r
-//\r
+///\r
+/// "ECDT" Embedded Controller Boot Resources Table\r
+///\r
 #define EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_SIGNATURE 0x54444345\r
 \r
-//\r
-// "ETDT" Event Timer Description Table\r
-//\r
+///\r
+/// "ETDT" Event Timer Description Table\r
+///\r
 #define EFI_ACPI_2_0_EVENT_TIMER_DESCRIPTION_TABLE_SIGNATURE  0x54445445\r
 \r
-//\r
-// "FACS" Firmware ACPI Control Structure\r
-//\r
+///\r
+/// "FACS" Firmware ACPI Control Structure\r
+///\r
 #define EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE  0x53434146\r
 \r
-//\r
-// "FACP" Fixed ACPI Description Table\r
-//\r
+///\r
+/// "FACP" Fixed ACPI Description Table\r
+///\r
 #define EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE 0x50434146\r
 \r
-//\r
-// "APIC" Multiple APIC Description Table\r
-//\r
+///\r
+/// "APIC" Multiple APIC Description Table\r
+///\r
 #define EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE  0x43495041\r
 \r
-//\r
-// "PSDT" Persistent System Description Table\r
-//\r
+///\r
+/// "PSDT" Persistent System Description Table\r
+///\r
 #define EFI_ACPI_2_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  0x54445350\r
 \r
-//\r
-// "RSDT" Root System Description Table\r
-//\r
+///\r
+/// "RSDT" Root System Description Table\r
+///\r
 #define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  0x54445352\r
 \r
-//\r
-// "SBST" Smart Battery Specification Table\r
-//\r
+///\r
+/// "SBST" Smart Battery Specification Table\r
+///\r
 #define EFI_ACPI_2_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE  0x54534253\r
 \r
-//\r
-// "SLIT" System Locality Information Table\r
-//\r
+///\r
+/// "SLIT" System Locality Information Table\r
+///\r
 #define EFI_ACPI_2_0_SYSTEM_LOCALITY_INFORMATION_TABLE_SIGNATURE  0x54494C53\r
 \r
-//\r
-// "SPCR" Serial Port Concole Redirection Table\r
-//\r
+///\r
+/// "SPCR" Serial Port Concole Redirection Table\r
+///\r
 #define EFI_ACPI_2_0_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE  0x52435053\r
 \r
-//\r
-// "SRAT" Static Resource Affinity Table\r
-//\r
+///\r
+/// "SRAT" Static Resource Affinity Table\r
+///\r
 #define EFI_ACPI_2_0_STATIC_RESOURCE_AFFINITY_TABLE_SIGNATURE 0x54415253\r
 \r
-//\r
-// "SSDT" Secondary System Description Table\r
-//\r
+///\r
+/// "SSDT" Secondary System Description Table\r
+///\r
 #define EFI_ACPI_2_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445353\r
 \r
-//\r
-// "SPMI" Server Platform Management Interface Table\r
-//\r
+///\r
+/// "SPMI" Server Platform Management Interface Table\r
+///\r
 #define EFI_ACPI_2_0_SERVER_PLATFORM_MANAGEMENT_INTERFACE_SIGNATURE 0x494D5053\r
 \r
-//\r
-// "XSDT" Extended System Description Table\r
-//\r
+///\r
+/// "XSDT" Extended System Description Table\r
+///\r
 #define EFI_ACPI_2_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  0x54445358\r
 \r
+///\r
+/// "MCFG" Static Resource Affinity Table\r
+///\r
+#define EFI_ACPI_2_0_MEMORY_MAPPED_CONFIGURATION_BASE_ADDRESS_TABLE_SIGNATURE 0x4746434D\r
+\r
 #pragma pack()\r
 \r
 #endif\r