11b0b00e3SLawrence Tang /** 22800cd8eSLawrence Tang * Describes high level functions for converting an entire CPER log, and functions for parsing 32800cd8eSLawrence Tang * CPER headers and section descriptions into an intermediate JSON format. 41b0b00e3SLawrence Tang * 51b0b00e3SLawrence Tang * Author: Lawrence.Tang@arm.com 61b0b00e3SLawrence Tang **/ 71b0b00e3SLawrence Tang 81b0b00e3SLawrence Tang #include <stdio.h> 91b0b00e3SLawrence Tang #include "json.h" 10*d7e8ca34SLawrence Tang #include "b64.h" 111b0b00e3SLawrence Tang #include "edk/Cper.h" 121b0b00e3SLawrence Tang #include "cper-parse.h" 131b0b00e3SLawrence Tang #include "cper-utils.h" 141b0b00e3SLawrence Tang #include "sections/cper-section-generic.h" 15794312c8SLawrence Tang #include "sections/cper-section-ia32x64.h" 162800cd8eSLawrence Tang #include "sections/cper-section-arm.h" 17a0865e38SLawrence Tang #include "sections/cper-section-memory.h" 184dbe3d72SLawrence Tang #include "sections/cper-section-pcie.h" 19214a1542SLawrence Tang #include "sections/cper-section-pci-bus.h" 20a416ec93SLawrence Tang #include "sections/cper-section-pci-dev.h" 21c60a243eSLawrence Tang #include "sections/cper-section-firmware.h" 224795d4aeSLawrence Tang #include "sections/cper-section-dmar-generic.h" 23db1b7ce2SLawrence Tang #include "sections/cper-section-dmar-vtd.h" 24db1b7ce2SLawrence Tang #include "sections/cper-section-dmar-iommu.h" 25864c0da9SLawrence Tang #include "sections/cper-section-ccix-per.h" 26b98ec66cSLawrence Tang #include "sections/cper-section-cxl-protocol.h" 27cc0f5f38SLawrence Tang #include "sections/cper-section-ipf.h" 28*d7e8ca34SLawrence Tang #include "sections/cper-section-cxl-component.h" 291b0b00e3SLawrence Tang 301b0b00e3SLawrence Tang //Private pre-definitions. 311b0b00e3SLawrence Tang json_object* cper_header_to_ir(EFI_COMMON_ERROR_RECORD_HEADER* header); 321b0b00e3SLawrence Tang json_object* cper_section_descriptor_to_ir(EFI_ERROR_SECTION_DESCRIPTOR* section_descriptor); 331b0b00e3SLawrence Tang json_object* cper_section_to_ir(FILE* handle, EFI_ERROR_SECTION_DESCRIPTOR* descriptor); 341b0b00e3SLawrence Tang 351b0b00e3SLawrence Tang //Reads a CPER log file at the given file location, and returns an intermediate 361b0b00e3SLawrence Tang //JSON representation of this CPER record. 371b0b00e3SLawrence Tang json_object* cper_to_ir(const char* filename) 381b0b00e3SLawrence Tang { 391b0b00e3SLawrence Tang //Get a handle for the log file. 401b0b00e3SLawrence Tang FILE* cper_file = fopen(filename, "r"); 411b0b00e3SLawrence Tang if (cper_file == NULL) { 421b0b00e3SLawrence Tang printf("Could not open CPER record, file handle returned null."); 431b0b00e3SLawrence Tang return NULL; 441b0b00e3SLawrence Tang } 451b0b00e3SLawrence Tang 461b0b00e3SLawrence Tang //Ensure this is really a CPER log. 471b0b00e3SLawrence Tang EFI_COMMON_ERROR_RECORD_HEADER header; 481b0b00e3SLawrence Tang fseek(cper_file, 0, SEEK_SET); 491b0b00e3SLawrence Tang if (fread(&header, sizeof(EFI_COMMON_ERROR_RECORD_HEADER), 1, cper_file) != 1) 501b0b00e3SLawrence Tang { 511b0b00e3SLawrence Tang printf("Invalid CPER file: Invalid length (log too short)."); 521b0b00e3SLawrence Tang return NULL; 531b0b00e3SLawrence Tang } 541b0b00e3SLawrence Tang 551b0b00e3SLawrence Tang //Check if the header contains the magic bytes ("CPER"). 561b0b00e3SLawrence Tang if (header.SignatureStart != EFI_ERROR_RECORD_SIGNATURE_START) { 571b0b00e3SLawrence Tang printf("Invalid CPER file: Invalid header (incorrect signature)."); 581b0b00e3SLawrence Tang return NULL; 591b0b00e3SLawrence Tang } 601b0b00e3SLawrence Tang 611b0b00e3SLawrence Tang // //Print struct contents (debug). 621b0b00e3SLawrence Tang // fpos_t file_pos; 631b0b00e3SLawrence Tang // fgetpos(cper_file, &file_pos); 641b0b00e3SLawrence Tang // printf("Stream is at position %d.\n", file_pos); 651b0b00e3SLawrence Tang // printf("SignatureStart: %s\n", (char*)&header.SignatureStart); 661b0b00e3SLawrence Tang // printf("Revision: %u\n", header.Revision); 671b0b00e3SLawrence Tang // printf("SectionCount: %u\n", header.SectionCount); 681b0b00e3SLawrence Tang // printf("Severity: %d\n", header.ErrorSeverity); 691b0b00e3SLawrence Tang // printf("RecordLength: %d\n", header.RecordLength); 701b0b00e3SLawrence Tang 711b0b00e3SLawrence Tang //Create the header JSON object from the read bytes. 721b0b00e3SLawrence Tang json_object* header_ir = cper_header_to_ir(&header); 731b0b00e3SLawrence Tang 741b0b00e3SLawrence Tang //Read the appropriate number of section descriptors & sections, and convert them into IR format. 751b0b00e3SLawrence Tang json_object* section_descriptors_ir = json_object_new_array(); 761b0b00e3SLawrence Tang json_object* sections_ir = json_object_new_array(); 771b0b00e3SLawrence Tang for (int i=0; i<header.SectionCount; i++) 781b0b00e3SLawrence Tang { 791b0b00e3SLawrence Tang //Create the section descriptor. 801b0b00e3SLawrence Tang EFI_ERROR_SECTION_DESCRIPTOR section_descriptor; 811b0b00e3SLawrence Tang if (fread(§ion_descriptor, sizeof(EFI_ERROR_SECTION_DESCRIPTOR), 1, cper_file) != 1) 821b0b00e3SLawrence Tang { 831b0b00e3SLawrence Tang printf("Invalid number of section headers: Header states %d sections, could not read section %d.", header.SectionCount, i+1); 841b0b00e3SLawrence Tang return NULL; 851b0b00e3SLawrence Tang } 861b0b00e3SLawrence Tang json_object_array_add(section_descriptors_ir, cper_section_descriptor_to_ir(§ion_descriptor)); 871b0b00e3SLawrence Tang 881b0b00e3SLawrence Tang //Read the section itself. 891b0b00e3SLawrence Tang json_object_array_add(sections_ir, cper_section_to_ir(cper_file, §ion_descriptor)); 901b0b00e3SLawrence Tang } 911b0b00e3SLawrence Tang 921b0b00e3SLawrence Tang //Add the header, section descriptors, and sections to a parent object. 931b0b00e3SLawrence Tang json_object* parent = json_object_new_object(); 941b0b00e3SLawrence Tang json_object_object_add(parent, "header", header_ir); 951b0b00e3SLawrence Tang json_object_object_add(parent, "sectionDescriptors", section_descriptors_ir); 962800cd8eSLawrence Tang json_object_object_add(parent, "sections", sections_ir); 971b0b00e3SLawrence Tang 981b0b00e3SLawrence Tang //... 991b0b00e3SLawrence Tang return parent; 1001b0b00e3SLawrence Tang } 1011b0b00e3SLawrence Tang 1021b0b00e3SLawrence Tang //Converts a parsed CPER record header into intermediate JSON object format. 1031b0b00e3SLawrence Tang json_object* cper_header_to_ir(EFI_COMMON_ERROR_RECORD_HEADER* header) 1041b0b00e3SLawrence Tang { 1051b0b00e3SLawrence Tang json_object* header_ir = json_object_new_object(); 1061b0b00e3SLawrence Tang 1071b0b00e3SLawrence Tang //Revision/version information. 1081b0b00e3SLawrence Tang json_object_object_add(header_ir, "revision", revision_to_ir(header->Revision)); 1091b0b00e3SLawrence Tang 1101b0b00e3SLawrence Tang //Section count. 1111b0b00e3SLawrence Tang json_object_object_add(header_ir, "sectionCount", json_object_new_int(header->SectionCount)); 1121b0b00e3SLawrence Tang 1131b0b00e3SLawrence Tang //Error severity (with interpreted string version). 1141b0b00e3SLawrence Tang json_object* error_severity = json_object_new_object(); 1151b0b00e3SLawrence Tang json_object_object_add(error_severity, "code", json_object_new_int(header->ErrorSeverity)); 1161b0b00e3SLawrence Tang json_object_object_add(error_severity, "name", json_object_new_string(severity_to_string(header->ErrorSeverity))); 1171b0b00e3SLawrence Tang json_object_object_add(header_ir, "severity", error_severity); 1181b0b00e3SLawrence Tang 1191b0b00e3SLawrence Tang //The validation bits for each section. 1202800cd8eSLawrence Tang json_object* validation_bits = bitfield_to_ir(header->ValidationBits, 3, CPER_HEADER_VALID_BITFIELD_NAMES); 1211b0b00e3SLawrence Tang json_object_object_add(header_ir, "validationBits", validation_bits); 1221b0b00e3SLawrence Tang 1231b0b00e3SLawrence Tang //Total length of the record (including headers) in bytes. 1241b0b00e3SLawrence Tang json_object_object_add(header_ir, "recordLength", json_object_new_int(header->RecordLength)); 1251b0b00e3SLawrence Tang 1261b0b00e3SLawrence Tang //If a timestamp exists according to validation bits, then add it. 1271b0b00e3SLawrence Tang if (header->ValidationBits & 0b10) 1281b0b00e3SLawrence Tang { 1291b0b00e3SLawrence Tang char timestamp_string[TIMESTAMP_LENGTH]; 1301b0b00e3SLawrence Tang sprintf(timestamp_string, "%02d%02d-%02d-%02dT%02d:%02d:%02d.000", 1311b0b00e3SLawrence Tang header->TimeStamp.Century, 1321b0b00e3SLawrence Tang header->TimeStamp.Year, 1331b0b00e3SLawrence Tang header->TimeStamp.Month, 1341b0b00e3SLawrence Tang header->TimeStamp.Day, 1351b0b00e3SLawrence Tang header->TimeStamp.Hours, 1361b0b00e3SLawrence Tang header->TimeStamp.Minutes, 1371b0b00e3SLawrence Tang header->TimeStamp.Seconds); 1381b0b00e3SLawrence Tang 1391b0b00e3SLawrence Tang json_object_object_add(header_ir, "timestamp", json_object_new_string(timestamp_string)); 1401b0b00e3SLawrence Tang json_object_object_add(header_ir, "timestampIsPrecise", json_object_new_boolean(header->TimeStamp.Flag)); 1411b0b00e3SLawrence Tang } 1421b0b00e3SLawrence Tang 1431b0b00e3SLawrence Tang //If a platform ID exists according to the validation bits, then add it. 1441b0b00e3SLawrence Tang if (header->ValidationBits & 0b1) 1451b0b00e3SLawrence Tang { 1461b0b00e3SLawrence Tang char platform_string[GUID_STRING_LENGTH]; 1471b0b00e3SLawrence Tang guid_to_string(platform_string, &header->PlatformID); 1481b0b00e3SLawrence Tang json_object_object_add(header_ir, "platformID", json_object_new_string(platform_string)); 1491b0b00e3SLawrence Tang } 1501b0b00e3SLawrence Tang 1511b0b00e3SLawrence Tang //If a partition ID exists according to the validation bits, then add it. 1521b0b00e3SLawrence Tang if (header->ValidationBits & 0b100) 1531b0b00e3SLawrence Tang { 1541b0b00e3SLawrence Tang char partition_string[GUID_STRING_LENGTH]; 1551b0b00e3SLawrence Tang guid_to_string(partition_string, &header->PartitionID); 1561b0b00e3SLawrence Tang json_object_object_add(header_ir, "partitionID", json_object_new_string(partition_string)); 1571b0b00e3SLawrence Tang } 1581b0b00e3SLawrence Tang 1591b0b00e3SLawrence Tang //Creator ID of the header. 1601b0b00e3SLawrence Tang char creator_string[GUID_STRING_LENGTH]; 1611b0b00e3SLawrence Tang guid_to_string(creator_string, &header->CreatorID); 1621b0b00e3SLawrence Tang json_object_object_add(header_ir, "creatorID", json_object_new_string(creator_string)); 1631b0b00e3SLawrence Tang 1641b0b00e3SLawrence Tang //Notification type for the header. Some defined types are available. 1651b0b00e3SLawrence Tang json_object* notification_type = json_object_new_object(); 1661b0b00e3SLawrence Tang char notification_type_string[GUID_STRING_LENGTH]; 1671b0b00e3SLawrence Tang guid_to_string(notification_type_string, &header->NotificationType); 1681b0b00e3SLawrence Tang json_object_object_add(notification_type, "guid", json_object_new_string(notification_type_string)); 1691b0b00e3SLawrence Tang 1701b0b00e3SLawrence Tang //Add the human readable notification type if possible. 1711b0b00e3SLawrence Tang char* notification_type_readable = "Unknown"; 1721b0b00e3SLawrence Tang if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeCmcGuid)) 1731b0b00e3SLawrence Tang notification_type_readable = "CMC"; 174794312c8SLawrence Tang else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeCpeGuid)) 1751b0b00e3SLawrence Tang notification_type_readable = "CPE"; 176794312c8SLawrence Tang else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeMceGuid)) 1771b0b00e3SLawrence Tang notification_type_readable = "MCE"; 178794312c8SLawrence Tang else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypePcieGuid)) 1791b0b00e3SLawrence Tang notification_type_readable = "PCIe"; 180794312c8SLawrence Tang else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeInitGuid)) 1811b0b00e3SLawrence Tang notification_type_readable = "INIT"; 182794312c8SLawrence Tang else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeNmiGuid)) 1831b0b00e3SLawrence Tang notification_type_readable = "NMI"; 184794312c8SLawrence Tang else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeBootGuid)) 1851b0b00e3SLawrence Tang notification_type_readable = "Boot"; 186794312c8SLawrence Tang else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeDmarGuid)) 1871b0b00e3SLawrence Tang notification_type_readable = "DMAr"; 188794312c8SLawrence Tang else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeSeaGuid)) 1891b0b00e3SLawrence Tang notification_type_readable = "SEA"; 190794312c8SLawrence Tang else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeSeiGuid)) 1911b0b00e3SLawrence Tang notification_type_readable = "SEI"; 192794312c8SLawrence Tang else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypePeiGuid)) 1931b0b00e3SLawrence Tang notification_type_readable = "PEI"; 194794312c8SLawrence Tang else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeCxlGuid)) 1951b0b00e3SLawrence Tang notification_type_readable = "CXL Component"; 1961b0b00e3SLawrence Tang json_object_object_add(notification_type, "type", json_object_new_string(notification_type_readable)); 1971b0b00e3SLawrence Tang json_object_object_add(header_ir, "notificationType", notification_type); 1981b0b00e3SLawrence Tang 1991b0b00e3SLawrence Tang //The record ID for this record, unique on a given system. 2001b0b00e3SLawrence Tang json_object_object_add(header_ir, "recordID", json_object_new_uint64(header->RecordID)); 2011b0b00e3SLawrence Tang 2021b0b00e3SLawrence Tang //Flag for the record, and a human readable form. 2033c43f743SLawrence Tang json_object* flags = integer_to_readable_pair(header->Flags, 2043c43f743SLawrence Tang sizeof(CPER_HEADER_FLAG_TYPES_KEYS) / sizeof(int), 2053c43f743SLawrence Tang CPER_HEADER_FLAG_TYPES_KEYS, 2063c43f743SLawrence Tang CPER_HEADER_FLAG_TYPES_VALUES, 2073c43f743SLawrence Tang "Unknown"); 2081b0b00e3SLawrence Tang json_object_object_add(header_ir, "flags", flags); 2091b0b00e3SLawrence Tang 2101b0b00e3SLawrence Tang //Persistence information. Outside the scope of specification, so just a uint32 here. 2111b0b00e3SLawrence Tang json_object_object_add(header_ir, "persistenceInformation", json_object_new_uint64(header->PersistenceInfo)); 2121b0b00e3SLawrence Tang return header_ir; 2131b0b00e3SLawrence Tang } 2141b0b00e3SLawrence Tang 2151b0b00e3SLawrence Tang //Converts the given EFI section descriptor into JSON IR format. 2161b0b00e3SLawrence Tang json_object* cper_section_descriptor_to_ir(EFI_ERROR_SECTION_DESCRIPTOR* section_descriptor) 2171b0b00e3SLawrence Tang { 2181b0b00e3SLawrence Tang json_object* section_descriptor_ir = json_object_new_object(); 2191b0b00e3SLawrence Tang 2201b0b00e3SLawrence Tang //The offset of the section from the base of the record header, length. 2211b0b00e3SLawrence Tang json_object_object_add(section_descriptor_ir, "sectionOffset", json_object_new_int(section_descriptor->SectionOffset)); 2221b0b00e3SLawrence Tang json_object_object_add(section_descriptor_ir, "sectionLength", json_object_new_int(section_descriptor->SectionLength)); 2231b0b00e3SLawrence Tang 2241b0b00e3SLawrence Tang //Revision. 2251b0b00e3SLawrence Tang json_object_object_add(section_descriptor_ir, "revision", revision_to_ir(section_descriptor->Revision)); 2261b0b00e3SLawrence Tang 2271b0b00e3SLawrence Tang //Validation bits. 2281b0b00e3SLawrence Tang json_object* validation_bits = json_object_new_object(); 2291b0b00e3SLawrence Tang json_object_object_add(validation_bits, "fruID", json_object_new_boolean(section_descriptor->SecValidMask & 0b1)); 2301b0b00e3SLawrence Tang json_object_object_add(validation_bits, "fruString", json_object_new_boolean((section_descriptor->SecValidMask & 0b10) >> 1)); 2311b0b00e3SLawrence Tang json_object_object_add(section_descriptor_ir, "validationBits", validation_bits); 2321b0b00e3SLawrence Tang 2331b0b00e3SLawrence Tang //Flag bits. 2342800cd8eSLawrence Tang json_object* flags = bitfield_to_ir(section_descriptor->SectionFlags, 8, CPER_SECTION_DESCRIPTOR_FLAGS_BITFIELD_NAMES); 2351b0b00e3SLawrence Tang json_object_object_add(section_descriptor_ir, "flags", flags); 2361b0b00e3SLawrence Tang 2371b0b00e3SLawrence Tang //Section type (GUID). 2381b0b00e3SLawrence Tang json_object* section_type = json_object_new_object(); 2391b0b00e3SLawrence Tang char section_type_string[GUID_STRING_LENGTH]; 2401b0b00e3SLawrence Tang guid_to_string(section_type_string, §ion_descriptor->SectionType); 2411b0b00e3SLawrence Tang json_object_object_add(section_type, "data", json_object_new_string(section_type_string)); 2421b0b00e3SLawrence Tang 2431b0b00e3SLawrence Tang //Readable section type, if possible. 2441b0b00e3SLawrence Tang char* section_type_readable = "Unknown"; 2451b0b00e3SLawrence Tang if (guid_equal(§ion_descriptor->SectionType, &gEfiProcessorGenericErrorSectionGuid)) 2461b0b00e3SLawrence Tang section_type_readable = "Processor Generic"; 247864c0da9SLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiIa32X64ProcessorErrorSectionGuid)) 2481b0b00e3SLawrence Tang section_type_readable = "IA32/X64"; 249cc0f5f38SLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiIpfProcessorErrorSectionGuid)) 250cc0f5f38SLawrence Tang section_type_readable = "IPF"; 251864c0da9SLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiArmProcessorErrorSectionGuid)) 2521b0b00e3SLawrence Tang section_type_readable = "ARM"; 253864c0da9SLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiPlatformMemoryErrorSectionGuid)) 2541b0b00e3SLawrence Tang section_type_readable = "Platform Memory"; 255864c0da9SLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiPcieErrorSectionGuid)) 2561b0b00e3SLawrence Tang section_type_readable = "PCIe"; 257864c0da9SLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiFirmwareErrorSectionGuid)) 2581b0b00e3SLawrence Tang section_type_readable = "Firmware Error Record Reference"; 259864c0da9SLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiPciBusErrorSectionGuid)) 2601b0b00e3SLawrence Tang section_type_readable = "PCI/PCI-X Bus"; 261864c0da9SLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiPciDevErrorSectionGuid)) 2621b0b00e3SLawrence Tang section_type_readable = "PCI Component/Device"; 263864c0da9SLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiDMArGenericErrorSectionGuid)) 2641b0b00e3SLawrence Tang section_type_readable = "DMAr Generic"; 265864c0da9SLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiDirectedIoDMArErrorSectionGuid)) 2661b0b00e3SLawrence Tang section_type_readable = "Intel VT for Directed I/O specific DMAr section"; 267864c0da9SLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiIommuDMArErrorSectionGuid)) 2681b0b00e3SLawrence Tang section_type_readable = "IOMMU specific DMAr section"; 269864c0da9SLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiCcixPerLogErrorSectionGuid)) 270864c0da9SLawrence Tang section_type_readable = "CCIX PER Log Error"; 271b98ec66cSLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiCxlProtocolErrorSectionGuid)) 272b98ec66cSLawrence Tang section_type_readable = "CXL Protocol Error"; 273*d7e8ca34SLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiCxlGeneralMediaErrorSectionGuid)) 274*d7e8ca34SLawrence Tang section_type_readable = "CXL General Media Component Error"; 275*d7e8ca34SLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiCxlDramEventErrorSectionGuid)) 276*d7e8ca34SLawrence Tang section_type_readable = "CXL DRAM Component Error"; 277*d7e8ca34SLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiCxlPhysicalSwitchErrorSectionGuid)) 278*d7e8ca34SLawrence Tang section_type_readable = "CXL Physical Switch Component Error"; 279*d7e8ca34SLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiCxlVirtualSwitchErrorSectionGuid)) 280*d7e8ca34SLawrence Tang section_type_readable = "CXL Virtual Switch Component Error"; 281*d7e8ca34SLawrence Tang else if (guid_equal(§ion_descriptor->SectionType, &gEfiCxlMldPortErrorSectionGuid)) 282*d7e8ca34SLawrence Tang section_type_readable = "CXL MLD Port Component Error"; 2831b0b00e3SLawrence Tang 2841b0b00e3SLawrence Tang //todo: How do you determine if this is a CXL component event? 285b98ec66cSLawrence Tang //perhaps refer to CXL Specification, Rev 2.0 2861b0b00e3SLawrence Tang // if (guid_equal(§ion_descriptor->SectionType, &gEfiProcessorGenericErrorSectionGuid)) 2871b0b00e3SLawrence Tang // section_type_readable = "CXL Component Event"; 2881b0b00e3SLawrence Tang 2891b0b00e3SLawrence Tang json_object_object_add(section_type, "type", json_object_new_string(section_type_readable)); 2901b0b00e3SLawrence Tang json_object_object_add(section_descriptor_ir, "sectionType", section_type); 2911b0b00e3SLawrence Tang 2921b0b00e3SLawrence Tang //If validation bits indicate it exists, add FRU ID. 2931b0b00e3SLawrence Tang if (section_descriptor->SecValidMask & 0b1) 2941b0b00e3SLawrence Tang { 2951b0b00e3SLawrence Tang char fru_id_string[GUID_STRING_LENGTH]; 2961b0b00e3SLawrence Tang guid_to_string(fru_id_string, §ion_descriptor->FruId); 2971b0b00e3SLawrence Tang json_object_object_add(section_descriptor_ir, "fruID", json_object_new_string(fru_id_string)); 2981b0b00e3SLawrence Tang } 2991b0b00e3SLawrence Tang 3001b0b00e3SLawrence Tang //If validation bits indicate it exists, add FRU text. 3011b0b00e3SLawrence Tang if ((section_descriptor->SecValidMask & 0b10) >> 1) 3021b0b00e3SLawrence Tang json_object_object_add(section_descriptor_ir, "fruText", json_object_new_string(section_descriptor->FruString)); 3031b0b00e3SLawrence Tang 3041b0b00e3SLawrence Tang //Section severity. 3051b0b00e3SLawrence Tang json_object* section_severity = json_object_new_object(); 3061b0b00e3SLawrence Tang json_object_object_add(section_severity, "code", json_object_new_int(section_descriptor->Severity)); 3071b0b00e3SLawrence Tang json_object_object_add(section_severity, "name", json_object_new_string(severity_to_string(section_descriptor->Severity))); 3081b0b00e3SLawrence Tang json_object_object_add(section_descriptor_ir, "severity", section_severity); 3091b0b00e3SLawrence Tang 3101b0b00e3SLawrence Tang return section_descriptor_ir; 3111b0b00e3SLawrence Tang } 3121b0b00e3SLawrence Tang 3131b0b00e3SLawrence Tang 3141b0b00e3SLawrence Tang //Converts the section described by a single given section descriptor. 3151b0b00e3SLawrence Tang json_object* cper_section_to_ir(FILE* handle, EFI_ERROR_SECTION_DESCRIPTOR* descriptor) 3161b0b00e3SLawrence Tang { 3171b0b00e3SLawrence Tang //Read section as described by the section descriptor. 3181b0b00e3SLawrence Tang fseek(handle, descriptor->SectionOffset, SEEK_SET); 319e18aaee9SLawrence Tang void* section = malloc(descriptor->SectionLength); 3201b0b00e3SLawrence Tang if (fread(section, descriptor->SectionLength, 1, handle) != 1) 3211b0b00e3SLawrence Tang { 3221b0b00e3SLawrence Tang printf("Section read failed: Could not read %d bytes from global offset %d.", 3231b0b00e3SLawrence Tang descriptor->SectionLength, 3241b0b00e3SLawrence Tang descriptor->SectionOffset); 325e18aaee9SLawrence Tang free(section); 326e18aaee9SLawrence Tang return NULL; 3271b0b00e3SLawrence Tang } 3281b0b00e3SLawrence Tang 329db1b7ce2SLawrence Tang //Parse section to IR based on GUID. 3301b0b00e3SLawrence Tang json_object* result = NULL; 3311b0b00e3SLawrence Tang if (guid_equal(&descriptor->SectionType, &gEfiProcessorGenericErrorSectionGuid)) 3322800cd8eSLawrence Tang result = cper_section_generic_to_ir(section, descriptor); 3332800cd8eSLawrence Tang else if (guid_equal(&descriptor->SectionType, &gEfiIa32X64ProcessorErrorSectionGuid)) 3342800cd8eSLawrence Tang result = cper_section_ia32x64_to_ir(section, descriptor); 335cc0f5f38SLawrence Tang else if (guid_equal(&descriptor->SectionType, &gEfiIpfProcessorErrorSectionGuid)) 336cc0f5f38SLawrence Tang result = cper_section_ipf_to_ir(section, descriptor); 3372800cd8eSLawrence Tang else if (guid_equal(&descriptor->SectionType, &gEfiArmProcessorErrorSectionGuid)) 3382800cd8eSLawrence Tang result = cper_section_arm_to_ir(section, descriptor); 339a0865e38SLawrence Tang else if (guid_equal(&descriptor->SectionType, &gEfiPlatformMemoryErrorSectionGuid)) 340a0865e38SLawrence Tang result = cper_section_platform_memory_to_ir(section, descriptor); 34154da4414SLawrence Tang else if (guid_equal(&descriptor->SectionType, &gEfiPlatformMemoryError2SectionGuid)) 34254da4414SLawrence Tang result = cper_section_platform_memory2_to_ir(section, descriptor); 3434dbe3d72SLawrence Tang else if (guid_equal(&descriptor->SectionType, &gEfiPcieErrorSectionGuid)) 3444dbe3d72SLawrence Tang result = cper_section_pcie_to_ir(section, descriptor); 345c60a243eSLawrence Tang else if (guid_equal(&descriptor->SectionType, &gEfiFirmwareErrorSectionGuid)) 346c60a243eSLawrence Tang result = cper_section_firmware_to_ir(section, descriptor); 347214a1542SLawrence Tang else if (guid_equal(&descriptor->SectionType, &gEfiPciBusErrorSectionGuid)) 348214a1542SLawrence Tang result = cper_section_pci_bus_to_ir(section, descriptor); 349a416ec93SLawrence Tang else if (guid_equal(&descriptor->SectionType, &gEfiPciDevErrorSectionGuid)) 350a416ec93SLawrence Tang result = cper_section_pci_dev_to_ir(section, descriptor); 3514795d4aeSLawrence Tang else if (guid_equal(&descriptor->SectionType, &gEfiDMArGenericErrorSectionGuid)) 3524795d4aeSLawrence Tang result = cper_section_dmar_generic_to_ir(section, descriptor); 353db1b7ce2SLawrence Tang else if (guid_equal(&descriptor->SectionType, &gEfiDirectedIoDMArErrorSectionGuid)) 354db1b7ce2SLawrence Tang result = cper_section_dmar_vtd_to_ir(section, descriptor); 355db1b7ce2SLawrence Tang else if (guid_equal(&descriptor->SectionType, &gEfiIommuDMArErrorSectionGuid)) 356db1b7ce2SLawrence Tang result = cper_section_dmar_iommu_to_ir(section, descriptor); 357864c0da9SLawrence Tang else if (guid_equal(&descriptor->SectionType, &gEfiCcixPerLogErrorSectionGuid)) 358864c0da9SLawrence Tang result = cper_section_ccix_per_to_ir(section, descriptor); 359b98ec66cSLawrence Tang else if (guid_equal(&descriptor->SectionType, &gEfiCxlProtocolErrorSectionGuid)) 360b98ec66cSLawrence Tang result = cper_section_cxl_protocol_to_ir(section, descriptor); 361*d7e8ca34SLawrence Tang else if (guid_equal(&descriptor->SectionType, &gEfiCxlGeneralMediaErrorSectionGuid) 362*d7e8ca34SLawrence Tang || guid_equal(&descriptor->SectionType, &gEfiCxlDramEventErrorSectionGuid) 363*d7e8ca34SLawrence Tang || guid_equal(&descriptor->SectionType, &gEfiCxlPhysicalSwitchErrorSectionGuid) 364*d7e8ca34SLawrence Tang || guid_equal(&descriptor->SectionType, &gEfiCxlVirtualSwitchErrorSectionGuid) 365*d7e8ca34SLawrence Tang || guid_equal(&descriptor->SectionType, &gEfiCxlMldPortErrorSectionGuid)) 366*d7e8ca34SLawrence Tang { 367*d7e8ca34SLawrence Tang result = cper_section_cxl_component_to_ir(section, descriptor); 368*d7e8ca34SLawrence Tang } 369db1b7ce2SLawrence Tang else 370db1b7ce2SLawrence Tang { 371db1b7ce2SLawrence Tang //Failed read, unknown GUID. 372*d7e8ca34SLawrence Tang //Output the data as formatted base64. 373*d7e8ca34SLawrence Tang result = json_object_new_object(); 374*d7e8ca34SLawrence Tang char* encoded = b64_encode((unsigned char*)section, descriptor->SectionLength); 375*d7e8ca34SLawrence Tang json_object_object_add(result, "data", json_object_new_string(encoded)); 376*d7e8ca34SLawrence Tang free(encoded); 377db1b7ce2SLawrence Tang } 3781b0b00e3SLawrence Tang 3791b0b00e3SLawrence Tang //Free section memory, return result. 3801b0b00e3SLawrence Tang free(section); 3811b0b00e3SLawrence Tang return result; 3821b0b00e3SLawrence Tang }