Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / libmctp / 6579c76d990267484e1ceebfbdd47604a0a7c013
commit6579c76d990267484e1ceebfbdd47604a0a7c013[log] [tgz]
authorJames Feist <james.feist@linux.intel.com>Thu Jun 13 10:45:00 2019 -0700
committerJames Feist <james.feist@linux.intel.com>Thu Jun 13 10:47:12 2019 -0700
treeadb8e0c2802d8a80c1980e96b97187127008ba20
parent0b278a6368c1009504d83c59144c788f0f813866 [diff]
Fix CMakeLists

The CMakeLists seems to have atrophied and no longer builds
due to some file changes. Fix them. Also ran it through
cmake-format to make it pretty.

Tested: cmake now builds

Change-Id: I8fd265e3f9e1ff1819600f2f4fd6205dcfdae6a2
Signed-off-by: James Feist <james.feist@linux.intel.com>
1 file changed
tree: adb8e0c2802d8a80c1980e96b97187127008ba20
  1. tests/
  2. utils/
  3. alloc.c
  4. astlpc.c
  5. bootstrap.sh
  6. CMakeLists.txt
  7. configure.ac
  8. core.c
  9. libmctp-alloc.h
  10. libmctp-astlpc.h
  11. libmctp-log.h
  12. libmctp-serial.h
  13. libmctp.h
  14. LICENSE
  15. log.c
  16. Makefile.am
  17. Makefile.inc
  18. README.md
  19. serial.c
README.md

libmctp: Implementation of MCTP (DTMF DSP0236)

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.

Core API

To initialise the MCTP stack with a single hardware bus:

  • mctp = mctp_init(): Initialise the MCTP core
  • binding = mctp_<binding>_init(): Initialise a hardware binding
  • mctp_register_bus(mctp, binding, eid): Register the hardware binding with the core, using a predefined EID

Then, 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 received

Or transmit a message:

  • mctp_message_tx(mctp, message, len): Transmit a MCTP message

The 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.

Integration

The libmctp code is intended to be integrated into other codebases by two methods:

  1. as a simple library (libmctp.{a,so}) which can be compiled separately and linked into the containing project

  2. 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.

Environment configuration

This library is intended to be portable to be used in a range of environments, but the main targets are:

  • Linux userspace, typically for BMC use-cases
  • Low-level firmware environments

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 few compile-time definitions:

  • MCTP_HAVE_FILEIO: define if POSIX file io is available, allowing the serial hardware binding to access char devices for IO.

  • MCTP_HAVE_SYSLOG: allow logging to syslog, through the vsyslog call.

  • MCTP_DEFAULT_ALLOC: set default allocator functions (malloc, free, realloc), so that applications do not have to provide their own.

TODO

  • Partial packet queue transmit
  • Control messages
  • Message- and packet-buffer pools and preallocation
  • C++ API
  • Non-file-based serial binding