How to build bootloaders for Android: Difference between revisions

Latest revision as of 11:20, 13 March 2025↑

Applicable for

Important

OpenSTDroid is validated against the ecosystem release v5.1.0 . It has not been ported yet on ecosystem release v6.0.0 .

This article explains how to build the Android™ bootloader binaries for a selected STM32 device. It is intended for Distribution Package users.

This article explains how to rebuild the primary and secondary bootloaders for the STM32 device families. It is intended for Distribution Package users.

1. Prerequisites[edit | edit source]↑

The environment must be installed using the distribution package adapted to the selected microprocessor unit.

To execute the following instructions, work from the distribution root directory and initialize the environment with the following instructions:

source build/envsetup.sh
lunch aosp_<BoardId>-userdebug
bspsetup

Information

The bspsetup instruction only needs to be run once for each distribution.

2. Partition layout[edit | edit source]↑

The Trusted Firmware (TF-A) is used as the primary bootloader in the OpenSTDroid distribution. The TF-A binary file is part of the FSBL partition.

The Universal Bootloader (U-Boot) is used as the secondary bootloader in the OpenSTDroid distribution. The U-Boot binary file is part of the FIP partition.

The binaries are available in device/stm/<STM32Series>-bootloader/prebuilt.

Information

For information on the complete partition layout for the corresponding development platform, refer to the corresponding Flash mapping article named Your_development_platform Flash mapping for Android™. Example: STM32 MPU Flash mapping for Android for the STM32MP25 boards.

All Flash mapping for Android™ articles belong to the Category:Flash mapping for Android.

3. Load the bootloader sources[edit | edit source]↑

By default, the bootloader sources are not part of the OpenSTDroid distribution. To load the sources, execute the following instruction:

load_bootloader

It will load both the TF-A and U-Boot sources.

Information

The load_bootloader script uses the configuration file android_fsbl.config (resp. android_ssbl.config) available in the device/stm/<STM32Series>-bootloader/source/patch/<fsbl-version>/ (resp. .../<ssbl-version>/) directory.

The bootloader sources are located in:

TF-A: device/stm/<STM32Series>-bootloader/tf-a-<STM32Series>
U-Boot: device/stm/<STM32Series>-bootloader/u-boot-<STM32Series>

Information

As soon as possible, only the archive is loaded from the remote repository (reducing size). This means that you need to configure your environment to ensure that you can download via http from GitHub. If required the remote repository with all the git history can be cloned instead.

For that purpose, BOOTLOADER_ARCHIVE_PATH must be replaced by BOOTLOADER_GIT_PATHin the file android_fsbl.config (resp. android_ssbl.config) . Then execute load_bootloader again with -f option if previously loaded sources have to be replaced.

4. Build the bootloaders[edit | edit source]↑

To build both the FSBL and the SSBL, run:

build_bootloader

Warning

The build script is only compatible with x86_64 host machine. The arm64 host machine compatible version will arrive soon.

This instruction generates both the TF-A and the U-Boot for every available board, memory, and boot mode in the optee configuration.

To get more details on available options, run:

build_bootloader -h

Hereafter, this is the result for version 1.8:

Usage: build_bootloader [Options] [Mode Options] [Board Options]

  This script allows building the bootloaders source (TF-A and/or U-Boot)

Options:
  -h / --help: print this message
  -v / --version: get script version
  -i / --install: update prebuilt images
  --verbose=<level>: enable verbosity (1 or 2 depending on level of verbosity required)

  -p / --programmer: build dedicated programmer version (-i option forced)
  -g/--gdb: generate .elf files useful for debug purpose
  -t / --tools: generate fiptool for the HOST machine

Board options: (default = all possibilities)
  -b <name> / --board=<name>: set board name from following list = eval (default: all)
  -m <config> / --mem=<config>: set memory configuration from following list = sd emmc (default: all)

5. Integrate the bootloaders[edit | edit source]↑

To update prebuilt images add -i option:

build_bootloader -i

To integrate the updated prebuilt images, execute from the root directory:

make -j

Then update associated partitions on your device. Refer to How to populate boards for Android

