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