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/cper-json-section-descriptor.json b/specification/json/cper-json-section-descriptor.json
index 2b4b080..f408522 100644
--- a/specification/json/cper-json-section-descriptor.json
+++ b/specification/json/cper-json-section-descriptor.json
@@ -2,6 +2,7 @@
"$id": "cper-json-section-descriptor",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
+ "description": "Common Platform Record Section Descriptor as defined in UEFI Appendix N section 2.2",
"required": [
"sectionOffset",
"sectionLength",
@@ -14,13 +15,16 @@
"additionalProperties": false,
"properties": {
"sectionOffset": {
- "type": "integer"
+ "type": "integer",
+ "description": "Offset in bytes of the section body from the base of the record header."
},
"sectionLength": {
- "type": "integer"
+ "type": "integer",
+ "description": "The length in bytes of the section body."
},
"revision": {
"type": "object",
+ "description": "This is a 2-byte field representing a major and minor version number for the error record definition in BCD format.",
"required": ["major", "minor"],
"properties": {
"major": {
@@ -35,6 +39,7 @@
},
"validationBits": {
"type": "object",
+ "description": "This field indicates the validity of other feilds in this descriptor.",
"required": ["fruIDValid", "fruStringValid"],
"properties": {
"fruIDValid": {
@@ -59,33 +64,42 @@
],
"properties": {
"primary": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If set, identifies the section as the section to be associated with the error condition."
},
"containmentWarning": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If set, the error was not contained within the processor or memory hierarchy and the error may have propagated to persistent storage or network."
},
"reset": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If set, the component has been reset and must be re-initialized or re-enabled by the operating system prior to use."
},
"errorThresholdExceeded": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If set, OS may choose to discontinue use of this resource."
},
"resourceNotAccessible": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If set, the resource could not be queried for error information due to conflicts with other system software or resources."
},
"latentError": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If set this flag indicates that action has been taken to ensure error containment"
},
"propagated": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If set this flag indicates the section is to be associated with an error that has been propagated due to hardware poisoning."
},
"overflow": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If set this flag indicates the firmware has detected an overflow of buffers/queues that are used to accumulate, collect, or report errors"
}
}
},
"sectionType": {
"type": "object",
+ "description": "This field holds a pre-assigned GUID value indicating that it is a section of a particular error.",
"required": ["data", "type"],
"properties": {
"data": {
@@ -98,10 +112,12 @@
}
},
"fruID": {
- "type": "string"
+ "type": "string",
+ "description": "GUID representing the FRU ID, if it exists, for the section reporting the error. The default value is zero indicating an invalid FRU ID."
},
"severity": {
"type": "object",
+ "description": "This field indicates the severity associated with the error section.",
"required": ["code", "name"],
"properties": {
"code": {
@@ -114,7 +130,8 @@
}
},
"fruText": {
- "type": "string"
+ "type": "string",
+ "description": "ASCII string identifying the FRU hardware."
}
}
}