Difference between revisions of "STM32MP1 Developer Package"

[unchecked revision] [quality revision]
m (Installing the OpenSTLinux BSP packages)
m (Installing the OpenSTLinux BSP packages)
Applicable for STM32MP13x lines, STM32MP15x lines

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), 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]

If you are not yet familiar with the STM32MPU Embedded Software distribution and its Packages, read the following articles:

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:
      • Linux® kernel
      • gcnano-driver
      • U-Boot
      • Trusted Firmware-A (TF-A)
      • Open source Trusted Execution Environment (OP-TEE)
    • the debug symbol files for Linux® kernel, U-Boot and TF-A
  • for the STM32CubeMPU Package (development on Arm® Cortex®-M processor for STM32MP15x lines More info.png only):
    • all pieces of software (BSP, HAL, middlewares and applications) in source code
    • the integrated development environment (IDE) (STM32CubeIDE)

Note that, the application frameworks for the OpenSTLinux distribution are not available as source code in this Package.


Components of the Developer Package

2 Developer Package step-by-step overview[edit]

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:


3 Checking the prerequisites[edit]

3.1 Knowledges[edit]

The STM32MP1 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]

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.

Development setup for Developer and Distribution Packages


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]

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]

5.1 Installing the SDK[edit]

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.


The STM32MP1 SDK is delivered through a tarball file named : en.SDK-x86_64-stm32mp1-openstlinux-5.15-yocto-kirkstone-mp1-v22.11.23.tar.gz

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 (SLA). The detailed content licenses can be found here.

Warning white.png Warning
To download a package, it is recommended to be logged in to your "myst" account [1]. If, trying to download, you encounter a “403 error”, you could try to empty your browser cache to workaround the problem. We are working on the resolution of this problem.
We apologize for this inconvenience
STM32MP1 Developer Package SDK - STM32MP1-Ecosystem-v4.1.0 release
Download

You need to be logged on my.st.com before accessing the following link:
en.SDK-x86_64-stm32mp1-openstlinux-5.15-yocto-kirkstone-mp1-v22.11.23.tar.gz

Installation
  • Uncompress the tarball file to get the SDK installation script.
 tar xvf en.SDK-x86_64-stm32mp1-openstlinux-5.15-yocto-kirkstone-mp1-v22.11.23.tar.gz
  • If needed, change the permissions on the SDK installation script so that it is executable.
 chmod +x stm32mp1-openstlinux-5.15-yocto-kirkstone-mp1-v22.11.23/sdk/st-image-weston-openstlinux-weston-stm32mp1-x86_64-toolchain-4.0.4-openstlinux-5.15-yocto-kirkstone-mp1-v22.11.23.sh
  • Run the SDK installation script.
    • Use the -d <SDK installation directory absolute path> option to specify the absolute path to the directory in which you want to install the SDK (<SDK installation directory>).
    • If you follow the proposition to organize the working directory, it means:
 ./stm32mp1-openstlinux-5.15-yocto-kirkstone-mp1-v22.11.23/sdk/st-image-weston-openstlinux-weston-stm32mp1-x86_64-toolchain-4.0.4-openstlinux-5.15-yocto-kirkstone-mp1-v22.11.23.sh -d <working directory absolute path>/Developer-Package/SDK
  • A successful installation outputs the following log:
ST OpenSTLinux - Weston - (A Yocto Project Based Distro) SDK installer version 4.0.4-openstlinux-5.15-yocto-kirkstone-mp1-v22.11.23
===================================================================================================================================
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.

Archive box.png If you are interested in older releases, please have a look into the section Archives.

  • 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


Warning white.png Warning
Now that the SDK is installed, do not move or rename the <SDK installation directory>.

5.1.1 Starting up the SDK[edit]

The SDK environment setup script must be run once in each new working terminal in which you cross-compile:

 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>

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]

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.


The software package is provided AS IS, and by downloading it, you agree to be bound to the terms of the software license agreement (SLA). The detailed content licenses can be found here.

Warning white.png Warning
To download a package, it is recommended to be logged in to your "myst" account [2]. If, trying to download, you encounter a “403 error”, you could try to empty your browser cache to workaround the problem. We are working on the resolution of this problem.
We apologize for this inconvenience
  • The OpenSTLinux BSP package is delivered through a tarball file named en.SOURCES-stm32mp1-openstlinux-5.15-yocto-kirkstone-mp1-v22.11.23.tar.gz for STM32MP157x-EV1 More info green.png, STM32MP157x-DKx More info green.png and STM32MP135x-DK Warning.png boards.

  • Download and install the STM32MP1 OpenSTLinux BSP package.
STM32MP1 Developer Package - STM32MP1 ecosystem v4.1.0 release
Download

