public inbox for u-boot@lists.denx.de
 help / color / mirror / Atom feed
* [PATCH v5 0/6] doc: board: toradex reST documentation
@ 2020-02-12 15:14 Igor Opaniuk
  2020-02-12 15:14 ` [PATCH v5 1/6] doc: board: toradex: add colibri_imx7.rst Igor Opaniuk
                   ` (6 more replies)
  0 siblings, 7 replies; 19+ messages in thread
From: Igor Opaniuk @ 2020-02-12 15:14 UTC (permalink / raw)
  To: u-boot

This patch-series adds/converts existing README files for Toradex modules
to reStructureFormat.

To verify please run:
$ make htmldocs

v5:
- Fixed markup for headers [Bin Meng]
- Applied R-b tag for colibri_imx7.rst [Bin Beng]

v4:
- Removed blank lines from EOF in some readme files [Heinrich Schuchardt]
- Adjust MAINTAINERS, add entries for newly created docs

v3:
- Fixed Colibri iMX7 image adjustments section [Max Krummenacher]
- Changed hierarchy of documents and moved to doc/board/toradex [Bin Meng]
- Fixed some typos ('%s/U-boot/U-Boot/g') [Bin Meng]

v2:
- Converted to reStructuredText format [Bin Meng]

Igor Opaniuk (6):
  doc: board: toradex: add colibri_imx7.rst
  doc: board: verdin-imx8mm: convert readme to reST
  doc: board: apalis-imx8: convert readme to reST
  doc: board: colibri-imx8x: convert readme to reST
  toradex: MAINTAINERS: entries for new reST docs
  doc: board: add rockchip subfolder

 board/toradex/apalis-imx8/MAINTAINERS   |   1 +
 board/toradex/apalis-imx8/README        |  66 ------------
 board/toradex/colibri-imx8x/MAINTAINERS |   1 +
 board/toradex/colibri-imx8x/README      |  66 ------------
 board/toradex/colibri_imx7/MAINTAINERS  |   1 +
 board/toradex/verdin-imx8mm/MAINTAINERS |   1 +
 board/toradex/verdin-imx8mm/README      |  88 ----------------
 doc/board/index.rst                     |   2 +
 doc/board/toradex/apalix-imx8.rst       |  82 +++++++++++++++
 doc/board/toradex/colibri-imx8x.rst     |  82 +++++++++++++++
 doc/board/toradex/colibri_imx7.rst      | 127 ++++++++++++++++++++++++
 doc/board/toradex/index.rst             |  12 +++
 doc/board/toradex/verdin-imx8mm.rst     | 112 +++++++++++++++++++++
 13 files changed, 421 insertions(+), 220 deletions(-)
 delete mode 100644 board/toradex/apalis-imx8/README
 delete mode 100644 board/toradex/colibri-imx8x/README
 delete mode 100644 board/toradex/verdin-imx8mm/README
 create mode 100644 doc/board/toradex/apalix-imx8.rst
 create mode 100644 doc/board/toradex/colibri-imx8x.rst
 create mode 100644 doc/board/toradex/colibri_imx7.rst
 create mode 100644 doc/board/toradex/index.rst
 create mode 100644 doc/board/toradex/verdin-imx8mm.rst

-- 
2.17.1

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [PATCH v5 1/6] doc: board: toradex: add colibri_imx7.rst
  2020-02-12 15:14 [PATCH v5 0/6] doc: board: toradex reST documentation Igor Opaniuk
@ 2020-02-12 15:14 ` Igor Opaniuk
  2020-02-12 15:45   ` Oleksandr Suvorov
  2020-02-20 13:26   ` Bin Meng
  2020-02-12 15:14 ` [PATCH v5 2/6] doc: board: verdin-imx8mm: convert readme to reST Igor Opaniuk
                   ` (5 subsequent siblings)
  6 siblings, 2 replies; 19+ messages in thread
From: Igor Opaniuk @ 2020-02-12 15:14 UTC (permalink / raw)
  To: u-boot

From: Igor Opaniuk <igor.opaniuk@toradex.com>

- add initial index for toradex boards reST documentation
- add initial colibri_imx7.rst doc file which provides all needed
information for obtaining a workable image ready for flashing
for both eMMC/NAND versions of Colibri iMX7.

Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>
---

 doc/board/index.rst                |   1 +
 doc/board/toradex/colibri_imx7.rst | 127 +++++++++++++++++++++++++++++
 doc/board/toradex/index.rst        |   9 ++
 3 files changed, 137 insertions(+)
 create mode 100644 doc/board/toradex/colibri_imx7.rst
 create mode 100644 doc/board/toradex/index.rst

diff --git a/doc/board/index.rst b/doc/board/index.rst
index 00e72f57cd..f2f5907b8c 100644
--- a/doc/board/index.rst
+++ b/doc/board/index.rst
@@ -15,4 +15,5 @@ Board-specific doc
    intel/index
    renesas/index
    sifive/index
+   toradex/index
    xilinx/index
diff --git a/doc/board/toradex/colibri_imx7.rst b/doc/board/toradex/colibri_imx7.rst
new file mode 100644
index 0000000000..0c7ae082d0
--- /dev/null
+++ b/doc/board/toradex/colibri_imx7.rst
@@ -0,0 +1,127 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Colibri iMX7
+============
+
+Quick Start
+-----------
+
+- Build U-Boot
+- NAND IMX image adjustments before flashing
+- Flashing manually U-Boot to eMMC
+- Flashing manually U-Boot to NAND
+- Using ``update_uboot`` script
+
+Build U-Boot
+------------
+
+.. code-block:: bash
+
+    $ export CROSS_COMPILE=arm-linux-gnueabi-
+    $ export ARCH=arm
+    $ 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
+adjustments).
+
+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
+* **Boot data** -indicates the program image location, program image size
+  in bytes, and the plugin flag.
+* **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
+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.
+To obtain this value, run:
+
+.. code-block:: bash
+
+    $ od -X -N 0x30 u-boot-dtb.imx
+    0000000    402000d1 87800000 00000000 877ff42c
+    0000020    877ff420 877ff400 878a5000 00000000
+                        ^^^^^^^^
+    0000040    877ff000 000a8060 00000000 40b401d2
+               ^^^^^^^^ ^^^^^^^^
+
+Where:
+
+* ``877ff400`` - IVT self address
+* ``877ff000`` - Program image address
+* ``000a8060`` - Program image size
+
+To calculate the padding:
+
+* IVT offset = ``0x877ff400`` - ``0x877ff000`` = ``0x400``
+* Program image size = ``0xa8060`` - ``0x400`` = ``0xa7c60``
+
+and then pad the image:
+
+.. code-block:: bash
+
+    $ 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.
+
+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
+beginning of the image.
+
+.. code-block:: bash
+
+    $ dd if=u-boot-dtb.imx.zero-padded of=u-boot-dtb.imx.ready bs=1024 seek=1
+
+Flash U-Boot IMX image to eMMC
+------------------------------
+
+Flash the ``u-boot-dtb.imx.zero-padded`` binary to the primary eMMC hardware
+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
+    => mmc write ${loadaddr} 0x2 ${blkcnt}
+
+Flash U-Boot IMX image to NAND
+------------------------------
+
+.. code-block:: bash
+
+    => load mmc 1:1 $loadaddr u-boot-dtb.imx.ready
+    => nand erase.part u-boot1
+    => nand write ${loadaddr} u-boot1 ${filesize}
+    => nand erase.part u-boot2
+    => nand write ${loadaddr} u-boot2 ${filesize}
+
+Using update_uboot script
+-------------------------
+
+You can also usb U-Boot env update_uboot script,
+which wraps all eMMC/NAND specific command invocation:
+
+.. code-block:: bash
+
+    => load mmc 1:1 $loadaddr u-boot-dtb.imx.ready
+    => run update_uboot
diff --git a/doc/board/toradex/index.rst b/doc/board/toradex/index.rst
new file mode 100644
index 0000000000..aa418d6bad
--- /dev/null
+++ b/doc/board/toradex/index.rst
@@ -0,0 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Toradex
+=======
+
+.. toctree::
+   :maxdepth: 2
+
+   colibri_imx7
-- 
2.17.1

^ permalink raw reply related	[flat|nested] 19+ messages in thread

* [PATCH v5 2/6] doc: board: verdin-imx8mm: convert readme to reST
  2020-02-12 15:14 [PATCH v5 0/6] doc: board: toradex reST documentation Igor Opaniuk
  2020-02-12 15:14 ` [PATCH v5 1/6] doc: board: toradex: add colibri_imx7.rst Igor Opaniuk
