This repository specifies a structure for representing UEFI CPER records (as described in UEFI Specification Appendix N) in a human-readable JSON format, in addition to a library which can readily convert back and forth between the standard CPER binary format and the specified structured JSON.
Before building this library and its associated tools, you must have meson (>=1.1.1)
This project uses Meson (>=1.1.1). To build for native architecture, simply run:
meson setup build
ninja -C buildThis project comes with several binaries to help you deal with CPER binary and
CPER-JSON. The first of these is cper-convert, which is a command line tool
that can be found in build/. With this, you can convert to and from CPER and
CPER-JSON through the command line. An example usage scenario is below:
cper-convert to-cper samples/cper-json-test-arm.json --out cper.dump
cper-convert to-json cper.generated.dumpAnother tool bundled with this repository is cper-generate, found in build/.
This allows you to generate pseudo-random valid CPER records with sections of
specified types for testing purposes. An example use of the program is below:
cper-generate --out cper.generated.dump --sections generic ia32x64Help for both of these tools can be accessed through using the --help flag in
isolation.
Finally, a static library containing symbols for converting CPER and CPER-JSON
between an intermediate JSON format can be found generated at
lib/libcper-parse.a. This contains the following useful library symbols:
json_object* cper_to_ir(FILE* cper_file);
void ir_to_cper(json_object* ir, FILE* out);The specification for this project's CPER-JSON format can be found in
specification/, defined in both JSON Schema format and also as a LaTeX
document. Specification for the CPER binary format can be found in
UEFI Specification Appendix N
(2021/03/18).
This library is utilised in a proof of concept displaying CPER communication between a SatMC and OpenBMC board, including a conversion into CPER JSON for logging that utilises this library. You can find information on how to reproduce the prototype at the scripts repository, and example usage of the library itself at the pldm repository.