14dbe3d72SLawrence Tang /** 24dbe3d72SLawrence Tang * Describes functions for converting PCIe CPER sections from binary and JSON format 34dbe3d72SLawrence Tang * into an intermediate format. 44dbe3d72SLawrence Tang * 54dbe3d72SLawrence Tang * Author: Lawrence.Tang@arm.com 64dbe3d72SLawrence Tang **/ 74dbe3d72SLawrence Tang #include <stdio.h> 8*3b7f45b5SLawrence Tang #include <string.h> 94dbe3d72SLawrence Tang #include "json.h" 106c461e90SLawrence Tang #include "b64.h" 114dbe3d72SLawrence Tang #include "../edk/Cper.h" 124dbe3d72SLawrence Tang #include "../cper-utils.h" 134dbe3d72SLawrence Tang #include "cper-section-pcie.h" 144dbe3d72SLawrence Tang 154dbe3d72SLawrence Tang //Converts a single PCIe CPER section into JSON IR. 164dbe3d72SLawrence Tang json_object* cper_section_pcie_to_ir(void* section, EFI_ERROR_SECTION_DESCRIPTOR* descriptor) 174dbe3d72SLawrence Tang { 184dbe3d72SLawrence Tang EFI_PCIE_ERROR_DATA* pcie_error = (EFI_PCIE_ERROR_DATA*)section; 194dbe3d72SLawrence Tang json_object* section_ir = json_object_new_object(); 204dbe3d72SLawrence Tang 214dbe3d72SLawrence Tang //Validation bits. 224dbe3d72SLawrence Tang json_object* validation = bitfield_to_ir(pcie_error->ValidFields, 8, PCIE_ERROR_VALID_BITFIELD_NAMES); 234dbe3d72SLawrence Tang json_object_object_add(section_ir, "validationBits", validation); 244dbe3d72SLawrence Tang 254dbe3d72SLawrence Tang //Port type. 264dbe3d72SLawrence Tang json_object* port_type = integer_to_readable_pair(pcie_error->PortType, 9, 274dbe3d72SLawrence Tang PCIE_ERROR_PORT_TYPES_KEYS, 284dbe3d72SLawrence Tang PCIE_ERROR_PORT_TYPES_VALUES, 294dbe3d72SLawrence Tang "Unknown"); 304dbe3d72SLawrence Tang json_object_object_add(section_ir, "portType", port_type); 314dbe3d72SLawrence Tang 324dbe3d72SLawrence Tang //Version, provided each half in BCD. 334dbe3d72SLawrence Tang json_object* version = json_object_new_object(); 344dbe3d72SLawrence Tang json_object_object_add(version, "minor", json_object_new_int(bcd_to_int(pcie_error->Version & 0xFF))); 354dbe3d72SLawrence Tang json_object_object_add(version, "major", json_object_new_int(bcd_to_int(pcie_error->Version >> 8))); 364dbe3d72SLawrence Tang json_object_object_add(section_ir, "version", version); 374dbe3d72SLawrence Tang 384dbe3d72SLawrence Tang //Command & status. 394dbe3d72SLawrence Tang json_object* command_status = json_object_new_object(); 404dbe3d72SLawrence Tang json_object_object_add(command_status, "commandRegister", json_object_new_uint64(pcie_error->CommandStatus & 0xFFFF)); 414dbe3d72SLawrence Tang json_object_object_add(command_status, "statusRegister", json_object_new_uint64(pcie_error->CommandStatus >> 16)); 424dbe3d72SLawrence Tang json_object_object_add(section_ir, "commandStatus", command_status); 434dbe3d72SLawrence Tang 444dbe3d72SLawrence Tang //PCIe Device ID. 454dbe3d72SLawrence Tang json_object* device_id = json_object_new_object(); 46db1b7ce2SLawrence Tang UINT64 class_id = (pcie_error->DevBridge.ClassCode[0] << 16) + 474dbe3d72SLawrence Tang (pcie_error->DevBridge.ClassCode[1] << 8) + 48db1b7ce2SLawrence Tang pcie_error->DevBridge.ClassCode[2]; 494dbe3d72SLawrence Tang json_object_object_add(device_id, "vendorID", json_object_new_uint64(pcie_error->DevBridge.VendorId)); 504dbe3d72SLawrence Tang json_object_object_add(device_id, "deviceID", json_object_new_uint64(pcie_error->DevBridge.DeviceId)); 514dbe3d72SLawrence Tang json_object_object_add(device_id, "classCode", json_object_new_uint64(class_id)); 524dbe3d72SLawrence Tang json_object_object_add(device_id, "functionNumber", json_object_new_uint64(pcie_error->DevBridge.Function)); 534dbe3d72SLawrence Tang json_object_object_add(device_id, "deviceNumber", json_object_new_uint64(pcie_error->DevBridge.Device)); 544dbe3d72SLawrence Tang json_object_object_add(device_id, "segmentNumber", json_object_new_uint64(pcie_error->DevBridge.Segment)); 554dbe3d72SLawrence Tang json_object_object_add(device_id, "primaryOrDeviceBusNumber", json_object_new_uint64(pcie_error->DevBridge.PrimaryOrDeviceBus)); 564dbe3d72SLawrence Tang json_object_object_add(device_id, "secondaryBusNumber", json_object_new_uint64(pcie_error->DevBridge.SecondaryBus)); 574dbe3d72SLawrence Tang json_object_object_add(device_id, "slotNumber", json_object_new_uint64(pcie_error->DevBridge.Slot.Number)); 584dbe3d72SLawrence Tang json_object_object_add(section_ir, "deviceID", device_id); 594dbe3d72SLawrence Tang 604dbe3d72SLawrence Tang //Device serial number. 614dbe3d72SLawrence Tang json_object_object_add(section_ir, "deviceSerialNumber", json_object_new_uint64(pcie_error->SerialNo)); 624dbe3d72SLawrence Tang 634dbe3d72SLawrence Tang //Bridge control status. 644dbe3d72SLawrence Tang json_object* bridge_control_status = json_object_new_object(); 654dbe3d72SLawrence Tang json_object_object_add(bridge_control_status, "secondaryStatusRegister", 664dbe3d72SLawrence Tang json_object_new_uint64(pcie_error->BridgeControlStatus & 0xFFFF)); 674dbe3d72SLawrence Tang json_object_object_add(bridge_control_status, "controlRegister", 684dbe3d72SLawrence Tang json_object_new_uint64(pcie_error->BridgeControlStatus >> 16)); 694dbe3d72SLawrence Tang json_object_object_add(section_ir, "bridgeControlStatus", bridge_control_status); 704dbe3d72SLawrence Tang 714dbe3d72SLawrence Tang //Capability structure. 726c461e90SLawrence Tang //The PCIe capability structure provided here could either be PCIe 1.1 Capability Structure 736c461e90SLawrence Tang //(36-byte, padded to 60 bytes) or PCIe 2.0 Capability Structure (60-byte). There does not seem 746c461e90SLawrence Tang //to be a way to differentiate these, so this is left as a b64 dump. 756c461e90SLawrence Tang char* encoded = b64_encode((unsigned char*)pcie_error->Capability.PcieCap, 60); 766c461e90SLawrence Tang json_object* capability = json_object_new_object(); 776c461e90SLawrence Tang json_object_object_add(capability, "data", json_object_new_string(encoded)); 786c461e90SLawrence Tang free(encoded); 796c461e90SLawrence Tang json_object_object_add(section_ir, "capabilityStructure", capability); 804dbe3d72SLawrence Tang 814dbe3d72SLawrence Tang //AER information. 826c461e90SLawrence Tang json_object* aer_capability_ir = json_object_new_object(); 836c461e90SLawrence Tang EFI_PCIE_ADV_ERROR_EXT_CAPABILITY* aer_capability = (EFI_PCIE_ADV_ERROR_EXT_CAPABILITY*)pcie_error->AerInfo.PcieAer; 846c461e90SLawrence Tang json_object_object_add(aer_capability_ir, "capabilityID", 856c461e90SLawrence Tang json_object_new_uint64(aer_capability->Header.PcieExtendedCapabilityId)); 866c461e90SLawrence Tang json_object_object_add(aer_capability_ir, "capabilityVersion", 876c461e90SLawrence Tang json_object_new_uint64(aer_capability->Header.CapabilityVersion)); 886c461e90SLawrence Tang json_object_object_add(aer_capability_ir, "uncorrectableErrorStatusRegister", 896c461e90SLawrence Tang json_object_new_uint64(aer_capability->UncorrectableErrorStatusReg)); 906c461e90SLawrence Tang json_object_object_add(aer_capability_ir, "uncorrectableErrorMaskRegister", 916c461e90SLawrence Tang json_object_new_uint64(aer_capability->UncorrectableErrorMaskReg)); 926c461e90SLawrence Tang json_object_object_add(aer_capability_ir, "uncorrectableErrorSeverityRegister", 936c461e90SLawrence Tang json_object_new_uint64(aer_capability->UncorrectableErrorSeverityReg)); 946c461e90SLawrence Tang json_object_object_add(aer_capability_ir, "correctableErrorStatusRegister", 956c461e90SLawrence Tang json_object_new_uint64(aer_capability->CorrectableErrorStatusReg)); 966c461e90SLawrence Tang json_object_object_add(aer_capability_ir, "correctableErrorMaskRegister", 976c461e90SLawrence Tang json_object_new_uint64(aer_capability->CorrectableErrorMaskReg)); 986c461e90SLawrence Tang json_object_object_add(aer_capability_ir, "aeccReg", json_object_new_uint64(aer_capability->AeccReg)); 994dbe3d72SLawrence Tang 1006c461e90SLawrence Tang //Header log register (b64). 1016c461e90SLawrence Tang encoded = b64_encode((unsigned char*)aer_capability->HeaderLogReg, 16); 1026c461e90SLawrence Tang json_object_object_add(aer_capability_ir, "headerLogRegister", json_object_new_string(encoded)); 1036c461e90SLawrence Tang free(encoded); 1046c461e90SLawrence Tang 1056c461e90SLawrence Tang //Remaining AER fields. 1066c461e90SLawrence Tang json_object_object_add(aer_capability_ir, "rootErrorCommand", 1076c461e90SLawrence Tang json_object_new_uint64(aer_capability->RootErrorCommand)); 1086c461e90SLawrence Tang json_object_object_add(aer_capability_ir, "rootErrorStatus", 1096c461e90SLawrence Tang json_object_new_uint64(aer_capability->RootErrorStatus)); 1106c461e90SLawrence Tang json_object_object_add(aer_capability_ir, "errorSourceIDRegister", 1116c461e90SLawrence Tang json_object_new_uint64(aer_capability->ErrorSourceIdReg)); 1126c461e90SLawrence Tang json_object_object_add(aer_capability_ir, "correctableErrorSourceIDRegister", 1136c461e90SLawrence Tang json_object_new_uint64(aer_capability->CorrectableSourceIdReg)); 1146c461e90SLawrence Tang 1156c461e90SLawrence Tang json_object_object_add(section_ir, "aerInfo", aer_capability_ir); 1164dbe3d72SLawrence Tang return section_ir; 1174dbe3d72SLawrence Tang } 118*3b7f45b5SLawrence Tang 119*3b7f45b5SLawrence Tang //Converts a single CPER-JSON PCIe section into CPER binary, outputting to the given stream. 120*3b7f45b5SLawrence Tang void ir_section_pcie_to_cper(json_object* section, FILE* out) 121*3b7f45b5SLawrence Tang { 122*3b7f45b5SLawrence Tang EFI_PCIE_ERROR_DATA* section_cper = (EFI_PCIE_ERROR_DATA*)calloc(1, sizeof(EFI_PCIE_ERROR_DATA)); 123*3b7f45b5SLawrence Tang 124*3b7f45b5SLawrence Tang //Validation bits. 125*3b7f45b5SLawrence Tang section_cper->ValidFields = ir_to_bitfield(json_object_object_get(section, "validationBits"), 126*3b7f45b5SLawrence Tang 8, PCIE_ERROR_VALID_BITFIELD_NAMES); 127*3b7f45b5SLawrence Tang 128*3b7f45b5SLawrence Tang //Version. 129*3b7f45b5SLawrence Tang json_object* version = json_object_object_get(section, "version"); 130*3b7f45b5SLawrence Tang int minor = json_object_get_int(json_object_object_get(version, "minor")); 131*3b7f45b5SLawrence Tang int major = json_object_get_int(json_object_object_get(version, "major")); 132*3b7f45b5SLawrence Tang section_cper->Version = int_to_bcd(minor) + ((UINT16)(int_to_bcd(major)) << 8); 133*3b7f45b5SLawrence Tang 134*3b7f45b5SLawrence Tang //Command/status registers. 135*3b7f45b5SLawrence Tang json_object* command_status = json_object_object_get(section, "commandStatus"); 136*3b7f45b5SLawrence Tang UINT32 command = (UINT16)json_object_get_uint64(json_object_object_get(command_status, "commandRegister")); 137*3b7f45b5SLawrence Tang UINT32 status = (UINT16)json_object_get_uint64(json_object_object_get(command_status, "statusRegister")); 138*3b7f45b5SLawrence Tang section_cper->CommandStatus = command + (status << 16); 139*3b7f45b5SLawrence Tang 140*3b7f45b5SLawrence Tang //Device ID. 141*3b7f45b5SLawrence Tang json_object* device_id = json_object_object_get(section, "deviceID"); 142*3b7f45b5SLawrence Tang UINT64 class_id = json_object_get_uint64(json_object_object_get(device_id, "classCode")); 143*3b7f45b5SLawrence Tang section_cper->DevBridge.VendorId = 144*3b7f45b5SLawrence Tang (UINT16)json_object_get_uint64(json_object_object_get(device_id, "vendorID")); 145*3b7f45b5SLawrence Tang section_cper->DevBridge.DeviceId = 146*3b7f45b5SLawrence Tang (UINT16)json_object_get_uint64(json_object_object_get(device_id, "deviceID")); 147*3b7f45b5SLawrence Tang section_cper->DevBridge.ClassCode[0] = class_id >> 16; 148*3b7f45b5SLawrence Tang section_cper->DevBridge.ClassCode[1] = (class_id >> 8) & 0xFF; 149*3b7f45b5SLawrence Tang section_cper->DevBridge.ClassCode[1] = class_id & 0xFF; 150*3b7f45b5SLawrence Tang section_cper->DevBridge.Function = 151*3b7f45b5SLawrence Tang (UINT8)json_object_get_uint64(json_object_object_get(device_id, "functionNumber")); 152*3b7f45b5SLawrence Tang section_cper->DevBridge.Device = 153*3b7f45b5SLawrence Tang (UINT8)json_object_get_uint64(json_object_object_get(device_id, "deviceNumber")); 154*3b7f45b5SLawrence Tang section_cper->DevBridge.Segment = 155*3b7f45b5SLawrence Tang (UINT16)json_object_get_uint64(json_object_object_get(device_id, "segmentNumber")); 156*3b7f45b5SLawrence Tang section_cper->DevBridge.PrimaryOrDeviceBus = 157*3b7f45b5SLawrence Tang (UINT8)json_object_get_uint64(json_object_object_get(device_id, "primaryOrDeviceBusNumber")); 158*3b7f45b5SLawrence Tang section_cper->DevBridge.SecondaryBus = 159*3b7f45b5SLawrence Tang (UINT8)json_object_get_uint64(json_object_object_get(device_id, "secondaryBusNumber")); 160*3b7f45b5SLawrence Tang section_cper->DevBridge.Slot.Number = 161*3b7f45b5SLawrence Tang (UINT16)json_object_get_uint64(json_object_object_get(device_id, "slotNumber")); 162*3b7f45b5SLawrence Tang 163*3b7f45b5SLawrence Tang //Bridge/control status. 164*3b7f45b5SLawrence Tang json_object* bridge_control = json_object_object_get(section, "bridgeControlStatus"); 165*3b7f45b5SLawrence Tang UINT32 bridge_status = (UINT16)json_object_get_uint64(json_object_object_get(bridge_control, "secondaryStatusRegister")); 166*3b7f45b5SLawrence Tang UINT32 control_status = (UINT16)json_object_get_uint64(json_object_object_get(bridge_control, "controlRegister")); 167*3b7f45b5SLawrence Tang section_cper->BridgeControlStatus = bridge_status + (control_status << 16); 168*3b7f45b5SLawrence Tang 169*3b7f45b5SLawrence Tang //Capability structure. 170*3b7f45b5SLawrence Tang json_object* capability = json_object_object_get(section, "capabilityStructure"); 171*3b7f45b5SLawrence Tang json_object* encoded = json_object_object_get(capability, "data"); 172*3b7f45b5SLawrence Tang UINT8* decoded = b64_decode(json_object_get_string(encoded), json_object_get_string_len(encoded)); 173*3b7f45b5SLawrence Tang memcpy(section_cper->Capability.PcieCap, decoded, 60); 174*3b7f45b5SLawrence Tang free(decoded); 175*3b7f45b5SLawrence Tang 176*3b7f45b5SLawrence Tang //AER capability structure. 177*3b7f45b5SLawrence Tang json_object* aer_info = json_object_object_get(section, "aerInfo"); 178*3b7f45b5SLawrence Tang EFI_PCIE_ADV_ERROR_EXT_CAPABILITY* aer_capability = 179*3b7f45b5SLawrence Tang (EFI_PCIE_ADV_ERROR_EXT_CAPABILITY*)section_cper->AerInfo.PcieAer; 180*3b7f45b5SLawrence Tang aer_capability->Header.PcieExtendedCapabilityId = 181*3b7f45b5SLawrence Tang json_object_get_uint64(json_object_object_get(aer_info, "capabilityID")); 182*3b7f45b5SLawrence Tang aer_capability->Header.CapabilityVersion = 183*3b7f45b5SLawrence Tang json_object_get_uint64(json_object_object_get(aer_info, "capabilityVersion")); 184*3b7f45b5SLawrence Tang aer_capability->UncorrectableErrorStatusReg = 185*3b7f45b5SLawrence Tang (UINT32)json_object_get_uint64(json_object_object_get(aer_info, "uncorrectableErrorStatusRegister")); 186*3b7f45b5SLawrence Tang aer_capability->UncorrectableErrorMaskReg = 187*3b7f45b5SLawrence Tang (UINT32)json_object_get_uint64(json_object_object_get(aer_info, "uncorrectableErrorMaskRegister")); 188*3b7f45b5SLawrence Tang aer_capability->UncorrectableErrorSeverityReg = 189*3b7f45b5SLawrence Tang (UINT32)json_object_get_uint64(json_object_object_get(aer_info, "uncorrectableErrorSeverityRegister")); 190*3b7f45b5SLawrence Tang aer_capability->CorrectableErrorStatusReg = 191*3b7f45b5SLawrence Tang (UINT32)json_object_get_uint64(json_object_object_get(aer_info, "correctableErrorStatusRegister")); 192*3b7f45b5SLawrence Tang aer_capability->CorrectableErrorMaskReg = 193*3b7f45b5SLawrence Tang (UINT32)json_object_get_uint64(json_object_object_get(aer_info, "correctableErrorMaskRegister")); 194*3b7f45b5SLawrence Tang aer_capability->AeccReg = 195*3b7f45b5SLawrence Tang (UINT32)json_object_get_uint64(json_object_object_get(aer_info, "aeccReg")); 196*3b7f45b5SLawrence Tang 197*3b7f45b5SLawrence Tang //AER header log register. 198*3b7f45b5SLawrence Tang encoded = json_object_object_get(aer_info, "headerLogRegister"); 199*3b7f45b5SLawrence Tang decoded = b64_decode(json_object_get_string(encoded), json_object_get_string_len(encoded)); 200*3b7f45b5SLawrence Tang memcpy(aer_capability->HeaderLogReg, decoded, 16); 201*3b7f45b5SLawrence Tang free(decoded); 202*3b7f45b5SLawrence Tang 203*3b7f45b5SLawrence Tang //Remaining AER fields. 204*3b7f45b5SLawrence Tang aer_capability->RootErrorCommand = 205*3b7f45b5SLawrence Tang (UINT32)json_object_get_uint64(json_object_object_get(aer_info, "rootErrorCommand")); 206*3b7f45b5SLawrence Tang aer_capability->RootErrorStatus = 207*3b7f45b5SLawrence Tang (UINT32)json_object_get_uint64(json_object_object_get(aer_info, "rootErrorStatus")); 208*3b7f45b5SLawrence Tang aer_capability->ErrorSourceIdReg = 209*3b7f45b5SLawrence Tang (UINT16)json_object_get_uint64(json_object_object_get(aer_info, "errorSourceIDRegister")); 210*3b7f45b5SLawrence Tang aer_capability->CorrectableSourceIdReg = 211*3b7f45b5SLawrence Tang (UINT16)json_object_get_uint64(json_object_object_get(aer_info, "correctableErrorSourceIDRegister")); 212*3b7f45b5SLawrence Tang 213*3b7f45b5SLawrence Tang 214*3b7f45b5SLawrence Tang //Miscellaneous value fields. 215*3b7f45b5SLawrence Tang section_cper->PortType = (UINT32)readable_pair_to_integer(json_object_object_get(section, "portType")); 216*3b7f45b5SLawrence Tang section_cper->SerialNo = json_object_get_uint64(json_object_object_get(section, "deviceSerialNumber")); 217*3b7f45b5SLawrence Tang 218*3b7f45b5SLawrence Tang //Write out to stream, free resources. 219*3b7f45b5SLawrence Tang fwrite(§ion_cper, sizeof(section_cper), 1, out); 220*3b7f45b5SLawrence Tang fflush(out); 221*3b7f45b5SLawrence Tang free(section_cper); 222*3b7f45b5SLawrence Tang }