2 ACPI 2.0 definitions from the ACPI Specification, revision 2.0
4 Copyright (c) 2006 - 2008, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include <IndustryStandard/Acpi10.h>
20 // Ensure proper structure formats
25 /// ACPI 2.0 Generic Address Space definition
29 UINT8 RegisterBitWidth
;
30 UINT8 RegisterBitOffset
;
33 } EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE
;
38 // Generic Address Space Address IDs
40 #define EFI_ACPI_2_0_SYSTEM_MEMORY 0
41 #define EFI_ACPI_2_0_SYSTEM_IO 1
42 #define EFI_ACPI_2_0_PCI_CONFIGURATION_SPACE 2
43 #define EFI_ACPI_2_0_EMBEDDED_CONTROLLER 3
44 #define EFI_ACPI_2_0_SMBUS 4
45 #define EFI_ACPI_2_0_FUNCTIONAL_FIXED_HARDWARE 0x7F
48 // ACPI 2.0 table structures
52 /// Root System Description Pointer Structure
62 UINT8 ExtendedChecksum
;
64 } EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER
;
67 /// RSD_PTR Revision (as defined in ACPI 2.0 spec.)
69 #define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02
72 /// Common table header, this prefaces all ACPI tables, including FACS, but
73 /// excluding the RSD PTR structure
78 } EFI_ACPI_2_0_COMMON_HEADER
;
81 // Root System Description Table
82 // No definition needed as it is a common description table header, the same with
83 // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT32 table pointers.
87 /// RSDT Revision (as defined in ACPI 2.0 spec.)
89 #define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
92 // Extended System Description Table
93 // No definition needed as it is a common description table header, the same with
94 // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT64 table pointers.
98 /// XSDT Revision (as defined in ACPI 2.0 spec.)
100 #define EFI_ACPI_2_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
103 // Ensure proper structure formats
107 /// Fixed ACPI Description Table Structure (FADT)
110 EFI_ACPI_DESCRIPTION_HEADER Header
;
114 UINT8 PreferredPmProfile
;
149 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE ResetReg
;
152 UINT64 XFirmwareCtrl
;
154 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk
;
155 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk
;
156 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk
;
157 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk
;
158 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk
;
159 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk
;
160 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XGpe0Blk
;
161 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XGpe1Blk
;
162 } EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE
;
166 /// FADT Version (as defined in ACPI 2.0 spec.)
168 #define EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x03
171 // Fixed ACPI Description Table Boot Architecture Flags
172 // All other bits are reserved and must be set to 0.
174 #define EFI_ACPI_2_0_LEGACY_DEVICES BIT0
175 #define EFI_ACPI_2_0_8042 BIT1
178 // Fixed ACPI Description Table Fixed Feature Flags
179 // All other bits are reserved and must be set to 0.
181 #define EFI_ACPI_2_0_WBINVD BIT0
182 #define EFI_ACPI_2_0_WBINVD_FLUSH BIT1
183 #define EFI_ACPI_2_0_PROC_C1 BIT2
184 #define EFI_ACPI_2_0_P_LVL2_UP BIT3
185 #define EFI_ACPI_2_0_PWR_BUTTON BIT4
186 #define EFI_ACPI_2_0_SLP_BUTTON BIT5
187 #define EFI_ACPI_2_0_FIX_RTC BIT6
188 #define EFI_ACPI_2_0_RTC_S4 BIT7
189 #define EFI_ACPI_2_0_TMR_VAL_EXT BIT8
190 #define EFI_ACPI_2_0_DCK_CAP BIT9
191 #define EFI_ACPI_2_0_RESET_REG_SUP BIT10
192 #define EFI_ACPI_2_0_SEALED_CASE BIT11
193 #define EFI_ACPI_2_0_HEADLESS BIT12
194 #define EFI_ACPI_2_0_CPU_SW_SLP BIT13
197 /// Firmware ACPI Control Structure
202 UINT32 HardwareSignature
;
203 UINT32 FirmwareWakingVector
;
206 UINT64 XFirmwareWakingVector
;
209 } EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
;
212 /// FACS Version (as defined in ACPI 2.0 spec.)
214 #define EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION 0x01
217 /// Firmware Control Structure Feature Flags
218 /// All other bits are reserved and must be set to 0.
220 #define EFI_ACPI_2_0_S4BIOS_F BIT0
223 /// Multiple APIC Description Table header definition. The rest of the table
224 /// must be defined in a platform specific manner.
227 EFI_ACPI_DESCRIPTION_HEADER Header
;
228 UINT32 LocalApicAddress
;
230 } EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER
;
233 /// MADT Revision (as defined in ACPI 2.0 spec.)
235 #define EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x01
238 /// Multiple APIC Flags
239 /// All other bits are reserved and must be set to 0.
241 #define EFI_ACPI_2_0_PCAT_COMPAT BIT0
244 // Multiple APIC Description Table APIC structure types
245 // All other values between 0x09 an 0xFF are reserved and
246 // will be ignored by OSPM.
248 #define EFI_ACPI_2_0_PROCESSOR_LOCAL_APIC 0x00
249 #define EFI_ACPI_2_0_IO_APIC 0x01
250 #define EFI_ACPI_2_0_INTERRUPT_SOURCE_OVERRIDE 0x02
251 #define EFI_ACPI_2_0_NON_MASKABLE_INTERRUPT_SOURCE 0x03
252 #define EFI_ACPI_2_0_LOCAL_APIC_NMI 0x04
253 #define EFI_ACPI_2_0_LOCAL_APIC_ADDRESS_OVERRIDE 0x05
254 #define EFI_ACPI_2_0_IO_SAPIC 0x06
255 #define EFI_ACPI_2_0_PROCESSOR_LOCAL_SAPIC 0x07
256 #define EFI_ACPI_2_0_PLATFORM_INTERRUPT_SOURCES 0x08
259 // APIC Structure Definitions
263 /// Processor Local APIC Structure Definition
268 UINT8 AcpiProcessorId
;
271 } EFI_ACPI_2_0_PROCESSOR_LOCAL_APIC_STRUCTURE
;
274 /// Local APIC Flags. All other bits are reserved and must be 0.
276 #define EFI_ACPI_2_0_LOCAL_APIC_ENABLED BIT0
279 /// IO APIC Structure
286 UINT32 IoApicAddress
;
287 UINT32 GlobalSystemInterruptBase
;
288 } EFI_ACPI_2_0_IO_APIC_STRUCTURE
;
291 /// Interrupt Source Override Structure
298 UINT32 GlobalSystemInterrupt
;
300 } EFI_ACPI_2_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE
;
303 /// Non-Maskable Interrupt Source Structure
309 UINT32 GlobalSystemInterrupt
;
310 } EFI_ACPI_2_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE
;
313 // Ensure proper structure formats
318 /// Local APIC NMI Structure
323 UINT8 AcpiProcessorId
;
326 } EFI_ACPI_2_0_LOCAL_APIC_NMI_STRUCTURE
;
329 /// Local APIC Address Override Structure
335 UINT64 LocalApicAddress
;
336 } EFI_ACPI_2_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE
;
341 /// IO SAPIC Structure
348 UINT32 GlobalSystemInterruptBase
;
349 UINT64 IoSapicAddress
;
350 } EFI_ACPI_2_0_IO_SAPIC_STRUCTURE
;
353 /// Local SAPIC Structure
358 UINT8 AcpiProcessorId
;
363 } EFI_ACPI_2_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE
;
366 /// Platform Interrupt Sources Structure
376 UINT32 GlobalSystemInterrupt
;
378 } EFI_ACPI_2_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE
;
381 /// Smart Battery Description Table (SBST)
384 EFI_ACPI_DESCRIPTION_HEADER Header
;
385 UINT32 WarningEnergyLevel
;
386 UINT32 LowEnergyLevel
;
387 UINT32 CriticalEnergyLevel
;
388 } EFI_ACPI_2_0_SMART_BATTERY_DESCRIPTION_TABLE
;
391 /// SBST Version (as defined in ACPI 2.0 spec.)
393 #define EFI_ACPI_2_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01
396 /// Embedded Controller Boot Resources Table (ECDT)
397 /// The table is followed by a null terminated ASCII string that contains
398 /// a fully qualified reference to the name space object.
401 EFI_ACPI_DESCRIPTION_HEADER Header
;
402 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE EcControl
;
403 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE EcData
;
406 } EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE
;
409 /// ECDT Version (as defined in ACPI 2.0 spec.)
411 #define EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_REVISION 0x01
414 // Known table signatures
418 /// "RSD PTR " Root System Description Pointer
420 #define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ')
423 /// "SPIC" Multiple SAPIC Description Table
425 /// BUGBUG: Don't know where this came from except SR870BN4 uses it.
426 /// #define EFI_ACPI_2_0_MULTIPLE_SAPIC_DESCRIPTION_TABLE_SIGNATURE 0x43495053
428 #define EFI_ACPI_2_0_MULTIPLE_SAPIC_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('S', 'P', 'I', 'C')
431 /// "BOOT" MS Simple Boot Spec
433 #define EFI_ACPI_2_0_SIMPLE_BOOT_FLAG_TABLE_SIGNATURE SIGNATURE_32('B', 'O', 'O', 'T')
436 /// "DBGP" MS Bebug Port Spec
438 #define EFI_ACPI_2_0_DEBUG_PORT_TABLE_SIGNATURE SIGNATURE_32('D', 'B', 'G', 'P')
441 /// "DSDT" Differentiated System Description Table
443 #define EFI_ACPI_2_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('D', 'S', 'D', 'T')
446 /// "ECDT" Embedded Controller Boot Resources Table
448 #define EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_SIGNATURE SIGNATURE_32('E', 'C', 'D', 'T')
451 /// "ETDT" Event Timer Description Table
453 #define EFI_ACPI_2_0_EVENT_TIMER_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('E', 'T', 'D', 'T')
456 /// "FACS" Firmware ACPI Control Structure
458 #define EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE SIGNATURE_32('F', 'A', 'C', 'S')
461 /// "FACP" Fixed ACPI Description Table
463 #define EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('F', 'A', 'C', 'P')
466 /// "APIC" Multiple APIC Description Table
468 #define EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('A', 'P', 'I', 'C')
471 /// "PSDT" Persistent System Description Table
473 #define EFI_ACPI_2_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('P', 'S', 'D', 'T')
476 /// "RSDT" Root System Description Table
478 #define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('R', 'S', 'D', 'T')
481 /// "SBST" Smart Battery Specification Table
483 #define EFI_ACPI_2_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE SIGNATURE_32('S', 'B', 'S', 'T')
486 /// "SLIT" System Locality Information Table
488 #define EFI_ACPI_2_0_SYSTEM_LOCALITY_INFORMATION_TABLE_SIGNATURE SIGNATURE_32('S', 'L', 'I', 'T')
491 /// "SPCR" Serial Port Concole Redirection Table
493 #define EFI_ACPI_2_0_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE SIGNATURE_32('S', 'P', 'C', 'R')
496 /// "SRAT" Static Resource Affinity Table
498 #define EFI_ACPI_2_0_STATIC_RESOURCE_AFFINITY_TABLE_SIGNATURE SIGNATURE_32('S', 'R', 'A', 'T')
501 /// "SSDT" Secondary System Description Table
503 #define EFI_ACPI_2_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('S', 'S', 'D', 'T')
506 /// "SPMI" Server Platform Management Interface Table
508 #define EFI_ACPI_2_0_SERVER_PLATFORM_MANAGEMENT_INTERFACE_SIGNATURE SIGNATURE_32('S', 'P', 'M', 'I')
511 /// "XSDT" Extended System Description Table
513 #define EFI_ACPI_2_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('X', 'S', 'D', 'T')
516 /// "MCFG" Static Resource Affinity Table
518 #define EFI_ACPI_2_0_MEMORY_MAPPED_CONFIGURATION_BASE_ADDRESS_TABLE_SIGNATURE SIGNATURE_32('M', 'C', 'F', 'G')