@ 2020-02-12 15:14 ` Igor Opaniuk
  2020-02-12 15:46   ` Oleksandr Suvorov
  2020-02-20 13:24   ` Bin Meng
  2020-02-12 15:14 ` [PATCH v5 3/6] doc: board: apalis-imx8: " Igor Opaniuk
                   ` (4 subsequent siblings)
  6 siblings, 2 replies; 19+ messages in thread
From: Igor Opaniuk @ 2020-02-12 15:14 UTC (permalink / raw)
  To: u-boot

From: Igor Opaniuk <igor.opaniuk@toradex.com>

Convert README to reStructuredText format.

Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>
---

 board/toradex/verdin-imx8mm/README  |  88 ----------------------
 doc/board/toradex/index.rst         |   1 +
 doc/board/toradex/verdin-imx8mm.rst | 112 ++++++++++++++++++++++++++++
 3 files changed, 113 insertions(+), 88 deletions(-)
 delete mode 100644 board/toradex/verdin-imx8mm/README
 create mode 100644 doc/board/toradex/verdin-imx8mm.rst

diff --git a/board/toradex/verdin-imx8mm/README b/board/toradex/verdin-imx8mm/README
deleted file mode 100644
index 1dac969476..0000000000
--- a/board/toradex/verdin-imx8mm/README
+++ /dev/null
@@ -1,88 +0,0 @@
-U-Boot for the Toradex Verdin iMX8M Mini Module
-
-Quick Start
-===========
-
-- Build the ARM trusted firmware binary
-- Get the DDR firmware
-- Build U-Boot
-- Flash to eMMC
-- Boot
-
-Get and Build the ARM Trusted Firmware (Trusted Firmware A)
-===========================================================
-
-$ echo "Downloading and building TF-A..."
-$ git clone -b imx_4.14.98_2.3.0 https://source.codeaurora.org/external/imx/imx-atf
-$ cd imx-atf
-
-Please edit `plat/imx/imx8mm/include/platform_def.h` so it contains proper
-values for UART configuration and BL31 base address (correct values listed
-below):
-#define BL31_BASE		0x910000
-#define IMX_BOOT_UART_BASE	0x30860000
-#define DEBUG_CONSOLE		1
-
-Then build ATF (TF-A):
-$ make PLAT=imx8mm bl31
-
-Get the DDR Firmware
-====================
-
-$ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-8.4.1.bin
-$ chmod +x firmware-imx-8.4.1.bin
-$ ./firmware-imx-8.4.1.bin
-$ cp firmware-imx-8.4.1/firmware/ddr/synopsys/lpddr4*.bin ./
-
-Build U-Boot
-============
-
-$ export CROSS_COMPILE=aarch64-linux-gnu-
-$ make verdin-imx8mm_defconfig
-$ make flash.bin
-
-Flash to eMMC
-=============
-
-> tftpboot ${loadaddr} flash.bin
-> 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
-U-Boot wrapper:
-> run update_uboot
-
-Boot
-====
-
-ATF, U-boot proper and u-boot.dtb images are packed into FIT image,
-which is loaded and parsed by SPL.
-
-Boot sequence is:
-SPL ---> ATF (TF-A) ---> U-boot proper
-
-Output:
-U-Boot SPL 2020.01-00187-gd411d164e5 (Jan 26 2020 - 04:47:26 +0100)
-Normal Boot
-Trying to boot from MMC1
-NOTICE:  Configuring TZASC380
-NOTICE:  RDC off
-NOTICE:  BL31: v2.0(release):rel_imx_4.14.98_2.3.0-0-g09c5cc994-dirty
-NOTICE:  BL31: Built : 01:11:41, Jan 25 2020
-NOTICE:  sip svc init
-
-
-U-Boot 2020.01-00187-gd411d164e5 (Jan 26 2020 - 04:47:26 +0100)
-
-CPU:   Freescale i.MX8MMQ rev1.0 at 0 MHz
-Reset cause: POR
-DRAM:  2 GiB
-MMC:   FSL_SDHC: 0, FSL_SDHC: 1, FSL_SDHC: 2
-Loading Environment from MMC... OK
-In:    serial
-Out:   serial
-Err:   serial
-Model: Toradex Verdin iMX8M Mini Quad 2GB Wi-Fi / BT IT V1.0A, Serial# 06535149
-Net:   eth0: ethernet at 30be0000
-Hit any key to stop autoboot:  0
-Verdin iMX8MM #
diff --git a/doc/board/toradex/index.rst b/doc/board/toradex/index.rst
index aa418d6bad..6cd2ade9f4 100644
--- a/doc/board/toradex/index.rst
+++ b/doc/board/toradex/index.rst
@@ -7,3 +7,4 @@ Toradex
    :maxdepth: 2
 
    colibri_imx7
+   verdin-imx8mm
diff --git a/doc/board/toradex/verdin-imx8mm.rst b/doc/board/toradex/verdin-imx8mm.rst
new file mode 100644
index 0000000000..4ed16fce34
--- /dev/null
+++ b/doc/board/toradex/verdin-imx8mm.rst
@@ -0,0 +1,112 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Verdin iMX8M Mini Module
+========================
+
+Quick Start
+-----------
+
+- Build the ARM trusted firmware binary
+- Get the DDR firmware
+- Build U-Boot
+- Flash to eMMC
+- Boot
+
+Get and Build the ARM Trusted Firmware (Trusted Firmware A)
+-----------------------------------------------------------
+
+.. code-block:: bash
+
+    $ echo "Downloading and building TF-A..."
+    $ git clone -b imx_4.14.98_2.3.0 \
+      https://source.codeaurora.org/external/imx/imx-atf
+    $ cd imx-atf
+
+Please edit ``plat/imx/imx8mm/include/platform_def.h`` so it contains proper
+values for UART configuration and BL31 base address (correct values listed
+below):
+
+.. code-block:: bash
+
+    #define BL31_BASE                   0x910000
+    #define IMX_BOOT_UART_BASE          0x30860000
+    #define DEBUG_CONSOLE               1
+
+Then build ATF (TF-A):
+
+.. code-block:: bash
+
+    $ make PLAT=imx8mm bl31
+
+Get the DDR Firmware
+--------------------
+
+.. code-block:: bash
+
+    $ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-8.4.1.bin
+    $ chmod +x firmware-imx-8.4.1.bin
+    $ ./firmware-imx-8.4.1.bin
+    $ cp firmware-imx-8.4.1/firmware/ddr/synopsys/lpddr4*.bin ./
+
+Build U-Boot
+------------
+.. code-block:: bash
+
+    $ export CROSS_COMPILE=aarch64-linux-gnu-
+    $ make verdin-imx8mm_defconfig
+    $ make flash.bin
+
+Flash to eMMC
+-------------
+
+.. code-block:: bash
+
+    > tftpboot ${loadaddr} flash.bin
+    > 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
+U-Boot wrapper:
+
+.. code-block:: bash
+
+    > run update_uboot
+
+Boot
+----
+
+ATF, U-boot proper and u-boot.dtb images are packed into FIT image,
+which is loaded and parsed by SPL.
+
+Boot sequence is:
+
+* SPL ---> ATF (TF-A) ---> U-boot proper
+
+Output:
+
+.. code-block:: bash
+
+    U-Boot SPL 2020.01-00187-gd411d164e5 (Jan 26 2020 - 04:47:26 +0100)
+    Normal Boot
+    Trying to boot from MMC1
+    NOTICE:  Configuring TZASC380
+    NOTICE:  RDC off
+    NOTICE:  BL31: v2.0(release):rel_imx_4.14.98_2.3.0-0-g09c5cc994-dirty
+    NOTICE:  BL31: Built : 01:11:41, Jan 25 2020
+    NOTICE:  sip svc init
+
+
+    U-Boot 2020.01-00187-gd411d164e5 (Jan 26 2020 - 04:47:26 +0100)
+
+    CPU:   Freescale i.MX8MMQ rev1.0 at 0 MHz
+    Reset cause: POR
+    DRAM:  2 GiB
+    MMC:   FSL_SDHC: 0, FSL_SDHC: 1, FSL_SDHC: 2
+    Loading Environment from MMC... OK
+    In:    serial
+    Out:   serial
+    Err:   serial
+    Model: Toradex Verdin iMX8M Mini Quad 2GB Wi-Fi / BT IT V1.0A, Serial:
+    Net:   eth0: ethernet at 30be0000
+    Hit any key to stop autoboot:  0
+    Verdin iMX8MM #
-- 
2.17.1

^ permalink raw reply related	[flat|nested] 19+ messages in thread

* [PATCH v5 3/6] doc: board: apalis-imx8: convert readme to reST
  2020-02-12 15:14 [PATCH v5 0/6] doc: board: toradex reST documentation Igor Opaniuk
  2020-02-12 15:14 ` [PATCH v5 1/6] doc: board: toradex: add colibri_imx7.rst Igor Opaniuk
  2020-02-12 15:14 ` [PATCH v5 2/6] doc: board: verdin-imx8mm: convert readme to reST Igor Opaniuk
@ 2020-02-12 15:14 ` Igor Opaniuk
  2020-02-12 15:46   ` Oleksandr Suvorov
  2020-02-20 13:35   ` Bin Meng
  2020-02-12 15:14 ` [PATCH v5 4/6] doc: board: colibri-imx8x: " Igor Opaniuk
                   ` (3 subsequent siblings)
  6 siblings, 2 replies; 19+ messages in thread
From: Igor Opaniuk @ 2020-02-12 15:14 UTC (permalink / raw)
  To: u-boot

From: Igor Opaniuk <igor.opaniuk@toradex.com>

Convert README to reStructuredText format.

Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>
---

 board/toradex/apalis-imx8/README  | 66 -------------------------
 doc/board/toradex/apalix-imx8.rst | 82 +++++++++++++++++++++++++++++++
 doc/board/toradex/index.rst       |  1 +
 3 files changed, 83 insertions(+), 66 deletions(-)
 delete mode 100644 board/toradex/apalis-imx8/README
 create mode 100644 doc/board/toradex/apalix-imx8.rst

