Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / libpldm / ab020b60ad17263b936d4cb1a649c9b5eb0f4ea6
commitab020b60ad17263b936d4cb1a649c9b5eb0f4ea6[log] [tgz]
authorAndrew Jeffery <andrew@codeconstruct.com.au>Tue Jun 17 10:07:07 2025 +0930
committerAndrew Jeffery <andrew@codeconstruct.com.au>Tue Jun 17 11:23:15 2025 +0930
tree3f4d10a5e6f4e100c0e43c90f1b88c4e91d4310e
parentae2c83f46f14d5d7d3899a5a160bb4ce1b1f65d3 [diff]
README: Migrate ABI discussion to CONTRIBUTING

Try to keep the README out of the weeds. It was initially the only
place any high-level documentation existed, but let's not carry on that
tradition.

Change-Id: I58667b5eb78abab0540b20eb3ec4742352f33bec
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>
2 files changed
tree: 3f4d10a5e6f4e100c0e43c90f1b88c4e91d4310e
  1. abi/
  2. docs/
  3. evolutions/
  4. include/
  5. instance-db/
  6. scripts/
  7. src/
  8. subprojects/
  9. tests/
  10. tools/
  11. CONTRIBUTING.md ⇨ docs/checklists/changes.md
  12. .clang-format
  13. .clang-tidy
  14. CHANGELOG.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.