zephyr/samples/subsys/ipc/ipc_service/static_vrings
Gerard Marull-Paretas f1fc468e99 samples: remove redundant CONFIG_MBOX_NRFX_IPC=y
It is no longer needed, Kconfig option is enabled based on DT status.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
2024-08-16 11:20:08 +01:00
..
boards samples: remove redundant CONFIG_MBOX_NRFX_IPC=y 2024-08-16 11:20:08 +01:00
remote samples: remove redundant CONFIG_MBOX_NRFX_IPC=y 2024-08-16 11:20:08 +01:00
src
CMakeLists.txt samples: ipc: static_vrings add NXP boards support 2024-04-30 08:57:01 +02:00
Kconfig samples: ipc: static_vrings add NXP boards support 2024-04-30 08:57:01 +02:00
Kconfig.sysbuild samples: ipc: static_vrings add NXP boards support 2024-04-30 08:57:01 +02:00
prj.conf
README.rst samples: ipc: static_vrings add NXP boards support 2024-04-30 08:57:01 +02:00
sample.yaml samples: subsys: ipc: ipc_service: check console output 2024-06-14 19:14:38 +02:00
sysbuild.cmake samples: ipc: static_vrings add NXP boards support 2024-04-30 08:57:01 +02:00

.. zephyr:code-sample:: ipc-static-vrings
   :name: IPC service: static vrings backend
   :relevant-api: ipc

   Send messages between two cores using the IPC service and static vrings backend.

Overview
********

This application demonstrates how to use IPC Service and the static vrings
backend with Zephyr. It is designed to demonstrate how to integrate it with
Zephyr both from a build perspective and code.

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

.. zephyr-app-commands::
   :zephyr-app: samples/subsys/ipc/ipc_service/static_vrings
   :board: nrf5340dk/nrf5340/cpuapp
   :goals: debug
   :west-args: --sysbuild

Building the application for lpcxpresso55s69/lpc55s69/cpu0
**********************************************************

.. zephyr-app-commands::
   :zephyr-app: samples/subsys/ipc/ipc_service/static_vrings
   :board: lpcxpresso55s69/lpc55s69/cpu0
   :goals: debug
   :west-args: --sysbuild

Building the application for mimxrt1160_evk/mimxrt1166/cm7
**********************************************************

.. zephyr-app-commands::
   :zephyr-app: samples/subsys/ipc/ipc_service/static_vrings
   :board: mimxrt1160_evk/mimxrt1166/cm7
   :goals: debug
   :west-args: --sysbuild

Building the application for mimxrt1170_evk/mimxrt1176/cm7
**********************************************************

.. zephyr-app-commands::
   :zephyr-app: samples/subsys/ipc/ipc_service/static_vrings
   :board: mimxrt1170_evk/mimxrt1176/cm7
   :goals: debug
   :west-args: --sysbuild

Building the application for mimxrt1170_evk@B/mimxrt1176/cm7
************************************************************

.. zephyr-app-commands::
   :zephyr-app: samples/subsys/ipc/ipc_service/static_vrings
   :board: mimxrt1170_evk@B/mimxrt1176/cm7
   :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 host another is remote:

.. code-block:: console

   *** Booting Zephyr OS build zephyr-v3.1.0-2383-g147aee22f273  ***
   IPC-service HOST [INST 0 - ENDP A] demo started
   IPC-service HOST [INST 0 - ENDP B] demo started
   IPC-service HOST [INST 1] demo started
   HOST [1]: 1
   HOST [1]: 3
   HOST [1]: 5
   HOST [1]: 7
   HOST [1]: 9
   ...


.. code-block:: console

   *** Booting Zephyr OS build zephyr-v3.1.0-2383-g147aee22f273  ***
   IPC-service REMOTE [INST 0 - ENDP A] demo started
   IPC-service REMOTE [INST 0 - ENDP B] demo started
   IPC-service REMOTE [INST 1] demo started
   REMOTE [1]: 0
   REMOTE [1]: 2
   REMOTE [1]: 4
   REMOTE [1]: 6
   REMOTE [1]: 8
   ...