Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / libpldm / 340bb6286f6e5fd55dc05fe1915e7f179992c500
commit340bb6286f6e5fd55dc05fe1915e7f179992c500[log] [tgz]
authorAndrew Jeffery <andrew@codeconstruct.com.au>Mon Aug 11 14:16:23 2025 +0930
committerAndrew Jeffery <andrew@codeconstruct.com.au>Mon Aug 11 14:16:23 2025 +0930
tree25f8bb6db80bdc61ca3e2b504c867cbeb1690ebd
parentada5871a7ac63a6bfbfa470e1f4f190597c6c601 [diff]
CONTRIBUTING: Switcheroo the symlink for ergonomics

Github's web UI doesn't follow the symlink, which is unfortunate.
Make CONTRIBUTING.md the file with the content, and switch
docs/checklists/changes.md to point to CONTRIBUTING.md.

Change-Id: I4ac35a5cd7d8cfb7f4224a2cdddba531473f0a35
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>
3 files changed
tree: 25f8bb6db80bdc61ca3e2b504c867cbeb1690ebd
  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.