1db1b7ce2SLawrence Tang /** 2db1b7ce2SLawrence Tang * Describes functions for converting VT-d specific DMAr CPER sections from binary and JSON format 3db1b7ce2SLawrence Tang * into an intermediate format. 4db1b7ce2SLawrence Tang * 5db1b7ce2SLawrence Tang * Author: Lawrence.Tang@arm.com 6db1b7ce2SLawrence Tang **/ 7db1b7ce2SLawrence Tang #include <stdio.h> 8205dd1d7SLawrence Tang #include <string.h> 9db1b7ce2SLawrence Tang #include "json.h" 10ce0f82bfSLawrence Tang #include "b64.h" 11db1b7ce2SLawrence Tang #include "../edk/Cper.h" 12db1b7ce2SLawrence Tang #include "../cper-utils.h" 13db1b7ce2SLawrence Tang #include "cper-section-dmar-vtd.h" 14db1b7ce2SLawrence Tang 15db1b7ce2SLawrence Tang //Converts a single VT-d specific DMAr CPER section into JSON IR. 16db1b7ce2SLawrence Tang json_object* cper_section_dmar_vtd_to_ir(void* section, EFI_ERROR_SECTION_DESCRIPTOR* descriptor) 17db1b7ce2SLawrence Tang { 18db1b7ce2SLawrence Tang EFI_DIRECTED_IO_DMAR_ERROR_DATA* vtd_error = (EFI_DIRECTED_IO_DMAR_ERROR_DATA*)section; 19db1b7ce2SLawrence Tang json_object* section_ir = json_object_new_object(); 20db1b7ce2SLawrence Tang 21db1b7ce2SLawrence Tang //Version, revision and OEM ID, as defined in the VT-d architecture. 22*0a4b3f2dSLawrence Tang UINT64 oem_id = 0; 23*0a4b3f2dSLawrence Tang for (int i=0; i<6; i++) 24*0a4b3f2dSLawrence Tang oem_id |= (UINT64)vtd_error->OemId[i] << (i * 8); 25db1b7ce2SLawrence Tang json_object_object_add(section_ir, "version", json_object_new_int(vtd_error->Version)); 26db1b7ce2SLawrence Tang json_object_object_add(section_ir, "revision", json_object_new_int(vtd_error->Revision)); 27db1b7ce2SLawrence Tang json_object_object_add(section_ir, "oemID", json_object_new_uint64(oem_id)); 28db1b7ce2SLawrence Tang 29db1b7ce2SLawrence Tang //Registers. 30db1b7ce2SLawrence Tang json_object_object_add(section_ir, "capabilityRegister", json_object_new_uint64(vtd_error->Capability)); 31db1b7ce2SLawrence Tang json_object_object_add(section_ir, "extendedCapabilityRegister", json_object_new_uint64(vtd_error->CapabilityEx)); 32db1b7ce2SLawrence Tang json_object_object_add(section_ir, "globalCommandRegister", json_object_new_uint64(vtd_error->GlobalCommand)); 33db1b7ce2SLawrence Tang json_object_object_add(section_ir, "globalStatusRegister", json_object_new_uint64(vtd_error->GlobalStatus)); 34db1b7ce2SLawrence Tang json_object_object_add(section_ir, "faultStatusRegister", json_object_new_uint64(vtd_error->FaultStatus)); 35db1b7ce2SLawrence Tang 36ce0f82bfSLawrence Tang //Fault record basic fields. 37ce0f82bfSLawrence Tang json_object* fault_record_ir = json_object_new_object(); 38ce0f82bfSLawrence Tang EFI_VTD_FAULT_RECORD* fault_record = (EFI_VTD_FAULT_RECORD*)vtd_error->FaultRecord; 39ce0f82bfSLawrence Tang json_object_object_add(fault_record_ir, "faultInformation", json_object_new_uint64(fault_record->FaultInformation)); 40ce0f82bfSLawrence Tang json_object_object_add(fault_record_ir, "sourceIdentifier", json_object_new_uint64(fault_record->SourceIdentifier)); 41ce0f82bfSLawrence Tang json_object_object_add(fault_record_ir, "privelegeModeRequested", 42ce0f82bfSLawrence Tang json_object_new_boolean(fault_record->PrivelegeModeRequested)); 43ce0f82bfSLawrence Tang json_object_object_add(fault_record_ir, "executePermissionRequested", 44ce0f82bfSLawrence Tang json_object_new_boolean(fault_record->ExecutePermissionRequested)); 45ce0f82bfSLawrence Tang json_object_object_add(fault_record_ir, "pasidPresent", json_object_new_boolean(fault_record->PasidPresent)); 46ce0f82bfSLawrence Tang json_object_object_add(fault_record_ir, "faultReason", json_object_new_uint64(fault_record->FaultReason)); 47ce0f82bfSLawrence Tang json_object_object_add(fault_record_ir, "pasidValue", json_object_new_uint64(fault_record->PasidValue)); 48ce0f82bfSLawrence Tang json_object_object_add(fault_record_ir, "addressType", json_object_new_uint64(fault_record->AddressType)); 49ce0f82bfSLawrence Tang 50205dd1d7SLawrence Tang //Fault record type. 51ce0f82bfSLawrence Tang json_object* fault_record_type = integer_to_readable_pair(fault_record->Type, 2, 52ce0f82bfSLawrence Tang VTD_FAULT_RECORD_TYPES_KEYS, 53ce0f82bfSLawrence Tang VTD_FAULT_RECORD_TYPES_VALUES, 54ce0f82bfSLawrence Tang "Unknown"); 55ce0f82bfSLawrence Tang json_object_object_add(fault_record_ir, "type", fault_record_type); 56ce0f82bfSLawrence Tang json_object_object_add(section_ir, "faultRecord", fault_record_ir); 57ce0f82bfSLawrence Tang 58ce0f82bfSLawrence Tang //Root entry. 59ce0f82bfSLawrence Tang char* encoded = b64_encode((unsigned char*)vtd_error->RootEntry, 16); 60ce0f82bfSLawrence Tang json_object_object_add(section_ir, "rootEntry", json_object_new_string(encoded)); 61ce0f82bfSLawrence Tang free(encoded); 62ce0f82bfSLawrence Tang 63ce0f82bfSLawrence Tang //Context entry. 64ce0f82bfSLawrence Tang encoded = b64_encode((unsigned char*)vtd_error->ContextEntry, 16); 65ce0f82bfSLawrence Tang json_object_object_add(section_ir, "contextEntry", json_object_new_string(encoded)); 66ce0f82bfSLawrence Tang free(encoded); 67db1b7ce2SLawrence Tang 68db1b7ce2SLawrence Tang //PTE entry for all page levels. 69db1b7ce2SLawrence Tang json_object_object_add(section_ir, "pageTableEntry_Level6", json_object_new_uint64(vtd_error->PteL6)); 70db1b7ce2SLawrence Tang json_object_object_add(section_ir, "pageTableEntry_Level5", json_object_new_uint64(vtd_error->PteL5)); 71db1b7ce2SLawrence Tang json_object_object_add(section_ir, "pageTableEntry_Level4", json_object_new_uint64(vtd_error->PteL4)); 72db1b7ce2SLawrence Tang json_object_object_add(section_ir, "pageTableEntry_Level3", json_object_new_uint64(vtd_error->PteL3)); 73db1b7ce2SLawrence Tang json_object_object_add(section_ir, "pageTableEntry_Level2", json_object_new_uint64(vtd_error->PteL2)); 74db1b7ce2SLawrence Tang json_object_object_add(section_ir, "pageTableEntry_Level1", json_object_new_uint64(vtd_error->PteL1)); 75db1b7ce2SLawrence Tang 76db1b7ce2SLawrence Tang return section_ir; 77db1b7ce2SLawrence Tang } 78205dd1d7SLawrence Tang 79205dd1d7SLawrence Tang //Converts a single VT-d DMAR CPER-JSON segment into CPER binary, outputting to the given stream. 80205dd1d7SLawrence Tang void ir_section_dmar_vtd_to_cper(json_object* section, FILE* out) 81205dd1d7SLawrence Tang { 82205dd1d7SLawrence Tang EFI_DIRECTED_IO_DMAR_ERROR_DATA* section_cper = 83205dd1d7SLawrence Tang (EFI_DIRECTED_IO_DMAR_ERROR_DATA*)calloc(1, sizeof(EFI_DIRECTED_IO_DMAR_ERROR_DATA)); 84205dd1d7SLawrence Tang 85205dd1d7SLawrence Tang //OEM ID. 86205dd1d7SLawrence Tang UINT64 oem_id = json_object_get_uint64(json_object_object_get(section, "oemID")); 87*0a4b3f2dSLawrence Tang for (int i=0; i<6; i++) 88*0a4b3f2dSLawrence Tang section_cper->OemId[i] = (oem_id >> (i * 8)) & 0xFF; 89205dd1d7SLawrence Tang 90205dd1d7SLawrence Tang //Registers & basic numeric fields. 91205dd1d7SLawrence Tang section_cper->Version = (UINT8)json_object_get_int(json_object_object_get(section, "version")); 92205dd1d7SLawrence Tang section_cper->Revision = (UINT8)json_object_get_int(json_object_object_get(section, "revision")); 93205dd1d7SLawrence Tang section_cper->Capability = json_object_get_uint64(json_object_object_get(section, "capabilityRegister")); 94205dd1d7SLawrence Tang section_cper->CapabilityEx = json_object_get_uint64(json_object_object_get(section, "extendedCapabilityRegister")); 95*0a4b3f2dSLawrence Tang section_cper->GlobalCommand = json_object_get_uint64(json_object_object_get(section, "globalCommandRegister")); 96*0a4b3f2dSLawrence Tang section_cper->GlobalStatus = json_object_get_uint64(json_object_object_get(section, "globalStatusRegister")); 97*0a4b3f2dSLawrence Tang section_cper->FaultStatus = json_object_get_uint64(json_object_object_get(section, "faultStatusRegister")); 98205dd1d7SLawrence Tang 99205dd1d7SLawrence Tang //Fault record. 100205dd1d7SLawrence Tang json_object* fault_record = json_object_object_get(section, "faultRecord"); 101205dd1d7SLawrence Tang EFI_VTD_FAULT_RECORD* fault_record_cper = (EFI_VTD_FAULT_RECORD*)section_cper->FaultRecord; 102205dd1d7SLawrence Tang fault_record_cper->FaultInformation = 103205dd1d7SLawrence Tang json_object_get_uint64(json_object_object_get(fault_record, "faultInformation")); 104205dd1d7SLawrence Tang fault_record_cper->SourceIdentifier = 105205dd1d7SLawrence Tang json_object_get_uint64(json_object_object_get(fault_record, "sourceIdentifier")); 106205dd1d7SLawrence Tang fault_record_cper->PrivelegeModeRequested = 107205dd1d7SLawrence Tang json_object_get_boolean(json_object_object_get(fault_record, "privelegeModeRequested")); 108205dd1d7SLawrence Tang fault_record_cper->ExecutePermissionRequested = 109205dd1d7SLawrence Tang json_object_get_boolean(json_object_object_get(fault_record, "executePermissionRequested")); 110205dd1d7SLawrence Tang fault_record_cper->PasidPresent = 111205dd1d7SLawrence Tang json_object_get_boolean(json_object_object_get(fault_record, "pasidPresent")); 112205dd1d7SLawrence Tang fault_record_cper->FaultReason = 113205dd1d7SLawrence Tang json_object_get_uint64(json_object_object_get(fault_record, "faultReason")); 114205dd1d7SLawrence Tang fault_record_cper->PasidValue = 115205dd1d7SLawrence Tang json_object_get_uint64(json_object_object_get(fault_record, "pasidValue")); 116205dd1d7SLawrence Tang fault_record_cper->AddressType = 117205dd1d7SLawrence Tang json_object_get_uint64(json_object_object_get(fault_record, "addressType")); 118205dd1d7SLawrence Tang fault_record_cper->Type = 119205dd1d7SLawrence Tang readable_pair_to_integer(json_object_object_get(fault_record, "type")); 120205dd1d7SLawrence Tang 121205dd1d7SLawrence Tang //Root entry. 122205dd1d7SLawrence Tang json_object* encoded = json_object_object_get(section, "rootEntry"); 123205dd1d7SLawrence Tang UINT8* decoded = b64_decode(json_object_get_string(encoded), json_object_get_string_len(encoded)); 124205dd1d7SLawrence Tang memcpy(section_cper->RootEntry, decoded, 16); 125205dd1d7SLawrence Tang free(decoded); 126205dd1d7SLawrence Tang 127205dd1d7SLawrence Tang //Context entry. 128205dd1d7SLawrence Tang encoded = json_object_object_get(section, "contextEntry"); 129205dd1d7SLawrence Tang decoded = b64_decode(json_object_get_string(encoded), json_object_get_string_len(encoded)); 130205dd1d7SLawrence Tang memcpy(section_cper->ContextEntry, decoded, 16); 131205dd1d7SLawrence Tang free(decoded); 132205dd1d7SLawrence Tang 133205dd1d7SLawrence Tang //Page table entries. 134205dd1d7SLawrence Tang section_cper->PteL1 = json_object_get_uint64(json_object_object_get(section, "pageTableEntry_Level1")); 135205dd1d7SLawrence Tang section_cper->PteL2 = json_object_get_uint64(json_object_object_get(section, "pageTableEntry_Level2")); 136205dd1d7SLawrence Tang section_cper->PteL3 = json_object_get_uint64(json_object_object_get(section, "pageTableEntry_Level3")); 137205dd1d7SLawrence Tang section_cper->PteL4 = json_object_get_uint64(json_object_object_get(section, "pageTableEntry_Level4")); 138205dd1d7SLawrence Tang section_cper->PteL5 = json_object_get_uint64(json_object_object_get(section, "pageTableEntry_Level5")); 139205dd1d7SLawrence Tang section_cper->PteL6 = json_object_get_uint64(json_object_object_get(section, "pageTableEntry_Level6")); 140205dd1d7SLawrence Tang 141205dd1d7SLawrence Tang //Write to stream, free resources. 1423ab351feSLawrence Tang fwrite(section_cper, sizeof(EFI_DIRECTED_IO_DMAR_ERROR_DATA), 1, out); 143205dd1d7SLawrence Tang fflush(out); 144205dd1d7SLawrence Tang free(section_cper); 145205dd1d7SLawrence Tang }