2 ACPI 3.0 definitions from the ACPI Specification Revision 3.0 September 2, 2004
4 Copyright (c) 2006 - 2007, 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.
21 #include "IndustryStandard/Acpi.h"
24 // Ensure proper structure formats
28 // ACPI Specification Revision
30 #define EFI_ACPI_3_0_REVISION 0x03 // BUGBUG: Not in spec yet.
32 // BUGBUG: OEM values need to be moved somewhere else, probably read from data hub
33 // and produced by a platform specific driver.
36 // ACPI 3.0 Generic Address Space definition
40 UINT8 RegisterBitWidth
;
41 UINT8 RegisterBitOffset
;
44 } EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE
;
47 // Generic Address Space Address IDs
49 #define EFI_ACPI_3_0_SYSTEM_MEMORY 0
50 #define EFI_ACPI_3_0_SYSTEM_IO 1
51 #define EFI_ACPI_3_0_PCI_CONFIGURATION_SPACE 2
52 #define EFI_ACPI_3_0_EMBEDDED_CONTROLLER 3
53 #define EFI_ACPI_3_0_SMBUS 4
54 #define EFI_ACPI_3_0_FUNCTIONAL_FIXED_HARDWARE 0x7F
57 // Generic Address Space Access Sizes
59 #define EFI_ACPI_3_0_UNDEFINED 0
60 #define EFI_ACPI_3_0_BYTE 1
61 #define EFI_ACPI_3_0_WORD 2
62 #define EFI_ACPI_3_0_DWORD 3
63 #define EFI_ACPI_3_0_QWORD 4
66 // ACPI 3.0 table structures
69 // Root System Description Pointer Structure
79 UINT8 ExtendedChecksum
;
81 } EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
;
84 // RSD_PTR Revision (as defined in ACPI 3.0 spec.)
86 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02 // ACPISpec30 (Revision 3.0 September 2, 2004) says current value is 2
88 // Common table header, this prefaces all ACPI tables, including FACS, but
89 // excluding the RSD PTR structure
94 } EFI_ACPI_3_0_COMMON_HEADER
;
97 // Root System Description Table
98 // No definition needed as it is a common description table header followed by a
99 // variable number of UINT32 table pointers.
102 // RSDT Revision (as defined in ACPI 3.0 spec.)
104 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
107 // Extended System Description Table
108 // No definition needed as it is a common description table header followed by a
109 // variable number of UINT64 table pointers.
112 // XSDT Revision (as defined in ACPI 3.0 spec.)
114 #define EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
117 // Fixed ACPI Description Table Structure (FADT)
120 EFI_ACPI_DESCRIPTION_HEADER Header
;
124 UINT8 PreferredPmProfile
;
159 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE ResetReg
;
162 UINT64 XFirmwareCtrl
;
164 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk
;
165 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk
;
166 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk
;
167 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk
;
168 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk
;
169 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk
;
170 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XGpe0Blk
;
171 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE XGpe1Blk
;
172 } EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE
;
175 // FADT Version (as defined in ACPI 3.0 spec.)
177 #define EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x04
180 // Fixed ACPI Description Table Preferred Power Management Profile
182 #define EFI_ACPI_3_0_PM_PROFILE_UNSPECIFIED 0
183 #define EFI_ACPI_3_0_PM_PROFILE_DESKTOP 1
184 #define EFI_ACPI_3_0_PM_PROFILE_MOBILE 2
185 #define EFI_ACPI_3_0_PM_PROFILE_WORKSTATION 3
186 #define EFI_ACPI_3_0_PM_PROFILE_ENTERPRISE_SERVER 4
187 #define EFI_ACPI_3_0_PM_PROFILE_SOHO_SERVER 5
188 #define EFI_ACPI_3_0_PM_PROFILE_APPLIANCE_PC 6
189 #define EFI_ACPI_3_0_PM_PROFILE_PERFORMANCE_SERVER 7
192 // Fixed ACPI Description Table Boot Architecture Flags
193 // All other bits are reserved and must be set to 0.
195 #define EFI_ACPI_3_0_LEGACY_DEVICES (1 << 0)
196 #define EFI_ACPI_3_0_8042 (1 << 1)
197 #define EFI_ACPI_3_0_VGA_NOT_PRESENT (1 << 2)
198 #define EFI_ACPI_3_0_MSI_NOT_SUPPORTED (1 << 3)
200 // Fixed ACPI Description Table Fixed Feature Flags
201 // All other bits are reserved and must be set to 0.
203 #define EFI_ACPI_3_0_WBINVD (1 << 0)
204 #define EFI_ACPI_3_0_WBINVD_FLUSH (1 << 1)
205 #define EFI_ACPI_3_0_PROC_C1 (1 << 2)
206 #define EFI_ACPI_3_0_P_LVL2_UP (1 << 3)
207 #define EFI_ACPI_3_0_PWR_BUTTON (1 << 4)
208 #define EFI_ACPI_3_0_SLP_BUTTON (1 << 5)
209 #define EFI_ACPI_3_0_FIX_RTC (1 << 6)
210 #define EFI_ACPI_3_0_RTC_S4 (1 << 7)
211 #define EFI_ACPI_3_0_TMR_VAL_EXT (1 << 8)
212 #define EFI_ACPI_3_0_DCK_CAP (1 << 9)
213 #define EFI_ACPI_3_0_RESET_REG_SUP (1 << 10)
214 #define EFI_ACPI_3_0_SEALED_CASE (1 << 11)
215 #define EFI_ACPI_3_0_HEADLESS (1 << 12)
216 #define EFI_ACPI_3_0_CPU_SW_SLP (1 << 13)
217 #define EFI_ACPI_3_0_PCI_EXP_WAK (1 << 14)
218 #define EFI_ACPI_3_0_USE_PLATFORM_CLOCK (1 << 15)
219 #define EFI_ACPI_3_0_S4_RTC_STS_VALID (1 << 16)
220 #define EFI_ACPI_3_0_REMOTE_POWER_ON_CAPABLE (1 << 17)
221 #define EFI_ACPI_3_0_FORCE_APIC_CLUSTER_MODEL (1 << 18)
222 #define EFI_ACPI_3_0_FORCE_APIC_PHYSICAL_DESTINATION_MODE (1 << 19)
225 // Firmware ACPI Control Structure
230 UINT32 HardwareSignature
;
231 UINT32 FirmwareWakingVector
;
234 UINT64 XFirmwareWakingVector
;
237 } EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
;
240 // FACS Version (as defined in ACPI 3.0 spec.)
242 #define EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION 0x01
245 // Firmware Control Structure Feature Flags
246 // All other bits are reserved and must be set to 0.
248 #define EFI_ACPI_3_0_S4BIOS_F (1 << 0)
251 // Differentiated System Description Table,
252 // Secondary System Description Table
253 // and Persistent System Description Table,
254 // no definition needed as they are common description table header followed by a
257 #define EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
258 #define EFI_ACPI_3_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
261 // Multiple APIC Description Table header definition. The rest of the table
262 // must be defined in a platform specific manner.
265 EFI_ACPI_DESCRIPTION_HEADER Header
;
266 UINT32 LocalApicAddress
;
268 } EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER
;
271 // MADT Revision (as defined in ACPI 3.0 spec.)
273 #define EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x02
276 // Multiple APIC Flags
277 // All other bits are reserved and must be set to 0.
279 #define EFI_ACPI_3_0_PCAT_COMPAT (1 << 0)
282 // Multiple APIC Description Table APIC structure types
283 // All other values between 0x09 an 0xFF are reserved and
284 // will be ignored by OSPM.
286 #define EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC 0x00
287 #define EFI_ACPI_3_0_IO_APIC 0x01
288 #define EFI_ACPI_3_0_INTERRUPT_SOURCE_OVERRIDE 0x02
289 #define EFI_ACPI_3_0_NON_MASKABLE_INTERRUPT_SOURCE 0x03
290 #define EFI_ACPI_3_0_LOCAL_APIC_NMI 0x04
291 #define EFI_ACPI_3_0_LOCAL_APIC_ADDRESS_OVERRIDE 0x05
292 #define EFI_ACPI_3_0_IO_SAPIC 0x06
293 #define EFI_ACPI_3_0_LOCAL_SAPIC 0x07
294 #define EFI_ACPI_3_0_PLATFORM_INTERRUPT_SOURCES 0x08
297 // APIC Structure Definitions
300 // Processor Local APIC Structure Definition
305 UINT8 AcpiProcessorId
;
308 } EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_STRUCTURE
;
311 // Local APIC Flags. All other bits are reserved and must be 0.
313 #define EFI_ACPI_3_0_LOCAL_APIC_ENABLED (1 << 0)
323 UINT32 IoApicAddress
;
324 UINT32 GlobalSystemInterruptBase
;
325 } EFI_ACPI_3_0_IO_APIC_STRUCTURE
;
328 // Interrupt Source Override Structure
335 UINT32 GlobalSystemInterrupt
;
337 } EFI_ACPI_3_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE
;
340 // Platform Interrupt Sources Structure Definition
350 UINT32 GlobalSystemInterrupt
;
351 UINT32 PlatformInterruptSourceFlags
;
352 UINT8 CpeiProcessorOverride
;
354 } EFI_ACPI_3_0_PLATFORM_INTERRUPT_APIC_STRUCTURE
;
358 // All other bits are reserved and must be set to 0.
360 #define EFI_ACPI_3_0_POLARITY (3 << 0)
361 #define EFI_ACPI_3_0_TRIGGER_MODE (3 << 2)
364 // Non-Maskable Interrupt Source Structure
370 UINT32 GlobalSystemInterrupt
;
371 } EFI_ACPI_3_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE
;
374 // Local APIC NMI Structure
379 UINT8 AcpiProcessorId
;
382 } EFI_ACPI_3_0_LOCAL_APIC_NMI_STRUCTURE
;
385 // Local APIC Address Override Structure
391 UINT64 LocalApicAddress
;
392 } EFI_ACPI_3_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE
;
395 // IO SAPIC Structure
402 UINT32 GlobalSystemInterruptBase
;
403 UINT64 IoSapicAddress
;
404 } EFI_ACPI_3_0_IO_SAPIC_STRUCTURE
;
407 // Local SAPIC Structure
408 // This struct followed by a null-terminated ASCII string - ACPI Processor UID String
413 UINT8 AcpiProcessorId
;
418 UINT32 ACPIProcessorUIDValue
;
419 } EFI_ACPI_3_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE
;
422 // Platform Interrupt Sources Structure
432 UINT32 GlobalSystemInterrupt
;
433 UINT32 PlatformInterruptSourceFlags
;
434 } EFI_ACPI_3_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE
;
437 // Platform Interrupt Source Flags.
438 // All other bits are reserved and must be set to 0.
440 #define EFI_ACPI_3_0_CPEI_PROCESSOR_OVERRIDE (1 << 0)
443 // Smart Battery Description Table (SBST)
446 EFI_ACPI_DESCRIPTION_HEADER Header
;
447 UINT32 WarningEnergyLevel
;
448 UINT32 LowEnergyLevel
;
449 UINT32 CriticalEnergyLevel
;
450 } EFI_ACPI_3_0_SMART_BATTERY_DESCRIPTION_TABLE
;
453 // SBST Version (as defined in ACPI 3.0 spec.)
455 #define EFI_ACPI_3_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01
458 // Embedded Controller Boot Resources Table (ECDT)
459 // The table is followed by a null terminated ASCII string that contains
460 // a fully qualified reference to the name space object.
463 EFI_ACPI_DESCRIPTION_HEADER Header
;
464 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE EcControl
;
465 EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE EcData
;
468 } EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE
;
471 // ECDT Version (as defined in ACPI 3.0 spec.)
473 #define EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_REVISION 0x01
476 // System Resource Affinity Table (SRAT. The rest of the table
477 // must be defined in a platform specific manner.
480 EFI_ACPI_DESCRIPTION_HEADER Header
;
481 UINT32 Reserved1
; // Must be set to 1
483 } EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_HEADER
;
486 // SRAT Version (as defined in ACPI 3.0 spec.)
488 #define EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_REVISION 0x02
491 // SRAT structure types.
492 // All other values between 0x02 an 0xFF are reserved and
493 // will be ignored by OSPM.
495 #define EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY 0x00
496 #define EFI_ACPI_3_0_MEMORY_AFFINITY 0x01
499 // Processor Local APIC/SAPIC Affinity Structure Definition
504 UINT8 ProximityDomain7To0
;
508 UINT8 ProximityDomain31To8
[3];
510 } EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY_STRUCTURE
;
513 // Local APIC/SAPIC Flags. All other bits are reserved and must be 0.
515 #define EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_ENABLED (1 << 0)
518 // Memory Affinity Structure Definition
523 UINT32 ProximityDomain
;
525 UINT32 AddressBaseLow
;
526 UINT32 AddressBaseHigh
;
532 } EFI_ACPI_3_0_MEMORY_AFFINITY_STRUCTURE
;
535 // Memory Flags. All other bits are reserved and must be 0.
537 #define EFI_ACPI_3_0_MEMORY_ENABLED (1 << 0)
538 #define EFI_ACPI_3_0_MEMORY_HOT_PLUGGABLE (1 << 1)
539 #define EFI_ACPI_3_0_MEMORY_NONVOLATILE (1 << 2)
542 // System Locality Distance Information Table (SLIT).
543 // The rest of the table is a matrix.
546 EFI_ACPI_DESCRIPTION_HEADER Header
;
547 UINT64 NumberOfSystemLocalities
;
548 } EFI_ACPI_3_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_HEADER
;
551 // SLIT Version (as defined in ACPI 3.0 spec.)
553 #define EFI_ACPI_3_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_REVISION 0x01
556 // Known table signatures
559 // "RSD PTR " Root System Description Pointer
561 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE 0x2052545020445352ULL
564 // "APIC" Multiple APIC Description Table
566 #define EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE 0x43495041
569 // "DSDT" Differentiated System Description Table
571 #define EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445344
574 // "ECDT" Embedded Controller Boot Resources Table
576 #define EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_SIGNATURE 0x54444345
579 // "FACP" Fixed ACPI Description Table
581 #define EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE 0x50434146
584 // "FACS" Firmware ACPI Control Structure
586 #define EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE 0x53434146
589 // "PSDT" Persistent System Description Table
591 #define EFI_ACPI_3_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445350
594 // "RSDT" Root System Description Table
596 #define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445352
599 // "SBST" Smart Battery Specification Table
601 #define EFI_ACPI_3_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE 0x54534253
604 // "SLIT" System Locality Information Table
606 #define EFI_ACPI_3_0_SYSTEM_LOCALITY_INFORMATION_TABLE_SIGNATURE 0x54494C53
609 // "SRAT" System Resource Affinity Table
611 #define EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_SIGNATURE 0x54415253
614 // "SSDT" Secondary System Description Table
616 #define EFI_ACPI_3_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445353
619 // "XSDT" Extended System Description Table
621 #define EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445358
624 // "BOOT" MS Simple Boot Spec
626 #define EFI_ACPI_3_0_SIMPLE_BOOT_FLAG_TABLE_SIGNATURE 0x544F4F42
629 // "CPEP" Corrected Platform Error Polling Table
632 #define EFI_ACPI_3_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_SIGNATURE 0x50455043
635 // "DBGP" MS Debug Port Spec
637 #define EFI_ACPI_3_0_DEBUG_PORT_TABLE_SIGNATURE 0x50474244
640 // "ETDT" Event Timer Description Table
642 #define EFI_ACPI_3_0_EVENT_TIMER_DESCRIPTION_TABLE_SIGNATURE 0x54445445
645 // "HPET" IA-PC High Precision Event Timer Table
647 #define EFI_ACPI_3_0_HIGH_PRECISION_EVENT_TIMER_TABLE_SIGNATURE 0x54455048
650 // "MCFG" PCI Express Memory Mapped Configuration Space Base Address Description Table
652 #define EFI_ACPI_3_0_PCI_EXPRESS_MEMORY_MAPPED_CONFIGURATION_SPACE_BASE_ADDRESS_DESCRIPTION_TABLE_SIGNATURE 0x4746434D
655 // "SPCR" Serial Port Concole Redirection Table
657 #define EFI_ACPI_3_0_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE 0x52435053
660 // "SPMI" Server Platform Management Interface Table
662 #define EFI_ACPI_3_0_SERVER_PLATFORM_MANAGEMENT_INTERFACE_TABLE_SIGNATURE 0x494D5053
665 // "TCPA" Trusted Computing Platform Alliance Capabilities Table
667 #define EFI_ACPI_3_0_TRUSTED_COMPUTING_PLATFORM_ALLIANCE_CAPABILITIES_TABLE_SIGNATURE 0x41504354
670 // "WDRT" Watchdog Resource Table
672 #define EFI_ACPI_3_0_WATCHDOG_RESOURCE_TABLE_SIGNATURE 0x54524457