commit	27c512aeb0f2a758e4484a0874dd575cfdfe60db	[log] [tgz]
author	Sridevi Ramesh <sridevra@in.ibm.com>	Wed Aug 12 03:29:42 2020 -0500
committer	Deepak Kodihalli <dkodihal@in.ibm.com>	Mon Oct 26 17:17:05 2020 +0000
tree	0069c84d62a81b3989c1093e447ef42e633b5124
parent	ca4a815bdd4e03b400190faff5632a0fcaec8860 [diff]

Display pldmtool platform command output in JSON

./pldmtool platform GetPDR -d 17
{
    "nextRecordHandle": 18,
    "responseCount": 19,
    "recordHandle": 17,
    "PDRHeaderVersion": 1,
    "PDRType": "Terminus Locator PDR",
    "recordChangeNumber": 0,
    "dataLength": 9,
    "PLDMTerminusHandle": 1,
    "validity": "valid",
    "TID": 1,
    "containerID": 0,
    "terminusLocatorType": "MCTP_EID",
    "terminusLocatorValueSize": 1,
    "EID": 8
}

./pldmtool platform GetPDR -d 1
{
    "nextRecordHandle": 2,
    "responseCount": 20,
    "recordHandle": 1,
    "PDRHeaderVersion": 1,
    "PDRType": "FRU Record Set PDR",
    "recordChangeNumber": 0,
    "dataLength": 10,
    "PLDMTerminusHandle": 0,
    "FRURecordSetIdentifier": 1,
    "entityType": "System (logical)",
    "entityInstanceNumber": 1,
    "containerID": 0
}

 ./pldmtool platform GetPDR -d 15
{
    "nextRecordHandle": 16,
    "responseCount": 26,
    "recordHandle": 15,
    "PDRHeaderVersion": 1,
    "PDRType": "Entity Association PDR",
    "recordChangeNumber": 0,
    "dataLength": 16,
    "containerID": 2,
    "associationType": "Physical",
    "containerEntityType": "System chassis (main enclosure)",
    "containerEntityInstanceNumber": 1,
    "containerEntityContainerID": 1,
    "containedEntityCount": 1,
    "containedEntityType[1]": "System Board",
    "containedEntityInstanceNumber[1]": 1,
    "containedEntityContainerID[1]": 2

./pldmtool platform GetPDR -d 18
{
    "nextRecordHandle": 19,
    "responseCount": 29,
    "recordHandle": 18,
    "PDRHeaderVersion": 1,
    "PDRType": "State Effecter PDR",
    "recordChangeNumber": 0,
    "dataLength": 19,
    "PLDMTerminusHandle": 1,
    "effecterID": 1,
    "entityType": "Virtual Machine Manager",
    "entityInstanceNumber": 0,
    "containerID": 0,
    "effecterSemanticID": 0,
    "effecterInit": "noInit",
    "effecterDescriptionPDR": false,
    "compositeEffecterCount": 1,
    "stateSetID": "Boot Progress(196)",
    "possibleStatesSize": 1,
    "possibleStates": " 1 1 2"
}

./pldmtool platform GetPDR -d 21
{
    "nextRecordHandle": 0,
    "responseCount": 84,
    "recordHandle": 21,
    "PDRHeaderVersion": 1,
    "PDRType": "Numeric Effecter PDR",
    "recordChangeNumber": 0,
    "dataLength": 74,
    "PLDMTerminusHandle": 0,
    "effecterID": 4,
    "entityType": 193,
    "entityInstanceNumber": 0,
    "containerID": 0,
    "effecterSemanticID": 0,
    "effecterInit": 0,
    "effecterAuxiliaryNames": false,
    "baseUnit": 72,
    "unitModifier": 0,
    "rateUnit": 0,
    "baseOEMUnitHandle": 0,
    "auxUnit": 0,
    "auxUnitModifier": 0,
    "auxrateUnit": 0,
    "auxOEMUnitHandle": 0,
    "isLinear": true,
    "effecterDataSize": 4,
    "resolution": 1,
    "offset": 0,
    "accuracy": 0,
    "plusTolerance": 0,
    "minusTolerance": 0,
    "stateTransitionInterval": 0,
    "TransitionInterval": 0,
    "maxSettable": 0,
    "minSettable": 0,
    "rangeFieldFormat": 3,
    "rangeFieldSupport": 0,
    "nominalValue": 0,
    "normalMax": 0,
    "normalMin": 0,
    "ratedMax": 0,
    "ratedMin": 0
}

./pldmtool platform SetStateEffecterStates -i 1 -c 1 -d 1 1
{
    "Response": "SUCCESS"
}

./pldmtool platform SetNumericEffecterValue -i 4 -s 4 -d 2100000000
{
    "Response": "SUCCESS"
}

Change-Id: I4572adb9a033435ddf05a5eb4b2ea3dbd0f3070f
Signed-off-by: Sridevi Ramesh <sridevra@in.ibm.com>

pldmtool/pldm_platform_cmd.cpp[diff]

1 file changed

tree: 0069c84d62a81b3989c1093e447ef42e633b5124

README.md

To Build

Need meson and ninja. Alternatively, source an OpenBMC ARM/x86 SDK.

meson build && ninja -C build

To run unit tests

Tests can be run in the CI docker container, or with an OpenBMC x86 sdk(see below for x86 steps).

meson -Doe-sdk=enabled -Dtests=enabled build
ninja -C build test

Code Organization

At a high-level, code in this repository belongs to one of the following three components.

libpldm

This is a library which deals with the encoding and decoding of PLDM messages. It should be possible to use this library by projects other than OpenBMC, and hence certain constraints apply to it:

keeping it light weight
implementation in C
minimal dynamic memory allocations
endian-safe
no OpenBMC specific dependencies

Source files are named according to the PLDM Type, for eg base.[h/c], fru.[h/c], etc.

Given a PLDM command "foo", the library will provide the following API: For the Requester function:

encode_foo_req() - encode a foo request
decode_foo_resp() - decode a response to foo

For the Responder function:

decode_foo_req() - decode a foo request
encode_foo_resp() - encode a response to foo

The library also provides API to pack and unpack PLDM headers.

libpldmresponder

This library provides handlers for incoming PLDM request messages. It provides for a registration as well as a plug-in mechanism. The library is implemented in modern C++, and handles OpenBMC's platform specifics.

The handlers are of the form

Response handler(Request payload, size_t payloadLen)

Source files are named according to the PLDM Type, for eg base.[hpp/cpp], fru.[hpp/cpp], etc.

OEM/vendor-specific functions

This will support OEM or vendor-specific functions and semantic information. Following directory structure has to be used:

    pldm repo
     |---- oem
            |----<oem_name>
                      |----libpldm
                            |----<oem based encoding and decoding files>
                      |----libpldmresponder
                            |---<oem based handler files>

<oem_name> - This folder must be created with the name of the OEM/vendor in lower case. Folders named libpldm and libpldmresponder must be created under the folder <oem_name>

Files having the oem functionality for the libpldm library should be placed under the folder oem/<oem_name>/libpldm. They must be adhering to the rules mentioned under the libpldm section above.

Files having the oem functionality for the libpldmresponder library should be placed under the folder oem/<oem_name>/libpldmresponder. They must be adhering to the rules mentioned under the libpldmresponder section above.

Once the above is done a conditional flag has to be created in the configure.ac to enable conditional compilation.

For consistency would recommend using "--enable-oem-<oem_name>".

The Makefile.am files in libpldm and libpldmresponder will need to be changed to allow conditional compilation of the code.

TODO

Consider hosting libpldm above in a repo of its own, probably even outside the OpenBMC project? A separate repo would enable something like git submodule.

Flows

This section documents important code flow paths.

BMC as PLDM responder

a) PLDM daemon receives PLDM request message from underlying transport (MCTP).

