xref: /openbmc/libcper/specification/json/sections/cper-nvidia-event.json (revision 51c1813200b42fa35d49eb0c214339ac479f090d)
1{
2    "$schema": "https://json-schema.org/draft/2020-12/schema",
3    "type": "object",
4    "description": "Nvidia Event Section - Structured event format for NVIDIA devices",
5    "required": ["eventHeader", "eventInfo", "eventContexts"],
6    "additionalProperties": false,
7    "properties": {
8        "eventHeader": {
9            "type": "object",
10            "description": "Event header containing event metadata and identification",
11            "required": [
12                "signature",
13                "version",
14                "sourceDeviceType",
15                "type",
16                "subtype"
17            ],
18            "additionalProperties": false,
19            "properties": {
20                "signature": {
21                    "type": "string",
22                    "description": "Event signature string"
23                },
24                "version": {
25                    "type": "integer",
26                    "description": "Event header version number",
27                    "minimum": 0
28                },
29                "sourceDeviceType": {
30                    "type": "integer",
31                    "description": "Source device type",
32                    "minimum": 0,
33                    "maximum": 5
34                },
35                "type": {
36                    "type": "integer",
37                    "description": "Event type code",
38                    "minimum": 0
39                },
40                "subtype": {
41                    "type": "integer",
42                    "description": "Event subtype code",
43                    "minimum": 0
44                },
45                "linkId": {
46                    "type": "integer",
47                    "description": "Event link identifier for correlation",
48                    "minimum": 0
49                }
50            }
51        },
52        "eventInfo": {
53            "type": "object",
54            "description": "Device-specific event information structure (varies by sourceDeviceType)",
55            "oneOf": [
56                { "$ref": "./sections/cper-nvidia-event-info-cpu.json" },
57                { "$ref": "./sections/cper-nvidia-event-info-gpu.json" }
58            ]
59        },
60        "eventContexts": {
61            "type": "array",
62            "description": "Array of event context objects containing error details",
63            "items": {
64                "type": "object",
65                "description": "Individual event context with header and data",
66                "required": [
67                    "version",
68                    "dataFormatType",
69                    "dataFormatVersion",
70                    "dataSize",
71                    "data"
72                ],
73                "additionalProperties": false,
74                "properties": {
75                    "version": { "type": "integer", "minimum": 0 },
76                    "dataFormatType": { "type": "integer", "minimum": 0 },
77                    "dataFormatVersion": { "type": "integer", "minimum": 0 },
78                    "dataSize": { "type": "integer", "minimum": 0 },
79                    "data": {
80                        "type": "object",
81                        "oneOf": [
82                            {
83                                "$ref": "./sections/cper-nvidia-event-data-opaque.json"
84                            },
85                            {
86                                "$ref": "./sections/cper-nvidia-event-data-type1.json"
87                            },
88                            {
89                                "$ref": "./sections/cper-nvidia-event-data-type2.json"
90                            },
91                            {
92                                "$ref": "./sections/cper-nvidia-event-data-type3.json"
93                            },
94                            {
95                                "$ref": "./sections/cper-nvidia-event-data-type4.json"
96                            },
97                            {
98                                "$ref": "./sections/cper-nvidia-event-data-gpu-metadata.json"
99                            },
100                            {
101                                "$ref": "./sections/cper-nvidia-event-data-gpu-legacy-xid.json"
102                            },
103                            {
104                                "$ref": "./sections/cper-nvidia-event-data-gpu-recommended-actions.json"
105                            }
106                        ]
107                    }
108                }
109            }
110        }
111    }
112}
113