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
;
36 // Generic Address Space Address IDs
38 #define EFI_ACPI_2_0_SYSTEM_MEMORY 0
39 #define EFI_ACPI_2_0_SYSTEM_IO 1
40 #define EFI_ACPI_2_0_PCI_CONFIGURATION_SPACE 2
41 #define EFI_ACPI_2_0_EMBEDDED_CONTROLLER 3
42 #define EFI_ACPI_2_0_SMBUS 4
43 #define EFI_ACPI_2_0_FUNCTIONAL_FIXED_HARDWARE 0x7F
46 // ACPI 2.0 table structures
50 /// Root System Description Pointer Structure
60 UINT8 ExtendedChecksum
;
62 } EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER
;
65 /// RSD_PTR Revision (as defined in ACPI 2.0 spec.)
67 #define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02
70 /// Common table header, this prefaces all ACPI tables, including FACS, but
71 /// excluding the RSD PTR structure
76 } EFI_ACPI_2_0_COMMON_HEADER
;
79 // Root System Description Table
80 // No definition needed as it is a common description table header, the same with
81 // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT32 table pointers.
85 /// RSDT Revision (as defined in ACPI 2.0 spec.)
87 #define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
90 // Extended System Description Table
91 // No definition needed as it is a common description table header, the same with
92 // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT64 table pointers.
96 /// XSDT Revision (as defined in ACPI 2.0 spec.)
98 #define EFI_ACPI_2_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
101 /// Fixed ACPI Description Table Structure (FADT)
104 EFI_ACPI_DESCRIPTION_HEADER Header
;
108 UINT8 PreferredPmProfile
;
143 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE ResetReg
;
146 UINT64 XFirmwareCtrl
;
148 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk
;
149 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk
;
150 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk
;
151 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk
;
152 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk
;
153 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk
;
154 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XGpe0Blk
;
155 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XGpe1Blk
;
156 } EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE
;
159 /// FADT Version (as defined in ACPI 2.0 spec.)
161 #define EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x03
164 // Fixed ACPI Description Table Boot Architecture Flags
165 // All other bits are reserved and must be set to 0.
167 #define EFI_ACPI_2_0_LEGACY_DEVICES BIT0
168 #define EFI_ACPI_2_0_8042 BIT1
171 // Fixed ACPI Description Table Fixed Feature Flags
172 // All other bits are reserved and must be set to 0.
174 #define EFI_ACPI_2_0_WBINVD BIT0
175 #define EFI_ACPI_2_0_WBINVD_FLUSH BIT1
176 #define EFI_ACPI_2_0_PROC_C1 BIT2
177 #define EFI_ACPI_2_0_P_LVL2_UP BIT3
178 #define EFI_ACPI_2_0_PWR_BUTTON BIT4
179 #define EFI_ACPI_2_0_SLP_BUTTON BIT5
180 #define EFI_ACPI_2_0_FIX_RTC BIT6
181 #define EFI_ACPI_2_0_RTC_S4 BIT7
182 #define EFI_ACPI_2_0_TMR_VAL_EXT BIT8
183 #define EFI_ACPI_2_0_DCK_CAP BIT9
184 #define EFI_ACPI_2_0_RESET_REG_SUP BIT10
185 #define EFI_ACPI_2_0_SEALED_CASE BIT11
186 #define EFI_ACPI_2_0_HEADLESS BIT12
187 #define EFI_ACPI_2_0_CPU_SW_SLP BIT13
190 /// Firmware ACPI Control Structure
195 UINT32 HardwareSignature
;
196 UINT32 FirmwareWakingVector
;
199 UINT64 XFirmwareWakingVector
;
202 } EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
;
205 /// FACS Version (as defined in ACPI 2.0 spec.)
207 #define EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION 0x01
210 /// Firmware Control Structure Feature Flags
211 /// All other bits are reserved and must be set to 0.
213 #define EFI_ACPI_2_0_S4BIOS_F BIT0
216 /// Multiple APIC Description Table header definition. The rest of the table
217 /// must be defined in a platform specific manner.
220 EFI_ACPI_DESCRIPTION_HEADER Header
;
221 UINT32 LocalApicAddress
;
223 } EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER
;
226 /// MADT Revision (as defined in ACPI 2.0 spec.)
228 #define EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x01
231 /// Multiple APIC Flags
232 /// All other bits are reserved and must be set to 0.
234 #define EFI_ACPI_2_0_PCAT_COMPAT BIT0
237 // Multiple APIC Description Table APIC structure types
238 // All other values between 0x09 an 0xFF are reserved and
239 // will be ignored by OSPM.
241 #define EFI_ACPI_2_0_PROCESSOR_LOCAL_APIC 0x00
242 #define EFI_ACPI_2_0_IO_APIC 0x01
243 #define EFI_ACPI_2_0_INTERRUPT_SOURCE_OVERRIDE 0x02
244 #define EFI_ACPI_2_0_NON_MASKABLE_INTERRUPT_SOURCE 0x03
245 #define EFI_ACPI_2_0_LOCAL_APIC_NMI 0x04
246 #define EFI_ACPI_2_0_LOCAL_APIC_ADDRESS_OVERRIDE 0x05
247 #define EFI_ACPI_2_0_IO_SAPIC 0x06
248 #define EFI_ACPI_2_0_PROCESSOR_LOCAL_SAPIC 0x07
249 #define EFI_ACPI_2_0_PLATFORM_INTERRUPT_SOURCES 0x08
252 // APIC Structure Definitions
256 /// Processor Local APIC Structure Definition
261 UINT8 AcpiProcessorId
;
264 } EFI_ACPI_2_0_PROCESSOR_LOCAL_APIC_STRUCTURE
;
267 /// Local APIC Flags. All other bits are reserved and must be 0.
269 #define EFI_ACPI_2_0_LOCAL_APIC_ENABLED BIT0
272 /// IO APIC Structure
279 UINT32 IoApicAddress
;
280 UINT32 GlobalSystemInterruptBase
;
281 } EFI_ACPI_2_0_IO_APIC_STRUCTURE
;
284 /// Interrupt Source Override Structure
291 UINT32 GlobalSystemInterrupt
;
293 } EFI_ACPI_2_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE
;
296 /// Non-Maskable Interrupt Source Structure
302 UINT32 GlobalSystemInterrupt
;
303 } EFI_ACPI_2_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE
;
306 /// Local APIC NMI Structure
311 UINT8 AcpiProcessorId
;
314 } EFI_ACPI_2_0_LOCAL_APIC_NMI_STRUCTURE
;
317 /// Local APIC Address Override Structure
323 UINT64 LocalApicAddress
;
324 } EFI_ACPI_2_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE
;
327 /// IO SAPIC Structure
334 UINT32 GlobalSystemInterruptBase
;
335 UINT64 IoSapicAddress
;
336 } EFI_ACPI_2_0_IO_SAPIC_STRUCTURE
;
339 /// Local SAPIC Structure
344 UINT8 AcpiProcessorId
;
349 } EFI_ACPI_2_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE
;
352 /// Platform Interrupt Sources Structure
362 UINT32 GlobalSystemInterrupt
;
364 } EFI_ACPI_2_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE
;
367 /// Smart Battery Description Table (SBST)
370 EFI_ACPI_DESCRIPTION_HEADER Header
;
371 UINT32 WarningEnergyLevel
;
372 UINT32 LowEnergyLevel
;
373 UINT32 CriticalEnergyLevel
;
374 } EFI_ACPI_2_0_SMART_BATTERY_DESCRIPTION_TABLE
;
377 /// SBST Version (as defined in ACPI 2.0 spec.)
379 #define EFI_ACPI_2_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01
382 /// Embedded Controller Boot Resources Table (ECDT)
383 /// The table is followed by a null terminated ASCII string that contains
384 /// a fully qualified reference to the name space object.
387 EFI_ACPI_DESCRIPTION_HEADER Header
;
388 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE EcControl
;
389 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE EcData
;
392 } EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE
;
395 /// ECDT Version (as defined in ACPI 2.0 spec.)
397 #define EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_REVISION 0x01
400 // Known table signatures
404 /// "RSD PTR " Root System Description Pointer
406 #define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ')
409 /// "SPIC" Multiple SAPIC Description Table
411 /// BUGBUG: Don't know where this came from except SR870BN4 uses it.
412 /// #define EFI_ACPI_2_0_MULTIPLE_SAPIC_DESCRIPTION_TABLE_SIGNATURE 0x43495053
414 #define EFI_ACPI_2_0_MULTIPLE_SAPIC_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('A', 'P', 'I', 'C')
417 /// "BOOT" MS Simple Boot Spec
419 #define EFI_ACPI_2_0_SIMPLE_BOOT_FLAG_TABLE_SIGNATURE SIGNATURE_32('B', 'O', 'O', 'T')
422 /// "DBGP" MS Bebug Port Spec
424 #define EFI_ACPI_2_0_DEBUG_PORT_TABLE_SIGNATURE SIGNATURE_32('D', 'B', 'G', 'P')
427 /// "DSDT" Differentiated System Description Table
429 #define EFI_ACPI_2_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('D', 'S', 'D', 'T')
432 /// "ECDT" Embedded Controller Boot Resources Table
434 #define EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_SIGNATURE SIGNATURE_32('E', 'C', 'D', 'T')
437 /// "ETDT" Event Timer Description Table
439 #define EFI_ACPI_2_0_EVENT_TIMER_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('E', 'T', 'D', 'T')
442 /// "FACS" Firmware ACPI Control Structure
444 #define EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE SIGNATURE_32('F', 'A', 'C', 'S')
447 /// "FACP" Fixed ACPI Description Table
449 #define EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('F', 'A', 'C', 'P')
452 /// "APIC" Multiple APIC Description Table
454 #define EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('A', 'P', 'I', 'C')
457 /// "PSDT" Persistent System Description Table
459 #define EFI_ACPI_2_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('P', 'S', 'D', 'T')
462 /// "RSDT" Root System Description Table
464 #define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('R', 'S', 'D', 'T')
467 /// "SBST" Smart Battery Specification Table
469 #define EFI_ACPI_2_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE SIGNATURE_32('S', 'B', 'S', 'T')
472 /// "SLIT" System Locality Information Table
474 #define EFI_ACPI_2_0_SYSTEM_LOCALITY_INFORMATION_TABLE_SIGNATURE SIGNATURE_32('S', 'L', 'I', 'T')
477 /// "SPCR" Serial Port Concole Redirection Table
479 #define EFI_ACPI_2_0_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE SIGNATURE_32('S', 'P', 'C', 'R')
482 /// "SRAT" Static Resource Affinity Table
484 #define EFI_ACPI_2_0_STATIC_RESOURCE_AFFINITY_TABLE_SIGNATURE SIGNATURE_32('S', 'R', 'A', 'T')
487 /// "SSDT" Secondary System Description Table
489 #define EFI_ACPI_2_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('S', 'S', 'D', 'T')
492 /// "SPMI" Server Platform Management Interface Table
494 #define EFI_ACPI_2_0_SERVER_PLATFORM_MANAGEMENT_INTERFACE_SIGNATURE SIGNATURE_32('S', 'P', 'M', 'I')
497 /// "XSDT" Extended System Description Table
499 #define EFI_ACPI_2_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('X', 'S', 'D', 'T')
502 /// "MCFG" Static Resource Affinity Table
504 #define EFI_ACPI_2_0_MEMORY_MAPPED_CONFIGURATION_BASE_ADDRESS_TABLE_SIGNATURE SIGNATURE_32('M', 'C', 'F', 'G')