1description: >
2    Implement to fetch the PDRs. PDRs are Platform Descriptor
3    Records which are the collection of information that includes semantic
4    and association information.
5
6    This API would be used by PLDM Requester apps on the BMC.
7
8    An implementation of this interface should maintain the primary PDR
9    repository on the BMC.
10
11    A OpenBMC implementation should implement the xyz.openbmc_project.PLDM.PDR
12    interface on the path /xyz/openbmc_project/pldm.
13
14    More information about PDR can be found at DSP0248 version 1.2.0 section 25.
15
16
17methods:
18    - name: FindStateEffecterPDR
19      description: >
20          Obtain the state effecter PDR, for the input TID, entity ID and state
21          set id. If multiple PLDM entity instances(in state effecter PDRs)
22          match the EntityId and StateSetId below,all the corresponding state
23          effecter PDRs are returned. More than one PDR can be returned for the
24          same state set id.
25
26          When the PDR for the given input TID, entity id and state set id is
27          not found, then the xyz.openbmc_project.Common.Error.ResourceNotFound
28          exception will be thrown.
29
30      parameters:
31        - name: TID
32          type: byte
33          description: >
34            A terminus id.
35
36        - name: EntityID
37          type: uint16
38          description: >
39            A numeric value that represents an entity that can be associated to
40            a PLDM state set.
41
42            More information is found at
43            http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf
44            section 7.
45
46        - name: StateSetId
47          type: uint16
48          description: >
49            A numeric value that identifies the PLDM State Set that is used with
50            this sensor.
51
52            More information is found at
53            http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf
54            section 6.
55
56      returns:
57        - name: StateEffecterPDR
58          type: array[array[byte]]
59          description: >
60            Array of State Effecter PDRs, where a PDR is an array[byte].
61            Multiple PDRs of the format present in table 89 of DSP0248 version
62            1.2.0 are returned. Each of the PDRs returned has the common header
63            along with all the other fields in table 89 and 90 of
64            DSP0248 of version 1.2.0 .
65
66      errors:
67        - xyz.openbmc_project.Common.Error.ResourceNotFound
68
69    - name: FindStateSensorPDR
70      description: >
71          Obtain the state sensor PDR, for the input TID,
72          entity ID and state set id. If multiple PLDM entity instances
73          (in state sensor PDRs) match the EntityId and StateSetId below,
74          all the corresponding state sensor PDRs are returned. More than one PDR
75          can be returned for the same state set id.
76
77          When the PDR for the given input TID, entity id
78          and state set id is not found, then the
79          xyz.openbmc_project.Common.Error.ResourceNotFound exception will be thrown.
80
81      parameters:
82        - name: TID
83          type: byte
84          description: >
85            A terminus id.
86
87        - name: EntityID
88          type: uint16
89          description: >
90            A numeric value that represents an entity that can be associated to a PLDM state set.
91            More information is found at
92            http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf section 7.
93
94        - name: StateSetId
95          type: uint16
96          description: >
97            A numeric value that identifies the PLDM State Set that is used with this sensor.
98            More information is found at
99            http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf section 6.
100
101      returns:
102        - name: StateSensorPDR
103          type: array[array[byte]]
104          description: >
105            Array of State Sensor PDRs, where a PDR is an array[byte]. Multiple PDRs of the
106            format present in table 80 of DSP0248 version 1.2.0 are returned. Each of the PDRs
107            returned has the common header along with all the other fields in table 80 and 81 of
108            DSP0248 of version 1.2.0 .
109
110      errors:
111        - xyz.openbmc_project.Common.Error.ResourceNotFound
112