MdePkg/Include/Guid/Cper.h

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