blob: 1c50637fd557ce5f0a7d3b433cab581046374a45 [file] [log] [blame]
Deepak Kodihallife0e3012020-05-15 03:53:33 -05001description: >
2 Implement to represent a PLDM Entity (see chapter 9 of
3 www.dmtf.org/sites/default/files/standards/documents/DSP0248_1.2.0.pdf).
4
5 Any OpenBMC implementation must add this interface on a D-Bus object that
6 represents a PLDM Entity. For example, if an app is creating D-Bus objects
7 consisting of PLDM FRU fields (DSP0257) as D-Bus properties, to be then
8 converted to inventory D-Bus objects (by apps like EM and PIM), then the app
9 may implement this interface. In this example, this interface helps identify
10 what the FRU's type is, in addition to instance and containment information.
11
12 PLDM stands for Platform Level Data Model. More information about PLDM (and
13 MCTP) can be found at https://www.dmtf.org/standards/pmci
14
15properties:
16 - name: EntityType
17 type: uint16
18 description: >
19 Represents the type of the entity. See 9.2 in DSP0248 v1.2.0.
20 - name: EntityInstanceNumber
21 type: uint16
22 description: >
23 Represents the instance number of the entity. See 9.3 in DSP0248
24 v1.2.0.
25 - name: ContainerID
26 type: uint16
27 description: >
28 Represents the ID of the containing entity of this entity. See 9.4 in
29 DSP0248 v1.2.0.