| Pavithra Barithaya | 4d01be9 | 2020-04-29 07:36:58 -0500 | [diff] [blame] | 1 | description: > |
| 2 | Implement to fetch the state effecter PDRs. PDRs are Platform Descriptor |
| 3 | Records which are the collection of information that includes semantic |
| 4 | and association information. The state effecter PDR is used to provide |
| 5 | information about the PLDM Composite State Effecter. |
| 6 | |
| 7 | This API would be used by PLDM Requester apps on the BMC. |
| 8 | |
| 9 | An implementation of this interface should maintain the primary PDR |
| 10 | repository on the BMC. |
| 11 | |
| 12 | A OpenBMC implementation should implement the xyz.openbmc_project.PLDM.PDR |
| 13 | interface on the path /xyz/openbmc_project/pldm. |
| 14 | |
| 15 | More information about PDR can be found at DSP0248 version 1.2.0 section 25. |
| 16 | |
| 17 | |
| 18 | methods: |
| 19 | - name: FindStateEffecterPDR |
| 20 | description: > |
| 21 | Obtain the state effecter PDR, for the input TID, entity ID and state |
| 22 | set id. If multiple PLDM entity instances(in state effecter PDRs) |
| 23 | match the EntityId and StateSetId below,all the corresponding state |
| 24 | effecter PDRs are returned. More than one PDR can be returned for the |
| 25 | same state set id. |
| 26 | |
| 27 | When the PDR for the given input TID, entity id and state set id is |
| 28 | not found, then the xyz.openbmc_project.Common.Error.ResourceNotFound |
| 29 | exception will be thrown. |
| 30 | |
| 31 | parameters: |
| 32 | - name: TID |
| 33 | type: byte |
| 34 | description: > |
| 35 | A terminus id. |
| 36 | |
| 37 | - name: EntityID |
| 38 | type: uint16 |
| 39 | description: > |
| 40 | A numeric value that represents an entity that can be associated to |
| 41 | a PLDM state set. |
| 42 | |
| 43 | More information is found at |
| 44 | http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf |
| 45 | section 7. |
| 46 | |
| 47 | - name: StateSetId |
| 48 | type: uint16 |
| 49 | description: > |
| 50 | A numeric value that identifies the PLDM State Set that is used with |
| 51 | this sensor. |
| 52 | |
| 53 | More information is found at |
| 54 | http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf |
| 55 | section 6. |
| 56 | |
| 57 | returns: |
| 58 | - name: StateEffecterPDR |
| 59 | type: array[array[byte]] |
| 60 | description: > |
| 61 | Array of State Effecter PDRs, where a PDR is an array[byte]. |
| 62 | Multiple PDRs of the format present in table 89 of DSP0248 version |
| 63 | 1.2.0 are returned. Each of the PDRs returned has the common header |
| 64 | along with all the other fields in table 89 and 90 of |
| 65 | DSP0248 of version 1.2.0 . |
| 66 | |
| 67 | errors: |
| 68 | - xyz.openbmc_project.Common.Error.ResourceNotFound |