xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Inventory/Item/PCIeDevice.interface.yaml (revision e4a64ba768a675937bcb41c5e74098c26de1d5e2)
1description: >
2    This defines a PCIe device to be exposed for system management.  It includes
3    the device properties and function properties for all 8 possible functions
4    that are needed for the device identification. The PCIe function's
5    properties are deprecated, they have been replaced with PCIeFunction
6    interface.
7
8properties:
9    - name: DeviceType
10      type: enum[self.DeviceTypes]
11      default: "Unknown"
12      description: >
13          Indicates if the device type is MultiFunction/Retimer/Simulated or
14          SingleFunction.
15    - name: GenerationInUse
16      type: enum[xyz.openbmc_project.Inventory.Item.PCIeSlot.Generations]
17      default: "Unknown"
18      description: >
19          The PCIe interface generation in use by the device.
20    - name: GenerationSupported
21      type: enum[xyz.openbmc_project.Inventory.Item.PCIeSlot.Generations]
22      default: "Unknown"
23      description: >
24          The maximum PCIe generation supported by the device.
25
26    - name: Function0ClassCode
27      type: string
28      description: >
29          The Class Code for this function. This property is deprecated, it has
30          been replaced with PCIeFunction interface.
31    - name: Function0DeviceClass
32      type: string
33      description: >
34          The Device Class for this function. This property is deprecated, it
35          has been replaced with PCIeFunction interface.
36    - name: Function0DeviceId
37      type: string
38      description: >
39          The Device ID for this function. This property is deprecated, it has
40          been replaced with PCIeFunction interface.
41    - name: Function0FunctionType
42      type: string
43      description: >
44          Indicates if the function is Physical or Virtual This property is
45          deprecated, it has been replaced with PCIeFunction interface.
46    - name: Function0RevisionId
47      type: string
48      description: >
49          The Revision ID for this function. This property is deprecated, it has
50          been replaced with PCIeFunction interface.
51    - name: Function0SubsystemId
52      type: string
53      description: >
54          The Subsystem ID for this function. This property is deprecated, it
55          has been replaced with PCIeFunction interface.
56    - name: Function0SubsystemVendorId
57      type: string
58      description: >
59          The Subsystem Vendor ID for this function. This property is
60          deprecated, it has been replaced with PCIeFunction interface.
61    - name: Function0VendorId
62      type: string
63      description: >
64          The Vendor ID for this function. This property is deprecated, it has
65          been replaced with PCIeFunction interface.
66
67    - name: Function1ClassCode
68      type: string
69      description: >
70          The Class Code for this function. This property is deprecated, it has
71          been replaced with PCIeFunction interface.
72    - name: Function1DeviceClass
73      type: string
74      description: >
75          The Device Class for this function. This property is deprecated, it
76          has been replaced with PCIeFunction interface.
77    - name: Function1DeviceId
78      type: string
79      description: >
80          The Device ID for this function. This property is deprecated, it has
81          been replaced with PCIeFunction interface.
82    - name: Function1FunctionType
83      type: string
84      description: >
85          Indicates if the function is Physical or Virtual This property is
86          deprecated, it has been replaced with PCIeFunction interface.
87    - name: Function1RevisionId
88      type: string
89      description: >
90          The Revision ID for this function. This property is deprecated, it has
91          been replaced with PCIeFunction interface.
92    - name: Function1SubsystemId
93      type: string
94      description: >
95          The Subsystem ID for this function. This property is deprecated, it
96          has been replaced with PCIeFunction interface.
97    - name: Function1SubsystemVendorId
98      type: string
99      description: >
100          The Subsystem Vendor ID for this function. This property is
101          deprecated, it has been replaced with PCIeFunction interface.
102    - name: Function1VendorId
103      type: string
104      description: >
105          The Vendor ID for this function. This property is deprecated, it has
106          been replaced with PCIeFunction interface.
107
108    - name: Function2ClassCode
109      type: string
110      description: >
111          The Class Code for this function. This property is deprecated, it has
112          been replaced with PCIeFunction interface.
113    - name: Function2DeviceClass
114      type: string
115      description: >
116          The Device Class for this function. This property is deprecated, it
117          has been replaced with PCIeFunction interface.
118    - name: Function2DeviceId
119      type: string
120      description: >
121          The Device ID for this function. This property is deprecated, it has
122          been replaced with PCIeFunction interface.
123    - name: Function2FunctionType
124      type: string
125      description: >
126          Indicates if the function is Physical or Virtual This property is
127          deprecated, it has been replaced with PCIeFunction interface.
128    - name: Function2RevisionId
129      type: string
130      description: >
131          The Revision ID for this function. This property is deprecated, it has
132          been replaced with PCIeFunction interface.
133    - name: Function2SubsystemId
134      type: string
135      description: >
136          The Subsystem ID for this function. This property is deprecated, it
137          has been replaced with PCIeFunction interface.
138    - name: Function2SubsystemVendorId
139      type: string
140      description: >
141          The Subsystem Vendor ID for this function. This property is
142          deprecated, it has been replaced with PCIeFunction interface.
143    - name: Function2VendorId
144      type: string
145      description: >
146          The Vendor ID for this function. This property is deprecated, it has
147          been replaced with PCIeFunction interface.
148
149    - name: Function3ClassCode
150      type: string
151      description: >
152          The Class Code for this function. This property is deprecated, it has
153          been replaced with PCIeFunction interface.
154    - name: Function3DeviceClass
155      type: string
156      description: >
157          The Device Class for this function. This property is deprecated, it
158          has been replaced with PCIeFunction interface.
159    - name: Function3DeviceId
160      type: string
161      description: >
162          The Device ID for this function. This property is deprecated, it has
163          been replaced with PCIeFunction interface.
164    - name: Function3FunctionType
165      type: string
166      description: >
167          Indicates if the function is Physical or Virtual This property is
168          deprecated, it has been replaced with PCIeFunction interface.
169    - name: Function3RevisionId
170      type: string
171      description: >
172          The Revision ID for this function. This property is deprecated, it has
173          been replaced with PCIeFunction interface.
174    - name: Function3SubsystemId
175      type: string
176      description: >
177          The Subsystem ID for this function. This property is deprecated, it
178          has been replaced with PCIeFunction interface.
179    - name: Function3SubsystemVendorId
180      type: string
181      description: >
182          The Subsystem Vendor ID for this function. This property is
183          deprecated, it has been replaced with PCIeFunction interface.
184    - name: Function3VendorId
185      type: string
186      description: >
187          The Vendor ID for this function. This property is deprecated, it has
188          been replaced with PCIeFunction interface.
189
190    - name: Function4ClassCode
191      type: string
192      description: >
193          The Class Code for this function. This property is deprecated, it has
194          been replaced with PCIeFunction interface.
195    - name: Function4DeviceClass
196      type: string
197      description: >
198          The Device Class for this function. This property is deprecated, it
199          has been replaced with PCIeFunction interface.
200    - name: Function4DeviceId
201      type: string
202      description: >
203          The Device ID for this function. This property is deprecated, it has
204          been replaced with PCIeFunction interface.
205    - name: Function4FunctionType
206      type: string
207      description: >
208          Indicates if the function is Physical or Virtual This property is
209          deprecated, it has been replaced with PCIeFunction interface.
210    - name: Function4RevisionId
211      type: string
212      description: >
213          The Revision ID for this function. This property is deprecated, it has
214          been replaced with PCIeFunction interface.
215    - name: Function4SubsystemId
216      type: string
217      description: >
218          The Subsystem ID for this function. This property is deprecated, it
219          has been replaced with PCIeFunction interface.
220    - name: Function4SubsystemVendorId
221      type: string
222      description: >
223          The Subsystem Vendor ID for this function. This property is
224          deprecated, it has been replaced with PCIeFunction interface.
225    - name: Function4VendorId
226      type: string
227      description: >
228          The Vendor ID for this function. This property is deprecated, it has
229          been replaced with PCIeFunction interface.
230
231    - name: Function5ClassCode
232      type: string
233      description: >
234          The Class Code for this function. This property is deprecated, it has
235          been replaced with PCIeFunction interface.
236    - name: Function5DeviceClass
237      type: string
238      description: >
239          The Device Class for this function. This property is deprecated, it
240          has been replaced with PCIeFunction interface.
241    - name: Function5DeviceId
242      type: string
243      description: >
244          The Device ID for this function. This property is deprecated, it has
245          been replaced with PCIeFunction interface.
246    - name: Function5FunctionType
247      type: string
248      description: >
249          Indicates if the function is Physical or Virtual This property is
250          deprecated, it has been replaced with PCIeFunction interface.
251    - name: Function5RevisionId
252      type: string
253      description: >
254          The Revision ID for this function. This property is deprecated, it has
255          been replaced with PCIeFunction interface.
256    - name: Function5SubsystemId
257      type: string
258      description: >
259          The Subsystem ID for this function. This property is deprecated, it
260          has been replaced with PCIeFunction interface.
261    - name: Function5SubsystemVendorId
262      type: string
263      description: >
264          The Subsystem Vendor ID for this function. This property is
265          deprecated, it has been replaced with PCIeFunction interface.
266    - name: Function5VendorId
267      type: string
268      description: >
269          The Vendor ID for this function. This property is deprecated, it has
270          been replaced with PCIeFunction interface.
271
272    - name: Function6ClassCode
273      type: string
274      description: >
275          The Class Code for this function. This property is deprecated, it has
276          been replaced with PCIeFunction interface.
277    - name: Function6DeviceClass
278      type: string
279      description: >
280          The Device Class for this function. This property is deprecated, it
281          has been replaced with PCIeFunction interface.
282    - name: Function6DeviceId
283      type: string
284      description: >
285          The Device ID for this function. This property is deprecated, it has
286          been replaced with PCIeFunction interface.
287    - name: Function6FunctionType
288      type: string
289      description: >
290          Indicates if the function is Physical or Virtual This property is
291          deprecated, it has been replaced with PCIeFunction interface.
292    - name: Function6RevisionId
293      type: string
294      description: >
295          The Revision ID for this function. This property is deprecated, it has
296          been replaced with PCIeFunction interface.
297    - name: Function6SubsystemId
298      type: string
299      description: >
300          The Subsystem ID for this function. This property is deprecated, it
301          has been replaced with PCIeFunction interface.
302    - name: Function6SubsystemVendorId
303      type: string
304      description: >
305          The Subsystem Vendor ID for this function. This property is
306          deprecated, it has been replaced with PCIeFunction interface.
307    - name: Function6VendorId
308      type: string
309      description: >
310          The Vendor ID for this function. This property is deprecated, it has
311          been replaced with PCIeFunction interface.
312
313    - name: Function7ClassCode
314      type: string
315      description: >
316          The Class Code for this function. This property is deprecated, it has
317          been replaced with PCIeFunction interface.
318    - name: Function7DeviceClass
319      type: string
320      description: >
321          The Device Class for this function. This property is deprecated, it
322          has been replaced with PCIeFunction interface.
323    - name: Function7DeviceId
324      type: string
325      description: >
326          The Device ID for this function. This property is deprecated, it has
327          been replaced with PCIeFunction interface.
328    - name: Function7FunctionType
329      type: string
330      description: >
331          Indicates if the function is Physical or Virtual This property is
332          deprecated, it has been replaced with PCIeFunction interface.
333    - name: Function7RevisionId
334      type: string
335      description: >
336          The Revision ID for this function. This property is deprecated, it has
337          been replaced with PCIeFunction interface.
338    - name: Function7SubsystemId
339      type: string
340      description: >
341          The Subsystem ID for this function. This property is deprecated, it
342          has been replaced with PCIeFunction interface.
343    - name: Function7SubsystemVendorId
344      type: string
345      description: >
346          The Subsystem Vendor ID for this function. This property is
347          deprecated, it has been replaced with PCIeFunction interface.
348    - name: Function7VendorId
349      type: string
350      description: >
351          The Vendor ID for this function. This property is deprecated, it has
352          been replaced with PCIeFunction interface.
353
354    - name: MaxLanes
355      type: size
356      default: 0
357      description: >
358          The maximum number of PCIe lanes supported by the PCIe Device
359
360    - name: LanesInUse
361      type: size
362      default: maxint
363      description: >
364          The number of PCIe lanes in use by this device. Default value of
365          maxint is to accommodate the situation where the value of this
366          property is not known due to some unknown reason, like hardware
367          failure. The value of 0 indicates that the link is not active.
368
369enumerations:
370    - name: DeviceTypes
371      description: >
372          Possible Device Type
373      values:
374          - name: MultiFunction
375            description: >
376                Indicates if the device is MultiFunction
377          - name: Retimer
378            description: >
379                Indicate if the device is Retimer
380          - name: Simulated
381            description: >
382                Indicates if the device is Simulated
383          - name: SingleFunction
384            description: >
385                Indicates if the device is Single Function
386          - name: Unknown
387            description: >
388                Indicates if the device is Unknown
389
390associations:
391    - name: upstream_pcie_slot
392      description: >
393          Objects that implement PCIeDevice can optionally implement the
394          upstream_pcie_slot association to provide a link back to a PCIe slot.
395      reverse_names:
396          - associated_pcie_device
397      required_endpoint_interfaces:
398          - xyz.openbmc_project.Inventory.Item.PCIeSlot
399
400    - name: exposing
401      description: >
402          Objects that implement PCIeDevice can optionally implement the
403          upstexposing association to provide a link back to a PCIe function.
404      reverse_names:
405          - exposed_by
406      required_endpoint_interfaces: xyz.openbmc_project.Inventory.Item.PCIeFunction
407