diff --git a/board/toradex/apalis-imx8/README b/board/toradex/apalis-imx8/README
deleted file mode 100644
index e6e3dcb367..0000000000
--- a/board/toradex/apalis-imx8/README
+++ /dev/null
@@ -1,66 +0,0 @@
-U-Boot for the Toradex Apalis iMX8QM V1.0B Module
-
-Quick Start
-===========
-
-- Build the ARM trusted firmware binary
-- Get scfw_tcm.bin and ahab-container.img
-- Build U-Boot
-- Load U-Boot binary using uuu
-- Flash U-Boot binary into the eMMC
-- Boot
-
-Get and Build the ARM Trusted Firmware
-======================================
-
-$ git clone -b imx_4.14.78_1.0.0_ga https://source.codeaurora.org/external/imx/imx-atf
-$ cd imx-atf/
-$ make PLAT=imx8qm bl31
-
-Get scfw_tcm.bin and ahab-container.img
-=======================================
-
-$ wget https://github.com/toradex/meta-fsl-bsp-release/blob/toradex-sumo-4.14.78-1.0.0_ga-bringup/imx/meta-bsp/recipes-bsp/imx-sc-firmware/files/mx8qm-apalis-scfw-tcm.bin?raw=true
-$ mv mx8qm-apalis-scfw-tcm.bin\?raw\=true mx8qm-apalis-scfw-tcm.bin
-$ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-8.0.bin
-$ chmod +x firmware-imx-8.0.bin
-$ ./firmware-imx-8.0.bin
-
-Copy the following binaries to the U-Boot folder:
-
-$ cp imx-atf/build/imx8qm/release/bl31.bin .
-$ cp u-boot/u-boot.bin .
-
-Copy the following firmware to the U-Boot folder:
-
-$ cp firmware-imx-8.0/firmware/seco/ahab-container.img .
-
-Build U-Boot
-============
-
-$ make apalis-imx8qm_defconfig
-$ make u-boot-dtb.imx
-
-Load the U-Boot Binary Using UUU
-================================
-
-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%2FNXPmicro%2Fmfgtools%2Freleases
-
-Put the module into USB recovery aka serial downloader mode, connect USB device
-to your host and execute uuu:
-
-sudo ./uuu u-boot/u-boot-dtb.imx
-
-Flash the U-Boot Binary into the eMMC
-=====================================
-
-Burn the u-boot-dtb.imx binary to the primary eMMC hardware boot area partition:
-
-load mmc 1:1 $loadaddr u-boot-dtb.imx
-setexpr blkcnt ${filesize} + 0x1ff && setexpr blkcnt ${blkcnt} / 0x200
-mmc dev 0 1
-mmc write ${loadaddr} 0x0 ${blkcnt}
-
-Boot
diff --git a/doc/board/toradex/apalix-imx8.rst b/doc/board/toradex/apalix-imx8.rst
new file mode 100644
index 0000000000..4b7ea65d31
--- /dev/null
+++ b/doc/board/toradex/apalix-imx8.rst
@@ -0,0 +1,82 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Apalis iMX8QM V1.0B Module
+==========================
+
+Quick Start
+-----------
+
+- Build the ARM trusted firmware binary
+- Get scfw_tcm.bin and ahab-container.img
+- Build U-Boot
+- Load U-Boot binary using uuu
+- Flash U-Boot binary into the eMMC
+- Boot
+
+Get and Build the ARM Trusted Firmware
+--------------------------------------
+
+.. code-block:: bash
+
+    $ git clone -b imx_4.14.78_1.0.0_ga https://source.codeaurora.org/external/imx/imx-atf
+    $ cd imx-atf/
+    $ make PLAT=imx8qm bl31
+
+Get scfw_tcm.bin and ahab-container.img
+---------------------------------------
+
+.. code-block:: bash
+
+    $ wget https://github.com/toradex/meta-fsl-bsp-release/blob/toradex-sumo-4.14.78-1.0.0_ga-bringup/imx/meta-bsp/recipes-
+      bsp/imx-sc-firmware/files/mx8qm-apalis-scfw-tcm.bin?raw=true
+    $ mv mx8qm-apalis-scfw-tcm.bin\?raw\=true mx8qm-apalis-scfw-tcm.bin
+    $ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-8.0.bin
+    $ chmod +x firmware-imx-8.0.bin
+    $ ./firmware-imx-8.0.bin
+
+Copy the following binaries to the U-Boot folder:
+
+.. code-block:: bash
+
+    $ cp imx-atf/build/imx8qm/release/bl31.bin .
+    $ cp u-boot/u-boot.bin .
+
+Copy the following firmware to the U-Boot folder:
+
+.. code-block:: bash
+
+    $ cp firmware-imx-8.0/firmware/seco/ahab-container.img .
+
+Build U-Boot
+------------
+.. code-block:: bash
+
+    $ make apalis-imx8qm_defconfig
+    $ make u-boot-dtb.imx
+
+Load the U-Boot Binary Using UUU
+--------------------------------
+
+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%2FNXPmicro%2Fmfgtools%2Freleases
+
+Put the module into USB recovery aka serial downloader mode, connect USB device
+to your host and execute uuu:
+
+.. code-block:: bash
+
+    sudo ./uuu u-boot/u-boot-dtb.imx
+
+Flash the U-Boot Binary into the eMMC
+-------------------------------------
+
+Burn the ``u-boot-dtb.imx`` binary to the primary eMMC hardware boot area
+partition and boot:
+
+.. code-block:: bash
+
+    load mmc 1:1 $loadaddr u-boot-dtb.imx
+    setexpr blkcnt ${filesize} + 0x1ff && setexpr blkcnt ${blkcnt} / 0x200
+    mmc dev 0 1
+    mmc write ${loadaddr} 0x0 ${blkcnt}
diff --git a/doc/board/toradex/index.rst b/doc/board/toradex/index.rst
index 6cd2ade9f4..da65ad2408 100644
--- a/doc/board/toradex/index.rst
+++ b/doc/board/toradex/index.rst
@@ -6,5 +6,6 @@ Toradex
 .. toctree::
    :maxdepth: 2
 
+   apalix-imx8
    colibri_imx7
    verdin-imx8mm
-- 
2.17.1

^ permalink raw reply related	[flat|nested] 19+ messages in thread

* [PATCH v5 4/6] doc: board: colibri-imx8x: convert readme to reST
  2020-02-12 15:14 [PATCH v5 0/6] doc: board: toradex reST documentation Igor Opaniuk
                   ` (2 preceding siblings ...)
  2020-02-12 15:14 ` [PATCH v5 3/6] doc: board: apalis-imx8: " Igor Opaniuk
@ 2020-02-12 15:14 ` Igor Opaniuk
  2020-02-13 10:10   ` Oleksandr Suvorov
  2020-02-20 13:37   ` Bin Meng
  2020-02-12 15:14 ` [PATCH v5 5/6] toradex: MAINTAINERS: entries for new reST docs Igor Opaniuk
                   ` (2 subsequent siblings)
  6 siblings, 2 replies; 19+ messages in thread
From: Igor Opaniuk @ 2020-02-12 15:14 UTC (permalink / raw)
  To: u-boot

From: Igor Opaniuk <igor.opaniuk@toradex.com>

Convert README to reStructuredText format.

Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>
---

 board/toradex/colibri-imx8x/README  | 66 -----------------------
 doc/board/toradex/colibri-imx8x.rst | 82 +++++++++++++++++++++++++++++
 doc/board/toradex/index.rst         |  1 +
 3 files changed, 83 insertions(+), 66 deletions(-)
 delete mode 100644 board/toradex/colibri-imx8x/README
 create mode 100644 doc/board/toradex/colibri-imx8x.rst

diff --git a/board/toradex/colibri-imx8x/README b/board/toradex/colibri-imx8x/README
deleted file mode 100644
index 708bb3e51c..0000000000
--- a/board/toradex/colibri-imx8x/README
+++ /dev/null
@@ -1,66 +0,0 @@
-U-Boot for the Toradex Colibri iMX8QXP V1.0B Module
-
-Quick Start
-===========
-
-- Build the ARM trusted firmware binary
-- Get scfw_tcm.bin and ahab-container.img
-- Build U-Boot
-- Load U-Boot binary using uuu
-- Flash U-Boot binary into the eMMC
-- Boot
-
-Get and Build the ARM Trusted Firmware
-======================================
-
-$ git clone -b imx_4.14.78_1.0.0_ga https://source.codeaurora.org/external/imx/imx-atf
-$ cd imx-atf/
-$ make PLAT=imx8qxp bl31
-
-Get scfw_tcm.bin and ahab-container.img
-=======================================
-
-$ wget https://github.com/toradex/meta-fsl-bsp-release/blob/toradex-sumo-4.14.78-1.0.0_ga-bringup/imx/meta-bsp/recipes-bsp/imx-sc-firmware/files/mx8qx-colibri-scfw-tcm.bin?raw=true
-$ mv mx8qx-colibri-scfw-tcm.bin\?raw\=true mx8qx-colibri-scfw-tcm.bin
-$ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-8.0.bin
-$ chmod +x firmware-imx-8.0.bin
-$ ./firmware-imx-8.0.bin
-
-Copy the following binaries to the U-Boot folder:
-
-$ cp imx-atf/build/imx8qxp/release/bl31.bin .
-$ cp u-boot/u-boot.bin .
-
-Copy the following firmware to the U-Boot folder:
-
-$ cp firmware-imx-8.0/firmware/seco/ahab-container.img .
-
-Build U-Boot
-============
-
-$ make colibri-imx8qxp_defconfig
-$ make u-boot-dtb.imx
-
-Load the U-Boot Binary Using UUU
-================================
-
-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%2FNXPmicro%2Fmfgtools%2Freleases
-
-Put the module into USB recovery aka serial downloader mode, connect USB device
-to your host and execute uuu:
-
-sudo ./uuu u-boot/u-boot-dtb.imx
-
-Flash the U-Boot Binary into the eMMC
-=====================================
-
-Burn the u-boot-dtb.imx binary to the primary eMMC hardware boot area partition:
-
-load mmc 1:1 $loadaddr u-boot-dtb.imx
-setexpr blkcnt ${filesize} + 0x1ff && setexpr blkcnt ${blkcnt} / 0x200
-mmc dev 0 1
-mmc write ${loadaddr} 0x0 ${blkcnt}
-
-Boot
diff --git a/doc/board/toradex/colibri-imx8x.rst b/doc/board/toradex/colibri-imx8x.rst
new file mode 100644
index 0000000000..244e5a4c04
--- /dev/null
+++ b/doc/board/toradex/colibri-imx8x.rst
@@ -0,0 +1,82 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Colibri iMX8QXP V1.0B Module
+============================
+
+Quick Start
+-----------
+
+- Build the ARM trusted firmware binary
+- Get scfw_tcm.bin and ahab-container.img
+- Build U-Boot
+- Load U-Boot binary using uuu
+- Flash U-Boot binary into the eMMC
+- Boot
+
+Get and Build the ARM Trusted Firmware
+--------------------------------------
+
+.. code-block:: bash
+
+    $ git clone -b imx_4.14.78_1.0.0_ga https://source.codeaurora.org/external/imx/imx-atf
+    $ cd imx-atf/
+    $ make PLAT=imx8qxp bl31
+
+Get scfw_tcm.bin and ahab-container.img
+---------------------------------------
+.. code-block:: bash
+
+    $ wget https://github.com/toradex/meta-fsl-bsp-release/blob/
+           toradex-sumo-4.14.78-1.0.0_ga-bringup/imx/meta-bsp/recipes-
+           bsp/imx-sc-firmware/files/mx8qx-colibri-scfw-tcm.bin?raw=true
+    $ mv mx8qx-colibri-scfw-tcm.bin\?raw\=true mx8qx-colibri-scfw-tcm.bin
+    $ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-8.0.bin
+    $ chmod +x firmware-imx-8.0.bin
+    $ ./firmware-imx-8.0.bin
+
+Copy the following binaries to the U-Boot folder:
+
+.. code-block:: bash
+
+    $ cp imx-atf/build/imx8qxp/release/bl31.bin .
+    $ cp u-boot/u-boot.bin .
+
+Copy the following firmware to the U-Boot folder:
+
+.. code-block:: bash
+
+    $ cp firmware-imx-8.0/firmware/seco/ahab-container.img .
+
+Build U-Boot
+------------
+
+.. code-block:: bash
+
+   $ make colibri-imx8qxp_defconfig
+   $ make u-boot-dtb.imx
+
+Load the U-Boot Binary Using UUU
+--------------------------------
+
+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%2FNXPmicro%2Fmfgtools%2Freleases
+
+Put the module into USB recovery aka serial downloader mode, connect USB device
+to your host and execute ``uuu``:
+
+.. code-block:: bash
+
+    sudo ./uuu u-boot/u-boot-dtb.imx
+
+Flash the U-Boot Binary into the eMMC
+-------------------------------------
+
+Burn the ``u-boot-dtb.imx`` binary to the primary eMMC hardware boot area partition:
+
+.. code-block:: bash
+
+    load mmc 1:1 $loadaddr u-boot-dtb.imx
+    setexpr blkcnt ${filesize} + 0x1ff && setexpr blkcnt ${blkcnt} / 0x200
+    mmc dev 0 1
+    mmc write ${loadaddr} 0x0 ${blkcnt}
diff --git a/doc/board/toradex/index.rst b/doc/board/toradex/index.rst
index da65ad2408..16b5a0770d 100644
--- a/doc/board/toradex/index.rst
+++ b/doc/board/toradex/index.rst
@@ -8,4 +8,5 @@ Toradex
 
    apalix-imx8
    colibri_imx7
+   colibri-imx8x
    verdin-imx8mm
-- 
2.17.1

^ permalink raw reply related	[flat|nested] 19+ messages in thread

* [PATCH v5 5/6] toradex: MAINTAINERS: entries for new reST docs
  2020-02-12 15:14 [PATCH v5 0/6] doc: board: toradex reST documentation Igor Opaniuk
                   ` (3 preceding siblings ...)
  2020-02-12 15:14 ` [PATCH v5 4/6] doc: board: colibri-imx8x: " Igor Opaniuk
@ 2020-02-12 15:14 ` Igor Opaniuk
  2020-02-20 13:19   ` Bin Meng
  2020-02-12 15:14 ` [PATCH v5 6/6] doc: board: add rockchip subfolder Igor Opaniuk
  2020-02-20 13:39 ` [PATCH v5 0/6] doc: board: toradex reST documentation Bin Meng
  6 siblings, 1 reply; 19+ messages in thread
From: Igor Opaniuk @ 2020-02-12 15:14 UTC (permalink / raw)
  To: u-boot

From: Igor Opaniuk <igor.opaniuk@toradex.com>

Add entries for the newly created documentation files in reST
format.

Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>
---

 board/toradex/apalis-imx8/MAINTAINERS   | 1 +
 board/toradex/colibri-imx8x/MAINTAINERS | 1 +
 board/toradex/colibri_imx7/MAINTAINERS  | 1 +
 board/toradex/verdin-imx8mm/MAINTAINERS | 1 +
 4 files changed, 4 insertions(+)

diff --git a/board/toradex/apalis-imx8/MAINTAINERS b/board/toradex/apalis-imx8/MAINTAINERS
index c9ac58b47b..feacf7eded 100644
--- a/board/toradex/apalis-imx8/MAINTAINERS
+++ b/board/toradex/apalis-imx8/MAINTAINERS
@@ -6,4 +6,5 @@ F:	arch/arm/dts/fsl-imx8-apalis.dts
 F:	arch/arm/dts/fsl-imx8-apalis-u-boot.dtsi
 F:	board/toradex/apalis-imx8/
 F:	configs/apalis-imx8qm_defconfig
+F:	doc/board/toradex/apalix-imx8.rst
 F:	include/configs/apalis-imx8.h
diff --git a/board/toradex/colibri-imx8x/MAINTAINERS b/board/toradex/colibri-imx8x/MAINTAINERS
index e91b9975c2..f6853586c8 100644
--- a/board/toradex/colibri-imx8x/MAINTAINERS
+++ b/board/toradex/colibri-imx8x/MAINTAINERS
@@ -6,4 +6,5 @@ F:	arch/arm/dts/fsl-imx8x-colibri.dts
 F:	arch/arm/dts/fsl-imx8x-colibri-u-boot.dtsi
 F:	board/toradex/colibri-imx8x/
 F:	configs/colibri-imx8qxp_defconfig
+F:	doc/board/toradex/colibri-imx8x.rst
 F:	include/configs/colibri-imx8x.h
diff --git a/board/toradex/colibri_imx7/MAINTAINERS b/board/toradex/colibri_imx7/MAINTAINERS
index 178dece797..82246be160 100644
--- a/board/toradex/colibri_imx7/MAINTAINERS
+++ b/board/toradex/colibri_imx7/MAINTAINERS
@@ -4,6 +4,7 @@ W:	http://developer.toradex.com/software/linux/linux-software
 W:	https://www.toradex.com/community
 S:	Maintained
 F:	board/toradex/colibri_imx7/
+F:	doc/board/toradex/colibri_imx7.rst
 F:	include/configs/colibri_imx7.h
 F:	configs/colibri_imx7_defconfig
 F:	configs/colibri_imx7_emmc_defconfig
diff --git a/board/toradex/verdin-imx8mm/MAINTAINERS b/board/toradex/verdin-imx8mm/MAINTAINERS
index 3b4fae5c66..2495696e9d 100644
--- a/board/toradex/verdin-imx8mm/MAINTAINERS
+++ b/board/toradex/verdin-imx8mm/MAINTAINERS
@@ -6,4 +6,5 @@ F:	arch/arm/dts/imx8mm-verdin.dts
 F:	arch/arm/dts/imx8mm-verdin-u-boot.dtsi
 F:	board/toradex/verdin-imx8mm/
 F:	configs/verdin-imx8mm_defconfig
+F:	doc/board/toradex/verdin-imx8mm.rst
 F:	include/configs/verdin-imx8mm.h
-- 
2.17.1

^ permalink raw reply related	[flat|nested] 19+ messages in thread

* [PATCH v5 6/6] doc: board: add rockchip subfolder
  2020-02-12 15:14 [PATCH v5 0/6] doc: board: toradex reST documentation Igor Opaniuk
                   ` (4 preceding siblings ...)
  2020-02-12 15:14 ` [PATCH v5 5/6] toradex: MAINTAINERS: entries for new reST docs Igor Opaniuk
@ 2020-02-12 15:14 ` Igor Opaniuk
  2020-02-12 15:48   ` Oleksandr Suvorov
  2020-02-20 13:14   ` Bin Meng
  2020-02-20 13:39 ` [PATCH v5 0/6] doc: board: toradex reST documentation Bin Meng
  6 siblings, 2 replies; 19+ messages in thread
From: Igor Opaniuk @ 2020-02-12 15:14 UTC (permalink / raw)
  To: u-boot

From: Igor Opaniuk <igor.opaniuk@toradex.com>

This fixes a warning when invoking make htmldocs:
checking consistency...
doc/board/rockchip/index.rst: WARNING: document isn't included in any toctree

Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>
Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---

 doc/board/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/doc/board/index.rst b/doc/board/index.rst
index f2f5907b8c..f061e8ecfc 100644
--- a/doc/board/index.rst
+++ b/doc/board/index.rst
@@ -14,6 +14,7 @@ Board-specific doc
    google/index
    intel/index
    renesas/index
+   rockchip/index
    sifive/index
    toradex/index
    xilinx/index
-- 
2.17.1

^ permalink raw reply related	[flat|nested] 19+ messages in thread

* [PATCH v5 1/6] doc: board: toradex: add colibri_imx7.rst
  2020-02-12 15:14 ` [PATCH v5 1/6] doc: board: toradex: add colibri_imx7.rst Igor Opaniuk
