VirtualBox

source: vbox/trunk/src/VBox/Devices/EFI/Firmware/MdePkg/Include/IndustryStandard/Acpi61.h

Last change on this file was 105670, checked in by vboxsync, 8 months ago

Devices/EFI/FirmwareNew: Merge edk2-stable-202405 and make it build on aarch64, bugref:4643
  • Property svn:eol-style set to native
File size: 80.9 KB
Line 
1/** @file
2 ACPI 6.1 definitions from the ACPI Specification Revision 6.1 January, 2016.
3
4 Copyright (c) 2016 - 2022, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
6 Copyright (c) 2020, ARM Ltd. All rights reserved.<BR>
7 SPDX-License-Identifier: BSD-2-Clause-Patent
8**/
9
10#ifndef _ACPI_6_1_H_
11#define _ACPI_6_1_H_
12
13#include <IndustryStandard/Acpi60.h>
14
15///
16/// _PSD Revision for ACPI 6.1
17///
18#define EFI_ACPI_6_1_AML_PSD_REVISION 0
19
20///
21/// _CPC Revision for ACPI 6.1
22///
23#define EFI_ACPI_6_1_AML_CPC_REVISION 2
24
25//
26// Ensure proper structure formats
27//
28#pragma pack(1)
29
30///
31/// ACPI 6.1 Generic Address Space definition
32///
33typedef struct {
34 UINT8 AddressSpaceId;
35 UINT8 RegisterBitWidth;
36 UINT8 RegisterBitOffset;
37 UINT8 AccessSize;
38 UINT64 Address;
39} EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE;
40
41//
42// Generic Address Space Address IDs
43//
44#define EFI_ACPI_6_1_SYSTEM_MEMORY 0
45#define EFI_ACPI_6_1_SYSTEM_IO 1
46#define EFI_ACPI_6_1_PCI_CONFIGURATION_SPACE 2
47#define EFI_ACPI_6_1_EMBEDDED_CONTROLLER 3
48#define EFI_ACPI_6_1_SMBUS 4
49#define EFI_ACPI_6_1_PLATFORM_COMMUNICATION_CHANNEL 0x0A
50#define EFI_ACPI_6_1_FUNCTIONAL_FIXED_HARDWARE 0x7F
51
52//
53// Generic Address Space Access Sizes
54//
55#define EFI_ACPI_6_1_UNDEFINED 0
56#define EFI_ACPI_6_1_BYTE 1
57#define EFI_ACPI_6_1_WORD 2
58#define EFI_ACPI_6_1_DWORD 3
59#define EFI_ACPI_6_1_QWORD 4
60
61//
62// ACPI 6.1 table structures
63//
64
65///
66/// Root System Description Pointer Structure
67///
68typedef struct {
69 UINT64 Signature;
70 UINT8 Checksum;
71 UINT8 OemId[6];
72 UINT8 Revision;
73 UINT32 RsdtAddress;
74 UINT32 Length;
75 UINT64 XsdtAddress;
76 UINT8 ExtendedChecksum;
77 UINT8 Reserved[3];
78} EFI_ACPI_6_1_ROOT_SYSTEM_DESCRIPTION_POINTER;
79
80///
81/// RSD_PTR Revision (as defined in ACPI 6.1 spec.)
82///
83#define EFI_ACPI_6_1_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02 ///< ACPISpec (Revision 6.1) says current value is 2
84
85///
86/// Common table header, this prefaces all ACPI tables, including FACS, but
87/// excluding the RSD PTR structure
88///
89typedef struct {
90 UINT32 Signature;
91 UINT32 Length;
92} EFI_ACPI_6_1_COMMON_HEADER;
93
94//
95// Root System Description Table
96// No definition needed as it is a common description table header, the same with
97// EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT32 table pointers.
98//
99
100///
101/// RSDT Revision (as defined in ACPI 6.1 spec.)
102///
103#define EFI_ACPI_6_1_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
104
105//
106// Extended System Description Table
107// No definition needed as it is a common description table header, the same with
108// EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT64 table pointers.
109//
110
111///
112/// XSDT Revision (as defined in ACPI 6.1 spec.)
113///
114#define EFI_ACPI_6_1_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
115
116///
117/// Fixed ACPI Description Table Structure (FADT)
118///
119typedef struct {
120 EFI_ACPI_DESCRIPTION_HEADER Header;
121 UINT32 FirmwareCtrl;
122 UINT32 Dsdt;
123 UINT8 Reserved0;
124 UINT8 PreferredPmProfile;
125 UINT16 SciInt;
126 UINT32 SmiCmd;
127 UINT8 AcpiEnable;
128 UINT8 AcpiDisable;
129 UINT8 S4BiosReq;
130 UINT8 PstateCnt;
131 UINT32 Pm1aEvtBlk;
132 UINT32 Pm1bEvtBlk;
133 UINT32 Pm1aCntBlk;
134 UINT32 Pm1bCntBlk;
135 UINT32 Pm2CntBlk;
136 UINT32 PmTmrBlk;
137 UINT32 Gpe0Blk;
138 UINT32 Gpe1Blk;
139 UINT8 Pm1EvtLen;
140 UINT8 Pm1CntLen;
141 UINT8 Pm2CntLen;
142 UINT8 PmTmrLen;
143 UINT8 Gpe0BlkLen;
144 UINT8 Gpe1BlkLen;
145 UINT8 Gpe1Base;
146 UINT8 CstCnt;
147 UINT16 PLvl2Lat;
148 UINT16 PLvl3Lat;
149 UINT16 FlushSize;
150 UINT16 FlushStride;
151 UINT8 DutyOffset;
152 UINT8 DutyWidth;
153 UINT8 DayAlrm;
154 UINT8 MonAlrm;
155 UINT8 Century;
156 UINT16 IaPcBootArch;
157 UINT8 Reserved1;
158 UINT32 Flags;
159 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE ResetReg;
160 UINT8 ResetValue;
161 UINT16 ArmBootArch;
162 UINT8 MinorVersion;
163 UINT64 XFirmwareCtrl;
164 UINT64 XDsdt;
165 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk;
166 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk;
167 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk;
168 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk;
169 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk;
170 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk;
171 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE XGpe0Blk;
172 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE XGpe1Blk;
173 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE SleepControlReg;
174 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE SleepStatusReg;
175 UINT64 HypervisorVendorIdentity;
176} EFI_ACPI_6_1_FIXED_ACPI_DESCRIPTION_TABLE;
177
178///
179/// FADT Version (as defined in ACPI 6.1 spec.)
180///
181#define EFI_ACPI_6_1_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x06
182#define EFI_ACPI_6_1_FIXED_ACPI_DESCRIPTION_TABLE_MINOR_REVISION 0x01
183
184//
185// Fixed ACPI Description Table Preferred Power Management Profile
186//
187#define EFI_ACPI_6_1_PM_PROFILE_UNSPECIFIED 0
188#define EFI_ACPI_6_1_PM_PROFILE_DESKTOP 1
189#define EFI_ACPI_6_1_PM_PROFILE_MOBILE 2
190#define EFI_ACPI_6_1_PM_PROFILE_WORKSTATION 3
191#define EFI_ACPI_6_1_PM_PROFILE_ENTERPRISE_SERVER 4
192#define EFI_ACPI_6_1_PM_PROFILE_SOHO_SERVER 5
193#define EFI_ACPI_6_1_PM_PROFILE_APPLIANCE_PC 6
194#define EFI_ACPI_6_1_PM_PROFILE_PERFORMANCE_SERVER 7
195#define EFI_ACPI_6_1_PM_PROFILE_TABLET 8
196
197//
198// Fixed ACPI Description Table Boot Architecture Flags
199// All other bits are reserved and must be set to 0.
200//
201#define EFI_ACPI_6_1_LEGACY_DEVICES BIT0
202#define EFI_ACPI_6_1_8042 BIT1
203#define EFI_ACPI_6_1_VGA_NOT_PRESENT BIT2
204#define EFI_ACPI_6_1_MSI_NOT_SUPPORTED BIT3
205#define EFI_ACPI_6_1_PCIE_ASPM_CONTROLS BIT4
206#define EFI_ACPI_6_1_CMOS_RTC_NOT_PRESENT BIT5
207
208//
209// Fixed ACPI Description Table Arm Boot Architecture Flags
210// All other bits are reserved and must be set to 0.
211//
212#define EFI_ACPI_6_1_ARM_PSCI_COMPLIANT BIT0
213#define EFI_ACPI_6_1_ARM_PSCI_USE_HVC BIT1
214
215//
216// Fixed ACPI Description Table Fixed Feature Flags
217// All other bits are reserved and must be set to 0.
218//
219#define EFI_ACPI_6_1_WBINVD BIT0
220#define EFI_ACPI_6_1_WBINVD_FLUSH BIT1
221#define EFI_ACPI_6_1_PROC_C1 BIT2
222#define EFI_ACPI_6_1_P_LVL2_UP BIT3
223#define EFI_ACPI_6_1_PWR_BUTTON BIT4
224#define EFI_ACPI_6_1_SLP_BUTTON BIT5
225#define EFI_ACPI_6_1_FIX_RTC BIT6
226#define EFI_ACPI_6_1_RTC_S4 BIT7
227#define EFI_ACPI_6_1_TMR_VAL_EXT BIT8
228#define EFI_ACPI_6_1_DCK_CAP BIT9
229#define EFI_ACPI_6_1_RESET_REG_SUP BIT10
230#define EFI_ACPI_6_1_SEALED_CASE BIT11
231#define EFI_ACPI_6_1_HEADLESS BIT12
232#define EFI_ACPI_6_1_CPU_SW_SLP BIT13
233#define EFI_ACPI_6_1_PCI_EXP_WAK BIT14
234#define EFI_ACPI_6_1_USE_PLATFORM_CLOCK BIT15
235#define EFI_ACPI_6_1_S4_RTC_STS_VALID BIT16
236#define EFI_ACPI_6_1_REMOTE_POWER_ON_CAPABLE BIT17
237#define EFI_ACPI_6_1_FORCE_APIC_CLUSTER_MODEL BIT18
238#define EFI_ACPI_6_1_FORCE_APIC_PHYSICAL_DESTINATION_MODE BIT19
239#define EFI_ACPI_6_1_HW_REDUCED_ACPI BIT20
240#define EFI_ACPI_6_1_LOW_POWER_S0_IDLE_CAPABLE BIT21
241
242///
243/// Firmware ACPI Control Structure
244///
245typedef struct {
246 UINT32 Signature;
247 UINT32 Length;
248 UINT32 HardwareSignature;
249 UINT32 FirmwareWakingVector;
250 UINT32 GlobalLock;
251 UINT32 Flags;
252 UINT64 XFirmwareWakingVector;
253 UINT8 Version;
254 UINT8 Reserved0[3];
255 UINT32 OspmFlags;
256 UINT8 Reserved1[24];
257} EFI_ACPI_6_1_FIRMWARE_ACPI_CONTROL_STRUCTURE;
258
259///
260/// FACS Version (as defined in ACPI 6.1 spec.)
261///
262#define EFI_ACPI_6_1_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION 0x02
263
264///
265/// Firmware Control Structure Feature Flags
266/// All other bits are reserved and must be set to 0.
267///
268#define EFI_ACPI_6_1_S4BIOS_F BIT0
269#define EFI_ACPI_6_1_64BIT_WAKE_SUPPORTED_F BIT1
270
271///
272/// OSPM Enabled Firmware Control Structure Flags
273/// All other bits are reserved and must be set to 0.
274///
275#define EFI_ACPI_6_1_OSPM_64BIT_WAKE_F BIT0
276
277//
278// Differentiated System Description Table,
279// Secondary System Description Table
280// and Persistent System Description Table,
281// no definition needed as they are common description table header, the same with
282// EFI_ACPI_DESCRIPTION_HEADER, followed by a definition block.
283//
284#define EFI_ACPI_6_1_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
285#define EFI_ACPI_6_1_SECONDARY_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
286
287///
288/// Multiple APIC Description Table header definition. The rest of the table
289/// must be defined in a platform specific manner.
290///
291typedef struct {
292 EFI_ACPI_DESCRIPTION_HEADER Header;
293 UINT32 LocalApicAddress;
294 UINT32 Flags;
295} EFI_ACPI_6_1_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;
296
297///
298/// MADT Revision (as defined in ACPI 6.1 spec.)
299///
300#define EFI_ACPI_6_1_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x04
301
302///
303/// Multiple APIC Flags
304/// All other bits are reserved and must be set to 0.
305///
306#define EFI_ACPI_6_1_PCAT_COMPAT BIT0
307
308//
309// Multiple APIC Description Table APIC structure types
310// All other values between 0x0D and 0x7F are reserved and
311// will be ignored by OSPM. 0x80 ~ 0xFF are reserved for OEM.
312//
313#define EFI_ACPI_6_1_PROCESSOR_LOCAL_APIC 0x00
314#define EFI_ACPI_6_1_IO_APIC 0x01
315#define EFI_ACPI_6_1_INTERRUPT_SOURCE_OVERRIDE 0x02
316#define EFI_ACPI_6_1_NON_MASKABLE_INTERRUPT_SOURCE 0x03
317#define EFI_ACPI_6_1_LOCAL_APIC_NMI 0x04
318#define EFI_ACPI_6_1_LOCAL_APIC_ADDRESS_OVERRIDE 0x05
319#define EFI_ACPI_6_1_IO_SAPIC 0x06
320#define EFI_ACPI_6_1_LOCAL_SAPIC 0x07
321#define EFI_ACPI_6_1_PLATFORM_INTERRUPT_SOURCES 0x08
322#define EFI_ACPI_6_1_PROCESSOR_LOCAL_X2APIC 0x09
323#define EFI_ACPI_6_1_LOCAL_X2APIC_NMI 0x0A
324#define EFI_ACPI_6_1_GIC 0x0B
325#define EFI_ACPI_6_1_GICD 0x0C
326#define EFI_ACPI_6_1_GIC_MSI_FRAME 0x0D
327#define EFI_ACPI_6_1_GICR 0x0E
328#define EFI_ACPI_6_1_GIC_ITS 0x0F
329
330//
331// APIC Structure Definitions
332//
333
334///
335/// Processor Local APIC Structure Definition
336///
337typedef struct {
338 UINT8 Type;
339 UINT8 Length;
340 UINT8 AcpiProcessorUid;
341 UINT8 ApicId;
342 UINT32 Flags;
343} EFI_ACPI_6_1_PROCESSOR_LOCAL_APIC_STRUCTURE;
344
345///
346/// Local APIC Flags. All other bits are reserved and must be 0.
347///
348#define EFI_ACPI_6_1_LOCAL_APIC_ENABLED BIT0
349
350///
351/// IO APIC Structure
352///
353typedef struct {
354 UINT8 Type;
355 UINT8 Length;
356 UINT8 IoApicId;
357 UINT8 Reserved;
358 UINT32 IoApicAddress;
359 UINT32 GlobalSystemInterruptBase;
360} EFI_ACPI_6_1_IO_APIC_STRUCTURE;
361
362///
363/// Interrupt Source Override Structure
364///
365typedef struct {
366 UINT8 Type;
367 UINT8 Length;
368 UINT8 Bus;
369 UINT8 Source;
370 UINT32 GlobalSystemInterrupt;
371 UINT16 Flags;
372} EFI_ACPI_6_1_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;
373
374///
375/// Platform Interrupt Sources Structure Definition
376///
377typedef struct {
378 UINT8 Type;
379 UINT8 Length;
380 UINT16 Flags;
381 UINT8 InterruptType;
382 UINT8 ProcessorId;
383 UINT8 ProcessorEid;
384 UINT8 IoSapicVector;
385 UINT32 GlobalSystemInterrupt;
386 UINT32 PlatformInterruptSourceFlags;
387 UINT8 CpeiProcessorOverride;
388 UINT8 Reserved[31];
389} EFI_ACPI_6_1_PLATFORM_INTERRUPT_APIC_STRUCTURE;
390
391//
392// MPS INTI flags.
393// All other bits are reserved and must be set to 0.
394//
395#define EFI_ACPI_6_1_POLARITY (3 << 0)
396#define EFI_ACPI_6_1_TRIGGER_MODE (3 << 2)
397
398///
399/// Non-Maskable Interrupt Source Structure
400///
401typedef struct {
402 UINT8 Type;
403 UINT8 Length;
404 UINT16 Flags;
405 UINT32 GlobalSystemInterrupt;
406} EFI_ACPI_6_1_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;
407
408///
409/// Local APIC NMI Structure
410///
411typedef struct {
412 UINT8 Type;
413 UINT8 Length;
414 UINT8 AcpiProcessorUid;
415 UINT16 Flags;
416 UINT8 LocalApicLint;
417} EFI_ACPI_6_1_LOCAL_APIC_NMI_STRUCTURE;
418
419///
420/// Local APIC Address Override Structure
421///
422typedef struct {
423 UINT8 Type;
424 UINT8 Length;
425 UINT16 Reserved;
426 UINT64 LocalApicAddress;
427} EFI_ACPI_6_1_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE;
428
429///
430/// IO SAPIC Structure
431///
432typedef struct {
433 UINT8 Type;
434 UINT8 Length;
435 UINT8 IoApicId;
436 UINT8 Reserved;
437 UINT32 GlobalSystemInterruptBase;
438 UINT64 IoSapicAddress;
439} EFI_ACPI_6_1_IO_SAPIC_STRUCTURE;
440
441///
442/// Local SAPIC Structure
443/// This struct followed by a null-terminated ASCII string - ACPI Processor UID String
444///
445typedef struct {
446 UINT8 Type;
447 UINT8 Length;
448 UINT8 AcpiProcessorId;
449 UINT8 LocalSapicId;
450 UINT8 LocalSapicEid;
451 UINT8 Reserved[3];
452 UINT32 Flags;
453 UINT32 ACPIProcessorUIDValue;
454} EFI_ACPI_6_1_PROCESSOR_LOCAL_SAPIC_STRUCTURE;
455
456///
457/// Platform Interrupt Sources Structure
458///
459typedef struct {
460 UINT8 Type;
461 UINT8 Length;
462 UINT16 Flags;
463 UINT8 InterruptType;
464 UINT8 ProcessorId;
465 UINT8 ProcessorEid;
466 UINT8 IoSapicVector;
467 UINT32 GlobalSystemInterrupt;
468 UINT32 PlatformInterruptSourceFlags;
469} EFI_ACPI_6_1_PLATFORM_INTERRUPT_SOURCES_STRUCTURE;
470
471///
472/// Platform Interrupt Source Flags.
473/// All other bits are reserved and must be set to 0.
474///
475#define EFI_ACPI_6_1_CPEI_PROCESSOR_OVERRIDE BIT0
476
477///
478/// Processor Local x2APIC Structure Definition
479///
480typedef struct {
481 UINT8 Type;
482 UINT8 Length;
483 UINT8 Reserved[2];
484 UINT32 X2ApicId;
485 UINT32 Flags;
486 UINT32 AcpiProcessorUid;
487} EFI_ACPI_6_1_PROCESSOR_LOCAL_X2APIC_STRUCTURE;
488
489///
490/// Local x2APIC NMI Structure
491///
492typedef struct {
493 UINT8 Type;
494 UINT8 Length;
495 UINT16 Flags;
496 UINT32 AcpiProcessorUid;
497 UINT8 LocalX2ApicLint;
498 UINT8 Reserved[3];
499} EFI_ACPI_6_1_LOCAL_X2APIC_NMI_STRUCTURE;
500
501///
502/// GIC Structure
503///
504typedef struct {
505 UINT8 Type;
506 UINT8 Length;
507 UINT16 Reserved;
508 UINT32 CPUInterfaceNumber;
509 UINT32 AcpiProcessorUid;
510 UINT32 Flags;
511 UINT32 ParkingProtocolVersion;
512 UINT32 PerformanceInterruptGsiv;
513 UINT64 ParkedAddress;
514 UINT64 PhysicalBaseAddress;
515 UINT64 GICV;
516 UINT64 GICH;
517 UINT32 VGICMaintenanceInterrupt;
518 UINT64 GICRBaseAddress;
519 UINT64 MPIDR;
520 UINT8 ProcessorPowerEfficiencyClass;
521 UINT8 Reserved2[3];
522} EFI_ACPI_6_1_GIC_STRUCTURE;
523
524///
525/// GIC Flags. All other bits are reserved and must be 0.
526///
527#define EFI_ACPI_6_1_GIC_ENABLED BIT0
528#define EFI_ACPI_6_1_PERFORMANCE_INTERRUPT_MODEL BIT1
529#define EFI_ACPI_6_1_VGIC_MAINTENANCE_INTERRUPT_MODE_FLAGS BIT2
530
531///
532/// GIC Distributor Structure
533///
534typedef struct {
535 UINT8 Type;
536 UINT8 Length;
537 UINT16 Reserved1;
538 UINT32 GicId;
539 UINT64 PhysicalBaseAddress;
540 UINT32 SystemVectorBase;
541 UINT8 GicVersion;
542 UINT8 Reserved2[3];
543} EFI_ACPI_6_1_GIC_DISTRIBUTOR_STRUCTURE;
544
545///
546/// GIC Version
547///
548#define EFI_ACPI_6_1_GIC_V1 0x01
549#define EFI_ACPI_6_1_GIC_V2 0x02
550#define EFI_ACPI_6_1_GIC_V3 0x03
551#define EFI_ACPI_6_1_GIC_V4 0x04
552
553///
554/// GIC MSI Frame Structure
555///
556typedef struct {
557 UINT8 Type;
558 UINT8 Length;
559 UINT16 Reserved1;
560 UINT32 GicMsiFrameId;
561 UINT64 PhysicalBaseAddress;
562 UINT32 Flags;
563 UINT16 SPICount;
564 UINT16 SPIBase;
565} EFI_ACPI_6_1_GIC_MSI_FRAME_STRUCTURE;
566
567///
568/// GIC MSI Frame Flags. All other bits are reserved and must be 0.
569///
570#define EFI_ACPI_6_1_SPI_COUNT_BASE_SELECT BIT0
571
572///
573/// GICR Structure
574///
575typedef struct {
576 UINT8 Type;
577 UINT8 Length;
578 UINT16 Reserved;
579 UINT64 DiscoveryRangeBaseAddress;
580 UINT32 DiscoveryRangeLength;
581} EFI_ACPI_6_1_GICR_STRUCTURE;
582
583///
584/// GIC Interrupt Translation Service Structure
585///
586typedef struct {
587 UINT8 Type;
588 UINT8 Length;
589 UINT16 Reserved;
590 UINT32 GicItsId;
591 UINT64 PhysicalBaseAddress;
592 UINT32 Reserved2;
593} EFI_ACPI_6_1_GIC_ITS_STRUCTURE;
594
595///
596/// Smart Battery Description Table (SBST)
597///
598typedef struct {
599 EFI_ACPI_DESCRIPTION_HEADER Header;
600 UINT32 WarningEnergyLevel;
601 UINT32 LowEnergyLevel;
602 UINT32 CriticalEnergyLevel;
603} EFI_ACPI_6_1_SMART_BATTERY_DESCRIPTION_TABLE;
604
605///
606/// SBST Version (as defined in ACPI 6.1 spec.)
607///
608#define EFI_ACPI_6_1_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01
609
610///
611/// Embedded Controller Boot Resources Table (ECDT)
612/// The table is followed by a null terminated ASCII string that contains
613/// a fully qualified reference to the name space object.
614///
615typedef struct {
616 EFI_ACPI_DESCRIPTION_HEADER Header;
617 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE EcControl;
618 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE EcData;
619 UINT32 Uid;
620 UINT8 GpeBit;
621} EFI_ACPI_6_1_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE;
622
623///
624/// ECDT Version (as defined in ACPI 6.1 spec.)
625///
626#define EFI_ACPI_6_1_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_REVISION 0x01
627
628///
629/// System Resource Affinity Table (SRAT). The rest of the table
630/// must be defined in a platform specific manner.
631///
632typedef struct {
633 EFI_ACPI_DESCRIPTION_HEADER Header;
634 UINT32 Reserved1; ///< Must be set to 1
635 UINT64 Reserved2;
636} EFI_ACPI_6_1_SYSTEM_RESOURCE_AFFINITY_TABLE_HEADER;
637
638///
639/// SRAT Version (as defined in ACPI 6.1 spec.)
640///
641#define EFI_ACPI_6_1_SYSTEM_RESOURCE_AFFINITY_TABLE_REVISION 0x03
642
643//
644// SRAT structure types.
645// All other values between 0x04 an 0xFF are reserved and
646// will be ignored by OSPM.
647//
648#define EFI_ACPI_6_1_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY 0x00
649#define EFI_ACPI_6_1_MEMORY_AFFINITY 0x01
650#define EFI_ACPI_6_1_PROCESSOR_LOCAL_X2APIC_AFFINITY 0x02
651#define EFI_ACPI_6_1_GICC_AFFINITY 0x03
652
653///
654/// Processor Local APIC/SAPIC Affinity Structure Definition
655///
656typedef struct {
657 UINT8 Type;
658 UINT8 Length;
659 UINT8 ProximityDomain7To0;
660 UINT8 ApicId;
661 UINT32 Flags;
662 UINT8 LocalSapicEid;
663 UINT8 ProximityDomain31To8[3];
664 UINT32 ClockDomain;
665} EFI_ACPI_6_1_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY_STRUCTURE;
666
667///
668/// Local APIC/SAPIC Flags. All other bits are reserved and must be 0.
669///
670#define EFI_ACPI_6_1_PROCESSOR_LOCAL_APIC_SAPIC_ENABLED (1 << 0)
671
672///
673/// Memory Affinity Structure Definition
674///
675typedef struct {
676 UINT8 Type;
677 UINT8 Length;
678 UINT32 ProximityDomain;
679 UINT16 Reserved1;
680 UINT32 AddressBaseLow;
681 UINT32 AddressBaseHigh;
682 UINT32 LengthLow;
683 UINT32 LengthHigh;
684 UINT32 Reserved2;
685 UINT32 Flags;
686 UINT64 Reserved3;
687} EFI_ACPI_6_1_MEMORY_AFFINITY_STRUCTURE;
688
689//
690// Memory Flags. All other bits are reserved and must be 0.
691//
692#define EFI_ACPI_6_1_MEMORY_ENABLED (1 << 0)
693#define EFI_ACPI_6_1_MEMORY_HOT_PLUGGABLE (1 << 1)
694#define EFI_ACPI_6_1_MEMORY_NONVOLATILE (1 << 2)
695
696///
697/// Processor Local x2APIC Affinity Structure Definition
698///
699typedef struct {
700 UINT8 Type;
701 UINT8 Length;
702 UINT8 Reserved1[2];
703 UINT32 ProximityDomain;
704 UINT32 X2ApicId;
705 UINT32 Flags;
706 UINT32 ClockDomain;
707 UINT8 Reserved2[4];
708} EFI_ACPI_6_1_PROCESSOR_LOCAL_X2APIC_AFFINITY_STRUCTURE;
709
710///
711/// GICC Affinity Structure Definition
712///
713typedef struct {
714 UINT8 Type;
715 UINT8 Length;
716 UINT32 ProximityDomain;
717 UINT32 AcpiProcessorUid;
718 UINT32 Flags;
719 UINT32 ClockDomain;
720} EFI_ACPI_6_1_GICC_AFFINITY_STRUCTURE;
721
722///
723/// GICC Flags. All other bits are reserved and must be 0.
724///
725#define EFI_ACPI_6_1_GICC_ENABLED (1 << 0)
726
727///
728/// System Locality Distance Information Table (SLIT).
729/// The rest of the table is a matrix.
730///
731typedef struct {
732 EFI_ACPI_DESCRIPTION_HEADER Header;
733 UINT64 NumberOfSystemLocalities;
734} EFI_ACPI_6_1_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_HEADER;
735
736///
737/// SLIT Version (as defined in ACPI 6.1 spec.)
738///
739#define EFI_ACPI_6_1_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_REVISION 0x01
740
741///
742/// Corrected Platform Error Polling Table (CPEP)
743///
744typedef struct {
745 EFI_ACPI_DESCRIPTION_HEADER Header;
746 UINT8 Reserved[8];
747} EFI_ACPI_6_1_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_HEADER;
748
749///
750/// CPEP Version (as defined in ACPI 6.1 spec.)
751///
752#define EFI_ACPI_6_1_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_REVISION 0x01
753
754//
755// CPEP processor structure types.
756//
757#define EFI_ACPI_6_1_CPEP_PROCESSOR_APIC_SAPIC 0x00
758
759///
760/// Corrected Platform Error Polling Processor Structure Definition
761///
762typedef struct {
763 UINT8 Type;
764 UINT8 Length;
765 UINT8 ProcessorId;
766 UINT8 ProcessorEid;
767 UINT32 PollingInterval;
768} EFI_ACPI_6_1_CPEP_PROCESSOR_APIC_SAPIC_STRUCTURE;
769
770///
771/// Maximum System Characteristics Table (MSCT)
772///
773typedef struct {
774 EFI_ACPI_DESCRIPTION_HEADER Header;
775 UINT32 OffsetProxDomInfo;
776 UINT32 MaximumNumberOfProximityDomains;
777 UINT32 MaximumNumberOfClockDomains;
778 UINT64 MaximumPhysicalAddress;
779} EFI_ACPI_6_1_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_HEADER;
780
781///
782/// MSCT Version (as defined in ACPI 6.1 spec.)
783///
784#define EFI_ACPI_6_1_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_REVISION 0x01
785
786///
787/// Maximum Proximity Domain Information Structure Definition
788///
789typedef struct {
790 UINT8 Revision;
791 UINT8 Length;
792 UINT32 ProximityDomainRangeLow;
793 UINT32 ProximityDomainRangeHigh;
794 UINT32 MaximumProcessorCapacity;
795 UINT64 MaximumMemoryCapacity;
796} EFI_ACPI_6_1_MAXIMUM_PROXIMITY_DOMAIN_INFORMATION_STRUCTURE;
797
798///
799/// ACPI RAS Feature Table definition.
800///
801typedef struct {
802 EFI_ACPI_DESCRIPTION_HEADER Header;
803 UINT8 PlatformCommunicationChannelIdentifier[12];
804} EFI_ACPI_6_1_RAS_FEATURE_TABLE;
805
806///
807/// RASF Version (as defined in ACPI 6.1 spec.)
808///
809#define EFI_ACPI_6_1_RAS_FEATURE_TABLE_REVISION 0x01
810
811///
812/// ACPI RASF Platform Communication Channel Shared Memory Region definition.
813///
814typedef struct {
815 UINT32 Signature;
816 UINT16 Command;
817 UINT16 Status;
818 UINT16 Version;
819 UINT8 RASCapabilities[16];
820 UINT8 SetRASCapabilities[16];
821 UINT16 NumberOfRASFParameterBlocks;
822 UINT32 SetRASCapabilitiesStatus;
823} EFI_ACPI_6_1_RASF_PLATFORM_COMMUNICATION_CHANNEL_SHARED_MEMORY_REGION;
824
825///
826/// ACPI RASF PCC command code
827///
828#define EFI_ACPI_6_1_RASF_PCC_COMMAND_CODE_EXECUTE_RASF_COMMAND 0x01
829
830///
831/// ACPI RASF Platform RAS Capabilities
832///
833#define EFI_ACPI_6_1_RASF_PLATFORM_RAS_CAPABILITY_HARDWARE_BASED_PATROL_SCRUB_SUPPOTED 0x01
834#define EFI_ACPI_6_1_RASF_PLATFORM_RAS_CAPABILITY_HARDWARE_BASED_PATROL_SCRUB_SUPPOTED_AND_EXPOSED_TO_SOFTWARE 0x02
835
836///
837/// ACPI RASF Parameter Block structure for PATROL_SCRUB
838///
839typedef struct {
840 UINT16 Type;
841 UINT16 Version;
842 UINT16 Length;
843 UINT16 PatrolScrubCommand;
844 UINT64 RequestedAddressRange[2];
845 UINT64 ActualAddressRange[2];
846 UINT16 Flags;
847 UINT8 RequestedSpeed;
848} EFI_ACPI_6_1_RASF_PATROL_SCRUB_PLATFORM_BLOCK_STRUCTURE;
849
850///
851/// ACPI RASF Patrol Scrub command
852///
853#define EFI_ACPI_6_1_RASF_PATROL_SCRUB_COMMAND_GET_PATROL_PARAMETERS 0x01
854#define EFI_ACPI_6_1_RASF_PATROL_SCRUB_COMMAND_START_PATROL_SCRUBBER 0x02
855#define EFI_ACPI_6_1_RASF_PATROL_SCRUB_COMMAND_STOP_PATROL_SCRUBBER 0x03
856
857///
858/// Memory Power State Table definition.
859///
860typedef struct {
861 EFI_ACPI_DESCRIPTION_HEADER Header;
862 UINT8 PlatformCommunicationChannelIdentifier;
863 UINT8 Reserved[3];
864 // Memory Power Node Structure
865 // Memory Power State Characteristics
866} EFI_ACPI_6_1_MEMORY_POWER_STATUS_TABLE;
867
868///
869/// MPST Version (as defined in ACPI 6.1 spec.)
870///
871#define EFI_ACPI_6_1_MEMORY_POWER_STATE_TABLE_REVISION 0x01
872
873///
874/// MPST Platform Communication Channel Shared Memory Region definition.
875///
876typedef struct {
877 UINT32 Signature;
878 UINT16 Command;
879 UINT16 Status;
880 UINT32 MemoryPowerCommandRegister;
881 UINT32 MemoryPowerStatusRegister;
882 UINT32 PowerStateId;
883 UINT32 MemoryPowerNodeId;
884 UINT64 MemoryEnergyConsumed;
885 UINT64 ExpectedAveragePowerComsuned;
886} EFI_ACPI_6_1_MPST_PLATFORM_COMMUNICATION_CHANNEL_SHARED_MEMORY_REGION;
887
888///
889/// ACPI MPST PCC command code
890///
891#define EFI_ACPI_6_1_MPST_PCC_COMMAND_CODE_EXECUTE_MPST_COMMAND 0x03
892
893///
894/// ACPI MPST Memory Power command
895///
896#define EFI_ACPI_6_1_MPST_MEMORY_POWER_COMMAND_GET_MEMORY_POWER_STATE 0x01
897#define EFI_ACPI_6_1_MPST_MEMORY_POWER_COMMAND_SET_MEMORY_POWER_STATE 0x02
898#define EFI_ACPI_6_1_MPST_MEMORY_POWER_COMMAND_GET_AVERAGE_POWER_CONSUMED 0x03
899#define EFI_ACPI_6_1_MPST_MEMORY_POWER_COMMAND_GET_MEMORY_ENERGY_CONSUMED 0x04
900
901///
902/// MPST Memory Power Node Table
903///
904typedef struct {
905 UINT8 PowerStateValue;
906 UINT8 PowerStateInformationIndex;
907} EFI_ACPI_6_1_MPST_MEMORY_POWER_STATE;
908
909typedef struct {
910 UINT8 Flag;
911 UINT8 Reserved;
912 UINT16 MemoryPowerNodeId;
913 UINT32 Length;
914 UINT64 AddressBase;
915 UINT64 AddressLength;
916 UINT32 NumberOfPowerStates;
917 UINT32 NumberOfPhysicalComponents;
918 // EFI_ACPI_6_1_MPST_MEMORY_POWER_STATE MemoryPowerState[NumberOfPowerStates];
919 // UINT16 PhysicalComponentIdentifier[NumberOfPhysicalComponents];
920} EFI_ACPI_6_1_MPST_MEMORY_POWER_STRUCTURE;
921
922#define EFI_ACPI_6_1_MPST_MEMORY_POWER_STRUCTURE_FLAG_ENABLE 0x01
923#define EFI_ACPI_6_1_MPST_MEMORY_POWER_STRUCTURE_FLAG_POWER_MANAGED 0x02
924#define EFI_ACPI_6_1_MPST_MEMORY_POWER_STRUCTURE_FLAG_HOT_PLUGGABLE 0x04
925
926typedef struct {
927 UINT16 MemoryPowerNodeCount;
928 UINT8 Reserved[2];
929} EFI_ACPI_6_1_MPST_MEMORY_POWER_NODE_TABLE;
930
931///
932/// MPST Memory Power State Characteristics Table
933///
934typedef struct {
935 UINT8 PowerStateStructureID;
936 UINT8 Flag;
937 UINT16 Reserved;
938 UINT32 AveragePowerConsumedInMPS0;
939 UINT32 RelativePowerSavingToMPS0;
940 UINT64 ExitLatencyToMPS0;
941} EFI_ACPI_6_1_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE;
942
943#define EFI_ACPI_6_1_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_MEMORY_CONTENT_PRESERVED 0x01
944#define EFI_ACPI_6_1_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_AUTONOMOUS_MEMORY_POWER_STATE_ENTRY 0x02
945#define EFI_ACPI_6_1_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_AUTONOMOUS_MEMORY_POWER_STATE_EXIT 0x04
946
947typedef struct {
948 UINT16 MemoryPowerStateCharacteristicsCount;
949 UINT8 Reserved[2];
950} EFI_ACPI_6_1_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_TABLE;
951
952///
953/// Memory Topology Table definition.
954///
955typedef struct {
956 EFI_ACPI_DESCRIPTION_HEADER Header;
957 UINT32 Reserved;
958} EFI_ACPI_6_1_MEMORY_TOPOLOGY_TABLE;
959
960///
961/// PMTT Version (as defined in ACPI 6.1 spec.)
962///
963#define EFI_ACPI_6_1_MEMORY_TOPOLOGY_TABLE_REVISION 0x01
964
965///
966/// Common Memory Aggregator Device Structure.
967///
968typedef struct {
969 UINT8 Type;
970 UINT8 Reserved;
971 UINT16 Length;
972 UINT16 Flags;
973 UINT16 Reserved1;
974} EFI_ACPI_6_1_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;
975
976///
977/// Memory Aggregator Device Type
978///
979#define EFI_ACPI_6_1_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_SOCKET 0x0
980#define EFI_ACPI_6_1_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_MEMORY_CONTROLLER 0x1
981#define EFI_ACPI_6_1_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_DIMM 0x2
982
983///
984/// Socket Memory Aggregator Device Structure.
985///
986typedef struct {
987 EFI_ACPI_6_1_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;
988 UINT16 SocketIdentifier;
989 UINT16 Reserved;
990 // EFI_ACPI_6_1_PMMT_MEMORY_CONTROLLER_MEMORY_AGGREGATOR_DEVICE_STRUCTURE MemoryController[];
991} EFI_ACPI_6_1_PMMT_SOCKET_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;
992
993///
994/// MemoryController Memory Aggregator Device Structure.
995///
996typedef struct {
997 EFI_ACPI_6_1_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;
998 UINT32 ReadLatency;
999 UINT32 WriteLatency;
1000 UINT32 ReadBandwidth;
1001 UINT32 WriteBandwidth;
1002 UINT16 OptimalAccessUnit;
1003 UINT16 OptimalAccessAlignment;
1004 UINT16 Reserved;
1005 UINT16 NumberOfProximityDomains;
1006 // UINT32 ProximityDomain[NumberOfProximityDomains];
1007 // EFI_ACPI_6_1_PMMT_DIMM_MEMORY_AGGREGATOR_DEVICE_STRUCTURE PhysicalComponent[];
1008} EFI_ACPI_6_1_PMMT_MEMORY_CONTROLLER_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;
1009
1010///
1011/// DIMM Memory Aggregator Device Structure.
1012///
1013typedef struct {
1014 EFI_ACPI_6_1_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;
1015 UINT16 PhysicalComponentIdentifier;
1016 UINT16 Reserved;
1017 UINT32 SizeOfDimm;
1018 UINT32 SmbiosHandle;
1019} EFI_ACPI_6_1_PMMT_DIMM_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;
1020
1021///
1022/// Boot Graphics Resource Table definition.
1023///
1024typedef struct {
1025 EFI_ACPI_DESCRIPTION_HEADER Header;
1026 ///
1027 /// 2-bytes (16 bit) version ID. This value must be 1.
1028 ///
1029 UINT16 Version;
1030 ///
1031 /// 1-byte status field indicating current status about the table.
1032 /// Bits[7:1] = Reserved (must be zero)
1033 /// Bit [0] = Valid. A one indicates the boot image graphic is valid.
1034 ///
1035 UINT8 Status;
1036 ///
1037 /// 1-byte enumerated type field indicating format of the image.
1038 /// 0 = Bitmap
1039 /// 1 - 255 Reserved (for future use)
1040 ///
1041 UINT8 ImageType;
1042 ///
1043 /// 8-byte (64 bit) physical address pointing to the firmware's in-memory copy
1044 /// of the image bitmap.
1045 ///
1046 UINT64 ImageAddress;
1047 ///
1048 /// A 4-byte (32-bit) unsigned long describing the display X-offset of the boot image.
1049 /// (X, Y) display offset of the top left corner of the boot image.
1050 /// The top left corner of the display is at offset (0, 0).
1051 ///
1052 UINT32 ImageOffsetX;
1053 ///
1054 /// A 4-byte (32-bit) unsigned long describing the display Y-offset of the boot image.
1055 /// (X, Y) display offset of the top left corner of the boot image.
1056 /// The top left corner of the display is at offset (0, 0).
1057 ///
1058 UINT32 ImageOffsetY;
1059} EFI_ACPI_6_1_BOOT_GRAPHICS_RESOURCE_TABLE;
1060
1061///
1062/// BGRT Revision
1063///
1064#define EFI_ACPI_6_1_BOOT_GRAPHICS_RESOURCE_TABLE_REVISION 1
1065
1066///
1067/// BGRT Version
1068///
1069#define EFI_ACPI_6_1_BGRT_VERSION 0x01
1070
1071///
1072/// BGRT Status
1073///
1074#define EFI_ACPI_6_1_BGRT_STATUS_NOT_DISPLAYED 0x00
1075#define EFI_ACPI_6_1_BGRT_STATUS_DISPLAYED 0x01
1076
1077///
1078/// BGRT Image Type
1079///
1080#define EFI_ACPI_6_1_BGRT_IMAGE_TYPE_BMP 0x00
1081
1082///
1083/// FPDT Version (as defined in ACPI 6.1 spec.)
1084///
1085#define EFI_ACPI_6_1_FIRMWARE_PERFORMANCE_DATA_TABLE_REVISION 0x01
1086
1087///
1088/// FPDT Performance Record Types
1089///
1090#define EFI_ACPI_6_1_FPDT_RECORD_TYPE_FIRMWARE_BASIC_BOOT_POINTER 0x0000
1091#define EFI_ACPI_6_1_FPDT_RECORD_TYPE_S3_PERFORMANCE_TABLE_POINTER 0x0001
1092
1093///
1094/// FPDT Performance Record Revision
1095///
1096#define EFI_ACPI_6_1_FPDT_RECORD_REVISION_FIRMWARE_BASIC_BOOT_POINTER 0x01
1097#define EFI_ACPI_6_1_FPDT_RECORD_REVISION_S3_PERFORMANCE_TABLE_POINTER 0x01
1098
1099///
1100/// FPDT Runtime Performance Record Types
1101///
1102#define EFI_ACPI_6_1_FPDT_RUNTIME_RECORD_TYPE_S3_RESUME 0x0000
1103#define EFI_ACPI_6_1_FPDT_RUNTIME_RECORD_TYPE_S3_SUSPEND 0x0001
1104#define EFI_ACPI_6_1_FPDT_RUNTIME_RECORD_TYPE_FIRMWARE_BASIC_BOOT 0x0002
1105
1106///
1107/// FPDT Runtime Performance Record Revision
1108///
1109#define EFI_ACPI_6_1_FPDT_RUNTIME_RECORD_REVISION_S3_RESUME 0x01
1110#define EFI_ACPI_6_1_FPDT_RUNTIME_RECORD_REVISION_S3_SUSPEND 0x01
1111#define EFI_ACPI_6_1_FPDT_RUNTIME_RECORD_REVISION_FIRMWARE_BASIC_BOOT 0x02
1112
1113///
1114/// FPDT Performance Record header
1115///
1116typedef struct {
1117 UINT16 Type;
1118 UINT8 Length;
1119 UINT8 Revision;
1120} EFI_ACPI_6_1_FPDT_PERFORMANCE_RECORD_HEADER;
1121
1122///
1123/// FPDT Performance Table header
1124///
1125typedef struct {
1126 UINT32 Signature;
1127 UINT32 Length;
1128} EFI_ACPI_6_1_FPDT_PERFORMANCE_TABLE_HEADER;
1129
1130///
1131/// FPDT Firmware Basic Boot Performance Pointer Record Structure
1132///
1133typedef struct {
1134 EFI_ACPI_6_1_FPDT_PERFORMANCE_RECORD_HEADER Header;
1135 UINT32 Reserved;
1136 ///
1137 /// 64-bit processor-relative physical address of the Basic Boot Performance Table.
1138 ///
1139 UINT64 BootPerformanceTablePointer;
1140} EFI_ACPI_6_1_FPDT_BOOT_PERFORMANCE_TABLE_POINTER_RECORD;
1141
1142///
1143/// FPDT S3 Performance Table Pointer Record Structure
1144///
1145typedef struct {
1146 EFI_ACPI_6_1_FPDT_PERFORMANCE_RECORD_HEADER Header;
1147 UINT32 Reserved;
1148 ///
1149 /// 64-bit processor-relative physical address of the S3 Performance Table.
1150 ///
1151 UINT64 S3PerformanceTablePointer;
1152} EFI_ACPI_6_1_FPDT_S3_PERFORMANCE_TABLE_POINTER_RECORD;
1153
1154///
1155/// FPDT Firmware Basic Boot Performance Record Structure
1156///
1157typedef struct {
1158 EFI_ACPI_6_1_FPDT_PERFORMANCE_RECORD_HEADER Header;
1159 UINT32 Reserved;
1160 ///
1161 /// Timer value logged at the beginning of firmware image execution.
1162 /// This may not always be zero or near zero.
1163 ///
1164 UINT64 ResetEnd;
1165 ///
1166 /// Timer value logged just prior to loading the OS boot loader into memory.
1167 /// For non-UEFI compatible boots, this field must be zero.
1168 ///
1169 UINT64 OsLoaderLoadImageStart;
1170 ///
1171 /// Timer value logged just prior to launching the previously loaded OS boot loader image.
1172 /// For non-UEFI compatible boots, the timer value logged will be just prior
1173 /// to the INT 19h handler invocation.
1174 ///
1175 UINT64 OsLoaderStartImageStart;
1176 ///
1177 /// Timer value logged at the point when the OS loader calls the
1178 /// ExitBootServices function for UEFI compatible firmware.
1179 /// For non-UEFI compatible boots, this field must be zero.
1180 ///
1181 UINT64 ExitBootServicesEntry;
1182 ///
1183 /// Timer value logged at the point just prior to when the OS loader gaining
1184 /// control back from calls the ExitBootServices function for UEFI compatible firmware.
1185 /// For non-UEFI compatible boots, this field must be zero.
1186 ///
1187 UINT64 ExitBootServicesExit;
1188} EFI_ACPI_6_1_FPDT_FIRMWARE_BASIC_BOOT_RECORD;
1189
1190///
1191/// FPDT Firmware Basic Boot Performance Table signature
1192///
1193#define EFI_ACPI_6_1_FPDT_BOOT_PERFORMANCE_TABLE_SIGNATURE SIGNATURE_32('F', 'B', 'P', 'T')
1194
1195//
1196// FPDT Firmware Basic Boot Performance Table
1197//
1198typedef struct {
1199 EFI_ACPI_6_1_FPDT_PERFORMANCE_TABLE_HEADER Header;
1200 //
1201 // one or more Performance Records.
1202 //
1203} EFI_ACPI_6_1_FPDT_FIRMWARE_BASIC_BOOT_TABLE;
1204
1205///
1206/// FPDT "S3PT" S3 Performance Table
1207///
1208#define EFI_ACPI_6_1_FPDT_S3_PERFORMANCE_TABLE_SIGNATURE SIGNATURE_32('S', '3', 'P', 'T')
1209
1210//
1211// FPDT Firmware S3 Boot Performance Table
1212//
1213typedef struct {
1214 EFI_ACPI_6_1_FPDT_PERFORMANCE_TABLE_HEADER Header;
1215 //
1216 // one or more Performance Records.
1217 //
1218} EFI_ACPI_6_1_FPDT_FIRMWARE_S3_BOOT_TABLE;
1219
1220///
1221/// FPDT Basic S3 Resume Performance Record
1222///
1223typedef struct {
1224 EFI_ACPI_6_1_FPDT_PERFORMANCE_RECORD_HEADER Header;
1225 ///
1226 /// A count of the number of S3 resume cycles since the last full boot sequence.
1227 ///
1228 UINT32 ResumeCount;
1229 ///
1230 /// Timer recorded at the end of BIOS S3 resume, just prior to handoff to the
1231 /// OS waking vector. Only the most recent resume cycle's time is retained.
1232 ///
1233 UINT64 FullResume;
1234 ///
1235 /// Average timer value of all resume cycles logged since the last full boot
1236 /// sequence, including the most recent resume. Note that the entire log of
1237 /// timer values does not need to be retained in order to calculate this average.
1238 ///
1239 UINT64 AverageResume;
1240} EFI_ACPI_6_1_FPDT_S3_RESUME_RECORD;
1241
1242///
1243/// FPDT Basic S3 Suspend Performance Record
1244///
1245typedef struct {
1246 EFI_ACPI_6_1_FPDT_PERFORMANCE_RECORD_HEADER Header;
1247 ///
1248 /// Timer value recorded at the OS write to SLP_TYP upon entry to S3.
1249 /// Only the most recent suspend cycle's timer value is retained.
1250 ///
1251 UINT64 SuspendStart;
1252 ///
1253 /// Timer value recorded at the final firmware write to SLP_TYP (or other
1254 /// mechanism) used to trigger hardware entry to S3.
1255 /// Only the most recent suspend cycle's timer value is retained.
1256 ///
1257 UINT64 SuspendEnd;
1258} EFI_ACPI_6_1_FPDT_S3_SUSPEND_RECORD;
1259
1260///
1261/// Firmware Performance Record Table definition.
1262///
1263typedef struct {
1264 EFI_ACPI_DESCRIPTION_HEADER Header;
1265} EFI_ACPI_6_1_FIRMWARE_PERFORMANCE_RECORD_TABLE;
1266
1267///
1268/// Generic Timer Description Table definition.
1269///
1270typedef struct {
1271 EFI_ACPI_DESCRIPTION_HEADER Header;
1272 UINT64 CntControlBasePhysicalAddress;
1273 UINT32 Reserved;
1274 UINT32 SecurePL1TimerGSIV;
1275 UINT32 SecurePL1TimerFlags;
1276 UINT32 NonSecurePL1TimerGSIV;
1277 UINT32 NonSecurePL1TimerFlags;
1278 UINT32 VirtualTimerGSIV;
1279 UINT32 VirtualTimerFlags;
1280 UINT32 NonSecurePL2TimerGSIV;
1281 UINT32 NonSecurePL2TimerFlags;
1282 UINT64 CntReadBasePhysicalAddress;
1283 UINT32 PlatformTimerCount;
1284 UINT32 PlatformTimerOffset;
1285} EFI_ACPI_6_1_GENERIC_TIMER_DESCRIPTION_TABLE;
1286
1287///
1288/// GTDT Version (as defined in ACPI 6.1 spec.)
1289///
1290#define EFI_ACPI_6_1_GENERIC_TIMER_DESCRIPTION_TABLE_REVISION 0x02
1291
1292///
1293/// Timer Flags. All other bits are reserved and must be 0.
1294///
1295#define EFI_ACPI_6_1_GTDT_TIMER_FLAG_TIMER_INTERRUPT_MODE BIT0
1296#define EFI_ACPI_6_1_GTDT_TIMER_FLAG_TIMER_INTERRUPT_POLARITY BIT1
1297#define EFI_ACPI_6_1_GTDT_TIMER_FLAG_ALWAYS_ON_CAPABILITY BIT2
1298
1299///
1300/// Platform Timer Type
1301///
1302#define EFI_ACPI_6_1_GTDT_GT_BLOCK 0
1303#define EFI_ACPI_6_1_GTDT_SBSA_GENERIC_WATCHDOG 1
1304
1305///
1306/// GT Block Structure
1307///
1308typedef struct {
1309 UINT8 Type;
1310 UINT16 Length;
1311 UINT8 Reserved;
1312 UINT64 CntCtlBase;
1313 UINT32 GTBlockTimerCount;
1314 UINT32 GTBlockTimerOffset;
1315} EFI_ACPI_6_1_GTDT_GT_BLOCK_STRUCTURE;
1316
1317///
1318/// GT Block Timer Structure
1319///
1320typedef struct {
1321 UINT8 GTFrameNumber;
1322 UINT8 Reserved[3];
1323 UINT64 CntBaseX;
1324 UINT64 CntEL0BaseX;
1325 UINT32 GTxPhysicalTimerGSIV;
1326 UINT32 GTxPhysicalTimerFlags;
1327 UINT32 GTxVirtualTimerGSIV;
1328 UINT32 GTxVirtualTimerFlags;
1329 UINT32 GTxCommonFlags;
1330} EFI_ACPI_6_1_GTDT_GT_BLOCK_TIMER_STRUCTURE;
1331
1332///
1333/// GT Block Physical Timers and Virtual Timers Flags. All other bits are reserved and must be 0.
1334///
1335#define EFI_ACPI_6_1_GTDT_GT_BLOCK_TIMER_FLAG_TIMER_INTERRUPT_MODE BIT0
1336#define EFI_ACPI_6_1_GTDT_GT_BLOCK_TIMER_FLAG_TIMER_INTERRUPT_POLARITY BIT1
1337
1338///
1339/// Common Flags Flags. All other bits are reserved and must be 0.
1340///
1341#define EFI_ACPI_6_1_GTDT_GT_BLOCK_COMMON_FLAG_SECURE_TIMER BIT0
1342#define EFI_ACPI_6_1_GTDT_GT_BLOCK_COMMON_FLAG_ALWAYS_ON_CAPABILITY BIT1
1343
1344///
1345/// SBSA Generic Watchdog Structure
1346///
1347typedef struct {
1348 UINT8 Type;
1349 UINT16 Length;
1350 UINT8 Reserved;
1351 UINT64 RefreshFramePhysicalAddress;
1352 UINT64 WatchdogControlFramePhysicalAddress;
1353 UINT32 WatchdogTimerGSIV;
1354 UINT32 WatchdogTimerFlags;
1355} EFI_ACPI_6_1_GTDT_SBSA_GENERIC_WATCHDOG_STRUCTURE;
1356
1357///
1358/// SBSA Generic Watchdog Timer Flags. All other bits are reserved and must be 0.
1359///
1360#define EFI_ACPI_6_1_GTDT_SBSA_GENERIC_WATCHDOG_FLAG_TIMER_INTERRUPT_MODE BIT0
1361#define EFI_ACPI_6_1_GTDT_SBSA_GENERIC_WATCHDOG_FLAG_TIMER_INTERRUPT_POLARITY BIT1
1362#define EFI_ACPI_6_1_GTDT_SBSA_GENERIC_WATCHDOG_FLAG_SECURE_TIMER BIT2
1363
1364//
1365// NVDIMM Firmware Interface Table definition.
1366//
1367typedef struct {
1368 EFI_ACPI_DESCRIPTION_HEADER Header;
1369 UINT32 Reserved;
1370} EFI_ACPI_6_1_NVDIMM_FIRMWARE_INTERFACE_TABLE;
1371
1372//
1373// NFIT Version (as defined in ACPI 6.1 spec.)
1374//
1375#define EFI_ACPI_6_1_NVDIMM_FIRMWARE_INTERFACE_TABLE_REVISION 0x1
1376
1377//
1378// Definition for NFIT Table Structure Types
1379//
1380#define EFI_ACPI_6_1_NFIT_SYSTEM_PHYSICAL_ADDRESS_RANGE_STRUCTURE_TYPE 0
1381#define EFI_ACPI_6_1_NFIT_NVDIMM_REGION_MAPPING_STRUCTURE_TYPE 1
1382#define EFI_ACPI_6_1_NFIT_INTERLEAVE_STRUCTURE_TYPE 2
1383#define EFI_ACPI_6_1_NFIT_SMBIOS_MANAGEMENT_INFORMATION_STRUCTURE_TYPE 3
1384#define EFI_ACPI_6_1_NFIT_NVDIMM_CONTROL_REGION_STRUCTURE_TYPE 4
1385#define EFI_ACPI_6_1_NFIT_NVDIMM_BLOCK_DATA_WINDOW_REGION_STRUCTURE_TYPE 5
1386#define EFI_ACPI_6_1_NFIT_FLUSH_HINT_ADDRESS_STRUCTURE_TYPE 6
1387
1388//
1389// Definition for NFIT Structure Header
1390//
1391typedef struct {
1392 UINT16 Type;
1393 UINT16 Length;
1394} EFI_ACPI_6_1_NFIT_STRUCTURE_HEADER;
1395
1396//
1397// Definition for System Physical Address Range Structure
1398//
1399#define EFI_ACPI_6_1_NFIT_SYSTEM_PHYSICAL_ADDRESS_RANGE_FLAGS_CONTROL_REGION_FOR_MANAGEMENT BIT0
1400#define EFI_ACPI_6_1_NFIT_SYSTEM_PHYSICAL_ADDRESS_RANGE_FLAGS_PROXIMITY_DOMAIN_VALID BIT1
1401#define EFI_ACPI_6_1_NFIT_GUID_VOLATILE_MEMORY_REGION { 0x7305944F, 0xFDDA, 0x44E3, { 0xB1, 0x6C, 0x3F, 0x22, 0xD2, 0x52, 0xE5, 0xD0 }}
1402#define EFI_ACPI_6_1_NFIT_GUID_BYTE_ADDRESSABLE_PERSISTENT_MEMORY_REGION { 0x66F0D379, 0xB4F3, 0x4074, { 0xAC, 0x43, 0x0D, 0x33, 0x18, 0xB7, 0x8C, 0xDB }}
1403#define EFI_ACPI_6_1_NFIT_GUID_NVDIMM_CONTROL_REGION { 0x92F701F6, 0x13B4, 0x405D, { 0x91, 0x0B, 0x29, 0x93, 0x67, 0xE8, 0x23, 0x4C }}
1404#define EFI_ACPI_6_1_NFIT_GUID_NVDIMM_BLOCK_DATA_WINDOW_REGION { 0x91AF0530, 0x5D86, 0x470E, { 0xA6, 0xB0, 0x0A, 0x2D, 0xB9, 0x40, 0x82, 0x49 }}
1405#define EFI_ACPI_6_1_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_DISK_REGION_VOLATILE { 0x77AB535A, 0x45FC, 0x624B, { 0x55, 0x60, 0xF7, 0xB2, 0x81, 0xD1, 0xF9, 0x6E }}
1406#define EFI_ACPI_6_1_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_CD_REGION_VOLATILE { 0x3D5ABD30, 0x4175, 0x87CE, { 0x6D, 0x64, 0xD2, 0xAD, 0xE5, 0x23, 0xC4, 0xBB }}
1407#define EFI_ACPI_6_1_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_DISK_REGION_PERSISTENT { 0x5CEA02C9, 0x4D07, 0x69D3, { 0x26, 0x9F ,0x44, 0x96, 0xFB, 0xE0, 0x96, 0xF9 }}
1408#define EFI_ACPI_6_1_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_CD_REGION_PERSISTENT { 0x08018188, 0x42CD, 0xBB48, { 0x10, 0x0F, 0x53, 0x87, 0xD5, 0x3D, 0xED, 0x3D }}
1409typedef struct {
1410 UINT16 Type;
1411 UINT16 Length;
1412 UINT16 SPARangeStructureIndex;
1413 UINT16 Flags;
1414 UINT32 Reserved_8;
1415 UINT32 ProximityDomain;
1416 GUID AddressRangeTypeGUID;
1417 UINT64 SystemPhysicalAddressRangeBase;
1418 UINT64 SystemPhysicalAddressRangeLength;
1419 UINT64 AddressRangeMemoryMappingAttribute;
1420} EFI_ACPI_6_1_NFIT_SYSTEM_PHYSICAL_ADDRESS_RANGE_STRUCTURE;
1421
1422//
1423// Definition for Memory Device to System Physical Address Range Mapping Structure
1424//
1425typedef struct {
1426 UINT32 DIMMNumber : 4;
1427 UINT32 MemoryChannelNumber : 4;
1428 UINT32 MemoryControllerID : 4;
1429 UINT32 SocketID : 4;
1430 UINT32 NodeControllerID : 12;
1431 UINT32 Reserved_28 : 4;
1432} EFI_ACPI_6_1_NFIT_DEVICE_HANDLE;
1433
1434#define EFI_ACPI_6_1_NFIT_MEMORY_DEVICE_STATE_FLAGS_PREVIOUS_SAVE_FAIL BIT0
1435#define EFI_ACPI_6_1_NFIT_MEMORY_DEVICE_STATE_FLAGS_LAST_RESTORE_FAIL BIT1
1436#define EFI_ACPI_6_1_NFIT_MEMORY_DEVICE_STATE_FLAGS_PLATFORM_FLUSH_FAIL BIT2
1437#define EFI_ACPI_6_1_NFIT_MEMORY_DEVICE_STATE_FLAGS_NOT_ARMED_PRIOR_TO_OSPM_HAND_OFF BIT3
1438#define EFI_ACPI_6_1_NFIT_MEMORY_DEVICE_STATE_FLAGS_SMART_HEALTH_EVENTS_PRIOR_OSPM_HAND_OFF BIT4
1439#define EFI_ACPI_6_1_NFIT_MEMORY_DEVICE_STATE_FLAGS_FIRMWARE_ENABLED_TO_NOTIFY_OSPM_ON_SMART_HEALTH_EVENTS BIT5
1440#define EFI_ACPI_6_1_NFIT_MEMORY_DEVICE_STATE_FLAGS_FIRMWARE_NOT_MAP_NVDIMM_TO_SPA BIT6
1441typedef struct {
1442 UINT16 Type;
1443 UINT16 Length;
1444 EFI_ACPI_6_1_NFIT_DEVICE_HANDLE NFITDeviceHandle;
1445 UINT16 NVDIMMPhysicalID;
1446 UINT16 NVDIMMRegionID;
1447 UINT16 SPARangeStructureIndex;
1448 UINT16 NVDIMMControlRegionStructureIndex;
1449 UINT64 NVDIMMRegionSize;
1450 UINT64 RegionOffset;
1451 UINT64 NVDIMMPhysicalAddressRegionBase;
1452 UINT16 InterleaveStructureIndex;
1453 UINT16 InterleaveWays;
1454 UINT16 NVDIMMStateFlags;
1455 UINT16 Reserved_46;
1456} EFI_ACPI_6_1_NFIT_NVDIMM_REGION_MAPPING_STRUCTURE;
1457
1458//
1459// Definition for Interleave Structure
1460//
1461typedef struct {
1462 UINT16 Type;
1463 UINT16 Length;
1464 UINT16 InterleaveStructureIndex;
1465 UINT16 Reserved_6;
1466 UINT32 NumberOfLines;
1467 UINT32 LineSize;
1468 // UINT32 LineOffset[NumberOfLines];
1469} EFI_ACPI_6_1_NFIT_INTERLEAVE_STRUCTURE;
1470
1471//
1472// Definition for SMBIOS Management Information Structure
1473//
1474typedef struct {
1475 UINT16 Type;
1476 UINT16 Length;
1477 UINT32 Reserved_4;
1478 // UINT8 Data[];
1479} EFI_ACPI_6_1_NFIT_SMBIOS_MANAGEMENT_INFORMATION_STRUCTURE;
1480
1481//
1482// Definition for NVDIMM Control Region Structure
1483//
1484#define EFI_ACPI_6_1_NFIT_NVDIMM_CONTROL_REGION_VALID_FIELDS_MANUFACTURING BIT0
1485
1486#define EFI_ACPI_6_1_NFIT_NVDIMM_CONTROL_REGION_FLAGS_BLOCK_DATA_WINDOWS_BUFFERED BIT0
1487typedef struct {
1488 UINT16 Type;
1489 UINT16 Length;
1490 UINT16 NVDIMMControlRegionStructureIndex;
1491 UINT16 VendorID;
1492 UINT16 DeviceID;
1493 UINT16 RevisionID;
1494 UINT16 SubsystemVendorID;
1495 UINT16 SubsystemDeviceID;
1496 UINT16 SubsystemRevisionID;
1497 UINT8 ValidFields;
1498 UINT8 ManufacturingLocation;
1499 UINT16 ManufacturingDate;
1500 UINT8 Reserved_22[2];
1501 UINT32 SerialNumber;
1502 UINT16 RegionFormatInterfaceCode;
1503 UINT16 NumberOfBlockControlWindows;
1504 UINT64 SizeOfBlockControlWindow;
1505 UINT64 CommandRegisterOffsetInBlockControlWindow;
1506 UINT64 SizeOfCommandRegisterInBlockControlWindows;
1507 UINT64 StatusRegisterOffsetInBlockControlWindow;
1508 UINT64 SizeOfStatusRegisterInBlockControlWindows;
1509 UINT16 NVDIMMControlRegionFlag;
1510 UINT8 Reserved_74[6];
1511} EFI_ACPI_6_1_NFIT_NVDIMM_CONTROL_REGION_STRUCTURE;
1512
1513//
1514// Definition for NVDIMM Block Data Window Region Structure
1515//
1516typedef struct {
1517 UINT16 Type;
1518 UINT16 Length;
1519 UINT16 NVDIMMControlRegionStructureIndex;
1520 UINT16 NumberOfBlockDataWindows;
1521 UINT64 BlockDataWindowStartOffset;
1522 UINT64 SizeOfBlockDataWindow;
1523 UINT64 BlockAccessibleMemoryCapacity;
1524 UINT64 BeginningAddressOfFirstBlockInBlockAccessibleMemory;
1525} EFI_ACPI_6_1_NFIT_NVDIMM_BLOCK_DATA_WINDOW_REGION_STRUCTURE;
1526
1527//
1528// Definition for Flush Hint Address Structure
1529//
1530typedef struct {
1531 UINT16 Type;
1532 UINT16 Length;
1533 EFI_ACPI_6_1_NFIT_DEVICE_HANDLE NFITDeviceHandle;
1534 UINT16 NumberOfFlushHintAddresses;
1535 UINT8 Reserved_10[6];
1536 // UINT64 FlushHintAddress[NumberOfFlushHintAddresses];
1537} EFI_ACPI_6_1_NFIT_FLUSH_HINT_ADDRESS_STRUCTURE;
1538
1539///
1540/// Boot Error Record Table (BERT)
1541///
1542typedef struct {
1543 EFI_ACPI_DESCRIPTION_HEADER Header;
1544 UINT32 BootErrorRegionLength;
1545 UINT64 BootErrorRegion;
1546} EFI_ACPI_6_1_BOOT_ERROR_RECORD_TABLE_HEADER;
1547
1548///
1549/// BERT Version (as defined in ACPI 6.1 spec.)
1550///
1551#define EFI_ACPI_6_1_BOOT_ERROR_RECORD_TABLE_REVISION 0x01
1552
1553///
1554/// Boot Error Region Block Status Definition
1555///
1556typedef struct {
1557 UINT32 UncorrectableErrorValid : 1;
1558 UINT32 CorrectableErrorValid : 1;
1559 UINT32 MultipleUncorrectableErrors : 1;
1560 UINT32 MultipleCorrectableErrors : 1;
1561 UINT32 ErrorDataEntryCount : 10;
1562 UINT32 Reserved : 18;
1563} EFI_ACPI_6_1_ERROR_BLOCK_STATUS;
1564
1565///
1566/// Boot Error Region Definition
1567///
1568typedef struct {
1569 EFI_ACPI_6_1_ERROR_BLOCK_STATUS BlockStatus;
1570 UINT32 RawDataOffset;
1571 UINT32 RawDataLength;
1572 UINT32 DataLength;
1573 UINT32 ErrorSeverity;
1574} EFI_ACPI_6_1_BOOT_ERROR_REGION_STRUCTURE;
1575
1576//
1577// Boot Error Severity types
1578//
1579#define EFI_ACPI_6_1_ERROR_SEVERITY_RECOVERABLE 0x00
1580#define EFI_ACPI_6_1_ERROR_SEVERITY_FATAL 0x01
1581#define EFI_ACPI_6_1_ERROR_SEVERITY_CORRECTED 0x02
1582#define EFI_ACPI_6_1_ERROR_SEVERITY_NONE 0x03
1583//
1584// The term 'Correctable' is no longer being used as an error severity of the
1585// reported error since ACPI Specification Version 5.1 Errata B.
1586// The below macro is considered as deprecated and should no longer be used.
1587//
1588#define EFI_ACPI_6_1_ERROR_SEVERITY_CORRECTABLE 0x00
1589
1590///
1591/// Generic Error Data Entry Definition
1592///
1593typedef struct {
1594 UINT8 SectionType[16];
1595 UINT32 ErrorSeverity;
1596 UINT16 Revision;
1597 UINT8 ValidationBits;
1598 UINT8 Flags;
1599 UINT32 ErrorDataLength;
1600 UINT8 FruId[16];
1601 UINT8 FruText[20];
1602 UINT8 Timestamp[8];
1603} EFI_ACPI_6_1_GENERIC_ERROR_DATA_ENTRY_STRUCTURE;
1604
1605///
1606/// Generic Error Data Entry Version (as defined in ACPI 6.1 spec.)
1607///
1608#define EFI_ACPI_6_1_GENERIC_ERROR_DATA_ENTRY_REVISION 0x0300
1609
1610///
1611/// HEST - Hardware Error Source Table
1612///
1613typedef struct {
1614 EFI_ACPI_DESCRIPTION_HEADER Header;
1615 UINT32 ErrorSourceCount;
1616} EFI_ACPI_6_1_HARDWARE_ERROR_SOURCE_TABLE_HEADER;
1617
1618///
1619/// HEST Version (as defined in ACPI 6.1 spec.)
1620///
1621#define EFI_ACPI_6_1_HARDWARE_ERROR_SOURCE_TABLE_REVISION 0x01
1622
1623//
1624// Error Source structure types.
1625//
1626#define EFI_ACPI_6_1_IA32_ARCHITECTURE_MACHINE_CHECK_EXCEPTION 0x00
1627#define EFI_ACPI_6_1_IA32_ARCHITECTURE_CORRECTED_MACHINE_CHECK 0x01
1628#define EFI_ACPI_6_1_IA32_ARCHITECTURE_NMI_ERROR 0x02
1629#define EFI_ACPI_6_1_PCI_EXPRESS_ROOT_PORT_AER 0x06
1630#define EFI_ACPI_6_1_PCI_EXPRESS_DEVICE_AER 0x07
1631#define EFI_ACPI_6_1_PCI_EXPRESS_BRIDGE_AER 0x08
1632#define EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR 0x09
1633#define EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR_VERSION_2 0x0A
1634
1635//
1636// Error Source structure flags.
1637//
1638#define EFI_ACPI_6_1_ERROR_SOURCE_FLAG_FIRMWARE_FIRST (1 << 0)
1639#define EFI_ACPI_6_1_ERROR_SOURCE_FLAG_GLOBAL (1 << 1)
1640
1641///
1642/// IA-32 Architecture Machine Check Exception Structure Definition
1643///
1644typedef struct {
1645 UINT16 Type;
1646 UINT16 SourceId;
1647 UINT8 Reserved0[2];
1648 UINT8 Flags;
1649 UINT8 Enabled;
1650 UINT32 NumberOfRecordsToPreAllocate;
1651 UINT32 MaxSectionsPerRecord;
1652 UINT64 GlobalCapabilityInitData;
1653 UINT64 GlobalControlInitData;
1654 UINT8 NumberOfHardwareBanks;
1655 UINT8 Reserved1[7];
1656} EFI_ACPI_6_1_IA32_ARCHITECTURE_MACHINE_CHECK_EXCEPTION_STRUCTURE;
1657
1658///
1659/// IA-32 Architecture Machine Check Bank Structure Definition
1660///
1661typedef struct {
1662 UINT8 BankNumber;
1663 UINT8 ClearStatusOnInitialization;
1664 UINT8 StatusDataFormat;
1665 UINT8 Reserved0;
1666 UINT32 ControlRegisterMsrAddress;
1667 UINT64 ControlInitData;
1668 UINT32 StatusRegisterMsrAddress;
1669 UINT32 AddressRegisterMsrAddress;
1670 UINT32 MiscRegisterMsrAddress;
1671} EFI_ACPI_6_1_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_BANK_STRUCTURE;
1672
1673///
1674/// IA-32 Architecture Machine Check Bank Structure MCA data format
1675///
1676#define EFI_ACPI_6_1_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_IA32 0x00
1677#define EFI_ACPI_6_1_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_INTEL64 0x01
1678#define EFI_ACPI_6_1_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_AMD64 0x02
1679
1680//
1681// Hardware Error Notification types. All other values are reserved
1682//
1683#define EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_POLLED 0x00
1684#define EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_EXTERNAL_INTERRUPT 0x01
1685#define EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_LOCAL_INTERRUPT 0x02
1686#define EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_SCI 0x03
1687#define EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_NMI 0x04
1688#define EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_CMCI 0x05
1689#define EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_MCE 0x06
1690#define EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_GPIO_SIGNAL 0x07
1691#define EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_ARMV8_SEA 0x08
1692#define EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_ARMV8_SEI 0x09
1693#define EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_GSIV 0x0A
1694
1695///
1696/// Hardware Error Notification Configuration Write Enable Structure Definition
1697///
1698typedef struct {
1699 UINT16 Type : 1;
1700 UINT16 PollInterval : 1;
1701 UINT16 SwitchToPollingThresholdValue : 1;
1702 UINT16 SwitchToPollingThresholdWindow : 1;
1703 UINT16 ErrorThresholdValue : 1;
1704 UINT16 ErrorThresholdWindow : 1;
1705 UINT16 Reserved : 10;
1706} EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE;
1707
1708///
1709/// Hardware Error Notification Structure Definition
1710///
1711typedef struct {
1712 UINT8 Type;
1713 UINT8 Length;
1714 EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE ConfigurationWriteEnable;
1715 UINT32 PollInterval;
1716 UINT32 Vector;
1717 UINT32 SwitchToPollingThresholdValue;
1718 UINT32 SwitchToPollingThresholdWindow;
1719 UINT32 ErrorThresholdValue;
1720 UINT32 ErrorThresholdWindow;
1721} EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_STRUCTURE;
1722
1723///
1724/// IA-32 Architecture Corrected Machine Check Structure Definition
1725///
1726typedef struct {
1727 UINT16 Type;
1728 UINT16 SourceId;
1729 UINT8 Reserved0[2];
1730 UINT8 Flags;
1731 UINT8 Enabled;
1732 UINT32 NumberOfRecordsToPreAllocate;
1733 UINT32 MaxSectionsPerRecord;
1734 EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_STRUCTURE NotificationStructure;
1735 UINT8 NumberOfHardwareBanks;
1736 UINT8 Reserved1[3];
1737} EFI_ACPI_6_1_IA32_ARCHITECTURE_CORRECTED_MACHINE_CHECK_STRUCTURE;
1738
1739///
1740/// IA-32 Architecture NMI Error Structure Definition
1741///
1742typedef struct {
1743 UINT16 Type;
1744 UINT16 SourceId;
1745 UINT8 Reserved0[2];
1746 UINT32 NumberOfRecordsToPreAllocate;
1747 UINT32 MaxSectionsPerRecord;
1748 UINT32 MaxRawDataLength;
1749} EFI_ACPI_6_1_IA32_ARCHITECTURE_NMI_ERROR_STRUCTURE;
1750
1751///
1752/// PCI Express Root Port AER Structure Definition
1753///
1754typedef struct {
1755 UINT16 Type;
1756 UINT16 SourceId;
1757 UINT8 Reserved0[2];
1758 UINT8 Flags;
1759 UINT8 Enabled;
1760 UINT32 NumberOfRecordsToPreAllocate;
1761 UINT32 MaxSectionsPerRecord;
1762 UINT32 Bus;
1763 UINT16 Device;
1764 UINT16 Function;
1765 UINT16 DeviceControl;
1766 UINT8 Reserved1[2];
1767 UINT32 UncorrectableErrorMask;
1768 UINT32 UncorrectableErrorSeverity;
1769 UINT32 CorrectableErrorMask;
1770 UINT32 AdvancedErrorCapabilitiesAndControl;
1771 UINT32 RootErrorCommand;
1772} EFI_ACPI_6_1_PCI_EXPRESS_ROOT_PORT_AER_STRUCTURE;
1773
1774///
1775/// PCI Express Device AER Structure Definition
1776///
1777typedef struct {
1778 UINT16 Type;
1779 UINT16 SourceId;
1780 UINT8 Reserved0[2];
1781 UINT8 Flags;
1782 UINT8 Enabled;
1783 UINT32 NumberOfRecordsToPreAllocate;
1784 UINT32 MaxSectionsPerRecord;
1785 UINT32 Bus;
1786 UINT16 Device;
1787 UINT16 Function;
1788 UINT16 DeviceControl;
1789 UINT8 Reserved1[2];
1790 UINT32 UncorrectableErrorMask;
1791 UINT32 UncorrectableErrorSeverity;
1792 UINT32 CorrectableErrorMask;
1793 UINT32 AdvancedErrorCapabilitiesAndControl;
1794} EFI_ACPI_6_1_PCI_EXPRESS_DEVICE_AER_STRUCTURE;
1795
1796///
1797/// PCI Express Bridge AER Structure Definition
1798///
1799typedef struct {
1800 UINT16 Type;
1801 UINT16 SourceId;
1802 UINT8 Reserved0[2];
1803 UINT8 Flags;
1804 UINT8 Enabled;
1805 UINT32 NumberOfRecordsToPreAllocate;
1806 UINT32 MaxSectionsPerRecord;
1807 UINT32 Bus;
1808 UINT16 Device;
1809 UINT16 Function;
1810 UINT16 DeviceControl;
1811 UINT8 Reserved1[2];
1812 UINT32 UncorrectableErrorMask;
1813 UINT32 UncorrectableErrorSeverity;
1814 UINT32 CorrectableErrorMask;
1815 UINT32 AdvancedErrorCapabilitiesAndControl;
1816 UINT32 SecondaryUncorrectableErrorMask;
1817 UINT32 SecondaryUncorrectableErrorSeverity;
1818 UINT32 SecondaryAdvancedErrorCapabilitiesAndControl;
1819} EFI_ACPI_6_1_PCI_EXPRESS_BRIDGE_AER_STRUCTURE;
1820
1821///
1822/// Generic Hardware Error Source Structure Definition
1823///
1824typedef struct {
1825 UINT16 Type;
1826 UINT16 SourceId;
1827 UINT16 RelatedSourceId;
1828 UINT8 Flags;
1829 UINT8 Enabled;
1830 UINT32 NumberOfRecordsToPreAllocate;
1831 UINT32 MaxSectionsPerRecord;
1832 UINT32 MaxRawDataLength;
1833 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE ErrorStatusAddress;
1834 EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_STRUCTURE NotificationStructure;
1835 UINT32 ErrorStatusBlockLength;
1836} EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR_SOURCE_STRUCTURE;
1837
1838///
1839/// Generic Hardware Error Source Version 2 Structure Definition
1840///
1841typedef struct {
1842 UINT16 Type;
1843 UINT16 SourceId;
1844 UINT16 RelatedSourceId;
1845 UINT8 Flags;
1846 UINT8 Enabled;
1847 UINT32 NumberOfRecordsToPreAllocate;
1848 UINT32 MaxSectionsPerRecord;
1849 UINT32 MaxRawDataLength;
1850 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE ErrorStatusAddress;
1851 EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_STRUCTURE NotificationStructure;
1852 UINT32 ErrorStatusBlockLength;
1853 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE ReadAckRegister;
1854 UINT64 ReadAckPreserve;
1855 UINT64 ReadAckWrite;
1856} EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR_SOURCE_VERSION_2_STRUCTURE;
1857
1858///
1859/// Generic Error Status Definition
1860///
1861typedef struct {
1862 EFI_ACPI_6_1_ERROR_BLOCK_STATUS BlockStatus;
1863 UINT32 RawDataOffset;
1864 UINT32 RawDataLength;
1865 UINT32 DataLength;
1866 UINT32 ErrorSeverity;
1867} EFI_ACPI_6_1_GENERIC_ERROR_STATUS_STRUCTURE;
1868
1869///
1870/// ERST - Error Record Serialization Table
1871///
1872typedef struct {
1873 EFI_ACPI_DESCRIPTION_HEADER Header;
1874 UINT32 SerializationHeaderSize;
1875 UINT8 Reserved0[4];
1876 UINT32 InstructionEntryCount;
1877} EFI_ACPI_6_1_ERROR_RECORD_SERIALIZATION_TABLE_HEADER;
1878
1879///
1880/// ERST Version (as defined in ACPI 6.1 spec.)
1881///
1882#define EFI_ACPI_6_1_ERROR_RECORD_SERIALIZATION_TABLE_REVISION 0x01
1883
1884///
1885/// ERST Serialization Actions
1886///
1887#define EFI_ACPI_6_1_ERST_BEGIN_WRITE_OPERATION 0x00
1888#define EFI_ACPI_6_1_ERST_BEGIN_READ_OPERATION 0x01
1889#define EFI_ACPI_6_1_ERST_BEGIN_CLEAR_OPERATION 0x02
1890#define EFI_ACPI_6_1_ERST_END_OPERATION 0x03
1891#define EFI_ACPI_6_1_ERST_SET_RECORD_OFFSET 0x04
1892#define EFI_ACPI_6_1_ERST_EXECUTE_OPERATION 0x05
1893#define EFI_ACPI_6_1_ERST_CHECK_BUSY_STATUS 0x06
1894#define EFI_ACPI_6_1_ERST_GET_COMMAND_STATUS 0x07
1895#define EFI_ACPI_6_1_ERST_GET_RECORD_IDENTIFIER 0x08
1896#define EFI_ACPI_6_1_ERST_SET_RECORD_IDENTIFIER 0x09
1897#define EFI_ACPI_6_1_ERST_GET_RECORD_COUNT 0x0A
1898#define EFI_ACPI_6_1_ERST_BEGIN_DUMMY_WRITE_OPERATION 0x0B
1899#define EFI_ACPI_6_1_ERST_GET_ERROR_LOG_ADDRESS_RANGE 0x0D
1900#define EFI_ACPI_6_1_ERST_GET_ERROR_LOG_ADDRESS_RANGE_LENGTH 0x0E
1901#define EFI_ACPI_6_1_ERST_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES 0x0F
1902#define EFI_ACPI_6_1_ERST_GET_EXECUTE_OPERATION_TIMINGS 0x10
1903
1904///
1905/// ERST Action Command Status
1906///
1907#define EFI_ACPI_6_1_ERST_STATUS_SUCCESS 0x00
1908#define EFI_ACPI_6_1_ERST_STATUS_NOT_ENOUGH_SPACE 0x01
1909#define EFI_ACPI_6_1_ERST_STATUS_HARDWARE_NOT_AVAILABLE 0x02
1910#define EFI_ACPI_6_1_ERST_STATUS_FAILED 0x03
1911#define EFI_ACPI_6_1_ERST_STATUS_RECORD_STORE_EMPTY 0x04
1912#define EFI_ACPI_6_1_ERST_STATUS_RECORD_NOT_FOUND 0x05
1913
1914///
1915/// ERST Serialization Instructions
1916///
1917#define EFI_ACPI_6_1_ERST_READ_REGISTER 0x00
1918#define EFI_ACPI_6_1_ERST_READ_REGISTER_VALUE 0x01
1919#define EFI_ACPI_6_1_ERST_WRITE_REGISTER 0x02
1920#define EFI_ACPI_6_1_ERST_WRITE_REGISTER_VALUE 0x03
1921#define EFI_ACPI_6_1_ERST_NOOP 0x04
1922#define EFI_ACPI_6_1_ERST_LOAD_VAR1 0x05
1923#define EFI_ACPI_6_1_ERST_LOAD_VAR2 0x06
1924#define EFI_ACPI_6_1_ERST_STORE_VAR1 0x07
1925#define EFI_ACPI_6_1_ERST_ADD 0x08
1926#define EFI_ACPI_6_1_ERST_SUBTRACT 0x09
1927#define EFI_ACPI_6_1_ERST_ADD_VALUE 0x0A
1928#define EFI_ACPI_6_1_ERST_SUBTRACT_VALUE 0x0B
1929#define EFI_ACPI_6_1_ERST_STALL 0x0C
1930#define EFI_ACPI_6_1_ERST_STALL_WHILE_TRUE 0x0D
1931#define EFI_ACPI_6_1_ERST_SKIP_NEXT_INSTRUCTION_IF_TRUE 0x0E
1932#define EFI_ACPI_6_1_ERST_GOTO 0x0F
1933#define EFI_ACPI_6_1_ERST_SET_SRC_ADDRESS_BASE 0x10
1934#define EFI_ACPI_6_1_ERST_SET_DST_ADDRESS_BASE 0x11
1935#define EFI_ACPI_6_1_ERST_MOVE_DATA 0x12
1936
1937///
1938/// ERST Instruction Flags
1939///
1940#define EFI_ACPI_6_1_ERST_PRESERVE_REGISTER 0x01
1941
1942///
1943/// ERST Serialization Instruction Entry
1944///
1945typedef struct {
1946 UINT8 SerializationAction;
1947 UINT8 Instruction;
1948 UINT8 Flags;
1949 UINT8 Reserved0;
1950 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE RegisterRegion;
1951 UINT64 Value;
1952 UINT64 Mask;
1953} EFI_ACPI_6_1_ERST_SERIALIZATION_INSTRUCTION_ENTRY;
1954
1955///
1956/// EINJ - Error Injection Table
1957///
1958typedef struct {
1959 EFI_ACPI_DESCRIPTION_HEADER Header;
1960 UINT32 InjectionHeaderSize;
1961 UINT8 InjectionFlags;
1962 UINT8 Reserved0[3];
1963 UINT32 InjectionEntryCount;
1964} EFI_ACPI_6_1_ERROR_INJECTION_TABLE_HEADER;
1965
1966///
1967/// EINJ Version (as defined in ACPI 6.1 spec.)
1968///
1969#define EFI_ACPI_6_1_ERROR_INJECTION_TABLE_REVISION 0x01
1970
1971///
1972/// EINJ Error Injection Actions
1973///
1974#define EFI_ACPI_6_1_EINJ_BEGIN_INJECTION_OPERATION 0x00
1975#define EFI_ACPI_6_1_EINJ_GET_TRIGGER_ERROR_ACTION_TABLE 0x01
1976#define EFI_ACPI_6_1_EINJ_SET_ERROR_TYPE 0x02
1977#define EFI_ACPI_6_1_EINJ_GET_ERROR_TYPE 0x03
1978#define EFI_ACPI_6_1_EINJ_END_OPERATION 0x04
1979#define EFI_ACPI_6_1_EINJ_EXECUTE_OPERATION 0x05
1980#define EFI_ACPI_6_1_EINJ_CHECK_BUSY_STATUS 0x06
1981#define EFI_ACPI_6_1_EINJ_GET_COMMAND_STATUS 0x07
1982#define EFI_ACPI_6_1_EINJ_TRIGGER_ERROR 0xFF
1983
1984///
1985/// EINJ Action Command Status
1986///
1987#define EFI_ACPI_6_1_EINJ_STATUS_SUCCESS 0x00
1988#define EFI_ACPI_6_1_EINJ_STATUS_UNKNOWN_FAILURE 0x01
1989#define EFI_ACPI_6_1_EINJ_STATUS_INVALID_ACCESS 0x02
1990
1991///
1992/// EINJ Error Type Definition
1993///
1994#define EFI_ACPI_6_1_EINJ_ERROR_PROCESSOR_CORRECTABLE (1 << 0)
1995#define EFI_ACPI_6_1_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_NONFATAL (1 << 1)
1996#define EFI_ACPI_6_1_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_FATAL (1 << 2)
1997#define EFI_ACPI_6_1_EINJ_ERROR_MEMORY_CORRECTABLE (1 << 3)
1998#define EFI_ACPI_6_1_EINJ_ERROR_MEMORY_UNCORRECTABLE_NONFATAL (1 << 4)
1999#define EFI_ACPI_6_1_EINJ_ERROR_MEMORY_UNCORRECTABLE_FATAL (1 << 5)
2000#define EFI_ACPI_6_1_EINJ_ERROR_PCI_EXPRESS_CORRECTABLE (1 << 6)
2001#define EFI_ACPI_6_1_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_NONFATAL (1 << 7)
2002#define EFI_ACPI_6_1_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_FATAL (1 << 8)
2003#define EFI_ACPI_6_1_EINJ_ERROR_PLATFORM_CORRECTABLE (1 << 9)
2004#define EFI_ACPI_6_1_EINJ_ERROR_PLATFORM_UNCORRECTABLE_NONFATAL (1 << 10)
2005#define EFI_ACPI_6_1_EINJ_ERROR_PLATFORM_UNCORRECTABLE_FATAL (1 << 11)
2006
2007///
2008/// EINJ Injection Instructions
2009///
2010#define EFI_ACPI_6_1_EINJ_READ_REGISTER 0x00
2011#define EFI_ACPI_6_1_EINJ_READ_REGISTER_VALUE 0x01
2012#define EFI_ACPI_6_1_EINJ_WRITE_REGISTER 0x02
2013#define EFI_ACPI_6_1_EINJ_WRITE_REGISTER_VALUE 0x03
2014#define EFI_ACPI_6_1_EINJ_NOOP 0x04
2015
2016///
2017/// EINJ Instruction Flags
2018///
2019#define EFI_ACPI_6_1_EINJ_PRESERVE_REGISTER 0x01
2020
2021///
2022/// EINJ Injection Instruction Entry
2023///
2024typedef struct {
2025 UINT8 InjectionAction;
2026 UINT8 Instruction;
2027 UINT8 Flags;
2028 UINT8 Reserved0;
2029 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE RegisterRegion;
2030 UINT64 Value;
2031 UINT64 Mask;
2032} EFI_ACPI_6_1_EINJ_INJECTION_INSTRUCTION_ENTRY;
2033
2034///
2035/// EINJ Trigger Action Table
2036///
2037typedef struct {
2038 UINT32 HeaderSize;
2039 UINT32 Revision;
2040 UINT32 TableSize;
2041 UINT32 EntryCount;
2042} EFI_ACPI_6_1_EINJ_TRIGGER_ACTION_TABLE;
2043
2044///
2045/// Platform Communications Channel Table (PCCT)
2046///
2047typedef struct {
2048 EFI_ACPI_DESCRIPTION_HEADER Header;
2049 UINT32 Flags;
2050 UINT64 Reserved;
2051} EFI_ACPI_6_1_PLATFORM_COMMUNICATION_CHANNEL_TABLE_HEADER;
2052
2053///
2054/// PCCT Version (as defined in ACPI 6.1 spec.)
2055///
2056#define EFI_ACPI_6_1_PLATFORM_COMMUNICATION_CHANNEL_TABLE_REVISION 0x01
2057
2058///
2059/// PCCT Global Flags
2060///
2061#define EFI_ACPI_6_1_PCCT_FLAGS_SCI_DOORBELL BIT0
2062
2063//
2064// PCCT Subspace type
2065//
2066#define EFI_ACPI_6_1_PCCT_SUBSPACE_TYPE_GENERIC 0x00
2067#define EFI_ACPI_6_1_PCCT_SUBSPACE_TYPE_1_HW_REDUCED_COMMUNICATIONS 0x01
2068#define EFI_ACPI_6_1_PCCT_SUBSPACE_TYPE_2_HW_REDUCED_COMMUNICATIONS 0x02
2069
2070///
2071/// PCC Subspace Structure Header
2072///
2073typedef struct {
2074 UINT8 Type;
2075 UINT8 Length;
2076} EFI_ACPI_6_1_PCCT_SUBSPACE_HEADER;
2077
2078///
2079/// Generic Communications Subspace Structure
2080///
2081typedef struct {
2082 UINT8 Type;
2083 UINT8 Length;
2084 UINT8 Reserved[6];
2085 UINT64 BaseAddress;
2086 UINT64 AddressLength;
2087 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE DoorbellRegister;
2088 UINT64 DoorbellPreserve;
2089 UINT64 DoorbellWrite;
2090 UINT32 NominalLatency;
2091 UINT32 MaximumPeriodicAccessRate;
2092 UINT16 MinimumRequestTurnaroundTime;
2093} EFI_ACPI_6_1_PCCT_SUBSPACE_GENERIC;
2094
2095///
2096/// Generic Communications Channel Shared Memory Region
2097///
2098
2099typedef struct {
2100 UINT8 Command;
2101 UINT8 Reserved : 7;
2102 UINT8 GenerateSci : 1;
2103} EFI_ACPI_6_1_PCCT_GENERIC_SHARED_MEMORY_REGION_COMMAND;
2104
2105typedef struct {
2106 UINT8 CommandComplete : 1;
2107 UINT8 SciDoorbell : 1;
2108 UINT8 Error : 1;
2109 UINT8 PlatformNotification : 1;
2110 UINT8 Reserved : 4;
2111 UINT8 Reserved1;
2112} EFI_ACPI_6_1_PCCT_GENERIC_SHARED_MEMORY_REGION_STATUS;
2113
2114typedef struct {
2115 UINT32 Signature;
2116 EFI_ACPI_6_1_PCCT_GENERIC_SHARED_MEMORY_REGION_COMMAND Command;
2117 EFI_ACPI_6_1_PCCT_GENERIC_SHARED_MEMORY_REGION_STATUS Status;
2118} EFI_ACPI_6_1_PCCT_GENERIC_SHARED_MEMORY_REGION_HEADER;
2119
2120#define EFI_ACPI_6_1_PCCT_SUBSPACE_DOORBELL_INTERRUPT_FLAGS_POLARITY BIT0
2121#define EFI_ACPI_6_1_PCCT_SUBSPACE_DOORBELL_INTERRUPT_FLAGS_MODE BIT1
2122
2123///
2124/// Type 1 HW-Reduced Communications Subspace Structure
2125///
2126typedef struct {
2127 UINT8 Type;
2128 UINT8 Length;
2129 UINT32 DoorbellInterrupt;
2130 UINT8 DoorbellInterruptFlags;
2131 UINT8 Reserved;
2132 UINT64 BaseAddress;
2133 UINT64 AddressLength;
2134 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE DoorbellRegister;
2135 UINT64 DoorbellPreserve;
2136 UINT64 DoorbellWrite;
2137 UINT32 NominalLatency;
2138 UINT32 MaximumPeriodicAccessRate;
2139 UINT16 MinimumRequestTurnaroundTime;
2140} EFI_ACPI_6_1_PCCT_SUBSPACE_1_HW_REDUCED_COMMUNICATIONS;
2141
2142///
2143/// Type 2 HW-Reduced Communications Subspace Structure
2144///
2145typedef struct {
2146 UINT8 Type;
2147 UINT8 Length;
2148 UINT32 DoorbellInterrupt;
2149 UINT8 DoorbellInterruptFlags;
2150 UINT8 Reserved;
2151 UINT64 BaseAddress;
2152 UINT64 AddressLength;
2153 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE DoorbellRegister;
2154 UINT64 DoorbellPreserve;
2155 UINT64 DoorbellWrite;
2156 UINT32 NominalLatency;
2157 UINT32 MaximumPeriodicAccessRate;
2158 UINT16 MinimumRequestTurnaroundTime;
2159 EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE DoorbellAckRegister;
2160 UINT64 DoorbellAckPreserve;
2161 UINT64 DoorbellAckWrite;
2162} EFI_ACPI_6_1_PCCT_SUBSPACE_2_HW_REDUCED_COMMUNICATIONS;
2163
2164//
2165// Known table signatures
2166//
2167
2168///
2169/// "RSD PTR " Root System Description Pointer
2170///
2171#define EFI_ACPI_6_1_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ')
2172
2173///
2174/// "APIC" Multiple APIC Description Table
2175///
2176#define EFI_ACPI_6_1_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('A', 'P', 'I', 'C')
2177
2178///
2179/// "BERT" Boot Error Record Table
2180///
2181#define EFI_ACPI_6_1_BOOT_ERROR_RECORD_TABLE_SIGNATURE SIGNATURE_32('B', 'E', 'R', 'T')
2182
2183///
2184/// "BGRT" Boot Graphics Resource Table
2185///
2186#define EFI_ACPI_6_1_BOOT_GRAPHICS_RESOURCE_TABLE_SIGNATURE SIGNATURE_32('B', 'G', 'R', 'T')
2187
2188///
2189/// "CPEP" Corrected Platform Error Polling Table
2190///
2191#define EFI_ACPI_6_1_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_SIGNATURE SIGNATURE_32('C', 'P', 'E', 'P')
2192
2193///
2194/// "DSDT" Differentiated System Description Table
2195///
2196#define EFI_ACPI_6_1_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('D', 'S', 'D', 'T')
2197
2198///
2199/// "ECDT" Embedded Controller Boot Resources Table
2200///
2201#define EFI_ACPI_6_1_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE_SIGNATURE SIGNATURE_32('E', 'C', 'D', 'T')
2202
2203///
2204/// "EINJ" Error Injection Table
2205///
2206#define EFI_ACPI_6_1_ERROR_INJECTION_TABLE_SIGNATURE SIGNATURE_32('E', 'I', 'N', 'J')
2207
2208///
2209/// "ERST" Error Record Serialization Table
2210///
2211#define EFI_ACPI_6_1_ERROR_RECORD_SERIALIZATION_TABLE_SIGNATURE SIGNATURE_32('E', 'R', 'S', 'T')
2212
2213///
2214/// "FACP" Fixed ACPI Description Table
2215///
2216#define EFI_ACPI_6_1_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('F', 'A', 'C', 'P')
2217
2218///
2219/// "FACS" Firmware ACPI Control Structure
2220///
2221#define EFI_ACPI_6_1_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE SIGNATURE_32('F', 'A', 'C', 'S')
2222
2223///
2224/// "FPDT" Firmware Performance Data Table
2225///
2226#define EFI_ACPI_6_1_FIRMWARE_PERFORMANCE_DATA_TABLE_SIGNATURE SIGNATURE_32('F', 'P', 'D', 'T')
2227
2228///
2229/// "GTDT" Generic Timer Description Table
2230///
2231#define EFI_ACPI_6_1_GENERIC_TIMER_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('G', 'T', 'D', 'T')
2232
2233///
2234/// "HEST" Hardware Error Source Table
2235///
2236#define EFI_ACPI_6_1_HARDWARE_ERROR_SOURCE_TABLE_SIGNATURE SIGNATURE_32('H', 'E', 'S', 'T')
2237
2238///
2239/// "MPST" Memory Power State Table
2240///
2241#define EFI_ACPI_6_1_MEMORY_POWER_STATE_TABLE_SIGNATURE SIGNATURE_32('M', 'P', 'S', 'T')
2242
2243///
2244/// "MSCT" Maximum System Characteristics Table
2245///
2246#define EFI_ACPI_6_1_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_SIGNATURE SIGNATURE_32('M', 'S', 'C', 'T')
2247
2248///
2249/// "NFIT" NVDIMM Firmware Interface Table
2250///
2251#define EFI_ACPI_6_1_NVDIMM_FIRMWARE_INTERFACE_TABLE_STRUCTURE_SIGNATURE SIGNATURE_32('N', 'F', 'I', 'T')
2252
2253///
2254/// "PMTT" Platform Memory Topology Table
2255///
2256#define EFI_ACPI_6_1_PLATFORM_MEMORY_TOPOLOGY_TABLE_SIGNATURE SIGNATURE_32('P', 'M', 'T', 'T')
2257
2258///
2259/// "PSDT" Persistent System Description Table
2260///
2261#define EFI_ACPI_6_1_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('P', 'S', 'D', 'T')
2262
2263///
2264/// "RASF" ACPI RAS Feature Table
2265///
2266#define EFI_ACPI_6_1_ACPI_RAS_FEATURE_TABLE_SIGNATURE SIGNATURE_32('R', 'A', 'S', 'F')
2267
2268///
2269/// "RSDT" Root System Description Table
2270///
2271#define EFI_ACPI_6_1_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('R', 'S', 'D', 'T')
2272
2273///
2274/// "SBST" Smart Battery Specification Table
2275///
2276#define EFI_ACPI_6_1_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE SIGNATURE_32('S', 'B', 'S', 'T')
2277
2278///
2279/// "SLIT" System Locality Information Table
2280///
2281#define EFI_ACPI_6_1_SYSTEM_LOCALITY_INFORMATION_TABLE_SIGNATURE SIGNATURE_32('S', 'L', 'I', 'T')
2282
2283///
2284/// "SRAT" System Resource Affinity Table
2285///
2286#define EFI_ACPI_6_1_SYSTEM_RESOURCE_AFFINITY_TABLE_SIGNATURE SIGNATURE_32('S', 'R', 'A', 'T')
2287
2288///
2289/// "SSDT" Secondary System Description Table
2290///
2291#define EFI_ACPI_6_1_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('S', 'S', 'D', 'T')
2292
2293///
2294/// "XSDT" Extended System Description Table
2295///
2296#define EFI_ACPI_6_1_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('X', 'S', 'D', 'T')
2297
2298///
2299/// "BOOT" MS Simple Boot Spec
2300///
2301#define EFI_ACPI_6_1_SIMPLE_BOOT_FLAG_TABLE_SIGNATURE SIGNATURE_32('B', 'O', 'O', 'T')
2302
2303///
2304/// "CSRT" MS Core System Resource Table
2305///
2306#define EFI_ACPI_6_1_CORE_SYSTEM_RESOURCE_TABLE_SIGNATURE SIGNATURE_32('C', 'S', 'R', 'T')
2307
2308///
2309/// "DBG2" MS Debug Port 2 Spec
2310///
2311#define EFI_ACPI_6_1_DEBUG_PORT_2_TABLE_SIGNATURE SIGNATURE_32('D', 'B', 'G', '2')
2312
2313///
2314/// "DBGP" MS Debug Port Spec
2315///
2316#define EFI_ACPI_6_1_DEBUG_PORT_TABLE_SIGNATURE SIGNATURE_32('D', 'B', 'G', 'P')
2317
2318///
2319/// "DMAR" DMA Remapping Table
2320///
2321#define EFI_ACPI_6_1_DMA_REMAPPING_TABLE_SIGNATURE SIGNATURE_32('D', 'M', 'A', 'R')
2322
2323///
2324/// "DRTM" Dynamic Root of Trust for Measurement Table
2325///
2326#define EFI_ACPI_6_1_DYNAMIC_ROOT_OF_TRUST_FOR_MEASUREMENT_TABLE_SIGNATURE SIGNATURE_32('D', 'R', 'T', 'M')
2327
2328///
2329/// "ETDT" Event Timer Description Table
2330///
2331#define EFI_ACPI_6_1_EVENT_TIMER_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('E', 'T', 'D', 'T')
2332
2333///
2334/// "HPET" IA-PC High Precision Event Timer Table
2335///
2336#define EFI_ACPI_6_1_HIGH_PRECISION_EVENT_TIMER_TABLE_SIGNATURE SIGNATURE_32('H', 'P', 'E', 'T')
2337
2338///
2339/// "iBFT" iSCSI Boot Firmware Table
2340///
2341#define EFI_ACPI_6_1_ISCSI_BOOT_FIRMWARE_TABLE_SIGNATURE SIGNATURE_32('i', 'B', 'F', 'T')
2342
2343///
2344/// "IORT" I/O Remapping Table
2345///
2346#define EFI_ACPI_6_1_IO_REMAPPING_TABLE_SIGNATURE SIGNATURE_32('I', 'O', 'R', 'T')
2347
2348///
2349/// "IVRS" I/O Virtualization Reporting Structure
2350///
2351#define EFI_ACPI_6_1_IO_VIRTUALIZATION_REPORTING_STRUCTURE_SIGNATURE SIGNATURE_32('I', 'V', 'R', 'S')
2352
2353///
2354/// "LPIT" Low Power Idle Table
2355///
2356#define EFI_ACPI_6_1_LOW_POWER_IDLE_TABLE_STRUCTURE_SIGNATURE SIGNATURE_32('L', 'P', 'I', 'T')
2357
2358///
2359/// "MCFG" PCI Express Memory Mapped Configuration Space Base Address Description Table
2360///
2361#define EFI_ACPI_6_1_PCI_EXPRESS_MEMORY_MAPPED_CONFIGURATION_SPACE_BASE_ADDRESS_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('M', 'C', 'F', 'G')
2362
2363///
2364/// "MCHI" Management Controller Host Interface Table
2365///
2366#define EFI_ACPI_6_1_MANAGEMENT_CONTROLLER_HOST_INTERFACE_TABLE_SIGNATURE SIGNATURE_32('M', 'C', 'H', 'I')
2367
2368///
2369/// "MSDM" MS Data Management Table
2370///
2371#define EFI_ACPI_6_1_DATA_MANAGEMENT_TABLE_SIGNATURE SIGNATURE_32('M', 'S', 'D', 'M')
2372
2373///
2374/// "PCCT" Platform Communications Channel Table
2375///
2376#define EFI_ACPI_6_1_PLATFORM_COMMUNICATIONS_CHANNEL_TABLE_SIGNATURE SIGNATURE_32('P', 'C', 'C', 'T')
2377
2378///
2379/// "SLIC" MS Software Licensing Table Specification
2380///
2381#define EFI_ACPI_6_1_SOFTWARE_LICENSING_TABLE_SIGNATURE SIGNATURE_32('S', 'L', 'I', 'C')
2382
2383///
2384/// "SPCR" Serial Port Console Redirection Table
2385///
2386#define EFI_ACPI_6_1_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE SIGNATURE_32('S', 'P', 'C', 'R')
2387
2388///
2389/// "SPMI" Server Platform Management Interface Table
2390///
2391#define EFI_ACPI_6_1_SERVER_PLATFORM_MANAGEMENT_INTERFACE_TABLE_SIGNATURE SIGNATURE_32('S', 'P', 'M', 'I')
2392
2393///
2394/// "STAO" _STA Override Table
2395///
2396#define EFI_ACPI_6_1_STA_OVERRIDE_TABLE_SIGNATURE SIGNATURE_32('S', 'T', 'A', 'O')
2397
2398///
2399/// "TCPA" Trusted Computing Platform Alliance Capabilities Table
2400///
2401#define EFI_ACPI_6_1_TRUSTED_COMPUTING_PLATFORM_ALLIANCE_CAPABILITIES_TABLE_SIGNATURE SIGNATURE_32('T', 'C', 'P', 'A')
2402
2403///
2404/// "TPM2" Trusted Computing Platform 1 Table
2405///
2406#define EFI_ACPI_6_1_TRUSTED_COMPUTING_PLATFORM_2_TABLE_SIGNATURE SIGNATURE_32('T', 'P', 'M', '2')
2407
2408///
2409/// "UEFI" UEFI ACPI Data Table
2410///
2411#define EFI_ACPI_6_1_UEFI_ACPI_DATA_TABLE_SIGNATURE SIGNATURE_32('U', 'E', 'F', 'I')
2412
2413///
2414/// "WAET" Windows ACPI Emulated Devices Table
2415///
2416#define EFI_ACPI_6_1_WINDOWS_ACPI_EMULATED_DEVICES_TABLE_SIGNATURE SIGNATURE_32('W', 'A', 'E', 'T')
2417
2418///
2419/// "WDAT" Watchdog Action Table
2420///
2421#define EFI_ACPI_6_1_WATCHDOG_ACTION_TABLE_SIGNATURE SIGNATURE_32('W', 'D', 'A', 'T')
2422
2423///
2424/// "WDRT" Watchdog Resource Table
2425///
2426#define EFI_ACPI_6_1_WATCHDOG_RESOURCE_TABLE_SIGNATURE SIGNATURE_32('W', 'D', 'R', 'T')
2427
2428///
2429/// "WPBT" MS Platform Binary Table
2430///
2431#define EFI_ACPI_6_1_PLATFORM_BINARY_TABLE_SIGNATURE SIGNATURE_32('W', 'P', 'B', 'T')
2432
2433///
2434/// "XENV" Xen Project Table
2435///
2436#define EFI_ACPI_6_1_XEN_PROJECT_TABLE_SIGNATURE SIGNATURE_32('X', 'E', 'N', 'V')
2437
2438#pragma pack()
2439
2440#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