zephyr/samples/drivers/mbox
Andrzej Głąbek 7cda16528c samples: Replace nRF54H20 PDK with nRF54H20 DK
nRF54H20 PDK is superseded by nRF54H20 DK and will no longer be
supported.

Signed-off-by: Andrzej Głąbek <andrzej.glabek@nordicsemi.no>
2024-03-18 19:11:36 +00:00
..
boards samples: Replace nRF54H20 PDK with nRF54H20 DK 2024-03-18 19:11:36 +00:00
remote samples: Replace nRF54H20 PDK with nRF54H20 DK 2024-03-18 19:11:36 +00:00
src drivers: mbox: update MBOX consumers to the new API 2024-03-07 14:32:57 +00:00
CMakeLists.txt samples: Replace nRF54H20 PDK with nRF54H20 DK 2024-03-18 19:11:36 +00:00
Kconfig samples: drivers: mbox: use DT 2024-03-07 14:32:57 +00:00
Kconfig.sysbuild samples: Replace nRF54H20 PDK with nRF54H20 DK 2024-03-18 19:11:36 +00:00
prj.conf
README.rst hwmv2: Introduce Hardware model version 2 and convert devices 2024-03-02 16:56:33 -05:00
sample.yaml samples: Replace nRF54H20 PDK with nRF54H20 DK 2024-03-18 19:11:36 +00:00
sysbuild.cmake samples: drivers: mbox: fix hwmv2 issues 2024-03-05 16:50:36 +00:00

.. zephyr:code-sample:: mbox
   :name: MBOX
   :relevant-api: mbox_interface

   Perform inter-processor mailbox communication using the MBOX API.

Overview
********

This sample demonstrates how to use the :ref:`MBOX API <mbox_api>`.

Building and Running
********************

The sample can be built and executed on boards supporting MBOX.

Building the application for nrf5340dk/nrf5340/cpuapp
*****************************************************

.. zephyr-app-commands::
   :zephyr-app: samples/drivers/mbox/
   :board: nrf5340dk/nrf5340/cpuapp
   :goals: debug
   :west-args: --sysbuild

Open a serial terminal (minicom, putty, etc.) and connect the board with the
following settings:

- Speed: 115200
- Data: 8 bits
- Parity: None
- Stop bits: 1

Reset the board and the following message will appear on the corresponding
serial port, one is the application (APP) core another is the network (NET)
core:

.. code-block:: console

   *** Booting Zephyr OS build zephyr-v3.1.0-2383-g147aee22f273  ***
   Hello from APP
   Pong (on channel 0)
   Ping (on channel 1)
   Pong (on channel 0)
   Ping (on channel 1)
   Ping (on channel 1)
   Pong (on channel 0)
   Ping (on channel 1)
   Pong (on channel 0)
   Ping (on channel 1)
   ...


.. code-block:: console

   *** Booting Zephyr OS build zephyr-v3.1.0-2383-g147aee22f273  ***
   Hello from NET
   Ping (on channel 0)
   Pong (on channel 1)
   Ping (on channel 0)
   Pong (on channel 1)


Building the application for the simulated nrf5340bsim
******************************************************

.. zephyr-app-commands::
   :zephyr-app: samples/drivers/mbox/
   :host-os: unix
   :board: nrf5340bsim_nrf5340_cpuapp
   :goals: build
   :west-args: --sysbuild

Then you can execute your application using:

.. code-block:: console

   $ ./build/zephyr/zephyr.exe -nosim
   # Press Ctrl+C to exit

You can expect a similar output as in the real HW in the invoking console.