3 ACPI 3.0 definitions from the ACPI Specification Revision 3.0 September 2, 2004
5 Copyright (c) 2006 - 2008, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 #include <IndustryStandard/Acpi2_0.h>
21 // Ensure proper structure formats
25 // ACPI Specification Revision
27 #define EFI_ACPI_3_0_REVISION 0x03
30 // ACPI 3.0 Generic Address Space definition
34 UINT8 RegisterBitWidth
;
35 UINT8 RegisterBitOffset
;
38 } EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE
;
41 // Generic Address Space Address IDs
43 #define EFI_ACPI_3_0_SYSTEM_MEMORY 0
44 #define EFI_ACPI_3_0_SYSTEM_IO 1
45 #define EFI_ACPI_3_0_PCI_CONFIGURATION_SPACE 2
46 #define EFI_ACPI_3_0_EMBEDDED_CONTROLLER 3
47 #define EFI_ACPI_3_0_SMBUS 4
48 #define EFI_ACPI_3_0_FUNCTIONAL_FIXED_HARDWARE 0x7F
51 // Generic Address Space Access Sizes
53 #define EFI_ACPI_3_0_UNDEFINED 0
54 #define EFI_ACPI_3_0_BYTE 1
55 #define EFI_ACPI_3_0_WORD 2
56 #define EFI_ACPI_3_0_DWORD 3
57 #define EFI_ACPI_3_0_QWORD 4
60 // ACPI 3.0 table structures
63 // Root System Description Pointer Structure
73 UINT8 ExtendedChecksum
;
75 } EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
;
78 // RSD_PTR Revision (as defined in ACPI 3.0 spec.)
80 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02 // ACPISpec30 (Revision 3.0 September 2, 2004) says current value is 2
82 // Common table header, this prefaces all ACPI tables, including FACS, but
83 // excluding the RSD PTR structure
88 } EFI_ACPI_3_0_COMMON_HEADER
;
91 // Root System Description Table
92 // No definition needed as it is a common description table header followed by a
93 // variable number of UINT32 table pointers.
96 // RSDT Revision (as defined in ACPI 3.0 spec.)
98 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
101 // Extended System Description Table
102 // No definition needed as it is a common description table header followed by a
103 // variable number of UINT64 table pointers.
106 // XSDT Revision (as defined in ACPI 3.0 spec.)
108 #define EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
111 // Fixed ACPI Description Table Structure (FADT)
114 EFI_ACPI_DESCRIPTION_HEADER Header
;
118 UINT8 PreferredPmProfile
;
153 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE ResetReg
;
156 UINT64 XFirmwareCtrl
;
158 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk
;
159 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk
;
160 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk
;
161 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk
;
162 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk
;
163 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk
;
164 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XGpe0Blk
;
165 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XGpe1Blk
;
166 } EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE
;
169 // FADT Version (as defined in ACPI 3.0 spec.)
171 #define EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x04
174 // Fixed ACPI Description Table Preferred Power Management Profile
176 #define EFI_ACPI_3_0_PM_PROFILE_UNSPECIFIED 0
177 #define EFI_ACPI_3_0_PM_PROFILE_DESKTOP 1
178 #define EFI_ACPI_3_0_PM_PROFILE_MOBILE 2
179 #define EFI_ACPI_3_0_PM_PROFILE_WORKSTATION 3
180 #define EFI_ACPI_3_0_PM_PROFILE_ENTERPRISE_SERVER 4
181 #define EFI_ACPI_3_0_PM_PROFILE_SOHO_SERVER 5
182 #define EFI_ACPI_3_0_PM_PROFILE_APPLIANCE_PC 6
183 #define EFI_ACPI_3_0_PM_PROFILE_PERFORMANCE_SERVER 7
186 // Fixed ACPI Description Table Boot Architecture Flags
187 // All other bits are reserved and must be set to 0.
189 #define EFI_ACPI_3_0_LEGACY_DEVICES (1 << 0)
190 #define EFI_ACPI_3_0_8042 (1 << 1)
191 #define EFI_ACPI_3_0_VGA_NOT_PRESENT (1 << 2)
192 #define EFI_ACPI_3_0_MSI_NOT_SUPPORTED (1 << 3)
193 #define EFI_ACPI_3_0_PCIE_ASPM_CONTROLS (1 << 4)
196 // Fixed ACPI Description Table Fixed Feature Flags
197 // All other bits are reserved and must be set to 0.
199 #define EFI_ACPI_3_0_WBINVD (1 << 0)
200 #define EFI_ACPI_3_0_WBINVD_FLUSH (1 << 1)
201 #define EFI_ACPI_3_0_PROC_C1 (1 << 2)
202 #define EFI_ACPI_3_0_P_LVL2_UP (1 << 3)
203 #define EFI_ACPI_3_0_PWR_BUTTON (1 << 4)
204 #define EFI_ACPI_3_0_SLP_BUTTON (1 << 5)
205 #define EFI_ACPI_3_0_FIX_RTC (1 << 6)
206 #define EFI_ACPI_3_0_RTC_S4 (1 << 7)
207 #define EFI_ACPI_3_0_TMR_VAL_EXT (1 << 8)
208 #define EFI_ACPI_3_0_DCK_CAP (1 << 9)
209 #define EFI_ACPI_3_0_RESET_REG_SUP (1 << 10)
210 #define EFI_ACPI_3_0_SEALED_CASE (1 << 11)
211 #define EFI_ACPI_3_0_HEADLESS (1 << 12)
212 #define EFI_ACPI_3_0_CPU_SW_SLP (1 << 13)
213 #define EFI_ACPI_3_0_PCI_EXP_WAK (1 << 14)
214 #define EFI_ACPI_3_0_USE_PLATFORM_CLOCK (1 << 15)
215 #define EFI_ACPI_3_0_S4_RTC_STS_VALID (1 << 16)
216 #define EFI_ACPI_3_0_REMOTE_POWER_ON_CAPABLE (1 << 17)
217 #define EFI_ACPI_3_0_FORCE_APIC_CLUSTER_MODEL (1 << 18)
218 #define EFI_ACPI_3_0_FORCE_APIC_PHYSICAL_DESTINATION_MODE (1 << 19)
221 // Firmware ACPI Control Structure
226 UINT32 HardwareSignature
;
227 UINT32 FirmwareWakingVector
;
230 UINT64 XFirmwareWakingVector
;
233 } EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
;
236 // FACS Version (as defined in ACPI 3.0 spec.)
238 #define EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION 0x01
241 // Firmware Control Structure Feature Flags
242 // All other bits are reserved and must be set to 0.
244 #define EFI_ACPI_3_0_S4BIOS_F (1 << 0)
247 // Differentiated System Description Table,
248 // Secondary System Description Table
249 // and Persistent System Description Table,
250 // no definition needed as they are common description table header followed by a
253 #define EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
254 #define EFI_ACPI_3_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
257 // Multiple APIC Description Table header definition. The rest of the table
258 // must be defined in a platform specific manner.
261 EFI_ACPI_DESCRIPTION_HEADER Header
;
262 UINT32 LocalApicAddress
;
264 } EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER
;
267 // MADT Revision (as defined in ACPI 3.0 spec.)
269 #define EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x02
272 // Multiple APIC Flags
273 // All other bits are reserved and must be set to 0.
275 #define EFI_ACPI_3_0_PCAT_COMPAT (1 << 0)
278 // Multiple APIC Description Table APIC structure types
279 // All other values between 0x09 an 0xFF are reserved and
280 // will be ignored by OSPM.
282 #define EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC 0x00
283 #define EFI_ACPI_3_0_IO_APIC 0x01
284 #define EFI_ACPI_3_0_INTERRUPT_SOURCE_OVERRIDE 0x02
285 #define EFI_ACPI_3_0_NON_MASKABLE_INTERRUPT_SOURCE 0x03
286 #define EFI_ACPI_3_0_LOCAL_APIC_NMI 0x04
287 #define EFI_ACPI_3_0_LOCAL_APIC_ADDRESS_OVERRIDE 0x05
288 #define EFI_ACPI_3_0_IO_SAPIC 0x06
289 #define EFI_ACPI_3_0_LOCAL_SAPIC 0x07
290 #define EFI_ACPI_3_0_PLATFORM_INTERRUPT_SOURCES 0x08
293 // APIC Structure Definitions
296 // Processor Local APIC Structure Definition
301 UINT8 AcpiProcessorId
;
304 } EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_STRUCTURE
;
307 // Local APIC Flags. All other bits are reserved and must be 0.
309 #define EFI_ACPI_3_0_LOCAL_APIC_ENABLED (1 << 0)
319 UINT32 IoApicAddress
;
320 UINT32 GlobalSystemInterruptBase
;
321 } EFI_ACPI_3_0_IO_APIC_STRUCTURE
;
324 // Interrupt Source Override Structure
331 UINT32 GlobalSystemInterrupt
;
333 } EFI_ACPI_3_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE
;
336 // Platform Interrupt Sources Structure Definition
346 UINT32 GlobalSystemInterrupt
;
347 UINT32 PlatformInterruptSourceFlags
;
348 UINT8 CpeiProcessorOverride
;
350 } EFI_ACPI_3_0_PLATFORM_INTERRUPT_APIC_STRUCTURE
;
354 // All other bits are reserved and must be set to 0.
356 #define EFI_ACPI_3_0_POLARITY (3 << 0)
357 #define EFI_ACPI_3_0_TRIGGER_MODE (3 << 2)
360 // Non-Maskable Interrupt Source Structure
366 UINT32 GlobalSystemInterrupt
;
367 } EFI_ACPI_3_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE
;
370 // Local APIC NMI Structure
375 UINT8 AcpiProcessorId
;
378 } EFI_ACPI_3_0_LOCAL_APIC_NMI_STRUCTURE
;
381 // Local APIC Address Override Structure
387 UINT64 LocalApicAddress
;
388 } EFI_ACPI_3_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE
;
391 // IO SAPIC Structure
398 UINT32 GlobalSystemInterruptBase
;
399 UINT64 IoSapicAddress
;
400 } EFI_ACPI_3_0_IO_SAPIC_STRUCTURE
;
403 // Local SAPIC Structure
404 // This struct followed by a null-terminated ASCII string - ACPI Processor UID String
409 UINT8 AcpiProcessorId
;
414 UINT32 ACPIProcessorUIDValue
;
415 } EFI_ACPI_3_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE
;
418 // Platform Interrupt Sources Structure
428 UINT32 GlobalSystemInterrupt
;
429 UINT32 PlatformInterruptSourceFlags
;
430 } EFI_ACPI_3_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE
;
433 // Platform Interrupt Source Flags.
434 // All other bits are reserved and must be set to 0.
436 #define EFI_ACPI_3_0_CPEI_PROCESSOR_OVERRIDE (1 << 0)
439 // Smart Battery Description Table (SBST)
442 EFI_ACPI_DESCRIPTION_HEADER Header
;
443 UINT32 WarningEnergyLevel
;
444 UINT32 LowEnergyLevel
;
445 UINT32 CriticalEnergyLevel
;
446 } EFI_ACPI_3_0_SMART_BATTERY_DESCRIPTION_TABLE
;
449 // SBST Version (as defined in ACPI 3.0 spec.)
451 #define EFI_ACPI_3_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01
454 // Embedded Controller Boot Resources Table (ECDT)
455 // The table is followed by a null terminated ASCII string that contains
456 // a fully qualified reference to the name space object.
459 EFI_ACPI_DESCRIPTION_HEADER Header
;
460 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE EcControl
;
461 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE EcData
;
464 } EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE
;
467 // ECDT Version (as defined in ACPI 3.0 spec.)
469 #define EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_REVISION 0x01
472 // System Resource Affinity Table (SRAT. The rest of the table
473 // must be defined in a platform specific manner.
476 EFI_ACPI_DESCRIPTION_HEADER Header
;
477 UINT32 Reserved1
; // Must be set to 1
479 } EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_HEADER
;
482 // SRAT Version (as defined in ACPI 3.0 spec.)
484 #define EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_REVISION 0x02
487 // SRAT structure types.
488 // All other values between 0x02 an 0xFF are reserved and
489 // will be ignored by OSPM.
491 #define EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY 0x00
492 #define EFI_ACPI_3_0_MEMORY_AFFINITY 0x01
495 // Processor Local APIC/SAPIC Affinity Structure Definition
500 UINT8 ProximityDomain7To0
;
504 UINT8 ProximityDomain31To8
[3];
506 } EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY_STRUCTURE
;
509 // Local APIC/SAPIC Flags. All other bits are reserved and must be 0.
511 #define EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_ENABLED (1 << 0)
514 // Memory Affinity Structure Definition
519 UINT32 ProximityDomain
;
521 UINT32 AddressBaseLow
;
522 UINT32 AddressBaseHigh
;
528 } EFI_ACPI_3_0_MEMORY_AFFINITY_STRUCTURE
;
531 // Memory Flags. All other bits are reserved and must be 0.
533 #define EFI_ACPI_3_0_MEMORY_ENABLED (1 << 0)
534 #define EFI_ACPI_3_0_MEMORY_HOT_PLUGGABLE (1 << 1)
535 #define EFI_ACPI_3_0_MEMORY_NONVOLATILE (1 << 2)
538 // System Locality Distance Information Table (SLIT).
539 // The rest of the table is a matrix.
542 EFI_ACPI_DESCRIPTION_HEADER Header
;
543 UINT64 NumberOfSystemLocalities
;
544 } EFI_ACPI_3_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_HEADER
;
547 // SLIT Version (as defined in ACPI 3.0 spec.)
549 #define EFI_ACPI_3_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_REVISION 0x01
552 // Known table signatures
555 // "RSD PTR " Root System Description Pointer
557 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE 0x2052545020445352ULL
560 // "APIC" Multiple APIC Description Table
562 #define EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE 0x43495041
565 // "DSDT" Differentiated System Description Table
567 #define EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445344
570 // "ECDT" Embedded Controller Boot Resources Table
572 #define EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_SIGNATURE 0x54444345
575 // "FACP" Fixed ACPI Description Table
577 #define EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE 0x50434146
580 // "FACS" Firmware ACPI Control Structure
582 #define EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE 0x53434146
585 // "PSDT" Persistent System Description Table
587 #define EFI_ACPI_3_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445350
590 // "RSDT" Root System Description Table
592 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445352
595 // "SBST" Smart Battery Specification Table
597 #define EFI_ACPI_3_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE 0x54534253
600 // "SLIT" System Locality Information Table
602 #define EFI_ACPI_3_0_SYSTEM_LOCALITY_INFORMATION_TABLE_SIGNATURE 0x54494C53
605 // "SRAT" System Resource Affinity Table
607 #define EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_SIGNATURE 0x54415253
610 // "SSDT" Secondary System Description Table
612 #define EFI_ACPI_3_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445353
615 // "XSDT" Extended System Description Table
617 #define EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445358
620 // "BOOT" MS Simple Boot Spec
622 #define EFI_ACPI_3_0_SIMPLE_BOOT_FLAG_TABLE_SIGNATURE 0x544F4F42
625 // "CPEP" Corrected Platform Error Polling Table
628 #define EFI_ACPI_3_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_SIGNATURE 0x50455043
631 // "DBGP" MS Debug Port Spec
633 #define EFI_ACPI_3_0_DEBUG_PORT_TABLE_SIGNATURE 0x50474244
636 // "ETDT" Event Timer Description Table
638 #define EFI_ACPI_3_0_EVENT_TIMER_DESCRIPTION_TABLE_SIGNATURE 0x54445445
641 // "HPET" IA-PC High Precision Event Timer Table
643 #define EFI_ACPI_3_0_HIGH_PRECISION_EVENT_TIMER_TABLE_SIGNATURE 0x54455048
646 // "MCFG" PCI Express Memory Mapped Configuration Space Base Address Description Table
648 #define EFI_ACPI_3_0_PCI_EXPRESS_MEMORY_MAPPED_CONFIGURATION_SPACE_BASE_ADDRESS_DESCRIPTION_TABLE_SIGNATURE 0x4746434D
651 // "SPCR" Serial Port Concole Redirection Table
653 #define EFI_ACPI_3_0_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE 0x52435053
656 // "SPMI" Server Platform Management Interface Table
658 #define EFI_ACPI_3_0_SERVER_PLATFORM_MANAGEMENT_INTERFACE_TABLE_SIGNATURE 0x494D5053
661 // "TCPA" Trusted Computing Platform Alliance Capabilities Table
663 #define EFI_ACPI_3_0_TRUSTED_COMPUTING_PLATFORM_ALLIANCE_CAPABILITIES_TABLE_SIGNATURE 0x41504354
666 // "WDRT" Watchdog Resource Table
668 #define EFI_ACPI_3_0_WATCHDOG_RESOURCE_TABLE_SIGNATURE 0x54524457
671 // "WDAT" Watchdog Action Table
673 #define EFI_ACPI_3_0_WATCHDOG_ACTION_TABLE_SIGNATURE 0x54414457
676 // "iBFT" iSCSI Boot Firmware Table
678 #define EFI_ACPI_3_0_ISCSI_BOOT_FIRMWARE_TABLE_SIGNATURE 0x54464269