@ 2020-02-12 15:45   ` Oleksandr Suvorov
  2020-02-20 13:26   ` Bin Meng
  1 sibling, 0 replies; 19+ messages in thread
From: Oleksandr Suvorov @ 2020-02-12 15:45 UTC (permalink / raw)
  To: u-boot

On Wed, Feb 12, 2020 at 5:15 PM Igor Opaniuk <igor.opaniuk@gmail.com> wrote:
>
> From: Igor Opaniuk <igor.opaniuk@toradex.com>
>
> - add initial index for toradex boards reST documentation
> - add initial colibri_imx7.rst doc file which provides all needed
> information for obtaining a workable image ready for flashing
> for both eMMC/NAND versions of Colibri iMX7.
>
> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
> Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>

Reviewed-by: Oleksandr Suvorov <oleksandr.suvorov@toradex.com>

> ---
>
>  doc/board/index.rst                |   1 +
>  doc/board/toradex/colibri_imx7.rst | 127 +++++++++++++++++++++++++++++
>  doc/board/toradex/index.rst        |   9 ++
>  3 files changed, 137 insertions(+)
>  create mode 100644 doc/board/toradex/colibri_imx7.rst
>  create mode 100644 doc/board/toradex/index.rst
>
> diff --git a/doc/board/index.rst b/doc/board/index.rst
> index 00e72f57cd..f2f5907b8c 100644
> --- a/doc/board/index.rst
> +++ b/doc/board/index.rst
> @@ -15,4 +15,5 @@ Board-specific doc
>     intel/index
>     renesas/index
>     sifive/index
> +   toradex/index
>     xilinx/index
> diff --git a/doc/board/toradex/colibri_imx7.rst b/doc/board/toradex/colibri_imx7.rst
> new file mode 100644
> index 0000000000..0c7ae082d0
> --- /dev/null
> +++ b/doc/board/toradex/colibri_imx7.rst
> @@ -0,0 +1,127 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +Colibri iMX7
> +============
> +
> +Quick Start
> +-----------
> +
> +- Build U-Boot
> +- NAND IMX image adjustments before flashing
> +- Flashing manually U-Boot to eMMC
> +- Flashing manually U-Boot to NAND
> +- Using ``update_uboot`` script
> +
> +Build U-Boot
> +------------
> +
> +.. code-block:: bash
> +
> +    $ export CROSS_COMPILE=arm-linux-gnueabi-
> +    $ export ARCH=arm
> +    $ 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
> +adjustments).
> +
> +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
> +* **Boot data** -indicates the program image location, program image size
> +  in bytes, and the plugin flag.
> +* **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
> +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.
> +To obtain this value, run:
> +
> +.. code-block:: bash
> +
> +    $ od -X -N 0x30 u-boot-dtb.imx
> +    0000000    402000d1 87800000 00000000 877ff42c
> +    0000020    877ff420 877ff400 878a5000 00000000
> +                        ^^^^^^^^
> +    0000040    877ff000 000a8060 00000000 40b401d2
> +               ^^^^^^^^ ^^^^^^^^
> +
> +Where:
> +
> +* ``877ff400`` - IVT self address
> +* ``877ff000`` - Program image address
> +* ``000a8060`` - Program image size
> +
> +To calculate the padding:
> +
> +* IVT offset = ``0x877ff400`` - ``0x877ff000`` = ``0x400``
> +* Program image size = ``0xa8060`` - ``0x400`` = ``0xa7c60``
> +
> +and then pad the image:
> +
> +.. code-block:: bash
> +
> +    $ 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.
> +
> +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
> +beginning of the image.
> +
> +.. code-block:: bash
> +
> +    $ dd if=u-boot-dtb.imx.zero-padded of=u-boot-dtb.imx.ready bs=1024 seek=1
> +
> +Flash U-Boot IMX image to eMMC
> +------------------------------
> +
> +Flash the ``u-boot-dtb.imx.zero-padded`` binary to the primary eMMC hardware
> +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
> +    => mmc write ${loadaddr} 0x2 ${blkcnt}
> +
> +Flash U-Boot IMX image to NAND
> +------------------------------
> +
> +.. code-block:: bash
> +
> +    => load mmc 1:1 $loadaddr u-boot-dtb.imx.ready
> +    => nand erase.part u-boot1
> +    => nand write ${loadaddr} u-boot1 ${filesize}
> +    => nand erase.part u-boot2
> +    => nand write ${loadaddr} u-boot2 ${filesize}
> +
> +Using update_uboot script
> +-------------------------
> +
> +You can also usb U-Boot env update_uboot script,
> +which wraps all eMMC/NAND specific command invocation:
> +
> +.. code-block:: bash
> +
> +    => load mmc 1:1 $loadaddr u-boot-dtb.imx.ready
> +    => run update_uboot
> diff --git a/doc/board/toradex/index.rst b/doc/board/toradex/index.rst
> new file mode 100644
> index 0000000000..aa418d6bad
> --- /dev/null
> +++ b/doc/board/toradex/index.rst
> @@ -0,0 +1,9 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +Toradex
> +=======
> +
> +.. toctree::
> +   :maxdepth: 2
> +
> +   colibri_imx7
> --
> 2.17.1
>


