From: Peng Fan <peng.fan@nxp.com>
To: u-boot@lists.denx.de
Subject: [PATCH V2 02/12] doc: board: Convert i.MX8MP EVK README to reST
Date: Wed, 14 Oct 2020 17:12:00 +0800 [thread overview]
Message-ID: <20201014091210.12113-3-peng.fan@nxp.com> (raw)
In-Reply-To: <20201014091210.12113-1-peng.fan@nxp.com>
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/imx8mp_evk/README | 41 --------------------
doc/board/freescale/imx8mp_evk.rst | 61 ++++++++++++++++++++++++++++++
doc/board/freescale/index.rst | 1 +
3 files changed, 62 insertions(+), 41 deletions(-)
delete mode 100644 board/freescale/imx8mp_evk/README
create mode 100644 doc/board/freescale/imx8mp_evk.rst
diff --git a/board/freescale/imx8mp_evk/README b/board/freescale/imx8mp_evk/README
deleted file mode 100644
index 3c64979be9..0000000000
--- a/board/freescale/imx8mp_evk/README
+++ /dev/null
@@ -1,41 +0,0 @@
-U-Boot for the NXP i.MX8MP EVK board
-
-Quick Start
-===========
-- Build the ARM Trusted firmware binary
-- Get the firmware-imx package
-- Build U-Boot
-- Boot
-
-Get and Build the ARM Trusted firmware
-======================================
-Note: $(srctree) is the U-Boot source directory
-Get ATF from: https://source.codeaurora.org/external/imx/imx-atf
-branch: imx_5.4.3_2.0.0
-$ make PLAT=imx8mp bl31
-$ sudo cp build/imx8mp/release/bl31.bin $(srctree)
-
-Get the ddr firmware
-====================
-$ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-8.7.bin
-$ chmod +x firmware-imx-8.7.bin
-$ ./firmware-imx-8.7
-$ sudo cp firmware-imx-8.7/firmware/ddr/synopsys/lpddr4_pmu_train_1d_dmem_201904.bin $(srctree)/lpddr4_pmu_train_1d_dmem.bin
-$ sudo cp firmware-imx-8.7/firmware/ddr/synopsys/lpddr4_pmu_train_1d_imem_201904.bin $(srctree)/lpddr4_pmu_train_1d_imem.bin
-$ sudo cp firmware-imx-8.7/firmware/ddr/synopsys/lpddr4_pmu_train_2d_dmem_201904.bin $(srctree)/lpddr4_pmu_train_2d_dmem.bin
-$ sudo cp firmware-imx-8.7/firmware/ddr/synopsys/lpddr4_pmu_train_2d_imem_201904.bin $(srctree)/lpddr4_pmu_train_2d_imem.bin
-
-Build U-Boot
-============
-$ export CROSS_COMPILE=aarch64-poky-linux-
-$ make imx8mp_evk_defconfig
-$ export ATF_LOAD_ADDR=0x960000
-$ make flash.bin
-
-Burn the flash.bin to the MicroSD card at offset 32KB
-$sudo dd if=flash.bin of=/dev/sd[x] bs=1K seek=32 conv=notrunc; sync
-
-Boot
-====
-Set Boot switch to SD boot
-Use /dev/ttyUSB2 for U-Boot console
diff --git a/doc/board/freescale/imx8mp_evk.rst b/doc/board/freescale/imx8mp_evk.rst
new file mode 100644
index 0000000000..b34742e33e
--- /dev/null
+++ b/doc/board/freescale/imx8mp_evk.rst
@@ -0,0 +1,61 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+imx8mp_evk
+==========
+
+U-Boot for the NXP i.MX8MP EVK board
+
+Quick Start
+-----------
+
+- Build the ARM Trusted firmware binary
+- Get the firmware-imx package
+- Build U-Boot
+- Boot
+
+Get and Build the ARM Trusted firmware
+--------------------------------------
+
+Note: $(srctree) is the U-Boot source directory
+Get ATF from: https://source.codeaurora.org/external/imx/imx-atf
+branch: imx_5.4.3_2.0.0
+
+.. code-block:: bash
+
+ $ make PLAT=imx8mp bl31
+ $ sudo cp build/imx8mp/release/bl31.bin $(srctree)
+
+Get the ddr firmware
+--------------------
+
+.. code-block:: bash
+
+ $ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-8.7.bin
+ $ chmod +x firmware-imx-8.7.bin
+ $ ./firmware-imx-8.7
+ $ sudo cp firmware-imx-8.7/firmware/ddr/synopsys/lpddr4_pmu_train_1d_dmem_201904.bin $(srctree)/lpddr4_pmu_train_1d_dmem.bin
+ $ sudo cp firmware-imx-8.7/firmware/ddr/synopsys/lpddr4_pmu_train_1d_imem_201904.bin $(srctree)/lpddr4_pmu_train_1d_imem.bin
+ $ sudo cp firmware-imx-8.7/firmware/ddr/synopsys/lpddr4_pmu_train_2d_dmem_201904.bin $(srctree)/lpddr4_pmu_train_2d_dmem.bin
+ $ sudo cp firmware-imx-8.7/firmware/ddr/synopsys/lpddr4_pmu_train_2d_imem_201904.bin $(srctree)/lpddr4_pmu_train_2d_imem.bin
+
+Build U-Boot
+------------
+
+.. code-block:: bash
+
+ $ export CROSS_COMPILE=aarch64-poky-linux-
+ $ make imx8mp_evk_defconfig
+ $ export ATF_LOAD_ADDR=0x960000
+ $ make flash.bin
+
+Burn the flash.bin to the MicroSD card at offset 32KB:
+
+.. code-block:: bash
+
+ $sudo dd if=flash.bin of=/dev/sd[x] bs=1K seek=32 conv=notrunc; sync
+
+Boot
+----
+
+Set Boot switch to SD boot
+Use /dev/ttyUSB2 for U-Boot console
diff --git a/doc/board/freescale/index.rst b/doc/board/freescale/index.rst
index 8d42b35b96..070d678725 100644
--- a/doc/board/freescale/index.rst
+++ b/doc/board/freescale/index.rst
@@ -7,3 +7,4 @@ Freescale
:maxdepth: 2
b4860qds
+ imx8mp_evk
--
2.28.0
next prev parent reply other threads:[~2020-10-14 9:12 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-14 9:11 [PATCH V2 00/12] imx: doc update Peng Fan
2020-10-14 9:11 ` [PATCH V2 01/12] board: imx: address dd usage in README Peng Fan
2020-11-01 14:38 ` sbabic at denx.de
2020-10-14 9:12 ` Peng Fan [this message]
2020-11-01 14:38 ` [PATCH V2 02/12] doc: board: Convert i.MX8MP EVK README to reST sbabic at denx.de
2020-10-14 9:12 ` [PATCH V2 03/12] doc: board: Convert i.MX8MN " Peng Fan
2020-11-01 14:39 ` sbabic at denx.de
2020-10-14 9:12 ` [PATCH V2 04/12] doc: board: Convert i.MX8MM " Peng Fan
2020-11-01 14:39 ` sbabic at denx.de
2020-10-14 9:12 ` [PATCH V2 05/12] doc: board: Convert i.MX8MQ " Peng Fan
2020-11-01 14:39 ` sbabic at denx.de
2020-10-14 9:12 ` [PATCH V2 06/12] doc: board: Convert i.MX8QXP MEK " Peng Fan
2020-11-01 14:39 ` sbabic at denx.de
2020-10-14 9:12 ` [PATCH V2 07/12] doc: board: Convert i.MXRT1020 EVK " Peng Fan
2020-11-01 14:39 ` sbabic at denx.de
2020-10-14 9:12 ` [PATCH V2 08/12] doc: board: Convert i.MXRT1050 " Peng Fan
2020-11-01 14:39 ` sbabic at denx.de
2020-10-14 9:12 ` [PATCH V2 09/12] doc: board: Convert i.MX6 Sabreauto " Peng Fan
2020-11-01 14:39 ` sbabic at denx.de
2020-10-14 9:12 ` [PATCH V2 10/12] doc: board: Convert i.MX6 Sabresd " Peng Fan
2020-11-01 14:39 ` sbabic at denx.de
2020-10-14 9:12 ` [PATCH V2 11/12] doc: board: Convert i.MX6UL 14x14 EVK " Peng Fan
2020-11-01 14:38 ` sbabic at denx.de
2020-10-14 9:12 ` [PATCH V2 12/12] doc: board: Convert i.MX6ULL " Peng Fan
2020-11-01 14:39 ` sbabic at denx.de
2020-10-14 15:28 ` [PATCH V2 00/12] imx: doc update Tom Rini
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201014091210.12113-3-peng.fan@nxp.com \
--to=peng.fan@nxp.com \
--cc=u-boot@lists.denx.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox