blob: 7dc47bfb8fb1ee54b66510faa17aa4aa3c88668b [file] [log] [blame]
Deepak Kodihallife0e3012020-05-15 03:53:33 -05001description: >
2 Implement to represent a PLDM FRU (
3 www.dmtf.org/sites/default/files/standards/documents/DSP0257_1.0.0.pdf).
4 This interface is composed of standard (not OEM) FRU field type (FRU
5 properties) definitions from table 5 in DSP0257.
6
7 Caveat: This interface is primarily for consumption by the PLDM FRU format
8 producer apps (for eg the PLDM daemon) and apps that transform specific FRU
9 formats to Inventory information, such as Entity Manager and Phosphor
10 Inventory Manager.
11
12 An OpenBMC implementation that wants to process a PLDM FRU record table
13 received by a connected PLDM entity must add this interface on a D-Bus
14 object that represents a PLDM FRU definition - a set of properties and their
15 values for the FRU. Typically such an app would parse PLDM FRU records and
16 relay the parsed information onto D-Bus. If the value of a certain standard
17 FRU field is missing in the FRU record, then the corresponding D-Bus
18 property in this interface will have a default value.
19
20 The proposal in https://gerrit.openbmc-project.xyz/#/c/openbmc/docs/+/32532
21 will make use of this interface.
22
23 PLDM stands for Platform Level Data Model. More information about PLDM (and
24 MCTP) can be found at https://www.dmtf.org/standards/pmci
25
26properties:
27 - name: ChassisType
28 type: string
29 description: >
30 Chassis type of the FRU. Can be empty if the FRU is not a chassis.
31 - name: Model
32 type: string
33 description: >
34 Model of the FRU.
35 - name: PN
36 type: string
37 description: >
38 Part number of the FRU.
39 - name: SN
40 type: string
41 description: >
42 Serial number of the FRU.
43 - name: Manufacturer
44 type: string
45 description: >
46 Manufacturer of the FRU.
47 - name: ManufacturerDate
48 type: string
49 description: >
50 Manufacturing date of the FRU in YYYYMMDD format. While the FRU spec
51 has this defined as 13 byte binary format, that is aligned with CIM. A
52 string is likely to be more useful. An implementation of this is
53 expected to transform the 13 byte binary format to a string.
54 - name: Vendor
55 type: string
56 description: >
57 Vendor of the FRU.
58 - name: Name
59 type: string
60 description: >
61 Name of the FRU.
62 - name: SKU
63 type: string
64 description: >
65 Stock-keeping unit number of the FRU.
66 - name: Version
67 type: string
68 description: >
69 Version of the FRU.
70 - name: AssetTag
71 type: string
72 description: >
73 Asset tag of the FRU.
74 - name: Description
75 type: string
76 description: >
77 A description of the FRU.
78 - name: ECLevel
79 type: string
80 description: >
81 Engineering change level of the FRU.
82 - name: Other
83 type: string
84 description: >
85 Other information about the FRU.
86 - name: IANA
87 type: uint32
88 description: >
89 The FRU vendor's IANA number.