Log on my.st.com before accessing the following link:
en.SOURCES-stm32mp1-openstlinux-5.15-yocto-kirkstone-mp1-v22.11.23.tar.gz

Installation
 cd <working directory path>/Developer-Package
 tar xvf en.SOURCES-stm32mp1-openstlinux-5.15-yocto-kirkstone-mp1-v22.11.23.tar.gz
Release note

Details about the content of the OpenSTLinux BSP package are available in the associated STM32 MPU OpenSTLinux release note.

Archive box.png For information on older releases, go to Archives.

  • In the <Developer Package installation directory>/, a tarball archive of the OpenSTLinux BSP components can be found.
  • The Linux kernel installation directory is named linux-stm32mp-<kernel version>:
linux-stm32mp-5.15.67-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)
├── linux-5.15.67.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.9-stm32mp-r2-r0		gcnano-driver installation directory
    ├── gcnano-driver-stm32mp-6.4.9-stm32mp-r2-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-v2021.10-stm32mp-r2-r0		U-Boot installation directory
    ├── [*].patch					ST patches to apply during the U-Boot preparation (see next chapter)
    ├── u-boot-stm32mp-v2021.10-stm32mp-r2		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-v2021.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.6-stm32mp-r2-r0		TF-A installation directory
    ├── [*].patch				ST patches to apply during the TF-A preparation (see next chapter)
    ├── tf-a-stm32mp-v2.6-stm32mp-r2	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.6-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.16.0-stm32mp-r2-r0		OP-TEE installation directory
    ├── [*].patch					ST patches to apply during the OP-TEE preparation (see next chapter)
    ├── optee-os-stm32mp-3.16.0-stm32mp-r2		OP-TEE source code directory
    ├── fonts.tar.gz					fonts for OPTEE-OS
    ├── Makefile.sdk					Makefile for the OP-TEE compilation
    ├── optee-os-stm32mp-3.16.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
│   ├── bl32
│   │   ├── stm32mp15[*]				Device tree for TF-A → STM32MP15 boards
│   │   └── tf-a-bl32-stm32mp15.bin			Binary file for bl32 stage
│   ├── 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.bin
    ├── u-boot-nodtb-stm32mp15.bin
    ├── 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-5.15-yocto-kirkstone-mp1-v22.11.23/images/stm32mp1 directory:
stm32mp1
├── arm-trusted-firmware
│   ├── bl32
│   │   └── debug
│   │       └── tf-a-bl32-stm32mp15.elf 	Debug symbol file for TF-A BL32
│   └── debug
│       ├── debug-tf-a-stm32mp13[*].stm32	Debug file for FSBL → STM32MP13 boards
│       ├── debug-tf-a-stm32mp15[*].stm32	Debug file for FSBL → STM32MP15 boards
│       ├── tf-a-bl2-emmc.elf 			Debug symbol file for TF-A → TF-A for emmc boot stage
│       ├── tf-a-bl2-nand.elf 			Debug symbol file for TF-A → TF-A for nand boot stage
│       ├── tf-a-bl2-nor.elf 			Debug symbol file for TF-A → TF-A for nor boot stage
│       ├── tf-a-bl2-sdcard.elf 		Debug symbol file for TF-A → TF-A for SDcard boot stage
│       ├── tf-a-bl2-uart.elf 			Debug symbol file for TF-A → TF-A for UART downloading boot stage
│       └── tf-a-bl2-usb.elf 			Debug symbol file for TF-A → TF-A for USB downloading boot stage
├── kernel
│   ├── config-5.15.67				Reference Config file for Linux kernel 
│   ├── vmlinux					Image of the Linux kernel 
├── optee
│   └── debug
│       ├── tee-stm32mp135f-dk.elf 		Debug symbol file for OP-TEE OS → STM32MP13 Discovery kits
│       ├── tee-stm32mp157a-dk1.elf 		Debug symbol file for OP-TEE OS → STM32MP15 Discovery kits
│       ├── tee-stm32mp157a-ev1.elf 		Debug symbol file for OP-TEE OS → STM32MP15 Evaluation boards
│       ├── tee-stm32mp157c-dk2.elf 		Debug symbol file for OP-TEE OS → STM32MP15 Discovery kits
│       ├── tee-stm32mp157c-ed1.elf 		Debug symbol file for OP-TEE OS → STM32MP15 Evaluation boards
│       ├── tee-stm32mp157c-ev1.elf 		Debug symbol file for OP-TEE OS → STM32MP15 Evaluation boards
│       ├── tee-stm32mp157d-dk1.elf 		Debug symbol file for OP-TEE OS → STM32MP15 Discovery kits
│       ├── tee-stm32mp157d-ev1.elf 		Debug symbol file for OP-TEE OS → STM32MP15 Evaluation boards
│       ├── tee-stm32mp157f-dk2.elf 		Debug symbol file for OP-TEE OS → STM32MP15 Discovery kits
│       ├── tee-stm32mp157f-ed1.elf 		Debug symbol file for OP-TEE OS → STM32MP15 Evaluation boards
│       └── tee-stm32mp157f-ev1.elf 		Debug symbol file for OP-TEE OS → STM32MP15 Evaluation boards
└── u-boot
    └── debug
        ├── u-boot-stm32mp13.elf 		Debug symbol file for U-Boot → STM32MP13 Discovery kits
        └── u-boot-stm32mp15.elf 		Debug symbol file for U-Boot → STM32MP15 boards