-- 
Best regards
Oleksandr Suvorov

Toradex AG
Altsagenstrasse 5 | 6048 Horw/Luzern | Switzerland | T: +41 41 500
4800 (main line)

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [PATCH v5 2/6] doc: board: verdin-imx8mm: convert readme to reST
  2020-02-12 15:14 ` [PATCH v5 2/6] doc: board: verdin-imx8mm: convert readme to reST Igor Opaniuk
@ 2020-02-12 15:46   ` Oleksandr Suvorov
  2020-02-20 13:24   ` Bin Meng
  1 sibling, 0 replies; 19+ messages in thread
From: Oleksandr Suvorov @ 2020-02-12 15:46 UTC (permalink / raw)
  To: u-boot

On Wed, Feb 12, 2020 at 5:15 PM Igor Opaniuk <igor.opaniuk@gmail.com> wrote:
>
> From: Igor Opaniuk <igor.opaniuk@toradex.com>
>
> Convert README to reStructuredText format.
>
> Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>

Reviewed-by: Oleksandr Suvorov <oleksandr.suvorov@toradex.com>

> ---
>
>  board/toradex/verdin-imx8mm/README  |  88 ----------------------
>  doc/board/toradex/index.rst         |   1 +
>  doc/board/toradex/verdin-imx8mm.rst | 112 ++++++++++++++++++++++++++++
>  3 files changed, 113 insertions(+), 88 deletions(-)
>  delete mode 100644 board/toradex/verdin-imx8mm/README
>  create mode 100644 doc/board/toradex/verdin-imx8mm.rst
>
> diff --git a/board/toradex/verdin-imx8mm/README b/board/toradex/verdin-imx8mm/README
> deleted file mode 100644
> index 1dac969476..0000000000
> --- a/board/toradex/verdin-imx8mm/README
> +++ /dev/null
> @@ -1,88 +0,0 @@
> -U-Boot for the Toradex Verdin iMX8M Mini Module
> -
> -Quick Start
> -===========
> -
> -- Build the ARM trusted firmware binary
> -- Get the DDR firmware
> -- Build U-Boot
> -- Flash to eMMC
> -- Boot
> -
> -Get and Build the ARM Trusted Firmware (Trusted Firmware A)
> -===========================================================
> -
> -$ echo "Downloading and building TF-A..."
> -$ git clone -b imx_4.14.98_2.3.0 https://source.codeaurora.org/external/imx/imx-atf
> -$ cd imx-atf
> -
> -Please edit `plat/imx/imx8mm/include/platform_def.h` so it contains proper
> -values for UART configuration and BL31 base address (correct values listed
> -below):
> -#define BL31_BASE              0x910000
> -#define IMX_BOOT_UART_BASE     0x30860000
> -#define DEBUG_CONSOLE          1
> -
> -Then build ATF (TF-A):
> -$ make PLAT=imx8mm bl31
> -
> -Get the DDR Firmware
> -====================
> -
> -$ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-8.4.1.bin
> -$ chmod +x firmware-imx-8.4.1.bin
> -$ ./firmware-imx-8.4.1.bin
> -$ cp firmware-imx-8.4.1/firmware/ddr/synopsys/lpddr4*.bin ./
> -
> -Build U-Boot
> -============
> -
> -$ export CROSS_COMPILE=aarch64-linux-gnu-
> -$ make verdin-imx8mm_defconfig
> -$ make flash.bin
> -
> -Flash to eMMC
> -=============
> -
> -> tftpboot ${loadaddr} flash.bin
> -> 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
> -U-Boot wrapper:
> -> run update_uboot
> -
> -Boot
> -====
> -
> -ATF, U-boot proper and u-boot.dtb images are packed into FIT image,
> -which is loaded and parsed by SPL.
> -
> -Boot sequence is:
> -SPL ---> ATF (TF-A) ---> U-boot proper
> -
> -Output:
> -U-Boot SPL 2020.01-00187-gd411d164e5 (Jan 26 2020 - 04:47:26 +0100)
> -Normal Boot
> -Trying to boot from MMC1
> -NOTICE:  Configuring TZASC380
> -NOTICE:  RDC off
> -NOTICE:  BL31: v2.0(release):rel_imx_4.14.98_2.3.0-0-g09c5cc994-dirty
> -NOTICE:  BL31: Built : 01:11:41, Jan 25 2020
> -NOTICE:  sip svc init
> -
> -
> -U-Boot 2020.01-00187-gd411d164e5 (Jan 26 2020 - 04:47:26 +0100)
> -
> -CPU:   Freescale i.MX8MMQ rev1.0 at 0 MHz
> -Reset cause: POR
> -DRAM:  2 GiB
> -MMC:   FSL_SDHC: 0, FSL_SDHC: 1, FSL_SDHC: 2
> -Loading Environment from MMC... OK
> -In:    serial
> -Out:   serial
> -Err:   serial
> -Model: Toradex Verdin iMX8M Mini Quad 2GB Wi-Fi / BT IT V1.0A, Serial# 06535149
> -Net:   eth0: ethernet at 30be0000
> -Hit any key to stop autoboot:  0
> -Verdin iMX8MM #
> diff --git a/doc/board/toradex/index.rst b/doc/board/toradex/index.rst
> index aa418d6bad..6cd2ade9f4 100644
> --- a/doc/board/toradex/index.rst
> +++ b/doc/board/toradex/index.rst
> @@ -7,3 +7,4 @@ Toradex
>     :maxdepth: 2
>
>     colibri_imx7
> +   verdin-imx8mm
> diff --git a/doc/board/toradex/verdin-imx8mm.rst b/doc/board/toradex/verdin-imx8mm.rst
> new file mode 100644
> index 0000000000..4ed16fce34
> --- /dev/null
> +++ b/doc/board/toradex/verdin-imx8mm.rst
> @@ -0,0 +1,112 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +Verdin iMX8M Mini Module
> +========================
> +
> +Quick Start
> +-----------
> +
> +- Build the ARM trusted firmware binary
> +- Get the DDR firmware
> +- Build U-Boot
> +- Flash to eMMC
> +- Boot
> +
> +Get and Build the ARM Trusted Firmware (Trusted Firmware A)
> +-----------------------------------------------------------
> +
> +.. code-block:: bash
> +
> +    $ echo "Downloading and building TF-A..."
> +    $ git clone -b imx_4.14.98_2.3.0 \
> +      https://source.codeaurora.org/external/imx/imx-atf
> +    $ cd imx-atf
> +
> +Please edit ``plat/imx/imx8mm/include/platform_def.h`` so it contains proper
> +values for UART configuration and BL31 base address (correct values listed
> +below):
> +
> +.. code-block:: bash
> +
> +    #define BL31_BASE                   0x910000
> +    #define IMX_BOOT_UART_BASE          0x30860000
> +    #define DEBUG_CONSOLE               1
> +
> +Then build ATF (TF-A):
> +
> +.. code-block:: bash
> +
> +    $ make PLAT=imx8mm bl31
> +
> +Get the DDR Firmware
> +--------------------
> +
> +.. code-block:: bash
> +
> +    $ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-8.4.1.bin
> +    $ chmod +x firmware-imx-8.4.1.bin
> +    $ ./firmware-imx-8.4.1.bin
> +    $ cp firmware-imx-8.4.1/firmware/ddr/synopsys/lpddr4*.bin ./
> +
> +Build U-Boot
> +------------
> +.. code-block:: bash
> +
> +    $ export CROSS_COMPILE=aarch64-linux-gnu-
> +    $ make verdin-imx8mm_defconfig
> +    $ make flash.bin
> +
> +Flash to eMMC
> +-------------
> +
> +.. code-block:: bash
> +
> +    > tftpboot ${loadaddr} flash.bin
> +    > 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
> +U-Boot wrapper:
> +
> +.. code-block:: bash
> +
> +    > run update_uboot
> +
> +Boot
> +----
> +
> +ATF, U-boot proper and u-boot.dtb images are packed into FIT image,
> +which is loaded and parsed by SPL.
> +
> +Boot sequence is:
> +
> +* SPL ---> ATF (TF-A) ---> U-boot proper
> +
> +Output:
> +
> +.. code-block:: bash
> +
> +    U-Boot SPL 2020.01-00187-gd411d164e5 (Jan 26 2020 - 04:47:26 +0100)
> +    Normal Boot
> +    Trying to boot from MMC1
> +    NOTICE:  Configuring TZASC380
> +    NOTICE:  RDC off
> +    NOTICE:  BL31: v2.0(release):rel_imx_4.14.98_2.3.0-0-g09c5cc994-dirty
> +    NOTICE:  BL31: Built : 01:11:41, Jan 25 2020
> +    NOTICE:  sip svc init
> +
> +
> +    U-Boot 2020.01-00187-gd411d164e5 (Jan 26 2020 - 04:47:26 +0100)
> +
> +    CPU:   Freescale i.MX8MMQ rev1.0 at 0 MHz
> +    Reset cause: POR
> +    DRAM:  2 GiB
> +    MMC:   FSL_SDHC: 0, FSL_SDHC: 1, FSL_SDHC: 2
> +    Loading Environment from MMC... OK
> +    In:    serial
> +    Out:   serial
> +    Err:   serial
> +    Model: Toradex Verdin iMX8M Mini Quad 2GB Wi-Fi / BT IT V1.0A, Serial:
> +    Net:   eth0: ethernet at 30be0000
> +    Hit any key to stop autoboot:  0
> +    Verdin iMX8MM #
> --
> 2.17.1
>


-- 
Best regards
Oleksandr Suvorov

Toradex AG
Altsagenstrasse 5 | 6048 Horw/Luzern | Switzerland | T: +41 41 500
4800 (main line)

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [PATCH v5 3/6] doc: board: apalis-imx8: convert readme to reST
  2020-02-12 15:14 ` [PATCH v5 3/6] doc: board: apalis-imx8: " Igor Opaniuk
