README.rst
1.. zephyr:code-sample:: mctp_host_sample
2 :name: MCTP Host Sample
3
4 Create an MCTP host over UART.
5
6Overview
7********
8Sets up an MCTP node that sends a request on a UART targeting a particular MCTP
9endpoint id with the message "hello". Expects and waits for a response to this
10"hello" message containing "world".
11
12Requirements
13************
14A board and SoC that provide access to a UART and a driver that implements the
15UART async API.
16
17Wiring
18******
19The UART pins should be wired to a board which will run the MCTP endpoint
20sample such that this board's UART tx pin connects to the endpoint board's rx
21pin, and this board's UART rx pin connects to the endpoint board's tx pin. The
22boards' grounds should also be wired together.
23
24Optionally a logic analyzer can be wired up and listening to the UART to inspect
25the data flowing.
26
27Building and Running
28********************
29
30.. zephyr-app-commands::
31 :zephyr-app: samples/modules/mctp/mctp_host
32 :host-os: unix
33 :board: nrf52840_nrf52840dk
34 :goals: run
35 :compact:
36
37References
38**********
39
40`MCTP Base Specification 2019 <https://www.dmtf.org/sites/default/files/standards/documents/DSP0236_1.3.1.pdf>`_
41
