On 8/29/23 00:01, Marcel Ziswiler wrote:

From: Marcel Ziswiler marcel.ziswiler@toradex.com

• Update SPDX-License-Identifier from obsolete GPL-2.0+ to GPL-2.0-or-later.
• Add links to product websites of SoM and carrier board where missing.
• Add information about update U-Boot wrapper where missing.
• Add sectionauthor where missing.
• Update information about imx-seco from version 3.7.4 to 3.8.1.
• Various minor grammatic and spelling fixes.
• Improve whitespace by adding or removing new lines.
• Change from code-block for output to just Output::.

Signed-off-by: Marcel Ziswiler marcel.ziswiler@toradex.com

doc/board/toradex/apalis-imx8.rst | 22 +++++++++++++---- doc/board/toradex/colibri-imx8x.rst | 31 ++++++++++++++++------- doc/board/toradex/colibri_imx7.rst | 38 +++++++++++++++-------------- doc/board/toradex/verdin-am62.rst | 8 +++--- doc/board/toradex/verdin-imx8mm.rst | 9 +++---- doc/board/toradex/verdin-imx8mp.rst | 9 +++---- 6 files changed, 71 insertions(+), 46 deletions(-)

diff --git a/doc/board/toradex/apalis-imx8.rst b/doc/board/toradex/apalis-imx8.rst index 849b1172bd4..ffc4c7d222a 100644 --- a/doc/board/toradex/apalis-imx8.rst +++ b/doc/board/toradex/apalis-imx8.rst @@ -1,7 +1,11 @@ -.. SPDX-License-Identifier: GPL-2.0+ +.. SPDX-License-Identifier: GPL-2.0-or-later +.. sectionauthor:: Marcel Ziswiler marcel.ziswiler@toradex.com

-Apalis iMX8QM V1.0B Module

+Apalis iMX8 Module +==================

+- SoM: https://www.toradex.com/computer-on-modules/apalis-arm-family/nxp-imx-8 +- Carrier board: https://www.toradex.com/products/carrier-board/apalis-evaluation-board

Quick Start

@@ -49,6 +53,7 @@ Copy the following firmware to the U-Boot folder:

Build U-Boot

• .. code-block:: bash

  $ make apalis-imx8_defconfig
  

@@ -61,8 +66,8 @@ Get the latest version of the universal update utility (uuu) aka ``mfgtools 3.0`

https://community.nxp.com/external-link.jspa?url=https%3A%2F%2Fgithub.com%2F...

-Put the module into USB recovery aka serial downloader mode, connect USB device -to your host and execute uuu: +Put the module into USB recovery aka serial downloader mode, connect the USB +device to your host and execute ``uuu``:

.. code-block:: bash

@@ -80,3 +85,10 @@ partition and boot: setexpr blkcnt ${filesize} + 0x1ff && setexpr blkcnt ${blkcnt} / 0x200 mmc dev 0 1 mmc write ${loadaddr} 0x0 ${blkcnt}

+As a convenience, instead of the last three commands, one may also use the +update U-Boot wrapper:

+.. code-block:: bash

• ...

  run update_uboot

diff --git a/doc/board/toradex/colibri-imx8x.rst b/doc/board/toradex/colibri-imx8x.rst index 545568c844a..9e61d98c6b1 100644 --- a/doc/board/toradex/colibri-imx8x.rst +++ b/doc/board/toradex/colibri-imx8x.rst @@ -1,7 +1,11 @@ -.. SPDX-License-Identifier: GPL-2.0+ +.. SPDX-License-Identifier: GPL-2.0-or-later +.. sectionauthor:: Marcel Ziswiler marcel.ziswiler@toradex.com

-Colibri iMX8QXP V1.0D Module

+Colibri iMX8X Module +====================

+- SoM: https://www.toradex.com/computer-on-modules/colibri-arm-family/nxp-imx-8x +- Carrier board: https://www.toradex.com/products/carrier-board/colibri-evaluation-board

Quick Start

@@ -23,18 +27,19 @@ Get and Build the ARM Trusted Firmware

Get scfw_tcm.bin and ahab-container.img

• .. code-block:: bash

  $ wget https://github.com/toradex/i.MX-System-Controller-Firmware/raw/master/src/scfw_export_mx8qx_b0/build_mx8qx_b0/mx8qx-colibri-scfw-tcm.bin
  

• $ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/imx-seco-3.7.4.bin
• $ sh imx-seco-3.7.4.bin --auto-accept

• $ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/imx-seco-3.8.1.bin

• $ sh imx-seco-3.8.1.bin --auto-accept

  Copy the following firmware to the U-Boot folder:

  .. code-block:: bash

  $ cp imx-atf/build/imx8qx/release/bl31.bin .

• $ cp imx-seco-3.7.4/firmware/seco/mx8qxc0-ahab-container.img mx8qx-ahab-container.img

• $ cp imx-seco-3.8.1/firmware/seco/mx8qxc0-ahab-container.img mx8qx-ahab-container.img

  Build U-Boot

@@ -51,8 +56,8 @@ Get the latest version of the universal update utility (uuu) aka ``mfgtools 3.0`

