diff mbox series

[V2,04/12] doc: board: Convert i.MX8MM EVK README to reST

Message ID 20201014091210.12113-5-peng.fan@nxp.com
State New
Headers show
Series imx: doc update | expand

Commit Message

Peng Fan Oct. 14, 2020, 9:12 a.m. UTC 
Convert plain text documentation to reStructuredText format and add
it to Sphinx TOC tree. No essential content change.

Signed-off-by: Peng Fan <peng.fan@nxp.com>

---
 board/freescale/imx8mm_evk/README  | 37 --------------------
 doc/board/freescale/imx8mm_evk.rst | 56 ++++++++++++++++++++++++++++++
 doc/board/freescale/index.rst      |  1 +
 3 files changed, 57 insertions(+), 37 deletions(-)
 delete mode 100644 board/freescale/imx8mm_evk/README
 create mode 100644 doc/board/freescale/imx8mm_evk.rst

-- 
2.28.0
diff mbox series

Patch

diff --git a/board/freescale/imx8mm_evk/README b/board/freescale/imx8mm_evk/README
deleted file mode 100644
index 3307711d5d..0000000000
--- a/board/freescale/imx8mm_evk/README
+++ /dev/null
@@ -1,37 +0,0 @@ 
-U-Boot for the NXP i.MX8MM EVK board
-
-Quick Start
-===========
-- Build the ARM Trusted firmware binary
-- Get ddr firmware
-- Build U-Boot
-- Boot
-
-Get and Build the ARM Trusted firmware
-======================================
-Note: builddir is U-Boot build directory (source directory for in-tree builds)
-Get ATF from: https://source.codeaurora.org/external/imx/imx-atf
-branch: imx_4.19.35_1.0.0
-$ make PLAT=imx8mm bl31
-$ cp build/imx8mm/release/bl31.bin $(builddir)
-
-Get the ddr firmware
-=============================
-$ 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
-$ cp firmware-imx-8.0/firmware/ddr/synopsys/lpddr4*.bin $(builddir)
-
-Build U-Boot
-============
-$ export CROSS_COMPILE=aarch64-poky-linux-
-$ make imx8mm_evk_defconfig
-$ export ATF_LOAD_ADDR=0x920000
-$ make flash.bin
-
-Burn the flash.bin to MicroSD card offset 33KB
-$sudo dd if=flash.bin of=/dev/sd[x] bs=1024 seek=33 conv=notrunc
-
-Boot
-====
-Set Boot switch to SD boot
diff --git a/doc/board/freescale/imx8mm_evk.rst b/doc/board/freescale/imx8mm_evk.rst
new file mode 100644
index 0000000000..f75190227c
--- /dev/null
+++ b/doc/board/freescale/imx8mm_evk.rst
@@ -0,0 +1,56 @@ 
+.. SPDX-License-Identifier: GPL-2.0+
+
+imx8mm_evk
+==========
+
+U-Boot for the NXP i.MX8MM EVK board
+
+Quick Start
+-----------
+
+- Build the ARM Trusted firmware binary
+- Get ddr firmware
+- Build U-Boot
+- Boot
+
+Get and Build the ARM Trusted firmware
+--------------------------------------
+
+Note: builddir is U-Boot build directory (source directory for in-tree builds)
+Get ATF from: https://source.codeaurora.org/external/imx/imx-atf
+branch: imx_4.19.35_1.0.0
+
+.. code-block:: bash
+
+   $ make PLAT=imx8mm bl31
+   $ cp build/imx8mm/release/bl31.bin $(builddir)
+
+Get the ddr firmware
+--------------------
+
+.. code-block:: bash
+
+   $ 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
+   $ cp firmware-imx-8.0/firmware/ddr/synopsys/lpddr4*.bin $(builddir)
+
+Build U-Boot
+------------
+
+.. code-block:: bash
+
+   $ export CROSS_COMPILE=aarch64-poky-linux-
+   $ make imx8mm_evk_defconfig
+   $ export ATF_LOAD_ADDR=0x920000
+   $ make flash.bin
+
+Burn the flash.bin to MicroSD card offset 33KB:
+
+.. code-block:: bash
+
+   $sudo dd if=flash.bin of=/dev/sd[x] bs=1024 seek=33 conv=notrunc
+
+Boot
+----
+Set Boot switch to SD boot
diff --git a/doc/board/freescale/index.rst b/doc/board/freescale/index.rst
index 77b6802098..33b1be95f5 100644
--- a/doc/board/freescale/index.rst
+++ b/doc/board/freescale/index.rst
@@ -7,5 +7,6 @@  Freescale
    :maxdepth: 2
 
    b4860qds
+   imx8mm_evk
    imx8mn_evk
    imx8mp_evk