This article describes how to get and use the Developer Package of the STM32MPU Embedded Software for any development platform of the STM32MP1 series (STM32MP15 boards and STM32MP13 boards) and STM32MP2 series (STM32MP25 boards), in order to modify some of its pieces of software, or to add applications on top of it.
It lists some prerequisites in terms of knowledges and development environment, and gives the step-by-step approach to download and install the STM32MPU Embedded Software components for this Package.
Finally, it proposes some guidelines to upgrade (add, remove, configure, improve...) any piece of software.
1. Developer Package content[edit source]
If you are not yet familiar with the STM32MPU Embedded Software distribution and its Packages, read the following articles:
- Which STM32MPU Embedded Software Package better suits your needs (and especially the Developer Package chapter)
- STM32MPU Embedded Software distribution
If you are already familiar with the Developer Package for the STM32MPU Embedded Software distribution, the fast links to essential commands might interest you.
To sum up, this Developer Package provides:
- for the OpenSTLinux distribution (development on Arm® Cortex®-A processor):
- the software development kit (SDK), based on Yocto SDK, for cross-development on an host PC
- the following pieces of software in source code:
- for the Cortex®-M processor firmware development (only for STM32MP15x lines
and STM32MP25x lines
)
- the integrated development environment (IDE) (STM32CubeIDE)
- the STM32CubeMPU Package including all pieces of software (BSP, HAL, middlewares and applications) in source code
- the Trusted Firmware-M (TF-M) in source code (for STM32MP25x lines
only)
- the debug symbol files for Linux® kernel, U-Boot, TF-A, OP-TEE and TF-M (for STM32MP25x lines
only)
Note that, the application frameworks for the OpenSTLinux distribution are not available as source code in this Package.
2. Developer Package step-by-step overview[edit source]
The steps to get the STM32MPU Embedded Software Developer Package ready for your developments, are:
☐ Checking the prerequisites
☐ Installing the Starter Package for your board
☐ Installing the components to develop software running on Arm® Cortex®-A (OpenSTLinux distribution)
- ☐ Installing the SDK (mandatory for any development on Arm® Cortex®-A)
- ☐ Installing the OpenSTLinux BSP package (mandatory only if you plan to modify the Linux kernel, to add external out-of-tree Linux kernel modules, to modify U-Boot, TF-A, OP-TEE OS)
- ☐ Installing the debug symbol files (mandatory only if you plan to debug Linux® kernel, U-Boot, OP-TEE or TF-A with GDB)
☐ Installing the components to develop software running Arm Cortex-M (STM32CubeMPU Package)
- ☐ Installing STM32CubeIDE (mandatory for any development on Arm® Cortex®-M)
- ☐ Installing the STM32CubeMPU Package (mandatory only if you plan to modify the STM32Cube firmware)
Once these steps are achieved, you are able to:
- develop software running on Arm Cortex-A
- develop software running on Arm Cortex-M ( only on STM32MP15x lines
and STM32MP25x lines
)
3. Checking the prerequisites[edit source]
3.1. Knowledges[edit source]
The STM32MPU Developer Package aims at enriching a Linux-based software for the targeted product: basic knowledges about Linux are recommended to make the most of this Package.
Having a look at the STM32MPU Embedded Software architecture overview is also highly recommended.
3.2. Development setup[edit source]
The recommended setup for the development PC (host) is specified in the following article: PC prerequisites.
Whatever the development platform (board) and development PC (host) used, the range of possible development setups is illustrated by the picture below.
The following components are mandatory:
- Host PC for cross-compilation and cross-debugging, installed as specified above
- Board assembled and configured as specified in the associated Starter Package article
- Mass storage device (for example, microSD card) to load and update the software images (binaries)
The following components are optional, but recommended:
- A serial link between the host PC (through Terminal program) and the board for traces (even early boot traces), and access to the board from the remote PC (command lines)
- An Ethernet link between the host PC and the board for cross-development and cross-debugging through a local network. This is an alternative or a complement to the serial (or USB) link
- A display connected to the board, depending on the technologies available on the board: DSI LCD display, HDMI monitor (or TV) and so on
- A mouse and a keyboard connected through USB ports
Additional optional components can be added by means of the connectivity capabilities of the board: cameras, displays, JTAG, sensors, actuators, and much more.
4. Installing the Starter Package[edit source]
Before developing with the Developer Package, it is essential to start up your board thanks to its Starter Package. All articles relative to Starter Packages are found in Category:Starter Package: find the one that corresponds to your board, and follow the installation instructions (if not yet done), before going further.
In brief, it means that:
- your board boots successfully
- the flashed image comes from the same release of the STM32MPU Embedded Software distribution than the components that will be downloaded in this article
Thanks to the Starter Package, all Flash partitions are populated.
Then, with the Developer Package, it is possible to modify or to upgrade the partitions independently one from the others.
For example, if you only want to modify the Linux kernel (part of bootfs partition), installing the SDK and the Linux kernel are enough; no need to install anything else.
5. Installing the components to develop software running on Arm Cortex-A (OpenSTLinux distribution)[edit source]
5.1. Installing the SDK[edit source]
Optional step: it is mandatory only if you want to modify or add software running on Arm Cortex-A (e.g. Linux kernel, Linux user space applications...).
The SDK for OpenSTLinux distribution provides a stand-alone cross-development toolchain and libraries tailored to the contents of the specific image flashed in the board. If you want to know more about this SDK, read the SDK for OpenSTLinux distribution article.
For STM32MP1 series
The STM32MP1 SDK is delivered through two tarball file named :
- en.sdk-x86_64-stm32mp1-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.tar.gz for x86_64 host architecture
- en.sdk-aarch64-stm32mp1-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.tar.gz for arm64 host architecture
Download and install the STM32MP1 SDK. The software package is provided AS IS, and by downloading it, you agree to be bound to the terms of the software license agreement (SLA0048). The detailed content licenses can be found here.
STM32MP1 Developer Package SDK - STM32MP1-Ecosystem-v5.1.0 release | |
---|---|
Download |
|
Installation | For x86_64 host architecture
tar xvf en.sdk-x86_64-stm32mp1-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.tar.gz
chmod +x stm32mp1-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26/sdk/st-image-weston-openstlinux-weston-stm32mp1-x86_64-toolchain-4.2.4-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.sh
./stm32mp1-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26/sdk/st-image-weston-openstlinux-weston-stm32mp1-x86_64-toolchain-4.2.4-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.sh -d <working directory absolute path>/Developer-Package/SDK
ST OpenSTLinux - Weston - (A Yocto Project Based Distro) SDK installer version 4.2.4-openstlinux-6.1-yocto-mickledore-mp1-v24.06.26 =================================================================================================================================== You are about to install the SDK to "<working directory absolute path>/Developer-Package/SDK". Proceed [Y/n]? Extracting SDK.........................................................................................................................................................................................................................done Setting it up...done SDK has been successfully set up and is ready to be used. Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g. $ . <working directory absolute path>/Developer-Package/SDK/environment-setup-cortexa7t2hf-neon-vfpv4-ostl-linux-gnueabi |
For arm64 host architecture tar xvf en.sdk-aarch64-stm32mp1-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.tar.gz
chmod +x stm32mp1-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26/st-image-weston-openstlinux-weston-stm32mp1-aarch64-toolchain-4.2.4-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.sh
./stm32mp1-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26/st-image-weston-openstlinux-weston-stm32mp1-aarch64-toolchain-4.2.4-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.sh -d <working directory absolute path>/Developer-Package/SDK
ST OpenSTLinux - Weston - (A Yocto Project Based Distro) SDK installer version 4.2.1-openstlinux-6.1-yocto-mickledore-mp1-v23.06.21 =================================================================================================================================== You are about to install the SDK to "<working directory absolute path>/Developer-Package/SDK". Proceed [Y/n]? Extracting SDK.........................................................................................................................................................................................................................done Setting it up...done SDK has been successfully set up and is ready to be used. Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g. $ . <working directory absolute path>/Developer-Package/SDK/environment-setup-cortexa7t2hf-neon-vfpv4-ostl-linux-gnueabi | |
Release note |
Details about the content of the SDK are available in the associated STM32 MPU ecosystem release note.
|
- The SDK is in the <SDK installation directory>:
<SDK installation directory> SDK for OpenSTLinux distribution: details in Standard SDK directory structure article ├── environment-setup-cortexa7t2hf-neon-vfpv4-ostl-linux-gnueabi Environment setup script for Developer Package ├── site-config-cortexa7t2hf-neon-vfpv4-ostl-linux-gnueabi ├── sysroots │ ├── cortexa7t2hf-neon-vfpv4-ostl-linux-gnueabi Target sysroot (libraries, headers, and symbols) │ │ └── [...] │ └── x86_64-ostl_sdk-linux Native sysroot (libraries, headers, and symbols) │ └── [...] └── version-cortexa7t2hf-neon-vfpv4-ostl-linux-gnueabi
For arm64 host architecture
<SDK installation directory> SDK for OpenSTLinux distribution: details in Standard SDK directory structure article ├── environment-setup-cortexa7t2hf-neon-vfpv4-ostl-linux-gnueabi Environment setup script for Developer Package ├── site-config-cortexa7t2hf-neon-vfpv4-ostl-linux-gnueabi ├── sysroots │ ├── cortexa7t2hf-neon-vfpv4-ostl-linux-gnueabi Target sysroot (libraries, headers, and symbols) │ │ └── [...] │ └── aarch64-ostl_sdk-linux Native sysroot (libraries, headers, and symbols) │ └── [...] └── version-cortexa7t2hf-neon-vfpv4-ostl-linux-gnueabi
The STM32MP2 SDK is delivered through two tarball file named :
- en.sdk-x86_64-stm32mp2-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.tar.gz for x86_64 host architecture
- en.sdk-aarch64-stm32mp2-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.tar.gz for arm64 host architecture
Download and install the STM32MP2 SDK. The software package is provided AS IS, and by downloading it, you agree to be bound to the terms of the software license agreement (SLA0048). The detailed content licenses can be found here.
STM32MP2 Developer Package SDK - STM32MP2-Ecosystem-v5.1.0 release | |
---|---|
Download |
|
Installation | For x86_64 host architecture
tar xvf en.sdk-x86_64-stm32mp2-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.tar.gz
chmod +x stm32mp2-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26/sdk/st-image-weston-openstlinux-weston-stm32mp2-x86_64-toolchain-4.2.4-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.sh
./stm32mp2-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26/sdk/st-image-weston-openstlinux-weston-stm32mp2-x86_64-toolchain-4.2.4-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.sh -d <working directory absolute path>/Developer-Package/SDK
ST OpenSTLinux - Weston - (A Yocto Project Based Distro) SDK installer version 4.2.4-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26 =================================================================================================================================== You are about to install the SDK to "<working directory absolute path>/Developer-Package/SDK". Proceed [Y/n]? Extracting SDK.........................................................................................................................................................................................................................done Setting it up...done SDK has been successfully set up and is ready to be used. Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g. $ . <working directory absolute path>/Developer-Package/SDK/environment-setup-cortexa35-ostl-linux |
For arm64 host architecture tar xvf en.sdk-aarch64-stm32mp2-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.tar.gz
chmod +x stm32mp2-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26/sdk/st-image-weston-openstlinux-weston-stm32mp2-aarch64-toolchain-4.2.4-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.sh
./stm32mp2-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26/sdk/st-image-weston-openstlinux-weston-stm32mp2-aarch64-toolchain-4.2.4-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.sh -d <working directory absolute path>/Developer-Package/SDK
ST OpenSTLinux - Weston - (A Yocto Project Based Distro) SDK installer version 4.2.4-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26 =================================================================================================================================== You are about to install the SDK to "<working directory absolute path>/Developer-Package/SDK". Proceed [Y/n]? Extracting SDK.........................................................................................................................................................................................................................done Setting it up...done SDK has been successfully set up and is ready to be used. Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g. $ . <working directory absolute path>/Developer-Package/SDK/environment-setup-cortexa35-ostl-linux | |
Release note |
Details about the content of the SDK are available in the associated STM32 MPU ecosystem release note.
|
- The SDK is in the <SDK installation directory>:
<SDK installation directory> SDK for OpenSTLinux distribution: details in Standard SDK directory structure article ├── environment-setup-cortexa35-ostl-linux Environment setup script for Developer Package ├── site-config-cortexa35-ostl-linux ├── sysroots │ ├── cortexa35-ostl-linux Target sysroot (libraries, headers, and symbols) │ │ └── [...] │ └── x86_64-ostl_sdk-linux Native sysroot (libraries, headers, and symbols) │ └── [...] └── version-cortexa35-ostl-linux
For arm64 host architecture
<SDK installation directory> SDK for OpenSTLinux distribution: details in Standard SDK directory structure article ├── environment-setup-cortexa35-ostl-linux Environment setup script for Developer Package ├── site-config-cortexa35-ostl-linux ├── sysroots │ ├── cortexa35-ostl-linux Target sysroot (libraries, headers, and symbols) │ │ └── [...] │ └── aarch64-ostl_sdk-linux Native sysroot (libraries, headers, and symbols) │ └── [...] └── version-cortexa35-ostl-linux
5.1.1. Starting up the SDK[edit source]
The SDK environment setup script must be run once in each new working terminal in which you cross-compile:
For STM32MP1 series
source <SDK installation directory>/environment-setup-cortexa7t2hf-neon-vfpv4-ostl-linux-gnueabi
The following checkings allow to ensure that the environment is correctly setup:
- Check the target architecture
echo $ARCH arm
- Check the toolchain binary prefix for the target tools
echo $CROSS_COMPILE arm-ostl-linux-gnueabi-
- Check the C compiler version
$CC --version arm-ostl-linux-gnueabi-gcc (GCC) <GCC version> [...]
- Check that the SDK version is the expected one
echo $OECORE_SDK_VERSION <expected SDK version>
source <SDK installation directory>/environment-setup-cortexa35-ostl-linux
The following checkings allow to ensure that the environment is correctly setup:
- Check the target architecture
echo $ARCH arm64
- Check the toolchain binary prefix for the target tools
echo $CROSS_COMPILE aarch64-ostl-linux-
- Check the C compiler version
$CC --version aarch64-ostl-linux-gcc (GCC) <GCC version> [...]
- Check that the SDK version is the expected one
echo $OECORE_SDK_VERSION <expected SDK version>
If any of these commands fails or does not return the expected result, try to reinstall the SDK.
5.2. Installing the OpenSTLinux BSP packages[edit source]
Optional step: it is mandatory only if you want to modify the BSP (Linux kernel, TF-A, U-Boot, OP-TEE OS), or to add external out-of-tree Linux kernel modules.
For STM32MP1 series:
The software package is provided AS IS, and by downloading it, you agree to be bound to the terms of the software license agreement (SLA0048). The detailed content licenses can be found here.
- The OpenSTLinux BSP package is delivered through a tarball file named en.sources-stm32mp1-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.tar.gz for STM32MP157x-EV1
, STM32MP157x-DKx
and STM32MP135x-DK
boards.
- Download and install the STM32MP1 OpenSTLinux BSP package.
STM32MP1 Developer Package - STM32MP1 ecosystem v5.1.0 release | |
---|---|
Download |
|
Installation |
cd <working directory path>/Developer-Package
tar xvf en.sources-stm32mp1-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.tar.gz |
Release note |
Details about the content of the OpenSTLinux BSP package are available in the associated STM32 MPU OpenSTLinux release note.
|
- In the <Developer Package installation directory>/stm32mp1-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26/sources/arm-ostl-linux-gnueabi, a tarball archive of the OpenSTLinux BSP components can be found.
- The Linux kernel installation directory is named linux-stm32mp-<kernel version>:
linux-stm32mp-6.1.82-stm32mp-r2-r0 Linux kernel installation directory ├── [*].patch ST patches to apply during the Linux kernel preparation (see next chapter) ├── fragment-[*].config ST configuration fragments to apply during the Linux kernel configuration (see next chapter) ├── optional-fragment-[*].config Optional ST configuration fragments to apply during the Linux kernel configuration depending on your needs (SMP or not, signature or not, ...) ├── linux-6.1.82.tar.xz Tarball file of the Linux kernel source code ├── README.HOW_TO.txt Helper file for Linux kernel management: reference for Linux kernel build └── series List of all ST patches to apply
- The gcnano driver installation directory is named gcnano-driver-stm32mp-<gcnano driver version>:
gcnano-driver-stm32mp-6.4.15-stm32mp1-r1-r0/ gcnano-driver installation directory ├── gcnano-driver-stm32mp-6.4.15-stm32mp1-r1-r0.tar.xz Tarball file of the gcnano-driver source code └── README.HOW_TO.txt Helper file for gcnano-driver management: reference for gcnano-driver build
- The U-Boot installation directory is named u-boot-stm32mp-<U-Boot version>:
u-boot-stm32mp-v2022.10-stm32mp-r2-r0 U-Boot installation directory ├── [*].patch ST patches to apply during the U-Boot preparation (see next chapter) ├── fiptool-stm32mp tool for fip generation ├── u-boot-stm32mp-v2022.10-stm32mp-r2-r0 U-Boot source code directory ├── Makefile.sdk Makefile for the U-Boot compilation ├── README.HOW_TO.txt Helper file for U-Boot management: reference for U-Boot build ├── series List of all ST patches to apply └── u-boot-stm32mp-v2022.10-stm32mp-r2-r0.tar.xz Tarball file of the U-Boot source code
- The TF-A installation directory is named tf-a-stm32mp-<TF-A version>:
tf-a-stm32mp-v2.8.15-stm32mp-r2-r0 TF-A installation directory ├── [*].patch ST patches to apply during the TF-A preparation (see next chapter) ├── fiptool-stm32mp tool for fip generation ├── tf-a-stm32mp-v2.8.15-stm32mp-r2-r0 TF-A source code directory ├── Makefile.sdk Makefile for the TF-A compilation ├── README.HOW_TO.txt Helper file for TF-A management: reference for TF-A build ├── series List of all ST patches to apply └── tf-a-stm32mp-v2.8.15-stm32mp-r2-r0.tar.xz Tarball file of the TF-A source code
- The OP-TEE installation directory is named optee-os-stm32mp-<OP-TEE version>:
optee-os-stm32mp-3.19.0-stm32mp-r2-r0/ OP-TEE installation directory ├── [*].patch ST patches to apply during the OP-TEE preparation (see next chapter) ├── fiptool-stm32mp tool for fip generation ├── optee-os-stm32mp-3.19.0-stm32mp-r2-r0 OP-TEE source code directory ├── fonts.tar.gz fonts for OPTEE-OS ├── Makefile.sdk Makefile for the OP-TEE compilation ├── optee-os-stm32mp-3.19.0-stm32mp-r2-r0.tar.xz Tarball file of the OP-TEE source code ├── README.HOW_TO.txt Helper file for OP-TEE management: reference for OP-TEE build └── series List of all ST patches to apply
- The FIP artifacts directory is named FIP_artifacts:
FIP_artifacts ├── arm-trusted-firmware │ ├── fwconfig │ │ ├── stm32mp13[*]-fw-config-optee.dtb Device tree for FW config → STM32MP13 boards │ │ └── stm32mp15[*]-fw-config-optee.dtb Device tree for FW config → STM32MP15 boards │ ├── metada.bin Store boot information │ ├── tf-a-stm32mp13[*].stm32 FSBL binary→ STM32MP13 boards │ └── tf-a-stm32mp15[*].stm32 FSBL binary → STM32MP15 boards ├── optee │ ├── tee-header_v2-stm32mp13[*].bin Binary file for OP-TEE OS → STM32MP13 boards │ ├── tee-header_v2-stm32mp15[*].bin Binary file for OP-TEE OS → STM32MP15 kits │ ├── tee-pageable_v2-stm32mp13[*].bin Binary file for OP-TEE OS → STM32MP13 boards │ ├── tee-pageable_v2-stm32mp15[*].bin Binary file for OP-TEE OS → STM32MP15 boards │ ├── tee-pager_v2-stm32mp13[*].bin Binary file for OP-TEE OS → STM32MP13 boards │ └── tee-pager_v2-stm32mp15[*].bin Binary file for OP-TEE OS → STM32MP15 boards └── u-boot ├── u-boot-nodtb-stm32mp13-default.bin ├── u-boot-nodtb-stm32mp15-default.bin ├── u-boot-nodtb-stm32mp13-fastboot-sdcard.bin Binary file for fastboot on SD-Card for STM32MP13 boards ├── u-boot-nodtb-stm32mp15-fastboot-emmc.bin Binary file for fastboot on eMMC for STM32MP15 boards ├── u-boot-nodtb-stm32mp15-fastboot-sdcard.bin Binary file for fastboot on SD-Card for STM32MP15 boards ├── u-boot-stm32mp13[*].dtb Device tree for U-Boot → STM32MP13 boards └── u-boot-stm32mp15[*].dtb Device tree for U-Boot → STM32MP15 boards
- The debug symbol files are located under the <Developer Package installation directory>/stm32mp1-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26/images/stm32mp1 directory:
The software package is provided AS IS, and by downloading it, you agree to be bound to the terms of the software license agreement (SLA0048). The detailed content licenses can be found here.
- The OpenSTLinux BSP package is delivered through a tarball file named en.sources-stm32mp2-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.tar.gz for STM32MP257F-EV1
boards.
- Download and install the STM32MPU OpenSTLinux BSP package.
STM32MPU Developer Package - STM32MPU ecosystem v5.1.0 release | |
---|---|
Download |
|
Installation |
cd <working directory path>/Developer-Package
tar xvf en.sources-stm32mp2-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26.tar.gz |
Release note |
Details about the content of the OpenSTLinux BSP package are available in the associated STM32 MPU OpenSTLinux release note.
|
- In sub-directories from <Developer Package installation directory>/stm32mp2-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26/sources/aarch64-ostl-linux, several tarball archive of the OpenSTLinux BSP components can be found.
- The external device tree directory is named external-dt-<ext-dt version>:
external-dt-v5.0-stm32mp-r1-r0 external device tree installation directory ├── external-dt-v5.0-stm32mp-r1-r0.tar.xz Tarball file of the external device tree source code └── README.HOW_TO.txt Helper file for external device tree management: reference for external device tree usage
- The Linux kernel installation directory is named linux-stm32mp-<kernel version>:
linux-stm32mp-6.1.82-stm32mp-r2-r0 Linux kernel installation directory ├── [*].patch ST patches to apply during the Linux kernel preparation (see next chapter) ├── fragment-[*].config ST configuration fragments to apply during the Linux kernel configuration (see next chapter) ├── optional-fragment-[*].config Optional ST configuration fragments to apply during the Linux kernel configuration depending on your needs (SMP or not, signature or not, ...) ├── linux-6.1.82.tar.xz Tarball file of the Linux kernel source code ├── README.HOW_TO.txt Helper file for Linux kernel management: reference for Linux kernel build └── series List of all ST patches to apply
- The gcnano driver installation directory is named gcnano-driver-stm32mp-<gcnano driver version>:
gcnano-driver-stm32mp-6.4.15-stm32mp2-r1-r0/ gcnano-driver installation directory ├── [*].patch ST patches to apply during the gcnano driver preparation (see next chapter) ├── gcnano-driver-stm32mp-6.4.15-stm32mp2-r1-r0.tar.xz Tarball file of the gcnano-driver source code ├── README.HOW_TO.txt Helper file for gcnano-driver management: reference for gcnano-driver build └── series List of all ST patches to apply
- The ddr phy installation directory is named stm32mp-ddr-phy-<ddr phy version>:
stm32mp-ddr-phy-A2022.11-r0 ddr-phy installation directory ├── stm32mp-ddr-phy-A2022.11-r0.tar.xz Tarball file of the stm32mp-ddr-phy binaries └── README.HOW_TO.txt Helper file for ddr phy management: reference for ddr-phy use
- The OP-TEE installation directory is named optee-os-stm32mp-<OP-TEE version>:
optee-os-stm32mp-3.19.0-stm32mp-r2-r0 OP-TEE installation directory ├── [*].patch ST patches to apply during the OP-TEE preparation (see next chapter) ├── fiptool-stm32mp tool for fip generation ├── fonts.tar.gz fonts for OPTEE-OS ├── Makefile.sdk Makefile for the OP-TEE compilation ├── optee-os-stm32mp-3.19.0-stm32mp-r2-r0.tar.xz Tarball file of the OP-TEE source code ├── README.HOW_TO.txt Helper file for OP-TEE management: reference for OP-TEE build └── series List of all ST patches to apply
- The U-Boot installation directory is named u-boot-stm32mp-<U-Boot version>:
u-boot-stm32mp-v2022.10-stm32mp-r2-r0 U-Boot installation directory ├── [*].patch ST patches to apply during the U-Boot preparation (see next chapter) ├── fiptool-stm32mp tool for fip generation ├── fragment-[*].fb_cfg ST configuration fragments to apply during the U-Boot configuration to support fastboot ├── Makefile.sdk Makefile for the U-Boot compilation ├── README.HOW_TO.txt Helper file for U-Boot management: reference for U-Boot build ├── series List of all ST patches to apply └── u-boot-stm32mp-v2022.10-stm32mp-r2-r0.tar.xz Tarball file of the U-Boot source code
- The TF-A installation directory is named tf-a-stm32mp-<TF-A version>:
tf-a-stm32mp-v2.8.15-stm32mp-r2-r0 TF-A installation directory ├── [*].patch ST patches to apply during the TF-A preparation (see next chapter) ├── fiptool-stm32mp tool for fip generation ├── Makefile.sdk Makefile for the TF-A compilation ├── README.HOW_TO.txt Helper file for TF-A management: reference for TF-A build ├── series List of all ST patches to apply ├── tf-a-st-ddr.tar.gz Tarball file of the DDR firmware └── tf-a-stm32mp-v2.8.15-stm32mp-r2-r0.tar.xz Tarball file of the TF-A source code
- The FIP artifacts directory is named FIP_artifacts:
FIP_artifacts ├── arm-trusted-firmware │ ├── bl2 │ │ ├── tf-a-stm32mp257f-dk-[*]-optee-emmc.bin TF-A binary for FSBL partition (eMMC boot device) for STM32MP257F-DK OSTL → STM32MP25 Discovery boards │ │ ├── tf-a-stm32mp257f-dk-[*]-optee-sdcard.bin TF-A binary for FSBL partition (microSD card boot device) for STM32MP257F-DK OSTL → STM32MP25 Discovery boards │ │ ├── tf-a-stm32mp257f-dk-[*]-uart.bin TF-A binary for uart serial boot partition (STM32CubeProgrammer) for STM32MP257F-DK OSTL → STM32MP25 Discovery boards │ │ ├── tf-a-stm32mp257f-dk-[*]-usb.bin TF-A binary for usb serial boot partition (STM32CubeProgrammer) for STM32MP257F-DK OSTL → STM32MP25 Discovery boards │ │ ├── tf-a-stm32mp257f-dk-optee-emmc.bin │ │ ├── tf-a-stm32mp257f-dk-optee-sdcard.bin │ │ ├── tf-a-stm32mp257f-dk-uart.bin │ │ ├── tf-a-stm32mp257f-dk-usb.bin │ │ ├── tf-a-stm32mp257f-ev1-[*]-optee-emmc.bin TF-A binary for FSBL partition (eMMC boot device) for STM32MP257F-EV1 OSTL → STM32MP25 Evaluation boards │ │ ├── tf-a-stm32mp257f-ev1-[*]-optee-sdcard.bin TF-A binary for FSBL partition (microSD card boot device) for STM32MP257F-EV1 OSTL → STM32MP25 Evaluation boards │ │ ├── tf-a-stm32mp257f-ev1-[*]-uart.bin TF-A binary for uart serial boot partition (STM32CubeProgrammer) for STM32MP257F-EV1 OSTL → STM32MP25 Evaluation boards │ │ ├── tf-a-stm32mp257f-ev1-[*]-usb.bin TF-A binary for usb serial boot partition (STM32CubeProgrammer) for STM32MP257F-EV1 OSTL → STM32MP25 Evaluation boards │ │ ├── tf-a-stm32mp257f-ev1-optee-emmc.bin │ │ ├── tf-a-stm32mp257f-ev1-optee-nor.bin │ │ ├── tf-a-stm32mp257f-ev1-optee-sdcard.bin │ │ ├── tf-a-stm32mp257f-ev1-uart.bin │ │ └── tf-a-stm32mp257f-ev1-usb.bin │ ├── bl31 │ │ ├── stm32mp257f-dk-[*]-bl31-optee-emmc.dtb TF-A dtb for eMMC boot device for STM32MP257F-DK OSTL → STM32MP25 Discovery boards │ │ ├── stm32mp257f-dk-[*]-bl31-optee-sdcard.dtb TF-A dtb for sdcard boot device for STM32MP257F-DK OSTL → STM32MP25 Discovery boards │ │ ├── stm32mp257f-ev1-[*]-bl31-optee-emmc.dtb TF-A dtb for eMMC boot device for STM32MP257F-EV1 OSTL → STM32MP25 Evaluation boards │ │ ├── stm32mp257f-ev1-[*]-bl31-optee-nor.dtb TF-A dtb for nor boot device for STM32MP257F-EV1 OSTL → STM32MP25 Evaluation boards │ │ ├── stm32mp257f-ev1-[*]-bl31-optee-sdcard.dtb TF-A dtb for sdcard boot device for STM32MP257F-EV1 OSTL → STM32MP25 Evaluation boards │ │ ├── tf-a-bl31-stm32mp25-optee-emmc.bin │ │ ├── tf-a-bl31-stm32mp25-optee-nor.bin │ │ └── tf-a-bl31-stm32mp25-optee-sdcard.bin │ ├── ddr │ │ ├── ddr_pmu-stm32mp257f-dk-[*]-optee-emmc.bin Trained DDR for STM32MP257F-DK OSTL → STM32MP25 Discovery boards │ │ ├── ddr_pmu-stm32mp257f-dk-[*]-optee-sdcard.bin Trained DDR for STM32MP257F-DK OSTL → STM32MP25 Discovery boards │ │ ├── ddr_pmu-stm32mp257f-dk-[*]-uart.bin Trained DDR for STM32MP257F-DK OSTL → STM32MP25 Discovery boards │ │ ├── ddr_pmu-stm32mp257f-dk-[*]-usb.bin Trained DDR for STM32MP257F-DK OSTL → STM32MP25 Discovery boards │ │ ├── ddr_pmu-stm32mp257f-ev1-[*]-optee-emmc.bin Trained DDR for STM32MP257F-EV1 OSTL → STM32MP25 Evaluation boards │ │ ├── ddr_pmu-stm32mp257f-ev1-[*]-optee-nor.bin Trained DDR for STM32MP257F-EV1 OSTL → STM32MP25 Evaluation boards │ │ ├── ddr_pmu-stm32mp257f-ev1-[*]-optee-sdcard.bin Trained DDR for STM32MP257F-EV1 OSTL → STM32MP25 Evaluation boards │ │ ├── ddr_pmu-stm32mp257f-ev1-[*]-uart.bin Trained DDR for STM32MP257F-EV1 OSTL → STM32MP25 Evaluation boards │ │ └── ddr_pmu-stm32mp257f-ev1-[*]-usb.bin Trained DDR for STM32MP257F-EV1 OSTL → STM32MP25 Evaluation boards │ ├── fwconfig │ │ ├── stm32mp257f-dk-[*]-fw-config-optee-emmc.dtb │ │ ├── stm32mp257f-dk-[*]-fw-config-optee-sdcard.dtb │ │ ├── stm32mp257f-ev1-[*]-fw-config-optee-emmc.dtb │ │ ├── stm32mp257f-ev1-[*]-fw-config-optee-nor.dtb │ │ └── stm32mp257f-ev1-[*]-fw-config-optee-sdcard.dtb │ ├── metadata.bin │ ├── tf-a-stm32mp257f-dk-[*]-optee-emmc.stm32 TF-A binary for FSBL partition (eMMC boot device) for STM32MP257F-DK OSTL → STM32MP25 Discovery boards │ ├── tf-a-stm32mp257f-dk-[*]-optee-sdcard.stm32 TF-A binary for FSBL partition (microSD card boot device) for STM32MP257F-DK OSTL → STM32MP25 Discovery boards │ ├── tf-a-stm32mp257f-dk-[*]-uart.stm32 TF-A binary for uart serial boot partition (nor boot device) for STM32MP257F-DK OSTL → STM32MP25 Discovery boards │ ├── tf-a-stm32mp257f-dk-[*]-usb.stm32 TF-A binary for usb serial boot partition (nor boot device) for STM32MP257F-DK OSTL → STM32MP25 Discovery boards │ ├── tf-a-stm32mp257f-ev1-[*]-optee-emmc.stm32 TF-A binary for FSBL partition (eMMC boot device) for STM32MP257F-EV1 OSTL → STM32MP25 Evaluation boards │ ├── tf-a-stm32mp257f-ev1-[*]-optee-nor.stm32 TF-A binary for FSBL partition (nor boot device) for STM32MP257F-EV1 OSTL → STM32MP25 Evaluation boards │ ├── tf-a-stm32mp257f-ev1-[*]-optee-sdcard.stm32 TF-A binary for FSBL partition (microSD card boot device) for STM32MP257F-EV1 OSTL → STM32MP25 Evaluation boards │ ├── tf-a-stm32mp257f-ev1-[*]-uart.stm32 TF-A binary for uart serial boot partition (nor boot device) for STM32MP257F-EV1 OSTL → STM32MP25 Evaluation boards │ └── tf-a-stm32mp257f-ev1-[*]-usb.stm32 TF-A binary for usb serial boot partition (nor boot device) for STM32MP257F-EV1 OSTL → STM32MP25 Evaluation boards ├── optee │ ├── tee-header_v2-stm32mp25[*].bin │ ├── tee-pageable_v2-stm32mp25[*].bin │ └── tee-pager_v2-stm32mp25[*].bin └── u-boot ├── u-boot-nodtb-stm32mp25-default.bin U-Boot binary → STM32MP5 boards ├── u-boot-nodtb-stm32mp25-fastboot-emmc.bin U-Boot binary with fastboot on eMMC→ STM32MP5 boards ├── u-boot-nodtb-stm32mp25-fastboot-sdcard.bin U-Boot binary with fastboot on SD-Card→ STM32MP5 boards └── u-boot-stm32mp25[*].dtb Device tree for U-Boot → STM32MP5 boards
- The debug symbol files are located under the <Developer Package installation directory>/stm32mp2-openstlinux-6.1-yocto-mickledore-mpu-v24.06.26/images/stm32mp2 directory:
5.2.1. Building and deploying the external device tree for the first time (only on STM32MP25x lines
)[edit source]
Prerequisite: the SDK is installed.
Open the <external device tree installation directory>/README.HOW_TO.txt helper file, and execute its instructions to:
☐ setup a software configuration management (SCM) system (git) for the external device tree (optional but recommended)
☐ export the path of external device tree directory into the variable EXTDT_DIR
The external device tree is now set-up and can be used during compilation.
5.2.2. Building and deploying the Linux kernel for the first time[edit source]
Prerequisite: the SDK is installed. It is mandatory to execute once the steps specified below before modifying the Linux kernel, or adding external out-of-tree Linux kernel modules.
The partitions related to the Linux kernel are:
- the bootfs partition that contains the Linux kernel U-Boot image (uImage) and device tree
- the rootfs partition that contains the Linux kernel modules
The Linux kernel might be cross-compiled, either in the source code directory, or in a dedicated directory different from the source code directory.
This last method is recommended as it clearly separates the files generated by the cross-compilation from the source code files.
![]() |
The README.HOW_TO.txt helper file is THE reference for the Linux kernel build |
Open the <Linux kernel installation directory>/README.HOW_TO.txt helper file, and execute its instructions to:
☐ setup a software configuration management (SCM) system (git) for the Linux kernel (optional but recommended)
☐ prepare the Linux kernel (applying the ST patches)
☐ configure the Linux kernel (applying the ST fragments)
☐ cross-compile the Linux kernel
☐ deploy the Linux kernel (i.e. update the software on board)
The Linux kernel is now installed: let's modify the Linux kernel.
5.2.3. Building and deploying the gcnano-driver for the first time (only on STM32MP15x lines
and STM32MP25x lines
)[edit source]
Prerequisite:
- the SDK is installed.
- the Linux kernel is built as explained here
It is mandatory to execute once the steps specified below before modifying gcnano-driver.
A kernel module depends on the Linux kernel version. If kernel module is not built with the correct Linux kernel, the kernel could refuse the module to be loaded.
![]() |
The README.HOW_TO.txt helper file is THE reference for the gcnano-driver build |
Open the <gcnano-driver installation directory>/README.HOW_TO.txt helper file, and execute its instructions to:
☐ setup a software configuration management (SCM) system (git) for the gcnano-driver (optional but recommended)
☐ cross-compile the gcnano-driver
☐ deploy the gcnano-driver (i.e. update the software on board)
The gcnano-driver is now installed.
5.2.4. Building and deploying the U-Boot for the first time[edit source]
Prerequisite: the SDK is installed. It is mandatory to execute once the steps specified below before modifying the U-Boot.
As explained in the boot chain overview, the trusted boot chain is the default solution delivered by STMicroelectronics.
Within this scope, the partition related to the U-Boot is the ssbl one that contains the U-Boot and its device tree blob.
![]() |
The README.HOW_TO.txt helper file is THE reference for the U-Boot build |
Open the <U-Boot installation directory>/README.HOW_TO.txt helper file, and execute its instructions to:
☐ setup a software configuration management (SCM) system (git) for the U-Boot (optional but recommended)
☐ prepare the U-Boot (applying the ST patches)
☐ cross-compile the U-Boot
☐ deploy the U-Boot (i.e. update the software on board)
The U-Boot is now installed: let's modify the U-Boot.
5.2.5. Building and deploying the TF-A for the first time[edit source]
Prerequisite: the SDK is installed. It is mandatory to execute once the steps specified below before modifying the TF-A.
As explained in the boot chain overview, the trusted boot chain is the default solution delivered by STMicroelectronics.
Within this scope, the partition related to the TF-A is the fsbl one.
![]() |
The README.HOW_TO.txt helper file is THE reference for the TF-A build |
Open the <TF-A installation directory>/README.HOW_TO.txt helper file, and execute its instructions to:
☐ setup a software configuration management (SCM) system (git) for the TF-A (optional but recommended)
☐ prepare the TF-A (applying the ST patches)
☐ cross-compile the TF-A
☐ deploy the TF-A (i.e. update the software on board)
The TF-A is now installed: let's modify the TF-A.
5.2.6. Building and deploying the OP-TEE for the first time[edit source]
Prerequisite: the SDK is installed. It is mandatory to execute once the steps specified below before modifying the OP-TEE.
As explained in the boot chain overview, the trusted boot chain is the default solution delivered by STMicroelectronics. Within this scope, the partition related to the OP-TEE is the fsbl one.
![]() |
The README.HOW_TO.txt helper file is THE reference for the OP-TEE build |
Open the <OP-TEE installation directory>/README.HOW_TO.txt helper file, and execute its instructions to:
☐ setup a software configuration management (SCM) system (git) for the OP-TEE (optional but recommended)
☐ prepare the OP-TEE (applying the ST patches)
☐ cross-compile the OP-TEE
☐ deploy the OP-TEE (i.e. update the software on board)
The OP-TEE is now installed: let's modify the OP-TEE.
5.3. Installing the debug symbol files[edit source]
Optional step: it is mandatory only if you want to debug Linux® kernel, U-Boot, OP-TEE or TF-A with GDB.
5.3.1. Using the debug symbol files[edit source]
These files are used to debug the Linux® kernel, U-Boot, OP-TEE or TF-A with GDB. Especially, the Debug OpenSTLinux BSP components chapter explains how to load the debug symbol files in GDB.
6. Installing the components to develop software running on Arm Cortex-M (STM32CubeMPU Package) ( only on STM32MP15x lines
and STM32MP25x lines
)[edit source]
6.1. Installing STM32CubeIDE[edit source]
Optional step: it is needed if you want to modify or add software running on Arm Cortex-M.
The table below explains how to download and install STM32CubeIDE which addresses STM32 MCU, and also provides support for Cortex-M inside STM32 MPU.
STM32 MPU support, inside STM32CubeIDE, is available on Linux® and Windows® host PCs, but it is NOT on macOS®.
STM32CubeIDE for Linux® host PC | STM32CubeIDE for Windows® host PC | |
---|---|---|
Download |
Version 1.16.0
|
Version 1.16.0
|
Installation guide | ||
User manual | ||
Detailed release note |
| |
Errata |
Minor releases may be available from the update site. Check chapter 10 in (UM2609) for more information on how to update STM32CubeIDE.
6.2. Installing the STM32CubeMPU Package[edit source]
Optional step: it is mandatory only if you want to modify the STM32CubeMPU Package.
Prerequisite: the STM32CubeIDE is installed.
For STM32MP1 series:
- The STM32CubeMP1 Package is delivered through an archive file named en.stm32cube_fw_mp1_v1.6.0.zip.
- Download and install the STM32CubeMP1 Package
The software package is provided AS IS, and by downloading it, you agree to be bound to the terms of the software license agreement (SLA0048). The detailed content licenses can be found here..
STM32MP1 Developer Package STM32CubeMP1 Package - v5.1.0 release | |
---|---|
Download |
|
Installation |
cd <working directory path>/Developer-Package
unzip en.stm32cube_fw_mp1_v1.6.0.zip |
Release note |
Details about the content of the STM32CubeMP1 Package are available in the STM32Cube_FW_MP1_V1.6.0/Release_Notes.html file.
|
- The STM32CubeMP1 Package installation directory is in the <Developer Package installation directory> directory, and is named STM32Cube_FW_MP1_V1.6.0:
STM32Cube_FW_MP1_V1.6.0 STM32CubeMP1 Package: details in STM32CubeMP15 Package content article ├── Drivers │ ├── BSP BSP drivers for the supported STM32MP1 boards │ │ └── [...] │ ├── CMSIS │ │ └── [...] │ └── STM32MP1xx_HAL_Driver HAL drivers for the supported STM32MP1 devices │ └── [...] ├── _htmresc │ └── [...] ├── License.md ├── Middlewares │ └── [...] ├── package.xml ├── Projects │ ├── STM32CubeProjectsList.html List of examples and applications for STM32CubeMP1 Package │ ├── STM32MP157C-DK2 Set of examples and applications → STM32MP15 Discovery kits │ │ └── [...] │ └── STM32MP157C-EV1 Set of examples and applications → STM32MP15 Evaluation boards │ └── [...] ├── Readme.md ├── Release_Notes.html Release note for STM32CubeMP1 Package └── Utilities └── [...]
- The STM32CubeMP2 Package is delivered through an archive file named en.stm32cubemp2-v1.0.0.zip.
- Download and install the STM32CubeMP2 Package
The software package is provided AS IS, and by downloading it, you agree to be bound to the terms of the software license agreement (SLA0048). The detailed content licenses can be found here.
STM32MP2 Developer Package STM32CubeMP2 Package - v5.1.0 release | |
---|---|
Download |
|
Installation |
cd <working directory path>/Developer-Package
unzip en.stm32cubemp2-v1.0.0.zip |
Release note |
Details about the content of the STM32CubeMP2Package are available in the STM32CubeMP2/Release_Notes.html file.
|
- The STM32CubeMP2 Package installation directory is in the <Developer Package installation directory> directory, and is named STM32Cube_FW_MP2_V1.0.0:
STM32Cube_FW_MP2_V1.0.0 STM32CubeMP2 Package: details in STM32CubeMP2 Package content article ├── Drivers │ ├── BSP BSP drivers for the supported STM32MP2 boards │ │ └── [...] │ ├── CMSIS │ │ └── [...] │ └── STM32MP2xx_HAL_Driver HAL drivers for the supported STM32MP2 devices │ └── [...] ├── _htmresc │ └── [...] ├── License.md ├── Middlewares │ └── [...] ├── package.xml ├── Projects │ ├── STM32CubeProjectsList.html List of examples and applications for STM32CubeMP2 Package │ └── STM32MP257F-EV1 Set of examples and applications → STM32MP25 Evaluation boards │ └── [...] ├── Readme.md ├── Release_Notes.html Release note for STM32CubeMP2 Package └── Utilities └── [...]
The STM32CubeMPU Package is now installed: let's develop software running on Arm Cortex-M.
7. Developing software running on Arm Cortex-A[edit source]
7.1. Modifying the Linux kernel[edit source]
Prerequisites:
The <Linux kernel installation directory>/README.HOW_TO.txt helper file gives the commands to:
☐ configure the Linux kernel
☐ cross-compile the Linux kernel
☐ deploy the Linux kernel (that is, update the software on board)
You can refer to the following simple examples:
- Modification of the kernel configuration
- Modification of the device tree
- Modification of a built-in device driver
- Modification of an external in-tree module
- Adding an external out-of-tree Linux kernel module
7.2. Adding Linux user space applications[edit source]
Prerequisites:
- the SDK is installed
- the SDK is started up
Once a suitable cross-toolchain (OpenSTLinux SDK) is installed, it is easy to develop a project outside of the OpenEmbedded build system.
There are different ways to use the SDK toolchain directly, among which Makefile and Autotools.
Whatever the method, it relies on:
- the sysroot that is associated with the cross-toolchain, and that contains the header files and libraries needed for generating binaries (see target sysroot)
- the environment variables created by the SDK environment setup script (see SDK startup)
You can refer to the following simple example:
7.3. Modifying the U-Boot[edit source]
Prerequisites:
The <U-Boot installation directory>/README.HOW_TO.txt helper file gives the commands to:
☐ cross-compile the U-Boot
☐ deploy the U-Boot (that is, update the software on board)
You can refer to the following simple example:
7.4. Modifying the TF-A[edit source]
Prerequisites:
The <TF-A installation directory>/README.HOW_TO.txt helper file gives the commands to:
☐ cross-compile the TF-A
☐ deploy the TF-A (that is, update the software on board)
You can refer to the following simple example:
7.5. Modifying the OP-TEE[edit source]
Prerequisites:
The <OP-TEE installation directory>/README.HOW_TO.txt helper file gives the commands to:
☐ cross-compile the OP-TEE
☐ deploy the OP-TEE (that is, update the software on board)
You can refer to the following simple example:
8. Developing software running on Arm Cortex-M[edit source]
Following chapters are valid only on STM32MP15x lines and STM32MP25x lines
.
8.1. How to create a STM32CubeMPU project from scratch or open/modify an existing one from STM32CubeMPU package[edit source]
Refer to:
- STM32CubeMP15 Package for STM32MP15x lines
- STM32CubeMP2 Package for STM32MP25x lines
9. Fast links to essential commands[edit source]
If you are already familiar with the Developer Package for the STM32MPU Embedded Software distribution, fast links to the essential commands are listed below.
![]() |
With the links below, you will be redirected to other articleInstalling the OpenSTLinux BSP packages; use the back button of your browser to come back to these fast links |
10. How to go further?[edit source]
Now that your developments are ready, you might want to switch to the STM32MPU Distribution Package, in order to create your own distribution and to generate your own SDK and image.