Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / ed76121b40dc3a2aa7925a108e92cf37c2f49792 / . / static / redfish / v1 / JsonSchemas / PCIeDevice / PCIeDevice.json
blob: 7dc32750a25475581aad289316c890bf0579dee4 [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]1{
Sui Chen141d9432022-02-03 22:01:27 -0800[diff] [blame]2 "$id": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.v1_9_0.json",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]3 "$ref": "#/definitions/PCIeDevice",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]4 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]5 "copyright": "Copyright 2014-2021 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]6 "definitions": {
7 "Actions": {
8 "additionalProperties": false,
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]9 "description": "The available actions for this resource.",
10 "longDescription": "This type shall contain the available actions for this resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]11 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]12 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]13 "description": "This property shall specify a valid odata or Redfish property.",
14 "type": [
15 "array",
16 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]17 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]18 "number",
19 "null",
20 "object",
21 "string"
22 ]
23 }
24 },
25 "properties": {
26 "Oem": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]27 "$ref": "#/definitions/OemActions",
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]28 "description": "The available OEM-specific actions for this resource.",
29 "longDescription": "This property shall contain the available OEM-specific actions for this resource.",
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]30 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]31 }
32 },
33 "type": "object"
34 },
35 "DeviceType": {
36 "enum": [
37 "SingleFunction",
38 "MultiFunction",
39 "Simulated"
40 ],
41 "enumDescriptions": {
42 "MultiFunction": "A multi-function PCIe device.",
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]43 "Simulated": "A PCIe device that is not currently physically present, but is being simulated by the PCIe infrastructure.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]44 "SingleFunction": "A single-function PCIe device."
45 },
46 "type": "string"
47 },
Sui Chen141d9432022-02-03 22:01:27 -0800[diff] [blame]48 "LaneSplittingType": {
49 "enum": [
50 "None",
51 "Bridged",
52 "Bifurcated"
53 ],
54 "enumDescriptions": {
55 "Bifurcated": "The slot is bifurcated to split the lanes with associated devices.",
56 "Bridged": "The slot has a bridge to share the lanes with associated devices.",
57 "None": "The slot has no lane splitting."
58 },
59 "type": "string"
60 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]61 "Links": {
62 "additionalProperties": false,
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]63 "description": "The links to other resources that are related to this resource.",
64 "longDescription": "This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]65 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]66 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]67 "description": "This property shall specify a valid odata or Redfish property.",
68 "type": [
69 "array",
70 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]71 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]72 "number",
73 "null",
74 "object",
75 "string"
76 ]
77 }
78 },
79 "properties": {
80 "Chassis": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]81 "description": "An array of links to the chassis in which the PCIe device is contained.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]82 "items": {
83 "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis"
84 },
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]85 "longDescription": "This property shall contain an array of links to resources of type Chassis that represent the physical containers associated with this resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]86 "readonly": true,
87 "type": "array"
88 },
89 "Chassis@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]90 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]91 },
92 "Oem": {
93 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]94 "description": "The OEM extension property.",
95 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]96 },
97 "PCIeFunctions": {
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]98 "deprecated": "This property has been deprecated in favor of the PCIeFunctions property in the root that provides a link to a resource collection.",
99 "description": "An array of links to PCIe functions exposed by this device.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]100 "items": {
101 "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction"
102 },
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]103 "longDescription": "This property shall contain an array of links to resources of type PCIeFunction that represent the PCIe functions this device exposes.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]104 "readonly": true,
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]105 "type": "array",
106 "versionDeprecated": "v1_4_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]107 },
108 "PCIeFunctions@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]109 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]110 }
111 },
112 "type": "object"
113 },
114 "OemActions": {
115 "additionalProperties": true,
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]116 "description": "The available OEM-specific actions for this resource.",
117 "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]118 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]119 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]120 "description": "This property shall specify a valid odata or Redfish property.",
121 "type": [
122 "array",
123 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]124 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]125 "number",
126 "null",
127 "object",
128 "string"
129 ]
130 }
131 },
132 "properties": {},
133 "type": "object"
134 },
135 "PCIeDevice": {
136 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]137 "description": "The PCIeDevice schema describes the properties of a PCIe device that is attached to a system.",
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]138 "longDescription": "This resource shall represent a PCIe device in a Redfish implementation.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]139 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]140 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]141 "description": "This property shall specify a valid odata or Redfish property.",
142 "type": [
143 "array",
144 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]145 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]146 "number",
147 "null",
148 "object",
149 "string"
150 ]
151 }
152 },
153 "properties": {
154 "@odata.context": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]155 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]156 },
157 "@odata.etag": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]158 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]159 },
160 "@odata.id": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]161 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]162 },
163 "@odata.type": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]164 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]165 },
166 "Actions": {
167 "$ref": "#/definitions/Actions",
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]168 "description": "The available actions for this resource.",
169 "longDescription": "The actions property shall contain the available actions for this resource.",
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]170 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]171 },
172 "Assembly": {
173 "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly",
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]174 "description": "The link to the assembly associated with this PCIe device.",
175 "longDescription": "This property shall contain a link to a resource of type Assembly.",
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]176 "readonly": true,
177 "versionAdded": "v1_2_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]178 },
179 "AssetTag": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]180 "description": "The user-assigned asset tag for this PCIe device.",
181 "longDescription": "This property shall contain an identifying string that tracks the PCIe device for inventory purposes.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]182 "readonly": false,
183 "type": [
184 "string",
185 "null"
186 ]
187 },
188 "Description": {
189 "anyOf": [
190 {
191 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
192 },
193 {
194 "type": "null"
195 }
196 ],
197 "readonly": true
198 },
199 "DeviceType": {
200 "$ref": "#/definitions/DeviceType",
201 "description": "The device type for this PCIe device.",
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]202 "longDescription": "This property shall contain the device type of the PCIe device such as `SingleFunction` or `MultiFunction`.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]203 "readonly": true
204 },
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]205 "EnvironmentMetrics": {
206 "$ref": "http://redfish.dmtf.org/schemas/v1/EnvironmentMetrics.json#/definitions/EnvironmentMetrics",
207 "description": "The link to the environment metrics for this PCIe device.",
208 "longDescription": "This property shall contain a link to a resource of type EnvironmentMetrics that specifies the environment metrics for this PCIe device.",
209 "readonly": true,
210 "versionAdded": "v1_7_0"
211 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]212 "FirmwareVersion": {
213 "description": "The version of firmware for this PCIe device.",
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]214 "longDescription": "This property shall contain the firmware version of the PCIe device.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]215 "readonly": true,
216 "type": [
217 "string",
218 "null"
219 ]
220 },
221 "Id": {
222 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
223 "readonly": true
224 },
225 "Links": {
226 "$ref": "#/definitions/Links",
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]227 "description": "The links to other resources that are related to this resource.",
228 "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]229 },
230 "Manufacturer": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]231 "description": "The manufacturer of this PCIe device.",
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]232 "longDescription": "This property shall contain the name of the organization responsible for producing the PCIe device. This organization may be the entity from whom the PCIe device is purchased, but this is not necessarily true.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]233 "readonly": true,
234 "type": [
235 "string",
236 "null"
237 ]
238 },
239 "Model": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]240 "description": "The model number for the PCIe device.",
241 "longDescription": "This property shall contain the name by which the manufacturer generally refers to the PCIe device.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]242 "readonly": true,
243 "type": [
244 "string",
245 "null"
246 ]
247 },
248 "Name": {
249 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
250 "readonly": true
251 },
252 "Oem": {
253 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]254 "description": "The OEM extension property.",
255 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
256 },
257 "PCIeFunctions": {
258 "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunctionCollection.json#/definitions/PCIeFunctionCollection",
259 "description": "The link to the collection of PCIe functions associated with this PCIe device.",
260 "longDescription": "This property shall contain a link to a Resource Collection of type PCIeFunctionCollection.",
261 "readonly": true,
262 "versionAdded": "v1_4_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]263 },
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]264 "PCIeInterface": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]265 "$ref": "#/definitions/PCIeInterface",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]266 "description": "The PCIe interface details for this PCIe device.",
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]267 "longDescription": "This property shall contain details for the PCIe interface that connects this PCIe device to its host or upstream switch.",
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]268 "versionAdded": "v1_3_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]269 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]270 "PartNumber": {
271 "description": "The part number for this PCIe device.",
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]272 "longDescription": "This property shall contain a part number assigned by the organization that is responsible for producing or manufacturing the PCIe device.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]273 "readonly": true,
274 "type": [
275 "string",
276 "null"
277 ]
278 },
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]279 "ReadyToRemove": {
280 "description": "An indication of whether the PCIe device is prepared by the system for removal.",
281 "longDescription": "This property shall indicate whether the PCIe device is ready for removal. Setting the value to `true` shall cause the service to perform appropriate actions to quiesce the device. A task may spawn while the device is quiescing.",
282 "readonly": false,
283 "type": [
284 "boolean",
285 "null"
286 ],
287 "versionAdded": "v1_7_0"
288 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]289 "SKU": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]290 "description": "The SKU for this PCIe device.",
291 "longDescription": "This property shall contain the stock-keeping unit number for this PCIe device.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]292 "readonly": true,
293 "type": [
294 "string",
295 "null"
296 ]
297 },
298 "SerialNumber": {
299 "description": "The serial number for this PCIe device.",
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]300 "longDescription": "This property shall contain a manufacturer-allocated number that identifies the PCIe device.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]301 "readonly": true,
302 "type": [
303 "string",
304 "null"
305 ]
306 },
Sui Chen141d9432022-02-03 22:01:27 -0800[diff] [blame]307 "Slot": {
308 "anyOf": [
309 {
310 "$ref": "#/definitions/Slot"
311 },
312 {
313 "type": "null"
314 }
315 ],
316 "description": "Information about the slot for this PCIe device.",
317 "longDescription": "This property shall contain information about the PCIe slot for this PCIe device.",
318 "versionAdded": "v1_9_0"
319 },
Gunnar Mills262d7d42021-01-20 16:28:41 -0600[diff] [blame]320 "SparePartNumber": {
321 "description": "The spare part number of the PCIe device.",
322 "longDescription": "This property shall contain the spare part number of the PCIe device.",
323 "readonly": true,
324 "type": [
325 "string",
326 "null"
327 ],
328 "versionAdded": "v1_6_0"
329 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]330 "Status": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]331 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]332 "description": "The status and health of the resource and its subordinate or dependent resources.",
333 "longDescription": "This property shall contain any status or health properties of the resource."
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]334 },
335 "UUID": {
336 "anyOf": [
337 {
338 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/UUID"
339 },
340 {
341 "type": "null"
342 }
343 ],
344 "description": "The UUID for this PCIe device.",
345 "longDescription": "This property shall contain the universal unique identifier number for this PCIe device.",
346 "readonly": true,
347 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]348 }
349 },
350 "required": [
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]351 "@odata.id",
352 "@odata.type",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]353 "Id",
354 "Name"
355 ],
356 "type": "object"
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]357 },
Gunnar Mills60c922d2021-12-01 09:28:53 -0600[diff] [blame]358 "PCIeErrors": {
359 "additionalProperties": false,
360 "description": "The PCIe errors associated with this device.",
361 "longDescription": "This property shall contain properties that describe the PCIe errors associated with this device.",
362 "patternProperties": {
363 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
364 "description": "This property shall specify a valid odata or Redfish property.",
365 "type": [
366 "array",
367 "boolean",
368 "integer",
369 "number",
370 "null",
371 "object",
372 "string"
373 ]
374 }
375 },
376 "properties": {
377 "CorrectableErrorCount": {
378 "description": "The total number of the PCIe correctable errors for this device.",
379 "longDescription": "This property shall contain the total number of the PCIe correctable errors for this device.",
380 "readonly": true,
381 "type": [
382 "integer",
383 "null"
384 ],
385 "versionAdded": "v1_8_0"
386 },
387 "FatalErrorCount": {
388 "description": "The total number of the PCIe fatal errors for this device.",
389 "longDescription": "This property shall contain the total number of the PCIe fatal errors for this device.",
390 "readonly": true,
391 "type": [
392 "integer",
393 "null"
394 ],
395 "versionAdded": "v1_8_0"
396 },
397 "L0ToRecoveryCount": {
398 "description": "The total number of times the PCIe link states transitioned from L0 to the recovery state for this device.",
399 "longDescription": "This property shall contain the total number of times the PCIe link transitioned from L0 to the recovery state for this device.",
400 "readonly": true,
401 "type": [
402 "integer",
403 "null"
404 ],
405 "versionAdded": "v1_8_0"
406 },
407 "NAKReceivedCount": {
408 "description": "The total number of NAKs issued on the PCIe link by the receiver.",
409 "longDescription": "This property shall contain the total number of NAKs issued on the PCIe link by the receiver. A NAK is issued by the receiver when it detects that a TLP from this device was missed. This could be because this device did not transmit it, or because the receiver could not properly decode the packet.",
410 "readonly": true,
411 "type": [
412 "integer",
413 "null"
414 ],
415 "versionAdded": "v1_8_0"
416 },
417 "NAKSentCount": {
418 "description": "The total number of NAKs issued on the PCIe link by this device.",
419 "longDescription": "This property shall contain the total number of NAKs issued on the PCIe link by this device. A NAK is issued by the device when it detects that a TLP from the receiver was missed. This could be because the receiver did not transmit it, or because this device could not properly decode the packet.",
420 "readonly": true,
421 "type": [
422 "integer",
423 "null"
424 ],
425 "versionAdded": "v1_8_0"
426 },
427 "NonFatalErrorCount": {
428 "description": "The total number of the PCIe non-fatal errors for this device.",
429 "longDescription": "This property shall contain the total number of the PCIe non-fatal errors for this device.",
430 "readonly": true,
431 "type": [
432 "integer",
433 "null"
434 ],
435 "versionAdded": "v1_8_0"
436 },
437 "ReplayCount": {
438 "description": "The total number of the PCIe replays issued by this device.",
439 "longDescription": "This property shall contain the total number of the replays issued on the PCIe link by this device. A replay is a retransmission of a TLP and occurs because the ACK timer is expired, which means that the receiver did not send the ACK or this device did not properly decode the ACK.",
440 "readonly": true,
441 "type": [
442 "integer",
443 "null"
444 ],
445 "versionAdded": "v1_8_0"
446 },
447 "ReplayRolloverCount": {
448 "description": "The total number of the PCIe replay rollovers issued by this device.",
449 "longDescription": "This property shall contain the total number of the replay rollovers issued on the PCIe link by this device. A replay rollover occurs when consecutive replays failed to resolve the errors on the link, which means that this device forced the link into the recovery state.",
450 "readonly": true,
451 "type": [
452 "integer",
453 "null"
454 ],
455 "versionAdded": "v1_8_0"
456 }
457 },
458 "type": "object"
459 },
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]460 "PCIeInterface": {
461 "additionalProperties": false,
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]462 "description": "Properties that describe a PCIe interface.",
463 "longDescription": "This type shall contain the definition for a PCIe interface for a Redfish implementation.",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]464 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]465 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]466 "description": "This property shall specify a valid odata or Redfish property.",
467 "type": [
468 "array",
469 "boolean",
470 "integer",
471 "number",
472 "null",
473 "object",
474 "string"
475 ]
476 }
477 },
478 "properties": {
479 "LanesInUse": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]480 "description": "The number of PCIe lanes in use by this device.",
481 "longDescription": "This property shall contain the number of PCIe lanes in use by this device, which shall be equal to or less than the MaxLanes property value.",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]482 "maximum": 32,
483 "readonly": true,
484 "type": [
485 "integer",
486 "null"
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]487 ],
488 "versionAdded": "v1_3_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]489 },
490 "MaxLanes": {
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]491 "description": "The number of PCIe lanes supported by this device.",
492 "longDescription": "This property shall contain the maximum number of PCIe lanes supported by this device.",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]493 "maximum": 32,
494 "readonly": true,
495 "type": [
496 "integer",
497 "null"
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]498 ],
499 "versionAdded": "v1_3_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]500 },
501 "MaxPCIeType": {
502 "anyOf": [
503 {
504 "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeTypes"
505 },
506 {
507 "type": "null"
508 }
509 ],
510 "description": "The highest version of the PCIe specification supported by this device.",
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]511 "longDescription": "This property shall contain the maximum PCIe specification that this device supports.",
512 "readonly": true,
513 "versionAdded": "v1_3_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]514 },
515 "Oem": {
516 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]517 "description": "The OEM extension property.",
518 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements.",
519 "versionAdded": "v1_3_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]520 },
521 "PCIeType": {
522 "anyOf": [
523 {
524 "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeTypes"
525 },
526 {
527 "type": "null"
528 }
529 ],
530 "description": "The version of the PCIe specification in use by this device.",
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]531 "longDescription": "This property shall contain the negotiated PCIe interface version in use by this device.",
532 "readonly": true,
533 "versionAdded": "v1_3_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]534 }
535 },
536 "type": "object"
Sui Chen141d9432022-02-03 22:01:27 -0800[diff] [blame]537 },
538 "Slot": {
539 "additionalProperties": false,
540 "description": "The PCIe slot associated with a PCIe device.",
541 "longDescription": "This object shall contain properties that describe the PCIe slot associated with a PCIe device.",
542 "patternProperties": {
543 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
544 "description": "This property shall specify a valid odata or Redfish property.",
545 "type": [
546 "array",
547 "boolean",
548 "integer",
549 "number",
550 "null",
551 "object",
552 "string"
553 ]
554 }
555 },
556 "properties": {
557 "LaneSplitting": {
558 "anyOf": [
559 {
560 "$ref": "#/definitions/LaneSplittingType"
561 },
562 {
563 "type": "null"
564 }
565 ],
566 "description": "The lane splitting strategy used in the PCIe slot.",
567 "longDescription": "This property shall contain lane splitting information of the associated PCIe slot.",
568 "readonly": true,
569 "versionAdded": "v1_9_0"
570 },
571 "Lanes": {
572 "description": "The number of PCIe lanes supported by this slot.",
573 "longDescription": "This property shall contain the maximum number of PCIe lanes supported by the slot.",
574 "maximum": 32,
575 "readonly": true,
576 "type": [
577 "integer",
578 "null"
579 ],
580 "versionAdded": "v1_9_0"
581 },
582 "Location": {
583 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location",
584 "description": "The location of the PCIe slot.",
585 "longDescription": "This property shall contain part location information, including a ServiceLabel property, of the associated PCIe slot.",
586 "versionAdded": "v1_9_0"
587 },
588 "PCIeType": {
589 "anyOf": [
590 {
591 "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeTypes"
592 },
593 {
594 "type": "null"
595 }
596 ],
597 "description": "The PCIe specification this slot supports.",
598 "longDescription": "This property shall contain the maximum PCIe specification that this slot supports.",
599 "readonly": true,
600 "versionAdded": "v1_9_0"
601 },
602 "SlotType": {
603 "anyOf": [
604 {
605 "$ref": "#/definitions/SlotType"
606 },
607 {
608 "type": "null"
609 }
610 ],
611 "description": "The PCIe slot type.",
612 "longDescription": "This property shall contain the PCIe slot type.",
613 "readonly": true,
614 "versionAdded": "v1_9_0"
615 }
616 },
617 "type": "object"
618 },
619 "SlotType": {
620 "enum": [
621 "FullLength",
622 "HalfLength",
623 "LowProfile",
624 "Mini",
625 "M2",
626 "OEM",
627 "OCP3Small",
628 "OCP3Large",
629 "U2"
630 ],
631 "enumDescriptions": {
632 "FullLength": "Full-Length PCIe slot.",
633 "HalfLength": "Half-Length PCIe slot.",
634 "LowProfile": "Low-Profile or Slim PCIe slot.",
635 "M2": "PCIe M.2 slot.",
636 "Mini": "Mini PCIe slot.",
637 "OCP3Large": "Open Compute Project 3.0 large form factor slot.",
638 "OCP3Small": "Open Compute Project 3.0 small form factor slot.",
639 "OEM": "An OEM-specific slot.",
640 "U2": "U.2 / SFF-8639 slot or bay."
641 },
642 "type": "string"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]643 }
644 },
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]645 "owningEntity": "DMTF",
Sui Chen141d9432022-02-03 22:01:27 -0800[diff] [blame]646 "release": "2021.4",
647 "title": "#PCIeDevice.v1_9_0.PCIeDevice"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]648}