diff mbox series

[v1] doc: board: colibri-imx8x: Update and improve documentation

Message ID 20240315143930.29155-1-hiagofranco@gmail.com
State Superseded
Delegated to: Heinrich Schuchardt
Headers show
Series [v1] doc: board: colibri-imx8x: Update and improve documentation | expand

Commit Message

Hiago De Franco March 15, 2024, 2:39 p.m. UTC
From: Hiago De Franco <hiago.franco@toradex.com>

Update and improve the building documentation of Colibri iMX8X.
The following changes were made:
- imx-atf repository changed to nxp-imx GitHub.
- imx-atf branch updated to 'lf_v2.6'.
- imx-seco updated to version 5.8.7.
- nxp-imx mfgtools link updated to GitHub releases.
- General writing improvements.

Signed-off-by: Hiago De Franco <hiago.franco@toradex.com>
---
 doc/board/toradex/colibri-imx8x.rst | 23 ++++++++++++++++-------
 1 file changed, 16 insertions(+), 7 deletions(-)

Comments

Francesco Dolcini March 15, 2024, 3:35 p.m. UTC | #1
On Fri, Mar 15, 2024 at 11:39:30AM -0300, Hiago De Franco wrote:
> From: Hiago De Franco <hiago.franco@toradex.com>
> 
> Update and improve the building documentation of Colibri iMX8X.
> The following changes were made:
> - imx-atf repository changed to nxp-imx GitHub.
> - imx-atf branch updated to 'lf_v2.6'.
> - imx-seco updated to version 5.8.7.
> - nxp-imx mfgtools link updated to GitHub releases.
> - General writing improvements.
> 
> Signed-off-by: Hiago De Franco <hiago.franco@toradex.com>

Reviewed-by: Francesco Dolcini <francesco.dolcini@toradex.com>

Francesco
Fabio Estevam March 15, 2024, 8:39 p.m. UTC | #2
Hi Hiago,

On Fri, Mar 15, 2024 at 11:39 AM Hiago De Franco <hiagofranco@gmail.com> wrote:
>
> From: Hiago De Franco <hiago.franco@toradex.com>
>
> Update and improve the building documentation of Colibri iMX8X.
> The following changes were made:
> - imx-atf repository changed to nxp-imx GitHub.
> - imx-atf branch updated to 'lf_v2.6'.
> - imx-seco updated to version 5.8.7.
> - nxp-imx mfgtools link updated to GitHub releases.
> - General writing improvements.

Thanks for improving the documentation.

One minor suggestion.

I have recently followed this document and noticed that the
instruction to copy the
mx8qm-apalis-scfw-tcm.bin to the U-Boot source is missing. Please add it.

Also, since you are updating several components, shouldn't
mx8qm-apalis-scfw-tcm.bin be updated?

Currently, the version is from toradex-sumo-4.14.78-1.0.0_ga-bringup
which looks quite ancient.
Hiago De Franco March 15, 2024, 9:16 p.m. UTC | #3
Hello Fabio,

On Fri, Mar 15, 2024 at 05:39:43PM -0300, Fabio Estevam wrote:
> Hi Hiago,
> 
> On Fri, Mar 15, 2024 at 11:39 AM Hiago De Franco <hiagofranco@gmail.com> wrote:
> >
> > From: Hiago De Franco <hiago.franco@toradex.com>
> >
> > Update and improve the building documentation of Colibri iMX8X.
> > The following changes were made:
> > - imx-atf repository changed to nxp-imx GitHub.
> > - imx-atf branch updated to 'lf_v2.6'.
> > - imx-seco updated to version 5.8.7.
> > - nxp-imx mfgtools link updated to GitHub releases.
> > - General writing improvements.
> 
> Thanks for improving the documentation.
> 
> One minor suggestion.
> 
> I have recently followed this document and noticed that the
> instruction to copy the
> mx8qm-apalis-scfw-tcm.bin to the U-Boot source is missing. Please add it.
> 
> Also, since you are updating several components, shouldn't
> mx8qm-apalis-scfw-tcm.bin be updated?
> 
> Currently, the version is from toradex-sumo-4.14.78-1.0.0_ga-bringup
> which looks quite ancient.

Sure, I will prepare a v2 and also include changes for Apalis iMX8.
Please note that I didn't do it now because I only changed Colibri iMX8X
documentation, but since they are very similar, I will do a v2 with your
suggestion.

Thanks,

Hiago.
diff mbox series

Patch

diff --git a/doc/board/toradex/colibri-imx8x.rst b/doc/board/toradex/colibri-imx8x.rst
index 9e61d98c6b1f..378b259abd05 100644
--- a/doc/board/toradex/colibri-imx8x.rst
+++ b/doc/board/toradex/colibri-imx8x.rst
@@ -20,26 +20,35 @@  Quick Start
 Get and Build the ARM Trusted Firmware
 --------------------------------------
 
+Download the imx-atf repository:
+
+.. code-block:: bash
+
+    $ git clone -b lf_v2.6 https://github.com/nxp-imx/imx-atf.git
+
+Compile it with an aarch64 toolchain:
+
 .. code-block:: bash
 
-    $ git clone -b toradex_imx_5.4.70_2.3.0 http://git.toradex.com/cgit/imx-atf.git/
     $ make PLAT=imx8qx bl31 -C imx-atf
 
 Get scfw_tcm.bin and ahab-container.img
 ---------------------------------------
 
+Download imx-seco firmware and extract it:
+
 .. 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.8.1.bin
-    $ sh imx-seco-3.8.1.bin --auto-accept
+    $ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/imx-seco-5.8.7.bin
+    $ sh imx-seco-5.8.7.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.8.1/firmware/seco/mx8qxc0-ahab-container.img mx8qx-ahab-container.img
+    $ 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
+    $ cp ../imx-atf/build/imx8qx/release/bl31.bin .
+    $ cp ../imx-seco-5.8.7/firmware/seco/mx8qxc0-ahab-container.img mx8qx-ahab-container.img
 
 Build U-Boot
 ------------
@@ -54,7 +63,7 @@  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
+https://github.com/nxp-imx/mfgtools/releases
 
 Put the module into USB recovery aka serial downloader mode, connect the USB
 device to your host and execute ``uuu``: