specification/document/cper-json-specification.tex

7 \title{CPER-JSON Specification}
47  in a human-readable JSON format, intended to be interoperable with standard CPER binary.
50 …ive JSON schema\footnote{As defined by \href{https://json-schema.org/draft/2020-12/json-schema-cor…
178 …ypes of sectoin body are defined in UEFI specification section N.2.2 Table N-5 and section N.2.4.\\
180 fruID & string (\textbf{optional}) & If validation field set, the FRU ID of the section reporting t…
197 reset & boolean & If true, indicates the component has been reset and must be re-initialised or re-…
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.
284 requestorID & uint64 & ID of the requestor associated with the error.\\
286 responderID & uint64 & ID of the responder associated with the error.\\
344 localAPICID & uint64 & The APIC ID of the processor.\\
384 This structure describes a single IA32/x64 Processor Error Info sub-section, which is part of the l…
552 This structure describes a single IA32/x64 Processor Context Info sub-section, which is part of the…
705 data & string & A base64-formatted binary representation of the register array.\\
724 mpidrEl1 & uint64 & The processor ID (\texttt{MPIDR\_EL1}) for this error.\\
726 midrEl1 & uint64 & The chip ID (\texttt{MIDR\_EL1}) for this error.\\
730 … is false. Cannot be made human readable, as this could either be in the pre-PSCI 1.0 format, or t…
736 vendorSpecificInfo.data & string (\textbf{optional}) & If it exists, a base64-encoded binary repres…
886 accessMode.value & int & The raw value of the access mode of the bus request (secure/normal).\\
887 …g & The human readable name, if available, of the access mode of the bus request (secure/normal).\\
923 …ture is used when the \texttt{type} field of that structure has a value other than 0-2 (inclusive).
1074 % ARM AARCH32 Secure Registers structure
1075 \subsection{ARM AARCH32 Secure Registers Structure}
1077 This structure describes the register array for AARCH32 secure registers as part of an ARM Processo…
1082 \jsontableend{ARM AARCH32 Secure Registers structure field table.}
1277 …ncluded when the field \texttt{registerContextType.value} has any value other than 0-8 (inclusive).
1298 extended.chipIdentification & int & The ID of the related chip.\\
1304 node & uint64 & Identifies the node containing the memory error, if in a multi-node system.\\
1412 node & uint64 & Identifies the node containing the memory error, if in a multi-node system.\\
1525 deviceID & object & A PCIe Device ID structure as defined in Subsection \ref{subsection:pciedevicei…
1533 …-64 formatted binary dump of the PCIe capability structure for this device. The structure could ei…
1536 aerInfo.data & string & A base64-formatted representation of a PCIe AER Extended Capability structu…
1562 % PCIe Device ID structure.
1563 \subsection{PCIe Device ID Structure}
1565 This structure describes a PCIe device ID, for use in a PCI Error section (\ref{table:pcieerrorsect…
1567 vendorID & uint64 & The vendor ID of the PCIe device.\\
1569 deviceID & uint64 & The device ID of the PCIe device.\\
1584 \jsontableend{PCIe Device ID structure field table.}
1591 % capabilityID & uint64 & The capability ID for this AER structure.\\
1607 % headerLogRegister & string & A base64-encoded binary dump of the header log register.\\
1613 % errorSourceIDRegister & uint64 & The error source ID register.\\
1615 % correctableErrorSourceIDRegister & uint64 & The correctable error source ID register.\\
1618 % PCI/PCI-X Bus error section.
1619 \section{PCI/PCI-X Bus Error Section}
1621 …cribes the JSON format for a single PCI/PCI-X Bus Error Section from a CPER record. The GUID used …
1623 validationBits & object & A PCI/PCI-X Bus Error Validation structure, as described in Subsection \r…
1630 busID.busNumber & int & The bus number of this bus ID.\\
1631 busID.segmentNumber & int & The segment number of this bus ID.\\
1637 busCommandType & string & The type of command at the time of the error. Either "PCI" or "PCI-X".\\
1639 busRequestorID & uint64 & The PCI bus requestor ID for the error.\\
1641 busCompleterID & uint64 & The PCI bus completer ID for the error.\\
1643 targetID & uint64 & The PCI bus intended target ID for the error.\\
1644 \jsontableend{PCI/PCI-X Bus Error structure field table.}
1646 % PCI/PCI-X Bus error validation structure.
1647 \subsection{PCI/PCI-X Bus Error Validation Structure}
1649 This structure describes which fields within a PCI/PCI-X Bus Error section (\ref{section:pcibuserro…
1651 errorStatusValid & boolean & Whether the "errorStatus" field of the PCI/PCI-X Bus Error section (\r…
1653 errorTypeValid & boolean & Whether the "errorType" field of the PCI/PCI-X Bus Error section (\ref{s…
1655 busIDValid & boolean & Whether the "busID" field of the PCI/PCI-X Bus Error section (\ref{section:p…
1657 busAddressValid & boolean & Whether the "busAddress" field of the PCI/PCI-X Bus Error section (\ref…
1659 busDataValid & boolean & Whether the "busData" field of the PCI/PCI-X Bus Error section (\ref{secti…
1661 commandValid & boolean & Whether the "busCommandType" field of the PCI/PCI-X Bus Error section (\re…
1663 requestorIDValid & boolean & Whether the "busRequestorID" field of the PCI/PCI-X Bus Error section …
1665 completerIDValid & boolean & Whether the "busCompleterID" field of the PCI/PCI-X Bus Error section …
1667 targetIDValid & boolean & Whether the "targetID" field of the PCI/PCI-X Bus Error section (\ref{sec…
1668 \jsontableend{PCI/PCI-X Bus Error validation structure field table.}
1670 % PCI/PCI-X Component error section.
1671 \section{PCI/PCI-X Component Error Section}
1673 …bes the JSON format for a single PCI/PCI-X Component Error Section from a CPER record. The GUID us…
1675 validationBits & object & A PCI/PCI-X Component Error Validation structure, as defined in Subsectio…
1679 idInfo & object & A PCI/PCI-X Component ID structure, as defined in Subsection \ref{subsection:pcic…
1681 memoryNumber & uint64 & The number of PCI/PCI-X component memory mapped register address/data pair …
1683 ioNumber & uint64 & The number of PCI/PCI-X component programmed I/O register address/data pair val…
1685 registerDataPairs & array & An array of PCI/PCI-X Component Register Pair structures, as defined in…
1686 \jsontableend{PCI/PCI-X Component Error structure field table.}
1688 % PCI/PCI-X Component error validation structure.
1689 \subsection{PCI/PCI-X Component Error Validation Structure}
1691 This structure describes which fields within a PCI/PCI-X Component Error section (\ref{section:pcic…
1693 errorStatusValid & boolean & Whether the "errorStatus" field of the PCI/PCI-X Component Error secti…
1695 idInfoValid & boolean & Whether the "idInfo" field of the PCI/PCI-X Component Error section (\ref{s…
1697 memoryNumberValid & boolean & Whether the "memoryNumber" field of the PCI/PCI-X Component Error sec…
1699 ioNumberValid & boolean & Whether the "ioNumber" field of the PCI/PCI-X Component Error section (\r…
1701 registerDataPairsValid & boolean & Whether the "registerDataPairs" field of the PCI/PCI-X Component…
1702 \jsontableend{PCI/PCI-X Component Error validation structure field table.}
1704 % PCI/PCI-X Component ID structure.
1705 \subsection{PCI/PCI-X Component ID Structure}
1707 This structure describes the ID of a single PCI/PCI-X component for use in a PCI/PCI-X Component Er…
1709 vendorID & uint64 & The vendor ID of this PCI/PCI-X component.\\
1711 deviceID & uint64 & The device ID of this PCI/PCI-X component.\\
1713 classCode & uint64 & The class code of this PCI/PCI-X component.\\
1715 functionNumber & uint64 & The function number of this PCI/PCI-X component.\\
1717 deviceNumber & uint64 & The device number of this PCI/PCI-X component.\\
1719 busNumber & uint64 & The bus number of this PCI/PCI-X component.\\
1721 segmentNumber & uint64 & The segment number of this PCI/PCI-X component.\\
1722 \jsontableend{PCI/PCI-X Component ID structure field table.}
1724 % PCI/PCI-X Component Register Pair structure.
1725 \subsection{PCI/PCI-X Component Register Pair Structure}
1727 …ructure describes a single pair of registers from a PCI/PCI-X component for use in a PCI/PCI-X Com…
1732 \jsontableend{PCI/PCI-X Component Register Pair structure field table.}
1754 requesterID & int & The device ID associated with the fault condition.\\
1771 deviceAddress & uint64 & The 64-bit device virtual address contained in the faulted DMA request.\\
1774 % VT-d DMAr error section.
1775 \section{VT-d DMAr Error Section}
1777 …ion describes the JSON format for a single VT-d DMAr Error Section from a CPER record. The GUID us…
1779 version & int & Version register value as defined in the VT-d specification.\\
1781 revision & int & Revision field in VT-d specific DMA remapping reporting structure.\\
1783 oemID & uint64 & OEM ID field in VT-d specific DMA remapping reporting structure.\\
1785 capabilityRegister & uint64 & Value of VT-d capability register.\\
1787 extendedCapabilityRegister & uint64 & Value of VT-d extended capability register.\\
1789 globalCommandRegister & uint64 & Value of VT-d global command register.\\
1791 globalStatusRegister & uint64 & Value of VT-d global status register.\\
1793 faultStatusRegister & uint64 & Value of VT-d fault status register.\\
1795 faultRecord & object & A VT-d DMAR Fault Record structure, as defined in Subsection \ref{subsection…
1797 rootEntry & string & A base64-represented binary dump of the root entry table for the associated re…
1799 contextEntry & string & A base64-represented binary dump of the context entry table for the associa…
1812 \jsontableend{VT-d DMAr Error structure field table.}
1814 % VT-d DMAR Fault Record structure.
1815 \subsection{VT-d DMAR Fault Record Structure}
1817 This structure describes a fault record, which forms part of a single VT-d DMAr Error section (\ref…
1819 faultInformation & uint64 & Fault information field as defined in the VT-d specification.\\
1821 sourceIdentifier & uint64 & Identifier of the source of the VT-d fault.\\
1829 faultReason & uint64 & The reason for the VT-d fault, as defined in the VT-d specification.\\
1833 addressType & uint64 & The addressing type of the fault, as defined by the VT-d specification.\\
1835 type.value & uint64 & The raw value of the type of VT-d fault record.\\
1836 type.name & string & The human readable name, if available, of the type of VT-d fault record.\\
1837 \jsontableend{VT-d DMAR Fault Record structure field table.}
1839 % IOMMU DMAr error section.
1840 \section{IOMMU DMAr Error Section}
1842 …on describes the JSON format for a single IOMMU DMAr Error Section from a CPER record. The GUID us…
1844 revision & int & The IOMMU specification revision.\\
1846 controlRegister & uint64 & The IOMMU control register value.\\
1848 statusRegister & uint64 & The IOMMU status register value.\\
1850 eventLogEntry & string & A base-64 binary dump of the IOMMU fault-related event log entry, as defin…
1852 deviceTableEntry & string & A base-64 representation of the value from the device table for a given…
1865 \jsontableend{IOMMU DMAr Error structure field table.}
1876 … SA, or RA, this indicates the CCIX Agent ID of the reporting component. Otherwise, this is the CC…
1878 ccixPortID & int & The CCIX Port ID that reported this error.\\
1880 ccixPERLog & string & A base64-represented binary dump of the CCIX PER Log structure, as defined in…
1907 deviceID & object & A CXL Device ID structure, as defined in Subsection \ref{subsection:cxlprotocol…
1911 …-encoded binary dump of the CXL device's PCIe capability structure. This could either be a PCIe 1.…
1917 cxlDVSEC & string & A base64-encoded dump of the CXL DVSEC structure. For CXL 1.1 devices, this is …
1919 cxlErrorLog & string & A base64-encoded dump of the CXL error log. This field contains a copy of "C…
1964 % CXL Protocol Device ID structure.
1965 \subsection{CXL Protocol Device ID Structure}
1967 This structure describes the ID of a CXL device, for use in a CXL Protocol Error section (\ref{sect…
1969 vendorID & uint64 & The vendor ID of the CXL device.\\
1971 deviceID & uint64 & The device ID of the CXL device.\\
1973 subsystemVendorID & uint64 & The subsystem vendor ID of the CXL device.\\
1975 subsystemDeviceID & uint64 & The subsystem device ID of the CXL device.\\
1980 \jsontableend{CXL Protocol Device ID structure field table.}
1999 deviceID & object & A CXL Component Device ID structure as described in Subsection \ref{subsection:…
2003 …\texttt{validationBits.cxlComponentEventLogValid} is true), this is a base64-represented binary du…
2018 % CXL Component Device ID structure.
2019 \subsection{CXL Component Device ID Structure}
2021 This structure describes the ID of a CXL component, for use in a CXL Component Error section (\ref{…
2023 vendorID & uint64 & The vendor ID of the CXL component.\\
2025 deviceID & uint64 & The device ID of the CXL component.\\
2036 \jsontableend{CXL Component Device ID structure field table.}
2043 data & string & A base64-encoded binary dump of the undefined CPER section.\\