[8/9] doc: add board documentation for stm32mp1

Change plain test README to rst format and move this file
in documentation directory.

Signed-off-by: Patrick Delaunay <patrick.delaunay at st.com>
---

 board/st/stm32mp1/README  | 520 +--------------------------------
 doc/board/index.rst       |   1 +
 doc/board/st/index.rst    |   9 +
 doc/board/st/stm32mp1.rst | 598 ++++++++++++++++++++++++++++++++++++++
 4 files changed, 609 insertions(+), 519 deletions(-)
 create mode 100644 doc/board/st/index.rst
 create mode 100644 doc/board/st/stm32mp1.rst

On 1/28/20 10:11 AM, Patrick Delaunay wrote:
> Change plain test README to rst format and move this file
> in documentation directory.
>
> Signed-off-by: Patrick Delaunay <patrick.delaunay at st.com>

When I apply only this patch to origin/master:

git am /tmp/1.patch
Applying: doc: add board documentation for stm32mp1
error: patch failed: board/st/stm32mp1/README:1
error: board/st/stm32mp1/README: patch does not apply
.git/rebase-apply/patch:1164: new blank line at EOF.

Maybe this patch will have to be rebased.

> ---
>
>   board/st/stm32mp1/README  | 520 +--------------------------------
>   doc/board/index.rst       |   1 +
>   doc/board/st/index.rst    |   9 +
>   doc/board/st/stm32mp1.rst | 598 ++++++++++++++++++++++++++++++++++++++
>   4 files changed, 609 insertions(+), 519 deletions(-)
>   create mode 100644 doc/board/st/index.rst
>   create mode 100644 doc/board/st/stm32mp1.rst
>
> diff --git a/board/st/stm32mp1/README b/board/st/stm32mp1/README
> index 5d7465a8c8..8172d26a66 100644
> --- a/board/st/stm32mp1/README
> +++ b/board/st/stm32mp1/README
> @@ -1,519 +1 @@
> -SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause
> -#
> -# Copyright (C) 2018 STMicroelectronics - All Rights Reserved
> -#
> -
> -U-Boot on STMicroelectronics STM32MP15x
> -=======================================
> -
> -1. Summary
> -==========
> -This is a quick instruction for setup stm32mp1 boards.
> -
> -2. Supported devices
> -====================
> -U-Boot supports STMP32MP15x SoCs: STM32MP157, STM32MP153 and STM32MP151
> -
> -The STM32MP15x is a Cortex-A MPU aimed at various applications.
> -It features:
> -- Dual core Cortex-A7 application core (Single on STM32MP151)
> -- 2D/3D image composition with GPU (only on STM32MP157)
> -- Standard memories interface support
> -- Standard connectivity, widely inherited from the STM32 MCU family
> -- Comprehensive security support
> -
> -Everything is supported in Linux but U-Boot is limited to:
> -1. UART
> -2. SDCard/MMC controller (SDMMC)
> -3. NAND controller (FMC)
> -4. NOR controller (QSPI)
> -5. USB controller (OTG DWC2)
> -6. Ethernet controller
> -
> -And the necessary drivers
> -1. I2C
> -2. STPMIC1 (PMIC and regulator)
> -3. Clock, Reset, Sysreset
> -4. Fuse
> -
> -Currently the following boards are supported:
> -+ stm32mp157a-avenger96.dts
> -+ stm32mp157a-dk1.dts
> -+ stm32mp157c-dk2.dts
> -+ stm32mp157c-ed1.dts
> -+ stm32mp157c-ev1.dts
> -
> -3. Boot Sequences
> -=================
> -
> -BootRom => FSBL in SYSRAM => SSBL in DDR => OS (Linux Kernel)
> -
> -with FSBL = First Stage Bootloader
> -     SSBL = Second Stage Bootloader
> -
> -3 boot configurations are supported:
> -
> -1) The "Trusted" boot chain (defconfig_file : stm32mp15_trusted_defconfig)
> -   BootRom => FSBL = Trusted Firmware-A (TF-A) => SSBL = U-Boot
> -   TF-A performs a full initialization of Secure peripherals and installs a
> -   secure monitor.
> -   U-Boot is running in normal world and uses TF-A monitor
> -   to access to secure resources.
> -
> -2) The "Trusted" boot chain with OP-TEE
> -   (defconfig_file : stm32mp15_optee_defconfig)
> -   BootRom => FSBL = Trusted Firmware-A (TF-A) => SSBL = U-Boot
> -   TF-A performs a full initialization of Secure peripherals and installs OP-TEE
> -   from specific partitions (teeh, teed, teex).
> -   U-Boot is running in normal world and uses OP-TEE monitor to access
> -   to secure resources.
> -
> -3) The "Basic" boot chain (defconfig_file : stm32mp15_basic_defconfig)
> -   BootRom => FSBL = U-Boot SPL => SSBL = U-Boot
> -   SPL has limited security initialisation
> -   U-Boot is running in secure mode and provide a secure monitor to the kernel
> -   with only PSCI support (Power State Coordination Interface defined by ARM).
> -
> -All the STM32MP15x boards supported by U-Boot use the same generic board
> -stm32mp1 which support all the bootable devices.
> -
> -Each board is configurated only with the associated device tree.
> -
> -4. Device Tree Selection
> -========================
> -
> -You need to select the appropriate device tree for your board,
> -the supported device trees for stm32mp157 are:
> -
> -+ ev1: eval board with pmic stpmic1 (ev1 = mother board + daughter ed1)
> -  dts: stm32mp157c-ev1
> -
> -+ ed1: daughter board with pmic stpmic1
> -  dts: stm32mp157c-ed1
> -
> -+ dk1: Discovery board
> -  dts: stm32mp157a-dk1
> -
> -+ dk2: Discovery board = dk1 with a BT/WiFI combo and a DSI panel
> -  dts: stm32mp157c-dk2
> -
> -+ avenger96: Avenger96 board from Arrow Electronics
> -  dts: stm32mp157a-avenger96
> -
> -5. Build Procedure
> -==================
> -
> -1. Install required tools for U-Boot
> -
> -   + install package needed in U-Boot makefile
> -     (libssl-dev, swig, libpython-dev...)
> -   + install ARMv7 toolchain for 32bit Cortex-A (from Linaro,
> -     from SDK for STM32MP15x, or any crosstoolchains from your distribution)
> -
> -2. Set the cross compiler:
> -
> -	# export CROSS_COMPILE=/path/to/toolchain/arm-linux-gnueabi-
> -	(you can use any gcc cross compiler compatible with U-Boot)
> -
> -3. Select the output directory (optional)
> -
> -	# export KBUILD_OUTPUT=/path/to/output
> -
> -	for example: use one output directory for each configuration
> -	# export KBUILD_OUTPUT=stm32mp15_trusted
> -	# export KBUILD_OUTPUT=stm32mp15_optee
> -	# export KBUILD_OUTPUT=stm32mp15_basic
> -
> -	you can build outside of code directory:
> -	# export KBUILD_OUTPUT=../build/stm32mp15_trusted
> -
> -4. Configure U-Boot:
> -
> -	# make <defconfig_file>
> -
> -	- For trusted boot mode : "stm32mp15_trusted_defconfig"
> -	- For trusted with OP-TEE boot mode : "stm32mp15_optee_defconfig"
> -	- For basic boot mode: "stm32mp15_basic_defconfig"
> -
> -5. Configure the device-tree and build the U-Boot image:
> -
> -	# make DEVICE_TREE=<name> all
> -
> -  example:
> -  a) trusted boot on ev1
> -	# export KBUILD_OUTPUT=stm32mp15_trusted
> -	# make stm32mp15_trusted_defconfig
> -	# make DEVICE_TREE=stm32mp157c-ev1 all
> -
> -  b) trusted with OP-TEE boot on dk2
> -	# export KBUILD_OUTPUT=stm32mp15_optee
> -	# make stm32mp15_optee_defconfig
> -	# make DEVICE_TREE=stm32mp157c-dk2 all
> -
> -  c) basic boot on ev1
> -	# export KBUILD_OUTPUT=stm32mp15_basic
> -	# make stm32mp15_basic_defconfig
> -	# make DEVICE_TREE=stm32mp157c-ev1 all
> -
> -  d) basic boot on ed1
> -	# export KBUILD_OUTPUT=stm32mp15_basic
> -	# make stm32mp15_basic_defconfig
> -	# make DEVICE_TREE=stm32mp157c-ed1 all
> -
> -  e) basic boot on dk1
> -	# export KBUILD_OUTPUT=stm32mp15_basic
> -	# make stm32mp15_basic_defconfig
> -	# make DEVICE_TREE=stm32mp157a-dk1 all
> -
> -  f) basic boot on avenger96
> -	# export KBUILD_OUTPUT=stm32mp15_basic
> -	# make stm32mp15_basic_defconfig
> -	# make DEVICE_TREE=stm32mp157a-avenger96 all
> -
> -6. Output files
> -
> -  BootRom and TF-A expect binaries with STM32 image header
> -  SPL expects file with U-Boot uImage header
> -
> -  So in the output directory (selected by KBUILD_OUTPUT),
> -  you can found the needed files:
> -
> -  a) For Trusted boot (with or without OP-TEE)
> -   + FSBL = tf-a.stm32 (provided by TF-A compilation)
> -   + SSBL = u-boot.stm32
> -
> -  b) For Basic boot
> -   + FSBL = spl/u-boot-spl.stm32
> -   + SSBL = u-boot.img
> -
> -6. Switch Setting for Boot Mode
> -===============================
> -
> -You can select the boot mode, on the board with one switch :
> -
> -- on the daugther board ed1 with the switch SW1 : BOOT0, BOOT1, BOOT2
> -
> - -----------------------------------
> -  Boot Mode   BOOT2   BOOT1   BOOT0
> - -----------------------------------
> -  Reserved	0	0	0
> -  NOR		0	0	1
> -  SD-Card	1	0	1
> -  eMMC		0	1	0
> -  NAND		0	1	1
> -  Recovery	1	1	0
> -  Recovery	0	0	0
> -
> -- on board DK1/DK2 with the switch SW1 : BOOT0, BOOT2
> -  (BOOT1 forced to 0, NOR not supported)
> -
> - --------------------------
> -  Boot Mode   BOOT2  BOOT0
> - --------------------------
> -  Reserved	1      0
> -  SD-Card	1      1
> -  Recovery	0      0
> -
> -- Boot mode of Avenger96 can be selected using switch S3
> -
> - -----------------------------------
> -  Boot Mode   BOOT2   BOOT1   BOOT0
> - -----------------------------------
> -  Recovery	0	0	0
> -  NOR		0	0	1
> -  SD-Card	1	0	1
> -  eMMC		0	1	0
> -  NAND		0	1	1
> -  Reserved	1	0	0
> -  Recovery	1	1	0
> -  SD-Card	1	1	1
> -
> -Recovery is a boot from serial link (UART/USB) and it is used with
> -STM32CubeProgrammer tool to load executable in RAM and to update the flash
> -devices available on the board (NOR/NAND/eMMC/SDCARD).
> -The communication between HOST and board is based on
> -- for UARTs : the uart protocol used with all MCU STM32
> -- for USB : based on USB DFU 1.1 (without the ST extensions used on MCU STM32)
> -
> -7. Prepare an SDCard
> -===================
> -
> -The minimal requirements for STMP32MP1 boot up to U-Boot are:
> -- GPT partitioning (with gdisk or with sgdisk)
> -- 2 fsbl partitions, named fsbl1 and fsbl2, size at least 256KiB
> -- one ssbl partition for U-Boot
> -
> -Then the minimal GPT partition is:
> -   ----- ------- --------- --------------
> -  | Num | Name  | Size    |  Content     |
> -   ----- ------- -------- ---------------
> -  |  1  | fsbl1 | 256 KiB |  TF-A or SPL |
> -  |  2  | fsbl2 | 256 KiB |  TF-A or SPL |
> -  |  3  | ssbl  | enought |  U-Boot      |
> -  |  *  |  -    |  -      |  Boot/Rootfs |
> -   ----- ------- --------- --------------
> -
> -(*) add bootable partition for extlinux.conf
> -    following Generic Distribution
> -    (doc/README.distro for use)
> -
> -  according the used card reader select the block device
> -  (/dev/sdx or /dev/mmcblk0)
> -  in the next example I use /dev/mmcblk0
> -
> -for example: with gpt table with 128 entries
> -
> -  a) remove previous formatting
> -	# sgdisk -o /dev/<SDCard dev>
> -
> -  b) create minimal image
> -	# sgdisk --resize-table=128 -a 1 \
> -		-n 1:34:545		-c 1:fsbl1 \
> -		-n 2:546:1057		-c 2:fsbl2 \
> -		-n 3:1058:5153		-c 3:ssbl \
> -		-p /dev/<SDCard dev>
> -
> -	you can add other partitions for kernel
> -	one partition rootfs for example:
> -		-n 4:5154:		-c 4:rootfs \
> -
> -  c) copy the FSBL (2 times) and SSBL file on the correct partition.
> -     in this example in partition 1 to 3
> -
> -     for basic boot mode : <SDCard dev> = /dev/mmcblk0
> -	# dd if=u-boot-spl.stm32 of=/dev/mmcblk0p1
> -	# dd if=u-boot-spl.stm32 of=/dev/mmcblk0p2
> -	# dd if=u-boot.img of=/dev/mmcblk0p3
> -
> -     for trusted boot mode :
> -	# dd if=tf-a.stm32 of=/dev/mmcblk0p1
> -	# dd if=tf-a.stm32 of=/dev/mmcblk0p2
> -	# dd if=u-boot.stm32 of=/dev/mmcblk0p3
> -
> -To boot from SDCard, select BootPinMode = 1 0 1 and reset.
> -
> -8. Prepare eMMC
> -===============
> -You can use U-Boot to copy binary in eMMC.
> -
> -In the next example, you need to boot from SDCARD and the images (u-boot-spl.stm32, u-boot.img)
> -are presents on SDCARD (mmc 0) in ext4 partition 4 (bootfs).
> -
> -To boot from SDCard, select BootPinMode = 1 0 1 and reset.
> -
> -Then you update the eMMC with the next U-Boot command :
> -
> -a) prepare GPT on eMMC,
> -	example with 2 partitions, bootfs and roots:
> -
> -	# setenv emmc_part "name=ssbl,size=2MiB;name=bootfs,type=linux,bootable,size=64MiB;name=rootfs,type=linux,size=512"
> -	# gpt write mmc 1 ${emmc_part}
> -
> -b) copy SPL on eMMC on firts boot partition
> -	(SPL max size is 256kB, with LBA 512, 0x200)
> -
> -	# ext4load mmc 0:4 0xC0000000 u-boot-spl.stm32
> -	# mmc dev 1
> -	# mmc partconf 1 1 1 1
> -	# mmc write ${fileaddr} 0 200
> -	# mmc partconf 1 1 1 0
> -
> -c) copy U-Boot in first GPT partition of eMMC
> -
> -	# ext4load mmc 0:4 0xC0000000 u-boot.img
> -	# mmc dev 1
> -	# part start mmc 1 1 partstart
> -	# mmc write ${fileaddr} ${partstart} ${filesize}
> -
> -To boot from eMMC, select BootPinMode = 0 1 0 and reset.
> -
> -9. MAC Address
> -==============
> -
> -Please read doc/README.enetaddr for the implementation guidelines for mac id
> -usage. Basically, environment has precedence over board specific storage.
> -
> -For STMicroelectonics board, it is retrieved in STM32MP15x otp :
> -- OTP_57[31:0] = MAC_ADDR[31:0]
> -- OTP_58[15:0] = MAC_ADDR[47:32]
> -
> -To program a MAC address on virgin OTP words above, you can use the fuse command
> -on bank 0 to access to internal OTP:
> -
> -    Prerequisite: check if a MAC address isn't yet programmed in OTP
> -
> -    1- check OTP: their value must be equal to 0
> -
> -       STM32MP> fuse sense 0 57 2
> -       Sensing bank 0:
> -       Word 0x00000039: 00000000 00000000
> -
> -    2- check environment variable
> -
> -       STM32MP> env print ethaddr
> -       ## Error: "ethaddr" not defined
> -
> -    Example to set mac address "12:34:56:78:9a:bc"
> -
> -    1- Write OTP
> -       STM32MP> fuse prog -y 0 57 0x78563412 0x0000bc9a
> -
> -    2- Read OTP
> -       STM32MP> fuse sense 0 57 2
> -       Sensing bank 0:
> -       Word 0x00000039: 78563412 0000bc9a
> -
> -    3- next REBOOT :
> -       ### Setting environment from OTP MAC address = "12:34:56:78:9a:bc"
> -
> -    4 check env update
> -       STM32MP> env print ethaddr
> -       ethaddr=12:34:56:78:9a:bc
> -
> -warning:: This MAC address provisioning can't be executed twice on the same
> -          board as the OTP are protected. It is already done for the board
> -          provided by STMicroelectronics.
> -
> -10. Coprocessor firmware
> -========================
> -
> -U-Boot can boot the coprocessor before the kernel (coprocessor early boot).
> -
> -A/ Manuallly by using rproc commands (update the bootcmd)
> -     Configurations
> -	# env set name_copro "rproc-m4-fw.elf"
> -	# env set dev_copro 0
> -	# env set loadaddr_copro 0xC1000000
> -
> -     Load binary from bootfs partition (number 4) on SDCard (mmc 0)
> -	# ext4load mmc 0:4 ${loadaddr_copro} ${name_copro}
> -	=> ${filesize} updated with the size of the loaded file
> -
> -     Start M4 firmware with remote proc command
> -	# rproc init
> -	# rproc load ${dev_copro} ${loadaddr_copro} ${filesize}
> -	# rproc start ${dev_copro}
> -
> -B/ Automatically by using FIT feature and generic DISTRO bootcmd
> -
> -   see examples in this directory :
> -
> -   Generate FIT including kernel + device tree + M4 firmware
> -   with cfg with M4 boot
> -        $> mkimage -f fit_copro_kernel_dtb.its fit_copro_kernel_dtb.itb
> -
> -    Then using DISTRO configuration file: see extlinux.conf to select
> -    the correct configuration
> -	=> stm32mp157c-ev1-m4
> -	=> stm32mp157c-dk2-m4
> -
> -11. DFU support
> -===============
> -
> -The DFU is supported on ST board.
> -The env variable dfu_alt_info is automatically build, and all
> -the memory present on the ST boards are exported.
> -
> -The mode is started by
> -
> -STM32MP> dfu 0
> -
> -On EV1 board:
> -
> -STM32MP> dfu 0 list
> -
> -DFU alt settings list:
> -dev: RAM alt: 0 name: uImage layout: RAM_ADDR
> -dev: RAM alt: 1 name: devicetree.dtb layout: RAM_ADDR
> -dev: RAM alt: 2 name: uramdisk.image.gz layout: RAM_ADDR
> -dev: eMMC alt: 3 name: sdcard_fsbl1 layout: RAW_ADDR
> -dev: eMMC alt: 4 name: sdcard_fsbl2 layout: RAW_ADDR
> -dev: eMMC alt: 5 name: sdcard_ssbl layout: RAW_ADDR
> -dev: eMMC alt: 6 name: sdcard_bootfs layout: RAW_ADDR
> -dev: eMMC alt: 7 name: sdcard_vendorfs layout: RAW_ADDR
> -dev: eMMC alt: 8 name: sdcard_rootfs layout: RAW_ADDR
> -dev: eMMC alt: 9 name: sdcard_userfs layout: RAW_ADDR
> -dev: eMMC alt: 10 name: emmc_fsbl1 layout: RAW_ADDR
> -dev: eMMC alt: 11 name: emmc_fsbl2 layout: RAW_ADDR
> -dev: eMMC alt: 12 name: emmc_ssbl layout: RAW_ADDR
> -dev: eMMC alt: 13 name: emmc_bootfs layout: RAW_ADDR
> -dev: eMMC alt: 14 name: emmc_vendorfs layout: RAW_ADDR
> -dev: eMMC alt: 15 name: emmc_rootfs layout: RAW_ADDR
> -dev: eMMC alt: 16 name: emmc_userfs layout: RAW_ADDR
> -dev: MTD alt: 17 name: nor_fsbl1 layout: RAW_ADDR
> -dev: MTD alt: 18 name: nor_fsbl2 layout: RAW_ADDR
> -dev: MTD alt: 19 name: nor_ssbl layout: RAW_ADDR
> -dev: MTD alt: 20 name: nor_env layout: RAW_ADDR
> -dev: MTD alt: 21 name: nand_fsbl layout: RAW_ADDR
> -dev: MTD alt: 22 name: nand_ssbl1 layout: RAW_ADDR
> -dev: MTD alt: 23 name: nand_ssbl2 layout: RAW_ADDR
> -dev: MTD alt: 24 name: nand_UBI layout: RAW_ADDR
> -dev: VIRT alt: 25 name: OTP layout: RAW_ADDR
> -dev: VIRT alt: 26 name: PMIC layout: RAW_ADDR
> -
> -All the supported device are exported for dfu-util tool:
> -
> -$> dfu-util -l
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=26, name="PMIC", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=25, name="OTP", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=24, name="nand_UBI", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=23, name="nand_ssbl2", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=22, name="nand_ssbl1", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=21, name="nand_fsbl", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=20, name="nor_env", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=19, name="nor_ssbl", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=18, name="nor_fsbl2", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=17, name="nor_fsbl1", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=16, name="emmc_userfs", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=15, name="emmc_rootfs", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=14, name="emmc_vendorfs", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=13, name="emmc_bootfs", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=12, name="emmc_ssbl", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=11, name="emmc_fsbl2", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=10, name="emmc_fsbl1", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=9, name="sdcard_userfs", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=8, name="sdcard_rootfs", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=7, name="sdcard_vendorfs", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=6, name="sdcard_bootfs", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=5, name="sdcard_ssbl", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=4, name="sdcard_fsbl2", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=3, name="sdcard_fsbl1", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=2, name="uramdisk.image.gz", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=1, name="devicetree.dtb", serial="002700333338511934383330"
> -Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=0, name="uImage", serial="002700333338511934383330"
> -
> -You can update the boot device:
> -
> -#SDCARD
> -$> dfu-util -d 0483:5720 -a 3 -D tf-a-stm32mp157c-ev1-trusted.stm32
> -$> dfu-util -d 0483:5720 -a 4 -D tf-a-stm32mp157c-ev1-trusted.stm32
> -$> dfu-util -d 0483:5720 -a 5 -D u-boot-stm32mp157c-ev1-trusted.img
> -$> dfu-util -d 0483:5720 -a 6 -D st-image-bootfs-openstlinux-weston-stm32mp1.ext4
> -$> dfu-util -d 0483:5720 -a 7 -D st-image-vendorfs-openstlinux-weston-stm32mp1.ext4
> -$> dfu-util -d 0483:5720 -a 8 -D st-image-weston-openstlinux-weston-stm32mp1.ext4
> -$> dfu-util -d 0483:5720 -a 9 -D st-image-userfs-openstlinux-weston-stm32mp1.ext4
> -
> -#EMMC
> -$> dfu-util -d 0483:5720 -a 10 -D tf-a-stm32mp157c-ev1-trusted.stm32
> -$> dfu-util -d 0483:5720 -a 11 -D tf-a-stm32mp157c-ev1-trusted.stm32
> -$> dfu-util -d 0483:5720 -a 12 -D u-boot-stm32mp157c-ev1-trusted.img
> -$> dfu-util -d 0483:5720 -a 13 -D st-image-bootfs-openstlinux-weston-stm32mp1.ext4
> -$> dfu-util -d 0483:5720 -a 14 -D st-image-vendorfs-openstlinux-weston-stm32mp1.ext4
> -$> dfu-util -d 0483:5720 -a 15 -D st-image-weston-openstlinux-weston-stm32mp1.ext4
> -$> dfu-util -d 0483:5720 -a 16 -D st-image-userfs-openstlinux-weston-stm32mp1.ext4
> -
> -#NOR
> -$> dfu-util -d 0483:5720 -a 17 -D tf-a-stm32mp157c-ev1-trusted.stm32
> -$> dfu-util -d 0483:5720 -a 18 -D tf-a-stm32mp157c-ev1-trusted.stm32
> -$> dfu-util -d 0483:5720 -a 19 -D u-boot-stm32mp157c-ev1-trusted.img
> -
> -#NAND (UBI partition used for NAND only boot or NOR + NAND boot)
> -$> dfu-util -d 0483:5720 -a 21 -D tf-a-stm32mp157c-ev1-trusted.stm32
> -$> dfu-util -d 0483:5720 -a 22 -D u-boot-stm32mp157c-ev1-trusted.img
> -$> dfu-util -d 0483:5720 -a 23 -D u-boot-stm32mp157c-ev1-trusted.img
> -$> dfu-util -d 0483:5720 -a 24 -D st-image-weston-openstlinux-weston-stm32mp1_nand_4_256_multivolume.ubi
> -
> -And you can also dump the OTP and the PMIC NVM with:
> -
> -$> dfu-util -d 0483:5720 -a 25 -U otp.bin
> -$> dfu-util -d 0483:5720 -a 26 -U pmic.bin
> +see doc/board/st/stm32mp1.rst
> diff --git a/doc/board/index.rst b/doc/board/index.rst
> index 00e72f57cd..21fddd2f92 100644
> --- a/doc/board/index.rst
> +++ b/doc/board/index.rst
> @@ -15,4 +15,5 @@ Board-specific doc
>      intel/index
>      renesas/index
>      sifive/index
> +   st/index
>      xilinx/index
> diff --git a/doc/board/st/index.rst b/doc/board/st/index.rst
> new file mode 100644
> index 0000000000..91f1d51b42
> --- /dev/null
> +++ b/doc/board/st/index.rst
> @@ -0,0 +1,9 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +STMicroelectronics
> +==================
> +
> +.. toctree::
> +   :maxdepth: 2
> +
> +   stm32mp1
> diff --git a/doc/board/st/stm32mp1.rst b/doc/board/st/stm32mp1.rst
> new file mode 100644
> index 0000000000..131f4902a3
> --- /dev/null
> +++ b/doc/board/st/stm32mp1.rst
> @@ -0,0 +1,598 @@
> +.. SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause
> +.. sectionauthor:: Patrick Delaunay <patrick.delaunay at st.com>
> +
> +STM32MP15x boards
> +=================
> +
> +This is a quick instruction for setup STM32MP15x boards.
> +
> +Supported devices
> +-----------------
> +
> +U-Boot supports STMP32MP15x SoCs:
> + - STM32MP157
> + - STM32MP153
> + - STM32MP151
> +
> +The STM32MP15x is a Cortex-A MPU aimed at various applications.
> +
> +It features:
> + - Dual core Cortex-A7 application core (Single on STM32MP151)
> + - 2D/3D image composition with GPU (only on STM32MP157)
> + - Standard memories interface support
> + - Standard connectivity, widely inherited from the STM32 MCU family
> + - Comprehensive security support
> +
> +Everything is supported in Linux but U-Boot is limited to:
> + 1. UART
> + 2. SD card/MMC controller (SDMMC)
> + 3. NAND controller (FMC)
> + 4. NOR controller (QSPI)
> + 5. USB controller (OTG DWC2)
> + 6. Ethernet controller
> +
> +And the necessary drivers
> + 1. I2C
> + 2. STPMIC1 (PMIC and regulator)
> + 3. Clock, Reset, Sysreset
> + 4. Fuse
> +
> +Currently the following boards are supported:
> + + stm32mp157a-avenger96.dts
> + + stm32mp157a-dk1.dts
> + + stm32mp157c-dk2.dts
> + + stm32mp157c-ed1.dts
> + + stm32mp157c-ev1.dts
> +
> +Boot Sequences
> +--------------
> +
> +3 boot configurations are supported with:
> +
> ++----------+------------------------+-------------------------+--------------+
> +| **ROM**  | **FSBL**               | **SSBL**                | **OS**       |
> ++ **code** +------------------------+-------------------------+--------------+
> +|          | First Stage Bootloader | Second Stage Bootloader | Linux Kernel |
> ++          +------------------------+-------------------------+--------------+
> +|          | embedded RAM           | DDR                                    |
> ++----------+------------------------+-------------------------+--------------+
> +
> +The **Trusted** boot chain
> +``````````````````````````
> +
> +defconfig_file : stm32mp15_trusted_defconfig
> +
> +    +-------------+-------------------------+------------+-------+
> +    |  ROM code   | FSBL                    | SSBL       | OS    |
> +    +             +-------------------------+------------+-------+
> +    |             |Trusted Firmware-A (TF-A)| U-Boot     | Linux |
> +    +-------------+-------------------------+------------+-------+
> +    | TrustZone   |TF-A secure monitor                           |
> +    +-------------+-------------------------+------------+-------+
> +
> +TF-A performs a full initialization of Secure peripherals and installs a
> +secure monitor (BL32=SPMin).
> +
> +U-Boot is running in normal world and uses TF-A monitor to access
> +to secure resources.
> +
> +The **Trusted** boot chain with **OP-TEE**
> +``````````````````````````````````````````
> +
> +defconfig_file : stm32mp15_optee_defconfig
> +
> +    +-------------+-------------------------+------------+-------+
> +    |  ROM code   | FSBL                    | SSBL       | OS    |
> +    +             +-------------------------+------------+-------+
> +    |             |Trusted Firmware-A (TF-A)| U-Boot     | Linux |
> +    +-------------+-------------------------+------------+-------+
> +    | TrustZone   |OP-TEE                                        |
> +    +-------------+-------------------------+------------+-------+
> +
> +TF-A performs a full initialization of Secure peripherals and installs OP-TEE
> +from specific partitions (teeh, teed, teex).
> +
> +U-Boot is running in normal world and uses OP-TEE monitor to access
> +to secure resources.
> +
> +The **Basic** boot chain
> +````````````````````````
> +
> +defconfig_file : stm32mp15_basic_defconfig
> +
> +    +-------------+------------+------------+-------+
> +    |  ROM code   | FSBL       | SSBL       | OS    |
> +    +             +------------+------------+-------+
> +    |             |U-Boot SPL  | U-Boot     | Linux |
> +    +-------------+------------+------------+-------+
> +    | TrustZone   |            | PSCI from U-Boot   |
> +    +-------------+------------+------------+-------+
> +
> +SPL has limited security initialization
> +
> +U-Boot is running in secure mode and provide a secure monitor to the kernel
> +with only PSCI support (Power State Coordination Interface defined by ARM).
> +
> +All the STM32MP15x boards supported by U-Boot use the same generic board
> +stm32mp1 which support all the bootable devices.
> +
> +Each board is configured only with the associated device tree.
> +
> +Device Tree Selection
> +---------------------
> +
> +You need to select the appropriate device tree for your board,
> +the supported device trees for STM32MP15x are:
> +
> ++ ev1: eval board with pmic stpmic1 (ev1 = mother board + daughter ed1)
> +   + stm32mp157c-ev1
> +
> ++ ed1: daughter board with pmic stpmic1
> +   + stm32mp157c-ed1
> +
> ++ dk1: Discovery board
> +   + stm32mp157a-dk1
> +
> ++ dk2: Discovery board = dk1 with a BT/WiFI combo and a DSI panel
> +   + stm32mp157c-dk2
> +
> ++ avenger96: Avenger96 board from Arrow Electronics
> +   + stm32mp157a-avenger96
> +
> +Build Procedure
> +---------------
> +
> +1. Install the required tools for U-Boot
> +
> +   * install package needed in U-Boot makefile
> +     (libssl-dev, swig, libpython-dev...)
> +
> +   * install ARMv7 toolchain for 32bit Cortex-A (from Linaro,
> +     from SDK for STM32MP15x, or any crosstoolchains from your distribution)
> +     (you can use any gcc cross compiler compatible with U-Boot)
> +
> +2. Set the cross compiler::
> +
> +    # export CROSS_COMPILE=/path/to/toolchain/arm-linux-gnueabi-
> +
> +3. Select the output directory (optional)::
> +
> +   # export KBUILD_OUTPUT=/path/to/output
> +
> +   for example: use one output directory for each configuration::
> +
> +   # export KBUILD_OUTPUT=stm32mp15_trusted
> +   # export KBUILD_OUTPUT=stm32mp15_optee
> +   # export KBUILD_OUTPUT=stm32mp15_basic
> +
> +   you can build outside of code directory::
> +
> +   # export KBUILD_OUTPUT=../build/stm32mp15_trusted
> +
> +4. Configure U-Boot::
> +
> +   # make <defconfig_file>
> +
> +   with <defconfig_file>:
> +
> +   - For **trusted** boot mode : **stm32mp15_trusted_defconfig**
> +   - For **trusted** with OP-TEE boot mode : **stm32mp15_optee_defconfig**
> +   - For basic boot mode: stm32mp15_basic_defconfig
> +
> +5. Configure the device-tree and build the U-Boot image::
> +
> +   # make DEVICE_TREE=<name> all
> +
> +   Examples:
> +
> +  a) trusted boot on ev1::
> +
> +     # export KBUILD_OUTPUT=stm32mp15_trusted
> +     # make stm32mp15_trusted_defconfig
> +     # make DEVICE_TREE=stm32mp157c-ev1 all
> +
> +  b) trusted with OP-TEE boot on dk2::
> +
> +      # export KBUILD_OUTPUT=stm32mp15_optee
> +      # make stm32mp15_optee_defconfig
> +      # make DEVICE_TREE=stm32mp157c-dk2 all
> +
> +  c) basic boot on ev1::
> +
> +      # export KBUILD_OUTPUT=stm32mp15_basic
> +      # make stm32mp15_basic_defconfig
> +      # make DEVICE_TREE=stm32mp157c-ev1 all
> +
> +  d) basic boot on ed1::
> +
> +      # export KBUILD_OUTPUT=stm32mp15_basic
> +      # make stm32mp15_basic_defconfig
> +      # make DEVICE_TREE=stm32mp157c-ed1 all
> +
> +  e) basic boot on dk1::
> +
> +     # export KBUILD_OUTPUT=stm32mp15_basic
> +     # make stm32mp15_basic_defconfig
> +     # make DEVICE_TREE=stm32mp157a-dk1 all
> +
> +  f) basic boot on avenger96::
> +
> +     # export KBUILD_OUTPUT=stm32mp15_basic
> +     # make stm32mp15_basic_defconfig
> +     # make DEVICE_TREE=stm32mp157a-avenger96 all
> +
> +6. Output files
> +
> +   BootRom and TF-A expect binaries with STM32 image header
> +   SPL expects file with U-Boot uImage header
> +
> +   So in the output directory (selected by KBUILD_OUTPUT),
> +   you can found the needed files:
> +
> +  - For **Trusted** boot (with or without OP-TEE)
> +     - FSBL = **tf-a.stm32** (provided by TF-A compilation)
> +     - SSBL = **u-boot.stm32**
> +
> +  - For Basic boot
> +     - FSBL = spl/u-boot-spl.stm32
> +     - SSBL = u-boot.img
> +
> +Switch Setting for Boot Mode
> +----------------------------
> +
> +You can select the boot mode, on the board with one switch, to select
> +the boot pin values = BOOT0, BOOT1, BOOT2
> +
> +  +-------------+---------+---------+---------+
> +  |*Boot Mode*  | *BOOT2* | *BOOT1* | *BOOT0* |
> +  +=============+=========+=========+=========+
> +  | Recovery    |  0      |  0      |  0      |
> +  +-------------+---------+---------+---------+
> +  | NOR         |  0      |  0      |  1      |
> +  +-------------+---------+---------+---------+
> +  | eMMC        |  0      |  1      |  0      |
> +  +-------------+---------+---------+---------+
> +  | NAND        |  0      |  1      |  1      |
> +  +-------------+---------+---------+---------+
> +  | Reserved    |  1      |  0      |  0      |
> +  +-------------+---------+---------+---------+
> +  | SD-Card     |  1      |  0      |  1      |
> +  +-------------+---------+---------+---------+
> +  | Recovery    |  1      |  1      |  0      |
> +  +-------------+---------+---------+---------+
> +  | SPI-NAND    |  1      |  1      |  1      |
> +  +-------------+---------+---------+---------+
> +
> +- on the **daugther board ed1 = MB1263** with the switch SW1
> +- on **Avenger96** with switch S3 (NOR and SPI-NAND are not applicable)
> +- on board **DK1/DK2** with the switch SW1 = BOOT0, BOOT2
> +  with only 2 pins available (BOOT1 is forced to 0 and NOR not supported),
> +  the possible value becomes:
> +
> +    +-------------+---------+---------+
> +    |*Boot Mode*  | *BOOT2* | *BOOT0* |
> +    +=============+=========+=========+
> +    | Recovery    |  0      |  0      |
> +    +-------------+---------+---------+
> +    | NOR     (NA)|  0      |  1      |
> +    +-------------+---------+---------+
> +    | Reserved    |  1      |  0      |
> +    +-------------+---------+---------+
> +    | SD-Card     |  1      |  1      |
> +    +-------------+---------+---------+
> +
> +Recovery is a boot from serial link (UART/USB) and it is used with
> +STM32CubeProgrammer tool to load executable in RAM and to update the flash
> +devices available on the board (NOR/NAND/eMMC/SD card).
> +
> +The communication between HOST and board is based on
> +  - for UARTs : the uart protocol used with all MCU STM32
> +  - for USB : based on USB DFU 1.1 (without the ST extensions used on MCU STM32)
> +
> +Prepare an SD card
> +------------------
> +
> +The minimal requirements for STMP32MP15x boot up to U-Boot are:
> +
> +- GPT partitioning (with gdisk or with sgdisk)
> +- 2 fsbl partitions, named fsbl1 and fsbl2, size at least 256KiB
> +- one ssbl partition for U-Boot
> +
> +Then the minimal GPT partition is:
> +
> +  +-------+--------+---------+-------------+
> +  | *Num* | *Name* | *Size*  | *Content*   |
> +  +=======+========+=========+=============+
> +  | 1     | fsbl1  | 256 KiB | TF-A or SPL |
> +  +-------+--------+---------+-------------+
> +  | 2     | fsbl2  | 256 KiB | TF-A or SPL |
> +  +-------+--------+---------+-------------+
> +  | 3     | ssbl   | enought | U-Boot      |
> +  +-------+--------+---------+-------------+
> +  | 4     | <any>  | <any>   | Rootfs      |
> +  +-------+--------+---------+-------------+
> +
> +Add a 4th partition (Rootfs) marked bootable with a file extlinux.conf
> +following the Generic Distribution feature (doc/README.distro for use).
> +
> +According the used card reader select the correct block device
> +(for example /dev/sdx or /dev/mmcblk0).
> +
> +In the next example, it is /dev/mmcblk0
> +
> +For example: with gpt table with 128 entries
> +
> +a) remove previous formatting::
> +
> +     # sgdisk -o /dev/<SD card dev>
> +
> +b) create minimal image::
> +
> +    # sgdisk --resize-table=128 -a 1 \
> +    -n 1:34:545		-c 1:fsbl1 \
> +    -n 2:546:1057		-c 2:fsbl2 \
> +    -n 3:1058:5153		-c 3:ssbl \
> +    -n 4:5154:		    -c 4:rootfs \
> +    -p /dev/<SD card dev>
> +
> +  With other partition for kernel one partition rootfs for kernel.
> +
> +c) copy the FSBL (2 times) and SSBL file on the correct partition.
> +   in this example in partition 1 to 3
> +
> +   for basic boot mode : <SD card dev> = /dev/mmcblk0::
> +
> +    # dd if=u-boot-spl.stm32 of=/dev/mmcblk0p1
> +    # dd if=u-boot-spl.stm32 of=/dev/mmcblk0p2
> +    # dd if=u-boot.img of=/dev/mmcblk0p3
> +
> +   for trusted boot mode: ::
> +
> +    # dd if=tf-a.stm32 of=/dev/mmcblk0p1
> +    # dd if=tf-a.stm32 of=/dev/mmcblk0p2
> +    # dd if=u-boot.stm32 of=/dev/mmcblk0p3
> +
> +To boot from SD card, select BootPinMode = 1 0 1 and reset.
> +
> +Prepare eMMC
> +------------
> +
> +You can use U-Boot to copy binary in eMMC.
> +
> +In the next example, you need to boot from SD card and the images
> +(u-boot-spl.stm32, u-boot.img) are presents on SD card (mmc 0)
> +in ext4 partition 4 (bootfs).
> +
> +To boot from SD card, select BootPinMode = 1 0 1 and reset.
> +
> +Then you update the eMMC with the next U-Boot command :
> +
> +a) prepare GPT on eMMC,
> +   example with 2 partitions, bootfs and roots::
> +
> +    # setenv emmc_part "name=ssbl,size=2MiB;name=bootfs,type=linux,bootable,size=64MiB;name=rootfs,type=linux,size=512"
> +    # gpt write mmc 1 ${emmc_part}
> +
> +b) copy SPL on eMMC on firts boot partition
> +   (SPL max size is 256kB, with LBA 512, 0x200)::
> +
> +    # ext4load mmc 0:4 0xC0000000 u-boot-spl.stm32
> +    # mmc dev 1
> +    # mmc partconf 1 1 1 1
> +    # mmc write ${fileaddr} 0 200
> +    # mmc partconf 1 1 1 0
> +
> +c) copy U-Boot in first GPT partition of eMMC::
> +
> +    # ext4load mmc 0:4 0xC0000000 u-boo	t.img
> +    # mmc dev 1
> +    # part start mmc 1 1 partstart
> +    # mmc write ${fileaddr} ${partstart} ${filesize}
> +
> +To boot from eMMC, select BootPinMode = 0 1 0 and reset.
> +
> +MAC Address
> +-----------
> +
> +Please read doc/README.enetaddr for the implementation guidelines for mac id
> +usage. Basically, environment has precedence over board specific storage.
> +
> +For STMicroelectonics board, it is retrieved in STM32MP15x OTP :
> + - OTP_57[31:0] = MAC_ADDR[31:0]
> + - OTP_58[15:0] = MAC_ADDR[47:32]
> +
> +To program a MAC address on virgin OTP words above, you can use the fuse command
> +on bank 0 to access to internal OTP:
> +
> +Prerequisite: check if a MAC address isn't yet programmed in OTP
> +
> +1) check OTP: their value must be equal to 0
> +
> +   STM32MP> fuse sense 0 57 2
> +   Sensing bank 0:
> +   Word 0x00000039: 00000000 00000000
> +
> +2) check environment variable
> +
> +   STM32MP> env print ethaddr
> +   ## Error: "ethaddr" not defined
> +
> +Example to set mac address "12:34:56:78:9a:bc"
> +
> +1) Write OTP::
> +
> +    STM32MP> fuse prog -y 0 57 0x78563412 0x0000bc9a
> +
> +2) Read OTP::
> +
> +    STM32MP> fuse sense 0 57 2
> +    Sensing bank 0:
> +    Word 0x00000039: 78563412 0000bc9a
> +
> +3) next REBOOT, in the trace::
> +
> +    ### Setting environment from OTP MAC address = "12:34:56:78:9a:bc"
> +
> +4) check env update::
> +
> +    STM32MP> env print ethaddr
> +    ethaddr=12:34:56:78:9a:bc
> +
> +.. warning:: This command can't be executed twice on the same board as
> +             OTP are protected. It is already done for the board
> +             provided by STMicroelectronics.
> +
> +Coprocessor firmware
> +--------------------
> +
> +U-Boot can boot the coprocessor before the kernel (coprocessor early boot).
> +
> +a) Manuallly by using rproc commands (update the bootcmd)
> +
> +   Configurations::
> +
> +	# env set name_copro "rproc-m4-fw.elf"
> +	# env set dev_copro 0
> +	# env set loadaddr_copro 0xC1000000
> +
> +   Load binary from bootfs partition (number 4) on SD card (mmc 0)::
> +
> +	# ext4load mmc 0:4 ${loadaddr_copro} ${name_copro}
> +
> +   => ${filesize} variable is updated with the size of the loaded file.
> +
> +   Start M4 firmware with remote proc command::
> +
> +	# rproc init
> +	# rproc load ${dev_copro} ${loadaddr_copro} ${filesize}
> +	# rproc start ${dev_copro}"00270033
> +
> +b) Automatically by using FIT feature and generic DISTRO bootcmd
> +
> +   see examples in the board stm32mp1 directory: fit_copro_kernel_dtb.its
> +
> +   Generate FIT including kernel + device tree + M4 firmware with cfg with M4 boot::
> +
> +   $> mkimage -f fit_copro_kernel_dtb.its fit_copro_kernel_dtb.itb
> +
> +   Then using DISTRO configuration file: see extlinux.conf to select the correct
> +   configuration:
> +
> +   - stm32mp157c-ev1-m4
> +   - stm32mp157c-dk2-m4
> +
> +DFU support
> +-----------
> +
> +The DFU is supported on ST board.
> +
> +The env variable dfu_alt_info is automatically build, and all
> +the memory present on the ST boards are exported.
> +
> +The dfu mode is started by the command::
> +
> +  STM32MP> dfu 0
> +
> +On EV1 board, booting from SD card, without OP-TEE::
> +
> +  STM32MP> dfu 0 list
> +  DFU alt settings list:
> +  dev: RAM alt: 0 name: uImage layout: RAM_ADDR
> +  dev: RAM alt: 1 name: devicetree.dtb layout: RAM_ADDR
> +  dev: RAM alt: 2 name: uramdisk.image.gz layout: RAM_ADDR
> +  dev: eMMC alt: 3 name: sdcard_fsbl1 layout: RAW_ADDR
> +  dev: eMMC alt: 4 name: sdcard_fsbl2 layout: RAW_ADDR
> +  dev: eMMC alt: 5 name: sdcard_ssbl layout: RAW_ADDR
> +  dev: eMMC alt: 6 name: sdcard_bootfs layout: RAW_ADDR
> +  dev: eMMC alt: 7 name: sdcard_vendorfs layout: RAW_ADDR
> +  dev: eMMC alt: 8 name: sdcard_rootfs layout: RAW_ADDR
> +  dev: eMMC alt: 9 name: sdcard_userfs layout: RAW_ADDR
> +  dev: eMMC alt: 10 name: emmc_fsbl1 layout: RAW_ADDR
> +  dev: eMMC alt: 11 name: emmc_fsbl2 layout: RAW_ADDR
> +  dev: eMMC alt: 12 name: emmc_ssbl layout: RAW_ADDR
> +  dev: eMMC alt: 13 name: emmc_bootfs layout: RAW_ADDR
> +  dev: eMMC alt: 14 name: emmc_vendorfs layout: RAW_ADDR
> +  dev: eMMC alt: 15 name: emmc_rootfs layout: RAW_ADDR
> +  dev: eMMC alt: 16 name: emmc_userfs layout: RAW_ADDR
> +  dev: MTD alt: 17 name: nor_fsbl1 layout: RAW_ADDR
> +  dev: MTD alt: 18 name: nor_fsbl2 layout: RAW_ADDR
> +  dev: MTD alt: 19 name: nor_ssbl layout: RAW_ADDR
> +  dev: MTD alt: 20 name: nor_env layout: RAW_ADDR
> +  dev: MTD alt: 21 name: nand_fsbl layout: RAW_ADDR
> +  dev: MTD alt: 22 name: nand_ssbl1 layout: RAW_ADDR
> +  dev: MTD alt: 23 name: nand_ssbl2 layout: RAW_ADDR
> +  dev: MTD alt: 24 name: nand_UBI layout: RAW_ADDR
> +  dev: VIRT alt: 25 name: OTP layout: RAW_ADDR
> +  dev: VIRT alt: 26 name: PMIC layout: RAW_ADDR
> +
> +All the supported device are exported for dfu-util tool::
> +
> +  $> dfu-util -l
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=26, name="PMIC", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=25, name="OTP", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=24, name="nand_UBI", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=23, name="nand_ssbl2", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=22, name="nand_ssbl1", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=21, name="nand_fsbl", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=20, name="nor_env", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=19, name="nor_ssbl", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=18, name="nor_fsbl2", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=17, name="nor_fsbl1", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=16, name="emmc_userfs", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=15, name="emmc_rootfs", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=14, name="emmc_vendorfs", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=13, name="emmc_bootfs", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=12, name="emmc_ssbl", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=11, name="emmc_fsbl2", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=10, name="emmc_fsbl1", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=9, name="sdcard_userfs", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=8, name="sdcard_rootfs", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=7, name="sdcard_vendorfs", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=6, name="sdcard_bootfs", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=5, name="sdcard_ssbl", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=4, name="sdcard_fsbl2", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=3, name="sdcard_fsbl1", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=2, name="uramdisk.image.gz", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=1, name="devicetree.dtb", serial="002700333338511934383330"
> +  Found DFU: [0483:5720] ver=9999, devnum=99, cfg=1, intf=0, alt=0, name="uImage", serial="002700333338511934383330"
> +
> +You can update the boot device:
> +
> +- SD card (mmc0) ::
> +
> +  $> dfu-util -d 0483:5720 -a 3 -D tf-a-stm32mp157c-ev1-trusted.stm32
> +  $> dfu-util -d 0483:5720 -a 4 -D tf-a-stm32mp157c-ev1-trusted.stm32
> +  $> dfu-util -d 0483:5720 -a 5 -D u-boot-stm32mp157c-ev1-trusted.img
> +  $> dfu-util -d 0483:5720 -a 6 -D st-image-bootfs-openstlinux-weston-stm32mp1.ext4
> +  $> dfu-util -d 0483:5720 -a 7 -D st-image-vendorfs-openstlinux-weston-stm32mp1.ext4
> +  $> dfu-util -d 0483:5720 -a 8 -D st-image-weston-openstlinux-weston-stm32mp1.ext4
> +  $> dfu-util -d 0483:5720 -a 9 -D st-image-userfs-openstlinux-weston-stm32mp1.ext4
> +
> +- EMMC (mmc1)::
> +
> +  $> dfu-util -d 0483:5720 -a 10 -D tf-a-stm32mp157c-ev1-trusted.stm32
> +  $> dfu-util -d 0483:5720 -a 11 -D tf-a-stm32mp157c-ev1-trusted.stm32
> +  $> dfu-util -d 0483:5720 -a 12 -D u-boot-stm32mp157c-ev1-trusted.img
> +  $> dfu-util -d 0483:5720 -a 13 -D st-image-bootfs-openstlinux-weston-stm32mp1.ext4
> +  $> dfu-util -d 0483:5720 -a 14 -D st-image-vendorfs-openstlinux-weston-stm32mp1.ext4
> +  $> dfu-util -d 0483:5720 -a 15 -D st-image-weston-openstlinux-weston-stm32mp1.ext4
> +  $> dfu-util -d 0483:5720 -a 16 -D st-image-userfs-openstlinux-weston-stm32mp1.ext4
> +
> +- NOR::
> +
> +  $> dfu-util -d 0483:5720 -a 17 -D tf-a-stm32mp157c-ev1-trusted.stm32
> +  $> dfu-util -d 0483:5720 -a 18 -D tf-a-stm32mp157c-ev1-trusted.stm32
> +  $> dfu-util -d 0483:5720 -a 19 -D u-boot-stm32mp157c-ev1-trusted.img
> +
> +- NAND (UBI partition used for NAND only boot or NOR + NAND boot)::
> +
> +  $> dfu-util -d 0483:5720 -a 21 -D tf-a-stm32mp157c-ev1-trusted.stm32
> +  $> dfu-util -d 0483:5720 -a 22 -D u-boot-stm32mp157c-ev1-trusted.img
> +  $> dfu-util -d 0483:5720 -a 23 -D u-boot-stm32mp157c-ev1-trusted.img
> +  $> dfu-util -d 0483:5720 -a 24 -D st-image-weston-openstlinux-weston-stm32mp1_nand_4_256_multivolume.ubi
> +
> +- you can also dump the OTP and the PMIC NVM with::
> +
> +  $> dfu-util -d 0483:5720 -a 25 -U otp.bin
> +  $> dfu-util -d 0483:5720 -a 26 -U pmic.bin
> +

This blank line could be removed.

'make html' shows that the reStructured text files are syntactically valid.

Tested-by: Heinrich Schuchardt <xypron.glpk at gmx.de>

>