blob: f16b0ddd1c485a83ed603c10e698a6cb4a034bf2 [file] [log] [blame]
Lawrence Tangc60a2432022-07-06 14:58:33 +01001/**
2 * Describes functions for converting firmware CPER sections from binary and JSON format
3 * into an intermediate format.
Ed Tanousfedd4572024-07-12 13:56:00 -07004 *
Lawrence Tangc60a2432022-07-06 14:58:33 +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-firmware.h>
Ed Tanous50b966f2025-03-11 09:06:19 -070012#include <libcper/log.h>
Aushim Nagarkattiad6c8802025-06-18 16:45:28 -070013#include <string.h>
Lawrence Tangc60a2432022-07-06 14:58:33 +010014
15//Converts a single firmware CPER section into JSON IR.
Aushim Nagarkattiad6c8802025-06-18 16:45:28 -070016json_object *cper_section_firmware_to_ir(const UINT8 *section, UINT32 size,
17 char **desc_string)
Lawrence Tangc60a2432022-07-06 14:58:33 +010018{
Aushim Nagarkattiad6c8802025-06-18 16:45:28 -070019 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
Ed Tanous12dbd4f2025-03-08 19:05:01 -080031 if (size < sizeof(EFI_FIRMWARE_ERROR_DATA)) {
32 return NULL;
33 }
34
Lawrence Tange407b4c2022-07-21 13:54:01 +010035 EFI_FIRMWARE_ERROR_DATA *firmware_error =
36 (EFI_FIRMWARE_ERROR_DATA *)section;
37 json_object *section_ir = json_object_new_object();
Lawrence Tangc60a2432022-07-06 14:58:33 +010038
Lawrence Tange407b4c2022-07-21 13:54:01 +010039 //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);
Lawrence Tangc60a2432022-07-06 14:58:33 +010044
Lawrence Tange407b4c2022-07-21 13:54:01 +010045 //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));
Lawrence Tangc60a2432022-07-06 14:58:33 +010051
Lawrence Tange407b4c2022-07-21 13:54:01 +010052 //Record GUID.
Ed Tanousc2ebddd2025-03-09 10:07:01 -070053 add_guid(section_ir, "recordIDGUID", &firmware_error->RecordIdGuid);
Lawrence Tange407b4c2022-07-21 13:54:01 +010054
55 return section_ir;
Lawrence Tang205dd1d2022-07-14 16:23:38 +010056}
57
58//Converts a single firmware CPER-JSON section into CPER binary, outputting to the given stream.
Lawrence Tange407b4c2022-07-21 13:54:01 +010059void ir_section_firmware_to_cper(json_object *section, FILE *out)
Lawrence Tang205dd1d2022-07-14 16:23:38 +010060{
Lawrence Tange407b4c2022-07-21 13:54:01 +010061 EFI_FIRMWARE_ERROR_DATA *section_cper =
62 (EFI_FIRMWARE_ERROR_DATA *)calloc(
63 1, sizeof(EFI_FIRMWARE_ERROR_DATA));
Lawrence Tang205dd1d2022-07-14 16:23:38 +010064
Lawrence Tange407b4c2022-07-21 13:54:01 +010065 //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")));
Lawrence Tang205dd1d2022-07-14 16:23:38 +010075
Lawrence Tange407b4c2022-07-21 13:54:01 +010076 //Write to stream, free resources.
77 fwrite(section_cper, sizeof(EFI_FIRMWARE_ERROR_DATA), 1, out);
78 fflush(out);
79 free(section_cper);
John Chungf8fc7052024-05-03 20:05:29 +080080}