Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / libpldm / 62b7dad7cf3aaa32b99285b6d71c0df7f244d7a4
commit62b7dad7cf3aaa32b99285b6d71c0df7f244d7a4[log] [tgz]
authorManojkiran Eda <manojkiran.eda@gmail.com>Tue May 20 08:02:58 2025 +0530
committerManojkiran Eda <manojkiran.eda@gmail.com>Thu Jun 26 16:07:54 2025 +0530
treef4cab5fbba1486bb7349d6fb07a0b7ded4fa0856
parent07264f48f3ce43bd7136a4906c018a7fc708e9f7 [diff]
base: Add command specific completion codes

Add command specific completion codes for various base commands.

Change-Id: Iee01b0ec9cd13f5102f1767f7184ac47cfc36c43
Signed-off-by: Manojkiran Eda <manojkiran.eda@gmail.com>
2 files changed
tree: f4cab5fbba1486bb7349d6fb07a0b7ded4fa0856
  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.