commit	2e30eb1a8aad1ec1ac3808d9f2b0083a4f595b00	[log] [tgz]
author	Sridevi Ramesh <sridevra@in.ibm.com>	Tue Jul 06 06:07:37 2021 -0500
committer	Sridevi Ramesh <sridevra@in.ibm.com>	Thu Jul 22 05:07:32 2021 +0000
tree	66cff9fee07d6fba5f021aca182c86e8571dee8c
parent	9cb05bd52be41c05d7f9b23c7ffe526cf7e18fa4 [diff]

pdr: Sensor support for various fault LEDS.

Also, added powersupply 2 and 3 support in 11.json

In this commit sensor fault LEDs support is added for connectors,
cablecard, processor, dasd_pyramid, ddimm, nvme, pcieslot,
planar, battery and tpm_wilson.

Testing Result:
Note: Test results are mentioned based on the random LED assert true/false
operation for the specific LED type.

processor
==========

busctl set-property xyz.openbmc_project.LED.GroupManager /xyz/openbmc_project/led/groups/cpu0_fault xyz.openbmc_project.Led.Group Asserted b true

 pldmtool platform GetStateSensorReadings -i 114 -r 1
{
    "compositeSensorCount": 1,
    "sensorOpState[0]": "Sensor Enabled",
    "presentState[0]": "Sensor Normal",
    "previousState[0]": "Sensor Unknown",
    "eventState[0]": "Sensor Warning"
}

Power Converter
==============

busctl set-property xyz.openbmc_project.LED.GroupManager /xyz/openbmc_project/led/groups/cpu1_vrm0_fault xyz.openbmc_project.Led.Group Asserted b false
pldmtool platform GetStateSensorReadings -i 117 -r 0
{
    "compositeSensorCount": 1,
    "sensorOpState[0]": "Sensor Enabled",
    "presentState[0]": "Sensor Normal",
    "previousState[0]": "Sensor Unknown",
    "eventState[0]": "Sensor Normal"
}

Drive backplane
====================

busctl set-property xyz.openbmc_project.LED.GroupManager /xyz/openbmc_project/led/groups/dasd_pyramid0_fault xyz.openbmc_project.Led.Group Asserted b true
pldmtool platform GetStateSensorReadings -i 118 -r 0
{
    "compositeSensorCount": 1,
    "sensorOpState[0]": "Sensor Enabled",
    "presentState[0]": "Sensor Normal",
    "previousState[0]": "Sensor Unknown",
    "eventState[0]": "Sensor Warning"
}

System Board
=================

busctl set-property xyz.openbmc_project.LED.GroupManager /xyz/openbmc_project/led/groups/planar_fault xyz.openbmc_project.Led.Group Asserted b false
pldmtool platform GetStateSensorReadings -i 196 -r 0                                                           {
    "compositeSensorCount": 1,
    "sensorOpState[0]": "Sensor Enabled",
    "presentState[0]": "Sensor Normal",
    "previousState[0]": "Sensor Unknown",
    "eventState[0]": "Sensor Normal"
}

Battery
=========

busctl set-property xyz.openbmc_project.LED.GroupManager /xyz/openbmc_project/led/groups/rtc_battery_fault xyz.openbmc_project.Led.Group Asserted b false
pldmtool platform GetStateSensorReadings -i 201 -r 0                                                           {
    "compositeSensorCount": 1,
    "sensorOpState[0]": "Sensor Enabled",
    "presentState[0]": "Sensor Normal",
    "previousState[0]": "Sensor Unknown",
    "eventState[0]": "Sensor Normal"
}

power supply
==========

busctl set-property xyz.openbmc_project.LED.GroupManager /xyz/openbmc_project/led/groups/powersupply3_fault xyz.openbmc_project.Led.Group Asserted b true
pldmtool platform GetStateSensorReadings -i 200 -r 0                                                          {
    "compositeSensorCount": 1,
    "sensorOpState[0]": "Sensor Enabled",
    "presentState[0]": "Sensor Normal",
    "previousState[0]": "Sensor Unknown",
    "eventState[0]": "Sensor Warning"
}

Dimm
=========

busctl set-property xyz.openbmc_project.LED.GroupManager /xyz/openbmc_project/led/groups/ddimm2_fault xyz.openbmc_project.Led.Group Asserted b true

 pldmtool platform GetStateSensorReadings -i 123 -r 0
{
    "compositeSensorCount": 1,
    "sensorOpState[0]": "Sensor Enabled",
    "presentState[0]": "Sensor Normal",
    "previousState[0]": "Sensor Unknown",
    "eventState[0]": "Sensor Warning"
}

NVMe
======

busctl set-property xyz.openbmc_project.LED.GroupManager /xyz/openbmc_project/led/groups/nvme23_fault xyz.openbmc_project.Led.Group Asserted b true

pldmtool platform GetStateSensorReadings -i 183 -r 0
{
    "compositeSensorCount": 1,
    "sensorOpState[0]": "Sensor Enabled",
    "presentState[0]": "Sensor Normal",
    "previousState[0]": "Sensor Unknown",
    "eventState[0]": "Sensor Warning"
}

PCIe slot
=============

busctl set-property xyz.openbmc_project.LED.GroupManager /xyz/openbmc_project/led/groups/pcieslot0_fault xyz.openbmc_project.Led.Group Asserted b true

 pldmtool platform GetStateSensorReadings -i 184 -r 0
{
    "compositeSensorCount": 1,
    "sensorOpState[0]": "Sensor Enabled",
    "presentState[0]": "Sensor Normal",
    "previousState[0]": "Sensor Unknown",
    "eventState[0]": "Sensor Warning"
}

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

2 files changed

tree: 66cff9fee07d6fba5f021aca182c86e8571dee8c

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 meson option has to be created in pldm/meson_options.txt with its mapped compiler flag to enable conditional compilation.

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

The pldm/meson.build and the corresponding source file(s) will need to incorporate the logic of adding its mapped compiler flag to allow conditional compilation of the code.

pldmtool

For more information on pldmtool please refer to plmdtool/README.md.

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.