From: Peng Fan <peng.fan@nxp.com>
To: u-boot@lists.denx.de
Subject: [PATCH V2 07/12] doc: board: Convert i.MXRT1020 EVK README to reST
Date: Wed, 14 Oct 2020 17:12:05 +0800 [thread overview]
Message-ID: <20201014091210.12113-8-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/imxrt1020-evk/README | 31 --------------------
doc/board/freescale/imxrt1020-evk.rst | 41 +++++++++++++++++++++++++++
doc/board/freescale/index.rst | 1 +
3 files changed, 42 insertions(+), 31 deletions(-)
delete mode 100644 board/freescale/imxrt1020-evk/README
create mode 100644 doc/board/freescale/imxrt1020-evk.rst
diff --git a/board/freescale/imxrt1020-evk/README b/board/freescale/imxrt1020-evk/README
deleted file mode 100644
index 9bc5bc00bc..0000000000
--- a/board/freescale/imxrt1020-evk/README
+++ /dev/null
@@ -1,31 +0,0 @@
-How to use U-Boot on NXP i.MXRT1020 EVK
------------------------------------------------
-
-- Build U-Boot for i.MXRT1020 EVK:
-
-$ make mrproper
-$ make imxrt1020-evk_defconfig
-$ make
-
-This will generate the SPL image called SPL and the u-boot.img.
-
-- Flash the SPL image into the micro SD card:
-
-sudo dd if=SPL of=/dev/sdX bs=1k seek=1 conv=notrunc; sync
-
-- Flash the u-boot.img image into the micro SD card:
-
-sudo dd if=u-boot.img of=/dev/sdX bs=1k seek=128 conv=notrunc; sync
-
-- Jumper settings:
-
-SW8: 0 1 1 0
-
-where 0 means bottom position and 1 means top position (from the
-switch label numbers reference).
-
-- Connect the USB cable between the EVK and the PC for the console.
-(The USB console connector is the one close the ethernet connector)
-
-- Insert the micro SD card in the board, power it up and U-Boot messages should
-come up.
diff --git a/doc/board/freescale/imxrt1020-evk.rst b/doc/board/freescale/imxrt1020-evk.rst
new file mode 100644
index 0000000000..267f80c517
--- /dev/null
+++ b/doc/board/freescale/imxrt1020-evk.rst
@@ -0,0 +1,41 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+imxrt1020-evk
+=============
+
+How to use U-Boot on NXP i.MXRT1020 EVK
+---------------------------------------
+
+- Build U-Boot for i.MXRT1020 EVK:
+
+.. code-block:: bash
+
+ $ make mrproper
+ $ make imxrt1020-evk_defconfig
+ $ make
+
+This will generate the SPL image called SPL and the u-boot.img.
+
+- Flash the SPL image into the micro SD card:
+
+.. code-block:: bash
+
+ $sudo dd if=SPL of=/dev/sdX bs=1k seek=1 conv=notrunc; sync
+
+- Flash the u-boot.img image into the micro SD card:
+
+.. code-block:: bash
+
+ $sudo dd if=u-boot.img of=/dev/sdX bs=1k seek=128 conv=notrunc; sync
+
+- Jumper settings::
+
+ SW8: 0 1 1 0
+
+where 0 means bottom position and 1 means top position (from the
+switch label numbers reference).
+
+- Connect the USB cable between the EVK and the PC for the console.
+ The USB console connector is the one close the ethernet connector
+
+- Insert the micro SD card in the board, power it up and U-Boot messages should come up.
diff --git a/doc/board/freescale/index.rst b/doc/board/freescale/index.rst
index 6cd352565f..81c4826beb 100644
--- a/doc/board/freescale/index.rst
+++ b/doc/board/freescale/index.rst
@@ -12,3 +12,4 @@ Freescale
imx8mp_evk
imx8mq_evk
imx8qxp_mek
+ imxrt1020-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 ` [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 ` [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 ` Peng Fan [this message]
2020-11-01 14:39 ` [PATCH V2 07/12] doc: board: Convert i.MXRT1020 EVK " 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-8-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