Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / libcper / 1ee8ce2442b6b5b2355003524b1b6eb5386af9ec
commit1ee8ce2442b6b5b2355003524b1b6eb5386af9ec[log] [tgz]
authorPatrick Williams <patrick@stwcx.xyz>Mon Jun 17 14:16:56 2024 -0500
committerPatrick Williams <patrick@stwcx.xyz>Mon Jun 17 14:17:16 2024 -0500
tree82697bc3eecef5579d6c159f021694d0702bcaa8
parentb8b687c2e05846afd37b60222a0b4253acda81fd [diff]
OWNERS: add starting OWNERS file

Ed was listed as the initial maintainer per the requesting issue.  Add
him as such.  Add myself as an initial reviewer.

https://github.com/openbmc/technical-oversight-forum/issues/35

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

Notice: This repository contains a proof of concept library. It is intended to serve as a demonstrator. Arm is not actively using the library in this repository or integrating the library into reference code. Arm is willing to collaborate to integrate the code in another upstream project.

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