b) PLDM daemon routes message to message handler, based on the PLDM command.

c) Message handler decodes request payload into various field(s) of the request message. It can make use of a decode_foo_req() API, and doesn't have to perform deserialization of the request payload by itself.

d) Message handler works with the request field(s) and generates response field(s).

e) Message handler prepares a response message. It can make use of an encode_foo_resp() API, and doesn't have to perform the serialization of the response field(s) by itself.

f) The PLDM daemon sends the response message prepared at step e) to the remote PLDM device.

BMC as PLDM requester

a) A BMC PLDM requester app prepares a PLDM request message. There would be several requester apps (based on functionality/PLDM remote device). Each of them needn't bother with the serialization of request field(s), and can instead make use of an encode_foo_req() API.

b) BMC requester app requests PLDM daemon to send the request message to remote PLDM device.

c) Once the PLDM daemon receives a corresponding response message, it notifies the requester app.

d) The requester app has to work with the response field(s). It can make use of a decode_foo_resp() API to deserialize the response message.

PDR Implementation

While PLDM Platform Descriptor Records (PDRs) are mostly static information, they can vary across platforms and systems. For this reason, platform specific PDR information is encoded in platform specific JSON files. JSON files must be named based on the PDR type number. For example a state effecter PDR JSON file will be named 11.json. The JSON files may also include information to enable additional processing (apart from PDR creation) for specific PDR types, for eg mapping an effecter id to a D-Bus object.

The PLDM responder implementation finds and parses PDR JSON files to create the PDR repository. Platform specific PDR modifications would likely just result in JSON updates. New PDR type support would require JSON updates as well as PDR generation code. The PDR generator is a map of PDR Type -> C++ lambda to create PDR entries for that type based on the JSON, and to update the central PDR repo.