Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / libcper / a6f070bb54b6ce2559b15aa918dd5639cd6af764
commita6f070bb54b6ce2559b15aa918dd5639cd6af764[log] [tgz]
authorAushim Nagarkatti <anagarkatti@nvidia.com>Tue Feb 04 11:06:43 2025 -0800
committerAushim Nagarkatti <anagarkatti@nvidia.com>Tue Feb 04 15:16:48 2025 -0800
tree08b2aece1583ae2ca092decea9b9116214ec1ca4
parentc97c041e571841f0ce67292208e083f6d858cf5c [diff]
Fix CPER generation of ASCII properties

If FRU string and CPU brand string are not ascii, they would be
generated as non UTF-8 entities, causing json parsers like nlohmann to
fail.

These properties are defined as ASCII in the UEFI 2.10 spec.

Change-Id: Iba8056bf9855c5bcf07e0267efe47fb17da245a7
Signed-off-by: Aushim Nagarkatti <anagarkatti@nvidia.com>
2 files changed
tree: 08b2aece1583ae2ca092decea9b9116214ec1ca4
  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.