Revision as of 16:51, 5 February 2020

Booting from USB using UUU utility

Introduction

UUU is an open source utility by NXP that allows to download and execute code on NXP i.MX6/i.MX7/i.MX8 SoCs through the Serial Download Protocol (SDP).
It is the next generation of NXP's MFGTOOL used to load SPL and U-Boot via the USB OTG port and optionally program the internal storage of the SOM.

Further reading:
https://github.com/NXPmicro/mfgtools

Note:
All Variscite SOMs are shipped with U-Boot pre-programmed on the SOM's internal storage.
In addition, all Variscite carrier boards have an SD card slot, and even in the unlikely event of the U-Boot being erased from the SOM's internal storage, the SOM can always be booted from an SD card (like our recovery SD card, for example).
So, generally, this utility is not needed, however, it is yet another option that can be used to boot the Variscite SOMs, for anyone who is interested.

Step by step usage instructions

Download and build the UUU utility:

$ sudo apt-get install libusb-1.0-0-dev libzip-dev libbz2-dev pkg-config cmake
$ cd ~
$ git clone https://github.com/NXPmicro/mfgtools.git
$ cd mfgtools
$ cmake .
$ make

Build U-Boot:
Build U-Boot using the defconfig for SD card/eMMC.
You can follow the "Build U-Boot from source code" instructions here.
Copy the U-Boot image uuu directory:

$ cp -v imx-boot-sd.bin ~/mfgtools/uuu
$ ln -fs imx-boot-sd.bin _flash.bin

Boot the board into serial download mode:
Set the board boot mode to SD card, while not having an actual card inserted in its slot.
Alternatively, set the board boot mode to eMMC/NAND flash, when the eMMC/NAND flash does not contain a bootloader.
Connect the board to your host PC via the USB OTG port, and power on the board.
The board should be recognized on the host as a "NXP Semiconductors".

