1.. _openAMP_rsc_table_sample:
2
3OpenAMP Sample Application using resource table
4###############################################
5
6Overview
7********
8
9This application demonstrates how to use OpenAMP with Zephyr based on a resource
10table. It is designed to respond to the `Linux rpmsg client sample <https://elixir.bootlin.com/linux/latest/source/samples/rpmsg/rpmsg_client_sample.c>`_.
11This sample implementation is compatible with platforms that embed
12a Linux kernel OS on the main processor and a Zephyr application on
13the co-processor.
14
15Building the application
16*************************
17
18Zephyr
19-------
20
21.. zephyr-app-commands::
22   :zephyr-app: samples/subsys/ipc/openamp_rsc_table
23   :goals: test
24
25Linux
26------
27
28Enable SAMPLE_RPMSG_CLIENT configuration to build and install
29the rpmsg_client_sample.ko module on the target.
30
31Running the sample
32*******************
33
34Zephyr console
35---------------
36
37Open a serial terminal (minicom, putty, etc.) and connect the board with the
38following settings:
39
40- Speed: 115200
41- Data: 8 bits
42- Parity: None
43- Stop bits: 1
44
45Reset the board.
46
47Linux console
48---------------
49
50Open a Linux shell (minicom, ssh, etc.) and insert a module into the Linux Kernel
51
52.. code-block:: console
53
54   root@linuxshell: insmod rpmsg_client_sample.ko
55
56Result on Zephyr console
57-------------------------
58
59The following message will appear on the corresponding Zephyr console:
60
61.. code-block:: console
62
63   ***** Booting Zephyr OS v#.##.#-####-g########## *****
64   Starting application thread!
65
66   OpenAMP demo started
67   Remote core received message 1: hello world!
68   Remote core received message 2: hello world!
69   Remote core received message 3: hello world!
70   ...
71   Remote core received message 100: hello world!
72   OpenAMP demo ended.
73