VirtualBox

source: vbox/trunk/src/VBox/Devices/EFI/FirmwareOld/MdePkg/Include/IndustryStandard/Acpi50.h@ 59775

Last change on this file since 59775 was 48674, checked in by vboxsync, 12 years ago

EFI: Export newly imported tinaocore UEFI sources to OSE.
  • Property svn:eol-style set to native
File size: 69.4 KB
Line 
1/** @file
2 ACPI 5.0 definitions from the ACPI Specification Revision 5.0 December 6, 2011
3
4 Copyright (c) 2011 - 2012, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12**/
13
14#ifndef _ACPI_5_0_H_
15#define _ACPI_5_0_H_
16
17#include <IndustryStandard/Acpi40.h>
18
19//
20// Define for Desriptor
21//
22#define ACPI_SMALL_FIXED_DMA_DESCRIPTOR_NAME 0x0A
23#define ACPI_LARGE_GPIO_CONNECTION_DESCRIPTOR_NAME 0x0C
24#define ACPI_LARGE_GENERIC_SERIAL_BUS_CONNECTION_DESCRIPTOR_NAME 0x0E
25
26#define ACPI_FIXED_DMA_DESCRIPTOR 0x55
27#define ACPI_GPIO_CONNECTION_DESCRIPTOR 0x8C
28#define ACPI_GENERIC_SERIAL_BUS_CONNECTION_DESCRIPTOR 0x8E
29
30#pragma pack(1)
31
32///
33/// Generic DMA Descriptor.
34///
35typedef PACKED struct {
36 ACPI_SMALL_RESOURCE_HEADER Header;
37 UINT16 DmaRequestLine;
38 UINT16 DmaChannel;
39 UINT8 DmaTransferWidth;
40} EFI_ACPI_FIXED_DMA_DESCRIPTOR;
41
42///
43/// GPIO Connection Descriptor
44///
45typedef PACKED struct {
46 ACPI_LARGE_RESOURCE_HEADER Header;
47 UINT8 RevisionId;
48 UINT8 ConnectionType;
49 UINT16 GeneralFlags;
50 UINT16 InterruptFlags;
51 UINT8 PinConfiguration;
52 UINT16 OutputDriveStrength;
53 UINT16 DebounceTimeout;
54 UINT16 PinTableOffset;
55 UINT8 ResourceSourceIndex;
56 UINT16 ResourceSourceNameOffset;
57 UINT16 VendorDataOffset;
58 UINT16 VendorDataLength;
59} EFI_ACPI_GPIO_CONNECTION_DESCRIPTOR;
60
61#define EFI_ACPI_GPIO_CONNECTION_TYPE_INTERRUPT 0x0
62#define EFI_ACPI_GPIO_CONNECTION_TYPE_IO 0x1
63
64///
65/// Serial Bus Resource Descriptor (Generic)
66///
67typedef PACKED struct {
68 ACPI_LARGE_RESOURCE_HEADER Header;
69 UINT8 RevisionId;
70 UINT8 ResourceSourceIndex;
71 UINT8 SerialBusType;
72 UINT8 GeneralFlags;
73 UINT16 TypeSpecificFlags;
74 UINT8 TypeSpecificRevisionId;
75 UINT16 TypeDataLength;
76// Type specific data
77} EFI_ACPI_SERIAL_BUS_RESOURCE_DESCRIPTOR;
78
79#define EFI_ACPI_SERIAL_BUS_RESOURCE_TYPE_I2C 0x1
80#define EFI_ACPI_SERIAL_BUS_RESOURCE_TYPE_SPI 0x2
81#define EFI_ACPI_SERIAL_BUS_RESOURCE_TYPE_UART 0x3
82
83///
84/// Serial Bus Resource Descriptor (I2C)
85///
86typedef PACKED struct {
87 ACPI_LARGE_RESOURCE_HEADER Header;
88 UINT8 RevisionId;
89 UINT8 ResourceSourceIndex;
90 UINT8 SerialBusType;
91 UINT8 GeneralFlags;
92 UINT16 TypeSpecificFlags;
93 UINT8 TypeSpecificRevisionId;
94 UINT16 TypeDataLength;
95 UINT32 ConnectionSpeed;
96 UINT16 SlaveAddress;
97} EFI_ACPI_SERIAL_BUS_RESOURCE_I2C_DESCRIPTOR;
98
99///
100/// Serial Bus Resource Descriptor (SPI)
101///
102typedef PACKED struct {
103 ACPI_LARGE_RESOURCE_HEADER Header;
104 UINT8 RevisionId;
105 UINT8 ResourceSourceIndex;
106 UINT8 SerialBusType;
107 UINT8 GeneralFlags;
108 UINT16 TypeSpecificFlags;
109 UINT8 TypeSpecificRevisionId;
110 UINT16 TypeDataLength;
111 UINT32 ConnectionSpeed;
112 UINT8 DataBitLength;
113 UINT8 Phase;
114 UINT8 Polarity;
115 UINT16 DeviceSelection;
116} EFI_ACPI_SERIAL_BUS_RESOURCE_SPI_DESCRIPTOR;
117
118///
119/// Serial Bus Resource Descriptor (UART)
120///
121typedef PACKED struct {
122 ACPI_LARGE_RESOURCE_HEADER Header;
123 UINT8 RevisionId;
124 UINT8 ResourceSourceIndex;
125 UINT8 SerialBusType;
126 UINT8 GeneralFlags;
127 UINT16 TypeSpecificFlags;
128 UINT8 TypeSpecificRevisionId;
129 UINT16 TypeDataLength;
130 UINT32 DefaultBaudRate;
131 UINT16 RxFIFO;
132 UINT16 TxFIFO;
133 UINT8 Parity;
134 UINT8 SerialLinesEnabled;
135} EFI_ACPI_SERIAL_BUS_RESOURCE_UART_DESCRIPTOR;
136
137#pragma pack()
138
139//
140// Ensure proper structure formats
141//
142#pragma pack(1)
143
144///
145/// ACPI 5.0 Generic Address Space definition
146///
147typedef struct {
148 UINT8 AddressSpaceId;
149 UINT8 RegisterBitWidth;
150 UINT8 RegisterBitOffset;
151 UINT8 AccessSize;
152 UINT64 Address;
153} EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE;
154
155//
156// Generic Address Space Address IDs
157//
158#define EFI_ACPI_5_0_SYSTEM_MEMORY 0
159#define EFI_ACPI_5_0_SYSTEM_IO 1
160#define EFI_ACPI_5_0_PCI_CONFIGURATION_SPACE 2
161#define EFI_ACPI_5_0_EMBEDDED_CONTROLLER 3
162#define EFI_ACPI_5_0_SMBUS 4
163#define EFI_ACPI_5_0_FUNCTIONAL_FIXED_HARDWARE 0x7F
164
165//
166// Generic Address Space Access Sizes
167//
168#define EFI_ACPI_5_0_UNDEFINED 0
169#define EFI_ACPI_5_0_BYTE 1
170#define EFI_ACPI_5_0_WORD 2
171#define EFI_ACPI_5_0_DWORD 3
172#define EFI_ACPI_5_0_QWORD 4
173
174//
175// ACPI 5.0 table structures
176//
177
178///
179/// Root System Description Pointer Structure
180///
181typedef struct {
182 UINT64 Signature;
183 UINT8 Checksum;
184 UINT8 OemId[6];
185 UINT8 Revision;
186 UINT32 RsdtAddress;
187 UINT32 Length;
188 UINT64 XsdtAddress;
189 UINT8 ExtendedChecksum;
190 UINT8 Reserved[3];
191} EFI_ACPI_5_0_ROOT_SYSTEM_DESCRIPTION_POINTER;
192
193///
194/// RSD_PTR Revision (as defined in ACPI 5.0 spec.)
195///
196#define EFI_ACPI_5_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02 ///< ACPISpec (Revision 5.0) says current value is 2
197
198///
199/// Common table header, this prefaces all ACPI tables, including FACS, but
200/// excluding the RSD PTR structure
201///
202typedef struct {
203 UINT32 Signature;
204 UINT32 Length;
205} EFI_ACPI_5_0_COMMON_HEADER;
206
207//
208// Root System Description Table
209// No definition needed as it is a common description table header, the same with
210// EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT32 table pointers.
211//
212
213///
214/// RSDT Revision (as defined in ACPI 5.0 spec.)
215///
216#define EFI_ACPI_5_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
217
218//
219// Extended System Description Table
220// No definition needed as it is a common description table header, the same with
221// EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT64 table pointers.
222//
223
224///
225/// XSDT Revision (as defined in ACPI 5.0 spec.)
226///
227#define EFI_ACPI_5_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
228
229///
230/// Fixed ACPI Description Table Structure (FADT)
231///
232typedef struct {
233 EFI_ACPI_DESCRIPTION_HEADER Header;
234 UINT32 FirmwareCtrl;
235 UINT32 Dsdt;
236 UINT8 Reserved0;
237 UINT8 PreferredPmProfile;
238 UINT16 SciInt;
239 UINT32 SmiCmd;
240 UINT8 AcpiEnable;
241 UINT8 AcpiDisable;
242 UINT8 S4BiosReq;
243 UINT8 PstateCnt;
244 UINT32 Pm1aEvtBlk;
245 UINT32 Pm1bEvtBlk;
246 UINT32 Pm1aCntBlk;
247 UINT32 Pm1bCntBlk;
248 UINT32 Pm2CntBlk;
249 UINT32 PmTmrBlk;
250 UINT32 Gpe0Blk;
251 UINT32 Gpe1Blk;
252 UINT8 Pm1EvtLen;
253 UINT8 Pm1CntLen;
254 UINT8 Pm2CntLen;
255 UINT8 PmTmrLen;
256 UINT8 Gpe0BlkLen;
257 UINT8 Gpe1BlkLen;
258 UINT8 Gpe1Base;
259 UINT8 CstCnt;
260 UINT16 PLvl2Lat;
261 UINT16 PLvl3Lat;
262 UINT16 FlushSize;
263 UINT16 FlushStride;
264 UINT8 DutyOffset;
265 UINT8 DutyWidth;
266 UINT8 DayAlrm;
267 UINT8 MonAlrm;
268 UINT8 Century;
269 UINT16 IaPcBootArch;
270 UINT8 Reserved1;
271 UINT32 Flags;
272 EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE ResetReg;
273 UINT8 ResetValue;
274 UINT8 Reserved2[3];
275 UINT64 XFirmwareCtrl;
276 UINT64 XDsdt;
277 EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk;
278 EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk;
279 EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk;
280 EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk;
281 EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk;
282 EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk;
283 EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE XGpe0Blk;
284 EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE XGpe1Blk;
285 EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE SleepControlReg;
286 EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE SleepStatusReg;
287} EFI_ACPI_5_0_FIXED_ACPI_DESCRIPTION_TABLE;
288
289///
290/// FADT Version (as defined in ACPI 5.0 spec.)
291///
292#define EFI_ACPI_5_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x05
293
294//
295// Fixed ACPI Description Table Preferred Power Management Profile
296//
297#define EFI_ACPI_5_0_PM_PROFILE_UNSPECIFIED 0
298#define EFI_ACPI_5_0_PM_PROFILE_DESKTOP 1
299#define EFI_ACPI_5_0_PM_PROFILE_MOBILE 2
300#define EFI_ACPI_5_0_PM_PROFILE_WORKSTATION 3
301#define EFI_ACPI_5_0_PM_PROFILE_ENTERPRISE_SERVER 4
302#define EFI_ACPI_5_0_PM_PROFILE_SOHO_SERVER 5
303#define EFI_ACPI_5_0_PM_PROFILE_APPLIANCE_PC 6
304#define EFI_ACPI_5_0_PM_PROFILE_PERFORMANCE_SERVER 7
305#define EFI_ACPI_5_0_PM_PROFILE_TABLET 8
306
307//
308// Fixed ACPI Description Table Boot Architecture Flags
309// All other bits are reserved and must be set to 0.
310//
311#define EFI_ACPI_5_0_LEGACY_DEVICES BIT0
312#define EFI_ACPI_5_0_8042 BIT1
313#define EFI_ACPI_5_0_VGA_NOT_PRESENT BIT2
314#define EFI_ACPI_5_0_MSI_NOT_SUPPORTED BIT3
315#define EFI_ACPI_5_0_PCIE_ASPM_CONTROLS BIT4
316#define EFI_ACPI_5_0_CMOS_RTC_NOT_PRESENT BIT5
317
318//
319// Fixed ACPI Description Table Fixed Feature Flags
320// All other bits are reserved and must be set to 0.
321//
322#define EFI_ACPI_5_0_WBINVD BIT0
323#define EFI_ACPI_5_0_WBINVD_FLUSH BIT1
324#define EFI_ACPI_5_0_PROC_C1 BIT2
325#define EFI_ACPI_5_0_P_LVL2_UP BIT3
326#define EFI_ACPI_5_0_PWR_BUTTON BIT4
327#define EFI_ACPI_5_0_SLP_BUTTON BIT5
328#define EFI_ACPI_5_0_FIX_RTC BIT6
329#define EFI_ACPI_5_0_RTC_S4 BIT7
330#define EFI_ACPI_5_0_TMR_VAL_EXT BIT8
331#define EFI_ACPI_5_0_DCK_CAP BIT9
332#define EFI_ACPI_5_0_RESET_REG_SUP BIT10
333#define EFI_ACPI_5_0_SEALED_CASE BIT11
334#define EFI_ACPI_5_0_HEADLESS BIT12
335#define EFI_ACPI_5_0_CPU_SW_SLP BIT13
336#define EFI_ACPI_5_0_PCI_EXP_WAK BIT14
337#define EFI_ACPI_5_0_USE_PLATFORM_CLOCK BIT15
338#define EFI_ACPI_5_0_S4_RTC_STS_VALID BIT16
339#define EFI_ACPI_5_0_REMOTE_POWER_ON_CAPABLE BIT17
340#define EFI_ACPI_5_0_FORCE_APIC_CLUSTER_MODEL BIT18
341#define EFI_ACPI_5_0_FORCE_APIC_PHYSICAL_DESTINATION_MODE BIT19
342#define EFI_ACPI_5_0_HW_REDUCED_ACPI BIT20
343#define EFI_ACPI_5_0_LOW_POWER_S0_IDLE_CAPABLE BIT21
344
345///
346/// Firmware ACPI Control Structure
347///
348typedef struct {
349 UINT32 Signature;
350 UINT32 Length;
351 UINT32 HardwareSignature;
352 UINT32 FirmwareWakingVector;
353 UINT32 GlobalLock;
354 UINT32 Flags;
355 UINT64 XFirmwareWakingVector;
356 UINT8 Version;
357 UINT8 Reserved0[3];
358 UINT32 OspmFlags;
359 UINT8 Reserved1[24];
360} EFI_ACPI_5_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;
361
362///
363/// FACS Version (as defined in ACPI 5.0 spec.)
364///
365#define EFI_ACPI_5_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION 0x02
366
367///
368/// Firmware Control Structure Feature Flags
369/// All other bits are reserved and must be set to 0.
370///
371#define EFI_ACPI_5_0_S4BIOS_F BIT0
372#define EFI_ACPI_5_0_64BIT_WAKE_SUPPORTED_F BIT1
373
374///
375/// OSPM Enabled Firmware Control Structure Flags
376/// All other bits are reserved and must be set to 0.
377///
378#define EFI_ACPI_5_0_OSPM_64BIT_WAKE_F BIT0
379
380//
381// Differentiated System Description Table,
382// Secondary System Description Table
383// and Persistent System Description Table,
384// no definition needed as they are common description table header, the same with
385// EFI_ACPI_DESCRIPTION_HEADER, followed by a definition block.
386//
387#define EFI_ACPI_5_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
388#define EFI_ACPI_5_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
389
390///
391/// Multiple APIC Description Table header definition. The rest of the table
392/// must be defined in a platform specific manner.
393///
394typedef struct {
395 EFI_ACPI_DESCRIPTION_HEADER Header;
396 UINT32 LocalApicAddress;
397 UINT32 Flags;
398} EFI_ACPI_5_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;
399
400///
401/// MADT Revision (as defined in ACPI 5.0 spec.)
402///
403#define EFI_ACPI_5_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x03
404
405///
406/// Multiple APIC Flags
407/// All other bits are reserved and must be set to 0.
408///
409#define EFI_ACPI_5_0_PCAT_COMPAT BIT0
410
411//
412// Multiple APIC Description Table APIC structure types
413// All other values between 0x0D and 0x7F are reserved and
414// will be ignored by OSPM. 0x80 ~ 0xFF are reserved for OEM.
415//
416#define EFI_ACPI_5_0_PROCESSOR_LOCAL_APIC 0x00
417#define EFI_ACPI_5_0_IO_APIC 0x01
418#define EFI_ACPI_5_0_INTERRUPT_SOURCE_OVERRIDE 0x02
419#define EFI_ACPI_5_0_NON_MASKABLE_INTERRUPT_SOURCE 0x03
420#define EFI_ACPI_5_0_LOCAL_APIC_NMI 0x04
421#define EFI_ACPI_5_0_LOCAL_APIC_ADDRESS_OVERRIDE 0x05
422#define EFI_ACPI_5_0_IO_SAPIC 0x06
423#define EFI_ACPI_5_0_LOCAL_SAPIC 0x07
424#define EFI_ACPI_5_0_PLATFORM_INTERRUPT_SOURCES 0x08
425#define EFI_ACPI_5_0_PROCESSOR_LOCAL_X2APIC 0x09
426#define EFI_ACPI_5_0_LOCAL_X2APIC_NMI 0x0A
427#define EFI_ACPI_5_0_GIC 0x0B
428#define EFI_ACPI_5_0_GICD 0x0C
429
430//
431// APIC Structure Definitions
432//
433
434///
435/// Processor Local APIC Structure Definition
436///
437typedef struct {
438 UINT8 Type;
439 UINT8 Length;
440 UINT8 AcpiProcessorId;
441 UINT8 ApicId;
442 UINT32 Flags;
443} EFI_ACPI_5_0_PROCESSOR_LOCAL_APIC_STRUCTURE;
444
445///
446/// Local APIC Flags. All other bits are reserved and must be 0.
447///
448#define EFI_ACPI_5_0_LOCAL_APIC_ENABLED BIT0
449
450///
451/// IO APIC Structure
452///
453typedef struct {
454 UINT8 Type;
455 UINT8 Length;
456 UINT8 IoApicId;
457 UINT8 Reserved;
458 UINT32 IoApicAddress;
459 UINT32 GlobalSystemInterruptBase;
460} EFI_ACPI_5_0_IO_APIC_STRUCTURE;
461
462///
463/// Interrupt Source Override Structure
464///
465typedef struct {
466 UINT8 Type;
467 UINT8 Length;
468 UINT8 Bus;
469 UINT8 Source;
470 UINT32 GlobalSystemInterrupt;
471 UINT16 Flags;
472} EFI_ACPI_5_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;
473
474///
475/// Platform Interrupt Sources Structure Definition
476///
477typedef struct {
478 UINT8 Type;
479 UINT8 Length;
480 UINT16 Flags;
481 UINT8 InterruptType;
482 UINT8 ProcessorId;
483 UINT8 ProcessorEid;
484 UINT8 IoSapicVector;
485 UINT32 GlobalSystemInterrupt;
486 UINT32 PlatformInterruptSourceFlags;
487 UINT8 CpeiProcessorOverride;
488 UINT8 Reserved[31];
489} EFI_ACPI_5_0_PLATFORM_INTERRUPT_APIC_STRUCTURE;
490
491//
492// MPS INTI flags.
493// All other bits are reserved and must be set to 0.
494//
495#define EFI_ACPI_5_0_POLARITY (3 << 0)
496#define EFI_ACPI_5_0_TRIGGER_MODE (3 << 2)
497
498///
499/// Non-Maskable Interrupt Source Structure
500///
501typedef struct {
502 UINT8 Type;
503 UINT8 Length;
504 UINT16 Flags;
505 UINT32 GlobalSystemInterrupt;
506} EFI_ACPI_5_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;
507
508///
509/// Local APIC NMI Structure
510///
511typedef struct {
512 UINT8 Type;
513 UINT8 Length;
514 UINT8 AcpiProcessorId;
515 UINT16 Flags;
516 UINT8 LocalApicLint;
517} EFI_ACPI_5_0_LOCAL_APIC_NMI_STRUCTURE;
518
519///
520/// Local APIC Address Override Structure
521///
522typedef struct {
523 UINT8 Type;
524 UINT8 Length;
525 UINT16 Reserved;
526 UINT64 LocalApicAddress;
527} EFI_ACPI_5_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE;
528
529///
530/// IO SAPIC Structure
531///
532typedef struct {
533 UINT8 Type;
534 UINT8 Length;
535 UINT8 IoApicId;
536 UINT8 Reserved;
537 UINT32 GlobalSystemInterruptBase;
538 UINT64 IoSapicAddress;
539} EFI_ACPI_5_0_IO_SAPIC_STRUCTURE;
540
541///
542/// Local SAPIC Structure
543/// This struct followed by a null-terminated ASCII string - ACPI Processor UID String
544///
545typedef struct {
546 UINT8 Type;
547 UINT8 Length;
548 UINT8 AcpiProcessorId;
549 UINT8 LocalSapicId;
550 UINT8 LocalSapicEid;
551 UINT8 Reserved[3];
552 UINT32 Flags;
553 UINT32 ACPIProcessorUIDValue;
554} EFI_ACPI_5_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE;
555
556///
557/// Platform Interrupt Sources Structure
558///
559typedef struct {
560 UINT8 Type;
561 UINT8 Length;
562 UINT16 Flags;
563 UINT8 InterruptType;
564 UINT8 ProcessorId;
565 UINT8 ProcessorEid;
566 UINT8 IoSapicVector;
567 UINT32 GlobalSystemInterrupt;
568 UINT32 PlatformInterruptSourceFlags;
569} EFI_ACPI_5_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE;
570
571///
572/// Platform Interrupt Source Flags.
573/// All other bits are reserved and must be set to 0.
574///
575#define EFI_ACPI_5_0_CPEI_PROCESSOR_OVERRIDE BIT0
576
577///
578/// Processor Local x2APIC Structure Definition
579///
580typedef struct {
581 UINT8 Type;
582 UINT8 Length;
583 UINT8 Reserved[2];
584 UINT32 X2ApicId;
585 UINT32 Flags;
586 UINT32 AcpiProcessorUid;
587} EFI_ACPI_5_0_PROCESSOR_LOCAL_X2APIC_STRUCTURE;
588
589///
590/// Local x2APIC NMI Structure
591///
592typedef struct {
593 UINT8 Type;
594 UINT8 Length;
595 UINT16 Flags;
596 UINT32 AcpiProcessorUid;
597 UINT8 LocalX2ApicLint;
598 UINT8 Reserved[3];
599} EFI_ACPI_5_0_LOCAL_X2APIC_NMI_STRUCTURE;
600
601///
602/// GIC Structure
603///
604typedef struct {
605 UINT8 Type;
606 UINT8 Length;
607 UINT16 Reserved;
608 UINT32 GicId;
609 UINT32 AcpiProcessorUid;
610 UINT32 Flags;
611 UINT32 ParkingProtocolVersion;
612 UINT32 PerformanceInterruptGsiv;
613 UINT64 ParkedAddress;
614 UINT64 PhysicalBaseAddress;
615} EFI_ACPI_5_0_GIC_STRUCTURE;
616
617///
618/// GIC Flags. All other bits are reserved and must be 0.
619///
620#define EFI_ACPI_5_0_GIC_ENABLED BIT0
621#define EFI_ACPI_5_0_PERFORMANCE_INTERRUPT_MODEL BIT1
622
623///
624/// GIC Distributor Structure
625///
626typedef struct {
627 UINT8 Type;
628 UINT8 Length;
629 UINT16 Reserved1;
630 UINT32 GicId;
631 UINT64 PhysicalBaseAddress;
632 UINT32 SystemVectorBase;
633 UINT32 Reserved2;
634} EFI_ACPI_5_0_GIC_DISTRIBUTOR_STRUCTURE;
635
636///
637/// Smart Battery Description Table (SBST)
638///
639typedef struct {
640 EFI_ACPI_DESCRIPTION_HEADER Header;
641 UINT32 WarningEnergyLevel;
642 UINT32 LowEnergyLevel;
643 UINT32 CriticalEnergyLevel;
644} EFI_ACPI_5_0_SMART_BATTERY_DESCRIPTION_TABLE;
645
646///
647/// SBST Version (as defined in ACPI 5.0 spec.)
648///
649#define EFI_ACPI_5_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01
650
651///
652/// Embedded Controller Boot Resources Table (ECDT)
653/// The table is followed by a null terminated ASCII string that contains
654/// a fully qualified reference to the name space object.
655///
656typedef struct {
657 EFI_ACPI_DESCRIPTION_HEADER Header;
658 EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE EcControl;
659 EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE EcData;
660 UINT32 Uid;
661 UINT8 GpeBit;
662} EFI_ACPI_5_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE;
663
664///
665/// ECDT Version (as defined in ACPI 5.0 spec.)
666///
667#define EFI_ACPI_5_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_REVISION 0x01
668
669///
670/// System Resource Affinity Table (SRAT). The rest of the table
671/// must be defined in a platform specific manner.
672///
673typedef struct {
674 EFI_ACPI_DESCRIPTION_HEADER Header;
675 UINT32 Reserved1; ///< Must be set to 1
676 UINT64 Reserved2;
677} EFI_ACPI_5_0_SYSTEM_RESOURCE_AFFINITY_TABLE_HEADER;
678
679///
680/// SRAT Version (as defined in ACPI 5.0 spec.)
681///
682#define EFI_ACPI_5_0_SYSTEM_RESOURCE_AFFINITY_TABLE_REVISION 0x03
683
684//
685// SRAT structure types.
686// All other values between 0x03 an 0xFF are reserved and
687// will be ignored by OSPM.
688//
689#define EFI_ACPI_5_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY 0x00
690#define EFI_ACPI_5_0_MEMORY_AFFINITY 0x01
691#define EFI_ACPI_5_0_PROCESSOR_LOCAL_X2APIC_AFFINITY 0x02
692
693///
694/// Processor Local APIC/SAPIC Affinity Structure Definition
695///
696typedef struct {
697 UINT8 Type;
698 UINT8 Length;
699 UINT8 ProximityDomain7To0;
700 UINT8 ApicId;
701 UINT32 Flags;
702 UINT8 LocalSapicEid;
703 UINT8 ProximityDomain31To8[3];
704 UINT32 ClockDomain;
705} EFI_ACPI_5_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY_STRUCTURE;
706
707///
708/// Local APIC/SAPIC Flags. All other bits are reserved and must be 0.
709///
710#define EFI_ACPI_5_0_PROCESSOR_LOCAL_APIC_SAPIC_ENABLED (1 << 0)
711
712///
713/// Memory Affinity Structure Definition
714///
715typedef struct {
716 UINT8 Type;
717 UINT8 Length;
718 UINT32 ProximityDomain;
719 UINT16 Reserved1;
720 UINT32 AddressBaseLow;
721 UINT32 AddressBaseHigh;
722 UINT32 LengthLow;
723 UINT32 LengthHigh;
724 UINT32 Reserved2;
725 UINT32 Flags;
726 UINT64 Reserved3;
727} EFI_ACPI_5_0_MEMORY_AFFINITY_STRUCTURE;
728
729//
730// Memory Flags. All other bits are reserved and must be 0.
731//
732#define EFI_ACPI_5_0_MEMORY_ENABLED (1 << 0)
733#define EFI_ACPI_5_0_MEMORY_HOT_PLUGGABLE (1 << 1)
734#define EFI_ACPI_5_0_MEMORY_NONVOLATILE (1 << 2)
735
736///
737/// Processor Local x2APIC Affinity Structure Definition
738///
739typedef struct {
740 UINT8 Type;
741 UINT8 Length;
742 UINT8 Reserved1[2];
743 UINT32 ProximityDomain;
744 UINT32 X2ApicId;
745 UINT32 Flags;
746 UINT32 ClockDomain;
747 UINT8 Reserved2[4];
748} EFI_ACPI_5_0_PROCESSOR_LOCAL_X2APIC_AFFINITY_STRUCTURE;
749
750///
751/// System Locality Distance Information Table (SLIT).
752/// The rest of the table is a matrix.
753///
754typedef struct {
755 EFI_ACPI_DESCRIPTION_HEADER Header;
756 UINT64 NumberOfSystemLocalities;
757} EFI_ACPI_5_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_HEADER;
758
759///
760/// SLIT Version (as defined in ACPI 5.0 spec.)
761///
762#define EFI_ACPI_5_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_REVISION 0x01
763
764///
765/// Corrected Platform Error Polling Table (CPEP)
766///
767typedef struct {
768 EFI_ACPI_DESCRIPTION_HEADER Header;
769 UINT8 Reserved[8];
770} EFI_ACPI_5_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_HEADER;
771
772///
773/// CPEP Version (as defined in ACPI 5.0 spec.)
774///
775#define EFI_ACPI_5_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_REVISION 0x01
776
777//
778// CPEP processor structure types.
779//
780#define EFI_ACPI_5_0_CPEP_PROCESSOR_APIC_SAPIC 0x00
781
782///
783/// Corrected Platform Error Polling Processor Structure Definition
784///
785typedef struct {
786 UINT8 Type;
787 UINT8 Length;
788 UINT8 ProcessorId;
789 UINT8 ProcessorEid;
790 UINT32 PollingInterval;
791} EFI_ACPI_5_0_CPEP_PROCESSOR_APIC_SAPIC_STRUCTURE;
792
793///
794/// Maximum System Characteristics Table (MSCT)
795///
796typedef struct {
797 EFI_ACPI_DESCRIPTION_HEADER Header;
798 UINT32 OffsetProxDomInfo;
799 UINT32 MaximumNumberOfProximityDomains;
800 UINT32 MaximumNumberOfClockDomains;
801 UINT64 MaximumPhysicalAddress;
802} EFI_ACPI_5_0_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_HEADER;
803
804///
805/// MSCT Version (as defined in ACPI 5.0 spec.)
806///
807#define EFI_ACPI_5_0_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_REVISION 0x01
808
809///
810/// Maximum Proximity Domain Information Structure Definition
811///
812typedef struct {
813 UINT8 Revision;
814 UINT8 Length;
815 UINT32 ProximityDomainRangeLow;
816 UINT32 ProximityDomainRangeHigh;
817 UINT32 MaximumProcessorCapacity;
818 UINT64 MaximumMemoryCapacity;
819} EFI_ACPI_5_0_MAXIMUM_PROXIMITY_DOMAIN_INFORMATION_STRUCTURE;
820
821///
822/// ACPI RAS Feature Table definition.
823///
824typedef struct {
825 EFI_ACPI_DESCRIPTION_HEADER Header;
826 UINT8 PlatformCommunicationChannelIdentifier[12];
827} EFI_ACPI_5_0_RAS_FEATURE_TABLE;
828
829///
830/// RASF Version (as defined in ACPI 5.0 spec.)
831///
832#define EFI_ACPI_5_0_RAS_FEATURE_TABLE_REVISION 0x01
833
834///
835/// ACPI RASF Platform Communication Channel Shared Memory Region definition.
836///
837typedef struct {
838 UINT32 Signature;
839 UINT16 Command;
840 UINT16 Status;
841 UINT16 Version;
842 UINT8 RASCapabilities[16];
843 UINT8 SetRASCapabilities[16];
844 UINT16 NumberOfRASFParameterBlocks;
845 UINT32 SetRASCapabilitiesStatus;
846} EFI_ACPI_5_0_RASF_PLATFORM_COMMUNICATION_CHANNEL_SHARED_MEMORY_REGION;
847
848///
849/// ACPI RASF PCC command code
850///
851#define EFI_ACPI_5_0_RASF_PCC_COMMAND_CODE_EXECUTE_RASF_COMMAND 0x01
852
853///
854/// ACPI RASF Platform RAS Capabilities
855///
856#define EFI_ACPI_5_0_RASF_PLATFORM_RAS_CAPABILITY_HARDWARE_BASED_PATROL_SCRUB_SUPPOTED 0x01
857#define EFI_ACPI_5_0_RASF_PLATFORM_RAS_CAPABILITY_HARDWARE_BASED_PATROL_SCRUB_SUPPOTED_AND_EXPOSED_TO_SOFTWARE 0x02
858
859///
860/// ACPI RASF Parameter Block structure for PATROL_SCRUB
861///
862typedef struct {
863 UINT16 Type;
864 UINT16 Version;
865 UINT16 Length;
866 UINT16 PatrolScrubCommand;
867 UINT64 RequestedAddressRange[2];
868 UINT64 ActualAddressRange[2];
869 UINT16 Flags;
870 UINT8 RequestedSpeed;
871} EFI_ACPI_5_0_RASF_PATROL_SCRUB_PLATFORM_BLOCK_STRUCTURE;
872
873///
874/// ACPI RASF Patrol Scrub command
875///
876#define EFI_ACPI_5_0_RASF_PATROL_SCRUB_COMMAND_GET_PATROL_PARAMETERS 0x01
877#define EFI_ACPI_5_0_RASF_PATROL_SCRUB_COMMAND_START_PATROL_SCRUBBER 0x02
878#define EFI_ACPI_5_0_RASF_PATROL_SCRUB_COMMAND_STOP_PATROL_SCRUBBER 0x03
879
880///
881/// Memory Power State Table definition.
882///
883typedef struct {
884 EFI_ACPI_DESCRIPTION_HEADER Header;
885 UINT8 PlatformCommunicationChannelIdentifier;
886 UINT8 Reserved[3];
887// Memory Power Node Structure
888// Memory Power State Characteristics
889} EFI_ACPI_5_0_MEMORY_POWER_STATUS_TABLE;
890
891///
892/// MPST Version (as defined in ACPI 5.0 spec.)
893///
894#define EFI_ACPI_5_0_MEMORY_POWER_STATE_TABLE_REVISION 0x01
895
896///
897/// MPST Platform Communication Channel Shared Memory Region definition.
898///
899typedef struct {
900 UINT32 Signature;
901 UINT16 Command;
902 UINT16 Status;
903 UINT32 MemoryPowerCommandRegister;
904 UINT32 MemoryPowerStatusRegister;
905 UINT32 PowerStateId;
906 UINT32 MemoryPowerNodeId;
907 UINT64 MemoryEnergyConsumed;
908 UINT64 ExpectedAveragePowerComsuned;
909} EFI_ACPI_5_0_MPST_PLATFORM_COMMUNICATION_CHANNEL_SHARED_MEMORY_REGION;
910
911///
912/// ACPI MPST PCC command code
913///
914#define EFI_ACPI_5_0_MPST_PCC_COMMAND_CODE_EXECUTE_MPST_COMMAND 0x03
915
916///
917/// ACPI MPST Memory Power command
918///
919#define EFI_ACPI_5_0_MPST_MEMORY_POWER_COMMAND_GET_MEMORY_POWER_STATE 0x01
920#define EFI_ACPI_5_0_MPST_MEMORY_POWER_COMMAND_SET_MEMORY_POWER_STATE 0x02
921#define EFI_ACPI_5_0_MPST_MEMORY_POWER_COMMAND_GET_AVERAGE_POWER_CONSUMED 0x03
922#define EFI_ACPI_5_0_MPST_MEMORY_POWER_COMMAND_GET_MEMORY_ENERGY_CONSUMED 0x04
923
924///
925/// MPST Memory Power Node Table
926///
927typedef struct {
928 UINT8 PowerStateValue;
929 UINT8 PowerStateInformationIndex;
930} EFI_ACPI_5_0_MPST_MEMORY_POWER_STATE;
931
932typedef struct {
933 UINT8 Flag;
934 UINT8 Reserved;
935 UINT16 MemoryPowerNodeId;
936 UINT32 Length;
937 UINT64 AddressBase;
938 UINT64 AddressLength;
939 UINT32 NumberOfPowerStates;
940 UINT32 NumberOfPhysicalComponents;
941//EFI_ACPI_5_0_MPST_MEMORY_POWER_STATE MemoryPowerState[NumberOfPowerStates];
942//UINT16 PhysicalComponentIdentifier[NumberOfPhysicalComponents];
943} EFI_ACPI_5_0_MPST_MEMORY_POWER_STRUCTURE;
944
945#define EFI_ACPI_5_0_MPST_MEMORY_POWER_STRUCTURE_FLAG_ENABLE 0x01
946#define EFI_ACPI_5_0_MPST_MEMORY_POWER_STRUCTURE_FLAG_POWER_MANAGED 0x02
947#define EFI_ACPI_5_0_MPST_MEMORY_POWER_STRUCTURE_FLAG_HOT_PLUGGABLE 0x04
948
949typedef struct {
950 UINT16 MemoryPowerNodeCount;
951 UINT8 Reserved[2];
952} EFI_ACPI_5_0_MPST_MEMORY_POWER_NODE_TABLE;
953
954///
955/// MPST Memory Power State Characteristics Table
956///
957typedef struct {
958 UINT8 PowerStateStructureID;
959 UINT8 Flag;
960 UINT16 Reserved;
961 UINT32 AveragePowerConsumedInMPS0;
962 UINT32 RelativePowerSavingToMPS0;
963 UINT64 ExitLatencyToMPS0;
964} EFI_ACPI_5_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE;
965
966#define EFI_ACPI_5_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_MEMORY_CONTENT_PRESERVED 0x01
967#define EFI_ACPI_5_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_AUTONOMOUS_MEMORY_POWER_STATE_ENTRY 0x02
968#define EFI_ACPI_5_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_AUTONOMOUS_MEMORY_POWER_STATE_EXIT 0x04
969
970typedef struct {
971 UINT16 MemoryPowerStateCharacteristicsCount;
972 UINT8 Reserved[2];
973} EFI_ACPI_5_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_TABLE;
974
975///
976/// Memory Topology Table definition.
977///
978typedef struct {
979 EFI_ACPI_DESCRIPTION_HEADER Header;
980 UINT32 Reserved;
981} EFI_ACPI_5_0_MEMORY_TOPOLOGY_TABLE;
982
983///
984/// PMTT Version (as defined in ACPI 5.0 spec.)
985///
986#define EFI_ACPI_5_0_MEMORY_TOPOLOGY_TABLE_REVISION 0x01
987
988///
989/// Common Memory Aggregator Device Structure.
990///
991typedef struct {
992 UINT8 Type;
993 UINT8 Reserved;
994 UINT16 Length;
995 UINT16 Flags;
996 UINT16 Reserved1;
997} EFI_ACPI_5_0_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;
998
999///
1000/// Memory Aggregator Device Type
1001///
1002#define EFI_ACPI_5_0_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_SOCKET 0x1
1003#define EFI_ACPI_5_0_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_MEMORY_CONTROLLER 0x2
1004#define EFI_ACPI_5_0_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_DIMM 0x3
1005
1006///
1007/// Socket Memory Aggregator Device Structure.
1008///
1009typedef struct {
1010 EFI_ACPI_5_0_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;
1011//EFI_ACPI_5_0_PMMT_MEMORY_CONTROLLER_MEMORY_AGGREGATOR_DEVICE_STRUCTURE MemoryController[];
1012} EFI_ACPI_5_0_PMMT_SOCKET_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;
1013
1014///
1015/// MemoryController Memory Aggregator Device Structure.
1016///
1017typedef struct {
1018 EFI_ACPI_5_0_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;
1019 UINT32 ReadLatency;
1020 UINT32 WriteLatency;
1021 UINT32 ReadBandwidth;
1022 UINT32 WriteBandwidth;
1023 UINT16 OptimalAccessUnit;
1024 UINT16 OptimalAccessAlignment;
1025 UINT16 Reserved;
1026 UINT16 NumberOfProximityDomains;
1027//UINT32 ProximityDomain[NumberOfProximityDomains];
1028//EFI_ACPI_5_0_PMMT_DIMM_MEMORY_AGGREGATOR_DEVICE_STRUCTURE PhysicalComponent[];
1029} EFI_ACPI_5_0_PMMT_MEMORY_CONTROLLER_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;
1030
1031///
1032/// DIMM Memory Aggregator Device Structure.
1033///
1034typedef struct {
1035 EFI_ACPI_5_0_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;
1036 UINT16 PhysicalComponentIdentifier;
1037 UINT16 Reserved;
1038 UINT32 SizeOfDimm;
1039 UINT32 SmbiosHandle;
1040} EFI_ACPI_5_0_PMMT_DIMM_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;
1041
1042///
1043/// Boot Graphics Resource Table definition.
1044///
1045typedef struct {
1046 EFI_ACPI_DESCRIPTION_HEADER Header;
1047 ///
1048 /// 2-bytes (16 bit) version ID. This value must be 1.
1049 ///
1050 UINT16 Version;
1051 ///
1052 /// 1-byte status field indicating current status about the table.
1053 /// Bits[7:1] = Reserved (must be zero)
1054 /// Bit [0] = Valid. A one indicates the boot image graphic is valid.
1055 ///
1056 UINT8 Status;
1057 ///
1058 /// 1-byte enumerated type field indicating format of the image.
1059 /// 0 = Bitmap
1060 /// 1 - 255 Reserved (for future use)
1061 ///
1062 UINT8 ImageType;
1063 ///
1064 /// 8-byte (64 bit) physical address pointing to the firmware's in-memory copy
1065 /// of the image bitmap.
1066 ///
1067 UINT64 ImageAddress;
1068 ///
1069 /// A 4-byte (32-bit) unsigned long describing the display X-offset of the boot image.
1070 /// (X, Y) display offset of the top left corner of the boot image.
1071 /// The top left corner of the display is at offset (0, 0).
1072 ///
1073 UINT32 ImageOffsetX;
1074 ///
1075 /// A 4-byte (32-bit) unsigned long describing the display Y-offset of the boot image.
1076 /// (X, Y) display offset of the top left corner of the boot image.
1077 /// The top left corner of the display is at offset (0, 0).
1078 ///
1079 UINT32 ImageOffsetY;
1080} EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE;
1081
1082///
1083/// BGRT Revision
1084///
1085#define EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE_REVISION 1
1086
1087///
1088/// BGRT Version
1089///
1090#define EFI_ACPI_5_0_BGRT_VERSION 0x01
1091
1092///
1093/// BGRT Status
1094///
1095#define EFI_ACPI_5_0_BGRT_STATUS_INVALID 0x00
1096#define EFI_ACPI_5_0_BGRT_STATUS_VALID 0x01
1097
1098///
1099/// BGRT Image Type
1100///
1101#define EFI_ACPI_5_0_BGRT_IMAGE_TYPE_BMP 0x00
1102
1103///
1104/// FPDT Version (as defined in ACPI 5.0 spec.)
1105///
1106#define EFI_ACPI_5_0_FIRMWARE_PERFORMANCE_DATA_TABLE_REVISION 0x01
1107
1108///
1109/// FPDT Performance Record Types
1110///
1111#define EFI_ACPI_5_0_FPDT_RECORD_TYPE_FIRMWARE_BASIC_BOOT_POINTER 0x0000
1112#define EFI_ACPI_5_0_FPDT_RECORD_TYPE_S3_PERFORMANCE_TABLE_POINTER 0x0001
1113
1114///
1115/// FPDT Performance Record Revision
1116///
1117#define EFI_ACPI_5_0_FPDT_RECORD_REVISION_FIRMWARE_BASIC_BOOT_POINTER 0x01
1118#define EFI_ACPI_5_0_FPDT_RECORD_REVISION_S3_PERFORMANCE_TABLE_POINTER 0x01
1119
1120///
1121/// FPDT Runtime Performance Record Types
1122///
1123#define EFI_ACPI_5_0_FPDT_RUNTIME_RECORD_TYPE_S3_RESUME 0x0000
1124#define EFI_ACPI_5_0_FPDT_RUNTIME_RECORD_TYPE_S3_SUSPEND 0x0001
1125#define EFI_ACPI_5_0_FPDT_RUNTIME_RECORD_TYPE_FIRMWARE_BASIC_BOOT 0x0002
1126
1127///
1128/// FPDT Runtime Performance Record Revision
1129///
1130#define EFI_ACPI_5_0_FPDT_RUNTIME_RECORD_REVISION_S3_RESUME 0x01
1131#define EFI_ACPI_5_0_FPDT_RUNTIME_RECORD_REVISION_S3_SUSPEND 0x01
1132#define EFI_ACPI_5_0_FPDT_RUNTIME_RECORD_REVISION_FIRMWARE_BASIC_BOOT 0x02
1133
1134///
1135/// FPDT Performance Record header
1136///
1137typedef struct {
1138 UINT16 Type;
1139 UINT8 Length;
1140 UINT8 Revision;
1141} EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER;
1142
1143///
1144/// FPDT Performance Table header
1145///
1146typedef struct {
1147 UINT32 Signature;
1148 UINT32 Length;
1149} EFI_ACPI_5_0_FPDT_PERFORMANCE_TABLE_HEADER;
1150
1151///
1152/// FPDT Firmware Basic Boot Performance Pointer Record Structure
1153///
1154typedef struct {
1155 EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER Header;
1156 UINT32 Reserved;
1157 ///
1158 /// 64-bit processor-relative physical address of the Basic Boot Performance Table.
1159 ///
1160 UINT64 BootPerformanceTablePointer;
1161} EFI_ACPI_5_0_FPDT_BOOT_PERFORMANCE_TABLE_POINTER_RECORD;
1162
1163///
1164/// FPDT S3 Performance Table Pointer Record Structure
1165///
1166typedef struct {
1167 EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER Header;
1168 UINT32 Reserved;
1169 ///
1170 /// 64-bit processor-relative physical address of the S3 Performance Table.
1171 ///
1172 UINT64 S3PerformanceTablePointer;
1173} EFI_ACPI_5_0_FPDT_S3_PERFORMANCE_TABLE_POINTER_RECORD;
1174
1175///
1176/// FPDT Firmware Basic Boot Performance Record Structure
1177///
1178typedef struct {
1179 EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER Header;
1180 UINT32 Reserved;
1181 ///
1182 /// Timer value logged at the beginning of firmware image execution.
1183 /// This may not always be zero or near zero.
1184 ///
1185 UINT64 ResetEnd;
1186 ///
1187 /// Timer value logged just prior to loading the OS boot loader into memory.
1188 /// For non-UEFI compatible boots, this field must be zero.
1189 ///
1190 UINT64 OsLoaderLoadImageStart;
1191 ///
1192 /// Timer value logged just prior to launching the previously loaded OS boot loader image.
1193 /// For non-UEFI compatible boots, the timer value logged will be just prior
1194 /// to the INT 19h handler invocation.
1195 ///
1196 UINT64 OsLoaderStartImageStart;
1197 ///
1198 /// Timer value logged at the point when the OS loader calls the
1199 /// ExitBootServices function for UEFI compatible firmware.
1200 /// For non-UEFI compatible boots, this field must be zero.
1201 ///
1202 UINT64 ExitBootServicesEntry;
1203 ///
1204 /// Timer value logged at the point just prior towhen the OS loader gaining
1205 /// control back from calls the ExitBootServices function for UEFI compatible firmware.
1206 /// For non-UEFI compatible boots, this field must be zero.
1207 ///
1208 UINT64 ExitBootServicesExit;
1209} EFI_ACPI_5_0_FPDT_FIRMWARE_BASIC_BOOT_RECORD;
1210
1211///
1212/// FPDT Firmware Basic Boot Performance Table signature
1213///
1214#define EFI_ACPI_5_0_FPDT_BOOT_PERFORMANCE_TABLE_SIGNATURE SIGNATURE_32('F', 'B', 'P', 'T')
1215
1216//
1217// FPDT Firmware Basic Boot Performance Table
1218//
1219typedef struct {
1220 EFI_ACPI_5_0_FPDT_PERFORMANCE_TABLE_HEADER Header;
1221 //
1222 // one or more Performance Records.
1223 //
1224} EFI_ACPI_5_0_FPDT_FIRMWARE_BASIC_BOOT_TABLE;
1225
1226///
1227/// FPDT "S3PT" S3 Performance Table
1228///
1229#define EFI_ACPI_5_0_FPDT_S3_PERFORMANCE_TABLE_SIGNATURE SIGNATURE_32('S', '3', 'P', 'T')
1230
1231//
1232// FPDT Firmware S3 Boot Performance Table
1233//
1234typedef struct {
1235 EFI_ACPI_5_0_FPDT_PERFORMANCE_TABLE_HEADER Header;
1236 //
1237 // one or more Performance Records.
1238 //
1239} EFI_ACPI_5_0_FPDT_FIRMWARE_S3_BOOT_TABLE;
1240
1241///
1242/// FPDT Basic S3 Resume Performance Record
1243///
1244typedef struct {
1245 EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER Header;
1246 ///
1247 /// A count of the number of S3 resume cycles since the last full boot sequence.
1248 ///
1249 UINT32 ResumeCount;
1250 ///
1251 /// Timer recorded at the end of BIOS S3 resume, just prior to handoff to the
1252 /// OS waking vector. Only the most recent resume cycle's time is retained.
1253 ///
1254 UINT64 FullResume;
1255 ///
1256 /// Average timer value of all resume cycles logged since the last full boot
1257 /// sequence, including the most recent resume. Note that the entire log of
1258 /// timer values does not need to be retained in order to calculate this average.
1259 ///
1260 UINT64 AverageResume;
1261} EFI_ACPI_5_0_FPDT_S3_RESUME_RECORD;
1262
1263///
1264/// FPDT Basic S3 Suspend Performance Record
1265///
1266typedef struct {
1267 EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER Header;
1268 ///
1269 /// Timer value recorded at the OS write to SLP_TYP upon entry to S3.
1270 /// Only the most recent suspend cycle's timer value is retained.
1271 ///
1272 UINT64 SuspendStart;
1273 ///
1274 /// Timer value recorded at the final firmware write to SLP_TYP (or other
1275 /// mechanism) used to trigger hardware entry to S3.
1276 /// Only the most recent suspend cycle's timer value is retained.
1277 ///
1278 UINT64 SuspendEnd;
1279} EFI_ACPI_5_0_FPDT_S3_SUSPEND_RECORD;
1280
1281///
1282/// Firmware Performance Record Table definition.
1283///
1284typedef struct {
1285 EFI_ACPI_DESCRIPTION_HEADER Header;
1286} EFI_ACPI_5_0_FIRMWARE_PERFORMANCE_RECORD_TABLE;
1287
1288///
1289/// Generic Timer Description Table definition.
1290///
1291typedef struct {
1292 EFI_ACPI_DESCRIPTION_HEADER Header;
1293 UINT64 PhysicalAddress;
1294 UINT32 GlobalFlags;
1295 UINT32 SecurePL1TimerGSIV;
1296 UINT32 SecurePL1TimerFlags;
1297 UINT32 NonSecurePL1TimerGSIV;
1298 UINT32 NonSecurePL1TimerFlags;
1299 UINT32 VirtualTimerGSIV;
1300 UINT32 VirtualTimerFlags;
1301 UINT32 NonSecurePL2TimerGSIV;
1302 UINT32 NonSecurePL2TimerFlags;
1303} EFI_ACPI_5_0_GENERIC_TIMER_DESCRIPTION_TABLE;
1304
1305///
1306/// GTDT Version (as defined in ACPI 5.0 spec.)
1307///
1308#define EFI_ACPI_5_0_GENERIC_TIMER_DESCRIPTION_TABLE_REVISION 0x01
1309
1310///
1311/// Global Flags. All other bits are reserved and must be 0.
1312///
1313#define EFI_ACPI_5_0_GTDT_GLOBAL_FLAG_MEMORY_MAPPED_BLOCK_PRESENT BIT0
1314#define EFI_ACPI_5_0_GTDT_GLOBAL_FLAG_INTERRUPT_MODE BIT1
1315
1316///
1317/// Timer Flags. All other bits are reserved and must be 0.
1318///
1319#define EFI_ACPI_5_0_GTDT_TIMER_FLAG_TIMER_INTERRUPT_MODE BIT0
1320#define EFI_ACPI_5_0_GTDT_TIMER_FLAG_TIMER_INTERRUPT_POLARITY BIT1
1321
1322///
1323/// Boot Error Record Table (BERT)
1324///
1325typedef struct {
1326 EFI_ACPI_DESCRIPTION_HEADER Header;
1327 UINT32 BootErrorRegionLength;
1328 UINT64 BootErrorRegion;
1329} EFI_ACPI_5_0_BOOT_ERROR_RECORD_TABLE_HEADER;
1330
1331///
1332/// BERT Version (as defined in ACPI 5.0 spec.)
1333///
1334#define EFI_ACPI_5_0_BOOT_ERROR_RECORD_TABLE_REVISION 0x01
1335
1336///
1337/// Boot Error Region Block Status Definition
1338///
1339typedef struct {
1340 UINT32 UncorrectableErrorValid:1;
1341 UINT32 CorrectableErrorValid:1;
1342 UINT32 MultipleUncorrectableErrors:1;
1343 UINT32 MultipleCorrectableErrors:1;
1344 UINT32 ErrorDataEntryCount:10;
1345 UINT32 Reserved:18;
1346} EFI_ACPI_5_0_ERROR_BLOCK_STATUS;
1347
1348///
1349/// Boot Error Region Definition
1350///
1351typedef struct {
1352 EFI_ACPI_5_0_ERROR_BLOCK_STATUS BlockStatus;
1353 UINT32 RawDataOffset;
1354 UINT32 RawDataLength;
1355 UINT32 DataLength;
1356 UINT32 ErrorSeverity;
1357} EFI_ACPI_5_0_BOOT_ERROR_REGION_STRUCTURE;
1358
1359//
1360// Boot Error Severity types
1361//
1362#define EFI_ACPI_5_0_ERROR_SEVERITY_CORRECTABLE 0x00
1363#define EFI_ACPI_5_0_ERROR_SEVERITY_FATAL 0x01
1364#define EFI_ACPI_5_0_ERROR_SEVERITY_CORRECTED 0x02
1365#define EFI_ACPI_5_0_ERROR_SEVERITY_NONE 0x03
1366
1367///
1368/// Generic Error Data Entry Definition
1369///
1370typedef struct {
1371 UINT8 SectionType[16];
1372 UINT32 ErrorSeverity;
1373 UINT16 Revision;
1374 UINT8 ValidationBits;
1375 UINT8 Flags;
1376 UINT32 ErrorDataLength;
1377 UINT8 FruId[16];
1378 UINT8 FruText[20];
1379} EFI_ACPI_5_0_GENERIC_ERROR_DATA_ENTRY_STRUCTURE;
1380
1381///
1382/// Generic Error Data Entry Version (as defined in ACPI 5.0 spec.)
1383///
1384#define EFI_ACPI_5_0_GENERIC_ERROR_DATA_ENTRY_REVISION 0x0201
1385
1386///
1387/// HEST - Hardware Error Source Table
1388///
1389typedef struct {
1390 EFI_ACPI_DESCRIPTION_HEADER Header;
1391 UINT32 ErrorSourceCount;
1392} EFI_ACPI_5_0_HARDWARE_ERROR_SOURCE_TABLE_HEADER;
1393
1394///
1395/// HEST Version (as defined in ACPI 5.0 spec.)
1396///
1397#define EFI_ACPI_5_0_HARDWARE_ERROR_SOURCE_TABLE_REVISION 0x01
1398
1399//
1400// Error Source structure types.
1401//
1402#define EFI_ACPI_5_0_IA32_ARCHITECTURE_MACHINE_CHECK_EXCEPTION 0x00
1403#define EFI_ACPI_5_0_IA32_ARCHITECTURE_CORRECTED_MACHINE_CHECK 0x01
1404#define EFI_ACPI_5_0_IA32_ARCHITECTURE_NMI_ERROR 0x02
1405#define EFI_ACPI_5_0_PCI_EXPRESS_ROOT_PORT_AER 0x06
1406#define EFI_ACPI_5_0_PCI_EXPRESS_DEVICE_AER 0x07
1407#define EFI_ACPI_5_0_PCI_EXPRESS_BRIDGE_AER 0x08
1408#define EFI_ACPI_5_0_GENERIC_HARDWARE_ERROR 0x09
1409
1410//
1411// Error Source structure flags.
1412//
1413#define EFI_ACPI_5_0_ERROR_SOURCE_FLAG_FIRMWARE_FIRST (1 << 0)
1414#define EFI_ACPI_5_0_ERROR_SOURCE_FLAG_GLOBAL (1 << 1)
1415
1416///
1417/// IA-32 Architecture Machine Check Exception Structure Definition
1418///
1419typedef struct {
1420 UINT16 Type;
1421 UINT16 SourceId;
1422 UINT8 Reserved0[2];
1423 UINT8 Flags;
1424 UINT8 Enabled;
1425 UINT32 NumberOfRecordsToPreAllocate;
1426 UINT32 MaxSectionsPerRecord;
1427 UINT64 GlobalCapabilityInitData;
1428 UINT64 GlobalControlInitData;
1429 UINT8 NumberOfHardwareBanks;
1430 UINT8 Reserved1[7];
1431} EFI_ACPI_5_0_IA32_ARCHITECTURE_MACHINE_CHECK_EXCEPTION_STRUCTURE;
1432
1433///
1434/// IA-32 Architecture Machine Check Bank Structure Definition
1435///
1436typedef struct {
1437 UINT8 BankNumber;
1438 UINT8 ClearStatusOnInitialization;
1439 UINT8 StatusDataFormat;
1440 UINT8 Reserved0;
1441 UINT32 ControlRegisterMsrAddress;
1442 UINT64 ControlInitData;
1443 UINT32 StatusRegisterMsrAddress;
1444 UINT32 AddressRegisterMsrAddress;
1445 UINT32 MiscRegisterMsrAddress;
1446} EFI_ACPI_5_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_BANK_STRUCTURE;
1447
1448///
1449/// IA-32 Architecture Machine Check Bank Structure MCA data format
1450///
1451#define EFI_ACPI_5_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_IA32 0x00
1452#define EFI_ACPI_5_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_INTEL64 0x01
1453#define EFI_ACPI_5_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_AMD64 0x02
1454
1455//
1456// Hardware Error Notification types. All other values are reserved
1457//
1458#define EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_POLLED 0x00
1459#define EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_EXTERNAL_INTERRUPT 0x01
1460#define EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_LOCAL_INTERRUPT 0x02
1461#define EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_SCI 0x03
1462#define EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_NMI 0x04
1463
1464///
1465/// Hardware Error Notification Configuration Write Enable Structure Definition
1466///
1467typedef struct {
1468 UINT16 Type:1;
1469 UINT16 PollInterval:1;
1470 UINT16 SwitchToPollingThresholdValue:1;
1471 UINT16 SwitchToPollingThresholdWindow:1;
1472 UINT16 ErrorThresholdValue:1;
1473 UINT16 ErrorThresholdWindow:1;
1474 UINT16 Reserved:10;
1475} EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE;
1476
1477///
1478/// Hardware Error Notification Structure Definition
1479///
1480typedef struct {
1481 UINT8 Type;
1482 UINT8 Length;
1483 EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE ConfigurationWriteEnable;
1484 UINT32 PollInterval;
1485 UINT32 Vector;
1486 UINT32 SwitchToPollingThresholdValue;
1487 UINT32 SwitchToPollingThresholdWindow;
1488 UINT32 ErrorThresholdValue;
1489 UINT32 ErrorThresholdWindow;
1490} EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE;
1491
1492///
1493/// IA-32 Architecture Corrected Machine Check Structure Definition
1494///
1495typedef struct {
1496 UINT16 Type;
1497 UINT16 SourceId;
1498 UINT8 Reserved0[2];
1499 UINT8 Flags;
1500 UINT8 Enabled;
1501 UINT32 NumberOfRecordsToPreAllocate;
1502 UINT32 MaxSectionsPerRecord;
1503 EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE NotificationStructure;
1504 UINT8 NumberOfHardwareBanks;
1505 UINT8 Reserved1[3];
1506} EFI_ACPI_5_0_IA32_ARCHITECTURE_CORRECTED_MACHINE_CHECK_STRUCTURE;
1507
1508///
1509/// IA-32 Architecture NMI Error Structure Definition
1510///
1511typedef struct {
1512 UINT16 Type;
1513 UINT16 SourceId;
1514 UINT8 Reserved0[2];
1515 UINT32 NumberOfRecordsToPreAllocate;
1516 UINT32 MaxSectionsPerRecord;
1517 UINT32 MaxRawDataLength;
1518} EFI_ACPI_5_0_IA32_ARCHITECTURE_NMI_ERROR_STRUCTURE;
1519
1520///
1521/// PCI Express Root Port AER Structure Definition
1522///
1523typedef struct {
1524 UINT16 Type;
1525 UINT16 SourceId;
1526 UINT8 Reserved0[2];
1527 UINT8 Flags;
1528 UINT8 Enabled;
1529 UINT32 NumberOfRecordsToPreAllocate;
1530 UINT32 MaxSectionsPerRecord;
1531 UINT32 Bus;
1532 UINT16 Device;
1533 UINT16 Function;
1534 UINT16 DeviceControl;
1535 UINT8 Reserved1[2];
1536 UINT32 UncorrectableErrorMask;
1537 UINT32 UncorrectableErrorSeverity;
1538 UINT32 CorrectableErrorMask;
1539 UINT32 AdvancedErrorCapabilitiesAndControl;
1540 UINT32 RootErrorCommand;
1541} EFI_ACPI_5_0_PCI_EXPRESS_ROOT_PORT_AER_STRUCTURE;
1542
1543///
1544/// PCI Express Device AER Structure Definition
1545///
1546typedef struct {
1547 UINT16 Type;
1548 UINT16 SourceId;
1549 UINT8 Reserved0[2];
1550 UINT8 Flags;
1551 UINT8 Enabled;
1552 UINT32 NumberOfRecordsToPreAllocate;
1553 UINT32 MaxSectionsPerRecord;
1554 UINT32 Bus;
1555 UINT16 Device;
1556 UINT16 Function;
1557 UINT16 DeviceControl;
1558 UINT8 Reserved1[2];
1559 UINT32 UncorrectableErrorMask;
1560 UINT32 UncorrectableErrorSeverity;
1561 UINT32 CorrectableErrorMask;
1562 UINT32 AdvancedErrorCapabilitiesAndControl;
1563} EFI_ACPI_5_0_PCI_EXPRESS_DEVICE_AER_STRUCTURE;
1564
1565///
1566/// PCI Express Bridge AER Structure Definition
1567///
1568typedef struct {
1569 UINT16 Type;
1570 UINT16 SourceId;
1571 UINT8 Reserved0[2];
1572 UINT8 Flags;
1573 UINT8 Enabled;
1574 UINT32 NumberOfRecordsToPreAllocate;
1575 UINT32 MaxSectionsPerRecord;
1576 UINT32 Bus;
1577 UINT16 Device;
1578 UINT16 Function;
1579 UINT16 DeviceControl;
1580 UINT8 Reserved1[2];
1581 UINT32 UncorrectableErrorMask;
1582 UINT32 UncorrectableErrorSeverity;
1583 UINT32 CorrectableErrorMask;
1584 UINT32 AdvancedErrorCapabilitiesAndControl;
1585 UINT32 SecondaryUncorrectableErrorMask;
1586 UINT32 SecondaryUncorrectableErrorSeverity;
1587 UINT32 SecondaryAdvancedErrorCapabilitiesAndControl;
1588} EFI_ACPI_5_0_PCI_EXPRESS_BRIDGE_AER_STRUCTURE;
1589
1590///
1591/// Generic Hardware Error Source Structure Definition
1592///
1593typedef struct {
1594 UINT16 Type;
1595 UINT16 SourceId;
1596 UINT16 RelatedSourceId;
1597 UINT8 Flags;
1598 UINT8 Enabled;
1599 UINT32 NumberOfRecordsToPreAllocate;
1600 UINT32 MaxSectionsPerRecord;
1601 UINT32 MaxRawDataLength;
1602 EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE ErrorStatusAddress;
1603 EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE NotificationStructure;
1604 UINT32 ErrorStatusBlockLength;
1605} EFI_ACPI_5_0_GENERIC_HARDWARE_ERROR_SOURCE_STRUCTURE;
1606
1607///
1608/// Generic Error Status Definition
1609///
1610typedef struct {
1611 EFI_ACPI_5_0_ERROR_BLOCK_STATUS BlockStatus;
1612 UINT32 RawDataOffset;
1613 UINT32 RawDataLength;
1614 UINT32 DataLength;
1615 UINT32 ErrorSeverity;
1616} EFI_ACPI_5_0_GENERIC_ERROR_STATUS_STRUCTURE;
1617
1618///
1619/// ERST - Error Record Serialization Table
1620///
1621typedef struct {
1622 EFI_ACPI_DESCRIPTION_HEADER Header;
1623 UINT32 SerializationHeaderSize;
1624 UINT8 Reserved0[4];
1625 UINT32 InstructionEntryCount;
1626} EFI_ACPI_5_0_ERROR_RECORD_SERIALIZATION_TABLE_HEADER;
1627
1628///
1629/// ERST Version (as defined in ACPI 5.0 spec.)
1630///
1631#define EFI_ACPI_5_0_ERROR_RECORD_SERIALIZATION_TABLE_REVISION 0x01
1632
1633///
1634/// ERST Serialization Actions
1635///
1636#define EFI_ACPI_5_0_ERST_BEGIN_WRITE_OPERATION 0x00
1637#define EFI_ACPI_5_0_ERST_BEGIN_READ_OPERATION 0x01
1638#define EFI_ACPI_5_0_ERST_BEGIN_CLEAR_OPERATION 0x02
1639#define EFI_ACPI_5_0_ERST_END_OPERATION 0x03
1640#define EFI_ACPI_5_0_ERST_SET_RECORD_OFFSET 0x04
1641#define EFI_ACPI_5_0_ERST_EXECUTE_OPERATION 0x05
1642#define EFI_ACPI_5_0_ERST_CHECK_BUSY_STATUS 0x06
1643#define EFI_ACPI_5_0_ERST_GET_COMMAND_STATUS 0x07
1644#define EFI_ACPI_5_0_ERST_GET_RECORD_IDENTIFIER 0x08
1645#define EFI_ACPI_5_0_ERST_SET_RECORD_IDENTIFIER 0x09
1646#define EFI_ACPI_5_0_ERST_GET_RECORD_COUNT 0x0A
1647#define EFI_ACPI_5_0_ERST_BEGIN_DUMMY_WRITE_OPERATION 0x0B
1648#define EFI_ACPI_5_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE 0x0D
1649#define EFI_ACPI_5_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE_LENGTH 0x0E
1650#define EFI_ACPI_5_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES 0x0F
1651
1652///
1653/// ERST Action Command Status
1654///
1655#define EFI_ACPI_5_0_ERST_STATUS_SUCCESS 0x00
1656#define EFI_ACPI_5_0_ERST_STATUS_NOT_ENOUGH_SPACE 0x01
1657#define EFI_ACPI_5_0_ERST_STATUS_HARDWARE_NOT_AVAILABLE 0x02
1658#define EFI_ACPI_5_0_ERST_STATUS_FAILED 0x03
1659#define EFI_ACPI_5_0_ERST_STATUS_RECORD_STORE_EMPTY 0x04
1660#define EFI_ACPI_5_0_ERST_STATUS_RECORD_NOT_FOUND 0x05
1661
1662///
1663/// ERST Serialization Instructions
1664///
1665#define EFI_ACPI_5_0_ERST_READ_REGISTER 0x00
1666#define EFI_ACPI_5_0_ERST_READ_REGISTER_VALUE 0x01
1667#define EFI_ACPI_5_0_ERST_WRITE_REGISTER 0x02
1668#define EFI_ACPI_5_0_ERST_WRITE_REGISTER_VALUE 0x03
1669#define EFI_ACPI_5_0_ERST_NOOP 0x04
1670#define EFI_ACPI_5_0_ERST_LOAD_VAR1 0x05
1671#define EFI_ACPI_5_0_ERST_LOAD_VAR2 0x06
1672#define EFI_ACPI_5_0_ERST_STORE_VAR1 0x07
1673#define EFI_ACPI_5_0_ERST_ADD 0x08
1674#define EFI_ACPI_5_0_ERST_SUBTRACT 0x09
1675#define EFI_ACPI_5_0_ERST_ADD_VALUE 0x0A
1676#define EFI_ACPI_5_0_ERST_SUBTRACT_VALUE 0x0B
1677#define EFI_ACPI_5_0_ERST_STALL 0x0C
1678#define EFI_ACPI_5_0_ERST_STALL_WHILE_TRUE 0x0D
1679#define EFI_ACPI_5_0_ERST_SKIP_NEXT_INSTRUCTION_IF_TRUE 0x0E
1680#define EFI_ACPI_5_0_ERST_GOTO 0x0F
1681#define EFI_ACPI_5_0_ERST_SET_SRC_ADDRESS_BASE 0x10
1682#define EFI_ACPI_5_0_ERST_SET_DST_ADDRESS_BASE 0x11
1683#define EFI_ACPI_5_0_ERST_MOVE_DATA 0x12
1684
1685///
1686/// ERST Instruction Flags
1687///
1688#define EFI_ACPI_5_0_ERST_PRESERVE_REGISTER 0x01
1689
1690///
1691/// ERST Serialization Instruction Entry
1692///
1693typedef struct {
1694 UINT8 SerializationAction;
1695 UINT8 Instruction;
1696 UINT8 Flags;
1697 UINT8 Reserved0;
1698 EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE RegisterRegion;
1699 UINT64 Value;
1700 UINT64 Mask;
1701} EFI_ACPI_5_0_ERST_SERIALIZATION_INSTRUCTION_ENTRY;
1702
1703///
1704/// EINJ - Error Injection Table
1705///
1706typedef struct {
1707 EFI_ACPI_DESCRIPTION_HEADER Header;
1708 UINT32 InjectionHeaderSize;
1709 UINT8 InjectionFlags;
1710 UINT8 Reserved0[3];
1711 UINT32 InjectionEntryCount;
1712} EFI_ACPI_5_0_ERROR_INJECTION_TABLE_HEADER;
1713
1714///
1715/// EINJ Version (as defined in ACPI 5.0 spec.)
1716///
1717#define EFI_ACPI_5_0_ERROR_INJECTION_TABLE_REVISION 0x01
1718
1719///
1720/// EINJ Error Injection Actions
1721///
1722#define EFI_ACPI_5_0_EINJ_BEGIN_INJECTION_OPERATION 0x00
1723#define EFI_ACPI_5_0_EINJ_GET_TRIGGER_ERROR_ACTION_TABLE 0x01
1724#define EFI_ACPI_5_0_EINJ_SET_ERROR_TYPE 0x02
1725#define EFI_ACPI_5_0_EINJ_GET_ERROR_TYPE 0x03
1726#define EFI_ACPI_5_0_EINJ_END_OPERATION 0x04
1727#define EFI_ACPI_5_0_EINJ_EXECUTE_OPERATION 0x05
1728#define EFI_ACPI_5_0_EINJ_CHECK_BUSY_STATUS 0x06
1729#define EFI_ACPI_5_0_EINJ_GET_COMMAND_STATUS 0x07
1730#define EFI_ACPI_5_0_EINJ_TRIGGER_ERROR 0xFF
1731
1732///
1733/// EINJ Action Command Status
1734///
1735#define EFI_ACPI_5_0_EINJ_STATUS_SUCCESS 0x00
1736#define EFI_ACPI_5_0_EINJ_STATUS_UNKNOWN_FAILURE 0x01
1737#define EFI_ACPI_5_0_EINJ_STATUS_INVALID_ACCESS 0x02
1738
1739///
1740/// EINJ Error Type Definition
1741///
1742#define EFI_ACPI_5_0_EINJ_ERROR_PROCESSOR_CORRECTABLE (1 << 0)
1743#define EFI_ACPI_5_0_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_NONFATAL (1 << 1)
1744#define EFI_ACPI_5_0_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_FATAL (1 << 2)
1745#define EFI_ACPI_5_0_EINJ_ERROR_MEMORY_CORRECTABLE (1 << 3)
1746#define EFI_ACPI_5_0_EINJ_ERROR_MEMORY_UNCORRECTABLE_NONFATAL (1 << 4)
1747#define EFI_ACPI_5_0_EINJ_ERROR_MEMORY_UNCORRECTABLE_FATAL (1 << 5)
1748#define EFI_ACPI_5_0_EINJ_ERROR_PCI_EXPRESS_CORRECTABLE (1 << 6)
1749#define EFI_ACPI_5_0_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_NONFATAL (1 << 7)
1750#define EFI_ACPI_5_0_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_FATAL (1 << 8)
1751#define EFI_ACPI_5_0_EINJ_ERROR_PLATFORM_CORRECTABLE (1 << 9)
1752#define EFI_ACPI_5_0_EINJ_ERROR_PLATFORM_UNCORRECTABLE_NONFATAL (1 << 10)
1753#define EFI_ACPI_5_0_EINJ_ERROR_PLATFORM_UNCORRECTABLE_FATAL (1 << 11)
1754
1755///
1756/// EINJ Injection Instructions
1757///
1758#define EFI_ACPI_5_0_EINJ_READ_REGISTER 0x00
1759#define EFI_ACPI_5_0_EINJ_READ_REGISTER_VALUE 0x01
1760#define EFI_ACPI_5_0_EINJ_WRITE_REGISTER 0x02
1761#define EFI_ACPI_5_0_EINJ_WRITE_REGISTER_VALUE 0x03
1762#define EFI_ACPI_5_0_EINJ_NOOP 0x04
1763
1764///
1765/// EINJ Instruction Flags
1766///
1767#define EFI_ACPI_5_0_EINJ_PRESERVE_REGISTER 0x01
1768
1769///
1770/// EINJ Injection Instruction Entry
1771///
1772typedef struct {
1773 UINT8 InjectionAction;
1774 UINT8 Instruction;
1775 UINT8 Flags;
1776 UINT8 Reserved0;
1777 EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE RegisterRegion;
1778 UINT64 Value;
1779 UINT64 Mask;
1780} EFI_ACPI_5_0_EINJ_INJECTION_INSTRUCTION_ENTRY;
1781
1782///
1783/// EINJ Trigger Action Table
1784///
1785typedef struct {
1786 UINT32 HeaderSize;
1787 UINT32 Revision;
1788 UINT32 TableSize;
1789 UINT32 EntryCount;
1790} EFI_ACPI_5_0_EINJ_TRIGGER_ACTION_TABLE;
1791
1792///
1793/// Platform Communications Channel Table (PCCT)
1794///
1795typedef struct {
1796 EFI_ACPI_DESCRIPTION_HEADER Header;
1797 UINT32 Flags;
1798 UINT32 NominalLatency;
1799 UINT32 Reserved;
1800} EFI_ACPI_5_0_PLATFORM_COMMUNICATION_CHANNEL_TABLE_HEADER;
1801
1802///
1803/// PCCT Version (as defined in ACPI 5.0 spec.)
1804///
1805#define EFI_ACPI_5_0_PLATFORM_COMMUNICATION_CHANNEL_TABLE_REVISION 0x01
1806
1807///
1808/// PCCT Global Flags
1809///
1810#define EFI_ACPI_5_0_PCCT_FLAGS_SCI_DOORBELL BIT0
1811
1812//
1813// PCCT Subspace type
1814//
1815#define EFI_ACPI_5_0_PCCT_SUBSPACE_TYPE_GENERIC 0x00
1816
1817///
1818/// PCC Subspace Structure Header
1819///
1820typedef struct {
1821 UINT8 Type;
1822 UINT8 Length;
1823} EFI_ACPI_5_0_PCCT_SUBSPACE_HEADER;
1824
1825///
1826/// Generic Communications Subspace Structure
1827///
1828typedef struct {
1829 UINT8 Type;
1830 UINT8 Length;
1831 UINT8 Reserved[6];
1832 UINT64 BaseAddress;
1833 UINT64 AddressLength;
1834 EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE DoorbellRegister;
1835 UINT64 DoorbellPreserve;
1836 UINT64 DoorbellWrite;
1837 UINT32 NominalLatency;
1838 UINT32 MaximumPeriodicAccessRate;
1839 UINT16 MinimumRequestTurnaroundTime;
1840} EFI_ACPI_5_0_PCCT_SUBSPACE_GENERIC;
1841
1842///
1843/// Generic Communications Channel Shared Memory Region
1844///
1845
1846typedef struct {
1847 UINT8 Command;
1848 UINT8 Reserved:7;
1849 UINT8 GenerateSci:1;
1850} EFI_ACPI_5_0_PCCT_GENERIC_SHARED_MEMORY_REGION_COMMAND;
1851
1852typedef struct {
1853 UINT8 CommandComplete:1;
1854 UINT8 SciDoorbell:1;
1855 UINT8 Error:1;
1856 UINT8 Reserved:5;
1857 UINT8 Reserved1;
1858} EFI_ACPI_5_0_PCCT_GENERIC_SHARED_MEMORY_REGION_STATUS;
1859
1860typedef struct {
1861 UINT32 Signature;
1862 EFI_ACPI_5_0_PCCT_GENERIC_SHARED_MEMORY_REGION_COMMAND Command;
1863 EFI_ACPI_5_0_PCCT_GENERIC_SHARED_MEMORY_REGION_STATUS Status;
1864} EFI_ACPI_5_0_PCCT_GENERIC_SHARED_MEMORY_REGION_HEADER;
1865
1866//
1867// Known table signatures
1868//
1869
1870///
1871/// "RSD PTR " Root System Description Pointer
1872///
1873#define EFI_ACPI_5_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ')
1874
1875///
1876/// "APIC" Multiple APIC Description Table
1877///
1878#define EFI_ACPI_5_0_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('A', 'P', 'I', 'C')
1879
1880///
1881/// "BERT" Boot Error Record Table
1882///
1883#define EFI_ACPI_5_0_BOOT_ERROR_RECORD_TABLE_SIGNATURE SIGNATURE_32('B', 'E', 'R', 'T')
1884
1885///
1886/// "BGRT" Boot Graphics Resource Table
1887///
1888#define EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE_SIGNATURE SIGNATURE_32('B', 'G', 'R', 'T')
1889
1890///
1891/// "CPEP" Corrected Platform Error Polling Table
1892///
1893#define EFI_ACPI_5_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_SIGNATURE SIGNATURE_32('C', 'P', 'E', 'P')
1894
1895///
1896/// "DSDT" Differentiated System Description Table
1897///
1898#define EFI_ACPI_5_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('D', 'S', 'D', 'T')
1899
1900///
1901/// "ECDT" Embedded Controller Boot Resources Table
1902///
1903#define EFI_ACPI_5_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_SIGNATURE SIGNATURE_32('E', 'C', 'D', 'T')
1904
1905///
1906/// "EINJ" Error Injection Table
1907///
1908#define EFI_ACPI_5_0_ERROR_INJECTION_TABLE_SIGNATURE SIGNATURE_32('E', 'I', 'N', 'J')
1909
1910///
1911/// "ERST" Error Record Serialization Table
1912///
1913#define EFI_ACPI_5_0_ERROR_RECORD_SERIALIZATION_TABLE_SIGNATURE SIGNATURE_32('E', 'R', 'S', 'T')
1914
1915///
1916/// "FACP" Fixed ACPI Description Table
1917///
1918#define EFI_ACPI_5_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('F', 'A', 'C', 'P')
1919
1920///
1921/// "FACS" Firmware ACPI Control Structure
1922///
1923#define EFI_ACPI_5_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE SIGNATURE_32('F', 'A', 'C', 'S')
1924
1925///
1926/// "FPDT" Firmware Performance Data Table
1927///
1928#define EFI_ACPI_5_0_FIRMWARE_PERFORMANCE_DATA_TABLE_SIGNATURE SIGNATURE_32('F', 'P', 'D', 'T')
1929
1930///
1931/// "GTDT" Generic Timer Description Table
1932///
1933#define EFI_ACPI_5_0_GENERIC_TIMER_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('G', 'T', 'D', 'T')
1934
1935///
1936/// "HEST" Hardware Error Source Table
1937///
1938#define EFI_ACPI_5_0_HARDWARE_ERROR_SOURCE_TABLE_SIGNATURE SIGNATURE_32('H', 'E', 'S', 'T')
1939
1940///
1941/// "MPST" Memory Power State Table
1942///
1943#define EFI_ACPI_5_0_MEMORY_POWER_STATE_TABLE_SIGNATURE SIGNATURE_32('M', 'P', 'S', 'T')
1944
1945///
1946/// "MSCT" Maximum System Characteristics Table
1947///
1948#define EFI_ACPI_5_0_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_SIGNATURE SIGNATURE_32('M', 'S', 'C', 'T')
1949
1950///
1951/// "PMTT" Platform Memory Topology Table
1952///
1953#define EFI_ACPI_5_0_PLATFORM_MEMORY_TOPOLOGY_TABLE_SIGNATURE SIGNATURE_32('P', 'M', 'T', 'T')
1954
1955///
1956/// "PSDT" Persistent System Description Table
1957///
1958#define EFI_ACPI_5_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('P', 'S', 'D', 'T')
1959
1960///
1961/// "RASF" ACPI RAS Feature Table
1962///
1963#define EFI_ACPI_5_0_ACPI_RAS_FEATURE_TABLE_SIGNATURE SIGNATURE_32('R', 'A', 'S', 'F')
1964
1965///
1966/// "RSDT" Root System Description Table
1967///
1968#define EFI_ACPI_5_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('R', 'S', 'D', 'T')
1969
1970///
1971/// "SBST" Smart Battery Specification Table
1972///
1973#define EFI_ACPI_5_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE SIGNATURE_32('S', 'B', 'S', 'T')
1974
1975///
1976/// "SLIT" System Locality Information Table
1977///
1978#define EFI_ACPI_5_0_SYSTEM_LOCALITY_INFORMATION_TABLE_SIGNATURE SIGNATURE_32('S', 'L', 'I', 'T')
1979
1980///
1981/// "SRAT" System Resource Affinity Table
1982///
1983#define EFI_ACPI_5_0_SYSTEM_RESOURCE_AFFINITY_TABLE_SIGNATURE SIGNATURE_32('S', 'R', 'A', 'T')
1984
1985///
1986/// "SSDT" Secondary System Description Table
1987///
1988#define EFI_ACPI_5_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('S', 'S', 'D', 'T')
1989
1990///
1991/// "XSDT" Extended System Description Table
1992///
1993#define EFI_ACPI_5_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('X', 'S', 'D', 'T')
1994
1995///
1996/// "BOOT" MS Simple Boot Spec
1997///
1998#define EFI_ACPI_5_0_SIMPLE_BOOT_FLAG_TABLE_SIGNATURE SIGNATURE_32('B', 'O', 'O', 'T')
1999
2000///
2001/// "CSRT" MS Core System Resource Table
2002///
2003#define EFI_ACPI_5_0_CORE_SYSTEM_RESOURCE_TABLE_SIGNATURE SIGNATURE_32('C', 'S', 'R', 'T')
2004
2005///
2006/// "DBG2" MS Debug Port 2 Spec
2007///
2008#define EFI_ACPI_5_0_DEBUG_PORT_2_TABLE_SIGNATURE SIGNATURE_32('D', 'B', 'G', '2')
2009
2010///
2011/// "DBGP" MS Debug Port Spec
2012///
2013#define EFI_ACPI_5_0_DEBUG_PORT_TABLE_SIGNATURE SIGNATURE_32('D', 'B', 'G', 'P')
2014
2015///
2016/// "DMAR" DMA Remapping Table
2017///
2018#define EFI_ACPI_5_0_DMA_REMAPPING_TABLE_SIGNATURE SIGNATURE_32('D', 'M', 'A', 'R')
2019
2020///
2021/// "ETDT" Event Timer Description Table
2022///
2023#define EFI_ACPI_5_0_EVENT_TIMER_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('E', 'T', 'D', 'T')
2024
2025///
2026/// "HPET" IA-PC High Precision Event Timer Table
2027///
2028#define EFI_ACPI_5_0_HIGH_PRECISION_EVENT_TIMER_TABLE_SIGNATURE SIGNATURE_32('H', 'P', 'E', 'T')
2029
2030///
2031/// "iBFT" iSCSI Boot Firmware Table
2032///
2033#define EFI_ACPI_5_0_ISCSI_BOOT_FIRMWARE_TABLE_SIGNATURE SIGNATURE_32('i', 'B', 'F', 'T')
2034
2035///
2036/// "IVRS" I/O Virtualization Reporting Structure
2037///
2038#define EFI_ACPI_5_0_IO_VIRTUALIZATION_REPORTING_STRUCTURE_SIGNATURE SIGNATURE_32('I', 'V', 'R', 'S')
2039
2040///
2041/// "MCFG" PCI Express Memory Mapped Configuration Space Base Address Description Table
2042///
2043#define EFI_ACPI_5_0_PCI_EXPRESS_MEMORY_MAPPED_CONFIGURATION_SPACE_BASE_ADDRESS_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('M', 'C', 'F', 'G')
2044
2045///
2046/// "MCHI" Management Controller Host Interface Table
2047///
2048#define EFI_ACPI_5_0_MANAGEMENT_CONTROLLER_HOST_INTERFACE_TABLE_SIGNATURE SIGNATURE_32('M', 'C', 'H', 'I')
2049
2050///
2051/// "MSDM" MS Data Management Table
2052///
2053#define EFI_ACPI_5_0_DATA_MANAGEMENT_TABLE_SIGNATURE SIGNATURE_32('M', 'S', 'D', 'M')
2054
2055///
2056/// "SLIC" MS Software Licensing Table Specification
2057///
2058#define EFI_ACPI_5_0_SOFTWARE_LICENSING_TABLE_SIGNATURE SIGNATURE_32('S', 'L', 'I', 'C')
2059
2060///
2061/// "SPCR" Serial Port Concole Redirection Table
2062///
2063#define EFI_ACPI_5_0_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE SIGNATURE_32('S', 'P', 'C', 'R')
2064
2065///
2066/// "SPMI" Server Platform Management Interface Table
2067///
2068#define EFI_ACPI_5_0_SERVER_PLATFORM_MANAGEMENT_INTERFACE_TABLE_SIGNATURE SIGNATURE_32('S', 'P', 'M', 'I')
2069
2070///
2071/// "TCPA" Trusted Computing Platform Alliance Capabilities Table
2072///
2073#define EFI_ACPI_5_0_TRUSTED_COMPUTING_PLATFORM_ALLIANCE_CAPABILITIES_TABLE_SIGNATURE SIGNATURE_32('T', 'C', 'P', 'A')
2074
2075///
2076/// "TPM2" Trusted Computing Platform 1 Table
2077///
2078#define EFI_ACPI_5_0_TRUSTED_COMPUTING_PLATFORM_2_TABLE_SIGNATURE SIGNATURE_32('T', 'P', 'M', '2')
2079
2080///
2081/// "UEFI" UEFI ACPI Data Table
2082///
2083#define EFI_ACPI_5_0_UEFI_ACPI_DATA_TABLE_SIGNATURE SIGNATURE_32('U', 'E', 'F', 'I')
2084
2085///
2086/// "WAET" Windows ACPI Enlightenment Table
2087///
2088#define EFI_ACPI_5_0_WINDOWS_ACPI_ENLIGHTENMENT_TABLE_SIGNATURE SIGNATURE_32('W', 'A', 'E', 'T')
2089
2090///
2091/// "WDAT" Watchdog Action Table
2092///
2093#define EFI_ACPI_5_0_WATCHDOG_ACTION_TABLE_SIGNATURE SIGNATURE_32('W', 'D', 'A', 'T')
2094
2095///
2096/// "WDRT" Watchdog Resource Table
2097///
2098#define EFI_ACPI_5_0_WATCHDOG_RESOURCE_TABLE_SIGNATURE SIGNATURE_32('W', 'D', 'R', 'T')
2099
2100///
2101/// "WPBT" MS Platform Binary Table
2102///
2103#define EFI_ACPI_5_0_PLATFORM_BINARY_TABLE_SIGNATURE SIGNATURE_32('W', 'P', 'B', 'T')
2104
2105#pragma pack()
2106
2107#endif
Note: See TracBrowser for help on using the repository browser.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette