2 ACPI 2.0 definitions from the ACPI Specification, revision 2.0
4 Copyright (c) 2006 - 2014, 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.
19 #include "IndustryStandard/Acpi.h"
22 // Ensure proper structure formats
26 // ACPI Specification Revision
28 #define EFI_ACPI_2_0_REVISION 0x02
31 // BUGBUG: OEM values need to be moved somewhere else, probably read from data hub
32 // and produced by a platform specific driver.
37 #define EFI_ACPI_2_0_OEM_ID "INTEL "
38 #define EFI_ACPI_2_0_OEM_TABLE_ID 0x5034303738543245 // "E2T8704P"
42 #define EFI_ACPI_2_0_OEM_REVISION 0x00000002
45 // ACPI table creator ID
47 #define EFI_ACPI_2_0_CREATOR_ID 0x5446534D // TBD "MSFT"
49 // ACPI table creator revision
51 #define EFI_ACPI_2_0_CREATOR_REVISION 0x01000013 // TBD
53 // ACPI 2.0 Generic Address Space definition
57 UINT8 RegisterBitWidth
;
58 UINT8 RegisterBitOffset
;
61 } EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE
;
64 // Generic Address Space Address IDs
66 #define EFI_ACPI_2_0_SYSTEM_MEMORY 0
67 #define EFI_ACPI_2_0_SYSTEM_IO 1
68 #define EFI_ACPI_2_0_PCI_CONFIGURATION_SPACE 2
69 #define EFI_ACPI_2_0_EMBEDDED_CONTROLLER 3
70 #define EFI_ACPI_2_0_SMBUS 4
71 #define EFI_ACPI_2_0_FUNCTIONAL_FIXED_HARDWARE 0x7F
74 // ACPI 2.0 table structures
77 // Root System Description Pointer Structure
87 UINT8 ExtendedChecksum
;
89 } EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER
;
92 // RSD_PTR Revision (as defined in ACPI 2.0 spec.)
94 #define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02
97 // Common table header, this prefaces all ACPI tables, including FACS, but
98 // excluding the RSD PTR structure
103 } EFI_ACPI_2_0_COMMON_HEADER
;
106 // Root System Description Table
107 // No definition needed as it is a common description table header followed by a
108 // variable number of UINT32 table pointers.
111 // RSDT Revision (as defined in ACPI 2.0 spec.)
113 #define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
116 // Extended System Description Table
117 // No definition needed as it is a common description table header followed by a
118 // variable number of UINT64 table pointers.
121 // XSDT Revision (as defined in ACPI 2.0 spec.)
123 #define EFI_ACPI_2_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
126 // Fixed ACPI Description Table Structure (FADT)
129 EFI_ACPI_DESCRIPTION_HEADER Header
;
133 UINT8 PreferredPmProfile
;
168 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE ResetReg
;
171 UINT64 XFirmwareCtrl
;
173 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk
;
174 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk
;
175 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk
;
176 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk
;
177 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk
;
178 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk
;
179 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XGpe0Blk
;
180 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XGpe1Blk
;
181 } EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE
;
184 // FADT Version (as defined in ACPI 2.0 spec.)
186 #define EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x03
189 // Fixed ACPI Description Table Boot Architecture Flags
190 // All other bits are reserved and must be set to 0.
192 #define EFI_ACPI_2_0_LEGACY_DEVICES (1 << 0)
193 #define EFI_ACPI_2_0_8042 (1 << 1)
196 // Fixed ACPI Description Table Fixed Feature Flags
197 // All other bits are reserved and must be set to 0.
199 #define EFI_ACPI_2_0_WBINVD (1 << 0)
200 #define EFI_ACPI_2_0_WBINVD_FLUSH (1 << 1)
201 #define EFI_ACPI_2_0_PROC_C1 (1 << 2)
202 #define EFI_ACPI_2_0_P_LVL2_UP (1 << 3)
203 #define EFI_ACPI_2_0_PWR_BUTTON (1 << 4)
204 #define EFI_ACPI_2_0_SLP_BUTTON (1 << 5)
205 #define EFI_ACPI_2_0_FIX_RTC (1 << 6)
206 #define EFI_ACPI_2_0_RTC_S4 (1 << 7)
207 #define EFI_ACPI_2_0_TMR_VAL_EXT (1 << 8)
208 #define EFI_ACPI_2_0_DCK_CAP (1 << 9)
209 #define EFI_ACPI_2_0_RESET_REG_SUP (1 << 10)
210 #define EFI_ACPI_2_0_SEALED_CASE (1 << 11)
211 #define EFI_ACPI_2_0_HEADLESS (1 << 12)
212 #define EFI_ACPI_2_0_CPU_SW_SLP (1 << 13)
215 // Firmware ACPI Control Structure
220 UINT32 HardwareSignature
;
221 UINT32 FirmwareWakingVector
;
224 UINT64 XFirmwareWakingVector
;
227 } EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
;
230 // FACS Version (as defined in ACPI 2.0 spec.)
232 #define EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION 0x01
235 // Firmware Control Structure Feature Flags
236 // All other bits are reserved and must be set to 0.
238 #define EFI_ACPI_2_0_S4BIOS_F (1 << 0)
241 // Multiple APIC Description Table header definition. The rest of the table
242 // must be defined in a platform specific manner.
245 EFI_ACPI_DESCRIPTION_HEADER Header
;
246 UINT32 LocalApicAddress
;
248 } EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER
;
251 // MADT Revision (as defined in ACPI 2.0 spec.)
253 #define EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x01
256 // Multiple APIC Flags
257 // All other bits are reserved and must be set to 0.
259 #define EFI_ACPI_2_0_PCAT_COMPAT (1 << 0)
262 // Multiple APIC Description Table APIC structure types
263 // All other values between 0x09 an 0xFF are reserved and
264 // will be ignored by OSPM.
266 #define EFI_ACPI_2_0_PROCESSOR_LOCAL_APIC 0x00
267 #define EFI_ACPI_2_0_IO_APIC 0x01
268 #define EFI_ACPI_2_0_INTERRUPT_SOURCE_OVERRIDE 0x02
269 #define EFI_ACPI_2_0_NON_MASKABLE_INTERRUPT_SOURCE 0x03
270 #define EFI_ACPI_2_0_LOCAL_APIC_NMI 0x04
271 #define EFI_ACPI_2_0_LOCAL_APIC_ADDRESS_OVERRIDE 0x05
272 #define EFI_ACPI_2_0_IO_SAPIC 0x06
273 #define EFI_ACPI_2_0_PROCESSOR_LOCAL_SAPIC 0x07
274 #define EFI_ACPI_2_0_PLATFORM_INTERRUPT_SOURCES 0x08
277 // APIC Structure Definitions
280 // Processor Local APIC Structure Definition
285 UINT8 AcpiProcessorId
;
288 } EFI_ACPI_2_0_PROCESSOR_LOCAL_APIC_STRUCTURE
;
291 // Local APIC Flags. All other bits are reserved and must be 0.
293 #define EFI_ACPI_2_0_LOCAL_APIC_ENABLED (1 << 0)
303 UINT32 IoApicAddress
;
304 UINT32 GlobalSystemInterruptBase
;
305 } EFI_ACPI_2_0_IO_APIC_STRUCTURE
;
308 // Interrupt Source Override Structure
315 UINT32 GlobalSystemInterrupt
;
317 } EFI_ACPI_2_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE
;
320 // Non-Maskable Interrupt Source Structure
326 UINT32 GlobalSystemInterrupt
;
327 } EFI_ACPI_2_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE
;
330 // Local APIC NMI Structure
335 UINT8 AcpiProcessorId
;
338 } EFI_ACPI_2_0_LOCAL_APIC_NMI_STRUCTURE
;
341 // Local APIC Address Override Structure
347 UINT64 LocalApicAddress
;
348 } EFI_ACPI_2_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE
;
351 // IO SAPIC Structure
358 UINT32 GlobalSystemInterruptBase
;
359 UINT64 IoSapicAddress
;
360 } EFI_ACPI_2_0_IO_SAPIC_STRUCTURE
;
363 // Local SAPIC Structure
368 UINT8 AcpiProcessorId
;
373 } EFI_ACPI_2_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE
;
376 // Platform Interrupt Sources Structure
386 UINT32 GlobalSystemInterrupt
;
388 } EFI_ACPI_2_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE
;
391 // Smart Battery Description Table (SBST)
394 EFI_ACPI_DESCRIPTION_HEADER Header
;
395 UINT32 WarningEnergyLevel
;
396 UINT32 LowEnergyLevel
;
397 UINT32 CriticalEnergyLevel
;
398 } EFI_ACPI_2_0_SMART_BATTERY_DESCRIPTION_TABLE
;
401 // SBST Version (as defined in ACPI 2.0 spec.)
403 #define EFI_ACPI_2_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01
406 // Embedded Controller Boot Resources Table (ECDT)
407 // The table is followed by a null terminated ASCII string that contains
408 // a fully qualified reference to the name space object.
411 EFI_ACPI_DESCRIPTION_HEADER Header
;
412 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE EcControl
;
413 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE EcData
;
416 } EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE
;
419 // ECDT Version (as defined in ACPI 2.0 spec.)
421 #define EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_REVISION 0x01
424 // Known table signatures
427 // "RSD PTR " Root System Description Pointer
429 #define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE 0x2052545020445352
432 // "SPIC" Multiple SAPIC Description Table
434 // BUGBUG: Don't know where this came from except SR870BN4 uses it.
435 // #define EFI_ACPI_2_0_MULTIPLE_SAPIC_DESCRIPTION_TABLE_SIGNATURE 0x43495053
437 #define EFI_ACPI_2_0_MULTIPLE_SAPIC_DESCRIPTION_TABLE_SIGNATURE 0x43495041
440 // "BOOT" MS Simple Boot Spec
442 #define EFI_ACPI_2_0_SIMPLE_BOOT_FLAG_TABLE_SIGNATURE 0x544F4F42
445 // "DBGP" MS Bebug Port Spec
447 #define EFI_ACPI_2_0_DEBUG_PORT_TABLE_SIGNATURE 0x50474244
450 // "DSDT" Differentiated System Description Table
452 #define EFI_ACPI_2_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445344
455 // "ECDT" Embedded Controller Boot Resources Table
457 #define EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_SIGNATURE 0x54444345
460 // "ETDT" Event Timer Description Table
462 #define EFI_ACPI_2_0_EVENT_TIMER_DESCRIPTION_TABLE_SIGNATURE 0x54445445
465 // "FACS" Firmware ACPI Control Structure
467 #define EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE 0x53434146
470 // "FACP" Fixed ACPI Description Table
472 #define EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE 0x50434146
475 // "APIC" Multiple APIC Description Table
477 #define EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE 0x43495041
480 // "PSDT" Persistent System Description Table
482 #define EFI_ACPI_2_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445350
485 // "RSDT" Root System Description Table
487 #define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445352
490 // "SBST" Smart Battery Specification Table
492 #define EFI_ACPI_2_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE 0x54534253
495 // "SLIT" System Locality Information Table
497 #define EFI_ACPI_2_0_SYSTEM_LOCALITY_INFORMATION_TABLE_SIGNATURE 0x54494C53
500 // "SPCR" Serial Port Console Redirection Table
502 #define EFI_ACPI_2_0_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE 0x52435053
505 // "SRAT" Static Resource Affinity Table
507 #define EFI_ACPI_2_0_STATIC_RESOURCE_AFFINITY_TABLE_SIGNATURE 0x54415253
510 // "SSDT" Secondary System Description Table
512 #define EFI_ACPI_2_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445353
515 // "SPMI" Server Platform Management Interface Table
517 #define EFI_ACPI_2_0_SERVER_PLATFORM_MANAGEMENT_INTERFACE_SIGNATURE 0x494D5053
520 // "XSDT" Extended System Description Table
522 #define EFI_ACPI_2_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445358