5.2.1 Building and deploying the Linux kernel for the first time[edit]

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.

Info white.png Information
The README.HOW_TO.txt helper file is THE reference for the Linux kernel build
Warning white.png Warning
The SDK must be started


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, or add external out-of-tree Linux kernel modules.

5.2.2 Building and deploying the gcnano-driver for the first time (only on STM32MP15x lines More info.png)[edit]

Prerequisite:

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.

Info white.png Information
The README.HOW_TO.txt helper file is THE reference for the gcnano-driver build
Warning white.png Warning
The SDK must be started

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.3 Building and deploying the U-Boot for the first time[edit]

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.

Info white.png Information
The README.HOW_TO.txt helper file is THE reference for the U-Boot build
Warning white.png Warning
The SDK must be started
Warning white.png Warning
On an Ubuntu 18.04 (with a host gcc version prior to 8.0), U-Boot cannot be built because of the usage of an unknown option : -fmacro-prefix-map .


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.4 Building and deploying the TF-A for the first time[edit]

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.

Info white.png Information
The README.HOW_TO.txt helper file is THE reference for the TF-A build
Warning white.png Warning
The SDK must be started


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.5 Building and deploying the OP-TEE for the first time[edit]

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.

Info white.png Information
The README.HOW_TO.txt helper file is THE reference for the OP-TEE build
Warning white.png Warning
The SDK must be started


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]

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]

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-M4 (STM32CubeMPU Package) ( only on STM32MP15x lines More info.png)[edit]

6.1 Installing STM32CubeIDE[edit]

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.11.0

  • Download the preferred all-in-one Linux installer from my.st.com
    • Generic Linux Installer - STM32CubeIDE-Lnx
    • RPM Linux Installer - STM32CubeIDE-RPM
    • Debian Linux Installer - STM32CubeIDE-DEB

Version 1.11.0

  • Download the all-in-one Windows installer from my.st.com
    • Windows Installer - STM32CubeIDE-Win


Installation guide
  • Refer to STM32CubeIDE installation guide (UM2563) available on my.st.com.
User manual
  • When the installation is completed, see additional information about STM32CubeIDE in my.st.com:
    • STM32CubeIDE quick start guide (UM2553)
Detailed release note
  • Details about the content of this tool version are available in the STM32CubeIDE release v1.10.0 release note from my.st.com

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]

Optional step: it is mandatory only if you want to modify the STM32CubeMPU Package.

Prerequisite: the STM32CubeIDE is installed.


  • 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 (SLA). The detailed content licenses can be found here.

Warning white.png Warning
To download a package, it is recommended to be logged in to your "myst" account [3]. If, trying to download, you encounter a “403 error”, you could try to empty your browser cache to workaround the problem. We are working on the resolution of this problem.
We apologize for this inconvenience
.
STM32MP1 Developer Package STM32CubeMP1 Package - v4.1.0 release
Download

You need to be logged on my.st.com before accessing the following link:
en.STM32Cube_FW_MP1_V1.6.0.zip

Installation
 cd <working directory path>/Developer-Package
  • Download the archive file in this directory
  • Uncompress the archive file to get the STM32CubeMP1 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.

Archive box.png If you are interested in older releases, please have a look into the section Archives.

  • 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 STM32CubeMP1 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 STM32CubeMPU Package is now installed: let's develop software running on Arm Cortex-M4.

7 Developing software running on Arm Cortex-A7[edit]

7.1 Modifying the Linux kernel[edit]

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:

7.2 Adding external out-of-tree Linux kernel modules[edit]

Prerequisites:

Most device drivers (or modules) in the Linux kernel can be compiled either into the kernel itself (built-in, or internal module) or as Loadable Kernel Modules (LKMs, or external modules) that need to be placed in the root file system under the /lib/modules directory. An external module can be in-tree (in the kernel tree structure), or out-of-tree (outside the kernel tree structure).

External Linux kernel modules are compiled taking reference to a Linux kernel source tree and a Linux kernel configuration file (.config).
Thus, a makefile for an external Linux kernel module points to the Linux kernel directory that contains the source code and the configuration file, with the "-C <Linux kernel path>" option.
This makefile also points to the directory that contains the source file(s) of the Linux kernel module to compile, with the "M=<Linux kernel module path>" option.