@ 2020-02-12 15:46   ` Oleksandr Suvorov
  2020-02-20 13:35   ` Bin Meng
  1 sibling, 0 replies; 19+ messages in thread
From: Oleksandr Suvorov @ 2020-02-12 15:46 UTC (permalink / raw)
  To: u-boot

On Wed, Feb 12, 2020 at 5:15 PM Igor Opaniuk <igor.opaniuk@gmail.com> wrote:
>
> From: Igor Opaniuk <igor.opaniuk@toradex.com>
>
> Convert README to reStructuredText format.
>
> Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>

Reviewed-by: Oleksandr Suvorov <oleksandr.suvorov@toradex.com>

> ---
>
>  board/toradex/apalis-imx8/README  | 66 -------------------------
>  doc/board/toradex/apalix-imx8.rst | 82 +++++++++++++++++++++++++++++++
>  doc/board/toradex/index.rst       |  1 +
>  3 files changed, 83 insertions(+), 66 deletions(-)
>  delete mode 100644 board/toradex/apalis-imx8/README
>  create mode 100644 doc/board/toradex/apalix-imx8.rst
>
> diff --git a/board/toradex/apalis-imx8/README b/board/toradex/apalis-imx8/README
> deleted file mode 100644
> index e6e3dcb367..0000000000
> --- a/board/toradex/apalis-imx8/README
> +++ /dev/null
> @@ -1,66 +0,0 @@
> -U-Boot for the Toradex Apalis iMX8QM V1.0B Module
> -
> -Quick Start
> -===========
> -
> -- Build the ARM trusted firmware binary
> -- Get scfw_tcm.bin and ahab-container.img
> -- Build U-Boot
> -- Load U-Boot binary using uuu
> -- Flash U-Boot binary into the eMMC
> -- Boot
> -
> -Get and Build the ARM Trusted Firmware
> -======================================
> -
> -$ git clone -b imx_4.14.78_1.0.0_ga https://source.codeaurora.org/external/imx/imx-atf
> -$ cd imx-atf/
> -$ make PLAT=imx8qm bl31
> -
> -Get scfw_tcm.bin and ahab-container.img
> -=======================================
> -
> -$ wget https://github.com/toradex/meta-fsl-bsp-release/blob/toradex-sumo-4.14.78-1.0.0_ga-bringup/imx/meta-bsp/recipes-bsp/imx-sc-firmware/files/mx8qm-apalis-scfw-tcm.bin?raw=true
> -$ mv mx8qm-apalis-scfw-tcm.bin\?raw\=true mx8qm-apalis-scfw-tcm.bin
> -$ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-8.0.bin
> -$ chmod +x firmware-imx-8.0.bin
> -$ ./firmware-imx-8.0.bin
> -
> -Copy the following binaries to the U-Boot folder:
> -
> -$ cp imx-atf/build/imx8qm/release/bl31.bin .
> -$ cp u-boot/u-boot.bin .
> -
> -Copy the following firmware to the U-Boot folder:
> -
> -$ cp firmware-imx-8.0/firmware/seco/ahab-container.img .
> -
> -Build U-Boot
> -============
> -
> -$ make apalis-imx8qm_defconfig
> -$ make u-boot-dtb.imx
> -
> -Load the U-Boot Binary Using UUU
> -================================
> -
> -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%2FNXPmicro%2Fmfgtools%2Freleases
> -
> -Put the module into USB recovery aka serial downloader mode, connect USB device
> -to your host and execute uuu:
> -
> -sudo ./uuu u-boot/u-boot-dtb.imx
> -
> -Flash the U-Boot Binary into the eMMC
> -=====================================
> -
> -Burn the u-boot-dtb.imx binary to the primary eMMC hardware boot area partition:
> -
> -load mmc 1:1 $loadaddr u-boot-dtb.imx
> -setexpr blkcnt ${filesize} + 0x1ff && setexpr blkcnt ${blkcnt} / 0x200
> -mmc dev 0 1
> -mmc write ${loadaddr} 0x0 ${blkcnt}
> -
> -Boot
> diff --git a/doc/board/toradex/apalix-imx8.rst b/doc/board/toradex/apalix-imx8.rst
> new file mode 100644
> index 0000000000..4b7ea65d31
> --- /dev/null
> +++ b/doc/board/toradex/apalix-imx8.rst
> @@ -0,0 +1,82 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +Apalis iMX8QM V1.0B Module
> +==========================
> +
> +Quick Start
> +-----------
> +
> +- Build the ARM trusted firmware binary
> +- Get scfw_tcm.bin and ahab-container.img
> +- Build U-Boot
> +- Load U-Boot binary using uuu
> +- Flash U-Boot binary into the eMMC
> +- Boot
> +
> +Get and Build the ARM Trusted Firmware
> +--------------------------------------
> +
> +.. code-block:: bash
> +
> +    $ git clone -b imx_4.14.78_1.0.0_ga https://source.codeaurora.org/external/imx/imx-atf
> +    $ cd imx-atf/
> +    $ make PLAT=imx8qm bl31
> +
> +Get scfw_tcm.bin and ahab-container.img
> +---------------------------------------
> +
> +.. code-block:: bash
> +
> +    $ wget https://github.com/toradex/meta-fsl-bsp-release/blob/toradex-sumo-4.14.78-1.0.0_ga-bringup/imx/meta-bsp/recipes-
> +      bsp/imx-sc-firmware/files/mx8qm-apalis-scfw-tcm.bin?raw=true
> +    $ mv mx8qm-apalis-scfw-tcm.bin\?raw\=true mx8qm-apalis-scfw-tcm.bin
> +    $ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-8.0.bin
> +    $ chmod +x firmware-imx-8.0.bin
> +    $ ./firmware-imx-8.0.bin
> +
> +Copy the following binaries to the U-Boot folder:
> +
> +.. code-block:: bash
> +
> +    $ cp imx-atf/build/imx8qm/release/bl31.bin .
> +    $ cp u-boot/u-boot.bin .
> +
> +Copy the following firmware to the U-Boot folder:
> +
> +.. code-block:: bash
> +
> +    $ cp firmware-imx-8.0/firmware/seco/ahab-container.img .
> +
> +Build U-Boot
> +------------
> +.. code-block:: bash
> +
> +    $ make apalis-imx8qm_defconfig
> +    $ make u-boot-dtb.imx
> +
> +Load the U-Boot Binary Using UUU
> +--------------------------------
> +
> +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%2FNXPmicro%2Fmfgtools%2Freleases
> +
> +Put the module into USB recovery aka serial downloader mode, connect USB device
> +to your host and execute uuu:
> +
> +.. code-block:: bash
> +
> +    sudo ./uuu u-boot/u-boot-dtb.imx
> +
> +Flash the U-Boot Binary into the eMMC
> +-------------------------------------
> +
> +Burn the ``u-boot-dtb.imx`` binary to the primary eMMC hardware boot area
> +partition and boot:
> +
> +.. code-block:: bash
> +
> +    load mmc 1:1 $loadaddr u-boot-dtb.imx
> +    setexpr blkcnt ${filesize} + 0x1ff && setexpr blkcnt ${blkcnt} / 0x200
> +    mmc dev 0 1
> +    mmc write ${loadaddr} 0x0 ${blkcnt}
> diff --git a/doc/board/toradex/index.rst b/doc/board/toradex/index.rst
> index 6cd2ade9f4..da65ad2408 100644
> --- a/doc/board/toradex/index.rst
> +++ b/doc/board/toradex/index.rst
> @@ -6,5 +6,6 @@ Toradex
>  .. toctree::
>     :maxdepth: 2
>
> +   apalix-imx8
>     colibri_imx7
>     verdin-imx8mm
> --
> 2.17.1
>


-- 
Best regards
Oleksandr Suvorov

Toradex AG
Altsagenstrasse 5 | 6048 Horw/Luzern | Switzerland | T: +41 41 500
4800 (main line)

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [PATCH v5 6/6] doc: board: add rockchip subfolder
  2020-02-12 15:14 ` [PATCH v5 6/6] doc: board: add rockchip subfolder Igor Opaniuk
@ 2020-02-12 15:48   ` Oleksandr Suvorov
  2020-02-20 13:14   ` Bin Meng
  1 sibling, 0 replies; 19+ messages in thread
From: Oleksandr Suvorov @ 2020-02-12 15:48 UTC (permalink / raw)
  To: u-boot

On Wed, Feb 12, 2020 at 5:15 PM Igor Opaniuk <igor.opaniuk@gmail.com> wrote:
>
> From: Igor Opaniuk <igor.opaniuk@toradex.com>
>
> This fixes a warning when invoking make htmldocs:
> checking consistency...
> doc/board/rockchip/index.rst: WARNING: document isn't included in any toctree
>
> Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>
> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Reviewed-by: Oleksandr Suvorov <oleksandr.suvorov@toradex.com>
> ---
>
>  doc/board/index.rst | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/doc/board/index.rst b/doc/board/index.rst
> index f2f5907b8c..f061e8ecfc 100644
> --- a/doc/board/index.rst
> +++ b/doc/board/index.rst
> @@ -14,6 +14,7 @@ Board-specific doc
>     google/index
>     intel/index
>     renesas/index
> +   rockchip/index
>     sifive/index
>     toradex/index
>     xilinx/index
> --
> 2.17.1
>


-- 
Best regards
Oleksandr Suvorov

Toradex AG
Altsagenstrasse 5 | 6048 Horw/Luzern | Switzerland | T: +41 41 500
4800 (main line)

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [PATCH v5 4/6] doc: board: colibri-imx8x: convert readme to reST
  2020-02-12 15:14 ` [PATCH v5 4/6] doc: board: colibri-imx8x: " Igor Opaniuk
@ 2020-02-13 10:10   ` Oleksandr Suvorov
  2020-02-20 13:37   ` Bin Meng
  1 sibling, 0 replies; 19+ messages in thread
From: Oleksandr Suvorov @ 2020-02-13 10:10 UTC (permalink / raw)
  To: u-boot

On Wed, Feb 12, 2020 at 5:15 PM Igor Opaniuk <igor.opaniuk@gmail.com> wrote:
>
> From: Igor Opaniuk <igor.opaniuk@toradex.com>
>
> Convert README to reStructuredText format.
>
> Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>

Reviewed-by: Oleksandr Suvorov <oleksandr.suvorov@toradex.com>

