STM32MP15 Ecosystem Release Note v3.1.0

This document describes the content of the STM32MP15-ecosystem-v3.1.0 release of STM32MPU Embedded Software distribution and its associated ecosystem.

Approval Date: November 18, 2021

1. Delivery Purpose and Scope

The STM32MP15-ecosystem-v3.1.0 release is dedicated to STM32MP15 microprocessors. It is a major release of STM32 MPU Mass Market based on new community components version (Yocto LTS Dunfell 3.1.11, Kernel 5.10.61 LTS, U-Boot v2020.10, TF-A 2.4, OP-TEE 3.12).

The STM32MP15-ecosystem-v3.1.0 aims at:

• Providing a full ecosystem for the STM32MP15x devices.
• Working efficiently with STM32MP15 boards, using one of the packages (Starter Package, Developer Package or Distribution Package) developed by STMicroelectronics for the STM32 MPUs.

This ecosystem release consists of:

• The STM32MPU Embedded Software distribution.
• STM32 referenced tools (more details are provided in the Referenced tools release notes chapter below).
• STM32CubeIDE
• STM32CubeMX
• STM32CubeProgrammer
• Keygen tool
• Signing tool
• The Package Repository Service hosted at the non-browsable URL http://packages.openstlinux.st.com, enabled by default in the Starter Package, providing regularly updated or additional packages.

Documentation:

• The present user guide in wiki format.
• The documentation package (for more details refer to Reference documents chapter below).

Supported STM32MP15 boards:

• STM32MP15 Evaluation boards
• STM32MP15 Discovery kits

2. Intended Audience

The targeted audience is STM32MP15 customers or partners.

3. Licensing

This software package is licensed under a SOFTWARE LICENSE AGREEMENT FOR ST MATERIALS (SLA). Customers may not use this package except in compliance with the software license agreement (SLA).

4. Main Features / Main Highlights

4.1 Boards

This STM32MP15-ecosystem-v3.1.0 release supports the same boards as STM32MP15-ecosystem-v3.0.0 ones.

4.2 Embedded Software

4.2.1 OpenSTLinux (Cortex®-A7)

openstlinux-5.10-dunfell-mp1-21-11-17 is the new version delivered with the STM32MP15-ecosystem-v3.1.0 release. This software set consists of the following components:

• Build process:
  • OpenEmbedded LTS Dunfell (v3.1.11) - NEW
  • GCC version v9.3
• Software components:
  • Kernel version LTS v5.10.61 - NEW
  • TF-A version v2.4
  • U-Boot version v2020.10
  • OP-TEE version v3.12.0
  • OpenOCD version v0.11.0
• Applicative components:
  • Weston version v8.0.0
  • GStreamer version v1.16.3
  • GCnano version v6.4.3

Main NEW features of the STM32MP15-ecosystem-v3.1.0 release:

• Coprocessor firmware Authentication support
• QSPI NAND performance improvements
• Linux KGDB support
• DMA pause & resume support
• stm32key command update for easy evaluation of STM32MP15 secure boot
• Enabling LPDDR2 / LPDDR3 PHY built-in Read Valid training (RVTRN)

Warning: Basic boot has been removed since STM32MP15-ecosystem-v2.0.0. If using basic boot with U-BOOT-SPL to load U-BOOT and the Kernel, use now the ST reference boot scheme replacing U-BOOT-SPL by TF-A as FSBL as explained in Boot chain overview.

• Internal peripheral assignment at boot time:
  • At boot time, select one of both kernel configurations:
    • Configuration 1: all internal peripherals are assigned to Cortex-A7 for Linux drivers. Cortex-M4 coprocessing firmware TTY is executed by default.
    • Configuration 2: some internal peripherals are assigned to Cortex-M4 to execute Cortex-M4 delivered examples on the board (EVAL or DISCO). See (How to run Cortex-M4 examples).
    Configuration 1 is activated by default if "2" is not specified in the U-Boot console. More information is available in the How to assign an internal peripheral to a runtime context article.

4.2.2 Buildroot (Cortex®-A7)

1st Buildroot distribution based on ST Linux BSP from Openstlinux-5.10-dunfell-mp1-21-11-17 is delivered with STM32MP15-ecosystem-v3.1.0 release with the tag openstlinux-5.10-buildroot-2021.02-mp1-21-11-17 on following URL [1].

4.2.3 STM32CubeMP1 (Cortex®-M4)

STM32CubeMP1-v1.5.0 version - NEW version versus STM32MP15-ecosystem-v3.0.0 release.

Main NEW features of STM32CubeMP1-v1.5.0, delivered within STM32MP15-ecosystem-v3.1.0 release:

• General updates to fix known defects and enhancements implementation for HAL, LL, CMSIS, BSP.
• HAL and LL Drivers:
  • Update the way to declare licenses in STM32Cube.
  • I2C, LPTIM, RNG, SPI alignment with other STM32 families (No API change).
• Cortex-M CMSIS:
  • New version V5.6.0.
• OPENAMP:
  • New version V2021.04.
