bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8b3f23eddc
zephyr/samples/subsys/ipc/ipc_service
History
Carlo Caione 6c00e980b2 ipc: ipc_service: Rework multi-instance backend. 
Only one single IPC service backend is currently present: multi_instance
backend. This backend is heavily relying on the RPMsg multi_instance
code to instanciate and manage instances and endpoints. Samples exist
for both in the samples/subsys/ipc/ directory.

With this patch we are "unpacking" the RPMsg multi_service code to make
it more modular and reusable by different backends.

In particular we are re-organizing the code into two helper libraries:
an RPMsg library and a VRING / virtqueues static allocation library. At
the same time we rewrite the multi_instance backend to make fully use of
those new libraries and remove the old multi_instance sample.

Signed-off-by: Carlo Caione <ccaione@baylibre.com>
2021-10-11 20:58:09 -04:00
..
boards ipc: ipc_service: Rework multi-instance backend. 2021-10-11 20:58:09 -04:00
remote ipc: ipc_service: Rework multi-instance backend. 2021-10-11 20:58:09 -04:00
src
CMakeLists.txt samples: ipc: ipc_service: Add support for BL5340 2021-09-23 13:13:51 -04:00
prj.conf ipc: ipc_service: Rework multi-instance backend. 2021-10-11 20:58:09 -04:00
README.rst samples: ipc: ipc_service: Add support for BL5340 2021-09-23 13:13:51 -04:00
sample.yaml samples: ipc: ipc_service: Add support for BL5340 2021-09-23 13:13:51 -04:00

README.rst 

.. _IPC_Service_sample:

IPC Service
###########

Overview
********

IPC Service is an abstraction layer.
It needs the corresponding backend registered for proper operation.
You can use any IPC mechanism as a backend.
In this sample, it is a multiple instance of RPMsg.
This sample demonstrates how to integrate IPC Service with Zephyr.

Building the application for nrf5340dk_nrf5340_cpuapp
*****************************************************

.. zephyr-app-commands::
   :zephyr-app: samples/subsys/ipc/ipc_service
   :board: nrf5340dk_nrf5340_cpuapp
   :goals: debug

Open a serial terminal (for example Minicom or PuTTY) and connect the board with the
following settings:

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

When you reset the development kit, the following messages (one for master and one for remote) will appear on the corresponding serial ports:

.. code-block:: console

   *** Booting Zephyr OS build v2.6.0-rc3-5-g026dfb6f1b71  ***

   IPC Service [master 1] demo started

   IPC Service [master 2] demo started
   Master [1] received a message: 1
   Master [2] received a message: 1
   Master [1] received a message: 3
   Master [2] received a message: 3

   ...
   Master [1] received a message: 99
   IPC Service [master 1] demo ended.
   Master [2] received a message: 99
   IPC Service [master 2] demo ended.


.. code-block:: console

   *** Booting Zephyr OS build v2.6.0-rc3-5-g026dfb6f1b71  ***

   IPC Service [remote 1] demo started

   IPC Service [remote 2] demo started
   Remote [1] received a message: 0
   Remote [2] received a message: 0
   Remote [1] received a message: 2
   Remote [2] received a message: 2
   Remote [1] received a message: 4
   Remote [2] received a message: 4
   ...
   Remote [1] received a message: 98
   IPC Service [remote 1] demo ended.
   Remote [2] received a message: 98
   IPC Service [remote 2] demo ended.

Building the application for bl5340_dvk_cpuapp
**********************************************

.. zephyr-app-commands::
   :zephyr-app: samples/subsys/ipc/ipc_service
   :board: bl5340_dvk_cpuapp
   :goals: debug

.. zephyr-app-commands::
   :zephyr-app: samples/subsys/ipc/ipc_service/remote
   :board: bl5340_dvk_cpunet
   :goals: debug

Open a serial terminal (for example Minicom or PuTTY) and connect to the board
with the following settings on both serial ports:

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

When you reset the development kit after having flashed both the application
and network core images, the following messages (one for master and one for
remote) will appear on the corresponding serial ports:

.. code-block:: console

   *** Booting Zephyr OS build v2.7.0-rc1-103-ge19875c88916  ***

   IPC Service [master 1] demo started

   IPC Service [master 2] demo started
   Master [1] received a message: 1
   Master [2] received a message: 1
   Master [1] received a message: 3
   Master [2] received a message: 3

   ...
   Master [1] received a message: 99
   IPC Service [master 1] demo ended.
   Master [2] received a message: 99
   IPC Service [master 2] demo ended.


.. code-block:: console

   *** Booting Zephyr OS build v2.7.0-rc1-103-ge19875c88916  ***

   IPC Service [remote 1] demo started

   IPC Service [remote 2] demo started
   Remote [1] received a message: 0
   Remote [2] received a message: 0
   Remote [1] received a message: 2
   Remote [2] received a message: 2
   Remote [1] received a message: 4
   Remote [2] received a message: 4
   ...
   Remote [1] received a message: 98
   IPC Service [remote 1] demo ended.
   Remote [2] received a message: 98
   IPC Service [remote 2] demo ended.