Skip to content

Commit 5aa8955

Browse files
decsnycfriedt
authored andcommitted
samples: Fix confusing openamp sample doc
A lot of users seem to be confused by this sample when they try to do west debug. This is because Zephyr currently does not support flashing all the cores from a sysbuild automatically when doing a west debug command. So west flash needs to be done prior to a west debug command. The README previously actually said the step by step instructions are to do the build, then immediately west debug, which would cause faulting and crashing, so change the instructions goal to be a flash, and put a note about needing to flash before debugging. Signed-off-by: Declan Snyder <[email protected]>
1 parent a7527b1 commit 5aa8955

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

samples/subsys/ipc/openamp/README.rst

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,21 @@ Overview
99

1010
This application demonstrates how to use OpenAMP with Zephyr. It is designed to
1111
demonstrate how to integrate OpenAMP with Zephyr both from a build perspective
12-
and code. Note that the remote and primary core images can be flashed
12+
and code.
13+
14+
Note that the remote and primary core images can be flashed
1315
independently, but sysbuild must be used in order to build the images.
1416

17+
Both cores must be flashed prior to using ``west debug`` on either core.
18+
It is suggested to use ``west flash`` to do this as shown below.
19+
1520
Building the application for lpcxpresso54114_m4
1621
***********************************************
1722

1823
.. zephyr-app-commands::
1924
:zephyr-app: samples/subsys/ipc/openamp
2025
:board: lpcxpresso54114/lpc54114/m4
21-
:goals: debug
26+
:goals: flash
2227
:west-args: --sysbuild
2328

2429
Building the application for lpcxpresso55s69/lpc55s69/cpu0
@@ -27,7 +32,7 @@ Building the application for lpcxpresso55s69/lpc55s69/cpu0
2732
.. zephyr-app-commands::
2833
:zephyr-app: samples/subsys/ipc/openamp
2934
:board: lpcxpresso55s69/lpc55s69/cpu0
30-
:goals: debug
35+
:goals: flash
3136
:west-args: --sysbuild
3237

3338
Building the application for mps2/an521/cpu0
@@ -36,7 +41,7 @@ Building the application for mps2/an521/cpu0
3641
.. zephyr-app-commands::
3742
:zephyr-app: samples/subsys/ipc/openamp
3843
:board: mps2/an521/cpu0
39-
:goals: debug
44+
:goals: flash
4045
:west-args: --sysbuild
4146

4247
Building the application for v2m_musca_b1/musca_b1
@@ -45,7 +50,7 @@ Building the application for v2m_musca_b1/musca_b1
4550
.. zephyr-app-commands::
4651
:zephyr-app: samples/subsys/ipc/openamp
4752
:board: v2m_musca_b1/musca_b1
48-
:goals: debug
53+
:goals: flash
4954
:west-args: --sysbuild
5055

5156
Building the application for mimxrt1170_evk_cm7
@@ -54,7 +59,7 @@ Building the application for mimxrt1170_evk_cm7
5459
.. zephyr-app-commands::
5560
:zephyr-app: samples/subsys/ipc/openamp
5661
:board: mimxrt1170_evk_cm7
57-
:goals: debug
62+
:goals: flash
5863
:west-args: --sysbuild
5964

6065
Building the application for frdm_mcxn947/mcxn947/cpu0
@@ -63,7 +68,7 @@ Building the application for frdm_mcxn947/mcxn947/cpu0
6368
.. zephyr-app-commands::
6469
:zephyr-app: samples/subsys/ipc/openamp
6570
:board: frdm_mcxn947/mcxn947/cpu0
66-
:goals: debug
71+
:goals: flash
6772
:west-args: --sysbuild
6873

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

0 commit comments

Comments
 (0)