(Note: If your board only has a regular USB type-A connector and doesn't have a USB Micro-AB receptacle, you can use a "male USB type-A to male USB type-A" cable)

Run uuu to load U-Boot on the board:

$ sudo ./uuu ./spl_boot.lst

The board should now run U-Boot.
You can see its output on the console via the debug port, as always.

Notes:

The default boot command when booting from USB is bootcmd_mfg. It is defined in the board's default environment.

@@ Line 5: / Line 5: @@
 = Introduction =
-UUU is an open source utility by NXP that allows to download and execute code on NXP i.MX5/i.MX6/i.MX7 and Vybrid SoCs through the Serial Download Protocol (SDP).<br>
+UUU is an open source utility by NXP that allows to download and execute code on NXP i.MX6/i.MX7/i.MX8 SoCs through the Serial Download Protocol (SDP).<br>
-Most commonly it is used as a replacement for NXP's MFGTOOL to load SPL and U-Boot via the USB OTG port.<br> <br>
+It is the next generation of NXP's MFGTOOL used to load SPL and U-Boot via the USB OTG port and optionally program the internal storage of the SOM.<br> <br>
 <br>
 Further reading:<br>
-https://github.com/boundarydevices/imx_usb_loader/blob/master/README.md<br>
+https://github.com/NXPmicro/mfgtools<br>
-{{#ifeq: {{#var:SPL_SD_IMAGE_NAME}} | N/A || https://github.com/varigit/uboot-imx/blob/{{#var:U-BOOT_BRANCH}}/doc/{{#ifeq: {{#var:U-BOOT_BRANCH}} | imx_v2017.03_4.9.11_1.0.0_ga_var01 | README.sdp | imx/misc/sdp.txt }}<br>}}
 <br>
 Note:<br>
-All Variscite SOMs are shipped with {{#ifeq: {{#var:SPL_SD_IMAGE_NAME}} | N/A || SPL and}} U-Boot pre-programmed on the SOM's internal storage.<br>
+All Variscite SOMs are shipped with U-Boot pre-programmed on the SOM's internal storage.<br>
-In addition, all Variscite carrier boards have an SD card slot, and even in the unlikely event of the SPL/U-Boot being erased from the SOM's internal storage, the SOM can always be booted from an SD card (like our recovery SD card, for example).<br>
+In addition, all Variscite carrier boards have an SD card slot, and even in the unlikely event of the U-Boot being erased from the SOM's internal storage, the SOM can always be booted from an SD card (like our recovery SD card, for example).<br>
 So, generally, this utility is not needed, however, it is yet another option that can be used to boot the Variscite SOMs, for anyone who is interested.<br>
 = Step by step usage instructions =
-'''Download and install the imx_usb_loader utility''':<br>
+'''Download and build the UUU utility''':<br>
 <pre>
-$ sudo apt-get install libusb-1.0-0-dev
+$ sudo apt-get install libusb-1.0-0-dev libzip-dev libbz2-dev pkg-config cmake
 $ cd ~
-$ git clone https://github.com/boundarydevices/imx_usb_loader.git
+$ git clone https://github.com/NXPmicro/mfgtools.git
-$ cd imx_usb_loader
+$ cd mfgtools
-$ git reset --hard c598fd14d67
+$ cmake .
 $ make
 </pre>
 <br>
 '''Build U-Boot''':<br>
 Build U-Boot using the defconfig for SD card/eMMC.<br>
 You can follow the "Build U-Boot from source code" instructions {{Varlink|Yocto_Build_U-Boot|{{#var:RELEASE_LINK}}|here}}.<br>
-Copy the {{#ifeq: {{#var:SPL_SD_IMAGE_NAME}} | N/A | U-Boot image | SPL and U-Boot images}} to the imx_usb_loader directory:
+Copy the U-Boot image uuu directory:
-  $ cp -v {{#ifeq: {{#var:SPL_SD_IMAGE_NAME}} | N/A |{{#var:U-BOOT_IMAGE_NAME}}|SPL u-boot.img}} ~/imx_usb_loader
+  $ cp -v {{#var:U-BOOT_SD_IMAGE_NAME}} ~/mfgtools/uuu
-<br>
+ $ ln -fs {{#var:U-BOOT_SD_IMAGE_NAME}} _flash.bin
-{{#ifeq: {{#var:SPL_SD_IMAGE_NAME}} | N/A ||
-{{#ifeq: {{#var:MACHINE_NAME}} | imx7-var-som |
-'''Configure imx_usb to load SPL and u-boot.img consecutively''':
- $ cd ~/imx_usb_loader
-Edit the imx_usb.conf file, and <u>prepend</u> the following lines to it:
- #imx7
-x15a2:0x0076, mx7_usb_rom.conf, 0x0525:0xb4a4, mx7_usb_sdp_spl.conf
-Create a file called mx7_usb_rom.conf with the following content:<br>
-(the content is the same as mx7_usb_work.conf, with an 'SPL:jump header2' line appended to it)
- mx7
- hid,1024,0x910000,0x80000000,1G,0x00900000,0x20000
- SPL:jump header2
-Create a file called mx7_usb_sdp_spl.conf file, with the following content:
- mx7_spl_sdp
- #hid/bulk,[old_header,]max packet size, {ram start, ram size}(repeat valid ram areas)
- #In SPL, we typically load u-boot.img which has a U-boot header...
- hid,uboot_header,1024,0x80000000,1G,0x00907000,0x11000
- u-boot.img:jump header2
 <br>
-|
-'''Configure imx_usb to load SPL and u-boot.img consecutively''':
- $ cd ~/imx_usb_loader
-Edit the imx_usb.conf file, and <u>prepend</u> the following lines to it:
- #imx6dq/dqp
-x15a2:0x0054, mx6_usb_rom.conf, 0x0525:0xb4a4, mx6_usb_sdp_spl.conf
- #imx6s/dl
-x15a2:0x0061, mx6_usb_rom.conf, 0x0525:0xb4a4, mx6_usb_sdp_spl.conf
- #imx6ul
-x15a2:0x007d, mx6_usb_rom.conf, 0x0525:0xb4a4, mx6_usb_sdp_spl.conf
- #imx6ull
-x15a2:0x0080, mx6_usb_rom.conf, 0x0525:0xb4a4, mx6_usb_sdp_spl.conf
-Create a file called mx6_usb_rom.conf with the following content:<br>
-(the content is the same as mx6_usb_work.conf, with an 'SPL:jump header2' line appended to it)
- mx6_qsb
- hid,1024,0x910000,0x10000000,1G,0x00900000,0x40000
- SPL:jump header2
-Edit the mx6_usb_sdp_spl.conf file, and append the following line to it:
- u-boot.img:jump header2
-<br>
-}}
-}}
 '''Boot the board into serial download mode''':<br>
 {{Varlink|Yocto_Build_Release#Setting the Boot Mode|{{#var:RELEASE_LINK}}|Set the board boot mode}} to SD card, while not having an actual card inserted in its slot.<br>
 Alternatively, set the board boot mode to eMMC/NAND flash, when the eMMC/NAND flash does not contain a bootloader.<br>
 Connect the board to your host PC via the USB OTG port, and power on the board.<br>
-The board should be recognized on the host as a "Freescale SemiConductor Inc  SE Blank ARIK" (or something similar).<br>
+The board should be recognized on the host as a "NXP Semiconductors".<br>
 <br>
 (Note: If your board only has a regular USB type-A connector and doesn't have a USB Micro-AB receptacle, you can use a "male USB type-A to male USB type-A" cable)<br>
 <br>
-'''Run imx_usb to load {{#ifeq: {{#var:SPL_SD_IMAGE_NAME}} | N/A || SPL and}} U-Boot on the board''':
- {{#ifeq: {{#var:SPL_SD_IMAGE_NAME}} | N/A |
+'''Run uuu to load U-Boot on the board''':
-  $ sudo ./imx_usb {{#var:U-BOOT_IMAGE_NAME}}|
+  $ sudo ./uuu ./spl_boot.lst
- $ sudo ./imx_usb}}
+The board should now run U-Boot.<br>
-The board should now run {{#ifeq: {{#var:SPL_SD_IMAGE_NAME}} | N/A || SPL and}} U-Boot.<br>
 You can see its output on the console via the debug port, as always.<br>
 <br>
 '''Notes''':
-* The default boot command when booting from USB is bootcmd_mfg. It can be defined in the board's default env{{#ifeq: {{#var:SPL_SD_IMAGE_NAME}} | N/A ||&#32;(we leave it empty by default)}}.
+* The default boot command when booting from USB is bootcmd_mfg. It is defined in the board's default environment.

Imx uuu: Difference between revisions

Revision as of 16:51, 5 February 2020

Contents

Introduction

Step by step usage instructions