README.rst
1.. zephyr:code-sample:: mctp_endpoint_sample
2 :name: MCTP Endpoint Sample
3
4 Create an MCTP endpoint over UART.
5
6Overview
7********
8Sets up an MCTP node that listens on a UART for messages targeting a particular
9MCTP endpoint id with the message "hello". Responds to this "hello" message with
10"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 listening UART pins should be wired to a board which will run the MCTP host
20sample such that this board's UART tx pin connects to the host board's rx pin,
21and this board's UART rx pin connects to the host board's tx pin. The boards'
22grounds 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
31.. zephyr-app-commands::
32 :zephyr-app: samples/modules/mctp/mctp_endpoint
33 :host-os: unix
34 :board: nrf52840_nrf52840dk
35 :goals: run
36 :compact:
37
38References
39**********
40
41`MCTP Base Specification 2019 <https://www.dmtf.org/sites/default/files/standards/documents/DSP0236_1.3.1.pdf>`_
42