https://community.nxp.com/external-link.jspa?url=https%3A%2F%2Fgithub.com%2F...

-Put the module into USB recovery aka serial downloader mode, connect USB device -to your host and execute ``uuu``: +Put the module into USB recovery aka serial downloader mode, connect the USB +device to your host and execute ``uuu``:

.. code-block:: bash

@@ -61,7 +66,8 @@ to your host and execute ``uuu``: Flash the U-Boot Binary into the eMMC

---

-Burn the ``u-boot-dtb.imx`` binary to the primary eMMC hardware boot area partition: +Burn the ``u-boot-dtb.imx`` binary to the primary eMMC hardware boot area +partition and boot:

.. code-block:: bash

@@ -69,3 +75,10 @@ Burn the ``u-boot-dtb.imx`` binary to the primary eMMC hardware boot area partit setexpr blkcnt ${filesize} + 0x1ff && setexpr blkcnt ${blkcnt} / 0x200 mmc dev 0 1 mmc write ${loadaddr} 0x0 ${blkcnt}

+As a convenience, instead of the last three commands, one may also use the +update U-Boot wrapper:

+.. code-block:: bash

• ...

  run update_uboot

diff --git a/doc/board/toradex/colibri_imx7.rst b/doc/board/toradex/colibri_imx7.rst index a30e721379e..6532878932c 100644 --- a/doc/board/toradex/colibri_imx7.rst +++ b/doc/board/toradex/colibri_imx7.rst @@ -1,7 +1,11 @@ -.. SPDX-License-Identifier: GPL-2.0+ +.. SPDX-License-Identifier: GPL-2.0-or-later +.. sectionauthor:: Igor Opaniuk igor.opaniuk@toradex.com

-Colibri iMX7

+Colibri iMX7 Modules +====================

+- SoM: https://www.toradex.com/computer-on-modules/colibri-arm-family/nxp-freescale... +- Carrier board: https://www.toradex.com/products/carrier-board/colibri-evaluation-board

Quick Start

@@ -21,11 +25,11 @@ Build U-Boot $ make colibri_imx7_emmc_defconfig # For NAND: colibri_imx7_defconfig $ make

