| commit | 2f7e05bd27426e69ba4aabf82e7ecb02c77cd7db | [log] [tgz] |
|---|---|---|
| author | Jeremy Kerr <jk@ozlabs.org> | Fri Feb 08 09:48:36 2019 +0800 |
| committer | Jeremy Kerr <jk@ozlabs.org> | Fri Feb 08 10:03:01 2019 +0800 |
| tree | f9134856edde4bd4d9820f55b2831ec1bc865435 | |
| parent | 24db71fbb553c056f887be1eaafd10e2c7dd1f3f [diff] |
README: Add notes on integration Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
This library is intended to be a portable implementation of the Management Component Transport Protocol (MCTP), as defined by DMTF standard "DSP0236", plus transport binding specifications.
Currently, the library is is only at prototyping stage. Interfaces will likely change, and are missing lots of components of the standard.
To initialise the MCTP stack with a single hardware bus:
mctp = mctp_init(): Initialise the MCTP corebinding = mctp_<binding>_init(): Initialise a hardware bindingmctp_register_bus(mctp, binding, eid): Register the hardware binding with the core, using a predefined EIDThen, register a function call to be invoked when a message is received:
mctp_set_rx_all(mctp, function): Provide a callback to be invoked when a MCTP message is receivedOr transmit a message:
mctp_message_tx(mctp, message, len): Transmit a MCTP messageThe binding may require you to notify it to receive packets. For example, for the serial binding, the mctp_serial_read() function should be invoked when the file-descriptor for the serial device has data available.
The libmctp code is intended to be integrated into other codebases by two methods:
as a simple library (libmctp.a), which can be compiled separately and linked into the containing project
as a set of sources to be included into the containing project (either imported, or as a git subtree/submodule)
For (1), you can use the top-level makefile to produce libmtcp.a.
For (2), the Makefile.inc file provides the minimum set of dependencies to either build libmctp.a, or just the actual object files (LIBMCTP_OBS), which you can include into your existing make definitions. You'll want to set LIBMTCP_DIR to refer to the subdirectory that contains that makefile, so we can set the correct paths to sources.
This library is intended to be portable to be used in a range of environments, but the main targets are:
For the latter, we need to support customisation of the functions that libmctp uses (for example, POSIX file IO is not available).
In order to support these, we have a couple of compile-time definitions:
MCTP_FILEIO: define if POSIX file io is available, allowing the serial hardware binding to access char devices for IO.
MCTP_LOG_: allows selection of a logging backend. Currently available are:
MCTP_LOG_STDERR: use fprintf(stderr, ...) for log output
MCTP_LOG_SYSLOG: use syslog() for log output
MCTP_LOG_CUSTOM: provide your own macro for logging, of the format: #define mctp_prlog(level, fmt, ...) (....)