xref: /openbmc/libcper/sections/cper-section-firmware.c (revision ad6c880fc739b6ca750c3ab594e270efd972c2ac)
1 /**
2  * Describes functions for converting firmware 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-firmware.h>
12 #include <libcper/log.h>
13 #include <string.h>
14 
15 //Converts a single firmware CPER section into JSON IR.
cper_section_firmware_to_ir(const UINT8 * section,UINT32 size,char ** desc_string)16 json_object *cper_section_firmware_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 Firmware Error occurred");
23 	if (outstr_len < 0) {
24 		cper_print_log(
25 			"Error: Could not write to Firmware description string\n");
26 	} else if (outstr_len > SECTION_DESC_STRING_SIZE) {
27 		cper_print_log(
28 			"Error: Firmware description string truncated\n");
29 	}
30 
31 	if (size < sizeof(EFI_FIRMWARE_ERROR_DATA)) {
32 		return NULL;
33 	}
34 
35 	EFI_FIRMWARE_ERROR_DATA *firmware_error =
36 		(EFI_FIRMWARE_ERROR_DATA *)section;
37 	json_object *section_ir = json_object_new_object();
38 
39 	//Record type.
40 	json_object *record_type = integer_to_readable_pair(
41 		firmware_error->ErrorType, 3, FIRMWARE_ERROR_RECORD_TYPES_KEYS,
42 		FIRMWARE_ERROR_RECORD_TYPES_VALUES, "Unknown (Reserved)");
43 	json_object_object_add(section_ir, "errorRecordType", record_type);
44 
45 	//Revision, record identifier.
46 	json_object_object_add(section_ir, "revision",
47 			       json_object_new_int(firmware_error->Revision));
48 	json_object_object_add(
49 		section_ir, "recordID",
50 		json_object_new_uint64(firmware_error->RecordId));
51 
52 	//Record GUID.
53 	add_guid(section_ir, "recordIDGUID", &firmware_error->RecordIdGuid);
54 
55 	return section_ir;
56 }
57 
58 //Converts a single firmware CPER-JSON section into CPER binary, outputting to the given stream.
ir_section_firmware_to_cper(json_object * section,FILE * out)59 void ir_section_firmware_to_cper(json_object *section, FILE *out)
60 {
61 	EFI_FIRMWARE_ERROR_DATA *section_cper =
62 		(EFI_FIRMWARE_ERROR_DATA *)calloc(
63 			1, sizeof(EFI_FIRMWARE_ERROR_DATA));
64 
65 	//Record fields.
66 	section_cper->ErrorType = readable_pair_to_integer(
67 		json_object_object_get(section, "errorRecordType"));
68 	section_cper->Revision = json_object_get_int(
69 		json_object_object_get(section, "revision"));
70 	section_cper->RecordId = json_object_get_uint64(
71 		json_object_object_get(section, "recordID"));
72 	string_to_guid(&section_cper->RecordIdGuid,
73 		       json_object_get_string(json_object_object_get(
74 			       section, "recordIDGUID")));
75 
76 	//Write to stream, free resources.
77 	fwrite(section_cper, sizeof(EFI_FIRMWARE_ERROR_DATA), 1, out);
78 	fflush(out);
79 	free(section_cper);
80 }
81