openbmc/libmctp/README.md

12 - where you are implementing MCTP in an embedded device; or
13 - where you have Linux system:
14   - with no kernel MCTP support,
15   - need a single application implementing all of the MCTP stack; and
16   - you are providing your own hardware drivers for MCTP transports.
19 certainly_ want to use the in-kernel MCTP support, which gives you a standard
20 sockets-based interface to transmit and receive MCTP messages. When using the
25 There is an overview and example code for the in-kernel support in the [MCTP
26 kernel docs][kernel-mctp], and a general guide in an [introduction to MCTP on
27 Linux][mctp-linux-intro] document.
29 [kernel-mctp]: https://docs.kernel.org/networking/mctp.html
30 [mctp-linux-intro]:
31   https://codeconstruct.com.au/docs/mctp-on-linux-introduction/
35 - Email: See [OWNERS](OWNERS). Please also Cc <openbmc@lists.ozlabs.org>
36 - Discord: #mctp on <https://discord.gg/69Km47zH98>
37 - IRC: #openbmc on Freenode
54 - `mctp = mctp_init()`: Initialise the MCTP core
55 - `binding = mctp_<binding>_init()`: Initialise a hardware binding
56 - `mctp_register_bus(mctp, binding, eid)`: Register the hardware binding with
61 - `mctp_set_rx_all(mctp, function)`: Provide a callback to be invoked when a
66 - `mctp_message_tx(mctp, message, len)`: Transmit a MCTP message
70 file-descriptor for the serial device has data available.
76 their messages, then the messages are re-packetised for the outgoing binding.
80 - `mctp = mctp_init()`: Initialise the MCTP core
81 - `b1 = mctp_<binding>_init(); b2 = mctp_<binding>_init()`: Initialise two
83 - `mctp_bridge_busses(mctp, b1, b2)`: Setup bridge
86 a local rx callback, and messages are bridged as-is.
97         /* hardware-specific members here... */
106 or maybe the `foo` binding needs a path argument:
111 hardware-specific struct to the libmctp generic core struct
116 `b->binding`). Callers can then use that generic pointer to register the binding
119     struct mctp_binding *binding = mctp_binding_foo_core(foo);
133 For (1), you can use the top-level makefile to produce `libmctp.a`.
146 - Linux userspace, typically for BMC use-cases
147 - Low-level firmware environments
152 In order to support these, we have a few compile-time definitions:
154 - `MCTP_HAVE_FILEIO`: define if POSIX file io is available, allowing the serial
157 - `MCTP_HAVE_SYSLOG`: allow logging to syslog, through the `vsyslog` call.
159 - `MCTP_DEFAULT_ALLOC`: set default allocator functions (malloc, free, realloc),
164 - Partial packet queue transmit
165 - Control messages
166 - Message- and packet-buffer pools and preallocation
167 - C++ API
168 - Non-file-based serial binding