blob: 0fcc967f61954b584d65479fcaf1144f41eeb8d2 [file] [log] [blame]
Lawrence Tang1b0b00e2022-07-05 10:33:10 +01001/** @file
2 GUIDs and definitions used for Common Platform Error Record.
3
4 Copyright (c) 2011 - 2017, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
6 SPDX-License-Identifier: BSD-2-Clause-Patent
7
8 @par Revision Reference:
9 GUIDs defined in UEFI 2.7 Specification.
10
11**/
12#include "BaseTypes.h"
13
14#ifndef __CPER_GUID_H__
15#define __CPER_GUID_H__
16
17#pragma pack(1)
18
19#define EFI_ERROR_RECORD_SIGNATURE_START SIGNATURE_32('C', 'P', 'E', 'R')
20#define EFI_ERROR_RECORD_SIGNATURE_END 0xFFFFFFFF
21
22#define EFI_ERROR_RECORD_REVISION 0x0101
23
24///
25/// Error Severity in Error Record Header and Error Section Descriptor
26///@{
27#define EFI_GENERIC_ERROR_RECOVERABLE 0x00000000
28#define EFI_GENERIC_ERROR_FATAL 0x00000001
29#define EFI_GENERIC_ERROR_CORRECTED 0x00000002
30#define EFI_GENERIC_ERROR_INFO 0x00000003
31///@}
32
33///
34/// The validation bit mask indicates the validity of the following fields
35/// in Error Record Header.
36///@{
37#define EFI_ERROR_RECORD_HEADER_PLATFORM_ID_VALID BIT0
38#define EFI_ERROR_RECORD_HEADER_TIME_STAMP_VALID BIT1
39#define EFI_ERROR_RECORD_HEADER_PARTITION_ID_VALID BIT2
40///@}
41
42///
43/// Timestamp is precise if this bit is set and correlates to the time of the
44/// error event.
45///
46#define EFI_ERROR_TIME_STAMP_PRECISE BIT0
47
48///
49/// The timestamp correlates to the time when the error information was collected
50/// by the system software and may not necessarily represent the time of the error
51/// event. The timestamp contains the local time in BCD format.
52///
53typedef struct {
54 UINT8 Seconds;
55 UINT8 Minutes;
56 UINT8 Hours;
57 UINT8 Flag;
58 UINT8 Day;
59 UINT8 Month;
60 UINT8 Year;
61 UINT8 Century;
62} EFI_ERROR_TIME_STAMP;
63
64///
65/// GUID value indicating the record association with an error event notification type.
66///@{
67#define EFI_EVENT_NOTIFICATION_TYEP_CMC_GUID \
68 { \
69 0x2DCE8BB1, 0xBDD7, 0x450e, { 0xB9, 0xAD, 0x9C, 0xF4, 0xEB, 0xD4, 0xF8, 0x90 } \
70 }
71#define EFI_EVENT_NOTIFICATION_TYEP_CPE_GUID \
72 { \
73 0x4E292F96, 0xD843, 0x4a55, { 0xA8, 0xC2, 0xD4, 0x81, 0xF2, 0x7E, 0xBE, 0xEE } \
74 }
75#define EFI_EVENT_NOTIFICATION_TYEP_MCE_GUID \
76 { \
77 0xE8F56FFE, 0x919C, 0x4cc5, { 0xBA, 0x88, 0x65, 0xAB, 0xE1, 0x49, 0x13, 0xBB } \
78 }
79#define EFI_EVENT_NOTIFICATION_TYEP_PCIE_GUID \
80 { \
81 0xCF93C01F, 0x1A16, 0x4dfc, { 0xB8, 0xBC, 0x9C, 0x4D, 0xAF, 0x67, 0xC1, 0x04 } \
82 }
83#define EFI_EVENT_NOTIFICATION_TYEP_INIT_GUID \
84 { \
85 0xCC5263E8, 0x9308, 0x454a, { 0x89, 0xD0, 0x34, 0x0B, 0xD3, 0x9B, 0xC9, 0x8E } \
86 }
87#define EFI_EVENT_NOTIFICATION_TYEP_NMI_GUID \
88 { \
89 0x5BAD89FF, 0xB7E6, 0x42c9, { 0x81, 0x4A, 0xCF, 0x24, 0x85, 0xD6, 0xE9, 0x8A } \
90 }
91#define EFI_EVENT_NOTIFICATION_TYEP_BOOT_GUID \
92 { \
93 0x3D61A466, 0xAB40, 0x409a, { 0xA6, 0x98, 0xF3, 0x62, 0xD4, 0x64, 0xB3, 0x8F } \
94 }
95#define EFI_EVENT_NOTIFICATION_TYEP_DMAR_GUID \
96 { \
97 0x667DD791, 0xC6B3, 0x4c27, { 0x8A, 0x6B, 0x0F, 0x8E, 0x72, 0x2D, 0xEB, 0x41 } \
98 }
99#define EFI_EVENT_NOTIFICATION_TYPE_DMAR_SEA \
100 { \
101 0x9A78788A, 0xBBE8, 0x11E4, { 0x80, 0x9E, 0x67, 0x61, 0x1E, 0x5D, 0x46, 0xB0 } \
102 }
103#define EFI_EVENT_NOTIFICATION_TYPE_DMAR_SEI \
104 { \
105 0x5C284C81, 0xB0AE, 0x4E87, { 0xA3, 0x22, 0xB0, 0x4C, 0x85, 0x62, 0x43, 0x23 } \
106 }
107#define EFI_EVENT_NOTIFICATION_TYPE_DMAR_PEI \
108 { \
109 0x09A9D5AC, 0x5204, 0x4214, { 0x96, 0xE5, 0x94, 0x99, 0x2E, 0x75, 0x2B, 0xCD } \
110 }
111///@}
112
113///
114/// Error Record Header Flags
115///@{
116#define EFI_HW_ERROR_FLAGS_RECOVERED 0x00000001
117#define EFI_HW_ERROR_FLAGS_PREVERR 0x00000002
118#define EFI_HW_ERROR_FLAGS_SIMULATED 0x00000004
119///@}
120
121///
122/// Common error record header
123///
124typedef struct {
125 UINT32 SignatureStart;
126 UINT16 Revision;
127 UINT32 SignatureEnd;
128 UINT16 SectionCount;
129 UINT32 ErrorSeverity;
130 UINT32 ValidationBits;
131 UINT32 RecordLength;
132 EFI_ERROR_TIME_STAMP TimeStamp;
133 EFI_GUID PlatformID;
134 EFI_GUID PartitionID;
135 EFI_GUID CreatorID;
136 EFI_GUID NotificationType;
137 UINT64 RecordID;
138 UINT32 Flags;
139 UINT64 PersistenceInfo;
140 UINT8 Resv1[12];
141 ///
142 /// An array of SectionCount descriptors for the associated
143 /// sections. The number of valid sections is equivalent to the
144 /// SectionCount. The buffer size of the record may include
145 /// more space to dynamically add additional Section
146 /// Descriptors to the error record.
147 ///
148} EFI_COMMON_ERROR_RECORD_HEADER;
149
150#define EFI_ERROR_SECTION_REVISION 0x0100
151
152///
153/// Validity Fields in Error Section Descriptor.
154///
155#define EFI_ERROR_SECTION_FRU_ID_VALID BIT0
156#define EFI_ERROR_SECTION_FRU_STRING_VALID BIT1
157
158///
159/// Flag field contains information that describes the error section
160/// in Error Section Descriptor.
161///
162#define EFI_ERROR_SECTION_FLAGS_PRIMARY BIT0
163#define EFI_ERROR_SECTION_FLAGS_CONTAINMENT_WARNING BIT1
164#define EFI_ERROR_SECTION_FLAGS_RESET BIT2
165#define EFI_ERROR_SECTION_FLAGS_ERROR_THRESHOLD_EXCEEDED BIT3
166#define EFI_ERROR_SECTION_FLAGS_RESOURCE_NOT_ACCESSIBLE BIT4
167#define EFI_ERROR_SECTION_FLAGS_LATENT_ERROR BIT5
168
169///
170/// Error Sectition Type GUIDs in Error Section Descriptor
171///@{
172#define EFI_ERROR_SECTION_PROCESSOR_GENERIC_GUID \
173 { \
174 0x9876ccad, 0x47b4, 0x4bdb, { 0xb6, 0x5e, 0x16, 0xf1, 0x93, 0xc4, 0xf3, 0xdb } \
175 }
176#define EFI_ERROR_SECTION_PROCESSOR_SPECIFIC_GUID \
177 { \
178 0xdc3ea0b0, 0xa144, 0x4797, { 0xb9, 0x5b, 0x53, 0xfa, 0x24, 0x2b, 0x6e, 0x1d } \
179 }
180#define EFI_ERROR_SECTION_PROCESSOR_SPECIFIC_IA32X64_GUID \
181 { \
182 0xdc3ea0b0, 0xa144, 0x4797, { 0xb9, 0x5b, 0x53, 0xfa, 0x24, 0x2b, 0x6e, 0x1d } \
183 }
184#define EFI_ERROR_SECTION_PROCESSOR_SPECIFIC_ARM_GUID \
185 { \
186 0xe19e3d16, 0xbc11, 0x11e4, { 0x9c, 0xaa, 0xc2, 0x05, 0x1d, 0x5d, 0x46, 0xb0 } \
187 }
188#define EFI_ERROR_SECTION_PLATFORM_MEMORY_GUID \
189 { \
190 0xa5bc1114, 0x6f64, 0x4ede, { 0xb8, 0x63, 0x3e, 0x83, 0xed, 0x7c, 0x83, 0xb1 } \
191 }
192#define EFI_ERROR_SECTION_PLATFORM_MEMORY2_GUID \
193 { \
194 0x61EC04FC, 0x48E6, 0xD813, { 0x25, 0xC9, 0x8D, 0xAA, 0x44, 0x75, 0x0B, 0x12 } \
195 }
196#define EFI_ERROR_SECTION_PCIE_GUID \
197 { \
198 0xd995e954, 0xbbc1, 0x430f, { 0xad, 0x91, 0xb4, 0x4d, 0xcb, 0x3c, 0x6f, 0x35 } \
199 }
200#define EFI_ERROR_SECTION_FW_ERROR_RECORD_GUID \
201 { \
202 0x81212a96, 0x09ed, 0x4996, { 0x94, 0x71, 0x8d, 0x72, 0x9c, 0x8e, 0x69, 0xed } \
203 }
204#define EFI_ERROR_SECTION_PCI_PCIX_BUS_GUID \
205 { \
206 0xc5753963, 0x3b84, 0x4095, { 0xbf, 0x78, 0xed, 0xda, 0xd3, 0xf9, 0xc9, 0xdd } \
207 }
208#define EFI_ERROR_SECTION_PCI_DEVICE_GUID \
209 { \
210 0xeb5e4685, 0xca66, 0x4769, { 0xb6, 0xa2, 0x26, 0x06, 0x8b, 0x00, 0x13, 0x26 } \
211 }
212#define EFI_ERROR_SECTION_DMAR_GENERIC_GUID \
213 { \
214 0x5b51fef7, 0xc79d, 0x4434, { 0x8f, 0x1b, 0xaa, 0x62, 0xde, 0x3e, 0x2c, 0x64 } \
215 }
216#define EFI_ERROR_SECTION_DIRECTED_IO_DMAR_GUID \
217 { \
218 0x71761d37, 0x32b2, 0x45cd, { 0xa7, 0xd0, 0xb0, 0xfe, 0xdd, 0x93, 0xe8, 0xcf } \
219 }
220#define EFI_ERROR_SECTION_IOMMU_DMAR_GUID \
221 { \
222 0x036f84e1, 0x7f37, 0x428c, { 0xa7, 0x9e, 0x57, 0x5f, 0xdf, 0xaa, 0x84, 0xec } \
223 }
224///@}
225
226///
227/// Error Section Descriptor
228///
229typedef struct {
230 UINT32 SectionOffset;
231 UINT32 SectionLength;
232 UINT16 Revision;
233 UINT8 SecValidMask;
234 UINT8 Resv1;
235 UINT32 SectionFlags;
236 EFI_GUID SectionType;
237 EFI_GUID FruId;
238 UINT32 Severity;
239 CHAR8 FruString[20];
240} EFI_ERROR_SECTION_DESCRIPTOR;
241
242///
243/// The validation bit mask indicates whether or not each of the following fields are
244/// valid in Proessor Generic Error section.
245///@{
246#define EFI_GENERIC_ERROR_PROC_TYPE_VALID BIT0
247#define EFI_GENERIC_ERROR_PROC_ISA_VALID BIT1
248#define EFI_GENERIC_ERROR_PROC_ERROR_TYPE_VALID BIT2
249#define EFI_GENERIC_ERROR_PROC_OPERATION_VALID BIT3
250#define EFI_GENERIC_ERROR_PROC_FLAGS_VALID BIT4
251#define EFI_GENERIC_ERROR_PROC_LEVEL_VALID BIT5
252#define EFI_GENERIC_ERROR_PROC_VERSION_VALID BIT6
253#define EFI_GENERIC_ERROR_PROC_BRAND_VALID BIT7
254#define EFI_GENERIC_ERROR_PROC_ID_VALID BIT8
255#define EFI_GENERIC_ERROR_PROC_TARGET_ADDR_VALID BIT9
256#define EFI_GENERIC_ERROR_PROC_REQUESTER_ID_VALID BIT10
257#define EFI_GENERIC_ERROR_PROC_RESPONDER_ID_VALID BIT11
258#define EFI_GENERIC_ERROR_PROC_INST_IP_VALID BIT12
259///@}
260
261///
262/// The type of the processor architecture in Proessor Generic Error section.
263///@{
264#define EFI_GENERIC_ERROR_PROC_TYPE_IA32_X64 0x00
265#define EFI_GENERIC_ERROR_PROC_TYPE_IA64 0x01
266#define EFI_GENERIC_ERROR_PROC_TYPE_ARM 0x02
267///@}
268
269///
270/// The type of the instruction set executing when the error occurred in Proessor
271/// Generic Error section.
272///@{
273#define EFI_GENERIC_ERROR_PROC_ISA_IA32 0x00
274#define EFI_GENERIC_ERROR_PROC_ISA_IA64 0x01
275#define EFI_GENERIC_ERROR_PROC_ISA_X64 0x02
276#define EFI_GENERIC_ERROR_PROC_ISA_ARM_A32_T32 0x03
277#define EFI_GENERIC_ERROR_PROC_ISA_ARM_A64 0x04
278///@}
279
280///
281/// The type of error that occurred in Proessor Generic Error section.
282///@{
283#define EFI_GENERIC_ERROR_PROC_ERROR_TYPE_UNKNOWN 0x00
284#define EFI_GENERIC_ERROR_PROC_ERROR_TYPE_CACHE 0x01
285#define EFI_GENERIC_ERROR_PROC_ERROR_TYPE_TLB 0x02
286#define EFI_GENERIC_ERROR_PROC_ERROR_TYPE_BUS 0x04
287#define EFI_GENERIC_ERROR_PROC_ERROR_TYPE_MICRO_ARCH 0x08
288///@}
289
290///
291/// The type of operation in Proessor Generic Error section.
292///@{
293#define EFI_GENERIC_ERROR_PROC_OPERATION_GENERIC 0x00
294#define EFI_GENERIC_ERROR_PROC_OPERATION_DATA_READ 0x01
295#define EFI_GENERIC_ERROR_PROC_OPERATION_DATA_WRITE 0x02
296#define EFI_GENERIC_ERROR_PROC_OPERATION_INSTRUCTION_EXEC 0x03
297///@}
298
299///
300/// Flags bit mask indicates additional information about the error in Proessor Generic
301/// Error section
302///@{
303#define EFI_GENERIC_ERROR_PROC_FLAGS_RESTARTABLE BIT0
304#define EFI_GENERIC_ERROR_PROC_FLAGS_PRECISE_IP BIT1
305#define EFI_GENERIC_ERROR_PROC_FLAGS_OVERFLOW BIT2
306#define EFI_GENERIC_ERROR_PROC_FLAGS_CORRECTED BIT3
307///@}
308
309///
310/// Processor Generic Error Section
311/// describes processor reported hardware errors for logical processors in the system.
312///
313typedef struct {
314 UINT64 ValidFields;
315 UINT8 Type;
316 UINT8 Isa;
317 UINT8 ErrorType;
318 UINT8 Operation;
319 UINT8 Flags;
320 UINT8 Level;
321 UINT16 Resv1;
322 UINT64 VersionInfo;
323 CHAR8 BrandString[128];
324 UINT64 ApicId;
325 UINT64 TargetAddr;
326 UINT64 RequestorId;
327 UINT64 ResponderId;
328 UINT64 InstructionIP;
329} EFI_PROCESSOR_GENERIC_ERROR_DATA;
330
Lawrence Tang1b0b00e2022-07-05 10:33:10 +0100331///
332/// IA32 and x64 Specific definitions.
333///
334
335///
336/// GUID value indicating the type of Processor Error Information structure
337/// in IA32/X64 Processor Error Information Structure.
338///@{
339#define EFI_IA32_X64_ERROR_TYPE_CACHE_CHECK_GUID \
340 { \
341 0xA55701F5, 0xE3EF, 0x43de, {0xAC, 0x72, 0x24, 0x9B, 0x57, 0x3F, 0xAD, 0x2C } \
342 }
343#define EFI_IA32_X64_ERROR_TYPE_TLB_CHECK_GUID \
344 { \
345 0xFC06B535, 0x5E1F, 0x4562, {0x9F, 0x25, 0x0A, 0x3B, 0x9A, 0xDB, 0x63, 0xC3 } \
346 }
347#define EFI_IA32_X64_ERROR_TYPE_BUS_CHECK_GUID \
348 { \
349 0x1CF3F8B3, 0xC5B1, 0x49a2, {0xAA, 0x59, 0x5E, 0xEF, 0x92, 0xFF, 0xA6, 0x3C } \
350 }
351#define EFI_IA32_X64_ERROR_TYPE_MS_CHECK_GUID \
352 { \
353 0x48AB7F57, 0xDC34, 0x4f6c, {0xA7, 0xD3, 0xB0, 0xB5, 0xB0, 0xA7, 0x43, 0x14 } \
354 }
Lawrence Tang794312c2022-07-05 14:46:10 +0100355extern EFI_GUID gEfiIa32x64ErrorTypeCacheCheckGuid;
356extern EFI_GUID gEfiIa32x64ErrorTypeTlbCheckGuid;
357extern EFI_GUID gEfiIa32x64ErrorTypeBusCheckGuid;
358extern EFI_GUID gEfiIa32x64ErrorTypeMsCheckGuid;
359
Lawrence Tang1b0b00e2022-07-05 10:33:10 +0100360///@}
361
362///
363/// The validation bit mask indicates which fields in the IA32/X64 Processor
364/// Error Record structure are valid.
365///@{
366#define EFI_IA32_X64_PROCESSOR_ERROR_APIC_ID_VALID BIT0
367#define EFI_IA32_X64_PROCESSOR_ERROR_CPU_ID_INFO_VALID BIT1
368///@}
369
370///
371/// IA32/X64 Processor Error Record
372///
373typedef struct {
374 UINT64 ValidFields;
375 UINT64 ApicId;
376 UINT8 CpuIdInfo[48];
377} EFI_IA32_X64_PROCESSOR_ERROR_RECORD;
378
379///
380/// The validation bit mask indicates which fields in the Cache Check structure
381/// are valid.
382///@{
383#define EFI_CACHE_CHECK_TRANSACTION_TYPE_VALID BIT0
384#define EFI_CACHE_CHECK_OPERATION_VALID BIT1
385#define EFI_CACHE_CHECK_LEVEL_VALID BIT2
386#define EFI_CACHE_CHECK_CONTEXT_CORRUPT_VALID BIT3
387#define EFI_CACHE_CHECK_UNCORRECTED_VALID BIT4
388#define EFI_CACHE_CHECK_PRECISE_IP_VALID BIT5
389#define EFI_CACHE_CHECK_RESTARTABLE_VALID BIT6
390#define EFI_CACHE_CHECK_OVERFLOW_VALID BIT7
391///@}
392
393///
394/// Type of cache error in the Cache Check structure
395///@{
396#define EFI_CACHE_CHECK_ERROR_TYPE_INSTRUCTION 0
397#define EFI_CACHE_CHECK_ERROR_TYPE_DATA_ACCESS 1
398#define EFI_CACHE_CHECK_ERROR_TYPE_GENERIC 2
399///@}
400
401///
402/// Type of cache operation that caused the error in the Cache
403/// Check structure
404///@{
405#define EFI_CACHE_CHECK_OPERATION_TYPE_GENERIC 0
406#define EFI_CACHE_CHECK_OPERATION_TYPE_GENERIC_READ 1
407#define EFI_CACHE_CHECK_OPERATION_TYPE_GENERIC_WRITE 2
408#define EFI_CACHE_CHECK_OPERATION_TYPE_DATA_READ 3
409#define EFI_CACHE_CHECK_OPERATION_TYPE_DATA_WRITE 4
410#define EFI_CACHE_CHECK_OPERATION_TYPE_INSTRUCTION_FETCH 5
411#define EFI_CACHE_CHECK_OPERATION_TYPE_PREFETCH 6
412#define EFI_CACHE_CHECK_OPERATION_TYPE_EVICTION 7
413#define EFI_CACHE_CHECK_OPERATION_TYPE_SNOOP 8
414///@}
415
416///
417/// IA32/X64 Cache Check Structure
418///
419typedef struct {
420 UINT64 ValidFields : 16;
421 UINT64 TransactionType : 2;
422 UINT64 Operation : 4;
423 UINT64 Level : 3;
424 UINT64 ContextCorrupt : 1;
425 UINT64 ErrorUncorrected : 1;
426 UINT64 PreciseIp : 1;
427 UINT64 RestartableIp : 1;
428 UINT64 Overflow : 1;
429 UINT64 Resv1 : 34;
430} EFI_IA32_X64_CACHE_CHECK_INFO;
431
432///
433/// The validation bit mask indicates which fields in the TLB Check structure
434/// are valid.
435///@{
436#define EFI_TLB_CHECK_TRANSACTION_TYPE_VALID BIT0
437#define EFI_TLB_CHECK_OPERATION_VALID BIT1
438#define EFI_TLB_CHECK_LEVEL_VALID BIT2
439#define EFI_TLB_CHECK_CONTEXT_CORRUPT_VALID BIT3
440#define EFI_TLB_CHECK_UNCORRECTED_VALID BIT4
441#define EFI_TLB_CHECK_PRECISE_IP_VALID BIT5
442#define EFI_TLB_CHECK_RESTARTABLE_VALID BIT6
443#define EFI_TLB_CHECK_OVERFLOW_VALID BIT7
444///@}
445
446///
447/// Type of cache error in the TLB Check structure
448///@{
449#define EFI_TLB_CHECK_ERROR_TYPE_INSTRUCTION 0
450#define EFI_TLB_CHECK_ERROR_TYPE_DATA_ACCESS 1
451#define EFI_TLB_CHECK_ERROR_TYPE_GENERIC 2
452///@}
453
454///
455/// Type of cache operation that caused the error in the TLB
456/// Check structure
457///@{
458#define EFI_TLB_CHECK_OPERATION_TYPE_GENERIC 0
459#define EFI_TLB_CHECK_OPERATION_TYPE_GENERIC_READ 1
460#define EFI_TLB_CHECK_OPERATION_TYPE_GENERIC_WRITE 2
461#define EFI_TLB_CHECK_OPERATION_TYPE_DATA_READ 3
462#define EFI_TLB_CHECK_OPERATION_TYPE_DATA_WRITE 4
463#define EFI_TLB_CHECK_OPERATION_TYPE_INST_FETCH 5
464#define EFI_TLB_CHECK_OPERATION_TYPE_PREFETCH 6
465///@}
466
467///
468/// IA32/X64 TLB Check Structure
469///
470typedef struct {
471 UINT64 ValidFields : 16;
472 UINT64 TransactionType : 2;
473 UINT64 Operation : 4;
474 UINT64 Level : 3;
475 UINT64 ContextCorrupt : 1;
476 UINT64 ErrorUncorrected : 1;
477 UINT64 PreciseIp : 1;
478 UINT64 RestartableIp : 1;
479 UINT64 Overflow : 1;
480 UINT64 Resv1 : 34;
481} EFI_IA32_X64_TLB_CHECK_INFO;
482
483///
484/// The validation bit mask indicates which fields in the MS Check structure
485/// are valid.
486///@{
487#define EFI_BUS_CHECK_TRANSACTION_TYPE_VALID BIT0
488#define EFI_BUS_CHECK_OPERATION_VALID BIT1
489#define EFI_BUS_CHECK_LEVEL_VALID BIT2
490#define EFI_BUS_CHECK_CONTEXT_CORRUPT_VALID BIT3
491#define EFI_BUS_CHECK_UNCORRECTED_VALID BIT4
492#define EFI_BUS_CHECK_PRECISE_IP_VALID BIT5
493#define EFI_BUS_CHECK_RESTARTABLE_VALID BIT6
494#define EFI_BUS_CHECK_OVERFLOW_VALID BIT7
495#define EFI_BUS_CHECK_PARTICIPATION_TYPE_VALID BIT8
496#define EFI_BUS_CHECK_TIME_OUT_VALID BIT9
497#define EFI_BUS_CHECK_ADDRESS_SPACE_VALID BIT10
498///@}
499
500///
501/// Type of cache error in the Bus Check structure
502///@{
503#define EFI_BUS_CHECK_ERROR_TYPE_INSTRUCTION 0
504#define EFI_BUS_CHECK_ERROR_TYPE_DATA_ACCESS 1
505#define EFI_BUS_CHECK_ERROR_TYPE_GENERIC 2
506///@}
507
508///
509/// Type of cache operation that caused the error in the Bus
510/// Check structure
511///@{
512#define EFI_BUS_CHECK_OPERATION_TYPE_GENERIC 0
513#define EFI_BUS_CHECK_OPERATION_TYPE_GENERIC_READ 1
514#define EFI_BUS_CHECK_OPERATION_TYPE_GENERIC_WRITE 2
515#define EFI_BUS_CHECK_OPERATION_TYPE_DATA_READ 3
516#define EFI_BUS_CHECK_OPERATION_TYPE_DATA_WRITE 4
517#define EFI_BUS_CHECK_OPERATION_TYPE_INST_FETCH 5
518#define EFI_BUS_CHECK_OPERATION_TYPE_PREFETCH 6
519///@}
520
521///
522/// Type of Participation
523///@{
524#define EFI_BUS_CHECK_PARTICIPATION_TYPE_REQUEST 0
525#define EFI_BUS_CHECK_PARTICIPATION_TYPE_RESPONDED 1
526#define EFI_BUS_CHECK_PARTICIPATION_TYPE_OBSERVED 2
527#define EFI_BUS_CHECK_PARTICIPATION_TYPE_GENERIC 3
528///@}
529
530///
531/// Type of Address Space
532///@{
533#define EFI_BUS_CHECK_ADDRESS_SPACE_TYPE_MEMORY 0
534#define EFI_BUS_CHECK_ADDRESS_SPACE_TYPE_RESERVED 1
535#define EFI_BUS_CHECK_ADDRESS_SPACE_TYPE_IO 2
536#define EFI_BUS_CHECK_ADDRESS_SPACE_TYPE_OTHER 3
537///@}
538
539///
540/// IA32/X64 Bus Check Structure
541///
542typedef struct {
543 UINT64 ValidFields : 16;
544 UINT64 TransactionType : 2;
545 UINT64 Operation : 4;
546 UINT64 Level : 3;
547 UINT64 ContextCorrupt : 1;
548 UINT64 ErrorUncorrected : 1;
549 UINT64 PreciseIp : 1;
550 UINT64 RestartableIp : 1;
551 UINT64 Overflow : 1;
552 UINT64 ParticipationType : 2;
553 UINT64 TimeOut : 1;
554 UINT64 AddressSpace : 2;
555 UINT64 Resv1 : 29;
556} EFI_IA32_X64_BUS_CHECK_INFO;
557
558///
559/// The validation bit mask indicates which fields in the MS Check structure
560/// are valid.
561///@{
562#define EFI_MS_CHECK_ERROR_TYPE_VALID BIT0
563#define EFI_MS_CHECK_CONTEXT_CORRUPT_VALID BIT1
564#define EFI_MS_CHECK_UNCORRECTED_VALID BIT2
565#define EFI_MS_CHECK_PRECISE_IP_VALID BIT3
566#define EFI_MS_CHECK_RESTARTABLE_VALID BIT4
567#define EFI_MS_CHECK_OVERFLOW_VALID BIT5
568///@}
569
570///
571/// Error type identifies the operation that caused the error.
572///@{
573#define EFI_MS_CHECK_ERROR_TYPE_NO 0
574#define EFI_MS_CHECK_ERROR_TYPE_UNCLASSIFIED 1
575#define EFI_MS_CHECK_ERROR_TYPE_MICROCODE_PARITY 2
576#define EFI_MS_CHECK_ERROR_TYPE_EXTERNAL 3
577#define EFI_MS_CHECK_ERROR_TYPE_FRC 4
578#define EFI_MS_CHECK_ERROR_TYPE_INTERNAL_UNCLASSIFIED 5
579///@}
580
581///
582/// IA32/X64 MS Check Field Description
583///
584typedef struct {
585 UINT64 ValidFields : 16;
586 UINT64 ErrorType : 3;
587 UINT64 ContextCorrupt : 1;
588 UINT64 ErrorUncorrected : 1;
589 UINT64 PreciseIp : 1;
590 UINT64 RestartableIp : 1;
591 UINT64 Overflow : 1;
592 UINT64 Resv1 : 40;
593} EFI_IA32_X64_MS_CHECK_INFO;
594
595///
596/// IA32/X64 Check Information Item
597///
598typedef union {
599 EFI_IA32_X64_CACHE_CHECK_INFO CacheCheck;
600 EFI_IA32_X64_TLB_CHECK_INFO TlbCheck;
601 EFI_IA32_X64_BUS_CHECK_INFO BusCheck;
602 EFI_IA32_X64_MS_CHECK_INFO MsCheck;
603 UINT64 Data64;
604} EFI_IA32_X64_CHECK_INFO_ITEM;
605
606///
607/// The validation bit mask indicates which fields in the IA32/X64 Processor Error
608/// Information Structure are valid.
609///@{
610#define EFI_IA32_X64_ERROR_PROC_CHECK_INFO_VALID BIT0
611#define EFI_IA32_X64_ERROR_PROC_TARGET_ADDR_VALID BIT1
612#define EFI_IA32_X64_ERROR_PROC_REQUESTER_ID_VALID BIT2
613#define EFI_IA32_X64_ERROR_PROC_RESPONDER_ID_VALID BIT3
614#define EFI_IA32_X64_ERROR_PROC_INST_IP_VALID BIT4
615///@}
616
617///
618/// IA32/X64 Processor Error Information Structure
619///
620typedef struct {
621 EFI_GUID ErrorType;
622 UINT64 ValidFields;
623 EFI_IA32_X64_CHECK_INFO_ITEM CheckInfo;
624 UINT64 TargetId;
625 UINT64 RequestorId;
626 UINT64 ResponderId;
627 UINT64 InstructionIP;
628} EFI_IA32_X64_PROCESS_ERROR_INFO;
629
630///
631/// IA32/X64 Processor Context Information Structure
632///
633typedef struct {
634 UINT16 RegisterType;
635 UINT16 ArraySize;
636 UINT32 MsrAddress;
637 UINT64 MmRegisterAddress;
638 //
639 // This field will provide the contents of the actual registers or raw data.
640 // The number of Registers or size of the raw data reported is determined
641 // by (Array Size / 8) or otherwise specified by the context structure type
642 // definition.
643 //
644} EFI_IA32_X64_PROCESSOR_CONTEXT_INFO;
645
646///
647/// Register Context Type
648///@{
649#define EFI_REG_CONTEXT_TYPE_UNCLASSIFIED 0x0000
650#define EFI_REG_CONTEXT_TYPE_MSR 0x0001
651#define EFI_REG_CONTEXT_TYPE_IA32 0x0002
652#define EFI_REG_CONTEXT_TYPE_X64 0x0003
653#define EFI_REG_CONTEXT_TYPE_FXSAVE 0x0004
654#define EFI_REG_CONTEXT_TYPE_DR_IA32 0x0005
655#define EFI_REG_CONTEXT_TYPE_DR_X64 0x0006
656#define EFI_REG_CONTEXT_TYPE_MEM_MAP 0x0007
657///@}
658
659///
660/// IA32 Register State
661///
662typedef struct {
663 UINT32 Eax;
664 UINT32 Ebx;
665 UINT32 Ecx;
666 UINT32 Edx;
667 UINT32 Esi;
668 UINT32 Edi;
669 UINT32 Ebp;
670 UINT32 Esp;
671 UINT16 Cs;
672 UINT16 Ds;
673 UINT16 Ss;
674 UINT16 Es;
675 UINT16 Fs;
676 UINT16 Gs;
677 UINT32 Eflags;
678 UINT32 Eip;
679 UINT32 Cr0;
680 UINT32 Cr1;
681 UINT32 Cr2;
682 UINT32 Cr3;
683 UINT32 Cr4;
684 UINT32 Gdtr[2];
685 UINT32 Idtr[2];
686 UINT16 Ldtr;
687 UINT16 Tr;
688} EFI_CONTEXT_IA32_REGISTER_STATE;
689
690///
691/// X64 Register State
692///
693typedef struct {
694 UINT64 Rax;
695 UINT64 Rbx;
696 UINT64 Rcx;
697 UINT64 Rdx;
698 UINT64 Rsi;
699 UINT64 Rdi;
700 UINT64 Rbp;
701 UINT64 Rsp;
702 UINT64 R8;
703 UINT64 R9;
704 UINT64 R10;
705 UINT64 R11;
706 UINT64 R12;
707 UINT64 R13;
708 UINT64 R14;
709 UINT64 R15;
710 UINT16 Cs;
711 UINT16 Ds;
712 UINT16 Ss;
713 UINT16 Es;
714 UINT16 Fs;
715 UINT16 Gs;
716 UINT32 Resv1;
717 UINT64 Rflags;
718 UINT64 Rip;
719 UINT64 Cr0;
720 UINT64 Cr1;
721 UINT64 Cr2;
722 UINT64 Cr3;
723 UINT64 Cr4;
724 UINT64 Gdtr[2];
725 UINT64 Idtr[2];
726 UINT16 Ldtr;
727 UINT16 Tr;
728} EFI_CONTEXT_X64_REGISTER_STATE;
729
730///
731/// The validation bit mask indicates each of the following field is in IA32/X64
732/// Processor Error Section.
733///
734typedef struct {
735 UINT64 ApicIdValid : 1;
736 UINT64 CpuIdInforValid : 1;
737 UINT64 ErrorInfoNum : 6;
738 UINT64 ContextNum : 6;
739 UINT64 Resv1 : 50;
740} EFI_IA32_X64_VALID_BITS;
741
Lawrence Tang3d0e4f22022-07-05 17:17:41 +0100742///
Lawrence Tang1b0b00e2022-07-05 10:33:10 +0100743/// Error Status Fields
744///
745typedef struct {
746 UINT64 Resv1 : 8;
747 UINT64 Type : 8;
748 UINT64 AddressSignal : 1; ///< Error in Address signals or in Address portion of transaction
749 UINT64 ControlSignal : 1; ///< Error in Control signals or in Control portion of transaction
750 UINT64 DataSignal : 1; ///< Error in Data signals or in Data portion of transaction
751 UINT64 DetectedByResponder : 1; ///< Error detected by responder
752 UINT64 DetectedByRequester : 1; ///< Error detected by requestor
753 UINT64 FirstError : 1; ///< First Error in the sequence - option field
754 UINT64 OverflowNotLogged : 1; ///< Additional errors were not logged due to lack of resources
755 UINT64 Resv2 : 41;
756} EFI_GENERIC_ERROR_STATUS;
757
758///
Lawrence Tanga0865e32022-07-06 11:59:52 +0100759/// CPER Generic Error Codes
760///
761#define CPER_GENERIC_ERROR_TYPES_KEYS (int []){1, 16, 4, 5, 6, 7, 8, 9, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26}
762#define CPER_GENERIC_ERROR_TYPES_VALUES (const char*[]){"ERR_INTERNAL", "ERR_BUS", "ERR_MEM", "ERR_TLB", \
763 "ERR_CACHE", "ERR_FUNCTION", "ERR_SELFTEST", "ERR_FLOW", "ERR_MAP", "ERR_IMPROPER", "ERR_UNIMPL", \
764 "ERR_LOL", "ERR_RESPONSE", "ERR_PARITY", "ERR_PROTOCOL", "ERR_ERROR", "ERR_TIMEOUT", "ERR_POISONED"}
765#define CPER_GENERIC_ERROR_TYPES_DESCRIPTIONS (const char*[]){\
766 "Error detected internal to the component.", \
767 "Error detected in the bus.", \
768 "Storage error in memory (DRAM).", \
769 "Storage error in TLB.", \
770 "Storage error in cache.", \
771 "Error in one or more functional units.", \
772 "Component failed self test.", \
773 "Overflow or underflow of internal queue.", \
774 "Virtual address not found on IO-TLB or IO-PDIR.", \
775 "Improper access error.", \
776 "Access to a memory address which is not mapped to any component.", \
777 "Loss of Lockstep error.", \
778 "Response not associated with a request.", \
779 "Bus parity error (must also set the A, C, or D bits).", \
780 "Detection of a protocol error.", \
781 "Detection of a PATH_ERROR.", \
782 "Bus operation timeout.", \
783 "A read was issued to data that has been poisoned."}
784
785///
Lawrence Tang1b0b00e2022-07-05 10:33:10 +0100786/// Error Type
787///
788typedef enum {
789 ///
790 /// General Internal errors
791 ///
792 ErrorInternal = 1,
793 ErrorBus = 16,
794 ///
795 /// Component Internal errors
796 ///
797 ErrorMemStorage = 4, // Error in memory device
798 ErrorTlbStorage = 5, // TLB error in cache
799 ErrorCacheStorage = 6,
800 ErrorFunctionalUnit = 7,
801 ErrorSelftest = 8,
802 ErrorOverflow = 9,
803 ///
804 /// Bus internal errors
805 ///
806 ErrorVirtualMap = 17,
807 ErrorAccessInvalid = 18, // Improper access
808 ErrorUnimplAccess = 19, // Unimplemented memory access
809 ErrorLossOfLockstep = 20,
810 ErrorResponseInvalid = 21, // Response not associated with request
811 ErrorParity = 22,
812 ErrorProtocol = 23,
813 ErrorPath = 24, // Detected path error
814 ErrorTimeout = 25, // Bus timeout
815 ErrorPoisoned = 26 // Read data poisoned
816} EFI_GENERIC_ERROR_STATUS_ERROR_TYPE;
817
818///
819/// Validation bit mask indicates which fields in the memory error record are valid
820/// in Memory Error section
821///@{
822#define EFI_PLATFORM_MEMORY_ERROR_STATUS_VALID BIT0
823#define EFI_PLATFORM_MEMORY_PHY_ADDRESS_VALID BIT1
824#define EFI_PLATFORM_MEMORY_PHY_ADDRESS_MASK_VALID BIT2
825#define EFI_PLATFORM_MEMORY_NODE_VALID BIT3
826#define EFI_PLATFORM_MEMORY_CARD_VALID BIT4
827#define EFI_PLATFORM_MEMORY_MODULE_VALID BIT5
828#define EFI_PLATFORM_MEMORY_BANK_VALID BIT6
829#define EFI_PLATFORM_MEMORY_DEVICE_VALID BIT7
830#define EFI_PLATFORM_MEMORY_ROW_VALID BIT8
831#define EFI_PLATFORM_MEMORY_COLUMN_VALID BIT9
832#define EFI_PLATFORM_MEMORY_BIT_POS_VALID BIT10
833#define EFI_PLATFORM_MEMORY_REQUESTOR_ID_VALID BIT11
834#define EFI_PLATFORM_MEMORY_RESPONDER_ID_VALID BIT12
835#define EFI_PLATFORM_MEMORY_TARGET_ID_VALID BIT13
836#define EFI_PLATFORM_MEMORY_ERROR_TYPE_VALID BIT14
837#define EFI_PLATFORM_MEMORY_ERROR_RANK_NUM_VALID BIT15
838#define EFI_PLATFORM_MEMORY_ERROR_CARD_HANDLE_VALID BIT16
839#define EFI_PLATFORM_MEMORY_ERROR_MODULE_HANDLE_VALID BIT17
840#define EFI_PLATFORM_MEMORY_ERROR_EXTENDED_ROW_BIT_16_17_VALID BIT18
841#define EFI_PLATFORM_MEMORY_ERROR_BANK_GROUP_VALID BIT19
842#define EFI_PLATFORM_MEMORY_ERROR_BANK_ADDRESS_VALID BIT20
843#define EFI_PLATFORM_MEMORY_ERROR_CHIP_IDENTIFICATION_VALID BIT21
844///@}
845
846///
847/// Memory Error Type identifies the type of error that occurred in Memory
848/// Error section
849///@{
850#define EFI_PLATFORM_MEMORY_ERROR_UNKNOWN 0x00
851#define EFI_PLATFORM_MEMORY_ERROR_NONE 0x01
852#define EFI_PLATFORM_MEMORY_ERROR_SINGLEBIT_ECC 0x02
853#define EFI_PLATFORM_MEMORY_ERROR_MLTIBIT_ECC 0x03
854#define EFI_PLATFORM_MEMORY_ERROR_SINGLESYMBOLS_CHIPKILL 0x04
855#define EFI_PLATFORM_MEMORY_ERROR_MULTISYMBOL_CHIPKILL 0x05
856#define EFI_PLATFORM_MEMORY_ERROR_MATER_ABORT 0x06
857#define EFI_PLATFORM_MEMORY_ERROR_TARGET_ABORT 0x07
858#define EFI_PLATFORM_MEMORY_ERROR_PARITY 0x08
859#define EFI_PLATFORM_MEMORY_ERROR_WDT 0x09
860#define EFI_PLATFORM_MEMORY_ERROR_INVALID_ADDRESS 0x0A
861#define EFI_PLATFORM_MEMORY_ERROR_MIRROR_FAILED 0x0B
862#define EFI_PLATFORM_MEMORY_ERROR_SPARING 0x0C
863#define EFI_PLATFORM_MEMORY_ERROR_SCRUB_CORRECTED 0x0D
864#define EFI_PLATFORM_MEMORY_ERROR_SCRUB_UNCORRECTED 0x0E
865#define EFI_PLATFORM_MEMORY_ERROR_MEMORY_MAP_EVENT 0x0F
866///@}
867
868///
869/// Memory Error Section
870///
871typedef struct {
872 UINT64 ValidFields;
873 EFI_GENERIC_ERROR_STATUS ErrorStatus;
874 UINT64 PhysicalAddress; // Error physical address
875 UINT64 PhysicalAddressMask; // Grnaularity
876 UINT16 Node; // Node #
877 UINT16 Card;
878 UINT16 ModuleRank; // Module or Rank#
879 UINT16 Bank;
880 UINT16 Device;
881 UINT16 Row;
882 UINT16 Column;
883 UINT16 BitPosition;
884 UINT64 RequestorId;
885 UINT64 ResponderId;
886 UINT64 TargetId;
887 UINT8 ErrorType;
888 UINT8 Extended;
889 UINT16 RankNum;
890 UINT16 CardHandle;
891 UINT16 ModuleHandle;
892} EFI_PLATFORM_MEMORY_ERROR_DATA;
893
894///
895/// Validation bit mask indicates which fields in the memory error record 2 are valid
896/// in Memory Error section 2
897///@{
898#define EFI_PLATFORM_MEMORY2_ERROR_STATUS_VALID BIT0
899#define EFI_PLATFORM_MEMORY2_PHY_ADDRESS_VALID BIT1
900#define EFI_PLATFORM_MEMORY2_PHY_ADDRESS_MASK_VALID BIT2
901#define EFI_PLATFORM_MEMORY2_NODE_VALID BIT3
902#define EFI_PLATFORM_MEMORY2_CARD_VALID BIT4
903#define EFI_PLATFORM_MEMORY2_MODULE_VALID BIT5
904#define EFI_PLATFORM_MEMORY2_BANK_VALID BIT6
905#define EFI_PLATFORM_MEMORY2_DEVICE_VALID BIT7
906#define EFI_PLATFORM_MEMORY2_ROW_VALID BIT8
907#define EFI_PLATFORM_MEMORY2_COLUMN_VALID BIT9
908#define EFI_PLATFORM_MEMORY2_RANK_VALID BIT10
909#define EFI_PLATFORM_MEMORY2_BIT_POS_VALID BIT11
910#define EFI_PLATFORM_MEMORY2_CHIP_ID_VALID BIT12
911#define EFI_PLATFORM_MEMORY2_MEMORY_ERROR_TYPE_VALID BIT13
912#define EFI_PLATFORM_MEMORY2_STATUS_VALID BIT14
913#define EFI_PLATFORM_MEMORY2_REQUESTOR_ID_VALID BIT15
914#define EFI_PLATFORM_MEMORY2_RESPONDER_ID_VALID BIT16
915#define EFI_PLATFORM_MEMORY2_TARGET_ID_VALID BIT17
916#define EFI_PLATFORM_MEMORY2_CARD_HANDLE_VALID BIT18
917#define EFI_PLATFORM_MEMORY2_MODULE_HANDLE_VALID BIT19
918#define EFI_PLATFORM_MEMORY2_BANK_GROUP_VALID BIT20
919#define EFI_PLATFORM_MEMORY2_BANK_ADDRESS_VALID BIT21
920///@}
921
922///
923/// Memory Error Type identifies the type of error that occurred in Memory
924/// Error section 2
925///@{
926#define EFI_PLATFORM_MEMORY2_ERROR_UNKNOWN 0x00
927#define EFI_PLATFORM_MEMORY2_ERROR_NONE 0x01
928#define EFI_PLATFORM_MEMORY2_ERROR_SINGLEBIT_ECC 0x02
929#define EFI_PLATFORM_MEMORY2_ERROR_MLTIBIT_ECC 0x03
930#define EFI_PLATFORM_MEMORY2_ERROR_SINGLESYMBOL_CHIPKILL 0x04
931#define EFI_PLATFORM_MEMORY2_ERROR_MULTISYMBOL_CHIPKILL 0x05
932#define EFI_PLATFORM_MEMORY2_ERROR_MASTER_ABORT 0x06
933#define EFI_PLATFORM_MEMORY2_ERROR_TARGET_ABORT 0x07
934#define EFI_PLATFORM_MEMORY2_ERROR_PARITY 0x08
935#define EFI_PLATFORM_MEMORY2_ERROR_WDT 0x09
936#define EFI_PLATFORM_MEMORY2_ERROR_INVALID_ADDRESS 0x0A
937#define EFI_PLATFORM_MEMORY2_ERROR_MIRROR_BROKEN 0x0B
938#define EFI_PLATFORM_MEMORY2_ERROR_MEMORY_SPARING 0x0C
939#define EFI_PLATFORM_MEMORY2_ERROR_SCRUB_CORRECTED 0x0D
940#define EFI_PLATFORM_MEMORY2_ERROR_SCRUB_UNCORRECTED 0x0E
941#define EFI_PLATFORM_MEMORY2_ERROR_MEMORY_MAP_EVENT 0x0F
942///@}
943
944///
945/// Memory Error Section 2
946///
947typedef struct {
948 UINT64 ValidFields;
949 EFI_GENERIC_ERROR_STATUS ErrorStatus;
950 UINT64 PhysicalAddress; // Error physical address
951 UINT64 PhysicalAddressMask; // Grnaularity
952 UINT16 Node; // Node #
953 UINT16 Card;
954 UINT16 Module; // Module or Rank#
955 UINT16 Bank;
956 UINT32 Device;
957 UINT32 Row;
958 UINT32 Column;
959 UINT32 Rank;
960 UINT32 BitPosition;
961 UINT8 ChipId;
962 UINT8 MemErrorType;
963 UINT8 Status;
964 UINT8 Reserved;
965 UINT64 RequestorId;
966 UINT64 ResponderId;
967 UINT64 TargetId;
968 UINT32 CardHandle;
969 UINT32 ModuleHandle;
970} EFI_PLATFORM_MEMORY2_ERROR_DATA;
971
972///
973/// Validation bits mask indicates which of the following fields is valid
974/// in PCI Express Error Record.
975///@{
976#define EFI_PCIE_ERROR_PORT_TYPE_VALID BIT0
977#define EFI_PCIE_ERROR_VERSION_VALID BIT1
978#define EFI_PCIE_ERROR_COMMAND_STATUS_VALID BIT2
979#define EFI_PCIE_ERROR_DEVICE_ID_VALID BIT3
980#define EFI_PCIE_ERROR_SERIAL_NO_VALID BIT4
981#define EFI_PCIE_ERROR_BRIDGE_CRL_STS_VALID BIT5
982#define EFI_PCIE_ERROR_CAPABILITY_INFO_VALID BIT6
983#define EFI_PCIE_ERROR_AER_INFO_VALID BIT7
984///@}
985
986///
987/// PCIe Device/Port Type as defined in the PCI Express capabilities register
988///@{
989#define EFI_PCIE_ERROR_PORT_PCIE_ENDPOINT 0x00000000
990#define EFI_PCIE_ERROR_PORT_PCI_ENDPOINT 0x00000001
991#define EFI_PCIE_ERROR_PORT_ROOT_PORT 0x00000004
992#define EFI_PCIE_ERROR_PORT_UPSWITCH_PORT 0x00000005
993#define EFI_PCIE_ERROR_PORT_DOWNSWITCH_PORT 0x00000006
994#define EFI_PCIE_ERROR_PORT_PCIE_TO_PCI_BRIDGE 0x00000007
995#define EFI_PCIE_ERROR_PORT_PCI_TO_PCIE_BRIDGE 0x00000008
996#define EFI_PCIE_ERROR_PORT_ROOT_INT_ENDPOINT 0x00000009
997#define EFI_PCIE_ERROR_PORT_ROOT_EVENT_COLLECTOR 0x0000000A
998///@}
999
1000///
1001/// PCI Slot number
1002///
1003typedef struct {
1004 UINT16 Resv1 : 3;
1005 UINT16 Number : 13;
1006} EFI_GENERIC_ERROR_PCI_SLOT;
1007
1008///
1009/// PCIe Root Port PCI/bridge PCI compatible device number and
1010/// bus number information to uniquely identify the root port or
1011/// bridge. Default values for both the bus numbers is zero.
1012///
1013typedef struct {
1014 UINT16 VendorId;
1015 UINT16 DeviceId;
1016 UINT8 ClassCode[3];
1017 UINT8 Function;
1018 UINT8 Device;
1019 UINT16 Segment;
1020 UINT8 PrimaryOrDeviceBus;
1021 UINT8 SecondaryBus;
1022 EFI_GENERIC_ERROR_PCI_SLOT Slot;
1023 UINT8 Resv1;
1024} EFI_GENERIC_ERROR_PCIE_DEV_BRIDGE_ID;
1025
1026///
1027/// PCIe Capability Structure
1028///
1029typedef struct {
1030 UINT8 PcieCap[60];
1031} EFI_PCIE_ERROR_DATA_CAPABILITY;
1032
1033///
1034/// PCIe Advanced Error Reporting Extended Capability Structure.
1035///
1036typedef struct {
1037 UINT8 PcieAer[96];
1038} EFI_PCIE_ERROR_DATA_AER;
1039
1040///
1041/// PCI Express Error Record
1042///
1043typedef struct {
1044 UINT64 ValidFields;
1045 UINT32 PortType;
1046 UINT32 Version;
1047 UINT32 CommandStatus;
1048 UINT32 Resv2;
1049 EFI_GENERIC_ERROR_PCIE_DEV_BRIDGE_ID DevBridge;
1050 UINT64 SerialNo;
1051 UINT32 BridgeControlStatus;
1052 EFI_PCIE_ERROR_DATA_CAPABILITY Capability;
1053 EFI_PCIE_ERROR_DATA_AER AerInfo;
1054} EFI_PCIE_ERROR_DATA;
1055
1056///
1057/// Validation bits Indicates which of the following fields is valid
1058/// in PCI/PCI-X Bus Error Section.
1059///@{
1060#define EFI_PCI_PCIX_BUS_ERROR_STATUS_VALID BIT0
1061#define EFI_PCI_PCIX_BUS_ERROR_TYPE_VALID BIT1
1062#define EFI_PCI_PCIX_BUS_ERROR_BUS_ID_VALID BIT2
1063#define EFI_PCI_PCIX_BUS_ERROR_BUS_ADDRESS_VALID BIT3
1064#define EFI_PCI_PCIX_BUS_ERROR_BUS_DATA_VALID BIT4
1065#define EFI_PCI_PCIX_BUS_ERROR_COMMAND_VALID BIT5
1066#define EFI_PCI_PCIX_BUS_ERROR_REQUESTOR_ID_VALID BIT6
1067#define EFI_PCI_PCIX_BUS_ERROR_COMPLETER_ID_VALID BIT7
1068#define EFI_PCI_PCIX_BUS_ERROR_TARGET_ID_VALID BIT8
1069///@}
1070
1071///
1072/// PCI Bus Error Type in PCI/PCI-X Bus Error Section
1073///@{
1074#define EFI_PCI_PCIX_BUS_ERROR_UNKNOWN 0x0000
1075#define EFI_PCI_PCIX_BUS_ERROR_DATA_PARITY 0x0001
1076#define EFI_PCI_PCIX_BUS_ERROR_SYSTEM 0x0002
1077#define EFI_PCI_PCIX_BUS_ERROR_MASTER_ABORT 0x0003
1078#define EFI_PCI_PCIX_BUS_ERROR_BUS_TIMEOUT 0x0004
1079#define EFI_PCI_PCIX_BUS_ERROR_MASTER_DATA_PARITY 0x0005
1080#define EFI_PCI_PCIX_BUS_ERROR_ADDRESS_PARITY 0x0006
1081#define EFI_PCI_PCIX_BUS_ERROR_COMMAND_PARITY 0x0007
1082///@}
1083
1084///
1085/// PCI/PCI-X Bus Error Section
1086///
1087typedef struct {
1088 UINT64 ValidFields;
1089 EFI_GENERIC_ERROR_STATUS ErrorStatus;
1090 UINT16 Type;
1091 UINT16 BusId;
1092 UINT32 Resv2;
1093 UINT64 BusAddress;
1094 UINT64 BusData;
1095 UINT64 BusCommand;
1096 UINT64 RequestorId;
1097 UINT64 ResponderId;
1098 UINT64 TargetId;
1099} EFI_PCI_PCIX_BUS_ERROR_DATA;
1100
1101///
1102/// Validation bits Indicates which of the following fields is valid
1103/// in PCI/PCI-X Component Error Section.
1104///@{
1105#define EFI_PCI_PCIX_DEVICE_ERROR_STATUS_VALID BIT0
1106#define EFI_PCI_PCIX_DEVICE_ERROR_ID_INFO_VALID BIT1
1107#define EFI_PCI_PCIX_DEVICE_ERROR_MEM_NUM_VALID BIT2
1108#define EFI_PCI_PCIX_DEVICE_ERROR_IO_NUM_VALID BIT3
1109#define EFI_PCI_PCIX_DEVICE_ERROR_REG_DATA_PAIR_VALID BIT4
1110///@}
1111
1112///
1113/// PCI/PCI-X Device Identification Information
1114///
1115typedef struct {
1116 UINT16 VendorId;
1117 UINT16 DeviceId;
1118 UINT8 ClassCode[3];
1119 UINT8 Function;
1120 UINT8 Device;
1121 UINT8 Bus;
1122 UINT8 Segment;
1123 UINT8 Resv1;
1124 UINT32 Resv2;
1125} EFI_GENERIC_ERROR_PCI_DEVICE_ID;
1126
1127///
1128/// Identifies the type of firmware error record
1129///@{
1130#define EFI_FIRMWARE_ERROR_TYPE_IPF_SAL 0x00
1131#define EFI_FIRMWARE_ERROR_TYPE_SOC_TYPE1 0x01
1132#define EFI_FIRMWARE_ERROR_TYPE_SOC_TYPE2 0x02
1133///@}
1134
1135///
1136/// Firmware Error Record Section
1137///
1138typedef struct {
1139 UINT8 ErrorType;
1140 UINT8 Revision;
1141 UINT8 Resv1[6];
1142 UINT64 RecordId;
1143 EFI_GUID RecordIdGuid;
1144} EFI_FIRMWARE_ERROR_DATA;
1145
1146///
1147/// Fault Reason in DMAr Generic Error Section
1148///@{
1149#define EFI_DMA_FAULT_REASON_TABLE_ENTRY_NOT_PRESENT 0x01
1150#define EFI_DMA_FAULT_REASON_TABLE_ENTRY_INVALID 0x02
1151#define EFI_DMA_FAULT_REASON_ACCESS_MAPPING_TABLE_ERROR 0x03
1152#define EFI_DMA_FAULT_REASON_RESV_BIT_ERROR_IN_MAPPING_TABLE 0x04
1153#define EFI_DMA_FAULT_REASON_ACCESS_ADDR_OUT_OF_SPACE 0x05
1154#define EFI_DMA_FAULT_REASON_INVALID_ACCESS 0x06
1155#define EFI_DMA_FAULT_REASON_INVALID_REQUEST 0x07
1156#define EFI_DMA_FAULT_REASON_ACCESS_TRANSLATE_TABLE_ERROR 0x08
1157#define EFI_DMA_FAULT_REASON_RESV_BIT_ERROR_IN_TRANSLATE_TABLE 0x09
1158#define EFI_DMA_FAULT_REASON_INVALID_COMMAOND 0x0A
1159#define EFI_DMA_FAULT_REASON_ACCESS_COMMAND_BUFFER_ERROR 0x0B
1160///@}
1161
1162///
1163/// DMA access type in DMAr Generic Error Section
1164///@{
1165#define EFI_DMA_ACCESS_TYPE_READ 0x00
1166#define EFI_DMA_ACCESS_TYPE_WRITE 0x01
1167///@}
1168
1169///
1170/// DMA address type in DMAr Generic Error Section
1171///@{
1172#define EFI_DMA_ADDRESS_UNTRANSLATED 0x00
1173#define EFI_DMA_ADDRESS_TRANSLATION 0x01
1174///@}
1175
1176///
1177/// Architecture type in DMAr Generic Error Section
1178///@{
1179#define EFI_DMA_ARCH_TYPE_VT 0x01
1180#define EFI_DMA_ARCH_TYPE_IOMMU 0x02
1181///@}
1182
1183///
1184/// DMAr Generic Error Section
1185///
1186typedef struct {
1187 UINT16 RequesterId;
1188 UINT16 SegmentNumber;
1189 UINT8 FaultReason;
1190 UINT8 AccessType;
1191 UINT8 AddressType;
1192 UINT8 ArchType;
1193 UINT64 DeviceAddr;
1194 UINT8 Resv1[16];
1195} EFI_DMAR_GENERIC_ERROR_DATA;
1196
1197///
1198/// Intel VT for Directed I/O specific DMAr Errors
1199///
1200typedef struct {
1201 UINT8 Version;
1202 UINT8 Revision;
1203 UINT8 OemId[6];
1204 UINT64 Capability;
1205 UINT64 CapabilityEx;
1206 UINT32 GlobalCommand;
1207 UINT32 GlobalStatus;
1208 UINT32 FaultStatus;
1209 UINT8 Resv1[12];
1210 UINT64 FaultRecord[2];
1211 UINT64 RootEntry[2];
1212 UINT64 ContextEntry[2];
1213 UINT64 PteL6;
1214 UINT64 PteL5;
1215 UINT64 PteL4;
1216 UINT64 PteL3;
1217 UINT64 PteL2;
1218 UINT64 PteL1;
1219} EFI_DIRECTED_IO_DMAR_ERROR_DATA;
1220
1221///
1222/// IOMMU specific DMAr Errors
1223///
1224typedef struct {
1225 UINT8 Revision;
1226 UINT8 Resv1[7];
1227 UINT64 Control;
1228 UINT64 Status;
1229 UINT8 Resv2[8];
1230 UINT64 EventLogEntry[2];
1231 UINT8 Resv3[16];
1232 UINT64 DeviceTableEntry[4];
1233 UINT64 PteL6;
1234 UINT64 PteL5;
1235 UINT64 PteL4;
1236 UINT64 PteL3;
1237 UINT64 PteL2;
1238 UINT64 PteL1;
1239} EFI_IOMMU_DMAR_ERROR_DATA;
1240
1241extern EFI_GUID gEfiEventNotificationTypeCmcGuid;
1242extern EFI_GUID gEfiEventNotificationTypeCpeGuid;
1243extern EFI_GUID gEfiEventNotificationTypeMceGuid;
1244extern EFI_GUID gEfiEventNotificationTypePcieGuid;
1245extern EFI_GUID gEfiEventNotificationTypeInitGuid;
1246extern EFI_GUID gEfiEventNotificationTypeNmiGuid;
1247extern EFI_GUID gEfiEventNotificationTypeBootGuid;
1248extern EFI_GUID gEfiEventNotificationTypeDmarGuid;
1249extern EFI_GUID gEfiEventNotificationTypeSeaGuid;
1250extern EFI_GUID gEfiEventNotificationTypeSeiGuid;
1251extern EFI_GUID gEfiEventNotificationTypePeiGuid;
1252extern EFI_GUID gEfiEventNotificationTypeCxlGuid;
1253extern EFI_GUID gEfiProcessorGenericErrorSectionGuid;
1254extern EFI_GUID gEfiProcessorSpecificErrorSectionGuid;
1255extern EFI_GUID gEfiIa32X64ProcessorErrorSectionGuid;
Lawrence Tangcc0f5f32022-07-06 17:17:26 +01001256extern EFI_GUID gEfiIpfProcessorErrorSectionGuid;
Lawrence Tang1b0b00e2022-07-05 10:33:10 +01001257extern EFI_GUID gEfiArmProcessorErrorSectionGuid;
1258extern EFI_GUID gEfiPlatformMemoryErrorSectionGuid;
Lawrence Tanga0865e32022-07-06 11:59:52 +01001259extern EFI_GUID gEfiPlatformMemoryError2SectionGuid;
Lawrence Tang1b0b00e2022-07-05 10:33:10 +01001260extern EFI_GUID gEfiPcieErrorSectionGuid;
1261extern EFI_GUID gEfiFirmwareErrorSectionGuid;
1262extern EFI_GUID gEfiPciBusErrorSectionGuid;
1263extern EFI_GUID gEfiPciDevErrorSectionGuid;
1264extern EFI_GUID gEfiDMArGenericErrorSectionGuid;
1265extern EFI_GUID gEfiDirectedIoDMArErrorSectionGuid;
1266extern EFI_GUID gEfiIommuDMArErrorSectionGuid;
Lawrence Tang864c0da2022-07-06 15:55:40 +01001267extern EFI_GUID gEfiCcixPerLogErrorSectionGuid;
Lawrence Tangb98ec662022-07-06 16:50:21 +01001268extern EFI_GUID gEfiCxlProtocolErrorSectionGuid;
Lawrence Tangd7e8ca32022-07-07 10:25:53 +01001269extern EFI_GUID gEfiCxlGeneralMediaErrorSectionGuid;
1270extern EFI_GUID gEfiCxlDramEventErrorSectionGuid;
1271extern EFI_GUID gEfiCxlMemoryModuleErrorSectionGuid;
1272extern EFI_GUID gEfiCxlPhysicalSwitchErrorSectionGuid;
1273extern EFI_GUID gEfiCxlVirtualSwitchErrorSectionGuid;
1274extern EFI_GUID gEfiCxlMldPortErrorSectionGuid;
Lawrence Tang1b0b00e2022-07-05 10:33:10 +01001275#pragma pack()
1276
1277#if defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
1278///
1279/// IA32 and x64 Specific definitions.
1280///
1281
1282extern EFI_GUID gEfiIa32X64ErrorTypeCacheCheckGuid;
1283extern EFI_GUID gEfiIa32X64ErrorTypeTlbCheckGuid;
1284extern EFI_GUID gEfiIa32X64ErrorTypeBusCheckGuid;
1285extern EFI_GUID gEfiIa32X64ErrorTypeMsCheckGuid;
1286
1287#endif
1288
1289#endif