MdePkg/Include/Guid/Cper.h

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