A generic makefile for an external out-of-tree Linux kernel module looks like the following:

# Makefile for external out-of-tree Linux kernel module

# Object file(s) to be built
obj-m := <module source file(s)>.o

# Path to the directory that contains the Linux kernel source code
# and the configuration file (.config)
KERNEL_DIR ?= <Linux kernel path>

# Path to the directory that contains the generated objects
DESTDIR ?= <Linux kernel installation directory>

# Path to the directory that contains the source file(s) to compile
PWD := $(shell pwd) 
 
default:
 	$(MAKE) -C $(KERNEL_DIR) M=$(PWD) modules

install:
	$(MAKE) -C $(KERNEL_DIR) M=$(PWD) INSTALL_MOD_PATH=$(DESTDIR) modules_install

clean:  
	$(MAKE) -C $(KERNEL_DIR) M=$(PWD) clean

Such module is then cross-compiled with the following commands:

$ make clean
$ make
$ make install

You can refer to the following simple example:

7.3 Adding Linux user space applications[edit]

Prerequisites:

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.4 Modifying the U-Boot[edit]

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.5 Modifying the TF-A[edit]

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.6 Modifying the OP-TEE[edit]

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-M4 ( only on STM32MP15x lines More info.png)[edit]

8.1 How to create a STM32CubeMPU project from scratch or open/modify an existing one from STM32CubeMPU package[edit]

Refer to STM32CubeMP1 Package article.

9 Fast links to essential commands[edit]

If you are already familiar with the Developer Package for the STM32MPU Embedded Software distribution, fast links to the essential commands are listed below.

Info white.png Information
With the links below, you will be redirected to other articleInstalling the OpenSTLinux BSP packagess; use the back button of your browser to come back to these fast links
Link to the command
Starter Packages
Essential commands of the STM32MP15 Evaluation board Starter Package
Essential commands of the STM32MP15 Discovery kit Starter Package
Essential commands of the STM32MP13 Discovery kit Starter Package
SDK
Download and install the latest SDK
Start the SDK
Linux kernel
Download and install the latest Linux kernel
Helper file for the Linux kernel build, and update on board
gcnano-driver
Download and install the latest gcnano-driver
Helper file for the gcnano-driver build, and update on board
U-Boot
Download and install the latest U-Boot
Helper file for the U-Boot build, and update on board
TF-A
Download and install the latest TF-A
Helper file for the TF-A build, and update on board
OP-TEE
Download and install the latest OP-TEE
Helper file for the OP-TEE build, and update on board
Linux user space
Simple user space application
STM32CubeMPU Package only for STM32MP15x lines More info.png
Download and install the latest STM32CubeMP1 Package
Create or modify a STM32CubeMPU project

10 How to go further?[edit]

Now that your developments are ready, you might want to switch to the STM32MP1 Distribution Package, in order to create your own distribution and to generate your own SDK and image.




<noinclude>{{ApplicableFor
|MPUs list=STM32MP13x, STM32MP15x
|MPUs checklist=STM32MP13x,STM32MP15x
}}</noinclude>


