Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / libpldm / aa0aeda7c38dda911c81e9bcd9fae5f8210d303b
commitaa0aeda7c38dda911c81e9bcd9fae5f8210d303b[log] [tgz]
authorChau Ly <chaul@amperecomputing.com>Fri Sep 19 09:30:51 2025 +0930
committerAndrew Jeffery <andrew@codeconstruct.com.au>Fri Sep 19 02:22:00 2025 +0000
tree57198b937dca54d51b406136a56d36bc66f0a35f
parent67f6770afbdc09d6f3f7bae65d7e4f5403f1c5c5 [diff]
dsp: base: decode_pldm_base_negotiate_transfer_params_resp() is stable

cb987c5c8863 ("dsp: base: Added
decode_pldm_base_negotiate_transfer_params_req()") accidentally
set `decode_pldm_base_negotiate_transfer_params_resp()` back to
`LIBPLDM_ABI_TESTING` when it was stabilized by 26c8eb2a2f22 ("Stabilize
PLDM File Transfer related APIs").

Further, the existing integration of abi-compliance-checker was unable
to find the fault as the generated dump contained testing symbols, and
so decode_pldm_base_negotiate_transfer_params_resp() wasn't found to
be absent. We rework scripts/pre-submit such that this kind of problem
results in a CI failure.

Change-Id: I27d48e275646bbd75f19a3e1fe309a584d893cf2
Fixes: cb987c5c8863 ("dsp: base: Added decode_pldm_base_negotiate_transfer_params_req()")
Signed-off-by: Chau Ly <chaul@amperecomputing.com>
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>
4 files changed
tree: 57198b937dca54d51b406136a56d36bc66f0a35f
  1. abi/
  2. docs/
  3. evolutions/
  4. include/
  5. instance-db/
  6. scripts/
  7. src/
  8. subprojects/
  9. tests/
  10. tools/
  11. .clang-format
  12. .clang-tidy
  13. CHANGELOG.md
  14. CONTRIBUTING.md
  15. Doxyfile.in
  16. LICENSE
  17. meson.build
  18. meson.options
  19. OWNERS
  20. README.md
README.md

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.

To Build

libpldm is configured and built using meson. Python's pip or pipx can be used to install a recent version on your machine:

pipx install meson

Once meson is installed:

meson setup build && meson compile -C build

To run unit tests

meson test -C build

Working with libpldm

Components of the library ABI[^1] (loosely, functions) are separated into three categories:

[^1]: "library API + compiler ABI = library ABI"

  1. Stable
  2. Testing
  3. Deprecated

Applications depending on libpldm should aim to only use functions from the stable category. However, this may not always be possible. What to do when required functions fall into the deprecated or testing categories is discussed in CONTRIBUTING.

Upgrading libpldm

libpldm is maintained with the expectation that users move between successive releases when upgrading. This constraint allows the library to reintroduce types and functions of the same name in subsequent releases in the knowledge that there are no remaining users of previous definitions. While strategies are employed to avoid breaking existing APIs unnecessarily, the library is still to reach maturity, and we must allow for improvements to be made in the design.