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