boards/nxp/lpcxpresso55s69/doc/index.rst
.. zephyr:board:: lpcxpresso55s69
Overview
The LPCXpresso55S69 development board provides the ideal platform for evaluation of and development with the LPC55S6x MCU based on the Arm® Cortex®-M33 architecture. The board includes a high performance onboard debug probe, audio subsystem, and accelerometer, with several options for adding off-the-shelf add-on boards for networking, sensors, displays, and other interfaces.
Hardware
For more information about the LPC55S69 SoC and LPCXPRESSO55S69 board, see:
LPC55S69 SoC Website_LPC55S69 Datasheet_LPC55S69 Reference Manual_LPCXPRESSO55S69 Website_LPCXPRESSO55S69 User Guide_LPCXPRESSO55S69 Schematics_LPCXPRESSO55S69 Debug Firmware_NXP considers the LPCXpresso55S69 as the superset board for the LPC55xx series of MCUs. This board is a focus for NXP's Full Platform Support for Zephyr, to better enable the entire LPC55xx series. NXP prioritizes enabling this board with new support for Zephyr features.
.. zephyr:board-supported-hw::
The default configuration file
:zephyr_file:boards/nxp/lpcxpresso55s69/lpcxpresso55s69_lpc55s69_cpu0_defconfig
only enables the first core.
CPU0 is the only target that can run standalone.
NS target for CPU0 does not work correctly without a secure image to configure
the system, then hand execution over to the NS environment. To enable a secure
image, run any of the tfm_integration samples. When using the NS target
CONFIG_BUILD_WITH_TFM is always enabled to ensure that a valid S image is
included during the build process.
CPU1 does not work without CPU0 enabling it.
To enable it, run one of the following samples in subsys\ipc:
ipm_mcuxopenampThe LPC55S69 SoC has IOCON registers, which can be used to configure the functionality of a pin.
+---------+-----------------+----------------------------+ | Name | Function | Usage | +=========+=================+============================+ | PIO0_26 | SPI | SPI MOSI | +---------+-----------------+----------------------------+ | PIO0_27 | USART | USART TX | +---------+-----------------+----------------------------+ | PIO0_29 | USART | USART RX | +---------+-----------------+----------------------------+ | PIO0_30 | USART | USART TX | +---------+-----------------+----------------------------+ | PIO1_1 | SPI | SPI SSEL | +---------+-----------------+----------------------------+ | PIO1_2 | SPI | SPI SCK | +---------+-----------------+----------------------------+ | PIO1_3 | SPI | SPI MISO | +---------+-----------------+----------------------------+ | PIO1_4 | GPIO | RED LED | +---------+-----------------+----------------------------+ | PIO1_6 | GPIO | BLUE_LED | +---------+-----------------+----------------------------+ | PIO1_7 | GPIO | GREEN LED | +---------+-----------------+----------------------------+ | PIO1_20 | I2C | I2C SCL | +---------+-----------------+----------------------------+ | PIO1_21 | I2C | I2C SDA | +---------+-----------------+----------------------------+ | PIO1_24 | USART | USART RX | +---------+-----------------+----------------------------+ | PIO0_20 | I2S | I2S DATAOUT | +---------+-----------------+----------------------------+ | PIO0_19 | I2S | I2S TX WS | +---------+-----------------+----------------------------+ | PIO0_21 | I2S | I2S TX SCK | +---------+-----------------+----------------------------+ | PIO1_13 | I2S | I2S DATAIN | +---------+-----------------+----------------------------+ | PIO0_15 | SCT0_OUT2 | PWM | +---------+-----------------+----------------------------+ | PIO0_24 | SD0_D0 | SDHC | +---------+-----------------+----------------------------+ | PIO0_25 | SD0_D1 | SDHC | +---------+-----------------+----------------------------+ | PIO0_31 | SD0_D2 | SDHC | +---------+-----------------+----------------------------+ | PIO0_7 | SD0_CLK | SDHC | +---------+-----------------+----------------------------+ | PIO0_8 | SD0_CMD | SDHC | +---------+-----------------+----------------------------+ | PIO0_9 | SD0_POW_EN | SDHC | +---------+-----------------+----------------------------+ | PIO1_0 | SD0_D3 | SDHC | +---------+-----------------+----------------------------+
There are multiple memory configurations, they all start from the MCUboot partitioning which looks like the table below
+----------+------------------+---------------------------------+ | Name | Address[Size] | Comment | +==========+==================+=================================+ | boot | 0x00000000[32K] | Bootloader | +----------+------------------+---------------------------------+ | slot0 | 0x00008000[160k] | Image that runs after boot | +----------+------------------+---------------------------------+ | slot0_ns | 0x00030000[96k] | Second image, core 1 or NS | +----------+------------------+---------------------------------+ | slot1 | 0x00048000[160k] | Updates slot0 image | +----------+------------------+---------------------------------+ | slot1_ns | 0x00070000[96k] | Updates slot0_ns image | +----------+------------------+---------------------------------+ | storage | 0x00088000[50k] | File system, persistent storage | +----------+------------------+---------------------------------+
See below examples of how this partitioning is used
Trusted Execution
+-----------+------------------+--------------------+ | Memory | Address[Size] | Comment | +===========+==================+====================+ | MCUboot | 0x00000000[32K] | Secure bootloader | +-----------+------------------+--------------------+ | TFM_S | 0x00008000[160k] | Secure image | +-----------+------------------+--------------------+ | Zephyr_NS | 0x00030000[96k] | Non-Secure image | +-----------+------------------+--------------------+ | storage | 0x00088000[50k] | Persistent storage | +-----------+------------------+--------------------+
+----------------+------------------+-------------------+ | RAM | Address[Size] | Comment | +================+==================+===================+ | secure_ram | 0x20000000[136k] | Secure memory | +----------------+------------------+-------------------+ | non_secure_ram | 0x20022000[136k] | Non-Secure memory | +----------------+------------------+-------------------+
Dual Core samples
+--------+------------------+----------------------------+ | Memory | Address[Size] | Comment | +========+==================+============================+ | CPU0 | 0x00000000[630K] | CPU0, can access all flash | +--------+------------------+----------------------------+ | CPU1 | 0x00030000[96k] | CPU1, has no MPU | +--------+------------------+----------------------------+
+-------+------------------+-----------------------+ | RAM | Address[Size] | Comment | +=======+==================+=======================+ | sram0 | 0x20000000[64k] | CPU0 memory | +-------+------------------+-----------------------+ | sram3 | 0x20030000[64k] | CPU1 memory | +-------+------------------+-----------------------+ | sram4 | 0x20040000[16k] | Mailbox/shared memory | +-------+------------------+-----------------------+
The LPC55S69 SoC is configured to use PLL1 clocked from the external 16MHz crystal, running at 144MHz as a source for the system clock. When the flash controller is enabled, the core clock will be reduced to 96MHz. The application may reconfigure clocks after initialization, provided that the core clock is always set to 96MHz when flash programming operations are performed.
The LPC55S69 SoC has 8 FLEXCOMM interfaces for serial communication. One is configured as USART for the console and the remaining are not used.
Programming and Debugging
.. zephyr:board-supported-runners::
Build and flash applications as usual (see :ref:build_an_application and
:ref:application_run for more details).
LinkServer is the default runner for this board.
A debug probe is used for both flashing and debugging the board. This board is
configured by default to use the integrated :ref:mcu-link-onboard-debug-probe
in the CMSIS-DAP mode. To use this probe with Zephyr, you need to install the
:ref:linkserver-debug-host-tools and make sure they are in your search path.
Refer to the detailed overview about :ref:application_debugging for additional
information.
The integrated MCU-Link hardware can also be used as a J-Link probe with a
firmware update, as described in :ref:mcu-link-jlink-onboard-debug-probe.
The :ref:jlink-debug-host-tools should be available in this case.
Connect a USB cable from your PC to P6, and use the serial terminal of your choice (minicom, putty, etc.) with the following settings:
Here is an example for the :zephyr:code-sample:hello_world application. This example uses the
:ref:linkserver-debug-host-tools as default.
.. zephyr-app-commands:: :zephyr-app: samples/hello_world :board: lpcxpresso55s69/lpc55s69/cpu0 :goals: flash
Open a serial terminal, reset the board (press the RESET button), and you should see the following message in the terminal:
.. code-block:: console
***** Booting Zephyr OS v3.7.0 ***** Hello World! lpcxpresso55s69/lpc55s69/cpu0
The TF-M integration samples can be run using the
lpcxpresso55s69/lpc55s69/cpu0/ns target. To run we need to manually flash
the resulting image (tfm_merged.hex) with a J-Link as follows
(reset and erase are for recovering a locked core):
.. code-block:: console
JLinkExe -device lpc55s69 -if swd -speed 2000 -autoconnect 1
J-Link>r
J-Link>erase
J-Link>loadfile build/zephyr/tfm_merged.hex
We need to reset the board manually after flashing the image to run this code.
The dual-core samples are run using lpcxpresso55s69/lpc55s69/cpu0 target.
Images built for lpcxpresso55s69/lpc55s69/cpu1 will be loaded from flash
and executed on the second core when SECOND_CORE_MCUX is selected. For
an example of building for both cores with sysbuild, see
samples/subsys/ipc/openamp/
Here is an example for the :zephyr:code-sample:hello_world application. This example uses the
:ref:jlink-debug-host-tools as default.
.. zephyr-app-commands:: :zephyr-app: samples/hello_world :board: lpcxpresso55s69/lpc55s69/cpu0 :goals: debug
Open a serial terminal, step through the application in your debugger, and you should see the following message in the terminal:
.. code-block:: console
***** Booting Zephyr OS zephyr-v1.14.0 ***** Hello World! lpcxpresso55s69
.. include:: ../../common/board-footer.rst.inc
.. _LPC55S69 SoC Website: https://www.nxp.com/products/processors-and-microcontrollers/arm-based-processors-and-mcus/lpc-cortex-m-mcus/lpc5500-cortex-m33/high-efficiency-arm-cortex-m33-based-microcontroller-family:LPC55S6x
.. _LPC55S69 Datasheet: https://www.nxp.com/docs/en/nxp/data-sheets/LPC55S6x_DS.pdf
.. _LPC55S69 Reference Manual: https://www.nxp.com/webapp/Download?colCode=UM11126
.. _LPCXPRESSO55S69 Website: https://www.nxp.com/products/processors-and-microcontrollers/arm-based-processors-and-mcus/lpc-cortex-m-mcus/lpc5500-cortex-m33/lpcxpresso55s69-development-board:LPC55S69-EVK
.. _LPCXPRESSO55S69 User Guide: https://www.nxp.com/webapp/Download?colCode=UM11158
.. _LPCXPRESSO55S69 Debug Firmware: https://www.nxp.com/docs/en/application-note/AN13206.pdf
.. _LPCXPRESSO55S69 Schematics: https://www.nxp.com/webapp/Download?colCode=LPC55S69-SCH
.. _updating LPCXpresso firmware: https://os.mbed.com/teams/NXP/wiki/Updating-LPCXpresso-firmware