README.rst
1.. zephyr:code-sample:: mbox
2 :name: MBOX
3 :relevant-api: mbox_interface
4
5 Perform inter-processor mailbox communication using the MBOX API.
6
7Overview
8********
9
10This sample demonstrates how to use the :ref:`MBOX API <mbox_api>`.
11
12Building and Running
13********************
14
15The sample can be built and executed on boards supporting MBOX.
16
17Building the application for nrf5340dk/nrf5340/cpuapp
18*****************************************************
19
20.. zephyr-app-commands::
21 :zephyr-app: samples/drivers/mbox/
22 :board: nrf5340dk/nrf5340/cpuapp
23 :goals: debug
24 :west-args: --sysbuild
25
26Open a serial terminal (minicom, putty, etc.) and connect the board with the
27following settings:
28
29- Speed: 115200
30- Data: 8 bits
31- Parity: None
32- Stop bits: 1
33
34Reset the board and the following message will appear on the corresponding
35serial port, one is the application (APP) core another is the network (NET)
36core:
37
38.. code-block:: console
39
40 *** Booting Zephyr OS build zephyr-v3.1.0-2383-g147aee22f273 ***
41 Hello from APP
42 Pong (on channel 0)
43 Ping (on channel 1)
44 Pong (on channel 0)
45 Ping (on channel 1)
46 Ping (on channel 1)
47 Pong (on channel 0)
48 Ping (on channel 1)
49 Pong (on channel 0)
50 Ping (on channel 1)
51 ...
52
53
54.. code-block:: console
55
56 *** Booting Zephyr OS build zephyr-v3.1.0-2383-g147aee22f273 ***
57 Hello from NET
58 Ping (on channel 0)
59 Pong (on channel 1)
60 Ping (on channel 0)
61 Pong (on channel 1)
62
63
64Building the application for the simulated nrf5340bsim
65******************************************************
66
67.. zephyr-app-commands::
68 :zephyr-app: samples/drivers/mbox/
69 :host-os: unix
70 :board: nrf5340bsim/nrf5340/cpuapp
71 :goals: build
72 :west-args: --sysbuild
73
74Then you can execute your application using:
75
76.. code-block:: console
77
78 $ ./build/zephyr/zephyr.exe -nosim
79 # Press Ctrl+C to exit
80
81You can expect a similar output as in the real HW in the invoking console.
82
