]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/IndustryStandard/Acpi10.h
1, Add <Library/DevicePathLib.h> for all source that use device path utility macros
[mirror_edk2.git] / MdePkg / Include / IndustryStandard / Acpi10.h
CommitLineData
42eedea9 1/** @file \r
568eb0cb 2 ACPI 1.0b definitions from the ACPI Specification, revision 1.0b\r
3\r
2b1cf49a 4 Copyright (c) 2006 - 2008, Intel Corporation\r
568eb0cb 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_1_0_H_\r
15#define _ACPI_1_0_H_\r
16\r
1bc5d021 17///\r
18/// Common table header, this prefaces all ACPI tables, including FACS, but\r
19/// excluding the RSD PTR structure\r
20///\r
ecc40942 21typedef struct {\r
22 UINT32 Signature;\r
23 UINT32 Length;\r
24} EFI_ACPI_COMMON_HEADER;\r
25\r
4f1afaac 26#pragma pack(1)\r
55c11cc8 27///\r
28/// Common ACPI description table header. This structure prefaces most ACPI tables.\r
29///\r
ecc40942 30typedef struct {\r
31 UINT32 Signature;\r
32 UINT32 Length;\r
33 UINT8 Revision;\r
34 UINT8 Checksum;\r
35 UINT8 OemId[6];\r
36 UINT64 OemTableId;\r
37 UINT32 OemRevision;\r
38 UINT32 CreatorId;\r
39 UINT32 CreatorRevision;\r
40} EFI_ACPI_DESCRIPTION_HEADER;\r
4f1afaac 41#pragma pack()\r
ecc40942 42\r
ecc40942 43//\r
2b1cf49a 44// Define for Desriptor\r
ecc40942 45//\r
46#define ACPI_ADDRESS_SPACE_DESCRIPTOR 0x8A\r
47#define ACPI_END_TAG_DESCRIPTOR 0x79\r
48\r
2b1cf49a 49//\r
50// Resource Type\r
51//\r
ecc40942 52#define ACPI_ADDRESS_SPACE_TYPE_MEM 0x00\r
53#define ACPI_ADDRESS_SPACE_TYPE_IO 0x01\r
54#define ACPI_ADDRESS_SPACE_TYPE_BUS 0x02\r
55\r
1bc5d021 56///\r
57/// Power Management Timer frequency is fixed at 3.579545MHz\r
58///\r
ecc40942 59#define ACPI_TIMER_FREQUENCY 3579545\r
60\r
98a33bf4 61//\r
62// Ensure proper structure formats\r
63//\r
64#pragma pack(1)\r
55c11cc8 65\r
66///\r
67/// The commond definition of QWORD, DWORD, and WORD\r
68/// Address Space Descriptors\r
69///\r
ecc40942 70typedef struct {\r
71 UINT8 Desc;\r
72 UINT16 Len;\r
73 UINT8 ResType;\r
74 UINT8 GenFlag;\r
75 UINT8 SpecificFlag;\r
76 UINT64 AddrSpaceGranularity;\r
77 UINT64 AddrRangeMin;\r
78 UINT64 AddrRangeMax;\r
79 UINT64 AddrTranslationOffset;\r
80 UINT64 AddrLen;\r
81} EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR;\r
82\r
98a33bf4 83#pragma pack()\r
84\r
ecc40942 85typedef struct {\r
86 UINT8 Desc;\r
87 UINT8 Checksum;\r
88} EFI_ACPI_END_TAG_DESCRIPTOR;\r
89\r
90//\r
91// General use definitions\r
92//\r
93#define EFI_ACPI_RESERVED_BYTE 0x00\r
94#define EFI_ACPI_RESERVED_WORD 0x0000\r
95#define EFI_ACPI_RESERVED_DWORD 0x00000000\r
96#define EFI_ACPI_RESERVED_QWORD 0x0000000000000000\r
97\r
98//\r
99// Resource Type Specific Flags\r
100// Ref ACPI specification 6.4.3.5.5\r
101//\r
102// Bit [0] : Write Status, _RW\r
103//\r
104#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_READ_WRITE (1 << 0)\r
105#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_READ_ONLY (0 << 0)\r
106//\r
107// Bit [2:1] : Memory Attributes, _MEM\r
108//\r
109#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_NON_CACHEABLE (0 << 1)\r
110#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_CACHEABLE (1 << 1)\r
111#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_CACHEABLE_WRITE_COMBINING (2 << 1)\r
112#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_CACHEABLE_PREFETCHABLE (3 << 1)\r
113//\r
114// Bit [4:3] : Memory Attributes, _MTP\r
115//\r
116#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_ADDRESS_RANGE_MEMORY (0 << 3)\r
117#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_ADDRESS_RANGE_RESERVED (1 << 3)\r
118#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_ADDRESS_RANGE_ACPI (2 << 3)\r
119#define EFI_APCI_MEMORY_RESOURCE_SPECIFIC_FLAG_ADDRESS_RANGE_NVS (3 << 3)\r
120//\r
121// Bit [5] : Memory to I/O Translation, _TTP\r
122//\r
123#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_TYPE_TRANSLATION (1 << 5)\r
124#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_TYPE_STATIC (0 << 5)\r
125\r
568eb0cb 126//\r
127// ACPI 1.0b table structures\r
128//\r
1bc5d021 129\r
130///\r
131/// Root System Description Pointer Structure\r
132///\r
568eb0cb 133typedef struct {\r
134 UINT64 Signature;\r
135 UINT8 Checksum;\r
136 UINT8 OemId[6];\r
137 UINT8 Reserved;\r
138 UINT32 RsdtAddress;\r
139} EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER;\r
140\r
141//\r
142// Root System Description Table\r
2b1cf49a 143// No definition needed as it is a common description table header, the same with \r
144// EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT32 table pointers.\r
568eb0cb 145//\r
1bc5d021 146\r
147///\r
148/// RSDT Revision (as defined in ACPI 1.0b spec.)\r
149///\r
568eb0cb 150#define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01\r
151\r
1bc5d021 152///\r
153/// Fixed ACPI Description Table Structure (FADT)\r
154///\r
568eb0cb 155typedef struct {\r
156 EFI_ACPI_DESCRIPTION_HEADER Header;\r
157 UINT32 FirmwareCtrl;\r
158 UINT32 Dsdt;\r
159 UINT8 IntModel;\r
160 UINT8 Reserved1;\r
161 UINT16 SciInt;\r
162 UINT32 SmiCmd;\r
163 UINT8 AcpiEnable;\r
164 UINT8 AcpiDisable;\r
165 UINT8 S4BiosReq;\r
166 UINT8 Reserved2;\r
167 UINT32 Pm1aEvtBlk;\r
168 UINT32 Pm1bEvtBlk;\r
169 UINT32 Pm1aCntBlk;\r
170 UINT32 Pm1bCntBlk;\r
171 UINT32 Pm2CntBlk;\r
172 UINT32 PmTmrBlk;\r
173 UINT32 Gpe0Blk;\r
174 UINT32 Gpe1Blk;\r
175 UINT8 Pm1EvtLen;\r
176 UINT8 Pm1CntLen;\r
177 UINT8 Pm2CntLen;\r
178 UINT8 PmTmLen;\r
179 UINT8 Gpe0BlkLen;\r
180 UINT8 Gpe1BlkLen;\r
181 UINT8 Gpe1Base;\r
182 UINT8 Reserved3;\r
183 UINT16 PLvl2Lat;\r
184 UINT16 PLvl3Lat;\r
185 UINT16 FlushSize;\r
186 UINT16 FlushStride;\r
187 UINT8 DutyOffset;\r
188 UINT8 DutyWidth;\r
189 UINT8 DayAlrm;\r
190 UINT8 MonAlrm;\r
191 UINT8 Century;\r
192 UINT8 Reserved4;\r
193 UINT8 Reserved5;\r
194 UINT8 Reserved6;\r
195 UINT32 Flags;\r
196} EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE;\r
197\r
1bc5d021 198///\r
199/// FADT Version (as defined in ACPI 1.0b spec.)\r
200///\r
568eb0cb 201#define EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x01\r
202\r
203//\r
204// Fixed ACPI Description Table Fixed Feature Flags\r
205// All other bits are reserved and must be set to 0.\r
206//\r
55c11cc8 207#define EFI_ACPI_1_0_WBINVD BIT0\r
208#define EFI_ACPI_1_0_WBINVD_FLUSH BIT1\r
209#define EFI_ACPI_1_0_PROC_C1 BIT2\r
210#define EFI_ACPI_1_0_P_LVL2_UP BIT3\r
211#define EFI_ACPI_1_0_PWR_BUTTON BIT4\r
212#define EFI_ACPI_1_0_SLP_BUTTON BIT5\r
213#define EFI_ACPI_1_0_FIX_RTC BIT6\r
214#define EFI_ACPI_1_0_RTC_S4 BIT7\r
215#define EFI_ACPI_1_0_TMR_VAL_EXT BIT8\r
216#define EFI_ACPI_1_0_DCK_CAP BIT9\r
568eb0cb 217\r
1bc5d021 218///\r
219/// Firmware ACPI Control Structure\r
220///\r
568eb0cb 221typedef struct {\r
222 UINT32 Signature;\r
223 UINT32 Length;\r
224 UINT32 HardwareSignature;\r
225 UINT32 FirmwareWakingVector;\r
226 UINT32 GlobalLock;\r
227 UINT32 Flags;\r
228 UINT8 Reserved[40];\r
229} EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;\r
230\r
1bc5d021 231///\r
232/// Firmware Control Structure Feature Flags\r
233/// All other bits are reserved and must be set to 0.\r
234///\r
55c11cc8 235#define EFI_ACPI_1_0_S4BIOS_F BIT0\r
568eb0cb 236\r
1bc5d021 237///\r
238/// Multiple APIC Description Table header definition. The rest of the table\r
239/// must be defined in a platform specific manner.\r
240///\r
568eb0cb 241typedef struct {\r
242 EFI_ACPI_DESCRIPTION_HEADER Header;\r
243 UINT32 LocalApicAddress;\r
244 UINT32 Flags;\r
245} EFI_ACPI_1_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;\r
246\r
1bc5d021 247///\r
248/// MADT Revision (as defined in ACPI 1.0b spec.)\r
249///\r
568eb0cb 250#define EFI_ACPI_1_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x01\r
251\r
1bc5d021 252///\r
253/// Multiple APIC Flags\r
254/// All other bits are reserved and must be set to 0.\r
255///\r
55c11cc8 256#define EFI_ACPI_1_0_PCAT_COMPAT BIT0\r
568eb0cb 257\r
258//\r
259// Multiple APIC Description Table APIC structure types\r
2b1cf49a 260// All other values between 0x05 an 0xFF are reserved and\r
568eb0cb 261// will be ignored by OSPM.\r
262//\r
263#define EFI_ACPI_1_0_PROCESSOR_LOCAL_APIC 0x00\r
264#define EFI_ACPI_1_0_IO_APIC 0x01\r
265#define EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE 0x02\r
266#define EFI_ACPI_1_0_NON_MASKABLE_INTERRUPT_SOURCE 0x03\r
267#define EFI_ACPI_1_0_LOCAL_APIC_NMI 0x04\r
268\r
269//\r
270// APIC Structure Definitions\r
271//\r
1bc5d021 272\r
273///\r
274/// Processor Local APIC Structure Definition\r
275///\r
568eb0cb 276typedef struct {\r
277 UINT8 Type;\r
278 UINT8 Length;\r
279 UINT8 AcpiProcessorId;\r
280 UINT8 ApicId;\r
281 UINT32 Flags;\r
282} EFI_ACPI_1_0_PROCESSOR_LOCAL_APIC_STRUCTURE;\r
283\r
1bc5d021 284///\r
285/// Local APIC Flags. All other bits are reserved and must be 0.\r
286///\r
55c11cc8 287#define EFI_ACPI_1_0_LOCAL_APIC_ENABLED BIT0\r
568eb0cb 288\r
1bc5d021 289///\r
290/// IO APIC Structure\r
291///\r
568eb0cb 292typedef struct {\r
293 UINT8 Type;\r
294 UINT8 Length;\r
295 UINT8 IoApicId;\r
296 UINT8 Reserved;\r
297 UINT32 IoApicAddress;\r
298 UINT32 SystemVectorBase;\r
299} EFI_ACPI_1_0_IO_APIC_STRUCTURE;\r
300\r
1bc5d021 301///\r
302/// Interrupt Source Override Structure\r
303///\r
568eb0cb 304typedef struct {\r
305 UINT8 Type;\r
306 UINT8 Length;\r
307 UINT8 Bus;\r
308 UINT8 Source;\r
309 UINT32 GlobalSystemInterruptVector;\r
310 UINT16 Flags;\r
311} EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;\r
312\r
1bc5d021 313///\r
314/// Non-Maskable Interrupt Source Structure\r
315///\r
568eb0cb 316typedef struct {\r
317 UINT8 Type;\r
318 UINT8 Length;\r
319 UINT16 Flags;\r
320 UINT32 GlobalSystemInterruptVector;\r
321} EFI_ACPI_1_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;\r
322\r
55c11cc8 323//\r
324// Ensure proper structure formats\r
325//\r
326#pragma pack(1)\r
327\r
1bc5d021 328///\r
329/// Local APIC NMI Structure\r
330///\r
568eb0cb 331typedef struct {\r
332 UINT8 Type;\r
333 UINT8 Length;\r
334 UINT8 AcpiProcessorId;\r
335 UINT16 Flags;\r
336 UINT8 LocalApicInti;\r
337} EFI_ACPI_1_0_LOCAL_APIC_NMI_STRUCTURE;\r
338\r
55c11cc8 339#pragma pack()\r
340\r
1bc5d021 341///\r
342/// Smart Battery Description Table (SBST)\r
343///\r
568eb0cb 344typedef struct {\r
345 EFI_ACPI_DESCRIPTION_HEADER Header;\r
346 UINT32 WarningEnergyLevel;\r
347 UINT32 LowEnergyLevel;\r
348 UINT32 CriticalEnergyLevel;\r
349} EFI_ACPI_1_0_SMART_BATTERY_DESCRIPTION_TABLE;\r
350\r
351//\r
352// Known table signatures\r
353//\r
1bc5d021 354\r
355///\r
356/// "RSD PTR " Root System Description Pointer\r
357///\r
13c31065 358#define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ')\r
568eb0cb 359\r
1bc5d021 360///\r
361/// "APIC" Multiple APIC Description Table\r
362///\r
13c31065 363#define EFI_ACPI_1_0_APIC_SIGNATURE SIGNATURE_32('A', 'P', 'I', 'C')\r
568eb0cb 364\r
1bc5d021 365///\r
366/// "DSDT" Differentiated System Description Table\r
367///\r
13c31065 368#define EFI_ACPI_1_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('D', 'S', 'D', 'T')\r
568eb0cb 369\r
1bc5d021 370///\r
371/// "FACS" Firmware ACPI Control Structure\r
372///\r
13c31065 373#define EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE SIGNATURE_32('F', 'A', 'C', 'S')\r
568eb0cb 374\r
1bc5d021 375///\r
376/// "FACP" Fixed ACPI Description Table\r
377///\r
13c31065 378#define EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('F', 'A', 'C', 'P')\r
568eb0cb 379\r
1bc5d021 380///\r
381/// "PSDT" Persistent System Description Table\r
382///\r
13c31065 383#define EFI_ACPI_1_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('P', 'S', 'D', 'T')\r
568eb0cb 384\r
1bc5d021 385///\r
386/// "RSDT" Root System Description Table\r
387///\r
13c31065 388#define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('R', 'S', 'D', 'T')\r
568eb0cb 389\r
1bc5d021 390///\r
391/// "SBST" Smart Battery Specification Table\r
392///\r
13c31065 393#define EFI_ACPI_1_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE SIGNATURE_32('S', 'B', 'S', 'T')\r
568eb0cb 394\r
1bc5d021 395///\r
396/// "SSDT" Secondary System Description Table\r
397///\r
13c31065 398#define EFI_ACPI_1_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('S', 'S', 'D', 'T')\r
568eb0cb 399\r
568eb0cb 400#endif\r