3 ACPI 3.0 definitions from the ACPI Specification Revision 3.0 September 2, 2004
5 Copyright (c) 2006 - 2007, 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.
21 // Ensure proper structure formats
25 // ACPI Specification Revision
27 #define EFI_ACPI_3_0_REVISION 0x03 // BUGBUG: Not in spec yet.
29 // BUGBUG: OEM values need to be moved somewhere else, probably read from data hub
30 // and produced by a platform specific driver.
33 // ACPI 3.0 Generic Address Space definition
37 UINT8 RegisterBitWidth
;
38 UINT8 RegisterBitOffset
;
41 } EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE
;
44 // Generic Address Space Address IDs
46 #define EFI_ACPI_3_0_SYSTEM_MEMORY 0
47 #define EFI_ACPI_3_0_SYSTEM_IO 1
48 #define EFI_ACPI_3_0_PCI_CONFIGURATION_SPACE 2
49 #define EFI_ACPI_3_0_EMBEDDED_CONTROLLER 3
50 #define EFI_ACPI_3_0_SMBUS 4
51 #define EFI_ACPI_3_0_FUNCTIONAL_FIXED_HARDWARE 0x7F
54 // Generic Address Space Access Sizes
56 #define EFI_ACPI_3_0_UNDEFINED 0
57 #define EFI_ACPI_3_0_BYTE 1
58 #define EFI_ACPI_3_0_WORD 2
59 #define EFI_ACPI_3_0_DWORD 3
60 #define EFI_ACPI_3_0_QWORD 4
63 // ACPI 3.0 table structures
66 // Root System Description Pointer Structure
76 UINT8 ExtendedChecksum
;
78 } EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
;
81 // RSD_PTR Revision (as defined in ACPI 3.0 spec.)
83 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02 // ACPISpec30 (Revision 3.0 September 2, 2004) says current value is 2
85 // Common table header, this prefaces all ACPI tables, including FACS, but
86 // excluding the RSD PTR structure
91 } EFI_ACPI_3_0_COMMON_HEADER
;
94 // Root System Description Table
95 // No definition needed as it is a common description table header followed by a
96 // variable number of UINT32 table pointers.
99 // RSDT Revision (as defined in ACPI 3.0 spec.)
101 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
104 // Extended System Description Table
105 // No definition needed as it is a common description table header followed by a
106 // variable number of UINT64 table pointers.
109 // XSDT Revision (as defined in ACPI 3.0 spec.)
111 #define EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
114 // Fixed ACPI Description Table Structure (FADT)
117 EFI_ACPI_DESCRIPTION_HEADER Header
;
121 UINT8 PreferredPmProfile
;
156 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE ResetReg
;
159 UINT64 XFirmwareCtrl
;
161 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk
;
162 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk
;
163 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk
;
164 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk
;
165 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk
;
166 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk
;
167 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XGpe0Blk
;
168 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XGpe1Blk
;
169 } EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE
;
172 // FADT Version (as defined in ACPI 3.0 spec.)
174 #define EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x04
177 // Fixed ACPI Description Table Preferred Power Management Profile
179 #define EFI_ACPI_3_0_PM_PROFILE_UNSPECIFIED 0
180 #define EFI_ACPI_3_0_PM_PROFILE_DESKTOP 1
181 #define EFI_ACPI_3_0_PM_PROFILE_MOBILE 2
182 #define EFI_ACPI_3_0_PM_PROFILE_WORKSTATION 3
183 #define EFI_ACPI_3_0_PM_PROFILE_ENTERPRISE_SERVER 4
184 #define EFI_ACPI_3_0_PM_PROFILE_SOHO_SERVER 5
185 #define EFI_ACPI_3_0_PM_PROFILE_APPLIANCE_PC 6
186 #define EFI_ACPI_3_0_PM_PROFILE_PERFORMANCE_SERVER 7
189 // Fixed ACPI Description Table Boot Architecture Flags
190 // All other bits are reserved and must be set to 0.
192 #define EFI_ACPI_3_0_LEGACY_DEVICES (1 << 0)
193 #define EFI_ACPI_3_0_8042 (1 << 1)
194 #define EFI_ACPI_3_0_VGA_NOT_PRESENT (1 << 2)
195 #define EFI_ACPI_3_0_MSI_NOT_SUPPORTED (1 << 3)
197 // Fixed ACPI Description Table Fixed Feature Flags
198 // All other bits are reserved and must be set to 0.
200 #define EFI_ACPI_3_0_WBINVD (1 << 0)
201 #define EFI_ACPI_3_0_WBINVD_FLUSH (1 << 1)
202 #define EFI_ACPI_3_0_PROC_C1 (1 << 2)
203 #define EFI_ACPI_3_0_P_LVL2_UP (1 << 3)
204 #define EFI_ACPI_3_0_PWR_BUTTON (1 << 4)
205 #define EFI_ACPI_3_0_SLP_BUTTON (1 << 5)
206 #define EFI_ACPI_3_0_FIX_RTC (1 << 6)
207 #define EFI_ACPI_3_0_RTC_S4 (1 << 7)
208 #define EFI_ACPI_3_0_TMR_VAL_EXT (1 << 8)
209 #define EFI_ACPI_3_0_DCK_CAP (1 << 9)
210 #define EFI_ACPI_3_0_RESET_REG_SUP (1 << 10)
211 #define EFI_ACPI_3_0_SEALED_CASE (1 << 11)
212 #define EFI_ACPI_3_0_HEADLESS (1 << 12)
213 #define EFI_ACPI_3_0_CPU_SW_SLP (1 << 13)
214 #define EFI_ACPI_3_0_PCI_EXP_WAK (1 << 14)
215 #define EFI_ACPI_3_0_USE_PLATFORM_CLOCK (1 << 15)
216 #define EFI_ACPI_3_0_S4_RTC_STS_VALID (1 << 16)
217 #define EFI_ACPI_3_0_REMOTE_POWER_ON_CAPABLE (1 << 17)
218 #define EFI_ACPI_3_0_FORCE_APIC_CLUSTER_MODEL (1 << 18)
219 #define EFI_ACPI_3_0_FORCE_APIC_PHYSICAL_DESTINATION_MODE (1 << 19)
222 // Firmware ACPI Control Structure
227 UINT32 HardwareSignature
;
228 UINT32 FirmwareWakingVector
;
231 UINT64 XFirmwareWakingVector
;
234 } EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
;
237 // FACS Version (as defined in ACPI 3.0 spec.)
239 #define EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION 0x01
242 // Firmware Control Structure Feature Flags
243 // All other bits are reserved and must be set to 0.
245 #define EFI_ACPI_3_0_S4BIOS_F (1 << 0)
248 // Differentiated System Description Table,
249 // Secondary System Description Table
250 // and Persistent System Description Table,
251 // no definition needed as they are common description table header followed by a
254 #define EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
255 #define EFI_ACPI_3_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
258 // Multiple APIC Description Table header definition. The rest of the table
259 // must be defined in a platform specific manner.
262 EFI_ACPI_DESCRIPTION_HEADER Header
;
263 UINT32 LocalApicAddress
;
265 } EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER
;
268 // MADT Revision (as defined in ACPI 3.0 spec.)
270 #define EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x02
273 // Multiple APIC Flags
274 // All other bits are reserved and must be set to 0.
276 #define EFI_ACPI_3_0_PCAT_COMPAT (1 << 0)
279 // Multiple APIC Description Table APIC structure types
280 // All other values between 0x09 an 0xFF are reserved and
281 // will be ignored by OSPM.
283 #define EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC 0x00
284 #define EFI_ACPI_3_0_IO_APIC 0x01
285 #define EFI_ACPI_3_0_INTERRUPT_SOURCE_OVERRIDE 0x02
286 #define EFI_ACPI_3_0_NON_MASKABLE_INTERRUPT_SOURCE 0x03
287 #define EFI_ACPI_3_0_LOCAL_APIC_NMI 0x04
288 #define EFI_ACPI_3_0_LOCAL_APIC_ADDRESS_OVERRIDE 0x05
289 #define EFI_ACPI_3_0_IO_SAPIC 0x06
290 #define EFI_ACPI_3_0_LOCAL_SAPIC 0x07
291 #define EFI_ACPI_3_0_PLATFORM_INTERRUPT_SOURCES 0x08
294 // APIC Structure Definitions
297 // Processor Local APIC Structure Definition
302 UINT8 AcpiProcessorId
;
305 } EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_STRUCTURE
;
308 // Local APIC Flags. All other bits are reserved and must be 0.
310 #define EFI_ACPI_3_0_LOCAL_APIC_ENABLED (1 << 0)
320 UINT32 IoApicAddress
;
321 UINT32 GlobalSystemInterruptBase
;
322 } EFI_ACPI_3_0_IO_APIC_STRUCTURE
;
325 // Interrupt Source Override Structure
332 UINT32 GlobalSystemInterrupt
;
334 } EFI_ACPI_3_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE
;
337 // Platform Interrupt Sources Structure Definition
347 UINT32 GlobalSystemInterrupt
;
348 UINT32 PlatformInterruptSourceFlags
;
349 UINT8 CpeiProcessorOverride
;
351 } EFI_ACPI_3_0_PLATFORM_INTERRUPT_APIC_STRUCTURE
;
355 // All other bits are reserved and must be set to 0.
357 #define EFI_ACPI_3_0_POLARITY (3 << 0)
358 #define EFI_ACPI_3_0_TRIGGER_MODE (3 << 2)
361 // Non-Maskable Interrupt Source Structure
367 UINT32 GlobalSystemInterrupt
;
368 } EFI_ACPI_3_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE
;
371 // Local APIC NMI Structure
376 UINT8 AcpiProcessorId
;
379 } EFI_ACPI_3_0_LOCAL_APIC_NMI_STRUCTURE
;
382 // Local APIC Address Override Structure
388 UINT64 LocalApicAddress
;
389 } EFI_ACPI_3_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE
;
392 // IO SAPIC Structure
399 UINT32 GlobalSystemInterruptBase
;
400 UINT64 IoSapicAddress
;
401 } EFI_ACPI_3_0_IO_SAPIC_STRUCTURE
;
404 // Local SAPIC Structure
405 // This struct followed by a null-terminated ASCII string - ACPI Processor UID String
410 UINT8 AcpiProcessorId
;
415 UINT32 ACPIProcessorUIDValue
;
416 } EFI_ACPI_3_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE
;
419 // Platform Interrupt Sources Structure
429 UINT32 GlobalSystemInterrupt
;
430 UINT32 PlatformInterruptSourceFlags
;
431 } EFI_ACPI_3_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE
;
434 // Platform Interrupt Source Flags.
435 // All other bits are reserved and must be set to 0.
437 #define EFI_ACPI_3_0_CPEI_PROCESSOR_OVERRIDE (1 << 0)
440 // Smart Battery Description Table (SBST)
443 EFI_ACPI_DESCRIPTION_HEADER Header
;
444 UINT32 WarningEnergyLevel
;
445 UINT32 LowEnergyLevel
;
446 UINT32 CriticalEnergyLevel
;
447 } EFI_ACPI_3_0_SMART_BATTERY_DESCRIPTION_TABLE
;
450 // SBST Version (as defined in ACPI 3.0 spec.)
452 #define EFI_ACPI_3_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01
455 // Embedded Controller Boot Resources Table (ECDT)
456 // The table is followed by a null terminated ASCII string that contains
457 // a fully qualified reference to the name space object.
460 EFI_ACPI_DESCRIPTION_HEADER Header
;
461 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE EcControl
;
462 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE EcData
;
465 } EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE
;
468 // ECDT Version (as defined in ACPI 3.0 spec.)
470 #define EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_REVISION 0x01
473 // System Resource Affinity Table (SRAT. The rest of the table
474 // must be defined in a platform specific manner.
477 EFI_ACPI_DESCRIPTION_HEADER Header
;
478 UINT32 Reserved1
; // Must be set to 1
480 } EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_HEADER
;
483 // SRAT Version (as defined in ACPI 3.0 spec.)
485 #define EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_REVISION 0x02
488 // SRAT structure types.
489 // All other values between 0x02 an 0xFF are reserved and
490 // will be ignored by OSPM.
492 #define EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY 0x00
493 #define EFI_ACPI_3_0_MEMORY_AFFINITY 0x01
496 // Processor Local APIC/SAPIC Affinity Structure Definition
501 UINT8 ProximityDomain7To0
;
505 UINT8 ProximityDomain31To8
[3];
507 } EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY_STRUCTURE
;
510 // Local APIC/SAPIC Flags. All other bits are reserved and must be 0.
512 #define EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_ENABLED (1 << 0)
515 // Memory Affinity Structure Definition
520 UINT32 ProximityDomain
;
522 UINT32 AddressBaseLow
;
523 UINT32 AddressBaseHigh
;
529 } EFI_ACPI_3_0_MEMORY_AFFINITY_STRUCTURE
;
532 // Memory Flags. All other bits are reserved and must be 0.
534 #define EFI_ACPI_3_0_MEMORY_ENABLED (1 << 0)
535 #define EFI_ACPI_3_0_MEMORY_HOT_PLUGGABLE (1 << 1)
536 #define EFI_ACPI_3_0_MEMORY_NONVOLATILE (1 << 2)
539 // System Locality Distance Information Table (SLIT).
540 // The rest of the table is a matrix.
543 EFI_ACPI_DESCRIPTION_HEADER Header
;
544 UINT64 NumberOfSystemLocalities
;
545 } EFI_ACPI_3_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_HEADER
;
548 // SLIT Version (as defined in ACPI 3.0 spec.)
550 #define EFI_ACPI_3_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_REVISION 0x01
553 // Known table signatures
556 // "RSD PTR " Root System Description Pointer
558 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE 0x2052545020445352ULL
561 // "APIC" Multiple APIC Description Table
563 #define EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE 0x43495041
566 // "DSDT" Differentiated System Description Table
568 #define EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445344
571 // "ECDT" Embedded Controller Boot Resources Table
573 #define EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_SIGNATURE 0x54444345
576 // "FACP" Fixed ACPI Description Table
578 #define EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE 0x50434146
581 // "FACS" Firmware ACPI Control Structure
583 #define EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE 0x53434146
586 // "PSDT" Persistent System Description Table
588 #define EFI_ACPI_3_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445350
591 // "RSDT" Root System Description Table
593 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445352
596 // "SBST" Smart Battery Specification Table
598 #define EFI_ACPI_3_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE 0x54534253
601 // "SLIT" System Locality Information Table
603 #define EFI_ACPI_3_0_SYSTEM_LOCALITY_INFORMATION_TABLE_SIGNATURE 0x54494C53
606 // "SRAT" System Resource Affinity Table
608 #define EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_SIGNATURE 0x54415253
611 // "SSDT" Secondary System Description Table
613 #define EFI_ACPI_3_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445353
616 // "XSDT" Extended System Description Table
618 #define EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445358
621 // "BOOT" MS Simple Boot Spec
623 #define EFI_ACPI_3_0_SIMPLE_BOOT_FLAG_TABLE_SIGNATURE 0x544F4F42
626 // "CPEP" Corrected Platform Error Polling Table
629 #define EFI_ACPI_3_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_SIGNATURE 0x50455043
632 // "DBGP" MS Debug Port Spec
634 #define EFI_ACPI_3_0_DEBUG_PORT_TABLE_SIGNATURE 0x50474244
637 // "ETDT" Event Timer Description Table
639 #define EFI_ACPI_3_0_EVENT_TIMER_DESCRIPTION_TABLE_SIGNATURE 0x54445445
642 // "HPET" IA-PC High Precision Event Timer Table
644 #define EFI_ACPI_3_0_HIGH_PRECISION_EVENT_TIMER_TABLE_SIGNATURE 0x54455048
647 // "MCFG" PCI Express Memory Mapped Configuration Space Base Address Description Table
649 #define EFI_ACPI_3_0_PCI_EXPRESS_MEMORY_MAPPED_CONFIGURATION_SPACE_BASE_ADDRESS_DESCRIPTION_TABLE_SIGNATURE 0x4746434D
652 // "SPCR" Serial Port Concole Redirection Table
654 #define EFI_ACPI_3_0_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE 0x52435053
657 // "SPMI" Server Platform Management Interface Table
659 #define EFI_ACPI_3_0_SERVER_PLATFORM_MANAGEMENT_INTERFACE_TABLE_SIGNATURE 0x494D5053
662 // "TCPA" Trusted Computing Platform Alliance Capabilities Table
664 #define EFI_ACPI_3_0_TRUSTED_COMPUTING_PLATFORM_ALLIANCE_CAPABILITIES_TABLE_SIGNATURE 0x41504354
667 // "WDRT" Watchdog Resource Table
669 #define EFI_ACPI_3_0_WATCHDOG_RESOURCE_TABLE_SIGNATURE 0x54524457