1 .. SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause
2 .. sectionauthor:: Patrick Delaunay <patrick.delaunay@st.com>
7 This is a quick instruction for setup STM32MP15x boards.
12 U-Boot supports STMP32MP15x SoCs:
18 The STM32MP15x is a Cortex-A MPU aimed at various applications.
22 - Dual core Cortex-A7 application core (Single on STM32MP151)
23 - 2D/3D image composition with GPU (only on STM32MP157)
24 - Standard memories interface support
25 - Standard connectivity, widely inherited from the STM32 MCU family
26 - Comprehensive security support
28 Each line comes with a security option (cryptography & secure boot) and
29 a Cortex-A frequency option:
31 - A : Cortex-A7 @ 650 MHz
32 - C : Secure Boot + HW Crypto + Cortex-A7 @ 650 MHz
33 - D : Cortex-A7 @ 800 MHz
34 - F : Secure Boot + HW Crypto + Cortex-A7 @ 800 MHz
36 Everything is supported in Linux but U-Boot is limited to:
39 2. SD card/MMC controller (SDMMC)
40 3. NAND controller (FMC)
41 4. NOR controller (QSPI)
42 5. USB controller (OTG DWC2)
43 6. Ethernet controller
45 And the necessary drivers
48 2. STPMIC1 (PMIC and regulator)
49 3. Clock, Reset, Sysreset
52 Currently the following boards are supported:
58 + stm32mp15xx-dhcor-avenger96.dts
63 3 boot configurations are supported with:
65 +----------+------------------------+-------------------------+--------------+
66 | **ROM** | **FSBL** | **SSBL** | **OS** |
67 + **code** +------------------------+-------------------------+--------------+
68 | | First Stage Bootloader | Second Stage Bootloader | Linux Kernel |
69 + +------------------------+-------------------------+--------------+
70 | | embedded RAM | DDR |
71 +----------+------------------------+-------------------------+--------------+
73 The **Trusted** boot chain
74 ``````````````````````````
76 defconfig_file : stm32mp15_trusted_defconfig
78 +-------------+-------------------------+------------+-------+
79 | ROM code | FSBL | SSBL | OS |
80 + +-------------------------+------------+-------+
81 | |Trusted Firmware-A (TF-A)| U-Boot | Linux |
82 +-------------+-------------------------+------------+-------+
83 | TrustZone |secure monitor |
84 +-------------+-------------------------+------------+-------+
86 TF-A performs a full initialization of Secure peripherals and installs a
89 * SPMin provided by TF-A or
90 * OP-TEE from specific partitions (teeh, teed, teex).
92 U-Boot is running in normal world and uses the secure monitor to access
95 The **Basic** boot chain
96 ````````````````````````
98 defconfig_file : stm32mp15_basic_defconfig
100 +-------------+------------+------------+-------+
101 | ROM code | FSBL | SSBL | OS |
102 + +------------+------------+-------+
103 | |U-Boot SPL | U-Boot | Linux |
104 +-------------+------------+------------+-------+
105 | TrustZone | | PSCI from U-Boot |
106 +-------------+------------+------------+-------+
108 SPL has limited security initialization
110 U-Boot is running in secure mode and provide a secure monitor to the kernel
111 with only PSCI support (Power State Coordination Interface defined by ARM).
113 All the STM32MP15x boards supported by U-Boot use the same generic board
114 stm32mp1 which support all the bootable devices.
116 Each board is configured only with the associated device tree.
118 Device Tree Selection
119 ---------------------
121 You need to select the appropriate device tree for your board,
122 the supported device trees for STM32MP15x are:
124 + ev1: eval board with pmic stpmic1 (ev1 = mother board + daughter ed1)
128 + ed1: daughter board with pmic stpmic1
132 + dk1: Discovery board
136 + dk2: Discovery board = dk1 with a BT/WiFI combo and a DSI panel
140 + avenger96: Avenger96 board from Arrow Electronics based on DH Elec. DHCOR SoM
142 + stm32mp15xx-dhcor-avenger96
147 1. Install the required tools for U-Boot
149 * install package needed in U-Boot makefile
150 (libssl-dev, swig, libpython-dev...)
152 * install ARMv7 toolchain for 32bit Cortex-A (from Linaro,
153 from SDK for STM32MP15x, or any crosstoolchains from your distribution)
154 (you can use any gcc cross compiler compatible with U-Boot)
156 2. Set the cross compiler::
158 # export CROSS_COMPILE=/path/to/toolchain/arm-linux-gnueabi-
160 3. Select the output directory (optional)::
162 # export KBUILD_OUTPUT=/path/to/output
164 for example: use one output directory for each configuration::
166 # export KBUILD_OUTPUT=stm32mp15_trusted
167 # export KBUILD_OUTPUT=stm32mp15_basic
169 you can build outside of code directory::
171 # export KBUILD_OUTPUT=../build/stm32mp15_trusted
173 4. Configure U-Boot::
175 # make <defconfig_file>
177 with <defconfig_file>:
179 - For **trusted** boot mode : **stm32mp15_trusted_defconfig**
180 - For basic boot mode: stm32mp15_basic_defconfig
182 5. Configure the device-tree and build the U-Boot image::
184 # make DEVICE_TREE=<name> all
188 a) trusted boot on ev1::
190 # export KBUILD_OUTPUT=stm32mp15_trusted
191 # make stm32mp15_trusted_defconfig
192 # make DEVICE_TREE=stm32mp157c-ev1 all
194 b) trusted with OP-TEE boot on dk2::
196 # export KBUILD_OUTPUT=stm32mp15_trusted
197 # make stm32mp15_trusted_defconfig
198 # make DEVICE_TREE=stm32mp157c-dk2 all
200 c) basic boot on ev1::
202 # export KBUILD_OUTPUT=stm32mp15_basic
203 # make stm32mp15_basic_defconfig
204 # make DEVICE_TREE=stm32mp157c-ev1 all
206 d) basic boot on ed1::
208 # export KBUILD_OUTPUT=stm32mp15_basic
209 # make stm32mp15_basic_defconfig
210 # make DEVICE_TREE=stm32mp157c-ed1 all
212 e) basic boot on dk1::
214 # export KBUILD_OUTPUT=stm32mp15_basic
215 # make stm32mp15_basic_defconfig
216 # make DEVICE_TREE=stm32mp157a-dk1 all
218 f) basic boot on avenger96::
220 # export KBUILD_OUTPUT=stm32mp15_basic
221 # make stm32mp15_basic_defconfig
222 # make DEVICE_TREE=stm32mp15xx-dhcor-avenger96 all
226 BootRom and TF-A expect binaries with STM32 image header
227 SPL expects file with U-Boot uImage header
229 So in the output directory (selected by KBUILD_OUTPUT),
230 you can found the needed files:
232 - For **Trusted** boot (with or without OP-TEE)
234 - FSBL = **tf-a.stm32** (provided by TF-A compilation)
235 - SSBL = **u-boot.stm32**
239 - FSBL = spl/u-boot-spl.stm32
242 Switch Setting for Boot Mode
243 ----------------------------
245 You can select the boot mode, on the board with one switch, to select
246 the boot pin values = BOOT0, BOOT1, BOOT2
248 +-------------+---------+---------+---------+
249 |*Boot Mode* | *BOOT2* | *BOOT1* | *BOOT0* |
250 +=============+=========+=========+=========+
251 | Recovery | 0 | 0 | 0 |
252 +-------------+---------+---------+---------+
254 +-------------+---------+---------+---------+
256 +-------------+---------+---------+---------+
258 +-------------+---------+---------+---------+
259 | Reserved | 1 | 0 | 0 |
260 +-------------+---------+---------+---------+
261 | SD-Card | 1 | 0 | 1 |
262 +-------------+---------+---------+---------+
263 | Recovery | 1 | 1 | 0 |
264 +-------------+---------+---------+---------+
265 | SPI-NAND | 1 | 1 | 1 |
266 +-------------+---------+---------+---------+
268 - on the **daugther board ed1 = MB1263** with the switch SW1
269 - on **Avenger96** with switch S3 (NOR and SPI-NAND are not applicable)
270 - on board **DK1/DK2** with the switch SW1 = BOOT0, BOOT2
271 with only 2 pins available (BOOT1 is forced to 0 and NOR not supported),
272 the possible value becomes:
274 +-------------+---------+---------+
275 |*Boot Mode* | *BOOT2* | *BOOT0* |
276 +=============+=========+=========+
278 +-------------+---------+---------+
280 +-------------+---------+---------+
282 +-------------+---------+---------+
284 +-------------+---------+---------+
286 Recovery is a boot from serial link (UART/USB) and it is used with
287 STM32CubeProgrammer tool to load executable in RAM and to update the flash
288 devices available on the board (NOR/NAND/eMMC/SD card).
290 The communication between HOST and board is based on
292 - for UARTs : the uart protocol used with all MCU STM32
293 - for USB : based on USB DFU 1.1 (without the ST extensions used on MCU STM32)
298 The minimal requirements for STMP32MP15x boot up to U-Boot are:
300 - GPT partitioning (with gdisk or with sgdisk)
301 - 2 fsbl partitions, named fsbl1 and fsbl2, size at least 256KiB
302 - one ssbl partition for U-Boot
304 Then the minimal GPT partition is:
306 +-------+--------+---------+-------------+
307 | *Num* | *Name* | *Size* | *Content* |
308 +=======+========+=========+=============+
309 | 1 | fsbl1 | 256 KiB | TF-A or SPL |
310 +-------+--------+---------+-------------+
311 | 2 | fsbl2 | 256 KiB | TF-A or SPL |
312 +-------+--------+---------+-------------+
313 | 3 | ssbl | enought | U-Boot |
314 +-------+--------+---------+-------------+
315 | 4 | <any> | <any> | Rootfs |
316 +-------+--------+---------+-------------+
318 Add a 4th partition (Rootfs) marked bootable with a file extlinux.conf
319 following the Generic Distribution feature (doc/README.distro for use).
321 According the used card reader select the correct block device
322 (for example /dev/sdx or /dev/mmcblk0).
324 In the next example, it is /dev/mmcblk0
326 For example: with gpt table with 128 entries
328 a) remove previous formatting::
330 # sgdisk -o /dev/<SD card dev>
332 b) create minimal image::
334 # sgdisk --resize-table=128 -a 1 \
335 -n 1:34:545 -c 1:fsbl1 \
336 -n 2:546:1057 -c 2:fsbl2 \
337 -n 3:1058:5153 -c 3:ssbl \
338 -n 4:5154: -c 4:rootfs \
339 -p /dev/<SD card dev>
341 With other partition for kernel one partition rootfs for kernel.
343 c) copy the FSBL (2 times) and SSBL file on the correct partition.
344 in this example in partition 1 to 3
346 for basic boot mode : <SD card dev> = /dev/mmcblk0::
348 # dd if=u-boot-spl.stm32 of=/dev/mmcblk0p1
349 # dd if=u-boot-spl.stm32 of=/dev/mmcblk0p2
350 # dd if=u-boot.img of=/dev/mmcblk0p3
352 for trusted boot mode: ::
354 # dd if=tf-a.stm32 of=/dev/mmcblk0p1
355 # dd if=tf-a.stm32 of=/dev/mmcblk0p2
356 # dd if=u-boot.stm32 of=/dev/mmcblk0p3
358 To boot from SD card, select BootPinMode = 1 0 1 and reset.
363 You can use U-Boot to copy binary in eMMC.
365 In the next example, you need to boot from SD card and the images
366 (u-boot-spl.stm32, u-boot.img) are presents on SD card (mmc 0)
367 in ext4 partition 4 (bootfs).
369 To boot from SD card, select BootPinMode = 1 0 1 and reset.
371 Then you update the eMMC with the next U-Boot command :
373 a) prepare GPT on eMMC,
374 example with 2 partitions, bootfs and roots::
376 # setenv emmc_part "name=ssbl,size=2MiB;name=bootfs,type=linux,bootable,size=64MiB;name=rootfs,type=linux,size=512"
377 # gpt write mmc 1 ${emmc_part}
379 b) copy SPL on eMMC on firts boot partition
380 (SPL max size is 256kB, with LBA 512, 0x200)::
382 # ext4load mmc 0:4 0xC0000000 u-boot-spl.stm32
384 # mmc partconf 1 1 1 1
385 # mmc write ${fileaddr} 0 200
386 # mmc partconf 1 1 1 0
388 c) copy U-Boot in first GPT partition of eMMC::
390 # ext4load mmc 0:4 0xC0000000 u-boo t.img
392 # part start mmc 1 1 partstart
393 # mmc write ${fileaddr} ${partstart} ${filesize}
395 To boot from eMMC, select BootPinMode = 0 1 0 and reset.
400 Please read doc/README.enetaddr for the implementation guidelines for mac id
401 usage. Basically, environment has precedence over board specific storage.
403 For STMicroelectonics board, it is retrieved in STM32MP15x OTP :
405 - OTP_57[31:0] = MAC_ADDR[31:0]
406 - OTP_58[15:0] = MAC_ADDR[47:32]
408 To program a MAC address on virgin OTP words above, you can use the fuse command
409 on bank 0 to access to internal OTP and lock them:
411 Prerequisite: check if a MAC address isn't yet programmed in OTP
413 1) check OTP: their value must be equal to 0::
415 STM32MP> fuse sense 0 57 2
417 Word 0x00000039: 00000000 00000000
419 2) check environment variable::
421 STM32MP> env print ethaddr
422 ## Error: "ethaddr" not defined
424 3) check lock status of fuse 57 & 58 (at 0x39, 0=unlocked, 1=locked)::
426 STM32MP> fuse sense 0 0x10000039 2
428 Word 0x10000039: 00000000 00000000
430 Example to set mac address "12:34:56:78:9a:bc"
434 STM32MP> fuse prog -y 0 57 0x78563412 0x0000bc9a
438 STM32MP> fuse sense 0 57 2
440 Word 0x00000039: 78563412 0000bc9a
444 STM32MP> fuse prog 0 0x10000039 1 1
446 STM32MP> fuse sense 0 0x10000039 2
448 Word 0x10000039: 00000001 00000001
450 4) next REBOOT, in the trace::
452 ### Setting environment from OTP MAC address = "12:34:56:78:9a:bc"
454 5) check env update::
456 STM32MP> env print ethaddr
457 ethaddr=12:34:56:78:9a:bc
459 .. warning:: This command can't be executed twice on the same board as
460 OTP are protected. It is already done for the board
461 provided by STMicroelectronics.
466 U-Boot can boot the coprocessor before the kernel (coprocessor early boot).
468 a) Manuallly by using rproc commands (update the bootcmd)
472 # env set name_copro "rproc-m4-fw.elf"
473 # env set dev_copro 0
474 # env set loadaddr_copro 0xC1000000
476 Load binary from bootfs partition (number 4) on SD card (mmc 0)::
478 # ext4load mmc 0:4 ${loadaddr_copro} ${name_copro}
480 => ${filesize} variable is updated with the size of the loaded file.
482 Start M4 firmware with remote proc command::
485 # rproc load ${dev_copro} ${loadaddr_copro} ${filesize}
486 # rproc start ${dev_copro}"00270033
488 b) Automatically by using FIT feature and generic DISTRO bootcmd
490 see examples in the board stm32mp1 directory: fit_copro_kernel_dtb.its
492 Generate FIT including kernel + device tree + M4 firmware with cfg with M4 boot::
494 $> mkimage -f fit_copro_kernel_dtb.its fit_copro_kernel_dtb.itb
496 Then using DISTRO configuration file: see extlinux.conf to select the correct
505 The DFU is supported on ST board.
507 The env variable dfu_alt_info is automatically build, and all
508 the memory present on the ST boards are exported.
510 The dfu mode is started by the command::
514 On EV1 board, booting from SD card, without OP-TEE::
517 DFU alt settings list:
518 dev: RAM alt: 0 name: uImage layout: RAM_ADDR
519 dev: RAM alt: 1 name: devicetree.dtb layout: RAM_ADDR
520 dev: RAM alt: 2 name: uramdisk.image.gz layout: RAM_ADDR
521 dev: eMMC alt: 3 name: mmc0_fsbl1 layout: RAW_ADDR
522 dev: eMMC alt: 4 name: mmc0_fsbl2 layout: RAW_ADDR
523 dev: eMMC alt: 5 name: mmc0_ssbl layout: RAW_ADDR
524 dev: eMMC alt: 6 name: mmc0_bootfs layout: RAW_ADDR
525 dev: eMMC alt: 7 name: mmc0_vendorfs layout: RAW_ADDR
526 dev: eMMC alt: 8 name: mmc0_rootfs layout: RAW_ADDR
527 dev: eMMC alt: 9 name: mmc0_userfs layout: RAW_ADDR
528 dev: eMMC alt: 10 name: mmc1_boot1 layout: RAW_ADDR
529 dev: eMMC alt: 11 name: mmc1_boot2 layout: RAW_ADDR
530 dev: eMMC alt: 12 name: mmc1_ssbl layout: RAW_ADDR
531 dev: eMMC alt: 13 name: mmc1_bootfs layout: RAW_ADDR
532 dev: eMMC alt: 14 name: mmc1_vendorfs layout: RAW_ADDR
533 dev: eMMC alt: 15 name: mmc1_rootfs layout: RAW_ADDR
534 dev: eMMC alt: 16 name: mmc1_userfs layout: RAW_ADDR
535 dev: MTD alt: 17 name: nor0 layout: RAW_ADDR
536 dev: MTD alt: 18 name: nand0 layout: RAW_ADDR
537 dev: VIRT alt: 19 name: OTP layout: RAW_ADDR
538 dev: VIRT alt: 20 name: PMIC layout: RAW_ADDR
540 All the supported device are exported for dfu-util tool::
543 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=20, name="PMIC", serial="002700333338511934383330"
544 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=19, name="OTP", serial="002700333338511934383330"
545 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=18, name="nand0", serial="002700333338511934383330"
546 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=17, name="nor0", serial="002700333338511934383330"
547 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=16, name="mmc1_userfs", serial="002700333338511934383330"
548 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=15, name="mmc1_rootfs", serial="002700333338511934383330"
549 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=14, name="mmc1_vendorfs", serial="002700333338511934383330"
550 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=13, name="mmc1_bootfs", serial="002700333338511934383330"
551 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=12, name="mmc1_ssbl", serial="002700333338511934383330"
552 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=11, name="mmc1_boot2", serial="002700333338511934383330"
553 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=10, name="mmc1_boot1", serial="002700333338511934383330"
554 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=9, name="mmc0_userfs", serial="002700333338511934383330"
555 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=8, name="mmc0_rootfs", serial="002700333338511934383330"
556 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=7, name="mmc0_vendorfs", serial="002700333338511934383330"
557 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=6, name="mmc0_bootfs", serial="002700333338511934383330"
558 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=5, name="mmc0_ssbl", serial="002700333338511934383330"
559 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=4, name="mmc0_fsbl2", serial="002700333338511934383330"
560 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=3, name="mmc0_fsbl1", serial="002700333338511934383330"
561 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=2, name="uramdisk.image.gz", serial="002700333338511934383330"
562 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=1, name="devicetree.dtb", serial="002700333338511934383330"
563 Found DFU: [0483:df11] ver=9999, devnum=99, cfg=1, intf=0, alt=0, name="uImage", serial="002700333338511934383330"
565 You can update the boot device:
569 $> dfu-util -d 0483:5720 -a 3 -D tf-a-stm32mp157c-ev1-trusted.stm32
570 $> dfu-util -d 0483:5720 -a 4 -D tf-a-stm32mp157c-ev1-trusted.stm32
571 $> dfu-util -d 0483:5720 -a 5 -D u-boot-stm32mp157c-ev1-trusted.img
572 $> dfu-util -d 0483:5720 -a 6 -D st-image-bootfs-openstlinux-weston-stm32mp1.ext4
573 $> dfu-util -d 0483:5720 -a 7 -D st-image-vendorfs-openstlinux-weston-stm32mp1.ext4
574 $> dfu-util -d 0483:5720 -a 8 -D st-image-weston-openstlinux-weston-stm32mp1.ext4
575 $> dfu-util -d 0483:5720 -a 9 -D st-image-userfs-openstlinux-weston-stm32mp1.ext4
579 $> dfu-util -d 0483:5720 -a 10 -D tf-a-stm32mp157c-ev1-trusted.stm32
580 $> dfu-util -d 0483:5720 -a 11 -D tf-a-stm32mp157c-ev1-trusted.stm32
581 $> dfu-util -d 0483:5720 -a 12 -D u-boot-stm32mp157c-ev1-trusted.img
582 $> dfu-util -d 0483:5720 -a 13 -D st-image-bootfs-openstlinux-weston-stm32mp1.ext4
583 $> dfu-util -d 0483:5720 -a 14 -D st-image-vendorfs-openstlinux-weston-stm32mp1.ext4
584 $> dfu-util -d 0483:5720 -a 15 -D st-image-weston-openstlinux-weston-stm32mp1.ext4
585 $> dfu-util -d 0483:5720 -a 16 -D st-image-userfs-openstlinux-weston-stm32mp1.ext4
587 - you can also dump the OTP and the PMIC NVM with::
589 $> dfu-util -d 0483:5720 -a 19 -U otp.bin
590 $> dfu-util -d 0483:5720 -a 20 -U pmic.bin
593 When the board is booting for nor0 or nand0,
594 only the MTD partition on the boot devices are available, for example:
596 - NOR (nor0 = alt 20) & NAND (nand0 = alt 26) ::
598 $> dfu-util -d 0483:5720 -a 21 -D tf-a-stm32mp157c-ev1-trusted.stm32
599 $> dfu-util -d 0483:5720 -a 22 -D tf-a-stm32mp157c-ev1-trusted.stm32
600 $> dfu-util -d 0483:5720 -a 23 -D u-boot-stm32mp157c-ev1-trusted.img
601 $> dfu-util -d 0483:5720 -a 27 -D st-image-weston-openstlinux-weston-stm32mp1_nand_4_256_multivolume.ubi
603 - NAND (nand0 = alt 21)::
605 $> dfu-util -d 0483:5720 -a 22 -D tf-a-stm32mp157c-ev1-trusted.stm32
606 $> dfu-util -d 0483:5720 -a 23 -D u-boot-stm32mp157c-ev1-trusted.img
607 $> dfu-util -d 0483:5720 -a 24 -D u-boot-stm32mp157c-ev1-trusted.img
608 $> dfu-util -d 0483:5720 -a 25 -D st-image-weston-openstlinux-weston-stm32mp1_nand_4_256_multivolume.ubi