]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/IndustryStandard/Acpi30.h
MdePkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / MdePkg / Include / IndustryStandard / Acpi30.h
index 83296e23dde41325de04c7a3fbb428433997a09a..0fc947e745f4be9baedfbdd79f0042f47130b3cd 100644 (file)
@@ -1,20 +1,56 @@
-/** @file   \r
+/** @file\r
   ACPI 3.0 definitions from the ACPI Specification Revision 3.0b October 10, 2006\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials                          \r
-  are licensed and made available under the terms and conditions of the BSD License         \r
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 **/\r
 \r
 #ifndef _ACPI_3_0_H_\r
 #define _ACPI_3_0_H_\r
 \r
-#include <IndustryStandard/Acpi2_0.h>\r
+#include <IndustryStandard/Acpi20.h>\r
+\r
+//\r
+// Define for Desriptor\r
+//\r
+#define ACPI_LARGE_EXTENDED_ADDRESS_SPACE_DESCRIPTOR_NAME    0x0B\r
+\r
+#define ACPI_EXTENDED_ADDRESS_SPACE_DESCRIPTOR    0x8B\r
+\r
+//\r
+// Ensure proper structure formats\r
+//\r
+#pragma pack(1)\r
+\r
+///\r
+/// Extended Address Space Descriptor\r
+///\r
+typedef PACKED struct {\r
+  ACPI_LARGE_RESOURCE_HEADER    Header;\r
+  UINT8                         ResType;\r
+  UINT8                         GenFlag;\r
+  UINT8                         SpecificFlag;\r
+  UINT8                         RevisionId;\r
+  UINT8                         Reserved;\r
+  UINT64                        AddrSpaceGranularity;\r
+  UINT64                        AddrRangeMin;\r
+  UINT64                        AddrRangeMax;\r
+  UINT64                        AddrTranslationOffset;\r
+  UINT64                        AddrLen;\r
+  UINT64                        TypeSpecificAttribute;\r
+} EFI_ACPI_EXTENDED_ADDRESS_SPACE_DESCRIPTOR;\r
+\r
+#pragma pack()\r
+\r
+//\r
+// Memory Type Specific Flags\r
+//\r
+#define EFI_ACPI_MEMORY_TYPE_SPECIFIC_ATTRIBUTES_UC  0x0000000000000001\r
+#define EFI_ACPI_MEMORY_TYPE_SPECIFIC_ATTRIBUTES_WC  0x0000000000000002\r
+#define EFI_ACPI_MEMORY_TYPE_SPECIFIC_ATTRIBUTES_WT  0x0000000000000004\r
+#define EFI_ACPI_MEMORY_TYPE_SPECIFIC_ATTRIBUTES_WB  0x0000000000000008\r
+#define EFI_ACPI_MEMORY_TYPE_SPECIFIC_ATTRIBUTES_UCE 0x0000000000000010\r
+#define EFI_ACPI_MEMORY_TYPE_SPECIFIC_ATTRIBUTES_NV  0x0000000000008000\r
 \r
 //\r
 // Ensure proper structure formats\r