> ---
>
>  board/toradex/colibri-imx8x/README  | 66 -----------------------
>  doc/board/toradex/colibri-imx8x.rst | 82 +++++++++++++++++++++++++++++
>  doc/board/toradex/index.rst         |  1 +
>  3 files changed, 83 insertions(+), 66 deletions(-)
>  delete mode 100644 board/toradex/colibri-imx8x/README
>  create mode 100644 doc/board/toradex/colibri-imx8x.rst
>
> diff --git a/board/toradex/colibri-imx8x/README b/board/toradex/colibri-imx8x/README
> deleted file mode 100644
> index 708bb3e51c..0000000000
> --- a/board/toradex/colibri-imx8x/README
> +++ /dev/null
> @@ -1,66 +0,0 @@
> -U-Boot for the Toradex Colibri iMX8QXP V1.0B Module
> -
> -Quick Start
> -===========
> -
> -- Build the ARM trusted firmware binary
> -- Get scfw_tcm.bin and ahab-container.img
> -- Build U-Boot
> -- Load U-Boot binary using uuu
> -- Flash U-Boot binary into the eMMC
> -- Boot
> -
> -Get and Build the ARM Trusted Firmware
> -======================================
> -
> -$ git clone -b imx_4.14.78_1.0.0_ga https://source.codeaurora.org/external/imx/imx-atf
> -$ cd imx-atf/
> -$ make PLAT=imx8qxp bl31
> -
> -Get scfw_tcm.bin and ahab-container.img
> -=======================================
> -
> -$ wget https://github.com/toradex/meta-fsl-bsp-release/blob/toradex-sumo-4.14.78-1.0.0_ga-bringup/imx/meta-bsp/recipes-bsp/imx-sc-firmware/files/mx8qx-colibri-scfw-tcm.bin?raw=true
> -$ mv mx8qx-colibri-scfw-tcm.bin\?raw\=true mx8qx-colibri-scfw-tcm.bin
> -$ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-8.0.bin
> -$ chmod +x firmware-imx-8.0.bin
> -$ ./firmware-imx-8.0.bin
> -
> -Copy the following binaries to the U-Boot folder:
> -
> -$ cp imx-atf/build/imx8qxp/release/bl31.bin .
> -$ cp u-boot/u-boot.bin .
> -
> -Copy the following firmware to the U-Boot folder:
> -
> -$ cp firmware-imx-8.0/firmware/seco/ahab-container.img .
> -
> -Build U-Boot
> -============
> -
> -$ make colibri-imx8qxp_defconfig
> -$ make u-boot-dtb.imx
> -
> -Load the U-Boot Binary Using UUU
> -================================
> -
> -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%2FNXPmicro%2Fmfgtools%2Freleases
> -
> -Put the module into USB recovery aka serial downloader mode, connect USB device
> -to your host and execute uuu:
> -
> -sudo ./uuu u-boot/u-boot-dtb.imx
> -
> -Flash the U-Boot Binary into the eMMC
> -=====================================
> -
> -Burn the u-boot-dtb.imx binary to the primary eMMC hardware boot area partition:
> -
> -load mmc 1:1 $loadaddr u-boot-dtb.imx
> -setexpr blkcnt ${filesize} + 0x1ff && setexpr blkcnt ${blkcnt} / 0x200
> -mmc dev 0 1
> -mmc write ${loadaddr} 0x0 ${blkcnt}
> -
> -Boot
> diff --git a/doc/board/toradex/colibri-imx8x.rst b/doc/board/toradex/colibri-imx8x.rst
> new file mode 100644
> index 0000000000..244e5a4c04
> --- /dev/null
> +++ b/doc/board/toradex/colibri-imx8x.rst
> @@ -0,0 +1,82 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +Colibri iMX8QXP V1.0B Module
> +============================
> +
> +Quick Start
> +-----------
> +
> +- Build the ARM trusted firmware binary
> +- Get scfw_tcm.bin and ahab-container.img
> +- Build U-Boot
> +- Load U-Boot binary using uuu
> +- Flash U-Boot binary into the eMMC
> +- Boot
> +
> +Get and Build the ARM Trusted Firmware
> +--------------------------------------
> +
> +.. code-block:: bash
> +
> +    $ git clone -b imx_4.14.78_1.0.0_ga https://source.codeaurora.org/external/imx/imx-atf
> +    $ cd imx-atf/
> +    $ make PLAT=imx8qxp bl31
> +
> +Get scfw_tcm.bin and ahab-container.img
> +---------------------------------------
> +.. code-block:: bash
> +
> +    $ wget https://github.com/toradex/meta-fsl-bsp-release/blob/
> +           toradex-sumo-4.14.78-1.0.0_ga-bringup/imx/meta-bsp/recipes-
> +           bsp/imx-sc-firmware/files/mx8qx-colibri-scfw-tcm.bin?raw=true
> +    $ mv mx8qx-colibri-scfw-tcm.bin\?raw\=true mx8qx-colibri-scfw-tcm.bin
> +    $ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-8.0.bin
> +    $ chmod +x firmware-imx-8.0.bin
> +    $ ./firmware-imx-8.0.bin
> +
> +Copy the following binaries to the U-Boot folder:
> +
> +.. code-block:: bash
> +
> +    $ cp imx-atf/build/imx8qxp/release/bl31.bin .
> +    $ cp u-boot/u-boot.bin .
> +
> +Copy the following firmware to the U-Boot folder:
> +
> +.. code-block:: bash
> +
> +    $ cp firmware-imx-8.0/firmware/seco/ahab-container.img .
> +
> +Build U-Boot
> +------------
> +
> +.. code-block:: bash
> +
> +   $ make colibri-imx8qxp_defconfig
> +   $ make u-boot-dtb.imx
> +
> +Load the U-Boot Binary Using UUU
> +--------------------------------
> +
> +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%2FNXPmicro%2Fmfgtools%2Freleases
> +
> +Put the module into USB recovery aka serial downloader mode, connect USB device
> +to your host and execute ``uuu``:
> +
> +.. code-block:: bash
> +
> +    sudo ./uuu u-boot/u-boot-dtb.imx
> +
> +Flash the U-Boot Binary into the eMMC
> +-------------------------------------
> +
> +Burn the ``u-boot-dtb.imx`` binary to the primary eMMC hardware boot area partition:
> +
> +.. code-block:: bash
> +
> +    load mmc 1:1 $loadaddr u-boot-dtb.imx
> +    setexpr blkcnt ${filesize} + 0x1ff && setexpr blkcnt ${blkcnt} / 0x200
> +    mmc dev 0 1
> +    mmc write ${loadaddr} 0x0 ${blkcnt}
> diff --git a/doc/board/toradex/index.rst b/doc/board/toradex/index.rst
> index da65ad2408..16b5a0770d 100644
> --- a/doc/board/toradex/index.rst
> +++ b/doc/board/toradex/index.rst
> @@ -8,4 +8,5 @@ Toradex
>
>     apalix-imx8
>     colibri_imx7
> +   colibri-imx8x
>     verdin-imx8mm
> --
> 2.17.1
>


--
Best regards
Oleksandr Suvorov

Toradex AG
Altsagenstrasse 5 | 6048 Horw/Luzern | Switzerland | T: +41 41 500
4800 (main line)

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [PATCH v5 6/6] doc: board: add rockchip subfolder
  2020-02-12 15:14 ` [PATCH v5 6/6] doc: board: add rockchip subfolder Igor Opaniuk
  2020-02-12 15:48   ` Oleksandr Suvorov
@ 2020-02-20 13:14   ` Bin Meng
  1 sibling, 0 replies; 19+ messages in thread
From: Bin Meng @ 2020-02-20 13:14 UTC (permalink / raw)
  To: u-boot

On Wed, Feb 12, 2020 at 11:14 PM Igor Opaniuk <igor.opaniuk@gmail.com> wrote:
>
> From: Igor Opaniuk <igor.opaniuk@toradex.com>
>
> This fixes a warning when invoking make htmldocs:
> checking consistency...
> doc/board/rockchip/index.rst: WARNING: document isn't included in any toctree
>
> Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>
> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> ---
>
>  doc/board/index.rst | 1 +
>  1 file changed, 1 insertion(+)
>

This patch does not apply as there is one already in the mainline.
Heinrich did the same below, but not sure how he gave a RB tag to this
one as well :)

Will drop this patch.

commit 7d92204bc0eb0a775810f887838a93a218a22f96
Author: Heinrich Schuchardt <xypron.glpk@gmx.de>
Date:   Fri Feb 7 21:25:09 2020 +0100

    doc: board: add Rockchip to doc/board/index.rst

    Fix a build error

Regards,
Bin

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [PATCH v5 5/6] toradex: MAINTAINERS: entries for new reST docs
  2020-02-12 15:14 ` [PATCH v5 5/6] toradex: MAINTAINERS: entries for new reST docs Igor Opaniuk
@ 2020-02-20 13:19   ` Bin Meng
  0 siblings, 0 replies; 19+ messages in thread
From: Bin Meng @ 2020-02-20 13:19 UTC (permalink / raw)
  To: u-boot

On Wed, Feb 12, 2020 at 11:14 PM Igor Opaniuk <igor.opaniuk@gmail.com> wrote:
>
> From: Igor Opaniuk <igor.opaniuk@toradex.com>
>
> Add entries for the newly created documentation files in reST
> format.
>
> Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>
> ---
>
>  board/toradex/apalis-imx8/MAINTAINERS   | 1 +
>  board/toradex/colibri-imx8x/MAINTAINERS | 1 +
>  board/toradex/colibri_imx7/MAINTAINERS  | 1 +
>  board/toradex/verdin-imx8mm/MAINTAINERS | 1 +
>  4 files changed, 4 insertions(+)
>

Reviewed-by: Bin Meng <bmeng.cn@gmail.com>

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [PATCH v5 2/6] doc: board: verdin-imx8mm: convert readme to reST
  2020-02-12 15:14 ` [PATCH v5 2/6] doc: board: verdin-imx8mm: convert readme to reST Igor Opaniuk
  2020-02-12 15:46   ` Oleksandr Suvorov
@ 2020-02-20 13:24   ` Bin Meng
  1 sibling, 0 replies; 19+ messages in thread
From: Bin Meng @ 2020-02-20 13:24 UTC (permalink / raw)
  To: u-boot

On Wed, Feb 12, 2020 at 11:14 PM Igor Opaniuk <igor.opaniuk@gmail.com> wrote:
>
> From: Igor Opaniuk <igor.opaniuk@toradex.com>
>
> Convert README to reStructuredText format.
>
> Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>
> ---
>
>  board/toradex/verdin-imx8mm/README  |  88 ----------------------
>  doc/board/toradex/index.rst         |   1 +
>  doc/board/toradex/verdin-imx8mm.rst | 112 ++++++++++++++++++++++++++++
>  3 files changed, 113 insertions(+), 88 deletions(-)
>  delete mode 100644 board/toradex/verdin-imx8mm/README
>  create mode 100644 doc/board/toradex/verdin-imx8mm.rst
>
> diff --git a/board/toradex/verdin-imx8mm/README b/board/toradex/verdin-imx8mm/README
> deleted file mode 100644
> index 1dac969476..0000000000
> --- a/board/toradex/verdin-imx8mm/README
> +++ /dev/null
> @@ -1,88 +0,0 @@
> -U-Boot for the Toradex Verdin iMX8M Mini Module
> -
> -Quick Start
> -===========
> -
> -- Build the ARM trusted firmware binary
> -- Get the DDR firmware
> -- Build U-Boot
> -- Flash to eMMC
> -- Boot
> -
> -Get and Build the ARM Trusted Firmware (Trusted Firmware A)
> -===========================================================
> -
> -$ echo "Downloading and building TF-A..."
> -$ git clone -b imx_4.14.98_2.3.0 https://source.codeaurora.org/external/imx/imx-atf
> -$ cd imx-atf
> -
> -Please edit `plat/imx/imx8mm/include/platform_def.h` so it contains proper
> -values for UART configuration and BL31 base address (correct values listed
> -below):
> -#define BL31_BASE              0x910000
> -#define IMX_BOOT_UART_BASE     0x30860000
> -#define DEBUG_CONSOLE          1
> -
> -Then build ATF (TF-A):
> -$ make PLAT=imx8mm bl31
> -
> -Get the DDR Firmware
> -====================
> -
> -$ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-8.4.1.bin
> -$ chmod +x firmware-imx-8.4.1.bin
> -$ ./firmware-imx-8.4.1.bin
> -$ cp firmware-imx-8.4.1/firmware/ddr/synopsys/lpddr4*.bin ./
> -
> -Build U-Boot
> -============
> -
> -$ export CROSS_COMPILE=aarch64-linux-gnu-
> -$ make verdin-imx8mm_defconfig
> -$ make flash.bin
> -
> -Flash to eMMC
> -=============
> -
> -> tftpboot ${loadaddr} flash.bin
> -> 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
> -U-Boot wrapper:
> -> run update_uboot
> -
> -Boot
> -====
> -
> -ATF, U-boot proper and u-boot.dtb images are packed into FIT image,

nits: U-Boot

> -which is loaded and parsed by SPL.
> -
> -Boot sequence is:
> -SPL ---> ATF (TF-A) ---> U-boot proper

nits: U-Boot

> -
> -Output:

Reviewed-by: Bin Meng <bmeng.cn@gmail.com>

Will fix the nits when applying

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [PATCH v5 1/6] doc: board: toradex: add colibri_imx7.rst
  2020-02-12 15:14 ` [PATCH v5 1/6] doc: board: toradex: add colibri_imx7.rst Igor Opaniuk
  2020-02-12 15:45   ` Oleksandr Suvorov
@ 2020-02-20 13:26   ` Bin Meng
  1 sibling, 0 replies; 19+ messages in thread
From: Bin Meng @ 2020-02-20 13:26 UTC (permalink / raw)
  To: u-boot

On Wed, Feb 12, 2020 at 11:14 PM Igor Opaniuk <igor.opaniuk@gmail.com> wrote:
>
> From: Igor Opaniuk <igor.opaniuk@toradex.com>
>
> - add initial index for toradex boards reST documentation
> - add initial colibri_imx7.rst doc file which provides all needed
> information for obtaining a workable image ready for flashing
> for both eMMC/NAND versions of Colibri iMX7.
>
> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
> Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>
> ---
>
>  doc/board/index.rst                |   1 +
>  doc/board/toradex/colibri_imx7.rst | 127 +++++++++++++++++++++++++++++
>  doc/board/toradex/index.rst        |   9 ++
>  3 files changed, 137 insertions(+)
>  create mode 100644 doc/board/toradex/colibri_imx7.rst
>  create mode 100644 doc/board/toradex/index.rst
>
> diff --git a/doc/board/index.rst b/doc/board/index.rst
> index 00e72f57cd..f2f5907b8c 100644
> --- a/doc/board/index.rst
> +++ b/doc/board/index.rst
> @@ -15,4 +15,5 @@ Board-specific doc
>     intel/index
>     renesas/index
>     sifive/index
> +   toradex/index
>     xilinx/index
> diff --git a/doc/board/toradex/colibri_imx7.rst b/doc/board/toradex/colibri_imx7.rst
> new file mode 100644
> index 0000000000..0c7ae082d0
> --- /dev/null
> +++ b/doc/board/toradex/colibri_imx7.rst
> @@ -0,0 +1,127 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +Colibri iMX7
> +============
> +
> +Quick Start
> +-----------
> +
> +- Build U-Boot
> +- NAND IMX image adjustments before flashing
> +- Flashing manually U-Boot to eMMC
> +- Flashing manually U-Boot to NAND
> +- Using ``update_uboot`` script
> +
> +Build U-Boot
> +------------
> +
> +.. code-block:: bash
> +
> +    $ export CROSS_COMPILE=arm-linux-gnueabi-
> +    $ export ARCH=arm
> +    $ 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
> +adjustments).
> +
> +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
> +* **Boot data** -indicates the program image location, program image size
> +  in bytes, and the plugin flag.
> +* **Device configuration data**
> +* **User image**: U-Boot image (``u-boot-dtb.bin``)
> +
> +
> +IMX image adjustments prior to flashing
> +--------------------------------------------

nits: title underline length should match the title

> +
> +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
> +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.
> +To obtain this value, run:
> +

Will fix the nits when applying.

Tested the doc build, no warnings
Tested-by: Bin Meng <bmeng.cn@gmail.com>

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [PATCH v5 3/6] doc: board: apalis-imx8: convert readme to reST
  2020-02-12 15:14 ` [PATCH v5 3/6] doc: board: apalis-imx8: " Igor Opaniuk
  2020-02-12 15:46   ` Oleksandr Suvorov
@ 2020-02-20 13:35   ` Bin Meng
  1 sibling, 0 replies; 19+ messages in thread
From: Bin Meng @ 2020-02-20 13:35 UTC (permalink / raw)
  To: u-boot

On Wed, Feb 12, 2020 at 11:14 PM Igor Opaniuk <igor.opaniuk@gmail.com> wrote:
>
> From: Igor Opaniuk <igor.opaniuk@toradex.com>
>
> Convert README to reStructuredText format.
>
> Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>
> ---
>
>  board/toradex/apalis-imx8/README  | 66 -------------------------
>  doc/board/toradex/apalix-imx8.rst | 82 +++++++++++++++++++++++++++++++
>  doc/board/toradex/index.rst       |  1 +
>  3 files changed, 83 insertions(+), 66 deletions(-)
>  delete mode 100644 board/toradex/apalis-imx8/README
>  create mode 100644 doc/board/toradex/apalix-imx8.rst
>

Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
Tested-by: Bin Meng <bmeng.cn@gmail.com>

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [PATCH v5 4/6] doc: board: colibri-imx8x: convert readme to reST
  2020-02-12 15:14 ` [PATCH v5 4/6] doc: board: colibri-imx8x: " Igor Opaniuk
  2020-02-13 10:10   ` Oleksandr Suvorov
@ 2020-02-20 13:37   ` Bin Meng
  1 sibling, 0 replies; 19+ messages in thread
From: Bin Meng @ 2020-02-20 13:37 UTC (permalink / raw)
  To: u-boot

On Wed, Feb 12, 2020 at 11:14 PM Igor Opaniuk <igor.opaniuk@gmail.com> wrote:
>
> From: Igor Opaniuk <igor.opaniuk@toradex.com>
>
> Convert README to reStructuredText format.
>
> Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>
> ---
>
>  board/toradex/colibri-imx8x/README  | 66 -----------------------
>  doc/board/toradex/colibri-imx8x.rst | 82 +++++++++++++++++++++++++++++
>  doc/board/toradex/index.rst         |  1 +
>  3 files changed, 83 insertions(+), 66 deletions(-)
>  delete mode 100644 board/toradex/colibri-imx8x/README
>  create mode 100644 doc/board/toradex/colibri-imx8x.rst
>

Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
Tested-by: Bin Meng <bmeng.cn@gmail.com>

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [PATCH v5 0/6] doc: board: toradex reST documentation
  2020-02-12 15:14 [PATCH v5 0/6] doc: board: toradex reST documentation Igor Opaniuk
                   ` (5 preceding siblings ...)
  2020-02-12 15:14 ` [PATCH v5 6/6] doc: board: add rockchip subfolder Igor Opaniuk
@ 2020-02-20 13:39 ` Bin Meng
  6 siblings, 0 replies; 19+ messages in thread
From: Bin Meng @ 2020-02-20 13:39 UTC (permalink / raw)
  To: u-boot

On Wed, Feb 12, 2020 at 11:14 PM Igor Opaniuk <igor.opaniuk@gmail.com> wrote:
>
> This patch-series adds/converts existing README files for Toradex modules
> to reStructureFormat.
>
> To verify please run:
> $ make htmldocs
>
> v5:
> - Fixed markup for headers [Bin Meng]
> - Applied R-b tag for colibri_imx7.rst [Bin Beng]
>

This was assigned to me on patchwork, so

series applied to u-boot-x86, thanks!

^ permalink raw reply	[flat|nested] 19+ messages in thread

end of thread, other threads:[~2020-02-20 13:39 UTC | newest]

Thread overview: 19+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-02-12 15:14 [PATCH v5 0/6] doc: board: toradex reST documentation Igor Opaniuk
2020-02-12 15:14 ` [PATCH v5 1/6] doc: board: toradex: add colibri_imx7.rst Igor Opaniuk
2020-02-12 15:45   ` Oleksandr Suvorov
2020-02-20 13:26   ` Bin Meng
2020-02-12 15:14 ` [PATCH v5 2/6] doc: board: verdin-imx8mm: convert readme to reST Igor Opaniuk
2020-02-12 15:46   ` Oleksandr Suvorov
2020-02-20 13:24   ` Bin Meng
2020-02-12 15:14 ` [PATCH v5 3/6] doc: board: apalis-imx8: " Igor Opaniuk
2020-02-12 15:46   ` Oleksandr Suvorov
2020-02-20 13:35   ` Bin Meng
2020-02-12 15:14 ` [PATCH v5 4/6] doc: board: colibri-imx8x: " Igor Opaniuk
2020-02-13 10:10   ` Oleksandr Suvorov
2020-02-20 13:37   ` Bin Meng
2020-02-12 15:14 ` [PATCH v5 5/6] toradex: MAINTAINERS: entries for new reST docs Igor Opaniuk
2020-02-20 13:19   ` Bin Meng
2020-02-12 15:14 ` [PATCH v5 6/6] doc: board: add rockchip subfolder Igor Opaniuk
2020-02-12 15:48   ` Oleksandr Suvorov
2020-02-20 13:14   ` Bin Meng
2020-02-20 13:39 ` [PATCH v5 0/6] doc: board: toradex reST documentation Bin Meng

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox