]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/IndustryStandard/Acpi2_0.h
Use doxygen comment style for document entity such as struct, enum, variable that...
[mirror_edk2.git] / MdePkg / Include / IndustryStandard / Acpi2_0.h
CommitLineData
42eedea9 1/** @file \r
568eb0cb 2 ACPI 2.0 definitions from the ACPI Specification, revision 2.0\r
3\r
4 Copyright (c) 2006 - 2007, Intel Corporation\r
5 All rights reserved. This program and the accompanying materials \r
6 are licensed and made available under the terms and conditions of the BSD License \r
7 which accompanies this distribution. The full text of the license may be found at \r
8 http://opensource.org/licenses/bsd-license.php \r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
12**/\r
13\r
14#ifndef _ACPI_2_0_H_\r
15#define _ACPI_2_0_H_\r
16\r
ecc40942 17#include <IndustryStandard/Acpi1_0.h>\r
568eb0cb 18\r
19//\r
20// Ensure proper structure formats\r
21//\r
22#pragma pack(1)\r
23//\r
24// ACPI Specification Revision\r
25//\r
26#define EFI_ACPI_2_0_REVISION 0x02\r
27\r
568eb0cb 28//\r
29// ACPI 2.0 Generic Address Space definition\r
30//\r
31typedef struct {\r
32 UINT8 AddressSpaceId;\r
33 UINT8 RegisterBitWidth;\r
34 UINT8 RegisterBitOffset;\r
35 UINT8 Reserved;\r
36 UINT64 Address;\r
37} EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE;\r
38\r
39//\r
40// Generic Address Space Address IDs\r
41//\r
42#define EFI_ACPI_2_0_SYSTEM_MEMORY 0\r
43#define EFI_ACPI_2_0_SYSTEM_IO 1\r
44#define EFI_ACPI_2_0_PCI_CONFIGURATION_SPACE 2\r
45#define EFI_ACPI_2_0_EMBEDDED_CONTROLLER 3\r
46#define EFI_ACPI_2_0_SMBUS 4\r
47#define EFI_ACPI_2_0_FUNCTIONAL_FIXED_HARDWARE 0x7F\r
48\r
49//\r
50// ACPI 2.0 table structures\r
51//\r
52//\r
53// Root System Description Pointer Structure\r
54//\r
55typedef struct {\r
56 UINT64 Signature;\r
57 UINT8 Checksum;\r
58 UINT8 OemId[6];\r
59 UINT8 Revision;\r
60 UINT32 RsdtAddress;\r
61 UINT32 Length;\r
62 UINT64 XsdtAddress;\r
63 UINT8 ExtendedChecksum;\r
64 UINT8 Reserved[3];\r
65} EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER;\r
66\r
67//\r
68// RSD_PTR Revision (as defined in ACPI 2.0 spec.)\r
69//\r
70#define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02\r
71\r
72//\r
73// Common table header, this prefaces all ACPI tables, including FACS, but\r
74// excluding the RSD PTR structure\r
75//\r
76typedef struct {\r
77 UINT32 Signature;\r
78 UINT32 Length;\r
79} EFI_ACPI_2_0_COMMON_HEADER;\r
80\r
81//\r
82// Root System Description Table\r
83// No definition needed as it is a common description table header followed by a\r
84// variable number of UINT32 table pointers.\r
85//\r
86//\r
87// RSDT Revision (as defined in ACPI 2.0 spec.)\r
88//\r
89#define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01\r
90\r
91//\r
92// Extended System Description Table\r
93// No definition needed as it is a common description table header followed by a\r
94// variable number of UINT64 table pointers.\r
95//\r
96//\r
97// XSDT Revision (as defined in ACPI 2.0 spec.)\r
98//\r
99#define EFI_ACPI_2_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01\r
100\r
101//\r
102// Fixed ACPI Description Table Structure (FADT)\r
103//\r
104typedef struct {\r
105 EFI_ACPI_DESCRIPTION_HEADER Header;\r
106 UINT32 FirmwareCtrl;\r
107 UINT32 Dsdt;\r
108 UINT8 Reserved0;\r
109 UINT8 PreferredPmProfile;\r
110 UINT16 SciInt;\r
111 UINT32 SmiCmd;\r
112 UINT8 AcpiEnable;\r
113 UINT8 AcpiDisable;\r
114 UINT8 S4BiosReq;\r
115 UINT8 PstateCnt;\r
116 UINT32 Pm1aEvtBlk;\r
117 UINT32 Pm1bEvtBlk;\r
118 UINT32 Pm1aCntBlk;\r
119 UINT32 Pm1bCntBlk;\r
120 UINT32 Pm2CntBlk;\r
121 UINT32 PmTmrBlk;\r
122 UINT32 Gpe0Blk;\r
123 UINT32 Gpe1Blk;\r
124 UINT8 Pm1EvtLen;\r
125 UINT8 Pm1CntLen;\r
126 UINT8 Pm2CntLen;\r
127 UINT8 PmTmrLen;\r
128 UINT8 Gpe0BlkLen;\r
129 UINT8 Gpe1BlkLen;\r
130 UINT8 Gpe1Base;\r
131 UINT8 CstCnt;\r
132 UINT16 PLvl2Lat;\r
133 UINT16 PLvl3Lat;\r
134 UINT16 FlushSize;\r
135 UINT16 FlushStride;\r
136 UINT8 DutyOffset;\r
137 UINT8 DutyWidth;\r
138 UINT8 DayAlrm;\r
139 UINT8 MonAlrm;\r
140 UINT8 Century;\r
141 UINT16 IaPcBootArch;\r
142 UINT8 Reserved1;\r
143 UINT32 Flags;\r
144 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE ResetReg;\r
145 UINT8 ResetValue;\r
146 UINT8 Reserved2[3];\r
147 UINT64 XFirmwareCtrl;\r
148 UINT64 XDsdt;\r
149 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk;\r
150 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk;\r
151 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk;\r
152 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk;\r
153 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk;\r
154 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk;\r
155 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XGpe0Blk;\r
156 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XGpe1Blk;\r
157} EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE;\r
158\r
159//\r
160// FADT Version (as defined in ACPI 2.0 spec.)\r
161//\r
162#define EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x03\r
163\r
164//\r
165// Fixed ACPI Description Table Boot Architecture Flags\r
166// All other bits are reserved and must be set to 0.\r
167//\r
168#define EFI_ACPI_2_0_LEGACY_DEVICES (1 << 0)\r
169#define EFI_ACPI_2_0_8042 (1 << 1)\r
170\r
171//\r
172// Fixed ACPI Description Table Fixed Feature Flags\r
173// All other bits are reserved and must be set to 0.\r
174//\r
175#define EFI_ACPI_2_0_WBINVD (1 << 0)\r
176#define EFI_ACPI_2_0_WBINVD_FLUSH (1 << 1)\r
177#define EFI_ACPI_2_0_PROC_C1 (1 << 2)\r
178#define EFI_ACPI_2_0_P_LVL2_UP (1 << 3)\r
179#define EFI_ACPI_2_0_PWR_BUTTON (1 << 4)\r
180#define EFI_ACPI_2_0_SLP_BUTTON (1 << 5)\r
181#define EFI_ACPI_2_0_FIX_RTC (1 << 6)\r
182#define EFI_ACPI_2_0_RTC_S4 (1 << 7)\r
183#define EFI_ACPI_2_0_TMR_VAL_EXT (1 << 8)\r
184#define EFI_ACPI_2_0_DCK_CAP (1 << 9)\r
185#define EFI_ACPI_2_0_RESET_REG_SUP (1 << 10)\r
186#define EFI_ACPI_2_0_SEALED_CASE (1 << 11)\r
187#define EFI_ACPI_2_0_HEADLESS (1 << 12)\r
188#define EFI_ACPI_2_0_CPU_SW_SLP (1 << 13)\r
189\r
190//\r
191// Firmware ACPI Control Structure\r
192//\r
193typedef struct {\r
194 UINT32 Signature;\r
195 UINT32 Length;\r
196 UINT32 HardwareSignature;\r
197 UINT32 FirmwareWakingVector;\r
198 UINT32 GlobalLock;\r
199 UINT32 Flags;\r
200 UINT64 XFirmwareWakingVector;\r
201 UINT8 Version;\r
202 UINT8 Reserved[31];\r
203} EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;\r
204\r
205//\r
206// FACS Version (as defined in ACPI 2.0 spec.)\r
207//\r
208#define EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION 0x01\r
209\r
210//\r
211// Firmware Control Structure Feature Flags\r
212// All other bits are reserved and must be set to 0.\r
213//\r
214#define EFI_ACPI_2_0_S4BIOS_F (1 << 0)\r
215\r
216//\r
217// Multiple APIC Description Table header definition. The rest of the table\r
218// must be defined in a platform specific manner.\r
219//\r
220typedef struct {\r
221 EFI_ACPI_DESCRIPTION_HEADER Header;\r
222 UINT32 LocalApicAddress;\r
223 UINT32 Flags;\r
224} EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;\r
225\r
226//\r
227// MADT Revision (as defined in ACPI 2.0 spec.)\r
228//\r
229#define EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x01\r
230\r
231//\r
232// Multiple APIC Flags\r
233// All other bits are reserved and must be set to 0.\r
234//\r
235#define EFI_ACPI_2_0_PCAT_COMPAT (1 << 0)\r
236\r
237//\r
238// Multiple APIC Description Table APIC structure types\r
239// All other values between 0x09 an 0xFF are reserved and\r
240// will be ignored by OSPM.\r
241//\r
242#define EFI_ACPI_2_0_PROCESSOR_LOCAL_APIC 0x00\r
243#define EFI_ACPI_2_0_IO_APIC 0x01\r
244#define EFI_ACPI_2_0_INTERRUPT_SOURCE_OVERRIDE 0x02\r
245#define EFI_ACPI_2_0_NON_MASKABLE_INTERRUPT_SOURCE 0x03\r
246#define EFI_ACPI_2_0_LOCAL_APIC_NMI 0x04\r
247#define EFI_ACPI_2_0_LOCAL_APIC_ADDRESS_OVERRIDE 0x05\r
248#define EFI_ACPI_2_0_IO_SAPIC 0x06\r
249#define EFI_ACPI_2_0_PROCESSOR_LOCAL_SAPIC 0x07\r
250#define EFI_ACPI_2_0_PLATFORM_INTERRUPT_SOURCES 0x08\r
251\r
252//\r
253// APIC Structure Definitions\r
254//\r
255//\r
256// Processor Local APIC Structure Definition\r
257//\r
258typedef struct {\r
259 UINT8 Type;\r
260 UINT8 Length;\r
261 UINT8 AcpiProcessorId;\r
262 UINT8 ApicId;\r
263 UINT32 Flags;\r
264} EFI_ACPI_2_0_PROCESSOR_LOCAL_APIC_STRUCTURE;\r
265\r
266//\r
267// Local APIC Flags. All other bits are reserved and must be 0.\r
268//\r
269#define EFI_ACPI_2_0_LOCAL_APIC_ENABLED (1 << 0)\r
270\r
271//\r
272// IO APIC Structure\r
273//\r
274typedef struct {\r
275 UINT8 Type;\r
276 UINT8 Length;\r
277 UINT8 IoApicId;\r
278 UINT8 Reserved;\r
279 UINT32 IoApicAddress;\r
280 UINT32 GlobalSystemInterruptBase;\r
281} EFI_ACPI_2_0_IO_APIC_STRUCTURE;\r
282\r
283//\r
284// Interrupt Source Override Structure\r
285//\r
286typedef struct {\r
287 UINT8 Type;\r
288 UINT8 Length;\r
289 UINT8 Bus;\r
290 UINT8 Source;\r
291 UINT32 GlobalSystemInterrupt;\r
292 UINT16 Flags;\r
293} EFI_ACPI_2_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;\r
294\r
295//\r
296// Non-Maskable Interrupt Source Structure\r
297//\r
298typedef struct {\r
299 UINT8 Type;\r
300 UINT8 Length;\r
301 UINT16 Flags;\r
302 UINT32 GlobalSystemInterrupt;\r
303} EFI_ACPI_2_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;\r
304\r
305//\r
306// Local APIC NMI Structure\r
307//\r
308typedef struct {\r
309 UINT8 Type;\r
310 UINT8 Length;\r
311 UINT8 AcpiProcessorId;\r
312 UINT16 Flags;\r
313 UINT8 LocalApicLint;\r
314} EFI_ACPI_2_0_LOCAL_APIC_NMI_STRUCTURE;\r
315\r
316//\r
317// Local APIC Address Override Structure\r
318//\r
319typedef struct {\r
320 UINT8 Type;\r
321 UINT8 Length;\r
322 UINT16 Reserved;\r
323 UINT64 LocalApicAddress;\r
324} EFI_ACPI_2_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE;\r
325\r
326//\r
327// IO SAPIC Structure\r
328//\r
329typedef struct {\r
330 UINT8 Type;\r
331 UINT8 Length;\r
332 UINT8 IoApicId;\r
333 UINT8 Reserved;\r
334 UINT32 GlobalSystemInterruptBase;\r
335 UINT64 IoSapicAddress;\r
336} EFI_ACPI_2_0_IO_SAPIC_STRUCTURE;\r
337\r
338//\r
339// Local SAPIC Structure\r
340//\r
341typedef struct {\r
342 UINT8 Type;\r
343 UINT8 Length;\r
344 UINT8 AcpiProcessorId;\r
345 UINT8 LocalSapicId;\r
346 UINT8 LocalSapicEid;\r
347 UINT8 Reserved[3];\r
348 UINT32 Flags;\r
349} EFI_ACPI_2_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE;\r
350\r
351//\r
352// Platform Interrupt Sources Structure\r
353//\r
354typedef struct {\r
355 UINT8 Type;\r
356 UINT8 Length;\r
357 UINT16 Flags;\r
358 UINT8 InterruptType;\r
359 UINT8 ProcessorId;\r
360 UINT8 ProcessorEid;\r
361 UINT8 IoSapicVector;\r
362 UINT32 GlobalSystemInterrupt;\r
363 UINT32 Reserved;\r
364} EFI_ACPI_2_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE;\r
365\r
366//\r
367// Smart Battery Description Table (SBST)\r
368//\r
369typedef struct {\r
370 EFI_ACPI_DESCRIPTION_HEADER Header;\r
371 UINT32 WarningEnergyLevel;\r
372 UINT32 LowEnergyLevel;\r
373 UINT32 CriticalEnergyLevel;\r
374} EFI_ACPI_2_0_SMART_BATTERY_DESCRIPTION_TABLE;\r
375\r
376//\r
377// SBST Version (as defined in ACPI 2.0 spec.)\r
378//\r
379#define EFI_ACPI_2_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01\r
380\r
381//\r
382// Embedded Controller Boot Resources Table (ECDT)\r
383// The table is followed by a null terminated ASCII string that contains\r
384// a fully qualified reference to the name space object.\r
385//\r
386typedef struct {\r
387 EFI_ACPI_DESCRIPTION_HEADER Header;\r
388 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE EcControl;\r
389 EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE EcData;\r
390 UINT32 Uid;\r
391 UINT8 GpeBit;\r
392} EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE;\r
393\r
394//\r
395// ECDT Version (as defined in ACPI 2.0 spec.)\r
396//\r
397#define EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_REVISION 0x01\r
398\r
399//\r
400// Known table signatures\r
401//\r
402//\r
403// "RSD PTR " Root System Description Pointer\r
404//\r
405#define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE 0x2052545020445352\r
406\r
407//\r
408// "SPIC" Multiple SAPIC Description Table\r
409//\r
410// BUGBUG: Don't know where this came from except SR870BN4 uses it.\r
411// #define EFI_ACPI_2_0_MULTIPLE_SAPIC_DESCRIPTION_TABLE_SIGNATURE 0x43495053\r
412//\r
413#define EFI_ACPI_2_0_MULTIPLE_SAPIC_DESCRIPTION_TABLE_SIGNATURE 0x43495041\r
414\r
415//\r
416// "BOOT" MS Simple Boot Spec\r
417//\r
418#define EFI_ACPI_2_0_SIMPLE_BOOT_FLAG_TABLE_SIGNATURE 0x544F4F42\r
419\r
420//\r
421// "DBGP" MS Bebug Port Spec\r
422//\r
423#define EFI_ACPI_2_0_DEBUG_PORT_TABLE_SIGNATURE 0x50474244\r
424\r
425//\r
426// "DSDT" Differentiated System Description Table\r
427//\r
428#define EFI_ACPI_2_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445344\r
429\r
430//\r
431// "ECDT" Embedded Controller Boot Resources Table\r
432//\r
433#define EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_SIGNATURE 0x54444345\r
434\r
435//\r
436// "ETDT" Event Timer Description Table\r
437//\r
438#define EFI_ACPI_2_0_EVENT_TIMER_DESCRIPTION_TABLE_SIGNATURE 0x54445445\r
439\r
440//\r
441// "FACS" Firmware ACPI Control Structure\r
442//\r
443#define EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE 0x53434146\r
444\r
445//\r
446// "FACP" Fixed ACPI Description Table\r
447//\r
448#define EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE 0x50434146\r
449\r
450//\r
451// "APIC" Multiple APIC Description Table\r
452//\r
453#define EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE 0x43495041\r
454\r
455//\r
456// "PSDT" Persistent System Description Table\r
457//\r
458#define EFI_ACPI_2_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445350\r
459\r
460//\r
461// "RSDT" Root System Description Table\r
462//\r
463#define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445352\r
464\r
465//\r
466// "SBST" Smart Battery Specification Table\r
467//\r
468#define EFI_ACPI_2_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE 0x54534253\r
469\r
470//\r
471// "SLIT" System Locality Information Table\r
472//\r
473#define EFI_ACPI_2_0_SYSTEM_LOCALITY_INFORMATION_TABLE_SIGNATURE 0x54494C53\r
474\r
475//\r
476// "SPCR" Serial Port Concole Redirection Table\r
477//\r
478#define EFI_ACPI_2_0_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE 0x52435053\r
479\r
480//\r
481// "SRAT" Static Resource Affinity Table\r
482//\r
483#define EFI_ACPI_2_0_STATIC_RESOURCE_AFFINITY_TABLE_SIGNATURE 0x54415253\r
484\r
485//\r
486// "SSDT" Secondary System Description Table\r
487//\r
488#define EFI_ACPI_2_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445353\r
489\r
490//\r
491// "SPMI" Server Platform Management Interface Table\r
492//\r
493#define EFI_ACPI_2_0_SERVER_PLATFORM_MANAGEMENT_INTERFACE_SIGNATURE 0x494D5053\r
494\r
495//\r
496// "XSDT" Extended System Description Table\r
497//\r
498#define EFI_ACPI_2_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445358\r
499\r
3431f363 500//\r
501// "MCFG" Static Resource Affinity Table\r
502//\r
503#define EFI_ACPI_2_0_MEMORY_MAPPED_CONFIGURATION_BASE_ADDRESS_TABLE_SIGNATURE 0x4746434D\r
504\r
568eb0cb 505#pragma pack()\r
506\r
507#endif\r