@@ -86,7 +122,7 @@ typedef struct {
 \r
 //\r
 // Root System Description Table\r
-// No definition needed as it is a common description table header, the same with \r
+// No definition needed as it is a common description table header, the same with\r
 // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT32 table pointers.\r
 //\r
 \r
@@ -97,7 +133,7 @@ typedef struct {
 \r
 //\r
 // Extended System Description Table\r
-// No definition needed as it is a common description table header, the same with \r
+// No definition needed as it is a common description table header, the same with\r
 // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT64 table pointers.\r
 //\r
 \r
@@ -185,36 +221,36 @@ typedef struct {
 // Fixed ACPI Description Table Boot Architecture Flags\r
 // All other bits are reserved and must be set to 0.\r
 //\r
-#define EFI_ACPI_3_0_LEGACY_DEVICES     (1 << 0)\r
-#define EFI_ACPI_3_0_8042               (1 << 1)\r
-#define EFI_ACPI_3_0_VGA_NOT_PRESENT    (1 << 2)\r
-#define EFI_ACPI_3_0_MSI_NOT_SUPPORTED  (1 << 3)\r
-#define EFI_ACPI_3_0_PCIE_ASPM_CONTROLS (1 << 4)\r
+#define EFI_ACPI_3_0_LEGACY_DEVICES              BIT0\r
+#define EFI_ACPI_3_0_8042                        BIT1\r
+#define EFI_ACPI_3_0_VGA_NOT_PRESENT             BIT2\r
+#define EFI_ACPI_3_0_MSI_NOT_SUPPORTED           BIT3\r
+#define EFI_ACPI_3_0_PCIE_ASPM_CONTROLS          BIT4\r
 \r
 //\r
 // Fixed ACPI Description Table Fixed Feature Flags\r
 // All other bits are reserved and must be set to 0.\r
 //\r
-#define EFI_ACPI_3_0_WBINVD                   (1 << 0)\r
-#define EFI_ACPI_3_0_WBINVD_FLUSH             (1 << 1)\r
-#define EFI_ACPI_3_0_PROC_C1                  (1 << 2)\r
-#define EFI_ACPI_3_0_P_LVL2_UP                (1 << 3)\r
-#define EFI_ACPI_3_0_PWR_BUTTON               (1 << 4)\r
-#define EFI_ACPI_3_0_SLP_BUTTON               (1 << 5)\r
-#define EFI_ACPI_3_0_FIX_RTC                  (1 << 6)\r
-#define EFI_ACPI_3_0_RTC_S4                   (1 << 7)\r
-#define EFI_ACPI_3_0_TMR_VAL_EXT              (1 << 8)\r
-#define EFI_ACPI_3_0_DCK_CAP                  (1 << 9)\r
-#define EFI_ACPI_3_0_RESET_REG_SUP            (1 << 10)\r
-#define EFI_ACPI_3_0_SEALED_CASE              (1 << 11)\r
-#define EFI_ACPI_3_0_HEADLESS                 (1 << 12)\r
-#define EFI_ACPI_3_0_CPU_SW_SLP               (1 << 13)\r
-#define EFI_ACPI_3_0_PCI_EXP_WAK              (1 << 14)\r
-#define EFI_ACPI_3_0_USE_PLATFORM_CLOCK       (1 << 15)\r
-#define EFI_ACPI_3_0_S4_RTC_STS_VALID         (1 << 16)\r
-#define EFI_ACPI_3_0_REMOTE_POWER_ON_CAPABLE  (1 << 17)\r
-#define EFI_ACPI_3_0_FORCE_APIC_CLUSTER_MODEL (1 << 18)\r
-#define EFI_ACPI_3_0_FORCE_APIC_PHYSICAL_DESTINATION_MODE (1 << 19)\r
+#define EFI_ACPI_3_0_WBINVD                                 BIT0\r
+#define EFI_ACPI_3_0_WBINVD_FLUSH                           BIT1\r
+#define EFI_ACPI_3_0_PROC_C1                                BIT2\r
+#define EFI_ACPI_3_0_P_LVL2_UP                              BIT3\r
+#define EFI_ACPI_3_0_PWR_BUTTON                             BIT4\r
+#define EFI_ACPI_3_0_SLP_BUTTON                             BIT5\r
+#define EFI_ACPI_3_0_FIX_RTC                                BIT6\r
+#define EFI_ACPI_3_0_RTC_S4                                 BIT7\r
+#define EFI_ACPI_3_0_TMR_VAL_EXT                            BIT8\r
+#define EFI_ACPI_3_0_DCK_CAP                                BIT9\r
+#define EFI_ACPI_3_0_RESET_REG_SUP                          BIT10\r
+#define EFI_ACPI_3_0_SEALED_CASE                            BIT11\r
+#define EFI_ACPI_3_0_HEADLESS                               BIT12\r
+#define EFI_ACPI_3_0_CPU_SW_SLP                             BIT13\r
+#define EFI_ACPI_3_0_PCI_EXP_WAK                            BIT14\r
+#define EFI_ACPI_3_0_USE_PLATFORM_CLOCK                     BIT15\r
+#define EFI_ACPI_3_0_S4_RTC_STS_VALID                       BIT16\r
+#define EFI_ACPI_3_0_REMOTE_POWER_ON_CAPABLE                BIT17\r
+#define EFI_ACPI_3_0_FORCE_APIC_CLUSTER_MODEL               BIT18\r
+#define EFI_ACPI_3_0_FORCE_APIC_PHYSICAL_DESTINATION_MODE   BIT19\r
 \r
 ///\r
 /// Firmware ACPI Control Structure\r
@@ -240,7 +276,7 @@ typedef struct {
 /// Firmware Control Structure Feature Flags\r
 /// All other bits are reserved and must be set to 0.\r
 ///\r
-#define EFI_ACPI_3_0_S4BIOS_F (1 << 0)\r
+#define EFI_ACPI_3_0_S4BIOS_F       BIT0\r
 \r
 //\r
 // Differentiated System Description Table,\r
@@ -271,7 +307,7 @@ typedef struct {
 /// Multiple APIC Flags\r
 /// All other bits are reserved and must be set to 0.\r
 ///\r
-#define EFI_ACPI_3_0_PCAT_COMPAT  (1 << 0)\r
+#define EFI_ACPI_3_0_PCAT_COMPAT         BIT0\r
 \r
 //\r
 // Multiple APIC Description Table APIC structure types\r
@@ -306,7 +342,7 @@ typedef struct {
 ///\r
 /// Local APIC Flags.  All other bits are reserved and must be 0.\r
 ///\r
-#define EFI_ACPI_3_0_LOCAL_APIC_ENABLED (1 << 0)\r
+#define EFI_ACPI_3_0_LOCAL_APIC_ENABLED        BIT0\r
 \r
 ///\r
 /// IO APIC Structure\r
@@ -433,7 +469,7 @@ typedef struct {
 /// Platform Interrupt Source Flags.\r
 /// All other bits are reserved and must be set to 0.\r
 ///\r
-#define EFI_ACPI_3_0_CPEI_PROCESSOR_OVERRIDE     (1 << 0)\r
+#define EFI_ACPI_3_0_CPEI_PROCESSOR_OVERRIDE          BIT0\r
 \r
 ///\r
 /// Smart Battery Description Table (SBST)\r
@@ -474,7 +510,7 @@ typedef struct {
 ///\r
 typedef struct {\r
   EFI_ACPI_DESCRIPTION_HEADER Header;\r
-  UINT32                      Reserved1;  // Must be set to 1\r
+  UINT32                      Reserved1;  ///< Must be set to 1\r
   UINT64                      Reserved2;\r
 } EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_HEADER;\r
 \r
@@ -483,11 +519,11 @@ typedef struct {
 ///\r
 #define EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_REVISION  0x02\r
 \r
-///\r
-/// SRAT structure types.\r
-/// All other values between 0x02 an 0xFF are reserved and\r
-/// will be ignored by OSPM.\r
-///\r
+//\r
+// SRAT structure types.\r
+// All other values between 0x02 an 0xFF are reserved and\r
+// will be ignored by OSPM.\r
+//\r
 #define EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY  0x00\r
 #define EFI_ACPI_3_0_MEMORY_AFFINITY                      0x01\r
 \r
@@ -555,128 +591,132 @@ typedef struct {
 ///\r
 /// "RSD PTR " Root System Description Pointer\r
 ///\r
-#define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE  0x2052545020445352ULL\r
+#define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE  SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ')\r
 \r
 ///\r
 /// "APIC" Multiple APIC Description Table\r
 ///\r
-#define EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE  0x43495041\r
+#define EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE  SIGNATURE_32('A', 'P', 'I', 'C')\r
 \r
 ///\r
 /// "DSDT" Differentiated System Description Table\r
 ///\r
-#define EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  0x54445344\r
+#define EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  SIGNATURE_32('D', 'S', 'D', 'T')\r
 \r
 ///\r
 /// "ECDT" Embedded Controller Boot Resources Table\r
 ///\r
-#define EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_SIGNATURE 0x54444345\r
+#define EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_SIGNATURE  SIGNATURE_32('E', 'C', 'D', 'T')\r
 \r
 ///\r
 /// "FACP" Fixed ACPI Description Table\r
 ///\r
-#define EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE 0x50434146\r
+#define EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE  SIGNATURE_32('F', 'A', 'C', 'P')\r
 \r
 ///\r
 /// "FACS" Firmware ACPI Control Structure\r
 ///\r
-#define EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE  0x53434146\r
+#define EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE  SIGNATURE_32('F', 'A', 'C', 'S')\r
 \r
 ///\r
 /// "PSDT" Persistent System Description Table\r
 ///\r
-#define EFI_ACPI_3_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  0x54445350\r
+#define EFI_ACPI_3_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  SIGNATURE_32('P', 'S', 'D', 'T')\r
 \r
 ///\r
 /// "RSDT" Root System Description Table\r
 ///\r
-#define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  0x54445352\r
+#define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  SIGNATURE_32('R', 'S', 'D', 'T')\r
 \r
 ///\r
 /// "SBST" Smart Battery Specification Table\r
 ///\r
-#define EFI_ACPI_3_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE  0x54534253\r
+#define EFI_ACPI_3_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE  SIGNATURE_32('S', 'B', 'S', 'T')\r
 \r
 ///\r
 /// "SLIT" System Locality Information Table\r
 ///\r
-#define EFI_ACPI_3_0_SYSTEM_LOCALITY_INFORMATION_TABLE_SIGNATURE  0x54494C53\r
+#define EFI_ACPI_3_0_SYSTEM_LOCALITY_INFORMATION_TABLE_SIGNATURE  SIGNATURE_32('S', 'L', 'I', 'T')\r
 \r
 ///\r
 /// "SRAT" System Resource Affinity Table\r
 ///\r
-#define EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_SIGNATURE 0x54415253\r
+#define EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_SIGNATURE  SIGNATURE_32('S', 'R', 'A', 'T')\r
 \r
 ///\r
 /// "SSDT" Secondary System Description Table\r
 ///\r
-#define EFI_ACPI_3_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445353\r
+#define EFI_ACPI_3_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  SIGNATURE_32('S', 'S', 'D', 'T')\r
 \r
 ///\r
 /// "XSDT" Extended System Description Table\r
 ///\r
-#define EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  0x54445358\r
+#define EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  SIGNATURE_32('X', 'S', 'D', 'T')\r
 \r
 ///\r
 /// "BOOT" MS Simple Boot Spec\r
 ///\r
-#define EFI_ACPI_3_0_SIMPLE_BOOT_FLAG_TABLE_SIGNATURE 0x544F4F42\r
+#define EFI_ACPI_3_0_SIMPLE_BOOT_FLAG_TABLE_SIGNATURE  SIGNATURE_32('B', 'O', 'O', 'T')\r
 \r
 ///\r
 /// "CPEP" Corrected Platform Error Polling Table\r
-/// See\r
 ///\r
-#define EFI_ACPI_3_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_SIGNATURE 0x50455043\r
+#define EFI_ACPI_3_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_SIGNATURE  SIGNATURE_32('C', 'P', 'E', 'P')\r
 \r
 ///\r
 /// "DBGP" MS Debug Port Spec\r
 ///\r
-#define EFI_ACPI_3_0_DEBUG_PORT_TABLE_SIGNATURE 0x50474244\r
+#define EFI_ACPI_3_0_DEBUG_PORT_TABLE_SIGNATURE  SIGNATURE_32('D', 'B', 'G', 'P')\r
 \r
 ///\r
 /// "ETDT" Event Timer Description Table\r
 ///\r
-#define EFI_ACPI_3_0_EVENT_TIMER_DESCRIPTION_TABLE_SIGNATURE  0x54445445\r
+#define EFI_ACPI_3_0_EVENT_TIMER_DESCRIPTION_TABLE_SIGNATURE  SIGNATURE_32('E', 'T', 'D', 'T')\r
 \r
 ///\r
 /// "HPET" IA-PC High Precision Event Timer Table\r
 ///\r
-#define EFI_ACPI_3_0_HIGH_PRECISION_EVENT_TIMER_TABLE_SIGNATURE 0x54455048\r
+#define EFI_ACPI_3_0_HIGH_PRECISION_EVENT_TIMER_TABLE_SIGNATURE  SIGNATURE_32('H', 'P', 'E', 'T')\r
 \r
 ///\r
 /// "MCFG" PCI Express Memory Mapped Configuration Space Base Address Description Table\r
 ///\r
-#define EFI_ACPI_3_0_PCI_EXPRESS_MEMORY_MAPPED_CONFIGURATION_SPACE_BASE_ADDRESS_DESCRIPTION_TABLE_SIGNATURE  0x4746434D\r
+#define EFI_ACPI_3_0_PCI_EXPRESS_MEMORY_MAPPED_CONFIGURATION_SPACE_BASE_ADDRESS_DESCRIPTION_TABLE_SIGNATURE  SIGNATURE_32('M', 'C', 'F', 'G')\r
 \r
 ///\r
 /// "SPCR" Serial Port Concole Redirection Table\r
 ///\r
-#define EFI_ACPI_3_0_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE  0x52435053\r
+#define EFI_ACPI_3_0_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE  SIGNATURE_32('S', 'P', 'C', 'R')\r
 \r
 ///\r
 /// "SPMI" Server Platform Management Interface Table\r
 ///\r
-#define EFI_ACPI_3_0_SERVER_PLATFORM_MANAGEMENT_INTERFACE_TABLE_SIGNATURE 0x494D5053\r
+#define EFI_ACPI_3_0_SERVER_PLATFORM_MANAGEMENT_INTERFACE_TABLE_SIGNATURE  SIGNATURE_32('S', 'P', 'M', 'I')\r
 \r
 ///\r
 /// "TCPA" Trusted Computing Platform Alliance Capabilities Table\r
 ///\r
-#define EFI_ACPI_3_0_TRUSTED_COMPUTING_PLATFORM_ALLIANCE_CAPABILITIES_TABLE_SIGNATURE 0x41504354\r
+#define EFI_ACPI_3_0_TRUSTED_COMPUTING_PLATFORM_ALLIANCE_CAPABILITIES_TABLE_SIGNATURE  SIGNATURE_32('T', 'C', 'P', 'A')\r
 \r
 ///\r
 /// "WDRT" Watchdog Resource Table\r
 ///\r
-#define EFI_ACPI_3_0_WATCHDOG_RESOURCE_TABLE_SIGNATURE 0x54524457\r
+#define EFI_ACPI_3_0_WATCHDOG_RESOURCE_TABLE_SIGNATURE  SIGNATURE_32('W', 'D', 'R', 'T')\r
 \r
 ///\r
 /// "WDAT" Watchdog Action Table\r
 ///\r
-#define EFI_ACPI_3_0_WATCHDOG_ACTION_TABLE_SIGNATURE 0x54414457\r
+#define EFI_ACPI_3_0_WATCHDOG_ACTION_TABLE_SIGNATURE  SIGNATURE_32('W', 'D', 'A', 'T')\r
+\r
+///\r
+/// "WSPT" Windows Specific Properties Table\r
+///\r
+#define EFI_ACPI_3_0_WINDOWS_SPECIFIC_PROPERTIES_TABLE_SIGNATURE  SIGNATURE_32('W', 'S', 'P', 'T')\r
 \r
 ///\r
 /// "iBFT" iSCSI Boot Firmware Table\r
 ///\r
-#define EFI_ACPI_3_0_ISCSI_BOOT_FIRMWARE_TABLE_SIGNATURE 0x54464269\r
+#define EFI_ACPI_3_0_ISCSI_BOOT_FIRMWARE_TABLE_SIGNATURE  SIGNATURE_32('i', 'B', 'F', 'T')\r
 \r
 #pragma pack()\r
 \r