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