openbmc/libmctp/README.md

9 - Email: See [OWNERS](OWNERS). Please also Cc <openbmc@lists.ozlabs.org>
10 - Discord: #mctp on <https://discord.gg/69Km47zH98>
11 - IRC: #openbmc on Freenode
28 - `mctp = mctp_init()`: Initialise the MCTP core
29 - `binding = mctp_<binding>_init()`: Initialise a hardware binding
30 - `mctp_register_bus(mctp, binding, eid)`: Register the hardware binding with
35 - `mctp_set_rx_all(mctp, function)`: Provide a callback to be invoked when a
40 - `mctp_message_tx(mctp, message, len)`: Transmit a MCTP message
44 file-descriptor for the serial device has data available.
50 their messages, then the messages are re-packetised for the outgoing binding.
54 - `mctp = mctp_init()`: Initialise the MCTP core
55 - `b1 = mctp_<binding>_init(); b2 = mctp_<binding>_init()`: Initialise two
57 - `mctp_bridge_busses(mctp, b1, b2)`: Setup bridge
60 a local rx callback, and messages are bridged as-is.
71         /* hardware-specific members here... */
80 or maybe the `foo` binding needs a path argument:
85 hardware-specific struct to the libmctp generic core struct
90 `b->binding`). Callers can then use that generic pointer to register the binding
93     struct mctp_binding *binding = mctp_binding_foo_core(foo);
107 For (1), you can use the top-level makefile to produce `libmctp.a`.
120 - Linux userspace, typically for BMC use-cases
121 - Low-level firmware environments
126 In order to support these, we have a few compile-time definitions:
128 - `MCTP_HAVE_FILEIO`: define if POSIX file io is available, allowing the serial
131 - `MCTP_HAVE_SYSLOG`: allow logging to syslog, through the `vsyslog` call.
133 - `MCTP_DEFAULT_ALLOC`: set default allocator functions (malloc, free, realloc),
138 - Partial packet queue transmit
139 - Control messages
140 - Message- and packet-buffer pools and preallocation
141 - C++ API
142 - Non-file-based serial binding