blob: d75647e96a60c03aa6dae602ac67512621d407cd [file] [log] [blame]
Lawrence Tang4795d4a2022-07-06 15:19:31 +01001/**
2 * Describes functions for converting generic DMAr CPER sections from binary and JSON format
3 * into an intermediate format.
Ed Tanousfedd4572024-07-12 13:56:00 -07004 *
Lawrence Tang4795d4a2022-07-06 15:19:31 +01005 * Author: Lawrence.Tang@arm.com
6 **/
7#include <stdio.h>
Lawrence Tang5202bbb2022-08-12 14:54:36 +01008#include <json.h>
Thu Nguyene42fb482024-10-15 14:43:11 +00009#include <libcper/Cper.h>
10#include <libcper/cper-utils.h>
11#include <libcper/sections/cper-section-dmar-generic.h>
Ed Tanous50b966f2025-03-11 09:06:19 -070012#include <libcper/log.h>
Lawrence Tang4795d4a2022-07-06 15:19:31 +010013
14//Converts a single generic DMAr CPER section into JSON IR.
Ed Tanous12dbd4f2025-03-08 19:05:01 -080015json_object *cper_section_dmar_generic_to_ir(const UINT8 *section, UINT32 size)
Lawrence Tang4795d4a2022-07-06 15:19:31 +010016{
Ed Tanous12dbd4f2025-03-08 19:05:01 -080017 if (size < sizeof(EFI_DMAR_GENERIC_ERROR_DATA)) {
18 return NULL;
19 }
20
Lawrence Tange407b4c2022-07-21 13:54:01 +010021 EFI_DMAR_GENERIC_ERROR_DATA *firmware_error =
22 (EFI_DMAR_GENERIC_ERROR_DATA *)section;
23 json_object *section_ir = json_object_new_object();
Lawrence Tang4795d4a2022-07-06 15:19:31 +010024
Lawrence Tange407b4c2022-07-21 13:54:01 +010025 //Requester ID, segment.
26 json_object_object_add(
27 section_ir, "requesterID",
28 json_object_new_int(firmware_error->RequesterId));
29 json_object_object_add(
30 section_ir, "segmentNumber",
31 json_object_new_int(firmware_error->SegmentNumber));
Lawrence Tang4795d4a2022-07-06 15:19:31 +010032
Lawrence Tange407b4c2022-07-21 13:54:01 +010033 //Fault reason.
34 json_object *fault_reason = integer_to_readable_pair_with_desc(
35 firmware_error->FaultReason, 11,
36 DMAR_GENERIC_ERROR_FAULT_REASON_TYPES_KEYS,
37 DMAR_GENERIC_ERROR_FAULT_REASON_TYPES_VALUES,
38 DMAR_GENERIC_ERROR_FAULT_REASON_TYPES_DESCRIPTIONS,
39 "Unknown (Reserved)");
40 json_object_object_add(section_ir, "faultReason", fault_reason);
Lawrence Tang4795d4a2022-07-06 15:19:31 +010041
Lawrence Tange407b4c2022-07-21 13:54:01 +010042 //Access type.
43 json_object *access_type = integer_to_readable_pair(
44 firmware_error->AccessType, 2,
45 DMAR_GENERIC_ERROR_ACCESS_TYPES_KEYS,
46 DMAR_GENERIC_ERROR_ACCESS_TYPES_VALUES, "Unknown (Reserved)");
47 json_object_object_add(section_ir, "accessType", access_type);
Lawrence Tang4795d4a2022-07-06 15:19:31 +010048
Lawrence Tange407b4c2022-07-21 13:54:01 +010049 //Address type.
50 json_object *address_type = integer_to_readable_pair(
51 firmware_error->AddressType, 2,
52 DMAR_GENERIC_ERROR_ADDRESS_TYPES_KEYS,
53 DMAR_GENERIC_ERROR_ADDRESS_TYPES_VALUES, "Unknown (Reserved)");
54 json_object_object_add(section_ir, "addressType", address_type);
Lawrence Tang4795d4a2022-07-06 15:19:31 +010055
Lawrence Tange407b4c2022-07-21 13:54:01 +010056 //Architecture type.
57 json_object *arch_type = integer_to_readable_pair(
58 firmware_error->ArchType, 2, DMAR_GENERIC_ERROR_ARCH_TYPES_KEYS,
59 DMAR_GENERIC_ERROR_ARCH_TYPES_VALUES, "Unknown (Reserved)");
60 json_object_object_add(section_ir, "architectureType", arch_type);
Lawrence Tang4795d4a2022-07-06 15:19:31 +010061
Lawrence Tange407b4c2022-07-21 13:54:01 +010062 //Device address.
63 json_object_object_add(
64 section_ir, "deviceAddress",
65 json_object_new_uint64(firmware_error->DeviceAddr));
66
67 return section_ir;
Lawrence Tang205dd1d2022-07-14 16:23:38 +010068}
69
70//Converts a single generic DMAR CPER-JSON section into CPER binary, outputting to the given stream.
Lawrence Tange407b4c2022-07-21 13:54:01 +010071void ir_section_dmar_generic_to_cper(json_object *section, FILE *out)
Lawrence Tang205dd1d2022-07-14 16:23:38 +010072{
Lawrence Tange407b4c2022-07-21 13:54:01 +010073 EFI_DMAR_GENERIC_ERROR_DATA *section_cper =
74 (EFI_DMAR_GENERIC_ERROR_DATA *)calloc(
75 1, sizeof(EFI_DMAR_GENERIC_ERROR_DATA));
Lawrence Tang205dd1d2022-07-14 16:23:38 +010076
Lawrence Tange407b4c2022-07-21 13:54:01 +010077 //Record fields.
78 section_cper->RequesterId = (UINT16)json_object_get_int(
79 json_object_object_get(section, "requesterID"));
80 section_cper->SegmentNumber = (UINT16)json_object_get_int(
81 json_object_object_get(section, "segmentNumber"));
82 section_cper->FaultReason = (UINT8)readable_pair_to_integer(
83 json_object_object_get(section, "faultReason"));
84 section_cper->AccessType = (UINT8)readable_pair_to_integer(
85 json_object_object_get(section, "accessType"));
86 section_cper->AddressType = (UINT8)readable_pair_to_integer(
87 json_object_object_get(section, "addressType"));
88 section_cper->ArchType = (UINT8)readable_pair_to_integer(
89 json_object_object_get(section, "architectureType"));
90 section_cper->DeviceAddr = json_object_get_uint64(
91 json_object_object_get(section, "deviceAddress"));
Lawrence Tang205dd1d2022-07-14 16:23:38 +010092
Lawrence Tange407b4c2022-07-21 13:54:01 +010093 //Write to stream, free resources.
94 fwrite(section_cper, sizeof(EFI_DMAR_GENERIC_ERROR_DATA), 1, out);
95 fflush(out);
96 free(section_cper);
John Chungf8fc7052024-05-03 20:05:29 +080097}