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 SPDX-License-Identifier: BSD-2-Clause-Patent
13 #include "IndustryStandard/Acpi.h"
16 // Ensure proper structure formats
20 // ACPI Specification Revision
22 #define EFI_ACPI_3_0_REVISION 0x03 // BUGBUG: Not in spec yet.
24 // BUGBUG: OEM values need to be moved somewhere else, probably read from data hub
25 // and produced by a platform specific driver.
28 // ACPI 3.0 Generic Address Space definition
32 UINT8 RegisterBitWidth
;
33 UINT8 RegisterBitOffset
;
36 } EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE
;
39 // Generic Address Space Address IDs
41 #define EFI_ACPI_3_0_SYSTEM_MEMORY 0
42 #define EFI_ACPI_3_0_SYSTEM_IO 1
43 #define EFI_ACPI_3_0_PCI_CONFIGURATION_SPACE 2
44 #define EFI_ACPI_3_0_EMBEDDED_CONTROLLER 3
45 #define EFI_ACPI_3_0_SMBUS 4
46 #define EFI_ACPI_3_0_FUNCTIONAL_FIXED_HARDWARE 0x7F
49 // Generic Address Space Access Sizes
51 #define EFI_ACPI_3_0_UNDEFINED 0
52 #define EFI_ACPI_3_0_BYTE 1
53 #define EFI_ACPI_3_0_WORD 2
54 #define EFI_ACPI_3_0_DWORD 3
55 #define EFI_ACPI_3_0_QWORD 4
58 // ACPI 3.0 table structures
61 // Root System Description Pointer Structure
71 UINT8 ExtendedChecksum
;
73 } EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
;
76 // RSD_PTR Revision (as defined in ACPI 3.0 spec.)
78 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02 // ACPISpec30 (Revision 3.0 September 2, 2004) says current value is 2
80 // Common table header, this prefaces all ACPI tables, including FACS, but
81 // excluding the RSD PTR structure
86 } EFI_ACPI_3_0_COMMON_HEADER
;
89 // Root System Description Table
90 // No definition needed as it is a common description table header followed by a
91 // variable number of UINT32 table pointers.
94 // RSDT Revision (as defined in ACPI 3.0 spec.)
96 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
99 // Extended System Description Table
100 // No definition needed as it is a common description table header followed by a
101 // variable number of UINT64 table pointers.
104 // XSDT Revision (as defined in ACPI 3.0 spec.)
106 #define EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
109 // Fixed ACPI Description Table Structure (FADT)
112 EFI_ACPI_DESCRIPTION_HEADER Header
;
116 UINT8 PreferredPmProfile
;
151 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE ResetReg
;
154 UINT64 XFirmwareCtrl
;
156 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk
;
157 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk
;
158 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk
;
159 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk
;
160 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk
;
161 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk
;
162 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XGpe0Blk
;
163 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XGpe1Blk
;
164 } EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE
;
167 // FADT Version (as defined in ACPI 3.0 spec.)
169 #define EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x04
172 // Fixed ACPI Description Table Preferred Power Management Profile
174 #define EFI_ACPI_3_0_PM_PROFILE_UNSPECIFIED 0
175 #define EFI_ACPI_3_0_PM_PROFILE_DESKTOP 1
176 #define EFI_ACPI_3_0_PM_PROFILE_MOBILE 2
177 #define EFI_ACPI_3_0_PM_PROFILE_WORKSTATION 3
178 #define EFI_ACPI_3_0_PM_PROFILE_ENTERPRISE_SERVER 4
179 #define EFI_ACPI_3_0_PM_PROFILE_SOHO_SERVER 5
180 #define EFI_ACPI_3_0_PM_PROFILE_APPLIANCE_PC 6
181 #define EFI_ACPI_3_0_PM_PROFILE_PERFORMANCE_SERVER 7
184 // Fixed ACPI Description Table Boot Architecture Flags
185 // All other bits are reserved and must be set to 0.
187 #define EFI_ACPI_3_0_LEGACY_DEVICES (1 << 0)
188 #define EFI_ACPI_3_0_8042 (1 << 1)
189 #define EFI_ACPI_3_0_VGA_NOT_PRESENT (1 << 2)
190 #define EFI_ACPI_3_0_MSI_NOT_SUPPORTED (1 << 3)
192 // Fixed ACPI Description Table Fixed Feature Flags
193 // All other bits are reserved and must be set to 0.
195 #define EFI_ACPI_3_0_WBINVD (1 << 0)
196 #define EFI_ACPI_3_0_WBINVD_FLUSH (1 << 1)
197 #define EFI_ACPI_3_0_PROC_C1 (1 << 2)
198 #define EFI_ACPI_3_0_P_LVL2_UP (1 << 3)
199 #define EFI_ACPI_3_0_PWR_BUTTON (1 << 4)
200 #define EFI_ACPI_3_0_SLP_BUTTON (1 << 5)
201 #define EFI_ACPI_3_0_FIX_RTC (1 << 6)
202 #define EFI_ACPI_3_0_RTC_S4 (1 << 7)
203 #define EFI_ACPI_3_0_TMR_VAL_EXT (1 << 8)
204 #define EFI_ACPI_3_0_DCK_CAP (1 << 9)
205 #define EFI_ACPI_3_0_RESET_REG_SUP (1 << 10)
206 #define EFI_ACPI_3_0_SEALED_CASE (1 << 11)
207 #define EFI_ACPI_3_0_HEADLESS (1 << 12)
208 #define EFI_ACPI_3_0_CPU_SW_SLP (1 << 13)
209 #define EFI_ACPI_3_0_PCI_EXP_WAK (1 << 14)
210 #define EFI_ACPI_3_0_USE_PLATFORM_CLOCK (1 << 15)
211 #define EFI_ACPI_3_0_S4_RTC_STS_VALID (1 << 16)
212 #define EFI_ACPI_3_0_REMOTE_POWER_ON_CAPABLE (1 << 17)
213 #define EFI_ACPI_3_0_FORCE_APIC_CLUSTER_MODEL (1 << 18)
214 #define EFI_ACPI_3_0_FORCE_APIC_PHYSICAL_DESTINATION_MODE (1 << 19)
217 // Firmware ACPI Control Structure
222 UINT32 HardwareSignature
;
223 UINT32 FirmwareWakingVector
;
226 UINT64 XFirmwareWakingVector
;
229 } EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
;
232 // FACS Version (as defined in ACPI 3.0 spec.)
234 #define EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION 0x01
237 // Firmware Control Structure Feature Flags
238 // All other bits are reserved and must be set to 0.
240 #define EFI_ACPI_3_0_S4BIOS_F (1 << 0)
243 // Differentiated System Description Table,
244 // Secondary System Description Table
245 // and Persistent System Description Table,
246 // no definition needed as they are common description table header followed by a
249 #define EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
250 #define EFI_ACPI_3_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
253 // Multiple APIC Description Table header definition. The rest of the table
254 // must be defined in a platform specific manner.
257 EFI_ACPI_DESCRIPTION_HEADER Header
;
258 UINT32 LocalApicAddress
;
260 } EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER
;
263 // MADT Revision (as defined in ACPI 3.0 spec.)
265 #define EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x02
268 // Multiple APIC Flags
269 // All other bits are reserved and must be set to 0.
271 #define EFI_ACPI_3_0_PCAT_COMPAT (1 << 0)
274 // Multiple APIC Description Table APIC structure types
275 // All other values between 0x09 an 0xFF are reserved and
276 // will be ignored by OSPM.
278 #define EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC 0x00
279 #define EFI_ACPI_3_0_IO_APIC 0x01
280 #define EFI_ACPI_3_0_INTERRUPT_SOURCE_OVERRIDE 0x02
281 #define EFI_ACPI_3_0_NON_MASKABLE_INTERRUPT_SOURCE 0x03
282 #define EFI_ACPI_3_0_LOCAL_APIC_NMI 0x04
283 #define EFI_ACPI_3_0_LOCAL_APIC_ADDRESS_OVERRIDE 0x05
284 #define EFI_ACPI_3_0_IO_SAPIC 0x06
285 #define EFI_ACPI_3_0_LOCAL_SAPIC 0x07
286 #define EFI_ACPI_3_0_PLATFORM_INTERRUPT_SOURCES 0x08
289 // APIC Structure Definitions
292 // Processor Local APIC Structure Definition
297 UINT8 AcpiProcessorId
;
300 } EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_STRUCTURE
;
303 // Local APIC Flags. All other bits are reserved and must be 0.
305 #define EFI_ACPI_3_0_LOCAL_APIC_ENABLED (1 << 0)
315 UINT32 IoApicAddress
;
316 UINT32 GlobalSystemInterruptBase
;
317 } EFI_ACPI_3_0_IO_APIC_STRUCTURE
;
320 // Interrupt Source Override Structure
327 UINT32 GlobalSystemInterrupt
;
329 } EFI_ACPI_3_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE
;
332 // Platform Interrupt Sources Structure Definition
342 UINT32 GlobalSystemInterrupt
;
343 UINT32 PlatformInterruptSourceFlags
;
344 UINT8 CpeiProcessorOverride
;
346 } EFI_ACPI_3_0_PLATFORM_INTERRUPT_APIC_STRUCTURE
;
350 // All other bits are reserved and must be set to 0.
352 #define EFI_ACPI_3_0_POLARITY (3 << 0)
353 #define EFI_ACPI_3_0_TRIGGER_MODE (3 << 2)
356 // Non-Maskable Interrupt Source Structure
362 UINT32 GlobalSystemInterrupt
;
363 } EFI_ACPI_3_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE
;
366 // Local APIC NMI Structure
371 UINT8 AcpiProcessorId
;
374 } EFI_ACPI_3_0_LOCAL_APIC_NMI_STRUCTURE
;
377 // Local APIC Address Override Structure
383 UINT64 LocalApicAddress
;
384 } EFI_ACPI_3_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE
;
387 // IO SAPIC Structure
394 UINT32 GlobalSystemInterruptBase
;
395 UINT64 IoSapicAddress
;
396 } EFI_ACPI_3_0_IO_SAPIC_STRUCTURE
;
399 // Local SAPIC Structure
400 // This struct followed by a null-terminated ASCII string - ACPI Processor UID String
405 UINT8 AcpiProcessorId
;
410 UINT32 ACPIProcessorUIDValue
;
411 } EFI_ACPI_3_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE
;
414 // Platform Interrupt Sources Structure
424 UINT32 GlobalSystemInterrupt
;
425 UINT32 PlatformInterruptSourceFlags
;
426 } EFI_ACPI_3_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE
;
429 // Platform Interrupt Source Flags.
430 // All other bits are reserved and must be set to 0.
432 #define EFI_ACPI_3_0_CPEI_PROCESSOR_OVERRIDE (1 << 0)
435 // Smart Battery Description Table (SBST)
438 EFI_ACPI_DESCRIPTION_HEADER Header
;
439 UINT32 WarningEnergyLevel
;
440 UINT32 LowEnergyLevel
;
441 UINT32 CriticalEnergyLevel
;
442 } EFI_ACPI_3_0_SMART_BATTERY_DESCRIPTION_TABLE
;
445 // SBST Version (as defined in ACPI 3.0 spec.)
447 #define EFI_ACPI_3_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01
450 // Embedded Controller Boot Resources Table (ECDT)
451 // The table is followed by a null terminated ASCII string that contains
452 // a fully qualified reference to the name space object.
455 EFI_ACPI_DESCRIPTION_HEADER Header
;
456 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE EcControl
;
457 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE EcData
;
460 } EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE
;
463 // ECDT Version (as defined in ACPI 3.0 spec.)
465 #define EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_REVISION 0x01
468 // System Resource Affinity Table (SRAT. The rest of the table
469 // must be defined in a platform specific manner.
472 EFI_ACPI_DESCRIPTION_HEADER Header
;
473 UINT32 Reserved1
; // Must be set to 1
475 } EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_HEADER
;
478 // SRAT Version (as defined in ACPI 3.0 spec.)
480 #define EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_REVISION 0x02
483 // SRAT structure types.
484 // All other values between 0x02 an 0xFF are reserved and
485 // will be ignored by OSPM.
487 #define EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY 0x00
488 #define EFI_ACPI_3_0_MEMORY_AFFINITY 0x01
491 // Processor Local APIC/SAPIC Affinity Structure Definition
496 UINT8 ProximityDomain7To0
;
500 UINT8 ProximityDomain31To8
[3];
502 } EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY_STRUCTURE
;
505 // Local APIC/SAPIC Flags. All other bits are reserved and must be 0.
507 #define EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_ENABLED (1 << 0)
510 // Memory Affinity Structure Definition
515 UINT32 ProximityDomain
;
517 UINT32 AddressBaseLow
;
518 UINT32 AddressBaseHigh
;
524 } EFI_ACPI_3_0_MEMORY_AFFINITY_STRUCTURE
;
527 // Memory Flags. All other bits are reserved and must be 0.
529 #define EFI_ACPI_3_0_MEMORY_ENABLED (1 << 0)
530 #define EFI_ACPI_3_0_MEMORY_HOT_PLUGGABLE (1 << 1)
531 #define EFI_ACPI_3_0_MEMORY_NONVOLATILE (1 << 2)
534 // System Locality Distance Information Table (SLIT).
535 // The rest of the table is a matrix.
538 EFI_ACPI_DESCRIPTION_HEADER Header
;
539 UINT64 NumberOfSystemLocalities
;
540 } EFI_ACPI_3_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_HEADER
;
543 // SLIT Version (as defined in ACPI 3.0 spec.)
545 #define EFI_ACPI_3_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_REVISION 0x01
548 // Known table signatures
551 // "RSD PTR " Root System Description Pointer
553 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE 0x2052545020445352ULL
556 // "APIC" Multiple APIC Description Table
558 #define EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE 0x43495041
561 // "DSDT" Differentiated System Description Table
563 #define EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445344
566 // "ECDT" Embedded Controller Boot Resources Table
568 #define EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_SIGNATURE 0x54444345
571 // "FACP" Fixed ACPI Description Table
573 #define EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE 0x50434146
576 // "FACS" Firmware ACPI Control Structure
578 #define EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE 0x53434146
581 // "PSDT" Persistent System Description Table
583 #define EFI_ACPI_3_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445350
586 // "RSDT" Root System Description Table
588 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445352
591 // "SBST" Smart Battery Specification Table
593 #define EFI_ACPI_3_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE 0x54534253
596 // "SLIT" System Locality Information Table
598 #define EFI_ACPI_3_0_SYSTEM_LOCALITY_INFORMATION_TABLE_SIGNATURE 0x54494C53
601 // "SRAT" System Resource Affinity Table
603 #define EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_SIGNATURE 0x54415253
606 // "SSDT" Secondary System Description Table
608 #define EFI_ACPI_3_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445353
611 // "XSDT" Extended System Description Table
613 #define EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445358
616 // "BOOT" MS Simple Boot Spec
618 #define EFI_ACPI_3_0_SIMPLE_BOOT_FLAG_TABLE_SIGNATURE 0x544F4F42
621 // "CPEP" Corrected Platform Error Polling Table
624 #define EFI_ACPI_3_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_SIGNATURE 0x50455043
627 // "DBGP" MS Debug Port Spec
629 #define EFI_ACPI_3_0_DEBUG_PORT_TABLE_SIGNATURE 0x50474244
632 // "ETDT" Event Timer Description Table
634 #define EFI_ACPI_3_0_EVENT_TIMER_DESCRIPTION_TABLE_SIGNATURE 0x54445445
637 // "HPET" IA-PC High Precision Event Timer Table
639 #define EFI_ACPI_3_0_HIGH_PRECISION_EVENT_TIMER_TABLE_SIGNATURE 0x54455048
642 // "MCFG" PCI Express Memory Mapped Configuration Space Base Address Description Table
644 #define EFI_ACPI_3_0_PCI_EXPRESS_MEMORY_MAPPED_CONFIGURATION_SPACE_BASE_ADDRESS_DESCRIPTION_TABLE_SIGNATURE 0x4746434D
647 // "SPCR" Serial Port Console Redirection Table
649 #define EFI_ACPI_3_0_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE 0x52435053
652 // "SPMI" Server Platform Management Interface Table
654 #define EFI_ACPI_3_0_SERVER_PLATFORM_MANAGEMENT_INTERFACE_TABLE_SIGNATURE 0x494D5053
657 // "TCPA" Trusted Computing Platform Alliance Capabilities Table
659 #define EFI_ACPI_3_0_TRUSTED_COMPUTING_PLATFORM_ALLIANCE_CAPABILITIES_TABLE_SIGNATURE 0x41504354
662 // "WDRT" Watchdog Resource Table
664 #define EFI_ACPI_3_0_WATCHDOG_RESOURCE_TABLE_SIGNATURE 0x54524457