specification/document/cper-json-specification.tex

7 \title{CPER-JSON Specification}
45 This document lays out a structure for representing UEFI CPER records, as described in UEFI Appendi…
47  in a human-readable JSON format, intended to be interoperable with standard CPER binary.
49 The C library released with this specification allows for the conversion between UEFI CPER records,…
56 This structure contains descriptions of the CPER log header, as well as the section descriptors and
57 section structures themselves within arrays, representing a full CPER log. This is the structure re…
61 header & object & A CPER header structure as defined in Section \ref{section:headerstructure}. \\
70 This structure contains a single section descriptor and section, representing a single section CPER…
83 This structure describes the JSON format of the standard CPER header as defined in section N.2.1 of…
88 revision & object & A CPER revision object structure as defined in Subsection \ref{subsection:revis…
90 sectionCount & int & The number of sections that are described by the CPER record.\\
94 validationBits & object & A CPER header validation bitfield as described in Subsection \ref{subsect…
96 recordLength & uint64 & The total length of the binary CPER record, including the header, in bytes.…
108 notificationType & object & A CPER notification type structure as described in Subsection \ref{subs…
112 flags & object & A CPER header flags structure, as defined in Subsection \ref{subsection:headerflag…
120 This structure describes the error severity of a single CPER record.
130 This structure describes a bitfield for validating the fields of the header of a single CPER record.
142 This structure describes the notification type of a single CPER record.
144 guid & string & The GUID of this notification type. Assigned GUIDs for types of CPER records are de…
152 This structure describes the enabled flag on a given CPER record header.
162 This section describes the JSON format of a single CPER record section descriptor as defined by sec…
170 revision & object & A CPER revision structure as defined in Subsection \ref{subsection:revisionstru…
175 flags & object & A CPER section descriptor flags structure as described in Subsection \ref{subsecti…
191 This structure describes the enabled flags on a given CPER section descriptor.
210 % Generic CPER structures.
211 \section{Generic CPER Structures}
212 This section describes generic CPER structures that are re-used throughout the specification.
217 This structure describes the revision of a single CPER record or sub-structure.
222 \jsontableend{CPER revision structure field table.}
227 This structure describes the a generic CPER error status, that can be used by any CPER section.
256 This section describes the JSON format for a single Generic Processor Error Section from a CPER rec…
294 This structure describes the valdation bits structure of a General Processor Error CPER section.
326 This structure describes the flags structure of a General Processor Error CPER section.
340 This section describes the JSON format for a single IA32/x64 Error Section from a CPER record. The …
356 This structure describes the validation bitfield structure of an IA32/x64 Error CPER section.
370 This structure describes the CPUINFO structure of an IA32/x64 Error CPER section.
711 This section describes the JSON format for a single ARM Processor Error Section from a CPER record.…
1285 This section describes the JSON format for a single Memory Error Section from a CPER record. The GU…
1289 errorStatus & object & A CPER Generic Error Status structure, as described in Subsection \ref{subse…
1394 This section describes the JSON format for a single Memory Error 2 Section from a CPER record. The …
1398 errorStatus & object & A CPER Generic Error Status structure, as described in Subsection \ref{subse…
1512 This section describes the JSON format for a single PCIe Error Section from a CPER record. The GUID…
1621 This section describes the JSON format for a single PCI/PCI-X Bus Error Section from a CPER record.…
1625 errorStatus & object & A CPER Generic Error Status structure, as described in Subsection \ref{subse…
1673 This section describes the JSON format for a single PCI/PCI-X Component Error Section from a CPER r…
1677 errorStatus & object & A CPER Generic Error Status structure, as described in Subsection \ref{subse…
1737 This section describes the JSON format for a single Firmware Error Section from a CPER record. The …
1752 This section describes the JSON format for a single Generic DMAr Error Section from a CPER record. …
1777 This section describes the JSON format for a single VT-d DMAr Error Section from a CPER record. The…
1842 This section describes the JSON format for a single IOMMU DMAr Error Section from a CPER record. Th…
1870 This section describes the JSON format for a single CCIX PER Error Section from a CPER record. The …
1898 This section describes the JSON format for a single CXL Protocol Error Section from a CPER record. …
1985 This section describes the JSON format for a single CXL Component Error Section from a CPER record.…
2041 …on describes the JSON format for a single undefined CPER section. This structure is used for all C…
2043 data & string & A base64-encoded binary dump of the undefined CPER section.\\