zephyr/samples/modules/mctp/mctp_host/README.rst
Tom Burdick be4a3d91e1 samples: Add mctp host and client samples
Samples work by sending MCTP encoded messages over a uart between two
boards.

Signed-off-by: Tom Burdick <thomas.burdick@intel.com>
2025-01-14 22:55:41 +01:00

41 lines
1.1 KiB
ReStructuredText

.. zephyr:code-sample:: mctp_host_sample
:name: MCTP Host Sample
Create an MCTP host over UART.
Overview
********
Sets up an MCTP node that sends a request on a UART targeting a particular MCTP
endpoint id with the message "hello". Expects and waits for a response to this
"hello" message containing "world".
Requirements
************
A board and SoC that provide access to a UART and a driver that implements the
UART async API.
Wiring
******
The UART pins should be wired to a board which will run the MCTP endpoint
sample such that this board's UART tx pin connects to the endpoint board's rx
pin, and this board's UART rx pin connects to the endpoint board's tx pin. The
boards' grounds should also be wired together.
Optionally a logic analyzer can be wired up and listening to the UART to inspect
the data flowing.
Building and Running
********************
.. zephyr-app-commands::
:zephyr-app: samples/modules/mctp/mctp_host
:host-os: unix
:board: nrf52840_nrf52840dk
:goals: run
:compact:
References
**********
`MCTP Base Specification 2019 <https://www.dmtf.org/sites/default/files/standards/documents/DSP0236_1.3.1.pdf>`_