• PROJECTS:
  • Application:
    • Update openamp.c and openamp.h in application (alignment with OpenAMP Release V2021.04).
    • Update OpenAMP_FreeRTOS_echo project to rely on libmetal FreeRTOS.
  • All projects:
    • Update Linker script to prevent text section to override data.
    • Remove SW4STM32 Projects (obsolete IDE, replaced by STM32CubeIDE).

4.3 STM32CubeProgrammer, Signing tool, Keygen

STM32CubeProgrammer v2.9.0 is the new version delivered within the STM32MP15-ecosystem-v3.1.0 release. This is an evolutive maintenance release for STM32CubeProgrammer.

Main NEW features of STM32CubeProgrammer-v2.9.0, delivered within STM32MP15-ecosystem-v3.1.0 release:

• Download command verifies all binaries are available before launching the programming.
• Same version (v2.9) for Signing Tool, Key generator, Trusted Package Creator and STM32CubeProgrammer.
• Support PKCS#11 in Signing tool.

Features already available in previous STM32CubeProgrammer-v2.8.0 version:

• STM32CubeProg installer including STM32CubeProgrammer, Keygen and Signing tools.
• Flash programming of SD Card, eMMC, NAND, NOR images through USB and UART for STM32MP157C-EV1, STM32MP157A-EV1, STM32MP157A-DK1, STM32MP157C-DK2 boards.
• Private and public key generation.
• Image signatures.
• Flashlayout file format change.
• STM32MP1 fuse management (with console interface only).
• PMIC NVM management (with console interface only).
• SSP (Secure Secrets Provisioning) UI.

Warning: OpenSTLinux generates flashlayout files only for USB programming mode. For UART usage, refer to Using_STM32Programmer_over_UART article to modify those files.

4.4 STM32CubeMX

STM32CubeMX-v6.4.0 is the new version delivered within STM32MP15-ecosystem-v3.1.0 release.

Main NEW features of STM32CubeMX-v6.4.0, delivered within the STM32MP15-ecosystem-v3.1.0 release:

• Device tree (Cortex-A7): New database based on openstlinux-5.10-dunfell-mp1-21-11-17.
• STM32Cube (Cortex-M4):
  • OpenAMP-2021.04 support.

Features already available in previous version:

• Ubuntu 20.04 support.
• I/O muxing and clock tree configuration.
• STM32MP1 contexts management (A7 non-secure, A7 secure, M4).
• ST32MP1Cube code generation.
• Tuning of DDR settings.
• Device tree code generation:
  • dtsi and header file inclusions.
  • pinctrl and clock generation.
  • System-on-chip device node positioning.
  • multi-core related configurations (ETZPC binding, resources manager binding, peripheral assignment).
  • DMA config generation - DMA nodes.

Information: Note: The other device tree parameters must be filled manually in user section tags (from /* USER CODE BEGIN <node> */ to /* USER CODE END <node> */).

4.5 STM32CubeIDE

STM32CubeIDE-v1.8.0 is the new version delivered within STM32MP15-ecosystem-v3.1.0 release.

Main NEW features of STM32CubeIDE v1.8.0, delivered within the STM32MP15-ecosystem-v3.1.0 release:

• Bootloaders target update support (TF-A, U-boot, OP-TEE).

Features already available in previous version:

• Ubuntu 20.04 support.
• Application and libraries userland Cortex-A7 support based on OpenSTLinux Developer Package and Yocto SDK.
• Cortex-M4 STM32CubeMP1 in "Production mode" and "Engineering mode".
• Cortex-M4 Firmware compilation, loading and debugging.
• PC Linux with ethernet (recommended) or serial link.
• PC Windows with ethernet or ethernet over USB link.
• Cortex-M4 Firmware installation directory configurable.
• OpenSTLinux Developer Package support with:
  • TF-A component project compilation with native dt selected or external dt (for example, generated from CubeMX).
  • U-BOOT component project compilation with native dt selected or external dt (for example, generated from CubeMX).
  • OP-TEE component project compilation with native dt selected or external dt (for example, generated from CubeMX).
  • KERNEL component project compilation with native dt selected or external dt (for example, generated from CubeMX).
  • KERNEL component project artefacts update on running target.
  • For more information refer to How to manage OpenSTLinux projects in STM32CubeIDE article.

4.6 Miscellaneous

Detailed features are available in the release notes of the different components that constitute this delivery. See sections STM32MPU Embedded Software distribution detailed release notes, Referenced tools release notes and Reference documents.

5. Main Restrictions

5.1 Embedded Software

5.1.1 OpenSTLinux (Cortex®-A7)

None

5.1.2 Buildroot (Cortex®-A7)

None

5.1.3 STM32CubeMP1 (Cortex®-M4)

• Use the HAL RTC with caution since this driver is also used by Linux. To remove any risk of contention between Linux and the HAL, proceed as follows:
  • The write protect (wpr) must be disabled by default and it must never be enabled in any driver (Linux nor HAL).
  • The HAL must use only Alarm B, since Linux uses Alarm A.
  • The RTC interrupt must be shared between Linux and the HAL to be able to receive alarm notifications on both sides.

