README.rst
1.. zephyr:code-sample:: openamp
2 :name: OpenAMP
3 :relevant-api: ipm_interface
4
5 Send messages between two cores using OpenAMP.
6
7Overview
8********
9
10This application demonstrates how to use OpenAMP with Zephyr. It is designed to
11demonstrate how to integrate OpenAMP with Zephyr both from a build perspective
12and code.
13
14Note that the remote and primary core images can be flashed
15independently, but sysbuild must be used in order to build the images.
16
17Both cores must be flashed prior to using ``west debug`` on either core.
18It is suggested to use ``west flash`` to do this as shown below.
19
20Building the application for lpcxpresso54114_m4
21***********************************************
22
23.. zephyr-app-commands::
24 :zephyr-app: samples/subsys/ipc/openamp
25 :board: lpcxpresso54114/lpc54114/m4
26 :goals: flash
27 :west-args: --sysbuild
28
29Building the application for lpcxpresso55s69/lpc55s69/cpu0
30**********************************************************
31
32.. zephyr-app-commands::
33 :zephyr-app: samples/subsys/ipc/openamp
34 :board: lpcxpresso55s69/lpc55s69/cpu0
35 :goals: flash
36 :west-args: --sysbuild
37
38Building the application for mps2/an521/cpu0
39********************************************
40
41.. zephyr-app-commands::
42 :zephyr-app: samples/subsys/ipc/openamp
43 :board: mps2/an521/cpu0
44 :goals: flash
45 :west-args: --sysbuild
46
47Building the application for v2m_musca_b1/musca_b1
48**************************************************
49
50.. zephyr-app-commands::
51 :zephyr-app: samples/subsys/ipc/openamp
52 :board: v2m_musca_b1/musca_b1
53 :goals: flash
54 :west-args: --sysbuild
55
56Building the application for mimxrt1170_evk_cm7
57***********************************************
58
59.. zephyr-app-commands::
60 :zephyr-app: samples/subsys/ipc/openamp
61 :board: mimxrt1170_evk_cm7
62 :goals: flash
63 :west-args: --sysbuild
64
65Building the application for frdm_mcxn947/mcxn947/cpu0
66******************************************************
67
68.. zephyr-app-commands::
69 :zephyr-app: samples/subsys/ipc/openamp
70 :board: frdm_mcxn947/mcxn947/cpu0
71 :goals: flash
72 :west-args: --sysbuild
73
74Building the application for ek_ra8p1/r7ka8p1kflcac/cm85
75********************************************************
76
77.. zephyr-app-commands::
78 :zephyr-app: samples/subsys/ipc/openamp
79 :board: ek_ra8p1/r7ka8p1kflcac/cm85
80 :goals: debug
81 :west-args: --sysbuild
82
83Open a serial terminal (minicom, putty, etc.) and connect the board with the
84following settings:
85
86- Speed: 115200
87- Data: 8 bits
88- Parity: None
89- Stop bits: 1
90
91Reset the board and the following message will appear on the corresponding
92serial port, one is master another is remote:
93
94.. code-block:: console
95
96 **** Booting Zephyr OS build zephyr-v1.14.0-2064-g888fc98fddaa ****
97 Starting application thread!
98
99 OpenAMP[master] demo started
100 Master core received a message: 1
101 Master core received a message: 3
102 Master core received a message: 5
103 ...
104 Master core received a message: 99
105 OpenAMP demo ended.
106
107
108.. code-block:: console
109
110 **** Booting Zephyr OS build zephyr-v1.14.0-2064-g888fc98fddaa ****
111 Starting application thread!
112
113 OpenAMP[remote] demo started
114 Remote core received a message: 0
115 Remote core received a message: 2
116 Remote core received a message: 4
117 ...
118 Remote core received a message: 98
119 OpenAMP demo ended.
120
