Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / libcper / 30cd66aa7068f42bd59893c9cbd31fa2f25480d5
commit30cd66aa7068f42bd59893c9cbd31fa2f25480d5[log] [tgz]
authorPatrick Williams <patrick@stwcx.xyz>Wed Dec 18 11:23:15 2024 -0500
committerPatrick Williams <patrick@stwcx.xyz>Tue Feb 04 20:02:36 2025 +0000
treea8ba7a843c67ad964fe7e8e64e278fb6f86271fe
parent5bc1b32cf3607939a2707693f883aa9385463ff1 [diff]
clang-format: re-format for clang-19

clang-format-19 isn't compatible with the clang-format-18 output, so we
need to reformat the code with the latest version.  A few parameters
in clang-tidy have been deprecated, so adjust the style file
accordingly.

See Ie2f6eb3b043f2d655c9df806815afd7971fd0947 for updated style.
See I88192b41ab7a95599a90915013579608af7bc56f for clang-19 enablement.

Change-Id: I32c52522ee18311ac09500950f82832102ccb5c0
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
18 files changed
tree: a8ba7a843c67ad964fe7e8e64e278fb6f86271fe
  1. cli-app/
  2. docs/
  3. generator/
  4. include/
  5. sections/
  6. specification/
  7. subprojects/
  8. tests/
  9. .clang-format
  10. .clang-tidy
  11. .gitignore
  12. base64.c
  13. common-utils.c
  14. cper-parse.c
  15. cper-parse.i
  16. cper-utils.c
  17. Cper.c
  18. ir-parse.c
  19. json-schema.c
  20. LICENSE
  21. meson.build
  22. meson.options
  23. OWNERS
  24. README.md
README.md

CPER JSON Representation & Conversion Library

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.

Prerequisites

Before building this library and its associated tools, you must have meson (>=1.1.1)

Building

This project uses Meson (>=1.1.1). To build for native architecture, simply run:

meson setup build
ninja -C build

Usage

This 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.dump

Another 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 ia32x64

Help 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);

Specification

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).

Usage Examples

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.