[v5,3/6] doc: board: apalis-imx8: convert readme to reST
diff mbox series

Message ID 20200212151433.9713-4-igor.opaniuk@gmail.com
State Accepted
Delegated to: Bin Meng
Headers show
Series
  • doc: board: toradex reST documentation
Related show

Commit Message

Igor Opaniuk Feb. 12, 2020, 3:14 p.m. UTC
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

Comments

Oleksandr Suvorov Feb. 12, 2020, 3:46 p.m. UTC | #1
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
>
Bin Meng Feb. 20, 2020, 1:35 p.m. UTC | #2
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>

Patch
diff mbox series

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