Skip to content

samples: Fix confusing openamp sample doc #94687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −7
Open

samples: Fix confusing openamp sample doc #94687

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions samples/subsys/ipc/openamp/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,21 @@ Overview

This application demonstrates how to use OpenAMP with Zephyr. It is designed to
demonstrate how to integrate OpenAMP with Zephyr both from a build perspective
and code. Note that the remote and primary core images can be flashed
and code.

Note that the remote and primary core images can be flashed
independently, but sysbuild must be used in order to build the images.

Both cores must be flashed prior to using ``west debug`` on either core.
It is suggested to use ``west flash`` to do this as shown below.

Building the application for lpcxpresso54114_m4
***********************************************

.. zephyr-app-commands::
:zephyr-app: samples/subsys/ipc/openamp
:board: lpcxpresso54114/lpc54114/m4
:goals: debug
:goals: flash
:west-args: --sysbuild

Building the application for lpcxpresso55s69/lpc55s69/cpu0
Expand All @@ -27,7 +32,7 @@ Building the application for lpcxpresso55s69/lpc55s69/cpu0
.. zephyr-app-commands::
:zephyr-app: samples/subsys/ipc/openamp
:board: lpcxpresso55s69/lpc55s69/cpu0
:goals: debug
:goals: flash
:west-args: --sysbuild

Building the application for mps2/an521/cpu0
Expand All @@ -36,7 +41,7 @@ Building the application for mps2/an521/cpu0
.. zephyr-app-commands::
:zephyr-app: samples/subsys/ipc/openamp
:board: mps2/an521/cpu0
:goals: debug
:goals: flash
:west-args: --sysbuild

Building the application for v2m_musca_b1/musca_b1
Expand All @@ -45,7 +50,7 @@ Building the application for v2m_musca_b1/musca_b1
.. zephyr-app-commands::
:zephyr-app: samples/subsys/ipc/openamp
:board: v2m_musca_b1/musca_b1
:goals: debug
:goals: flash
:west-args: --sysbuild

Building the application for mimxrt1170_evk_cm7
Expand All @@ -54,7 +59,7 @@ Building the application for mimxrt1170_evk_cm7
.. zephyr-app-commands::
:zephyr-app: samples/subsys/ipc/openamp
:board: mimxrt1170_evk_cm7
:goals: debug
:goals: flash
:west-args: --sysbuild

Building the application for frdm_mcxn947/mcxn947/cpu0
Expand All @@ -63,7 +68,7 @@ Building the application for frdm_mcxn947/mcxn947/cpu0
.. zephyr-app-commands::
:zephyr-app: samples/subsys/ipc/openamp
:board: frdm_mcxn947/mcxn947/cpu0
:goals: debug
:goals: flash
:west-args: --sysbuild

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