blob: 78f04d0929bcca328107d849ded183c7dfe957ff [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>
Lawrence Tangc60a2432022-07-06 14:58:33 +010012
13//Converts a single firmware CPER section into JSON IR.
Ed Tanous12dbd4f2025-03-08 19:05:01 -080014json_object *cper_section_firmware_to_ir(const UINT8 *section, UINT32 size)
Lawrence Tangc60a2432022-07-06 14:58:33 +010015{
Ed Tanous12dbd4f2025-03-08 19:05:01 -080016 if (size < sizeof(EFI_FIRMWARE_ERROR_DATA)) {
17 return NULL;
18 }
19
Lawrence Tange407b4c2022-07-21 13:54:01 +010020 EFI_FIRMWARE_ERROR_DATA *firmware_error =
21 (EFI_FIRMWARE_ERROR_DATA *)section;
22 json_object *section_ir = json_object_new_object();
Lawrence Tangc60a2432022-07-06 14:58:33 +010023
Lawrence Tange407b4c2022-07-21 13:54:01 +010024 //Record type.
25 json_object *record_type = integer_to_readable_pair(
26 firmware_error->ErrorType, 3, FIRMWARE_ERROR_RECORD_TYPES_KEYS,
27 FIRMWARE_ERROR_RECORD_TYPES_VALUES, "Unknown (Reserved)");
28 json_object_object_add(section_ir, "errorRecordType", record_type);
Lawrence Tangc60a2432022-07-06 14:58:33 +010029
Lawrence Tange407b4c2022-07-21 13:54:01 +010030 //Revision, record identifier.
31 json_object_object_add(section_ir, "revision",
32 json_object_new_int(firmware_error->Revision));
33 json_object_object_add(
34 section_ir, "recordID",
35 json_object_new_uint64(firmware_error->RecordId));
Lawrence Tangc60a2432022-07-06 14:58:33 +010036
Lawrence Tange407b4c2022-07-21 13:54:01 +010037 //Record GUID.
38 char record_id_guid[GUID_STRING_LENGTH];
39 guid_to_string(record_id_guid, &firmware_error->RecordIdGuid);
40 json_object_object_add(section_ir, "recordIDGUID",
41 json_object_new_string(record_id_guid));
42
43 return section_ir;
Lawrence Tang205dd1d2022-07-14 16:23:38 +010044}
45
46//Converts a single firmware CPER-JSON section into CPER binary, outputting to the given stream.
Lawrence Tange407b4c2022-07-21 13:54:01 +010047void ir_section_firmware_to_cper(json_object *section, FILE *out)
Lawrence Tang205dd1d2022-07-14 16:23:38 +010048{
Lawrence Tange407b4c2022-07-21 13:54:01 +010049 EFI_FIRMWARE_ERROR_DATA *section_cper =
50 (EFI_FIRMWARE_ERROR_DATA *)calloc(
51 1, sizeof(EFI_FIRMWARE_ERROR_DATA));
Lawrence Tang205dd1d2022-07-14 16:23:38 +010052
Lawrence Tange407b4c2022-07-21 13:54:01 +010053 //Record fields.
54 section_cper->ErrorType = readable_pair_to_integer(
55 json_object_object_get(section, "errorRecordType"));
56 section_cper->Revision = json_object_get_int(
57 json_object_object_get(section, "revision"));
58 section_cper->RecordId = json_object_get_uint64(
59 json_object_object_get(section, "recordID"));
60 string_to_guid(&section_cper->RecordIdGuid,
61 json_object_get_string(json_object_object_get(
62 section, "recordIDGUID")));
Lawrence Tang205dd1d2022-07-14 16:23:38 +010063
Lawrence Tange407b4c2022-07-21 13:54:01 +010064 //Write to stream, free resources.
65 fwrite(section_cper, sizeof(EFI_FIRMWARE_ERROR_DATA), 1, out);
66 fflush(out);
67 free(section_cper);
John Chungf8fc7052024-05-03 20:05:29 +080068}