specification/document/cper-json-specification.tex

7 \title{CPER-JSON Specification}
12 Revision v0.0.1 (\today)\endgraf
13 First revision released [DATE].}}
19     \label{#1}
32     \label{table:#1}
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…
55 \label{section:parentstructuretype1}
69 \label{section:parentstructuretype2}
82 \label{section:headerstructure}
88 revision & object & A CPER revision object structure as defined in Subsection \ref{subsection:revis…
119 \label{subsection:headererrorseveritystructure}
129 \label{subsection:headervalidbitfieldstructure}
141 \label{subsection:notificationtypestructure}
151 \label{subsection:headerflagsstructure}
161 \label{section:sectiondescriptorstructure}
170 revision & object & A CPER revision structure as defined in Subsection \ref{subsection:revisionstru…
178 …ypes of sectoin body are defined in UEFI specification section N.2.2 Table N-5 and section N.2.4.\\
190 \label{subsection:sectiondescriptorflagsstructure}
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.
214 % Revision.
215 \subsection{Revision Structure}
216 \label{subsection:revisionstructure}
217 This structure describes the revision of a single CPER record or sub-structure.
219 major & int & The major version number. An increase in this revision indicates the changes are not …
222 \jsontableend{CPER revision structure field table.}
226 \label{subsection:genericerrorstatusstructure}
250 \label{chapter:sectionchapter}
255 \label{section:genericprocessorerrorsection}
293 \label{subsection:genericprocessorvalidationstructure}
325 \label{subsection:genericprocessorflagsstructure}
339 \label{section:ia32x64errorsection}
355 \label{subsection:ia32x64processorflagsstructure}
369 \label{subsection:ia32x64cpuinfostructure}
383 \label{subsection:ia32x64processorerrorinfostructure}
384 This structure describes a single IA32/x64 Processor Error Info sub-section, which is part of the l…
404 \label{subsection:ia32x64processorerrorinfovalidationstructure}
421 \label{subsection:ia32x64processorerrorcheckinfocachetlbstructure}
448 \label{subsection:ia32x64processorerrorcheckinfobusstructure}
483 \label{subsection:ia32x64processorerrorcheckinfomscheckstructure}
505 \label{subsection:ia32x64processorerrorcheckinfovalidationstructure}
533 \label{subsection:ia32x64processorerrorcheckinfomscheckvalidationstructure}
551 \label{subsection:ia32x64processorcontextinfostructure}
552 This structure describes a single IA32/x64 Processor Context Info sub-section, which is part of the…
568 \label{subsection:ia32x64ia32registerstatestructure}
624 \label{subsection:ia32x64x64registerstatestructure}
702 \label{subsection:ia32x64unformattedregisterstatestructure}
705 data & string & A base64-formatted binary representation of the register array.\\
710 \label{section:armprocessorerrorsection}
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…
741 \label{subsection:armprocessorerrorvalidationstructure}
755 \label{subsection:armprocessorerrorinfostructure}
781 \label{subsection:armprocessorerrorinfovalidationstructure}
797 \label{subsection:armprocessorerrorinfoflagsstructure}
811 \label{subsection:armprocessorerrorinfoerrorinformationcachetlbstructure}
835 \label{subsection:armprocessorerrorinfocachetlbvalidationstructure}
855 \label{subsection:armprocessorerrorinfoerrorinformationbusstructure}
892 \label{subsection:armprocessorerrorinfobusvalidationstructure}
922 \label{subsection:armprocessorerrorinfoerrorinformationmicroarchundefinedstructure}
923 …ture is used when the \texttt{type} field of that structure has a value other than 0-2 (inclusive).
930 \label{subsection:armprocessorcontextinfostructure}
945 \label{subsection:armaarch32gprstructure}
983 \label{subsection:armaarch32el1contextregistersstructure}
1037 \label{subsection:armaarch32el2contextregistersstructure}
1076 \label{subsection:armaarch32secureregistersstructure}
1086 \label{subsection:armaarch64gprstructure}
1156 \label{subsection:armaarch64el1contextregistersstructure}
1196 \label{subsection:armaarch64el2contextregistersstructure}
1232 \label{subsection:armaarch64el3contextregistersstructure}
1258 \label{subsection:armmiscregistersstructure}
1276 \label{subsection:armunknownregistersstructure}
1277 …ncluded when the field \texttt{registerContextType.value} has any value other than 0-8 (inclusive).
1284 \label{section:memoryerrorsection}
1304 node & uint64 & Identifies the node containing the memory error, if in a multi-node system.\\
1333 \label{subsection:memoryerrorvalidationstructure}
1375 \label{subsection:memoryerrorstandardbankaddressstructure}
1383 \label{subsection:memoryerroraddressgroupbankaddressstructure}
1393 \label{section:memoryerror2section}
1412 node & uint64 & Identifies the node containing the memory error, if in a multi-node system.\\
1443 \label{subsection:memoryerror2validationstructure}
1493 \label{subsection:memoryerror2standardbankaddressstructure}
1501 \label{subsection:memoryerror2addressgroupbankaddressstructure}
1511 \label{section:pcieerrorsection}
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…
1541 \label{subsection:pcieerrorvalidationstructure}
1564 \label{subsection:pciedeviceidstructure}
1588 % \label{subsection:pcieaerecstructure}
1607 % headerLogRegister & string & A base64-encoded binary dump of the header log register.\\
1618 % PCI/PCI-X Bus error section.
1619 \section{PCI/PCI-X Bus Error Section}
1620 \label{section:pcibuserrorsection}
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…
1637 busCommandType & string & The type of command at the time of the error. Either "PCI" or "PCI-X".\\
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}
1648 \label{subsection:pcibuserrorvalidationstructure}
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}
1672 \label{section:pcicomponenterrorsection}
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}
1690 \label{subsection:pcicomponenterrorvalidationstructure}
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}
1706 \label{subsection:pcicomponentidstructure}
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}
1726 \label{subsection:pcicomponentregisterpairstructure}
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.}
1736 \label{section:firmwareerrorsection}
1742 revision & int & The header revision of this record. For the referenced UEFI specification, this va…
1744 recordID & uint64 & Identifier for the referenced firmware error record. When the \texttt{revision}…
1751 \label{section:dmargenericerrorsection}
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}
1776 \label{section:vtddmarerrorsection}
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}
1816 \label{subsection:vtddmarfaultrecordstructure}
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.}
1841 \label{section:iommudmarerrorsection}
1844 revision & int & The IOMMU specification revision.\\
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…
1869 \label{section:ccixpererrorsection}
1880 ccixPERLog & string & A base64-represented binary dump of the CCIX PER Log structure, as defined in…
1885 \label{subsection:ccixpervalidationstructure}
1897 \label{section:cxlprotocolerrorsection}
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…
1924 \label{subsection:cxlprotocolvalidationstructure}
1944 \label{subsection:cxlprotocoldeviceagentaddressstructure}
1958 \label{subsection:cxlprotocolrcrbaddressstructure}
1966 \label{subsection:cxlprotocoldeviceidstructure}
1984 \label{section:cxlcomponenterrorsection}
2003 …\texttt{validationBits.cxlComponentEventLogValid} is true), this is a base64-represented binary du…
2008 \label{subsection:cxlcomponentvalidationstructure}
2020 \label{subsection:cxlcomponentdeviceidstructure}
2040 \label{section:undefinederrorsection}
2043 data & string & A base64-encoded binary dump of the undefined CPER section.\\