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