]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/IndustryStandard/Acpi10.h
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Detab
[mirror_edk2.git] / MdePkg / Include / IndustryStandard / Acpi10.h
CommitLineData
42eedea9 1/** @file \r
ee6c452c 2 ACPI 1.0b definitions from the ACPI Specification, revision 1.0b\r
568eb0cb 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
766f4bc1 26//\r
27// Common ACPI description table header. This structure prefaces most ACPI tables.\r
28//\r
4f1afaac 29#pragma pack(1)\r
766f4bc1 30\r
ecc40942 31typedef struct {\r
32 UINT32 Signature;\r
33 UINT32 Length;\r
34 UINT8 Revision;\r
35 UINT8 Checksum;\r
36 UINT8 OemId[6];\r
37 UINT64 OemTableId;\r
38 UINT32 OemRevision;\r
39 UINT32 CreatorId;\r
40 UINT32 CreatorRevision;\r
41} EFI_ACPI_DESCRIPTION_HEADER;\r
42\r
766f4bc1 43#pragma pack()\r
ecc40942 44//\r
2b1cf49a 45// Define for Desriptor\r
ecc40942 46//\r
47#define ACPI_ADDRESS_SPACE_DESCRIPTOR 0x8A\r
48#define ACPI_END_TAG_DESCRIPTOR 0x79\r
49\r
2b1cf49a 50//\r
51// Resource Type\r
52//\r
ecc40942 53#define ACPI_ADDRESS_SPACE_TYPE_MEM 0x00\r
54#define ACPI_ADDRESS_SPACE_TYPE_IO 0x01\r
55#define ACPI_ADDRESS_SPACE_TYPE_BUS 0x02\r
56\r
1bc5d021 57///\r
58/// Power Management Timer frequency is fixed at 3.579545MHz\r
59///\r
ecc40942 60#define ACPI_TIMER_FREQUENCY 3579545\r
61\r
98a33bf4 62//\r
63// Ensure proper structure formats\r
64//\r
65#pragma pack(1)\r
766f4bc1 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
766f4bc1 126//\r
127// Ensure proper structure formats\r
128//\r
129#pragma pack(1)\r
568eb0cb 130//\r
131// ACPI 1.0b table structures\r
132//\r
1bc5d021 133\r
134///\r
135/// Root System Description Pointer Structure\r
136///\r
568eb0cb 137typedef struct {\r
138 UINT64 Signature;\r
139 UINT8 Checksum;\r
140 UINT8 OemId[6];\r
141 UINT8 Reserved;\r
142 UINT32 RsdtAddress;\r
143} EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER;\r
144\r
145//\r
146// Root System Description Table\r
2b1cf49a 147// No definition needed as it is a common description table header, the same with \r
148// EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT32 table pointers.\r
568eb0cb 149//\r
1bc5d021 150\r
151///\r
152/// RSDT Revision (as defined in ACPI 1.0b spec.)\r
153///\r
568eb0cb 154#define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01\r
155\r
1bc5d021 156///\r
157/// Fixed ACPI Description Table Structure (FADT)\r
158///\r
568eb0cb 159typedef struct {\r
160 EFI_ACPI_DESCRIPTION_HEADER Header;\r
161 UINT32 FirmwareCtrl;\r
162 UINT32 Dsdt;\r
163 UINT8 IntModel;\r
164 UINT8 Reserved1;\r
165 UINT16 SciInt;\r
166 UINT32 SmiCmd;\r
167 UINT8 AcpiEnable;\r
168 UINT8 AcpiDisable;\r
169 UINT8 S4BiosReq;\r
170 UINT8 Reserved2;\r
171 UINT32 Pm1aEvtBlk;\r
172 UINT32 Pm1bEvtBlk;\r
173 UINT32 Pm1aCntBlk;\r
174 UINT32 Pm1bCntBlk;\r
175 UINT32 Pm2CntBlk;\r
176 UINT32 PmTmrBlk;\r
177 UINT32 Gpe0Blk;\r
178 UINT32 Gpe1Blk;\r
179 UINT8 Pm1EvtLen;\r
180 UINT8 Pm1CntLen;\r
181 UINT8 Pm2CntLen;\r
182 UINT8 PmTmLen;\r
183 UINT8 Gpe0BlkLen;\r
184 UINT8 Gpe1BlkLen;\r
185 UINT8 Gpe1Base;\r
186 UINT8 Reserved3;\r
187 UINT16 PLvl2Lat;\r
188 UINT16 PLvl3Lat;\r
189 UINT16 FlushSize;\r
190 UINT16 FlushStride;\r
191 UINT8 DutyOffset;\r
192 UINT8 DutyWidth;\r
193 UINT8 DayAlrm;\r
194 UINT8 MonAlrm;\r
195 UINT8 Century;\r
196 UINT8 Reserved4;\r
197 UINT8 Reserved5;\r
198 UINT8 Reserved6;\r
199 UINT32 Flags;\r
200} EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE;\r
201\r
1bc5d021 202///\r
203/// FADT Version (as defined in ACPI 1.0b spec.)\r
204///\r
568eb0cb 205#define EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x01\r
206\r
207//\r
208// Fixed ACPI Description Table Fixed Feature Flags\r
209// All other bits are reserved and must be set to 0.\r
210//\r
766f4bc1 211#define EFI_ACPI_1_0_WBINVD (1 << 0)\r
212#define EFI_ACPI_1_0_WBINVD_FLUSH (1 << 1)\r
213#define EFI_ACPI_1_0_PROC_C1 (1 << 2)\r
214#define EFI_ACPI_1_0_P_LVL2_UP (1 << 3)\r
215#define EFI_ACPI_1_0_PWR_BUTTON (1 << 4)\r
216#define EFI_ACPI_1_0_SLP_BUTTON (1 << 5)\r
217#define EFI_ACPI_1_0_FIX_RTC (1 << 6)\r
218#define EFI_ACPI_1_0_RTC_S4 (1 << 7)\r
219#define EFI_ACPI_1_0_TMR_VAL_EXT (1 << 8)\r
220#define EFI_ACPI_1_0_DCK_CAP (1 << 9)\r
568eb0cb 221\r
1bc5d021 222///\r
223/// Firmware ACPI Control Structure\r
224///\r
568eb0cb 225typedef struct {\r
226 UINT32 Signature;\r
227 UINT32 Length;\r
228 UINT32 HardwareSignature;\r
229 UINT32 FirmwareWakingVector;\r
230 UINT32 GlobalLock;\r
231 UINT32 Flags;\r
232 UINT8 Reserved[40];\r
233} EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;\r
234\r
1bc5d021 235///\r
236/// Firmware Control Structure Feature Flags\r
237/// All other bits are reserved and must be set to 0.\r
238///\r
766f4bc1 239#define EFI_ACPI_1_0_S4BIOS_F (1 << 0)\r
568eb0cb 240\r
1bc5d021 241///\r
242/// Multiple APIC Description Table header definition. The rest of the table\r
243/// must be defined in a platform specific manner.\r
244///\r
568eb0cb 245typedef struct {\r
246 EFI_ACPI_DESCRIPTION_HEADER Header;\r
247 UINT32 LocalApicAddress;\r
248 UINT32 Flags;\r
249} EFI_ACPI_1_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;\r
250\r
1bc5d021 251///\r
252/// MADT Revision (as defined in ACPI 1.0b spec.)\r
253///\r
568eb0cb 254#define EFI_ACPI_1_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x01\r
255\r
1bc5d021 256///\r
257/// Multiple APIC Flags\r
258/// All other bits are reserved and must be set to 0.\r
259///\r
766f4bc1 260#define EFI_ACPI_1_0_PCAT_COMPAT (1 << 0)\r
568eb0cb 261\r
262//\r
263// Multiple APIC Description Table APIC structure types\r
2b1cf49a 264// All other values between 0x05 an 0xFF are reserved and\r
568eb0cb 265// will be ignored by OSPM.\r
266//\r
267#define EFI_ACPI_1_0_PROCESSOR_LOCAL_APIC 0x00\r
268#define EFI_ACPI_1_0_IO_APIC 0x01\r
269#define EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE 0x02\r
270#define EFI_ACPI_1_0_NON_MASKABLE_INTERRUPT_SOURCE 0x03\r
271#define EFI_ACPI_1_0_LOCAL_APIC_NMI 0x04\r
272\r
273//\r
274// APIC Structure Definitions\r
275//\r
1bc5d021 276\r
277///\r
278/// Processor Local APIC Structure Definition\r
279///\r
568eb0cb 280typedef struct {\r
281 UINT8 Type;\r
282 UINT8 Length;\r
283 UINT8 AcpiProcessorId;\r
284 UINT8 ApicId;\r
285 UINT32 Flags;\r
286} EFI_ACPI_1_0_PROCESSOR_LOCAL_APIC_STRUCTURE;\r
287\r
1bc5d021 288///\r
289/// Local APIC Flags. All other bits are reserved and must be 0.\r
290///\r
766f4bc1 291#define EFI_ACPI_1_0_LOCAL_APIC_ENABLED (1 << 0)\r
568eb0cb 292\r
1bc5d021 293///\r
294/// IO APIC Structure\r
295///\r
568eb0cb 296typedef struct {\r
297 UINT8 Type;\r
298 UINT8 Length;\r
299 UINT8 IoApicId;\r
300 UINT8 Reserved;\r
301 UINT32 IoApicAddress;\r
302 UINT32 SystemVectorBase;\r
303} EFI_ACPI_1_0_IO_APIC_STRUCTURE;\r
304\r
1bc5d021 305///\r
306/// Interrupt Source Override Structure\r
307///\r
568eb0cb 308typedef struct {\r
309 UINT8 Type;\r
310 UINT8 Length;\r
311 UINT8 Bus;\r
312 UINT8 Source;\r
313 UINT32 GlobalSystemInterruptVector;\r
314 UINT16 Flags;\r
315} EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;\r
316\r
1bc5d021 317///\r
318/// Non-Maskable Interrupt Source Structure\r
319///\r
568eb0cb 320typedef struct {\r
321 UINT8 Type;\r
322 UINT8 Length;\r
323 UINT16 Flags;\r
324 UINT32 GlobalSystemInterruptVector;\r
325} EFI_ACPI_1_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;\r
326\r
1bc5d021 327///\r
328/// Local APIC NMI Structure\r
329///\r
568eb0cb 330typedef struct {\r
331 UINT8 Type;\r
332 UINT8 Length;\r
333 UINT8 AcpiProcessorId;\r
334 UINT16 Flags;\r
335 UINT8 LocalApicInti;\r
336} EFI_ACPI_1_0_LOCAL_APIC_NMI_STRUCTURE;\r
337\r
1bc5d021 338///\r
339/// Smart Battery Description Table (SBST)\r
340///\r
568eb0cb 341typedef struct {\r
342 EFI_ACPI_DESCRIPTION_HEADER Header;\r
343 UINT32 WarningEnergyLevel;\r
344 UINT32 LowEnergyLevel;\r
345 UINT32 CriticalEnergyLevel;\r
346} EFI_ACPI_1_0_SMART_BATTERY_DESCRIPTION_TABLE;\r
347\r
348//\r
349// Known table signatures\r
350//\r
1bc5d021 351\r
352///\r
353/// "RSD PTR " Root System Description Pointer\r
354///\r
13c31065 355#define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ')\r
568eb0cb 356\r
1bc5d021 357///\r
358/// "APIC" Multiple APIC Description Table\r
359///\r
13c31065 360#define EFI_ACPI_1_0_APIC_SIGNATURE SIGNATURE_32('A', 'P', 'I', 'C')\r
568eb0cb 361\r
1bc5d021 362///\r
363/// "DSDT" Differentiated System Description Table\r
364///\r
13c31065 365#define EFI_ACPI_1_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('D', 'S', 'D', 'T')\r
568eb0cb 366\r
1bc5d021 367///\r
368/// "FACS" Firmware ACPI Control Structure\r
369///\r
13c31065 370#define EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE SIGNATURE_32('F', 'A', 'C', 'S')\r
568eb0cb 371\r
1bc5d021 372///\r
373/// "FACP" Fixed ACPI Description Table\r
374///\r
13c31065 375#define EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('F', 'A', 'C', 'P')\r
568eb0cb 376\r
1bc5d021 377///\r
378/// "PSDT" Persistent System Description Table\r
379///\r
13c31065 380#define EFI_ACPI_1_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('P', 'S', 'D', 'T')\r
568eb0cb 381\r
1bc5d021 382///\r
383/// "RSDT" Root System Description Table\r
384///\r
13c31065 385#define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('R', 'S', 'D', 'T')\r
568eb0cb 386\r
1bc5d021 387///\r
388/// "SBST" Smart Battery Specification Table\r
389///\r
13c31065 390#define EFI_ACPI_1_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE SIGNATURE_32('S', 'B', 'S', 'T')\r
568eb0cb 391\r
1bc5d021 392///\r
393/// "SSDT" Secondary System Description Table\r
394///\r
13c31065 395#define EFI_ACPI_1_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('S', 'S', 'D', 'T')\r
568eb0cb 396\r
766f4bc1 397#pragma pack()\r
398\r
568eb0cb 399#endif\r
EFI Development Kit II mirror for PVE