Add FindStateSensorPDR method on PLDM.PDR Interface
This method would be used by PLDM Requester apps on the
BMC to access the PDR repo.
Signed-off-by: Chicago Duan <duanzhijia01@inspur.com>
Change-Id: I5eda621448698e9722ae20d5ba6a1a7ace9ffb59
diff --git a/xyz/openbmc_project/PLDM/PDR.interface.yaml b/xyz/openbmc_project/PLDM/PDR.interface.yaml
index cdbd58c..7c44229 100644
--- a/xyz/openbmc_project/PLDM/PDR.interface.yaml
+++ b/xyz/openbmc_project/PLDM/PDR.interface.yaml
@@ -1,8 +1,7 @@
description: >
- Implement to fetch the state effecter PDRs. PDRs are Platform Descriptor
+ Implement to fetch the PDRs. PDRs are Platform Descriptor
Records which are the collection of information that includes semantic
- and association information. The state effecter PDR is used to provide
- information about the PLDM Composite State Effecter.
+ and association information.
This API would be used by PLDM Requester apps on the BMC.
@@ -66,3 +65,47 @@
errors:
- xyz.openbmc_project.Common.Error.ResourceNotFound
+
+ - name: FindStateSensorPDR
+ description: >
+ Obtain the state sensor PDR, for the input TID,
+ entity ID and state set id. If multiple PLDM entity instances
+ (in state sensor PDRs) match the EntityId and StateSetId below,
+ all the corresponding state sensor PDRs are returned. More than one PDR
+ can be returned for the same state set id.
+
+ When the PDR for the given input TID, entity id
+ and state set id is not found, then the
+ xyz.openbmc_project.Common.Error.ResourceNotFound exception will be thrown.
+
+ parameters:
+ - name: TID
+ type: byte
+ description: >
+ A terminus id.
+
+ - name: EntityID
+ type: uint16
+ description: >
+ A numeric value that represents an entity that can be associated to a PLDM state set.
+ More information is found at
+ http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf section 7.
+
+ - name: StateSetId
+ type: uint16
+ description: >
+ A numeric value that identifies the PLDM State Set that is used with this sensor.
+ More information is found at
+ http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf section 6.
+
+ returns:
+ - name: StateSensorPDR
+ type: array[array[byte]]
+ description: >
+ Array of State Sensor PDRs, where a PDR is an array[byte]. Multiple PDRs of the
+ format present in table 80 of DSP0248 version 1.2.0 are returned. Each of the PDRs
+ returned has the common header along with all the other fields in table 80 and 81 of
+ DSP0248 of version 1.2.0 .
+
+ errors:
+ - xyz.openbmc_project.Common.Error.ResourceNotFound