xref: /openbmc/libcper/sections/cper-section-dmar-generic.c (revision ad6c880fc739b6ca750c3ab594e270efd972c2ac)
1 /**
2  * Describes functions for converting generic DMAr CPER sections from binary and JSON format
3  * into an intermediate format.
4  *
5  * Author: Lawrence.Tang@arm.com
6  **/
7 #include <stdio.h>
8 #include <json.h>
9 #include <libcper/Cper.h>
10 #include <libcper/cper-utils.h>
11 #include <libcper/sections/cper-section-dmar-generic.h>
12 #include <libcper/log.h>
13 #include <string.h>
14 
15 //Converts a single generic DMAr CPER section into JSON IR.
cper_section_dmar_generic_to_ir(const UINT8 * section,UINT32 size,char ** desc_string)16 json_object *cper_section_dmar_generic_to_ir(const UINT8 *section, UINT32 size,
17 					     char **desc_string)
18 {
19 	int outstr_len = 0;
20 	*desc_string = malloc(SECTION_DESC_STRING_SIZE);
21 	outstr_len = snprintf(*desc_string, SECTION_DESC_STRING_SIZE,
22 			      "A DMAr Generic Error occurred");
23 	if (outstr_len < 0) {
24 		cper_print_log(
25 			"Error: Could not write to DMAr Generic description string\n");
26 	} else if (outstr_len > SECTION_DESC_STRING_SIZE) {
27 		cper_print_log(
28 			"Error: DMAr Generic description string truncated\n");
29 	}
30 
31 	if (size < sizeof(EFI_DMAR_GENERIC_ERROR_DATA)) {
32 		return NULL;
33 	}
34 
35 	EFI_DMAR_GENERIC_ERROR_DATA *firmware_error =
36 		(EFI_DMAR_GENERIC_ERROR_DATA *)section;
37 	json_object *section_ir = json_object_new_object();
38 
39 	//Requester ID, segment.
40 	json_object_object_add(
41 		section_ir, "requesterID",
42 		json_object_new_int(firmware_error->RequesterId));
43 	json_object_object_add(
44 		section_ir, "segmentNumber",
45 		json_object_new_int(firmware_error->SegmentNumber));
46 
47 	//Fault reason.
48 	json_object *fault_reason = integer_to_readable_pair_with_desc(
49 		firmware_error->FaultReason, 11,
50 		DMAR_GENERIC_ERROR_FAULT_REASON_TYPES_KEYS,
51 		DMAR_GENERIC_ERROR_FAULT_REASON_TYPES_VALUES,
52 		DMAR_GENERIC_ERROR_FAULT_REASON_TYPES_DESCRIPTIONS,
53 		"Unknown (Reserved)");
54 	json_object_object_add(section_ir, "faultReason", fault_reason);
55 
56 	//Access type.
57 	json_object *access_type = integer_to_readable_pair(
58 		firmware_error->AccessType, 2,
59 		DMAR_GENERIC_ERROR_ACCESS_TYPES_KEYS,
60 		DMAR_GENERIC_ERROR_ACCESS_TYPES_VALUES, "Unknown (Reserved)");
61 	json_object_object_add(section_ir, "accessType", access_type);
62 
63 	//Address type.
64 	json_object *address_type = integer_to_readable_pair(
65 		firmware_error->AddressType, 2,
66 		DMAR_GENERIC_ERROR_ADDRESS_TYPES_KEYS,
67 		DMAR_GENERIC_ERROR_ADDRESS_TYPES_VALUES, "Unknown (Reserved)");
68 	json_object_object_add(section_ir, "addressType", address_type);
69 
70 	//Architecture type.
71 	json_object *arch_type = integer_to_readable_pair(
72 		firmware_error->ArchType, 2, DMAR_GENERIC_ERROR_ARCH_TYPES_KEYS,
73 		DMAR_GENERIC_ERROR_ARCH_TYPES_VALUES, "Unknown (Reserved)");
74 	json_object_object_add(section_ir, "architectureType", arch_type);
75 
76 	//Device address.
77 	json_object_object_add(
78 		section_ir, "deviceAddress",
79 		json_object_new_uint64(firmware_error->DeviceAddr));
80 
81 	return section_ir;
82 }
83 
84 //Converts a single generic DMAR CPER-JSON section into CPER binary, outputting to the given stream.
ir_section_dmar_generic_to_cper(json_object * section,FILE * out)85 void ir_section_dmar_generic_to_cper(json_object *section, FILE *out)
86 {
87 	EFI_DMAR_GENERIC_ERROR_DATA *section_cper =
88 		(EFI_DMAR_GENERIC_ERROR_DATA *)calloc(
89 			1, sizeof(EFI_DMAR_GENERIC_ERROR_DATA));
90 
91 	//Record fields.
92 	section_cper->RequesterId = (UINT16)json_object_get_int(
93 		json_object_object_get(section, "requesterID"));
94 	section_cper->SegmentNumber = (UINT16)json_object_get_int(
95 		json_object_object_get(section, "segmentNumber"));
96 	section_cper->FaultReason = (UINT8)readable_pair_to_integer(
97 		json_object_object_get(section, "faultReason"));
98 	section_cper->AccessType = (UINT8)readable_pair_to_integer(
99 		json_object_object_get(section, "accessType"));
100 	section_cper->AddressType = (UINT8)readable_pair_to_integer(
101 		json_object_object_get(section, "addressType"));
102 	section_cper->ArchType = (UINT8)readable_pair_to_integer(
103 		json_object_object_get(section, "architectureType"));
104 	section_cper->DeviceAddr = json_object_get_uint64(
105 		json_object_object_get(section, "deviceAddress"));
106 
107 	//Write to stream, free resources.
108 	fwrite(section_cper, sizeof(EFI_DMAR_GENERIC_ERROR_DATA), 1, out);
109 	fflush(out);
110 	free(section_cper);
111 }
112