@@ Line 3: / Line 3: @@
 |MPUs checklist=STM32MP13x, STM32MP15x, STM32MP25x
 }}</noinclude>
+{{FlowCompatibility/Android}}
+This article explains how to build the Android™ bootloader binaries for a selected STM32 device. It is intended for Distribution Package users.
-This article explains how to build the Android&trade; bootloader binaries for a selected STM32 device. It is intended for Distribution Package users.
+This article explains how to rebuild the primary and secondary bootloaders for the STM32 device families. It is intended for Distribution Package users.
-This article explains how to rebuild the primary and the secondary bootloaders for the STM32 device families. It is intended for Distribution Package users.
 == Prerequisites ==
-The environment must be installed using the Distribution Package adapted to the selected microprocessor device.
+The environment must be installed using the distribution package adapted to the selected microprocessor unit.
-To be able to execute following instructions, work from the distribution root directory and initialize the environment with the following instructions:
-  {{PC$}} source build/envsetup.sh
+To execute the following instructions, work from the distribution root directory and initialize the environment with the following instructions:
-  {{PC$}} lunch aosp_{{HighlightParam|''<BoardId>''}}-userdebug
+  {{PC$}}source build/envsetup.sh
-  {{PC$}} bspsetup
+  {{PC$}}lunch aosp_{{HighlightParam|''<BoardId>''}}-userdebug
-{{Info| The <code>bspsetup</code> instruction only needs to be run once for each distribution}}
+  {{PC$}}bspsetup
+{{Info| The <code>bspsetup</code> instruction only needs to be run once for each distribution.}}
 == Partition layout ==
-The Trusted Firmware (TF-A) is used as the ''primary bootloader'' in the OpenSTDroid distribution.
+The Trusted Firmware (TF-A) is used as the primary bootloader in the OpenSTDroid distribution. The TF-A binary file is part of the FSBL partition.
-The TF-A binary file is part of the <code>fsbl</code> partition.
-The Universal Bootloader (U-Boot) is used as the ''secondary bootloader'' in the OpenSTDroid distribution.
+The Universal Bootloader (U-Boot) is used as the secondary bootloader in the OpenSTDroid distribution. The U-Boot binary file is part of the FIP partition.
-The U-Boot binary file is part of the <code>fip</code> partition.
 The binaries are available in <code>device/stm/{{HighlightParam|''<STM32Series>''}}-bootloader/prebuilt</code>.
@@ Line 39: / Line 36: @@
 By default, the bootloader sources are not part of the OpenSTDroid distribution. To load the sources, execute the following instruction:
-  {{PC$}} load_bootloader
+  {{PC$}}load_bootloader
 It will load both the TF-A and U-Boot sources.
@@ Line 59: / Line 56: @@
 To build both the FSBL and the SSBL, run:
-  {{PC$}} build_bootloader
+  {{PC$}}build_bootloader
 {{Warning| The build script is only compatible with <code>x86_64</code> host machine. The <code>arm64</code> host machine compatible version will arrive soon.}}
-This instruction generates both the TF-A and the U-Boot for every available board, memory and boot mode in the optee configuration.
+This instruction generates both the TF-A and the U-Boot for every available board, memory, and boot mode in the optee configuration.
-To get back more details on available options, run:
+To get more details on available options, run:
-  {{PC$}} build_bootloader -h
+  {{PC$}}build_bootloader -h
-Here after, this the result for the version 1.8:
+Hereafter, this is the result for version 1.8:
 <pre>
 Usage: build_bootloader [Options] [Mode Options] [Board Options]
@@ Line 93: / Line 90: @@
 To update prebuilt images add '''-i''' option:
-  {{PC$}} build_bootloader -i
+  {{PC$}}build_bootloader -i
 To integrate the updated prebuilt images, execute from the root directory:
-  {{PC$}} make -j
+  {{PC$}}make -j
 Then update associated partitions on your device. Refer to [[How to populate boards for Android]]
 <noinclude>
-{{PublicationRequestId | no id | no date}}
+{{PublicationRequestId | 33629 | 2025-01-13 |  }}
 [[Category:How to Android]]
 [[Category:Android]]
 </noinclude>