-After build succeeds, you will obtain final ``u-boot-dtb.imx`` IMX specific -image, ready for flashing (but check next section for additional +After the build succeeds, you will obtain the final ``u-boot-dtb.imx`` IMX +specific image, ready for flashing (but check next section for additional adjustments).

-Final IMX program image includes (section ``6.6.7`` from `IMX7DRM +The final IMX program image includes (section ``6.6.7`` from `IMX7DRM https://www.nxp.com/webapp/Download?colCode=IMX7DRM`_):

• **Image vector table** (IVT) for BootROM

@@ -34,21 +38,20 @@ Final IMX program image includes (section ``6.6.7`` from `IMX7DRM

• **Device configuration data**
• **User image**: U-Boot image (``u-boot-dtb.bin``)

• IMX image adjustments prior to flashing

  1. U-Boot for both Colibri iMX7 NAND and eMMC versions

  is built with HABv4 support (`AN4581.pdf https://www.nxp.com/docs/en/application-note/AN4581.pdf`_)

-enabled by default, which requires to generate a proper +enabled by default, which requires generating a proper Command Sequence File (CSF) by srktool from NXP (not included in the U-Boot tree, check additional details in introduction_habv4.txt) and concatenate it to the final ``u-boot-dtb.imx``.

-2. In case if you don't want to generate a proper ``CSF`` (for any reason), -you still need to pad the IMX image so i has the same size as specified in -in **Boot Data** section of IMX image. +2. In case you don't want to generate a proper ``CSF`` (for any reason), +you still need to pad the IMX image so it has the same size as specified in +the **Boot Data** section of the IMX image. To obtain this value, run:

.. code-block:: bash @@ -78,11 +81,11 @@ and then pad the image: $ objcopy -I binary -O binary --pad-to 0xa7c60 --gap-fill=0x00 \ u-boot-dtb.imx u-boot-dtb.imx.zero-padded

-3. Also, according to requirement from ``6.6.7.1``, the final image -should have ``0x400`` offset for initial IVT table. +3. Also, according to the requirement from ``6.6.7.1``, the final image +should have ``0x400`` offset for the initial IVT table.

-For eMMC setup we handle this by flashing it to ``0x400``, howewer -for NAND setup we adjust the image prior to flashing, adding padding in the +For eMMC setup we handle this by flashing it to ``0x400``, however +for NAND setup we adjust the image prior to flashing, adding padding at the beginning of the image.

.. code-block:: bash @@ -97,7 +100,6 @@ boot area partition:

.. code-block:: bash

• => load mmc 1:1 $loadaddr u-boot-dtb.imx.zero-padded
  => setexpr blkcnt ${filesize} + 0x1ff && setexpr blkcnt ${blkcnt} / 0x200
  => mmc dev 0 1
  

@@ -117,8 +119,8 @@ Flash U-Boot IMX image to NAND Using update_uboot script

---

-You can also usb U-Boot env update_uboot script, -which wraps all eMMC/NAND specific command invocation: +You can also use U-Boot env update_uboot script, +which wraps all eMMC/NAND specific command invocations:

.. code-block:: bash

diff --git a/doc/board/toradex/verdin-am62.rst b/doc/board/toradex/verdin-am62.rst index 36db149cda0..ecc7e0777cb 100644 --- a/doc/board/toradex/verdin-am62.rst +++ b/doc/board/toradex/verdin-am62.rst @@ -24,12 +24,14 @@ For an overview of the TI AM62 SoC boot flow please head over to:

Sources:

• .. include:: ../ti/k3.rst :start-after: .. k3_rst_include_start_boot_sources :end-before: .. k3_rst_include_end_boot_sources

  Build procedure:

• 0. Setup the environment variables:

  .. include:: ../ti/k3.rst

@@ -50,7 +52,7 @@ Set the variables corresponding to this platform: $ export UBOOT_CFG_CORTEXR=verdin-am62_r5_defconfig $ export UBOOT_CFG_CORTEXA=verdin-am62_a53_defconfig $ export TFA_BOARD=lite

• $ # we dont use any extra TFA parameters

• $ # we don't use any extra TFA parameters $ unset TFA_EXTRA_ARGS $ export OPTEE_PLATFORM=k3-am62x $ export OPTEE_EXTRA_ARGS="CFG_WITH_SOFTWARE_PRNG=y"

@@ -75,9 +77,7 @@ Flash to eMMC Boot

---

-Output:

-.. code-block:: none +Output::

U-Boot SPL 2023.10-rc1-00210-gb678170a34c (Aug 03 2023 - 00:09:14 +0200)
SYSFW ABI: 3.1 (firmware rev 0x0009 '9.0.1--v09.00.01 (Kool Koala)')

diff --git a/doc/board/toradex/verdin-imx8mm.rst b/doc/board/toradex/verdin-imx8mm.rst index cc39030450f..6e150e9aec7 100644 --- a/doc/board/toradex/verdin-imx8mm.rst +++ b/doc/board/toradex/verdin-imx8mm.rst @@ -46,6 +46,7 @@ Get the DDR Firmware

Build U-Boot

• .. code-block:: bash

  $ export CROSS_COMPILE=aarch64-linux-gnu-
  

@@ -61,7 +62,7 @@ Flash to eMMC > setexpr blkcnt ${filesize} + 0x1ff && setexpr blkcnt ${blkcnt} / 0x200 > mmc dev 0 1 && mmc write ${loadaddr} 0x2 ${blkcnt}

-As a convenience, instead of the last two commands one may also use the update +As a convenience, instead of the last two commands, one may also use the update U-Boot wrapper:

.. code-block:: bash @@ -71,16 +72,14 @@ U-Boot wrapper: Boot

---

-ATF, U-Boot proper and u-boot.dtb images are packed into FIT image, +ATF, U-Boot proper and u-boot.dtb images are packed into a FIT image, which is loaded and parsed by SPL.

Boot sequence is:

• SPL ---> ATF (TF-A) ---> U-Boot proper

-Output:

-.. code-block:: none +Output::

U-Boot SPL 2021.10-rc2-00028-gee010ba1129 (Aug 23 2021 - 16:56:02 +0200)
Normal Boot

diff --git a/doc/board/toradex/verdin-imx8mp.rst b/doc/board/toradex/verdin-imx8mp.rst index bdc4d0c2cb5..9ee605f64d5 100644 --- a/doc/board/toradex/verdin-imx8mp.rst +++ b/doc/board/toradex/verdin-imx8mp.rst @@ -46,6 +46,7 @@ Get the DDR Firmware

Build U-Boot

• .. code-block:: bash

  $ export CROSS_COMPILE=aarch64-linux-gnu-
  

@@ -61,7 +62,7 @@ Flash to eMMC > setexpr blkcnt ${filesize} + 0x1ff && setexpr blkcnt ${blkcnt} / 0x200 > mmc dev 2 1 && mmc write ${loadaddr} 0x0 ${blkcnt}

Thank you for keeping the documentation accurate.

The configuration for the board has:

SYS_PROMPT "Verdin iMX8MP # " SYS_PROMPT_HUSH_PS2 "> "

I would not have expected the secondary prompt '> ' here.

Best regards

Heinrich

-As a convenience, instead of the last two commands one may also use the update +As a convenience, instead of the last two commands, one may also use the update U-Boot wrapper:

.. code-block:: bash @@ -71,16 +72,14 @@ U-Boot wrapper: Boot

---

-ATF, U-Boot proper and u-boot.dtb images are packed into FIT image, +ATF, U-Boot proper and u-boot.dtb images are packed into a FIT image, which is loaded and parsed by SPL.

Boot sequence is:

• SPL ---> ATF (TF-A) ---> U-Boot proper

-Output:

-.. code-block:: none +Output::

U-Boot SPL 2022.04-rc1-00164-g21a0312611-dirty (Feb 07 2022 - 11:34:04 +0100)
Quad die, dual rank failed, attempting dual die, single rank configuration.

On 8/29/23 00:01, Marcel Ziswiler wrote:

From: Marcel Ziswiler marcel.ziswiler@toradex.com

Now with the update U-Boot wrappers having been sorted out, document their usage.

Signed-off-by: Marcel Ziswiler marcel.ziswiler@toradex.com

---

doc/board/toradex/verdin-am62.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+)

diff --git a/doc/board/toradex/verdin-am62.rst b/doc/board/toradex/verdin-am62.rst index ecc7e0777cb..e8d90273288 100644 --- a/doc/board/toradex/verdin-am62.rst +++ b/doc/board/toradex/verdin-am62.rst @@ -74,6 +74,20 @@ Flash to eMMC => fatload mmc 1 ${loadaddr} u-boot.img => mmc write ${loadaddr} 0x1400 0x2000

+As a convenience, instead of having to remember all those addresses and sizes, +one may also use the update U-Boot wrappers:

+.. code-block:: bash

• ...

  tftpboot ${loadaddr} tiboot3-am62x-gp-verdin.bin

• ...

  run update_tiboot3

I wonder what the prompt '>' refers to. The rest of the document uses '=>' as U-Boot prompt.

To make copying easier consider using

.. prompt:: bash =>

The html rendered page will contain a => before each line but you would not need to type it here.

Best regards

Heinrich

• ...

  tftpboot ${loadaddr} tispl.bin

• ...

  run update_tispl

• ...

  tftpboot ${loadaddr} u-boot.img

• ...

  run update_uboot

• Boot