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