2 ACPI 3.0 definitions from the ACPI Specification Revision 3.0 September 2, 2004
4 Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials are licensed and made available
7 under the terms and conditions of the BSD License which accompanies this
8 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.
19 #include "IndustryStandard/Acpi.h"
22 // Ensure proper structure formats
26 // ACPI Specification Revision
28 #define EFI_ACPI_3_0_REVISION 0x03 // BUGBUG: Not in spec yet.
30 // BUGBUG: OEM values need to be moved somewhere else, probably read from data hub
31 // and produced by a platform specific driver.
34 // ACPI 3.0 Generic Address Space definition
38 UINT8 RegisterBitWidth
;
39 UINT8 RegisterBitOffset
;
42 } EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE
;
45 // Generic Address Space Address IDs
47 #define EFI_ACPI_3_0_SYSTEM_MEMORY 0
48 #define EFI_ACPI_3_0_SYSTEM_IO 1
49 #define EFI_ACPI_3_0_PCI_CONFIGURATION_SPACE 2
50 #define EFI_ACPI_3_0_EMBEDDED_CONTROLLER 3
51 #define EFI_ACPI_3_0_SMBUS 4
52 #define EFI_ACPI_3_0_FUNCTIONAL_FIXED_HARDWARE 0x7F
55 // Generic Address Space Access Sizes
57 #define EFI_ACPI_3_0_UNDEFINED 0
58 #define EFI_ACPI_3_0_BYTE 1
59 #define EFI_ACPI_3_0_WORD 2
60 #define EFI_ACPI_3_0_DWORD 3
61 #define EFI_ACPI_3_0_QWORD 4
64 // ACPI 3.0 table structures
67 // Root System Description Pointer Structure
77 UINT8 ExtendedChecksum
;
79 } EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
;
82 // RSD_PTR Revision (as defined in ACPI 3.0 spec.)
84 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02 // ACPISpec30 (Revision 3.0 September 2, 2004) says current value is 2
86 // Common table header, this prefaces all ACPI tables, including FACS, but
87 // excluding the RSD PTR structure
92 } EFI_ACPI_3_0_COMMON_HEADER
;
95 // Root System Description Table
96 // No definition needed as it is a common description table header followed by a
97 // variable number of UINT32 table pointers.
100 // RSDT Revision (as defined in ACPI 3.0 spec.)
102 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
105 // Extended System Description Table
106 // No definition needed as it is a common description table header followed by a
107 // variable number of UINT64 table pointers.
110 // XSDT Revision (as defined in ACPI 3.0 spec.)
112 #define EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
115 // Fixed ACPI Description Table Structure (FADT)
118 EFI_ACPI_DESCRIPTION_HEADER Header
;
122 UINT8 PreferredPmProfile
;
157 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE ResetReg
;
160 UINT64 XFirmwareCtrl
;
162 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk
;
163 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk
;
164 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk
;
165 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk
;
166 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk
;
167 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk
;
168 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XGpe0Blk
;
169 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XGpe1Blk
;
170 } EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE
;
173 // FADT Version (as defined in ACPI 3.0 spec.)
175 #define EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x04
178 // Fixed ACPI Description Table Preferred Power Management Profile
180 #define EFI_ACPI_3_0_PM_PROFILE_UNSPECIFIED 0
181 #define EFI_ACPI_3_0_PM_PROFILE_DESKTOP 1
182 #define EFI_ACPI_3_0_PM_PROFILE_MOBILE 2
183 #define EFI_ACPI_3_0_PM_PROFILE_WORKSTATION 3
184 #define EFI_ACPI_3_0_PM_PROFILE_ENTERPRISE_SERVER 4
185 #define EFI_ACPI_3_0_PM_PROFILE_SOHO_SERVER 5
186 #define EFI_ACPI_3_0_PM_PROFILE_APPLIANCE_PC 6
187 #define EFI_ACPI_3_0_PM_PROFILE_PERFORMANCE_SERVER 7
190 // Fixed ACPI Description Table Boot Architecture Flags
191 // All other bits are reserved and must be set to 0.
193 #define EFI_ACPI_3_0_LEGACY_DEVICES (1 << 0)
194 #define EFI_ACPI_3_0_8042 (1 << 1)
195 #define EFI_ACPI_3_0_VGA_NOT_PRESENT (1 << 2)
196 #define EFI_ACPI_3_0_MSI_NOT_SUPPORTED (1 << 3)
198 // Fixed ACPI Description Table Fixed Feature Flags
199 // All other bits are reserved and must be set to 0.
201 #define EFI_ACPI_3_0_WBINVD (1 << 0)
202 #define EFI_ACPI_3_0_WBINVD_FLUSH (1 << 1)
203 #define EFI_ACPI_3_0_PROC_C1 (1 << 2)
204 #define EFI_ACPI_3_0_P_LVL2_UP (1 << 3)
205 #define EFI_ACPI_3_0_PWR_BUTTON (1 << 4)
206 #define EFI_ACPI_3_0_SLP_BUTTON (1 << 5)
207 #define EFI_ACPI_3_0_FIX_RTC (1 << 6)
208 #define EFI_ACPI_3_0_RTC_S4 (1 << 7)
209 #define EFI_ACPI_3_0_TMR_VAL_EXT (1 << 8)
210 #define EFI_ACPI_3_0_DCK_CAP (1 << 9)
211 #define EFI_ACPI_3_0_RESET_REG_SUP (1 << 10)
212 #define EFI_ACPI_3_0_SEALED_CASE (1 << 11)
213 #define EFI_ACPI_3_0_HEADLESS (1 << 12)
214 #define EFI_ACPI_3_0_CPU_SW_SLP (1 << 13)
215 #define EFI_ACPI_3_0_PCI_EXP_WAK (1 << 14)
216 #define EFI_ACPI_3_0_USE_PLATFORM_CLOCK (1 << 15)
217 #define EFI_ACPI_3_0_S4_RTC_STS_VALID (1 << 16)
218 #define EFI_ACPI_3_0_REMOTE_POWER_ON_CAPABLE (1 << 17)
219 #define EFI_ACPI_3_0_FORCE_APIC_CLUSTER_MODEL (1 << 18)
220 #define EFI_ACPI_3_0_FORCE_APIC_PHYSICAL_DESTINATION_MODE (1 << 19)
223 // Firmware ACPI Control Structure
228 UINT32 HardwareSignature
;
229 UINT32 FirmwareWakingVector
;
232 UINT64 XFirmwareWakingVector
;
235 } EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
;
238 // FACS Version (as defined in ACPI 3.0 spec.)
240 #define EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION 0x01
243 // Firmware Control Structure Feature Flags
244 // All other bits are reserved and must be set to 0.
246 #define EFI_ACPI_3_0_S4BIOS_F (1 << 0)
249 // Differentiated System Description Table,
250 // Secondary System Description Table
251 // and Persistent System Description Table,
252 // no definition needed as they are common description table header followed by a
255 #define EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
256 #define EFI_ACPI_3_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
259 // Multiple APIC Description Table header definition. The rest of the table
260 // must be defined in a platform specific manner.
263 EFI_ACPI_DESCRIPTION_HEADER Header
;
264 UINT32 LocalApicAddress
;
266 } EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER
;
269 // MADT Revision (as defined in ACPI 3.0 spec.)
271 #define EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x02
274 // Multiple APIC Flags
275 // All other bits are reserved and must be set to 0.
277 #define EFI_ACPI_3_0_PCAT_COMPAT (1 << 0)
280 // Multiple APIC Description Table APIC structure types
281 // All other values between 0x09 an 0xFF are reserved and
282 // will be ignored by OSPM.
284 #define EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC 0x00
285 #define EFI_ACPI_3_0_IO_APIC 0x01
286 #define EFI_ACPI_3_0_INTERRUPT_SOURCE_OVERRIDE 0x02
287 #define EFI_ACPI_3_0_NON_MASKABLE_INTERRUPT_SOURCE 0x03
288 #define EFI_ACPI_3_0_LOCAL_APIC_NMI 0x04
289 #define EFI_ACPI_3_0_LOCAL_APIC_ADDRESS_OVERRIDE 0x05
290 #define EFI_ACPI_3_0_IO_SAPIC 0x06
291 #define EFI_ACPI_3_0_LOCAL_SAPIC 0x07
292 #define EFI_ACPI_3_0_PLATFORM_INTERRUPT_SOURCES 0x08
295 // APIC Structure Definitions
298 // Processor Local APIC Structure Definition
303 UINT8 AcpiProcessorId
;
306 } EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_STRUCTURE
;
309 // Local APIC Flags. All other bits are reserved and must be 0.
311 #define EFI_ACPI_3_0_LOCAL_APIC_ENABLED (1 << 0)
321 UINT32 IoApicAddress
;
322 UINT32 GlobalSystemInterruptBase
;
323 } EFI_ACPI_3_0_IO_APIC_STRUCTURE
;
326 // Interrupt Source Override Structure
333 UINT32 GlobalSystemInterrupt
;
335 } EFI_ACPI_3_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE
;
338 // Platform Interrupt Sources Structure Definition
348 UINT32 GlobalSystemInterrupt
;
349 UINT32 PlatformInterruptSourceFlags
;
350 UINT8 CpeiProcessorOverride
;
352 } EFI_ACPI_3_0_PLATFORM_INTERRUPT_APIC_STRUCTURE
;
356 // All other bits are reserved and must be set to 0.
358 #define EFI_ACPI_3_0_POLARITY (3 << 0)
359 #define EFI_ACPI_3_0_TRIGGER_MODE (3 << 2)
362 // Non-Maskable Interrupt Source Structure
368 UINT32 GlobalSystemInterrupt
;
369 } EFI_ACPI_3_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE
;
372 // Local APIC NMI Structure
377 UINT8 AcpiProcessorId
;
380 } EFI_ACPI_3_0_LOCAL_APIC_NMI_STRUCTURE
;
383 // Local APIC Address Override Structure
389 UINT64 LocalApicAddress
;
390 } EFI_ACPI_3_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE
;
393 // IO SAPIC Structure
400 UINT32 GlobalSystemInterruptBase
;
401 UINT64 IoSapicAddress
;
402 } EFI_ACPI_3_0_IO_SAPIC_STRUCTURE
;
405 // Local SAPIC Structure
406 // This struct followed by a null-terminated ASCII string - ACPI Processor UID String
411 UINT8 AcpiProcessorId
;
416 UINT32 ACPIProcessorUIDValue
;
417 } EFI_ACPI_3_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE
;
420 // Platform Interrupt Sources Structure
430 UINT32 GlobalSystemInterrupt
;
431 UINT32 PlatformInterruptSourceFlags
;
432 } EFI_ACPI_3_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE
;
435 // Platform Interrupt Source Flags.
436 // All other bits are reserved and must be set to 0.
438 #define EFI_ACPI_3_0_CPEI_PROCESSOR_OVERRIDE (1 << 0)
441 // Smart Battery Description Table (SBST)
444 EFI_ACPI_DESCRIPTION_HEADER Header
;
445 UINT32 WarningEnergyLevel
;
446 UINT32 LowEnergyLevel
;
447 UINT32 CriticalEnergyLevel
;
448 } EFI_ACPI_3_0_SMART_BATTERY_DESCRIPTION_TABLE
;
451 // SBST Version (as defined in ACPI 3.0 spec.)
453 #define EFI_ACPI_3_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01
456 // Embedded Controller Boot Resources Table (ECDT)
457 // The table is followed by a null terminated ASCII string that contains
458 // a fully qualified reference to the name space object.
461 EFI_ACPI_DESCRIPTION_HEADER Header
;
462 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE EcControl
;
463 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE EcData
;
466 } EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE
;
469 // ECDT Version (as defined in ACPI 3.0 spec.)
471 #define EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_REVISION 0x01
474 // System Resource Affinity Table (SRAT. The rest of the table
475 // must be defined in a platform specific manner.
478 EFI_ACPI_DESCRIPTION_HEADER Header
;
479 UINT32 Reserved1
; // Must be set to 1
481 } EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_HEADER
;
484 // SRAT Version (as defined in ACPI 3.0 spec.)
486 #define EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_REVISION 0x02
489 // SRAT structure types.
490 // All other values between 0x02 an 0xFF are reserved and
491 // will be ignored by OSPM.
493 #define EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY 0x00
494 #define EFI_ACPI_3_0_MEMORY_AFFINITY 0x01
497 // Processor Local APIC/SAPIC Affinity Structure Definition
502 UINT8 ProximityDomain7To0
;
506 UINT8 ProximityDomain31To8
[3];
508 } EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY_STRUCTURE
;
511 // Local APIC/SAPIC Flags. All other bits are reserved and must be 0.
513 #define EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_ENABLED (1 << 0)
516 // Memory Affinity Structure Definition
521 UINT32 ProximityDomain
;
523 UINT32 AddressBaseLow
;
524 UINT32 AddressBaseHigh
;
530 } EFI_ACPI_3_0_MEMORY_AFFINITY_STRUCTURE
;
533 // Memory Flags. All other bits are reserved and must be 0.
535 #define EFI_ACPI_3_0_MEMORY_ENABLED (1 << 0)
536 #define EFI_ACPI_3_0_MEMORY_HOT_PLUGGABLE (1 << 1)
537 #define EFI_ACPI_3_0_MEMORY_NONVOLATILE (1 << 2)
540 // System Locality Distance Information Table (SLIT).
541 // The rest of the table is a matrix.
544 EFI_ACPI_DESCRIPTION_HEADER Header
;
545 UINT64 NumberOfSystemLocalities
;
546 } EFI_ACPI_3_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_HEADER
;
549 // SLIT Version (as defined in ACPI 3.0 spec.)
551 #define EFI_ACPI_3_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_REVISION 0x01
554 // Known table signatures
557 // "RSD PTR " Root System Description Pointer
559 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE 0x2052545020445352ULL
562 // "APIC" Multiple APIC Description Table
564 #define EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE 0x43495041
567 // "DSDT" Differentiated System Description Table
569 #define EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445344
572 // "ECDT" Embedded Controller Boot Resources Table
574 #define EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_SIGNATURE 0x54444345
577 // "FACP" Fixed ACPI Description Table
579 #define EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE 0x50434146
582 // "FACS" Firmware ACPI Control Structure
584 #define EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE 0x53434146
587 // "PSDT" Persistent System Description Table
589 #define EFI_ACPI_3_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445350
592 // "RSDT" Root System Description Table
594 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445352
597 // "SBST" Smart Battery Specification Table
599 #define EFI_ACPI_3_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE 0x54534253
602 // "SLIT" System Locality Information Table
604 #define EFI_ACPI_3_0_SYSTEM_LOCALITY_INFORMATION_TABLE_SIGNATURE 0x54494C53
607 // "SRAT" System Resource Affinity Table
609 #define EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_SIGNATURE 0x54415253
612 // "SSDT" Secondary System Description Table
614 #define EFI_ACPI_3_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445353
617 // "XSDT" Extended System Description Table
619 #define EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445358
622 // "BOOT" MS Simple Boot Spec
624 #define EFI_ACPI_3_0_SIMPLE_BOOT_FLAG_TABLE_SIGNATURE 0x544F4F42
627 // "CPEP" Corrected Platform Error Polling Table
630 #define EFI_ACPI_3_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_SIGNATURE 0x50455043
633 // "DBGP" MS Debug Port Spec
635 #define EFI_ACPI_3_0_DEBUG_PORT_TABLE_SIGNATURE 0x50474244
638 // "ETDT" Event Timer Description Table
640 #define EFI_ACPI_3_0_EVENT_TIMER_DESCRIPTION_TABLE_SIGNATURE 0x54445445
643 // "HPET" IA-PC High Precision Event Timer Table
645 #define EFI_ACPI_3_0_HIGH_PRECISION_EVENT_TIMER_TABLE_SIGNATURE 0x54455048
648 // "MCFG" PCI Express Memory Mapped Configuration Space Base Address Description Table
650 #define EFI_ACPI_3_0_PCI_EXPRESS_MEMORY_MAPPED_CONFIGURATION_SPACE_BASE_ADDRESS_DESCRIPTION_TABLE_SIGNATURE 0x4746434D
653 // "SPCR" Serial Port Concole Redirection Table
655 #define EFI_ACPI_3_0_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE 0x52435053
658 // "SPMI" Server Platform Management Interface Table
660 #define EFI_ACPI_3_0_SERVER_PLATFORM_MANAGEMENT_INTERFACE_TABLE_SIGNATURE 0x494D5053
663 // "TCPA" Trusted Computing Platform Alliance Capabilities Table
665 #define EFI_ACPI_3_0_TRUSTED_COMPUTING_PLATFORM_ALLIANCE_CAPABILITIES_TABLE_SIGNATURE 0x41504354
668 // "WDRT" Watchdog Resource Table
670 #define EFI_ACPI_3_0_WATCHDOG_RESOURCE_TABLE_SIGNATURE 0x54524457