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> 83b7f45b5SLawrence 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. 16*e407b4c8SLawrence Tang json_object *cper_section_pcie_to_ir(void *section, 17*e407b4c8SLawrence Tang EFI_ERROR_SECTION_DESCRIPTOR *descriptor) 184dbe3d72SLawrence Tang { 194dbe3d72SLawrence Tang EFI_PCIE_ERROR_DATA *pcie_error = (EFI_PCIE_ERROR_DATA *)section; 204dbe3d72SLawrence Tang json_object *section_ir = json_object_new_object(); 214dbe3d72SLawrence Tang 224dbe3d72SLawrence Tang //Validation bits. 23*e407b4c8SLawrence Tang json_object *validation = bitfield_to_ir( 24*e407b4c8SLawrence Tang pcie_error->ValidFields, 8, PCIE_ERROR_VALID_BITFIELD_NAMES); 254dbe3d72SLawrence Tang json_object_object_add(section_ir, "validationBits", validation); 264dbe3d72SLawrence Tang 274dbe3d72SLawrence Tang //Port type. 28*e407b4c8SLawrence Tang json_object *port_type = integer_to_readable_pair( 29*e407b4c8SLawrence Tang pcie_error->PortType, 9, PCIE_ERROR_PORT_TYPES_KEYS, 30*e407b4c8SLawrence Tang PCIE_ERROR_PORT_TYPES_VALUES, "Unknown"); 314dbe3d72SLawrence Tang json_object_object_add(section_ir, "portType", port_type); 324dbe3d72SLawrence Tang 334dbe3d72SLawrence Tang //Version, provided each half in BCD. 344dbe3d72SLawrence Tang json_object *version = json_object_new_object(); 35*e407b4c8SLawrence Tang json_object_object_add( 36*e407b4c8SLawrence Tang version, "minor", 37*e407b4c8SLawrence Tang json_object_new_int(bcd_to_int(pcie_error->Version & 0xFF))); 38*e407b4c8SLawrence Tang json_object_object_add( 39*e407b4c8SLawrence Tang version, "major", 40*e407b4c8SLawrence Tang json_object_new_int(bcd_to_int(pcie_error->Version >> 8))); 414dbe3d72SLawrence Tang json_object_object_add(section_ir, "version", version); 424dbe3d72SLawrence Tang 434dbe3d72SLawrence Tang //Command & status. 444dbe3d72SLawrence Tang json_object *command_status = json_object_new_object(); 45*e407b4c8SLawrence Tang json_object_object_add( 46*e407b4c8SLawrence Tang command_status, "commandRegister", 47*e407b4c8SLawrence Tang json_object_new_uint64(pcie_error->CommandStatus & 0xFFFF)); 48*e407b4c8SLawrence Tang json_object_object_add( 49*e407b4c8SLawrence Tang command_status, "statusRegister", 50*e407b4c8SLawrence Tang json_object_new_uint64(pcie_error->CommandStatus >> 16)); 514dbe3d72SLawrence Tang json_object_object_add(section_ir, "commandStatus", command_status); 524dbe3d72SLawrence Tang 534dbe3d72SLawrence Tang //PCIe Device ID. 544dbe3d72SLawrence Tang json_object *device_id = json_object_new_object(); 55db1b7ce2SLawrence Tang UINT64 class_id = (pcie_error->DevBridge.ClassCode[0] << 16) + 564dbe3d72SLawrence Tang (pcie_error->DevBridge.ClassCode[1] << 8) + 57db1b7ce2SLawrence Tang pcie_error->DevBridge.ClassCode[2]; 58*e407b4c8SLawrence Tang json_object_object_add( 59*e407b4c8SLawrence Tang device_id, "vendorID", 60*e407b4c8SLawrence Tang json_object_new_uint64(pcie_error->DevBridge.VendorId)); 61*e407b4c8SLawrence Tang json_object_object_add( 62*e407b4c8SLawrence Tang device_id, "deviceID", 63*e407b4c8SLawrence Tang json_object_new_uint64(pcie_error->DevBridge.DeviceId)); 64*e407b4c8SLawrence Tang json_object_object_add(device_id, "classCode", 65*e407b4c8SLawrence Tang json_object_new_uint64(class_id)); 66*e407b4c8SLawrence Tang json_object_object_add( 67*e407b4c8SLawrence Tang device_id, "functionNumber", 68*e407b4c8SLawrence Tang json_object_new_uint64(pcie_error->DevBridge.Function)); 69*e407b4c8SLawrence Tang json_object_object_add( 70*e407b4c8SLawrence Tang device_id, "deviceNumber", 71*e407b4c8SLawrence Tang json_object_new_uint64(pcie_error->DevBridge.Device)); 72*e407b4c8SLawrence Tang json_object_object_add( 73*e407b4c8SLawrence Tang device_id, "segmentNumber", 74*e407b4c8SLawrence Tang json_object_new_uint64(pcie_error->DevBridge.Segment)); 75*e407b4c8SLawrence Tang json_object_object_add( 76*e407b4c8SLawrence Tang device_id, "primaryOrDeviceBusNumber", 77*e407b4c8SLawrence Tang json_object_new_uint64( 78*e407b4c8SLawrence Tang pcie_error->DevBridge.PrimaryOrDeviceBus)); 79*e407b4c8SLawrence Tang json_object_object_add( 80*e407b4c8SLawrence Tang device_id, "secondaryBusNumber", 81*e407b4c8SLawrence Tang json_object_new_uint64(pcie_error->DevBridge.SecondaryBus)); 82*e407b4c8SLawrence Tang json_object_object_add( 83*e407b4c8SLawrence Tang device_id, "slotNumber", 84*e407b4c8SLawrence Tang json_object_new_uint64(pcie_error->DevBridge.Slot.Number)); 854dbe3d72SLawrence Tang json_object_object_add(section_ir, "deviceID", device_id); 864dbe3d72SLawrence Tang 874dbe3d72SLawrence Tang //Device serial number. 88*e407b4c8SLawrence Tang json_object_object_add(section_ir, "deviceSerialNumber", 89*e407b4c8SLawrence Tang json_object_new_uint64(pcie_error->SerialNo)); 904dbe3d72SLawrence Tang 914dbe3d72SLawrence Tang //Bridge control status. 924dbe3d72SLawrence Tang json_object *bridge_control_status = json_object_new_object(); 93*e407b4c8SLawrence Tang json_object_object_add( 94*e407b4c8SLawrence Tang bridge_control_status, "secondaryStatusRegister", 95*e407b4c8SLawrence Tang json_object_new_uint64(pcie_error->BridgeControlStatus & 96*e407b4c8SLawrence Tang 0xFFFF)); 97*e407b4c8SLawrence Tang json_object_object_add( 98*e407b4c8SLawrence Tang bridge_control_status, "controlRegister", 994dbe3d72SLawrence Tang json_object_new_uint64(pcie_error->BridgeControlStatus >> 16)); 100*e407b4c8SLawrence Tang json_object_object_add(section_ir, "bridgeControlStatus", 101*e407b4c8SLawrence Tang bridge_control_status); 1024dbe3d72SLawrence Tang 1034dbe3d72SLawrence Tang //Capability structure. 1046c461e90SLawrence Tang //The PCIe capability structure provided here could either be PCIe 1.1 Capability Structure 1056c461e90SLawrence Tang //(36-byte, padded to 60 bytes) or PCIe 2.0 Capability Structure (60-byte). There does not seem 1066c461e90SLawrence Tang //to be a way to differentiate these, so this is left as a b64 dump. 107*e407b4c8SLawrence Tang char *encoded = 108*e407b4c8SLawrence Tang b64_encode((unsigned char *)pcie_error->Capability.PcieCap, 60); 1096c461e90SLawrence Tang json_object *capability = json_object_new_object(); 110*e407b4c8SLawrence Tang json_object_object_add(capability, "data", 111*e407b4c8SLawrence Tang json_object_new_string(encoded)); 1126c461e90SLawrence Tang free(encoded); 1136c461e90SLawrence Tang json_object_object_add(section_ir, "capabilityStructure", capability); 1144dbe3d72SLawrence Tang 1154dbe3d72SLawrence Tang //AER information. 1166c461e90SLawrence Tang json_object *aer_capability_ir = json_object_new_object(); 1173ab351feSLawrence Tang encoded = b64_encode((unsigned char *)pcie_error->AerInfo.PcieAer, 96); 118*e407b4c8SLawrence Tang json_object_object_add(aer_capability_ir, "data", 119*e407b4c8SLawrence Tang json_object_new_string(encoded)); 1206c461e90SLawrence Tang free(encoded); 1216c461e90SLawrence Tang json_object_object_add(section_ir, "aerInfo", aer_capability_ir); 1224dbe3d72SLawrence Tang return section_ir; 1234dbe3d72SLawrence Tang } 1243b7f45b5SLawrence Tang 1253b7f45b5SLawrence Tang //Converts a single CPER-JSON PCIe section into CPER binary, outputting to the given stream. 1263b7f45b5SLawrence Tang void ir_section_pcie_to_cper(json_object *section, FILE *out) 1273b7f45b5SLawrence Tang { 128*e407b4c8SLawrence Tang EFI_PCIE_ERROR_DATA *section_cper = 129*e407b4c8SLawrence Tang (EFI_PCIE_ERROR_DATA *)calloc(1, sizeof(EFI_PCIE_ERROR_DATA)); 1303b7f45b5SLawrence Tang 1313b7f45b5SLawrence Tang //Validation bits. 132*e407b4c8SLawrence Tang section_cper->ValidFields = ir_to_bitfield( 133*e407b4c8SLawrence Tang json_object_object_get(section, "validationBits"), 8, 134*e407b4c8SLawrence Tang PCIE_ERROR_VALID_BITFIELD_NAMES); 1353b7f45b5SLawrence Tang 1363b7f45b5SLawrence Tang //Version. 1373b7f45b5SLawrence Tang json_object *version = json_object_object_get(section, "version"); 138*e407b4c8SLawrence Tang UINT32 minor = int_to_bcd( 139*e407b4c8SLawrence Tang json_object_get_int(json_object_object_get(version, "minor"))); 140*e407b4c8SLawrence Tang UINT32 major = int_to_bcd( 141*e407b4c8SLawrence Tang json_object_get_int(json_object_object_get(version, "major"))); 1423ab351feSLawrence Tang section_cper->Version = minor + (major << 8); 1433b7f45b5SLawrence Tang 1443b7f45b5SLawrence Tang //Command/status registers. 145*e407b4c8SLawrence Tang json_object *command_status = 146*e407b4c8SLawrence Tang json_object_object_get(section, "commandStatus"); 147*e407b4c8SLawrence Tang UINT32 command = (UINT16)json_object_get_uint64( 148*e407b4c8SLawrence Tang json_object_object_get(command_status, "commandRegister")); 149*e407b4c8SLawrence Tang UINT32 status = (UINT16)json_object_get_uint64( 150*e407b4c8SLawrence Tang json_object_object_get(command_status, "statusRegister")); 1513b7f45b5SLawrence Tang section_cper->CommandStatus = command + (status << 16); 1523b7f45b5SLawrence Tang 1533b7f45b5SLawrence Tang //Device ID. 1543b7f45b5SLawrence Tang json_object *device_id = json_object_object_get(section, "deviceID"); 155*e407b4c8SLawrence Tang UINT64 class_id = json_object_get_uint64( 156*e407b4c8SLawrence Tang json_object_object_get(device_id, "classCode")); 157*e407b4c8SLawrence Tang section_cper->DevBridge.VendorId = (UINT16)json_object_get_uint64( 158*e407b4c8SLawrence Tang json_object_object_get(device_id, "vendorID")); 159*e407b4c8SLawrence Tang section_cper->DevBridge.DeviceId = (UINT16)json_object_get_uint64( 160*e407b4c8SLawrence Tang json_object_object_get(device_id, "deviceID")); 1613b7f45b5SLawrence Tang section_cper->DevBridge.ClassCode[0] = class_id >> 16; 1623b7f45b5SLawrence Tang section_cper->DevBridge.ClassCode[1] = (class_id >> 8) & 0xFF; 1633ab351feSLawrence Tang section_cper->DevBridge.ClassCode[2] = class_id & 0xFF; 164*e407b4c8SLawrence Tang section_cper->DevBridge.Function = (UINT8)json_object_get_uint64( 165*e407b4c8SLawrence Tang json_object_object_get(device_id, "functionNumber")); 166*e407b4c8SLawrence Tang section_cper->DevBridge.Device = (UINT8)json_object_get_uint64( 167*e407b4c8SLawrence Tang json_object_object_get(device_id, "deviceNumber")); 168*e407b4c8SLawrence Tang section_cper->DevBridge.Segment = (UINT16)json_object_get_uint64( 169*e407b4c8SLawrence Tang json_object_object_get(device_id, "segmentNumber")); 1703b7f45b5SLawrence Tang section_cper->DevBridge.PrimaryOrDeviceBus = 171*e407b4c8SLawrence Tang (UINT8)json_object_get_uint64(json_object_object_get( 172*e407b4c8SLawrence Tang device_id, "primaryOrDeviceBusNumber")); 173*e407b4c8SLawrence Tang section_cper->DevBridge.SecondaryBus = (UINT8)json_object_get_uint64( 174*e407b4c8SLawrence Tang json_object_object_get(device_id, "secondaryBusNumber")); 175*e407b4c8SLawrence Tang section_cper->DevBridge.Slot.Number = (UINT16)json_object_get_uint64( 176*e407b4c8SLawrence Tang json_object_object_get(device_id, "slotNumber")); 1773b7f45b5SLawrence Tang 1783b7f45b5SLawrence Tang //Bridge/control status. 179*e407b4c8SLawrence Tang json_object *bridge_control = 180*e407b4c8SLawrence Tang json_object_object_get(section, "bridgeControlStatus"); 181*e407b4c8SLawrence Tang UINT32 bridge_status = (UINT16)json_object_get_uint64( 182*e407b4c8SLawrence Tang json_object_object_get(bridge_control, 183*e407b4c8SLawrence Tang "secondaryStatusRegister")); 184*e407b4c8SLawrence Tang UINT32 control_status = (UINT16)json_object_get_uint64( 185*e407b4c8SLawrence Tang json_object_object_get(bridge_control, "controlRegister")); 186*e407b4c8SLawrence Tang section_cper->BridgeControlStatus = 187*e407b4c8SLawrence Tang bridge_status + (control_status << 16); 1883b7f45b5SLawrence Tang 1893b7f45b5SLawrence Tang //Capability structure. 190*e407b4c8SLawrence Tang json_object *capability = 191*e407b4c8SLawrence Tang json_object_object_get(section, "capabilityStructure"); 1923b7f45b5SLawrence Tang json_object *encoded = json_object_object_get(capability, "data"); 193*e407b4c8SLawrence Tang UINT8 *decoded = b64_decode(json_object_get_string(encoded), 194*e407b4c8SLawrence Tang json_object_get_string_len(encoded)); 1953b7f45b5SLawrence Tang memcpy(section_cper->Capability.PcieCap, decoded, 60); 1963b7f45b5SLawrence Tang free(decoded); 1973b7f45b5SLawrence Tang 1983b7f45b5SLawrence Tang //AER capability structure. 1993b7f45b5SLawrence Tang json_object *aer_info = json_object_object_get(section, "aerInfo"); 2003ab351feSLawrence Tang encoded = json_object_object_get(aer_info, "data"); 201*e407b4c8SLawrence Tang decoded = b64_decode(json_object_get_string(encoded), 202*e407b4c8SLawrence Tang json_object_get_string_len(encoded)); 2033ab351feSLawrence Tang memcpy(section_cper->AerInfo.PcieAer, decoded, 96); 2043b7f45b5SLawrence Tang free(decoded); 2053b7f45b5SLawrence Tang 2063b7f45b5SLawrence Tang //Miscellaneous value fields. 207*e407b4c8SLawrence Tang section_cper->PortType = (UINT32)readable_pair_to_integer( 208*e407b4c8SLawrence Tang json_object_object_get(section, "portType")); 209*e407b4c8SLawrence Tang section_cper->SerialNo = json_object_get_uint64( 210*e407b4c8SLawrence Tang json_object_object_get(section, "deviceSerialNumber")); 2113b7f45b5SLawrence Tang 2123b7f45b5SLawrence Tang //Write out to stream, free resources. 2133ab351feSLawrence Tang fwrite(section_cper, sizeof(EFI_PCIE_ERROR_DATA), 1, out); 2143b7f45b5SLawrence Tang fflush(out); 2153b7f45b5SLawrence Tang free(section_cper); 2163b7f45b5SLawrence Tang }