This article describes how to get and use the '''Developer Package''' of the '''STM32MPU Embedded Software''' for any development platform of the '''{{MicroprocessorDevice | device=1}}' ''' ([[STM32MP15 boards]] and [[STM32MP13 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.

==Developer Package content==
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 [[Which STM32MPU Embedded Software Package better suits your needs#Developer Package|Developer Package]] chapter)
* [[STM32MPU Embedded Software distribution]]
If you are already familiar with the Developer Package for the STM32MPU Embedded Software distribution, [[#Fast links to essential commands|the fast links to essential commands]] might interest you.

To sum up, this '''Developer Package''' provides:
* for the '''OpenSTLinux distribution''' (development on Arm<sup>&reg;</sup> Cortex<sup>&reg;</sup>-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''':
*** Linux<sup>&reg;</sup> kernel
*** gcnano-driver
*** U-Boot
*** Trusted Firmware-A (TF-A)
*** Open source Trusted Execution Environment (OP-TEE)
** the '''debug symbol files''' for Linux<sup>&reg;</sup> kernel, U-Boot and TF-A
* for the '''STM32CubeMPU Package''' (development on Arm<sup>&reg;</sup> Cortex<sup>&reg;</sup>-M processor for '''{{MicroprocessorDevice | device=15}} only'''):
** all pieces of software (BSP, HAL, middlewares and applications) in '''source code'''
** the '''integrated development environment (IDE)''' ([[STM32CubeIDE]])
Note that, the application frameworks for the OpenSTLinux distribution are not available as source code in this Package.

{{ReviewsComments|JCT W815: the STM32CubeMX tool shall be added in the list above when it will be fully integrated in this article}}

[[File: STM32_MPU_Embedded_Software_Developer_Package.png|frame|center|link=|Components of the Developer Package]]

==Developer Package step-by-step overview==
{{highlight|'''The steps to get the STM32MPU Embedded Software Developer Package ready for your developments, are:'''}} <br>
<span style="font-size:21px"></span> [[#Checking the prerequisites|Checking the prerequisites]] <br>
<span style="font-size:21px"></span> [[#Installing the Starter Package|Installing the Starter Package for your board]] <br>

<span style="font-size:21px"></span> Installing the components to develop software running on Arm<sup>&reg;</sup> Cortex<sup>&reg;</sup>-A (OpenSTLinux distribution)
:<span style="font-size:21px"></span> [[#Installing the SDK|Installing the SDK]] ('''mandatory''' for any development on Arm<sup>&reg;</sup> Cortex<sup>&reg;</sup>-A) <br>

:<span style="font-size:21px"></span> [[#Installing the OpenSTLinux BSP packages|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) <br>

:<span style="font-size:21px"></span> [[#Installing the debug symbol files|Installing the debug symbol files]] ('''mandatory only''' if you plan to debug Linux<sup>&reg;</sup> kernel, U-Boot, OP-TEE or TF-A with GDB)<br>
<span style="font-size:21px"></span> Installing the components to develop software running Arm Cortex-M (STM32CubeMPU Package)
:<span style="font-size:21px"></span> [[#Installing STM32CubeIDE|Installing STM32CubeIDE]] ('''mandatory''' for any development on Arm<sup>&reg;</sup> Cortex<sup>&reg;</sup>-M) <br>

:<span style="font-size:21px"></span> [[#Installing the STM32CubeMPU Package|Installing the STM32CubeMPU Package]] ('''mandatory only''' if you plan to modify the STM32Cube firmware) <br>


Once these steps are achieved, you are able to:
* develop software running on Arm Cortex-A
** [[#Modifying the Linux kernel|Modifying the Linux kernel]]
** [[#Adding external out-of-tree Linux kernel modules|Adding external out-of-tree Linux kernel modules]]
** [[#Adding Linux user space applications|Adding Linux user space applications]]
** [[#Modifying the U-Boot|Modifying the U-Boot]]
** [[#Modifying the TF-A|Modifying the TF-A]]
* [[#Developing software running on Arm Cortex-M4|develop software running on Arm Cortex-M4]] ( {{highlight|only on {{MicroprocessorDevice | device=15}}}})
{{ReviewsComments|-- [[User:Jean-philippe Romain|Jean-philippe Romain]] ([[User talk:Jean-philippe Romain|talk]]) 10:10, 9 June 2021 (CEST)<br />As given now on the README file in the tarball for each components, need to specify that the source code could also be get from github instead of the ones provided in the SDK}}

==Checking the prerequisites==
===Knowledges===
The STM32MP1 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.

===Development setup===
{{:Development setup for STM32MPU Embedded Software}}

==Installing the Starter Package==
Before developing with the Developer Package, {{highlight|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 [[STM32 MPU Flash mapping#Flash partitions|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.

==Installing the components to develop software running on Arm Cortex-A (OpenSTLinux distribution)==

===Installing the SDK===
{{Highlight|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.
{{:STM32MP1 Developer Package - SDK}}

{{Warning|Now that the SDK is installed, do not move or rename the ''<SDK installation directory>''.}}
====Starting up the SDK====
{{highlight|'''The SDK environment setup script must be run once in each new working terminal in which you cross-compile:'''}}
 {{PC$}} source {{HighlightParam|''<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 
 {{PC$}} echo $ARCH
 arm
* Check the toolchain binary prefix for the target tools
 {{PC$}} echo $CROSS_COMPILE
 arm-ostl-linux-gnueabi-
* Check the C compiler version
 {{PC$}} $CC --version
 arm-ostl-linux-gnueabi-gcc (GCC) <GCC version>

 [...]
* Check that the SDK version is the expected one
 {{PC$}} 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.

===Installing the OpenSTLinux BSP packages===
{{highlight|'''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.'''

{{ReviewsComments|-- [[User:Jean Christophe Trotin|Jean Christophe Trotin]] ([[User talk:Jean Christophe Trotin|talk]]) 17:36, 27 June 2022 (CEST)<br />The following remarks apply to [[STM32MP1_Developer_Package_-_OpenSTLinux_BSP]] that is transcluded here:
* Strange double '''r0''' for gcnano driver, U-Boot, TF-A and OP-TEE installation directories (e.g. u-boot-stm32mp-v2021.10-stm32mp1-r1-'''r0-r0''')
* For U-Boot, TF-A and OP-TEE, I don't think that the source code directories (e.g. u-boot-stm32mp-v2021.10-stm32mp1-r1-r0) are already there when only the BSP tarball has been uncompressed.}}

{{:STM32MP1 :STM32MP1 Developer Package - OpenSTLinux BSP}}

====Building and deploying the Linux kernel for the first time====
Prerequisite: the [[#Installing the SDK|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.<br>

This last method is recommended as it clearly separates the files generated by the cross-compilation from the source code files.
{{Info|The {{CodeSource | meta-st-stm32mp | recipes-kernel/linux/linux-stm32mp/README.HOW_TO.txt | README.HOW_TO.txt}} helper file is '''THE''' reference for the Linux kernel build}}
{{Warning|[[#Starting up the SDK|The SDK must be started]]}}

{{highlight|'''Open the ''<Linux kernel installation directory>/README.HOW_TO.txt'' helper file, and execute its instructions to:'''}} <br>
<span style="font-size:21px"></span> setup a software configuration management (SCM) system (''git'') for the Linux kernel (optional but recommended) <br>
<span style="font-size:21px"></span> prepare the Linux kernel (applying the ST patches) <br>
<span style="font-size:21px"></span> configure the Linux kernel (applying the ST fragments) <br>
<span style="font-size:21px"></span> cross-compile the Linux kernel <br>
<span style="font-size:21px"></span> deploy the Linux kernel (i.e. update the software on board) <br>


'''The Linux kernel is now installed''': let's [[#Modifying the Linux kernel|modify the Linux kernel]], or [[#Adding external out-of-tree Linux kernel modules|add external out-of-tree Linux kernel modules]].

====Building and deploying the gcnano-driver for the first time (only on {{MicroprocessorDevice | device=15}})====
Prerequisite:
* the [[#Installing the SDK|SDK is installed]].
* the Linux kernel is built as explained [[STM32MP1_Developer_Package#Building and deploying the Linux kernel for the first time|here]] <br>


'''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.

{{Info|The {{CodeSource | meta-st-stm32mp | recipes-bsp/drivers/gcnano-driver-stm32mp/README.HOW_TO.txt | README.HOW_TO.txt}} helper file is '''THE''' reference for the gcnano-driver build}}

{{Warning|[[#Starting up the SDK|The SDK must be started]]}}

{{highlight|'''Open the ''<gcnano-driver installation directory>/README.HOW_TO.txt'' helper file, and execute its instructions to:'''}} <br>
<span style="font-size:21px"></span> setup a software configuration management (SCM) system (''git'') for the gcnano-driver (optional but recommended) <br>
<span style="font-size:21px"></span> cross-compile the gcnano-driver <br>
<span style="font-size:21px"></span> deploy the gcnano-driver (i.e. update the software on board) <br>


'''The gcnano-driver is now installed'''.

====Building and deploying the U-Boot for the first time====
Prerequisite: the [[#Installing the SDK|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|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. 
{{Info|The {{CodeSource | meta-st-stm32mp | recipes-bsp/u-boot/u-boot-stm32mp/README.HOW_TO.txt | README.HOW_TO.txt}} helper file is '''THE''' reference for the U-Boot build}}
{{Warning|[[#Starting up the SDK|The SDK must be started]]}}
{{Warning|On an Ubuntu 18.04 (with a host gcc version prior to 8.0), U-Boot {{Red|cannot be built}} because of the usage of an unknown option : '''-fmacro-prefix-map''' . }}

{{highlight|'''Open the ''&#60;U-Boot installation directory>/README.HOW_TO.txt'' helper file, and execute its instructions to:'''}} <br>
<span style="font-size:21px"></span> setup a software configuration management (SCM) system (''git'') for the U-Boot (optional but recommended) <br>
<span style="font-size:21px"></span> prepare the U-Boot (applying the ST patches) <br>
<span style="font-size:21px"></span> cross-compile the U-Boot <br>
<span style="font-size:21px"></span> deploy the U-Boot (i.e. update the software on board) <br>


'''The U-Boot is now installed''': let's [[#Modifying the U-Boot|modify the U-Boot]].

====Building and deploying the TF-A for the first time====
Prerequisite: the [[#Installing the SDK|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|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.
{{Info|The {{CodeSource | meta-st-stm32mp | recipes-bsp/trusted-firmware-a/tf-a-stm32mp/README.HOW_TO.txt | README.HOW_TO.txt}} helper file is '''THE''' reference for the TF-A build}}
{{Warning|[[#Starting up the SDK|The SDK must be started]]}}

{{highlight|'''Open the ''<TF-A installation directory>/README.HOW_TO.txt'' helper file, and execute its instructions to:'''}} <br>
<span style="font-size:21px"></span> setup a software configuration management (SCM) system (''git'') for the TF-A (optional but recommended) <br>
<span style="font-size:21px"></span> prepare the TF-A (applying the ST patches) <br>
<span style="font-size:21px"></span> cross-compile the TF-A <br>
<span style="font-size:21px"></span> deploy the TF-A (i.e. update the software on board) <br>


'''The TF-A is now installed''': let's [[#Modifying the TF-A|modify the TF-A]].

====Building and deploying the OP-TEE for the first time====
Prerequisite: the [[#Installing the SDK|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|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.

{{Info|The {{CodeSource | meta-st-stm32mp | recipes-security/optee/optee-os/README.HOW_TO.txt | README.HOW_TO.txt}} helper file is '''THE''' reference for the OP-TEE build}}
{{Warning|[[#Starting up the SDK|The SDK must be started]]}}

{{highlight|'''Open the ''<OP-TEE installation directory>/README.HOW_TO.txt'' helper file, and execute its instructions to:'''}} <br>
<span style="font-size:21px"></span> setup a software configuration management (SCM) system (''git'') for the OP-TEE (optional but recommended) <br>
<span style="font-size:21px"></span> prepare the OP-TEE (applying the ST patches) <br>
<span style="font-size:21px"></span> cross-compile the OP-TEE <br>
<span style="font-size:21px"></span> deploy the OP-TEE (i.e. update the software on board) <br>


'''The OP-TEE is now installed''': let's [[#Modifying the OP-TEE|modify the OP-TEE]].

===Installing the debug symbol files===
{{highlight|'''Optional step'''}}''': it is mandatory only if you want to debug Linux<sup>&reg;</sup> kernel, U-Boot, OP-TEE or TF-A with GDB.'''

====Using the debug symbol files====
These files are used to debug the Linux<sup>&reg;</sup> kernel, U-Boot, OP-TEE or TF-A with [[GDB]]. Especially, the [[GDB#Debug OpenSTLinux BSP components|Debug OpenSTLinux BSP components]] chapter explains how to load the debug symbol files in GDB.

==Installing the components to develop software running on Arm Cortex-M4 (STM32CubeMPU Package) ( only on {{MicroprocessorDevice | device=15}})==

===Installing STM32CubeIDE===
{{Highlight|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.
{{:STM32CubeIDE release note}}

===Installing the STM32CubeMPU Package===
{{highlight|'''Optional step'''}}''': it is mandatory only if you want to modify the STM32CubeMPU Package.'''

Prerequisite: the [[#Installing STM32CubeIDE|STM32CubeIDE is installed]].

{{:STM32MP1 Developer Package - STM32CubeMP1 Package}}

'''The STM32CubeMPU Package is now installed''': let's [[#Developing software running on Arm Cortex-M4|develop software running on Arm Cortex-M4]].

==Developing software running on Arm Cortex-A7==
{{:Cross-compile with OpenSTLinux SDK}}

==Developing software running on Arm Cortex-M4 ( only on {{MicroprocessorDevice | device=15}})==

===How to create a STM32CubeMPU project from scratch or open/modify an existing one from STM32CubeMPU package===
{{ReviewsComments|-- [[User:Nathalie Sangouard|Nathalie Sangouard]] ([[User talk:Nathalie Sangouard|talk]]) 14:02, 24 June 2022 (CEST)<br />In the tittle above, Cube project or STM32CubeMPU project? I have made some modification please check}}
Refer to [[STM32CubeMP1 Package#Developer Package for STM32CubeMP1|STM32CubeMP1 Package]] article.

== Fast links to essential commands==
If you are already familiar with the Developer Package for the STM32MPU Embedded Software distribution, fast links to the essential commands are listed below.

{{Info|With the links below, you will be redirected to other articleInstalling the OpenSTLinux BSP packagess; use the ''back'' button of your browser to come back to these fast links}}
{| class="st-table"
! Link to the command
|-
|'''Starter Packages'''{{UpdateNeededForNewBoard|Point to the "Fast links to essential commands" of the new board Starter Package}}
|-
| [[STM32MP15 Evaluation boards - Starter Package#Fast links to essential commands|Essential commands of the STM32MP15 Evaluation board Starter Package]]
|-
| [[STM32MP15 Discovery kits - Starter Package#Fast links to essential commands|Essential commands of the STM32MP15 Discovery kit Starter Package]]
|-
| [[STM32MP13 Discovery kits - Starter Package#Fast links to essential commands|Essential commands of the STM32MP13 Discovery kit Starter Package]]
|-
| | '''SDK'''
|-
| [[STM32MP1 Developer Package - SDK#Download|Download and install the latest SDK]]
|-
| [[#Starting up the SDK|Start the SDK]]
|-
| | '''Linux kernel'''
|-
| [[STM32MP1 Developer Package#Installing the OpenSTLinux BSP packages|Download and install the latest Linux kernel]]
|-
| {{CodeSource | meta-st-stm32mp | recipes-kernel/linux/linux-stm32mp/README.HOW_TO.txt | Helper file for the '''Linux kernel''' build, and update on board}}
|-
|| '''gcnano-driver'''
|-
| [[STM32MP1 Developer Package#Installing the OpenSTLinux BSP packages|Download and install the latest gcnano-driver]]
|-
| {{CodeSource | meta-st-stm32mp | recipes-bsp/drivers/gcnano-driver-stm32mp/README.HOW_TO.txt | Helper file for the '''gcnano-driver''' build, and update on board}}
|-
| | '''U-Boot'''
|-
| [[STM32MP1 Developer Package#Installing the OpenSTLinux BSP packages|Download and install the latest U-Boot]]
|-
| {{CodeSource | meta-st-stm32mp | recipes-bsp/u-boot/u-boot-stm32mp/README.HOW_TO.txt | Helper file for the '''U-Boot''' build, and update on board}}
|-
| | '''TF-A'''
|-
| [[STM32MP1 Developer Package#Installing the OpenSTLinux BSP packages|Download and install the latest TF-A]]
|-
| {{CodeSource | meta-st-stm32mp | recipes-bsp/trusted-firmware-a/tf-a-stm32mp/README.HOW_TO.txt | Helper file for the '''TF-A''' build, and update on board}}
|-
| | '''OP-TEE'''
|-
| [[STM32MP1 Developer Package#Installing the OpenSTLinux BSP packages|Download and install the latest OP-TEE]]
|-
| {{CodeSource | meta-st-stm32mp | recipes-security/optee/optee-os/README.HOW_TO.txt | Helper file for the '''OP-TEE''' build, and update on board}}
|-
|| '''Linux user space'''
|-
| [[How to cross-compile with the Developer Package#Adding a "hello world" user space example|Simple user space application]]
|-
|| '''STM32CubeMPU Package''' only for {{MicroprocessorDevice | device=15}}
|-
| [[STM32MP1 Developer Package - STM32CubeMP1 Package#Download|Download and install the latest STM32CubeMP1 Package]]
|-
| [[STM32CubeMP1 Package#Developer Package for STM32CubeMP1 |Create or modify a STM32CubeMPU project]] 
|}

==How to go further?==
Now that your developments are ready, you might want to switch to the [[STM32MP1 Distribution Package]], in order to create your own distribution and to generate your own SDK and image.
<noinclude>

{{PublicationRequestId | 8418 | 2018-08-14 | AlainF}}

[[Category:Getting started with STM32MP1 boards]]
[[Category:Developer Package]]

{{UpdateNeededForNewRelease|
* Check that the following transcluded articles deal with the last ecosystem release, and that the "Release note" row of these transcluded articles refer to their "Archives" section (see details in the "Contributors:Ecosystem release delivery" article)
{{:STM32MP1 Developer Package - SDK}}
{{:STM32MP1 Developer Package - Linux kernel}}
{{:STM32MP1 Developer Package - U-Boot}}
{{:STM32MP1 Developer Package - TF-A}}
{{:STM32MP1 Developer Package - OP-TEE}}
{{:STM32MP1 Developer Package - debug symbol files}}
{{:STM32MP1 Developer Package - STM32CubeMP1 Package}}
* Make the modifications indicated by {{UpdateNeededForNewRelease}}
}}</noinclude>
Line 114: Line 114:
 
===Installing the OpenSTLinux BSP packages===
 
===Installing the OpenSTLinux BSP packages===
 
{{highlight|'''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.'''
 
{{highlight|'''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.'''
 
{{ReviewsComments|-- [[User:Jean Christophe Trotin|Jean Christophe Trotin]] ([[User talk:Jean Christophe Trotin|talk]]) 17:36, 27 June 2022 (CEST)<br />The following remarks apply to [[STM32MP1_Developer_Package_-_OpenSTLinux_BSP]] that is transcluded here:
 
* Strange double '''r0''' for gcnano driver, U-Boot, TF-A and OP-TEE installation directories (e.g. u-boot-stm32mp-v2021.10-stm32mp1-r1-'''r0-r0''')
 
* For U-Boot, TF-A and OP-TEE, I don't think that the source code directories (e.g. u-boot-stm32mp-v2021.10-stm32mp1-r1-r0) are already there when only the BSP tarball has been uncompressed.}}
 
 
   
 
{{:STM32MP1 Developer Package - OpenSTLinux BSP}}
 
{{:STM32MP1 Developer Package - OpenSTLinux BSP}}