From: Peng Fan <peng.fan@nxp.com>
To: u-boot@lists.denx.de
Subject: [PATCH V2 06/12] doc: board: Convert i.MX8QXP MEK README to reST
Date: Wed, 14 Oct 2020 17:12:04 +0800 [thread overview]
Message-ID: <20201014091210.12113-7-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/imx8qxp_mek/README | 50 ----------------------
doc/board/freescale/imx8qxp_mek.rst | 66 +++++++++++++++++++++++++++++
doc/board/freescale/index.rst | 1 +
3 files changed, 67 insertions(+), 50 deletions(-)
delete mode 100644 board/freescale/imx8qxp_mek/README
create mode 100644 doc/board/freescale/imx8qxp_mek.rst
diff --git a/board/freescale/imx8qxp_mek/README b/board/freescale/imx8qxp_mek/README
deleted file mode 100644
index 6f99d0e13e..0000000000
--- a/board/freescale/imx8qxp_mek/README
+++ /dev/null
@@ -1,50 +0,0 @@
-U-Boot for the NXP i.MX8QXP EVK board
-
-Quick Start
-===========
-
-- Build the ARM Trusted firmware binary
-- Get scfw_tcm.bin and ahab-container.img
-- Build U-Boot
-- 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.19.35_1.1.0 -b imx_4.19.35_1.1.0
-$ make PLAT=imx8qx bl31
-
-Get scfw_tcm.bin and ahab-container.img
-==============================
-
-$ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/imx-sc-firmware-1.2.7.1.bin
-$ chmod +x imx-sc-firmware-1.2.7.1.bin
-$ ./imx-sc-firmware-1.2.7.1.bin
-$ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/imx-seco-2.3.1.bin
-$ chmod +x imx-seco-2.3.1.bin
-$ ./imx-seco-2.3.1.bin
-
-Copy the following binaries to U-Boot folder:
-
-$ cp imx-atf/build/imx8qx/release/bl31.bin .
-$ cp imx-seco-2.3.1/firmware/seco/mx8qx-ahab-container.img ./ahab-container.img
-$ cp imx-sc-firmware-1.2.7.1/mx8qx-mek-scfw-tcm.bin .
-
-Build U-Boot
-============
-$ make imx8qxp_mek_defconfig
-$ 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=1024 seek=32 conv=notrunc
-
-Boot
-====
-Set Boot switch SW2: 1100.
diff --git a/doc/board/freescale/imx8qxp_mek.rst b/doc/board/freescale/imx8qxp_mek.rst
new file mode 100644
index 0000000000..215627cfa6
--- /dev/null
+++ b/doc/board/freescale/imx8qxp_mek.rst
@@ -0,0 +1,66 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+imx8qxp_mek
+===========
+
+U-Boot for the NXP i.MX8QXP EVK board
+
+Quick Start
+-----------
+
+- Build the ARM Trusted firmware binary
+- Get scfw_tcm.bin and ahab-container.img
+- Build U-Boot
+- 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.19.35_1.1.0 -b imx_4.19.35_1.1.0
+ $ make PLAT=imx8qx 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.2.7.1.bin
+ $ chmod +x imx-sc-firmware-1.2.7.1.bin
+ $ ./imx-sc-firmware-1.2.7.1.bin
+ $ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/imx-seco-2.3.1.bin
+ $ chmod +x imx-seco-2.3.1.bin
+ $ ./imx-seco-2.3.1.bin
+
+Copy the following binaries to U-Boot folder:
+
+.. code-block:: bash
+
+ $ cp imx-atf/build/imx8qx/release/bl31.bin .
+ $ cp imx-seco-2.3.1/firmware/seco/mx8qx-ahab-container.img ./ahab-container.img
+ $ cp imx-sc-firmware-1.2.7.1/mx8qx-mek-scfw-tcm.bin .
+
+Build U-Boot
+------------
+
+.. code-block:: bash
+
+ $ make imx8qxp_mek_defconfig
+ $ 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=1024 seek=32 conv=notrunc
+
+Boot
+----
+Set Boot switch SW2: 1100.
diff --git a/doc/board/freescale/index.rst b/doc/board/freescale/index.rst
index 5c10c95b93..6cd352565f 100644
--- a/doc/board/freescale/index.rst
+++ b/doc/board/freescale/index.rst
@@ -11,3 +11,4 @@ Freescale
imx8mn_evk
imx8mp_evk
imx8mq_evk
+ imx8qxp_mek
--
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 ` [PATCH V2 02/12] doc: board: Convert i.MX8MP EVK README to reST Peng Fan
2020-11-01 14:38 ` 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 ` Peng Fan [this message]
2020-11-01 14:39 ` [PATCH V2 06/12] doc: board: Convert i.MX8QXP MEK " 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-7-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