zephyr/samples/drivers/ipm/ipm_mcux
Daniel DeGrasse e61e6a4092 samples: drivers: ipm: ipm_mcux: fix build command documentation
Documentation for IPM MCUX sample did not provide correct command for
building sample. To resolve this, add the "--sysbuild" argument to build
command documentation

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2024-03-11 10:25:09 -04:00
..
boards hwmv2: Introduce Hardware model version 2 and convert devices 2024-03-02 16:56:33 -05:00
remote hwmv2: Introduce Hardware model version 2 and convert devices 2024-03-02 16:56:33 -05:00
src samples, tests, boards: Switch main return type from void to int 2023-04-14 07:49:41 +09:00
CMakeLists.txt samples: drivers: ipm: update to use sysbuild 2022-11-15 14:46:02 +01:00
Kconfig samples: drivers: ipm: update to use sysbuild 2022-11-15 14:46:02 +01:00
Kconfig.sysbuild hwmv2: Introduce Hardware model version 2 and convert devices 2024-03-02 16:56:33 -05:00
prj.conf samples: drivers: ipm: update to use sysbuild 2022-11-15 14:46:02 +01:00
README.rst samples: drivers: ipm: ipm_mcux: fix build command documentation 2024-03-11 10:25:09 -04:00
sample.yaml hwmv2: Introduce Hardware model version 2 and convert devices 2024-03-02 16:56:33 -05:00
sysbuild.cmake sysbuild: Remove IMAGES variable 2023-09-05 15:27:04 +02:00

.. zephyr:code-sample:: ipm-mcux
   :name: IPM on NXP LPC
   :relevant-api: ipm_interface

   Implement inter-processor mailbox (IPM) on NXP LPC family.

Overview
********

Some NXP microcontrollers from LPC family are dual-core, this
sample application uses a mailbox to send messages from one
processor core to the other.

This sample applies to the following boards:
 -  :ref:`lpcxpresso54114`, two core processors (Cortex-M4F and Cortex-M0+)
 -  :ref:`lpcxpresso55s69`, two core processors (dual Cortex-M33)

Requirements
************

- :ref:`lpcxpresso54114` board
- :ref:`lpcxpresso55s69` board

Building the application for lpcxpresso54114/lpc54114/m4
********************************************************

.. zephyr-app-commands::
   :zephyr-app: samples/drivers/ipm/ipm_mcux
   :board: lpcxpresso54114/lpc54114/m4
   :goals: debug
   :west-args: --sysbuild


Building the application for lpcxpresso55s69/lpc55s69/cpu0
**********************************************************

.. zephyr-app-commands::
   :zephyr-app: samples/drivers/ipm/ipm_mcux
   :board: lpcxpresso55s69/lpc55s69/cpu0
   :goals: debug
   :west-args: --sysbuild

Running
*******
Open a serial terminal (minicom, putty, etc.) and connect the board with the
following settings:

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

Reset the board and the following message will appear on the corresponding
serial port:

.. code-block:: console

   ***** Booting Zephyr OS v1.11.0-764-g4e3007a *****
   Hello World from MASTER! arm
   Received: 1
   ...
   Received: 99