| commit | 6fd81a518d8a021009101038b0d80092f14a9028 | [log] [tgz] |
|---|---|---|
| author | Andrew Jeffery <andrew@aj.id.au> | Wed May 10 13:50:14 2023 +0930 |
| committer | Andrew Jeffery <andrew@aj.id.au> | Thu May 11 12:16:22 2023 +0000 |
| tree | d4e2cbb715a03c2dc1514855243d52da159a8fb8 | |
| parent | 8eb20f282bb52dc40bccf336ecb0feb0882e24df [diff] |
libpldm: Add a changelog The changelog is based around the expectations set out in "Keep a Changelog": https://keepachangelog.com/en/1.0.0/ Through review I will set the expectation that people modify CHANGELOG.md in the patches changing the functionality in relevant ways. When we need to commit to an API or ABI break we will first create a tag before merging the breaking changes. This gives consumers of the library sensible sequence points for migrating their code as we clean up the library. Signed-off-by: Andrew Jeffery <andrew@aj.id.au> Change-Id: Ie361049829cfe7f1b962860bee6f7fe528f64e2a
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:
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.
Need meson and ninja. Alternatively, source an OpenBMC ARM/x86 SDK.
meson setup builddir && ninja -C builddir
The simplest way of running the tests is as described by the meson man page:
meson setup builddir && meson test -C builddir
This will support OEM or vendor-specific functions and semantic information. Following directory structure has to be used:
libpldm |---- include/libpldm | |---- oem/<oem_name>/libpldm | |----<oem based .h files> |---- src | |---- oem/<oem_name> | |----<oem based .c files> |---- tests | |---- oem/<oem_name> | |----<oem based test files>
<oem_name> - This folder must be created with the name of the OEM/vendor in lower case.
Header files & source files having the oem functionality for the libpldm library should be placed under the respective folder hierarchy as mentioned in the above figure. They must be adhering to the rules mentioned under the libpldm section above.
Once the above is done a meson option has to be created in libpldm/meson_options.txt with its mapped compiler flag to enable conditional compilation.
For consistency would recommend using "oem-<oem_name>".
The libpldm/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.
The pldm requester API's are present in src/requester folder and they are intended to provide API's to interact with the desired underlying transport layer to send/receive pldm messages.
NOTE : In the current state, the requester API's in the repository only works with specific transport mechanism & these are going to change in future & probably aren't appropriate to be writing code against.