@@ -16,3 +16,4 @@ Freescale
imxrt1050-evk
mx6sabreauto
mx6sabresd
+ mx6ul_14x14_evk
similarity index 65%
rename from board/freescale/mx6ul_14x14_evk/README
rename to doc/board/freescale/mx6ul_14x14_evk.rst
@@ -1,11 +1,18 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+mx6ul_14x14_evk
+===============
+
How to use U-Boot on Freescale MX6UL 14x14 EVK
-----------------------------------------------
- Build U-Boot for MX6UL 14x14 EVK:
-$ make mrproper
-$ make mx6ul_14x14_evk_defconfig
-$ make
+.. code-block:: bash
+
+ $ make mrproper
+ $ make mx6ul_14x14_evk_defconfig
+ $ make
This will generate the SPL image called SPL and the u-boot.img.
@@ -14,35 +21,38 @@ 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/mmcblk0 bs=1k seek=1 conv=notrunc; sync
+.. code-block:: bash
+
+ sudo dd if=SPL of=/dev/mmcblk0 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/mmcblk0 bs=1k seek=69 conv=notrunc; sync
+.. code-block:: bash
-- Jumper settings:
+ sudo dd if=u-boot.img of=/dev/mmcblk0 bs=1k seek=69 conv=notrunc; sync
-SW601: 0 0 1 0
-Sw602: 1 0
+- Jumper settings::
+
+ SW601: 0 0 1 0
+ Sw602: 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 push buttons)
+ The USB console connector is the one close the push buttons
-- Insert the micro SD card in the board, power it up and U-Boot messages should
-come up.
+- Insert the micro SD card in the board, power it up and U-Boot messages should come up.
2. Booting via Serial Download Protocol (SDP)
---------------------------------------------
The mx6ulevk board can boot from USB OTG port using the SDP, target will
enter in SDP mode in case an SD Card is not connect or boot switches are
-set as below:
+set as below::
-Sw602: 0 1
-SW601: x x x x
+ Sw602: 0 1
+ SW601: x x x x
The following tools can be used to boot via SDP, for both tools you must
connect an USB cable in USB OTG port.
@@ -54,13 +64,15 @@ https://github.com/NXPmicro/mfgtools
The following script should be created to boot SPL + u-boot-dtb.img binaries:
- $ cat uuu_script
- uuu_version 1.1.4
+.. code-block:: bash
+
+ $ cat uuu_script
+ uuu_version 1.1.4
- SDP: boot -f SPL
- SDPU: write -f u-boot-dtb.img -addr 0x877fffc0
- SDPU: jump -addr 0x877fffc0
- SDPU: done
+ SDP: boot -f SPL
+ SDPU: write -f u-boot-dtb.img -addr 0x877fffc0
+ SDPU: jump -addr 0x877fffc0
+ SDPU: done
Please note that the address above is calculated based on SYS_TEXT_BASE address:
@@ -68,7 +80,9 @@ Please note that the address above is calculated based on SYS_TEXT_BASE address:
Power on the target and run the following command from U-Boot root directory:
- $ sudo ./uuu uuu_script
+.. code-block:: bash
+
+ $ sudo ./uuu uuu_script
- Method 2: imx usb loader tool (imx_usb):
@@ -78,5 +92,7 @@ https://github.com/boundarydevices/imx_usb_loader
Build the source code and run the following commands from U-Boot root
directory:
- $ sudo ./imx_usb SPL
- $ sudo ./imx_usb u-boot-dtb.img
+.. code-block:: bash
+
+ $ sudo ./imx_usb SPL
+ $ sudo ./imx_usb u-boot-dtb.img
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> --- doc/board/freescale/index.rst | 1 + .../board/freescale/mx6ul_14x14_evk.rst | 62 ++++++++++++------- 2 files changed, 40 insertions(+), 23 deletions(-) rename board/freescale/mx6ul_14x14_evk/README => doc/board/freescale/mx6ul_14x14_evk.rst (65%) -- 2.28.0