aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPeng Fan <peng.fan@nxp.com>2020-10-14 17:12:05 +0800
committerStefano Babic <sbabic@denx.de>2020-11-01 15:37:19 +0100
commite66be2d7e6e6976a94433dcad51b89a3c7aa410a (patch)
treed1978528b04cf575ed249a3f70a339883b30e4f5
parent21f747c845d8c71d1a751de3dfe57ad1dc68ccbe (diff)
downloadu-boot-e66be2d7e6e6976a94433dcad51b89a3c7aa410a.tar.gz
doc: board: Convert i.MXRT1020 EVK README to reST
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>
-rw-r--r--board/freescale/imxrt1020-evk/README31
-rw-r--r--doc/board/freescale/imxrt1020-evk.rst41
-rw-r--r--doc/board/freescale/index.rst1
3 files changed, 42 insertions, 31 deletions
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