[PATCH v1] doc: board: imx8qm-rom7720-a1.rst: convert readme to reST

Mon Dec 7 08:54:05 CET 2020

Hi Oliver,

On 20.11.20 15:05, Oliver Graute wrote:
> Convert README to reStructuredText format.
> 
> Signed-off-by: Oliver Graute <oliver.graute at kococonnector.com>
> ---
>   board/advantech/imx8qm_rom7720_a1/README  | 61 ------------------
>   doc/board/advantech/imx8qm-rom7720-a1.rst | 75 +++++++++++++++++++++++
>   doc/board/advantech/index.rst             |  9 +++

The entry in doc/board/index.rst is missing, I add it myself while merging.

diff --git a/doc/board/index.rst b/doc/board/index.rst
index 4b6a996eb1..915f1be8a5 100644
--- a/doc/board/index.rst
+++ b/doc/board/index.rst
@@ -7,6 +7,7 @@ Board-specific doc
     :maxdepth: 2

     actions/index
+   advantech/index
     AndesTech/index
     amlogic/index
     atmel/index

Best regards,
Stefano

>   3 files changed, 84 insertions(+), 61 deletions(-)
>   delete mode 100644 board/advantech/imx8qm_rom7720_a1/README
>   create mode 100644 doc/board/advantech/imx8qm-rom7720-a1.rst
>   create mode 100644 doc/board/advantech/index.rst
> 
> diff --git a/board/advantech/imx8qm_rom7720_a1/README b/board/advantech/imx8qm_rom7720_a1/README
> deleted file mode 100644
> index 585fde440d..0000000000
> --- a/board/advantech/imx8qm_rom7720_a1/README
> +++ /dev/null
> @@ -1,61 +0,0 @@
> -U-Boot for the NXP i.MX8QM ROM 7720a1 board
> -
> -Quick Start
> -===========
> -
> -- Build the ARM Trusted firmware binary
> -- Get scfw_tcm.bin and ahab-container.img
> -- Get imx-mkimage
> -- Build U-Boot
> -- Build imx-mkimage
> -- Flash the binary into the SD card
> -- Boot
> -
> -Get and Build the ARM Trusted firmware
> -======================================
> -
> -$ git clone https://source.codeaurora.org/external/imx/imx-atf
> -$ cd imx-atf/
> -$ git checkout origin/imx_4.14.78_1.0.0_ga -b imx_4.14.78_1.0.0_ga
> -$ make PLAT=imx8qm bl31
> -
> -Get scfw_tcm.bin and ahab-container.img
> -==============================
> -
> -$ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/imx-sc-firmware-1.1.bin
> -$ chmod +x imx-sc-firmware-1.1.bin
> -$ ./imx-sc-firmware-1.1.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
> -
> -Or use this to avoid running random scripts from the internet,
> -but note that you must agree to the license the script displays:
> -
> -$ dd if=imx-sc-firmware-1.1.bin of=imx-sc-firmware-1.1.tar.bz2 bs=37185 skip=1
> -$ tar -xf imx-sc-firmware-1.1.tar.bz2
> -$ cp imx-sc-firmware-1.1/mx8qm-val-scfw-tcm.bin $(builddir)
> -
> -$ dd if=firmware-imx-8.0.bin of=firmware-imx-8.0.tar.bz2 bs=37180 skip=1
> -$ tar -xf firmware-imx-8.0.tar.bz2
> -$ cp firmware-imx-8.0/firmware/seco/mx8qm-ahab-container.img $(builddir)
> -
> -Build U-Boot
> -============
> -
> -$ export ATF_LOAD_ADDR=0x80000000
> -$ export BL33_LOAD_ADDR=0x80020000
> -$ make imx8qm_rom7720_a1_4G_defconfig
> -$ make u-boot.bin
> -$ make flash.bin
> -
> -Flash the binary into the SD card
> -=================================
> -
> -Burn the flash.bin binary to SD card offset 32KB:
> -
> -$ sudo dd if=flash.bin of=/dev/sd[x] bs=1k seek=32 conv=fsync
> -
> -Boot
> -====
> -Set Boot switch SW2: 1100.
> diff --git a/doc/board/advantech/imx8qm-rom7720-a1.rst b/doc/board/advantech/imx8qm-rom7720-a1.rst
> new file mode 100644
> index 0000000000..bd4be1dbeb
> --- /dev/null
> +++ b/doc/board/advantech/imx8qm-rom7720-a1.rst
> @@ -0,0 +1,75 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +U-Boot for the NXP i.MX8QM ROM 7720a1 board
> +===========================================
> +
> +Quick Start
> +-----------
> +
> +- Build the ARM Trusted firmware binary
> +- Get scfw_tcm.bin and ahab-container.img
> +- Get imx-mkimage
> +- Build U-Boot
> +- Build imx-mkimage
> +- Flash the binary into the SD card
> +- Boot
> +
> +Get and Build the ARM Trusted firmware
> +--------------------------------------
> +
> +.. code-block:: bash
> +
> +     $ git clone https://source.codeaurora.org/external/imx/imx-atf
> +     $ cd imx-atf/
> +     $ git checkout origin/imx_4.14.78_1.0.0_ga -b imx_4.14.78_1.0.0_ga
> +     $ make PLAT=imx8qm bl31
> +
> +Get scfw_tcm.bin and ahab-container.img
> +---------------------------------------
> +
> +.. code-block:: bash
> +
> +     $ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/imx-sc-firmware-1.1.bin
> +     $ chmod +x imx-sc-firmware-1.1.bin
> +     $ ./imx-sc-firmware-1.1.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
> +
> +Or use this to avoid running random scripts from the internet,
> +but note that you must agree to the license the script displays:
> +
> +.. code-block:: bash
> +
> +     $ dd if=imx-sc-firmware-1.1.bin of=imx-sc-firmware-1.1.tar.bz2 bs=37185 skip=1
> +     $ tar -xf imx-sc-firmware-1.1.tar.bz2
> +     $ cp imx-sc-firmware-1.1/mx8qm-val-scfw-tcm.bin $(builddir)
> +
> +     $ dd if=firmware-imx-8.0.bin of=firmware-imx-8.0.tar.bz2 bs=37180 skip=1
> +     $ tar -xf firmware-imx-8.0.tar.bz2
> +     $ cp firmware-imx-8.0/firmware/seco/mx8qm-ahab-container.img $(builddir)
> +
> +Build U-Boot
> +------------
> +
> +.. code-block:: bash
> +
> +     $ export ATF_LOAD_ADDR=0x80000000
> +     $ export BL33_LOAD_ADDR=0x80020000
> +     $ make imx8qm_rom7720_a1_4G_defconfig
> +     $ make u-boot.bin
> +     $ make flash.bin
> +
> +Flash the binary into the SD card
> +---------------------------------
> +
> +Burn the flash.bin binary to SD card offset 32KB:
> +
> +.. code-block:: bash
> +
> +    $ sudo dd if=flash.bin of=/dev/sd[x] bs=1k seek=32 conv=fsync
> +
> +Boot
> +----
> +
> +Set Boot switch SW2: 1100.
> diff --git a/doc/board/advantech/index.rst b/doc/board/advantech/index.rst
> new file mode 100644
> index 0000000000..e9b198c5c3
> --- /dev/null
> +++ b/doc/board/advantech/index.rst
> @@ -0,0 +1,9 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +Advantech
> +=========
> +
> +.. toctree::
> +   :maxdepth: 2
> +
> +   imx8qm-rom7720-a1.rst
> 

-- 
=====================================================================
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: +49-8142-66989-53 Fax: +49-8142-66989-80 Email: sbabic at denx.de
=====================================================================
