specification/document/cper-json-specification.tex

42 % Introductory section.
44 \section{Introduction \& Summary}
52 % Specification section.
54 \section{Parent Structure (Type 1): Full Log}
55 \label{section:parentstructuretype1}
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}. \\
63 sectionDescriptors & array & An array of section descriptor objects as defined in Section \ref{sect…
65 …array of section objects as defined in Chapter \ref{chapter:sectionchapter}. These sections are at…
68 \section{Parent Structure (Type 2): Single Section Log}
69 \label{section:parentstructuretype2}
70 This structure contains a single section descriptor and section, representing a single section CPER…
75 sectionDescriptor & object & A section descriptor object as defined in Section \ref{section:section…
77 section & object & A section object as defined in Chapter \ref{chapter:sectionchapter}.\\
81 \section{Header Structure}
82 \label{section:headerstructure}
83 This structure describes the JSON format of the standard CPER header as defined in section N.2.1 of…
132 platformIDValid & boolean & Whether the "platformID" field in the header structure (\ref{section:he…
134 timestampValid & boolean & Whether the "timestamp" field in the header structure (\ref{section:head…
136 partitionIDValid & boolean & Whether the "partitionID" field in the header structure (\ref{section:…
144 …type. Assigned GUIDs for types of CPER records are defined in UEFI Specification section N.2.1.1.\\
159 %Section descriptor structure.
160 \section{Section Descriptor Structure}
161 \label{section:sectiondescriptorstructure}
162 …section describes the JSON format of a single CPER record section descriptor as defined by section…
164 %Section descriptor structure table.
166 sectionOffset & uint64 & The offset (in bytes) of the section body this section descriptor describe…
168 sectionLength & uint64 & The length (in bytes) of the section body.\\
172 validationBits.fruIDValid & boolean & Whether the "fruID" field on this section descriptor contains…
173 validationBits.fruStringValid & boolean & Whether the "fruString" field on this section descriptor …
175 flags & object & A CPER section descriptor flags structure as described in Subsection \ref{subsecti…
177 sectionType.data & string & GUID data for the type of section body.\\
178 …e, for the type of section body. GUIDs for types of sectoin body are defined in UEFI specification…
180 fruID & string (\textbf{optional}) & If validation field set, the FRU ID of the section reporting t…
182 severity.code & uint64 & The integer value of the severity of the described section.\\
183 ….name & string & If available, the human readable name for the severity of the described section.\\
186 \jsontableend{Section descriptor structure field table.}
188 % Section descriptor flags.
189 \subsection{Section Descriptor Flags Structure}
191 This structure describes the enabled flags on a given CPER section descriptor.
193 primary & boolean & If true, indicates the section body should be associated with the error conditi…
201 …to conflicts with other system software or resources. Some fields of the section will be invalid.\\
208 \jsontableend{Section descriptor flags structure field table.}
211 \section{Generic CPER Structures}
212 This section describes generic CPER structures that are re-used throughout the specification.
227 This structure describes the a generic CPER error status, that can be used by any CPER section.
243 firstError & boolean & If multiple errors are logged for a single type of section, this indicates t…
249 \chapter{Section Specification}
251 This chapter defines section body formats for all of the sections defined within UEFI Specification…
253 % Generic processor error section.
254 \section{Generic Processor Error Section}
255 \label{section:genericprocessorerrorsection}
256 This section describes the JSON format for a single Generic Processor Error Section from a CPER rec…
266 …ng & If available, the human readable name of the type of processor error this section describes.\\
294 This structure describes the valdation bits structure of a General Processor Error CPER section.
296 … Whether the "processorType" field of the Generic Processor Error section (\ref{section:genericpro…
298 …& Whether the "processorISA" field of the Generic Processor Error section (\ref{section:genericpro…
300 …an & Whether the "errorType" field of the Generic Processor Error section (\ref{section:genericpro…
302 …an & Whether the "operation" field of the Generic Processor Error section (\ref{section:genericpro…
304 …oolean & Whether the "flags" field of the Generic Processor Error section (\ref{section:genericpro…
306 …n & Whether the "levelValid" field of the Generic Processor Error section (\ref{section:genericpro…
308 …n & Whether the "cpuVersion" field of the Generic Processor Error section (\ref{section:genericpro…
310 …& Whether the "cpuBrandInfo" field of the Generic Processor Error section (\ref{section:genericpro…
312 …oolean & Whether the "cpuID" field of the Generic Processor Error section (\ref{section:genericpro…
314 … Whether the "targetAddress" field of the Generic Processor Error section (\ref{section:genericpro…
316 … & Whether the "requestorID" field of the Generic Processor Error section (\ref{section:genericpro…
318 … & Whether the "responderID" field of the Generic Processor Error section (\ref{section:genericpro…
320 … Whether the "instructionIP" field of the Generic Processor Error section (\ref{section:genericpro…
326 This structure describes the flags structure of a General Processor Error CPER section.
337 % IA32/x64 error section.
338 \section{IA32/x64 Processor Error Section}
339 \label{section:ia32x64errorsection}
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.
358 …& boolean & Whether the "localAPICID" field of the IA32/x64 Error section (\ref{section:ia32x64err…
360 …d & boolean & Whether the "cpuidInfo" field of the IA32/x64 Error section (\ref{section:ia32x64err…
362 … (\ref{subsection:ia32x64processorerrorinfostructure}) that are included with this error section.\\
364 …\ref{subsection:ia32x64processorcontextinfostructure}) that are included with this error section.\\
370 This structure describes the CPUINFO structure of an IA32/x64 Error CPER section.
384 …a single IA32/x64 Processor Error Info sub-section, which is part of the larger IA32/x64 record (\…
391 …r \ref{subsection:ia32x64processorerrorcheckinfomscheckstructure}. Which section is placed here is…
552 …single IA32/x64 Processor Context Info sub-section, which is part of the larger IA32/x64 record (\…
708 % ARM processor error section.
709 \section{ARM Processor Error Section}
710 \label{section:armprocessorerrorsection}
711 This section describes the JSON format for a single ARM Processor Error Section from a CPER record.…
719 sectionLength & uint64 & The total size (in bytes) of this error section.\\
742 …s which fields are valid in a single ARM Processor Error structure (\ref{section:armprocessorerror…
744 … Whether the "mpidrEl1" field in the ARM Processor Error structure (\ref{section:armprocessorerror…
746 …her the "errorAffinity" field in the ARM Processor Error structure (\ref{section:armprocessorerror…
748 …& Whether the "running" field in the ARM Processor Error structure (\ref{section:armprocessorerror…
750 …or specific info (if present) in the ARM Processor Error Structure (\ref{section:armprocessorerror…
756 …r Info structure, as part of a whole ARM Processor Error structure (\ref{section:armprocessorerror…
931 …t Info structure, as part of a whole ARM Processor Error structure (\ref{section:armprocessorerror…
1282 % Memory error section.
1283 \section{Memory Error Section}
1284 \label{section:memoryerrorsection}
1285 This section describes the JSON format for a single Memory Error Section from a CPER record. The GU…
1334 This structure describes whether fields in a single Memory Error (\ref{section:memoryerrorsection})…
1336 errorStatusValid & boolean & Whether the "errorStatus" field of a Memory Error (\ref{section:memory…
1338 … & boolean & Whether the "physicalAddress" field of a Memory Error (\ref{section:memoryerrorsectio…
1340 …oolean & Whether the "physicalAddressMask" field of a Memory Error (\ref{section:memoryerrorsectio…
1342 nodeValid & boolean & Whether the "node" field of a Memory Error (\ref{section:memoryerrorsection})…
1344 cardValid & boolean & Whether the "card" field of a Memory Error (\ref{section:memoryerrorsection})…
1346 moduleValid & boolean & Whether the "module" field of a Memory Error (\ref{section:memoryerrorsecti…
1348 bankValid & boolean & Whether the "bank.value" field of a Memory Error (\ref{section:memoryerrorsec…
1350 deviceValid & boolean & Whether the "device" field of a Memory Error (\ref{section:memoryerrorsecti…
1352 rowValid & boolean & Whether the "row" field of a Memory Error (\ref{section:memoryerrorsection}) i…
1354 …d & boolean & Whether the memory platform target of a Memory Error (\ref{section:memoryerrorsectio…
1356 … & boolean & Whether the "memoryErrorType" field of a Memory Error (\ref{section:memoryerrorsectio…
1358 rankNumberValid & boolean & Whether the "rankNumber" field of a Memory Error (\ref{section:memoryer…
1360 cardHandleValid & boolean & Whether the "cardSmbiosHandle" field of a Memory Error (\ref{section:me…
1362 …boolean & Whether the "moduleSmbiosHandle" field of a Memory Error (\ref{section:memoryerrorsectio…
1364 …extended.rowBit16" and "extended.rowBit17" field of a Memory Error (\ref{section:memoryerrorsectio…
1366 bankGroupValid & boolean & Whether the "bank.group" field of a Memory Error (\ref{section:memoryerr…
1368 bankAddressValid & boolean & Whether the "bank.address" field of a Memory Error (\ref{section:memor…
1370 … Whether the "extended.chipIdentification" field of a Memory Error (\ref{section:memoryerrorsectio…
1376 This structure describes a simple bank address for a Memory Error section (\ref{section:memoryerror…
1384 This structure describes an address/group bank address for a Memory Error section (\ref{section:mem…
1391 % Memory error 2 section.
1392 \section{Memory Error 2 Section}
1393 \label{section:memoryerror2section}
1394 This section describes the JSON format for a single Memory Error 2 Section from a CPER record. The …
1444 This structure describes whether fields in a single Memory Error 2 (\ref{section:memoryerror2sectio…
1446 errorStatusValid & boolean & Whether the "errorStatus" field of a Memory Error 2 (\ref{section:memo…
1448 … boolean & Whether the "physicalAddress" field of a Memory Error 2 (\ref{section:memoryerror2secti…
1450 …lean & Whether the "physicalAddressMask" field of a Memory Error 2 (\ref{section:memoryerror2secti…
1452 nodeValid & boolean & Whether the "node" field of a Memory Error 2 (\ref{section:memoryerror2sectio…
1454 cardValid & boolean & Whether the "card" field of a Memory Error 2 (\ref{section:memoryerror2sectio…
1456 moduleValid & boolean & Whether the "module" field of a Memory Error 2 (\ref{section:memoryerror2se…
1458 bankValid & boolean & Whether the "bank.value" field of a Memory Error 2 (\ref{section:memoryerror2…
1460 deviceValid & boolean & Whether the "device" field of a Memory Error 2 (\ref{section:memoryerror2se…
1462 rowValid & boolean & Whether the "row" field of a Memory Error 2 (\ref{section:memoryerror2section}…
1464 columnValid & boolean & Whether the "column" field of a Memory Error 2 (\ref{section:memoryerror2se…
1466 rankValid & boolean & Whether the "rank" field of a Memory Error 2 (\ref{section:memoryerror2sectio…
1468 bitPositionValid & boolean & Whether the "bitPosition" field of a Memory Error 2 (\ref{section:memo…
1470 chipIDValid & boolean & Whether the "chipID" field of a Memory Error 2 (\ref{section:memoryerror2se…
1472 … boolean & Whether the "memoryErrorType" field of a Memory Error 2 (\ref{section:memoryerror2secti…
1474 statusValid & boolean & Whether the "status" field of a Memory Error 2 (\ref{section:memoryerror2se…
1476 requestorIDValid & boolean & Whether the "requestorID" field of a Memory Error 2 (\ref{section:memo…
1478 responderIDValid & boolean & Whether the "responderID" field of a Memory Error 2 (\ref{section:memo…
1480 targetIDValid & boolean & Whether the "targetID" field of a Memory Error 2 (\ref{section:memoryerro…
1482 cardHandleValid & boolean & Whether the "cardSmbiosHandle" field of a Memory Error 2 (\ref{section:…
1484 …olean & Whether the "moduleSmbiosHandle" field of a Memory Error 2 (\ref{section:memoryerror2secti…
1486 bankGroupValid & boolean & Whether the "bankGroup" field of a Memory Error 2 (\ref{section:memoryer…
1488 bankAddressValid & boolean & Whether the "bankAddress" field of a Memory Error 2 (\ref{section:memo…
1494 This structure describes a simple bank address for a Memory Error 2 section (\ref{section:memoryerr…
1502 This structure describes an address/group bank address for a Memory Error 2 section (\ref{section:m…
1509 % PCIe error section.
1510 \section{PCIe Error Section}
1511 \label{section:pcieerrorsection}
1512 This section describes the JSON format for a single PCIe Error Section from a CPER record. The GUID…
1542 This structure describes which fields within a PCIe Error section (\ref{section:pcieerrorsection}) …
1544 portTypeValid & boolean & Whether the "portType" field within a PCIe Error section (\ref{section:pc…
1546 versionValid & boolean & Whether the "version" field within a PCIe Error section (\ref{section:pcie…
1548 …& boolean & Whether the "commandStatus" field within a PCIe Error section (\ref{section:pcieerrors…
1550 deviceIDValid & boolean & Whether the "deviceID" field within a PCIe Error section (\ref{section:pc…
1552 …lean & Whether the "deviceSerialNumber" field within a PCIe Error section (\ref{section:pcieerrors…
1554 …ean & Whether the "bridgeControlStatus" field within a PCIe Error section (\ref{section:pcieerrors…
1556 …ean & Whether the "capabilityStructure" field within a PCIe Error section (\ref{section:pcieerrors…
1558 aerInfoValid & boolean & Whether the "aerInfo" field within a PCIe Error section (\ref{section:pcie…
1565 This structure describes a PCIe device ID, for use in a PCI Error section (\ref{table:pcieerrorsect…
1589 …ed Error Reporting Extended Capability structure, for use in a PCI Error section (\ref{table:pciee…
1618 % PCI/PCI-X Bus error section.
1619 \section{PCI/PCI-X Bus Error Section}
1620 \label{section:pcibuserrorsection}
1621 This section describes the JSON format for a single PCI/PCI-X Bus Error Section from a CPER record.…
1649 This structure describes which fields within a PCI/PCI-X Bus Error section (\ref{section:pcibuserro…
1651 …lean & Whether the "errorStatus" field of the PCI/PCI-X Bus Error section (\ref{section:pcibuserro…
1653 …oolean & Whether the "errorType" field of the PCI/PCI-X Bus Error section (\ref{section:pcibuserro…
1655 busIDValid & boolean & Whether the "busID" field of the PCI/PCI-X Bus Error section (\ref{section:p…
1657 …olean & Whether the "busAddress" field of the PCI/PCI-X Bus Error section (\ref{section:pcibuserro…
1659 … boolean & Whether the "busData" field of the PCI/PCI-X Bus Error section (\ref{section:pcibuserro…
1661 …n & Whether the "busCommandType" field of the PCI/PCI-X Bus Error section (\ref{section:pcibuserro…
1663 …n & Whether the "busRequestorID" field of the PCI/PCI-X Bus Error section (\ref{section:pcibuserro…
1665 …n & Whether the "busCompleterID" field of the PCI/PCI-X Bus Error section (\ref{section:pcibuserro…
1667 …boolean & Whether the "targetID" field of the PCI/PCI-X Bus Error section (\ref{section:pcibuserro…
1670 % PCI/PCI-X Component error section.
1671 \section{PCI/PCI-X Component Error Section}
1672 \label{section:pcicomponenterrorsection}
1673 This section describes the JSON format for a single PCI/PCI-X Component Error Section from a CPER r…
1691 This structure describes which fields within a PCI/PCI-X Component Error section (\ref{section:pcic…
1693 … Whether the "errorStatus" field of the PCI/PCI-X Component Error section (\ref{section:pcicompone…
1695 …ean & Whether the "idInfo" field of the PCI/PCI-X Component Error section (\ref{section:pcicompone…
1697 …Whether the "memoryNumber" field of the PCI/PCI-X Component Error section (\ref{section:pcicompone…
1699 …n & Whether the "ioNumber" field of the PCI/PCI-X Component Error section (\ref{section:pcicompone…
1701 …er the "registerDataPairs" field of the PCI/PCI-X Component Error section (\ref{section:pcicompone…
1707 …single PCI/PCI-X component for use in a PCI/PCI-X Component Error section (\ref{section:pcicompone…
1727 …from a PCI/PCI-X component for use in a PCI/PCI-X Component Error section (\ref{section:pcicompone…
1734 % Firmware error section.
1735 \section{Firmware Error Section}
1736 \label{section:firmwareerrorsection}
1737 This section describes the JSON format for a single Firmware Error Section from a CPER record. The …
1746 recordIDGUID & string & GUID of the firmware error record referenced by this section. \textbf{This …
1749 % Generic DMAr error section.
1750 \section{Generic DMAr Error Section}
1751 \label{section:dmargenericerrorsection}
1752 This section describes the JSON format for a single Generic DMAr Error Section from a CPER record. …
1774 % VT-d DMAr error section.
1775 \section{VT-d DMAr Error Section}
1776 \label{section:vtddmarerrorsection}
1777 This section describes the JSON format for a single VT-d DMAr Error Section from a CPER record. The…
1817 …ibes a fault record, which forms part of a single VT-d DMAr Error section (\ref{section:vtddmarerr…
1839 % IOMMU DMAr error section.
1840 \section{IOMMU DMAr Error Section}
1841 \label{section:iommudmarerrorsection}
1842 This section describes the JSON format for a single IOMMU DMAr Error Section from a CPER record. Th…
1867 % CCIX PER error section.
1868 \section{CCIX PER Error Section}
1869 \label{section:ccixpererrorsection}
1870 This section describes the JSON format for a single CCIX PER Error Section from a CPER record. The …
1880 …e64-represented binary dump of the CCIX PER Log structure, as defined in Section 7.3.2 of the CCIX…
1886 This structure describes which fields are valid in a CCIX PER Error section (\ref{section:ccixperer…
1888 … boolean & Whether the "ccixSourceID" field in the CCIX PER Error Section (\ref{section:ccixpererr…
1890 … & boolean & Whether the "ccixPortID" field in the CCIX PER Error Section (\ref{section:ccixpererr…
1892 … & boolean & Whether the "ccixPERLog" field in the CCIX PER Error Section (\ref{section:ccixpererr…
1895 % CXL Protocol error section.
1896 \section{CXL Protocol Error Section}
1897 \label{section:cxlprotocolerrorsection}
1898 This section describes the JSON format for a single CXL Protocol Error Section from a CPER record. …
1925 This structure describes which fields are valid in a CXL Protocol Error section (\ref{section:cxlpr…
1927 …lean & Whether the "cxlAgentType" field in the CXL Protocol Error section (\ref{section:cxlprotoco…
1929 …n & Whether the "cxlAgentAddress" field in the CXL Protocol Error section (\ref{section:cxlprotoco…
1931 … boolean & Whether the "deviceID" field in the CXL Protocol Error section (\ref{section:cxlprotoco…
1933 …lean & Whether the "deviceSerial" field in the CXL Protocol Error section (\ref{section:cxlprotoco…
1935 …Whether the "capabilityStructure" field in the CXL Protocol Error section (\ref{section:cxlprotoco…
1937 … boolean & Whether the "cxlDVSEC" field in the CXL Protocol Error section (\ref{section:cxlprotoco…
1939 …olean & Whether the "cxlErrorLog" field in the CXL Protocol Error section (\ref{section:cxlprotoco…
1945 …ess of a single CXL device agent, for use in a CXL Protocol Error section (\ref{section:cxlprotoco…
1959 …e describes an RCRB base address, for use in a CXL Protocol Error section (\ref{section:cxlprotoco…
1967 …describes the ID of a CXL device, for use in a CXL Protocol Error section (\ref{section:cxlprotoco…
1982 % CXL Component error section.
1983 \section{CXL Component Error Section}
1984 \label{section:cxlcomponenterrorsection}
1985 This section describes the JSON format for a single CXL Component Error Section from a CPER record.…
2003 …binary dump of the CXL Component Event Log as described within CXL Specification Section 8.2.9.1.\\
2009 This structure describes which fields are valid in a CXL Component Error section (\ref{section:cxlc…
2011 …boolean & Whether the "deviceID" field of the CXL Component Error section (\ref{section:cxlcompone…
2013 …ean & Whether the "deviceSerial" field of the CXL Component Error section (\ref{section:cxlcompone…
2015 …ether the "cxlComponentEventLog" field of the CXL Component Error section (\ref{section:cxlcompone…
2021 …ribes the ID of a CXL component, for use in a CXL Component Error section (\ref{section:cxlcompone…
2038 % Undefined error section.
2039 \section{Undefined Error Section}
2040 \label{section:undefinederrorsection}
2041 This section describes the JSON format for a single undefined CPER section. This structure is used …
2043 data & string & A base64-encoded binary dump of the undefined CPER section.\\