5.2 STM32CubeProgrammer, Signing tool and Keygen

Warning: Key generation is functional with STM32MP_KeyGen_CLI on Linux from Ubuntu 18.04 and upper versions.

5.3 STM32CubeMX

Warning: When opening a previous project built with STM32CubeMX version older than V6.4.0, the migration does not take into account the user section part. This part needs to be updated manually according the openstlinux-5.10-dunfell-mp1-21-11-17 manifest.

5.4 STM32CubeIDE

Using OpenOCD with ST-LINK does not check nor force ST-LINK firmware update at debug launch. It is therefore recommended to manually update the latest ST-LINK firmware for the best debug experience. Use the Help > ST-LINK Upgrade menu.

5.5 Miscellaneous

Restriction lists are available in the sub-components release notes, which are available in the following chapters:

• STM32MPU Embedded Software distribution detailed release notes.
• Referenced tools release notes.

Moreover, the software workarounds implemented to provide solutions to the STM32MPU device errata are listed in STM32MP15 ecosystem errata sheet.

6. Minor Release Updates

STMicroelectronics regularly delivers updates through the following github® components: tf-a, u-boot, optee-os, Linux kernel. Those components can be incorporated the Developer Package (refer to STM32MP1 Developer Package) or Distribution Package.

To update the Distribution Package, proceed as follows:

1. Switch the Distribution package reference source code to github mode.
2. Use the devtool modify <recipe name> command to access to the git source code repository used by the build process.
3. In the freshly cloned source code, check out the required revision to start from via git checkout -b WORK <github® TAG>.

STMicroelectronics also delivers dedicated fixes on layers through github®. These changes can be integrated (via git commands: git checkout -b WORK <github® commit SHA1>) into the local STM32MP1 Distribution Package environment. The github® links corresponding to each layers in the following list:

• meta-st-stm32mp
• meta-st-openstlinux
• meta-st-stm32mp-addons

7. Reference Documents

All the resources for the STM32MP1 Series are available in the Resources area of the STM32MP1 Series web page. The resources below are referenced in some of the articles of this user guide.

Information: The different STM32MP15 microprocessor part numbers available (with their corresponding internal peripherals, security options and packages) are described in the STM32MP15 microprocessor part numbers.

NEW means that the document (or its version) is new compared to what was delivered within the previous ecosystem release.

8. How to Download the Software and Start with This Release?

The list of embedded software packages available for download depends on the selected packages.

The table below provides the available board part numbers as well as information in order to:

• get started with one of the three available Packages (Starter, Developer or Distribution Package).
• get started with the board.
• find the associated embedded software distributions.
• download source code.
• build a piece of embedded software.

9. STM32MPU Embedded Software Distribution Detailed Release Notes

The table below lists the software packages available in the STM32MPU Embedded Software distributions, and provides the corresponding release notes. The release notes give more information and details about the features and content of the packages. They do not explain how to download the software. Refer to How to get the software and start with this release.

10. Referenced Tools Release Notes

The table below lists the available tools, and provides links to the corresponding release notes. Each release note gives information on how to install and use the corresponding tool. The set of tools that can be downloaded depends on the package that is used (double check Which Package better suits your needs article for more information on each package).

11. References

• 1.01.1 The part numbers are specified in STM32MP15 microprocessor part numbers.

12. Archives

Microprocessor Unit

• Das U-Boot -- the Universal Boot Loader (see U-Boot_overview)
• Trusted Firmware for Arm® Cortex®-A
• Open Portable Trusted Execution Environment
• Power Management Integrated Circuit
• Central processing unit
• Evaluation board
• Discovery kit
• Cortex®
• Linux® is a registered trademark of Linus Torvalds.
• Direct Memory Access
• Secondary Program Loader, Also known as U-Boot SPL
• First Stage Boot Loader
• TeleTYpewriter
• Board support package
• Hardware Abstraction Layer
• Low layer of STM32Cube
• Cortex Microcontroller Software Interface Standard
• Inter-Integrated Circuit (Bi-directional 2-wire bus standard for efficient inter-IC control.)
• low-power timer (STM32 specific)
• Random Number Generator
• Serial Peripheral Interface
• Application programming interface
• (Software) Integrated development/design/debugging environment
• former spelling for e-MMC ('e' in italic)
• Universal Asynchronous Receiver/Transmitter
• Non Volatile Memory, like a flash memory
• Secure Secret Provisioning
• Secure secrets provisioning
• User Interface
• Doubledata rate (memory domain)
• Extended TrustZone Protection Controller
• Software development kit (A programming package that enables a programmer to develop applications for a specific platform.)
• Real Time Clock
• USB port or connector
• Device Firmware Upgrade
• Universal Synchronous/Asynchronous Receiver/Transmitter
• Printed Circuit Board
• Arm® is a registered trademark of Arm Limited (or its subsidiaries) in the US and/or elsewhere.
• Display Serial Interface (MIPI® Alliance standard)