CPER JSON Schema Descriptions
Descriptions populated based on UEFI Appendix N in JSON Schemas
Change-Id: I765ec81913567ba7f32c39fdbd901483d9d78e21
Signed-off-by: Andrew Adriance <aadriance@nvidia.com>
diff --git a/specification/json/sections/cper-cxl-protocol.json b/specification/json/sections/cper-cxl-protocol.json
index bc46245..8d70e83 100644
--- a/specification/json/sections/cper-cxl-protocol.json
+++ b/specification/json/sections/cper-cxl-protocol.json
@@ -1,6 +1,7 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
+ "description": "Compute Express Link (CXL) Protocol Error Section",
"required": [
"validationBits",
"agentType",
@@ -15,6 +16,7 @@
"properties": {
"validationBits": {
"type": "object",
+ "description": "Indiciates what fields in the section are valid",
"required": [
"cxlAgentTypeValid",
"cxlAgentAddressValid",
@@ -50,10 +52,12 @@
},
"agentType": {
"type": "object",
+ "description": "CXL Agent Type",
"$ref": "./common/cper-json-nvp.json"
},
"cxlAgentAddress": {
"type": "object",
+ "description": "CXL Agent depedent address to uniquely identify the component",
"oneOf": [
{
"$id": "cper-json-cxlagentaddress0",
@@ -93,6 +97,7 @@
},
"deviceID": {
"type": "object",
+ "description": "Provides devices specific identifies.",
"required": [
"vendorID",
"deviceID",
@@ -123,22 +128,28 @@
}
},
"deviceSerial": {
- "type": "integer"
+ "type": "integer",
+ "description": "CXL Agent device serial number"
},
"capabilityStructure": {
- "type": "string"
+ "type": "string",
+ "description": "The PCIe Capability Structure of the agent"
},
"dvsecLength": {
- "type": "integer"
+ "type": "integer",
+ "description": "The length in bytes of the CXL DVSEC field"
},
"errorLogLength": {
- "type": "integer"
+ "type": "integer",
+ "description": "The length in bytes of the CXL Error Log field"
},
"cxlDVSEC": {
- "type": "string"
+ "type": "string",
+ "description": "Contains the DVSEC structure as defined in the CXL specification"
},
"cxlErrorLog": {
- "type": "string"
+ "type": "string",
+ "description": "This field contains a copy of the “CXL RAS Capability Structure”, as defined in the CXL Specification."
}
}
}