STM32MP1 Developer Package

This article describes how to get and use the Developer Package of the STM32MPU Embedded Software for any development platform of the STM32MP1 family (STM32MP15 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
2 Developer Package step-by-step overview
3 Checking the prerequisites
- 3.1 Knowledges
- 3.2 Development setup
4 Installing the Starter Package
5 Installing the components to develop software running on Arm Cortex-A (OpenSTLinux distribution)
6 Installing the components to develop software running on Arm Cortex-M4 (STM32Cube MPU Package)
- 6.1 Installing STM32CubeIDE
- 6.2 Installing the STM32Cube MPU Package
7 Developing software running on Arm Cortex-A7
8 Article purpose
9 Developing software running on Arm Cortex-M4
- 9.1 How to create a Cube project from scratch or open/modify an existing one from STM32Cube MPU package
10 Fast links to essential commands
11 How to go further?

Developer Package content

If you are not yet familiar with the STM32MPU Embedded Software distribution and its Packages, please 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:
  - Linux^® kernel
  - U-Boot
  - Trusted Firmware-A (TF-A)
  - optionally, Open source Trusted Execution Environment (OP-TEE)
- the debug symbol files for Linux^® kernel, U-Boot and TF-A
for the STM32Cube MPU Package (development on Arm^® Cortex^®-M processor):
- 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.

<securetransclude src="ProtectedTemplate:ReviewsComments" params="JCT W815: the STM32CubeMX tool shall be added in the list above when it will be fully integrated in this article"></securetransclude>{{#set:Has reviews comments=true}}

文件:STM32 MPU Embedded Software Developer Package.png

Components of the Developer Package

Developer Package step-by-step overview

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 Linux kernel (mandatory only if you plan to modify the Linux kernel or to add external out-of-tree Linux kernel modules)

☐ Installing the U-Boot (mandatory only if you plan to modify the U-Boot)

☐ Installing the TF-A (mandatory only if you plan to modify the TF-A)

☐ Installing the TF-A-SSP (mandatory only if you plan to modify the TF-A SSP)

☐ Installing the debug symbol files (mandatory only if you plan to debug Linux^® kernel, U-Boot or TF-A with GDB)

☐ Installing the components to develop software running Arm Cortex-M (STM32Cube MPU Package)

☐ Installing STM32CubeIDE (mandatory for any development on Arm^® Cortex^®-M)

☐ Installing the STM32Cube MPU Package (mandatory only if you plan to modify the Cube firmware)

Once these steps are achieved, you are able to:

develop software running on Arm Cortex-A
develop software running on Arm Cortex-M4

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

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

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.

Installing the Starter Package

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.

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

Installing the SDK

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, please read the SDK for OpenSTLinux distribution article.

The STM32MP1 SDK is delivered through a tarball file named : {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC}}{{#vardefine:url|TBC}}{{#vardefine:path|}}{{#var:name}}

Download and install the STM32MP1 SDK.

模板:SoftwareLicenseAgreement

STM32MP1 Developer Package SDK - STM32MP15-Ecosystem-v2.1.0 release

Download

You need to be logged on my.st.com before accessing the following link:
[{{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC}}{{#vardefine:url|TBC}}{{#vardefine:path|}}{{#var:url}}/{{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC}}{{#vardefine:url|TBC}}{{#vardefine:path|}}{{#var:name}} {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC}}{{#vardefine:url|TBC}}{{#vardefine:path|}}{{#var:name}}]

Installation

Uncompress the tarball file to get the SDK installation script

tar xvf {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC}}{{#vardefine:url|TBC}}{{#vardefine:path|}}{{#var:name}}

If needed, change the permissions on the SDK installation script so that it is executable

$ chmod +x {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.sh}}{{#vardefine:url|}}{{#vardefine:path|TBC}}{{#var:path}}/{{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.sh}}{{#vardefine:url|}}{{#vardefine:path|TBC}}{{#var:name}}

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:

$ ./{{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.sh}}{{#vardefine:url|}}{{#vardefine:path|TBC}}{{#var:path}}/{{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.sh}}{{#vardefine:url|}}{{#vardefine:path|TBC}}{{#var:name}} -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 3.1-openstlinux-5-4-dunfell-mp1-20-11-12
===========================================================================================
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 STM32MP15 ecosystem release note.

25px 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

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

Starting up the SDK

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

PC $> 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

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, please try to reinstall the SDK.

Installing the Linux kernel

Optional step: it is mandatory only if you want to modify the Linux kernel (configuration, device tree, driver...), or to add external out-of-tree Linux kernel modules.

Prerequite: the SDK is installed.

Downloading the Linux kernel

The STM32MP1 Linux kernel is delivered through a tarball file named {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:name}} for {{#vardefine:info|}}{{#vardefine:typ|}}{{#vardefine:info|}}STM32MP157x-EV1{{#var:typ}} {{#var:info}} and {{#vardefine:info|}}{{#vardefine:typ|}}{{#vardefine:info|}}STM32MP157x-DKx{{#var:typ}} {{#var:info}} boards.

Download and install the STM32MP1 Linux kernel

模板:SoftwareLicenseAgreement

STM32MP1 Developer Package Linux kernel - STM32MP15-Ecosystem-v2.1.0 release

Download

You need to be logged on to my.st.com before accessing the following link
[{{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:url}}/{{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:name}} {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:name}}]

Installation

Go to the host PC directory in which you want to install the Developer Package (<Developer Package installation directory>); if you follow the proposition to organize the working directory, this means:

$ cd <working directory path>/Developer-Package

Download the tarball file in this directory
Uncompress the tarball file to get the Linux kernel (Linux kernel source code, ST patches, ST configuration fragments...):

PC $> $ tar xvf {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:name}}
PC $> $ cd {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:path}}
PC $> $ tar xvf {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|}}{{#vardefine:path|TBC}}{{#var:name}}

Release note

Details of the content of the Linux kernel are available in the associated STM32MP15 OpenSTLinux release note.

25px If you are interested in older releases, please have a look into the section Archives.

The Linux kernel installation directory is in the <Developer Package installation directory>/stm32mp1-openstlinux-5-4-dunfell-mp1-20-11-12/sources/arm-ostl-linux-gnueabi directory, and is named linux-stm32mp-<kernel version>:

linux-stm32mp-5.4.56-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)
├── {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|}}{{#vardefine:path|TBC}}{{#var:path}}          Linux kernel source code directory
├── {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|}}{{#vardefine:path|TBC}}{{#var:name}}   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

Building and deploying the Linux kernel for the first time

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 Unsupported domain! helper file is THE reference for the Linux kernel build

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.

Installing the U-Boot

Optional step: it is mandatory only if you want to modify the U-Boot.

Prerequite: the SDK is installed.

Downloading the U-Boot

The STM32MP1 U-Boot is delivered through a tarball file named {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:name}} for {{#vardefine:info|}}{{#vardefine:typ|}}{{#vardefine:info|}}STM32MP157x-EV1{{#var:typ}} {{#var:info}} and {{#vardefine:info|}}{{#vardefine:typ|}}{{#vardefine:info|}}STM32MP157x-DKx{{#var:typ}} {{#var:info}} boards.

Download and install the STM32MP1 U-Boot

模板:SoftwareLicenseAgreement

STM32MP1 Developer Package U-Boot - STM32MP15-Ecosystem-v2.1.0 release

Download

You need to be logged on to my.st.com before accessing the following link
[{{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:url}}/{{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:name}} {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:name}}]

Installation

Go to the host PC directory in which you want to install the Developer Package (<Developer Package installation directory>); if you follow the proposition to organize the working directory, this means:

$ cd <working directory path>/Developer-Package

Download the tarball file in this directory
Uncompress the tarball file to get the U-Boot (U-Boot source code, ST patches and so on):

PC $> $ tar xvf {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:name}}
PC $> $ cd {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:path}}
PC $> $ tar xvf {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.gz }}{{#vardefine:url|}}{{#vardefine:path|TBC}}{{#var:name}}

Release note

Details of the content of the U-Boot are available in the associated STM32MP15 OpenSTLinux release note.

25px If you are interested in older releases, please have a look into the section Archives.

The U-Boot installation directory is in the <Developer Package installation directory>/stm32mp1-openstlinux-5-4-dunfell-mp1-20-11-12/sources/arm-ostl-linux-gnueabi directory, and is named u-boot-stm32mp-<U-Boot version>:

u-boot-stm32mp-2020.01-r2
├── [*].patch
├── {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.gz }}{{#vardefine:url|}}{{#vardefine:path|TBC}}{{#var:path}}
├── Makefile.sdk
├── README.HOW_TO.txt
├── series
└── {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.gz }}{{#vardefine:url|}}{{#vardefine:path|TBC}}{{#var:name}}

U-Boot installation directory
ST patches to apply during the U-Boot preparation (see next chapter)
U-Boot source code directory
Makefile for the U-Boot compilation
Helper file for U-Boot management: reference for U-Boot build
List of all ST patches to apply
Tarball file of the U-Boot source code

Building and deploying the U-Boot for the first time

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 Unsupported domain! helper file is THE reference for the U-Boot build

The SDK must be started

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.

Installing the TF-A

Optional step: it is mandatory only if you want to modify the TF-A.

Prerequite: the SDK is installed.

Downloading the TF-A

The STM32MP1 TF-A is delivered through a tarball file named {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:name}} for {{#vardefine:info|}}{{#vardefine:typ|}}{{#vardefine:info|}}STM32MP157x-EV1{{#var:typ}} {{#var:info}} and {{#vardefine:info|}}{{#vardefine:typ|}}{{#vardefine:info|}}STM32MP157x-DKx{{#var:typ}} {{#var:info}} boards.

Download and install the STM32MP1 TF-A

模板:SoftwareLicenseAgreement

STM32MP1 Developer Package TF-A - STM32MP15-Ecosystem-v2.1.0 release

Download

You need to be logged on my.st.com before accessing the following link:
[{{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:url}}/{{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:name}} {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:name}}]

Installation

Go to the host PC directory in which you want to install the Developer Package (<Developer Package installation directory>); if you follow the proposition to organize the working directory, it means:

$ cd <working directory path>/Developer-Package

Download the tarball file in this directory
Uncompress the tarball file to get the TF-A (TF-A source code, ST patches...):

PC $> $ tar xvf {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:name}}
PC $> $ cd {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.xz}}{{#vardefine:url|TBC}}{{#vardefine:path|TBC}}{{#var:path}}
PC $> $ tar xvf {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.gz}}{{#vardefine:url|}}{{#vardefine:path|TBC}}{{#var:name}}

Release note

Details about the content of the TF-A are available in the associated STM32MP15 OpenSTLinux release note.

25px If you are interested in older releases, please have a look into the section Archives.

The TF-A installation directory is in the <Developer Package installation directory>/stm32mp1-openstlinux-5-4-dunfell-mp1-20-11-12/sources/arm-ostl-linux-gnueabi directory, and is named tf-a-stm32mp-<TF-A version>:

{{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.gz}}{{#vardefine:url|}}{{#vardefine:path|TBC}}{{#var:path}}-r0             TF-A installation directory
├── [*].patch                      ST patches to apply during the TF-A preparation (see next chapter)
├── {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.gz}}{{#vardefine:url|}}{{#vardefine:path|TBC}}{{#var:path}}            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
└── {{#vardefine:name|}}{{#vardefine:url|}}{{#vardefine:path|}}{{#vardefine:name|TBC.tar.gz}}{{#vardefine:url|}}{{#vardefine:path|TBC}}{{#var:name}}  Tarball file of the TF-A source code

Building and deploying the TF-A for the first time

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 Unsupported domain! helper file is THE reference for the TF-A build

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.

Installing the TF-A-SSP

Optional step: it is mandatory only if you want to modify the TF-A to use Secure Secret provisioning feature.

Prerequite: the SDK is installed.

Downloading the TF-A-SSP

STM32MP1 Developer Package - TF-A-SSP

Building the TF-A-SSP for the first time

It is mandatory to execute once the steps specified below before modifying the TF-A SSP.

The Unsupported domain! helper file is THE reference for the TF-A SSP build

The SDK must be started

Open the <TF-A SSP 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 SSP (optional but recommended)
☐ prepare the TF-A SSP (applying the ST patches)
☐ cross-compile the TF-A SSP

The TF-A SSP is now built.

Installing the OP-TEE

Optional step: it is mandatory only if you want to modify the OP-TEE.

Prerequite: the SDK is installed.

<securetransclude src="ProtectedTemplate:ReviewsComments" params="YCO 15-Feb-19 : We should to write that we need here an optee image flashed on the board, extra partitions are created for TEE. We can put this info as prerequisite in OP-TEE.README.HOW_TO.txt"></securetransclude>{{#set:Has reviews comments=true}}

Downloading the OP-TEE

STM32MP1 Developer Package - OP-TEE

Building and deploying the OP-TEE for the first time

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. <securetransclude src="ProtectedTemplate:ReviewsComments" params="YCO 15-Feb-19 : fsbl is not the right partition, partition are teeh,teed,teex in a optee image mapping"></securetransclude>{{#set:Has reviews comments=true}} Within this scope, the partition related to the OP-TEE is the fsbl one.

The Unsupported domain! helper file is THE reference for the OP-TEE build

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.

<securetransclude src="ProtectedTemplate:ReviewsComments" params="YCO 15-Feb-19 : This link doesn't give extra information to modify the OP-TEE, see my remark at this link"></securetransclude>{{#set:Has reviews comments=true}}

Installing the debug symbol files

Optional step: it is mandatory only if you want to debug Linux^® kernel, U-Boot or TF-A with GDB.

Downloading the debug symbol files

STM32MP1 Developer Package - debug symbol files

Using the debug symbol files

These files are used to debug the Linux^® kernel, U-Boot or TF-A with GDB. Especially, the 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 (STM32Cube MPU Package)

Installing STM32CubeIDE

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 STM32Cube MPU Package

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

Prerequite: the STM32CubeIDE is installed.

STM32MP1 Developer Package - STM32CubeMP1 Package

The STM32Cube MPU Package is now installed: let's develop software running on Arm Cortex-M4.

Developing software running on Arm Cortex-A7

Article purpose

The pieces of software delivered as source code within the OpenSTLinux Developer Package (for example the Linux kernel) can be modified. External out-of-tree Linux kernel modules, and pieces of applicative software (for example Linux applications) can also be developed thanks to this Developer Package, and loaded onto the board.

The build of all these pieces of software by means of the SDK for OpenSTLinux distribution, and the deployment on-target of the resulting images is explained below.

To use the cross-compilation efficiently with the OpenSTLinux SDK, it is recommended that you read the Developer Package article relative to the Series of your STM32 microprocessor: Category:Developer Package

</noinclude>

Modifying the Linux kernel

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:

Adding external out-of-tree Linux kernel modules

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:

Addition of an external out-of-tree module

Adding Linux user space applications

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:

Addition of a "hello world" user space application

Modifying the U-Boot

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:

Modification of the U-Boot

Modifying the TF-A

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:

Modification of the TF-A

Modifying the OP-TEE

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)

<securetransclude src="ProtectedTemplate:ReviewsComments" params="YCO 15-Feb-19 : link missing "Modification of the OP-TEE"<br>

There is no link because the page "How_to_cross-compile_with_the_Developer_Package" doesn't contain a paragraph for TEE, <br> SO THIS PARAGRAH "Modifying the OP-TEE" is not useful, it gives no more informations.<br> The paragraph "5.5 Installing the OP-TEE" is enough"></securetransclude>{{#set:Has reviews comments=true}}

Developing software running on Arm Cortex-M4

How to create a Cube project from scratch or open/modify an existing one from STM32Cube MPU package

Please refer to 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.

With the links below, you will be redirected to other articles; 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
SDK
Download and install the latest SDK
Start the SDK
Linux kernel
Download and install the latest Linux kernel
Unsupported domain!
U-Boot
Download and install the latest U-Boot
Unsupported domain!
TF-A
Download and install the latest TF-A
Unsupported domain!
TF-A SSP
Download and install the latest TF-A SSP
Unsupported domain!
OP-TEE
Download and install the latest OP-TEE
Unsupported domain!
Linux user space
Simple user space application
STM32Cube MPU Package
Download and install the latest STM32CubeMP1 Package
Create or modify a Cube 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.

匿名

搜索

STM32MP1 Developer Package

目录

Developer Package content

Developer Package step-by-step overview

Checking the prerequisites

Knowledges

Development setup

Installing the Starter Package

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

Installing the SDK

Starting up the SDK

Installing the Linux kernel

Downloading the Linux kernel

Building and deploying the Linux kernel for the first time

Installing the U-Boot

Downloading the U-Boot

Building and deploying the U-Boot for the first time

Installing the TF-A

Downloading the TF-A

Building and deploying the TF-A for the first time

Installing the TF-A-SSP

Downloading the TF-A-SSP

Building the TF-A-SSP for the first time

Installing the OP-TEE

Downloading the OP-TEE

Building and deploying the OP-TEE for the first time

Installing the debug symbol files

Downloading the debug symbol files

Using the debug symbol files

Installing the components to develop software running on Arm Cortex-M4 (STM32Cube MPU Package)

Installing STM32CubeIDE

Installing the STM32Cube MPU Package

Developing software running on Arm Cortex-A7

Article purpose

Modifying the Linux kernel

Adding external out-of-tree Linux kernel modules

Adding Linux user space applications

Modifying the U-Boot

Modifying the TF-A

Modifying the OP-TEE

Developing software running on Arm Cortex-M4

How to create a Cube project from scratch or open/modify an existing one from STM32Cube MPU package

Fast links to essential commands

How to go further?

导航

Wiki工具

页面工具

分类