UUU (Universal Update Utility) i

UUU (Universal Update Utility)

UUU (Universal Update Utility) ii

REVISION HISTORY

NUMBER DATE DESCRIPTION NAME

5589368 Fri Nov 9 14:26:13 point into win7 user guide nxpfrankli
2018 -0600

a20e88b Fri Nov 9 15:25:57 fix path seperate Frank Li

2018 -0600

0bd57ab Mon Nov 12 Updated FAQ (asciidoc) nxpfrankli

14:06:00 2018 -0600

0714490 Tue Nov 27 11:56:13 Updated Release Notes (asciidoc) nxpfrankli

2018 -0600

652d52e Tue Nov 27 13:12:23 Updated Release Notes (asciidoc) nxpfrankli

2018 -0600

24c4981 Tue Nov 27 15:00:34 Updated Release Notes (asciidoc) nxpfrankli

2018 -0600

9cadcf8 Thu Nov 29 15:14:51 Updated Home (asciidoc) nxpfrankli

2018 -0600

9be1d88 Thu Nov 29 15:17:41 Updated Home (asciidoc) nxpfrankli

2018 -0600

a9b6498 Thu Nov 29 15:27:05 Updated Home (asciidoc) nxpfrankli

2018 -0600

a6b7ebd Fri Nov 30 11:30:23 Updated Release Notes (asciidoc) nxpfrankli

2018 -0600

379a768 Tue Dec 4 11:34:37 Updated Home (asciidoc) nxpfrankli

2018 -0600

06a61b6 Tue Dec 4 11:35:31 Updated Home (asciidoc) nxpfrankli

2018 -0600

e2d3abe Tue Dec 4 11:38:06 Updated FAQ (asciidoc) nxpfrankli

2018 -0600

d30423f Wed Dec 5 15:24:21 Updated UUU default support protocol list nxpfrankli
2018 -0600 (asciidoc)

a9b70c5 Mon Dec 10 Updated UUU default support protocol list nxpfrankli
11:01:10 2018 -0600 (asciidoc)

fcab0ed Thu Dec 13 10:16:55 Updated Release Notes (asciidoc) nxpfrankli

2018 -0600

bae1d6c Fri Jan 11 14:08:18 Updated UUU default support protocol list nxpfrankli
2019 -0600 (asciidoc)
UUU (Universal Update Utility) iii

REVISION HISTORY

NUMBER DATE DESCRIPTION NAME

f0416ac Wed Jan 16 14:19:54 Updated _Sidebar (markdown) nxpfrankli

2019 -0600

409e541 Thu Jan 17 14:22:54 Updated Release Notes (asciidoc) nxpfrankli

2019 -0600

a9d6248 Wed Jan 23 07:56:16 Updated Example (asciidoc) nxpfrankli

2019 -0600

5e4197c Wed Jan 23 10:46:52 Updated Sample script (asciidoc) nxpfrankli

2019 -0600

5b90577 Wed Jan 23 10:49:14 Updated Example (asciidoc) nxpfrankli

2019 -0600

4a45ce8 Wed Jan 23 10:50:36 Updated Example (asciidoc) nxpfrankli

2019 -0600

f9e9970 Fri Jan 25 13:28:05 Updated Release Notes (asciidoc) nxpfrankli

2019 -0600

776df7a Mon Feb 25 11:33:44 Updated Release Notes (asciidoc) nxpfrankli

2019 -0600
UUU (Universal Update Utility) iv

Contents

1 Introduction 1
1.1 Running environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2 Typical Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.3 Typical Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.4 License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.5 What Firmware Need . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.6 Setup auto parameter complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.6.1 windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.6.2 linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.7 L4.9.123_2.3.0_8MM GA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2 Syntactic 3

3 Usage Example 5
3.1 Basic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.1.1 Download boot loader for imx6\imx7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.1.2 Download boot loader for imx8qxp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.1.3 Download SPL and uboot, such as imx8mq. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.1.4 Burn Android Image to eMMC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.1.5 Burn yocto Image to eMMC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.2 Built-in script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.3 multi boards support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.3.1 For the same boards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.3.2 For the difference boards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.4 Talk with fastboot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.4.1 boot linux kernel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.4.2 write image to emmc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

4 Sample scripts 7

5 Supported protocol 7
5.1 SDP: i.MX6/7 ROM download protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
5.1.1 Supported command: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
5.2 SDPU\SDPV: uboot implement simplified ROM SDP protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
5.3 SDPS: i.MX8QXP and i.MX8QM ROM download protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
5.4 FB: Android fastboot protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
5.4.1 Support command: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.5 FBK: Android fastboot protocol, implement at initramfs. See project imx-uuu . . . . . . . . . . . . . . . . . . . 9
5.5.1 Support command: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.6 Common command for all protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
UUU (Universal Update Utility) v

6 Migration from mfgtool ucl2.xml 10

7 Win 7 User Guide 11

7.1 Back Ground . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
7.2 Install updated winusb inf file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
7.3 Use zadig to install winusb driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

8 FAQ 13

9 Build Steps 15
9.1 windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
9.2 linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

10 Uboot config requirement 16

11 kernel config requirement 17

12 Release Notes 17
12.1 1.2.TBD (Next) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
12.1.1 New features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
12.1.2 Bug fixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
12.2 1.2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
12.2.1 New features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
12.2.2 Bug fixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
12.3 1.1.81 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
12.3.1 New features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
12.3.2 Bug fixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
12.4 1.1.41 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
12.4.1 New features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
12.4.2 Bug fixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

13 Known issue 19
UUU (Universal Update Utility) 1 / 19

1 Introduction

Welcome to the UUU (Universal Update Utility). This is an evolution of MFGTools (aka MFGTools v3).
UUU is Freescale/NXP I.MX Chip image deploy tools.
With the time, the need for an update utility portable to Linux and Windows increased. UUU have the same usage on both
Windows and Linux. It means the same script works on both OS.
UUU is command line tools. look like
uuu (universal update utility) for nxp imx chips -- libuuu-1.0.1-gffd9837

Succues:0 Failure:3 Wait for Known USB Device Appear...

1:11 5/5 [ ] SDP: jump -f u-boot-dtb.imx - ←-

ivtinitramf....
2:1 1/5 [===> ] SDP: boot -f u-boot-imx7dsabresd_sd. ←-
imx ....

UUU design as common library and UI. So user can easily integrate into their tools with uuu library. UUU also easy run in any
scripts.
PDF of wiki content also is available at release page.

1.1 Running environment

• Windows 10, 64bit, early version(below 1.2.0) need install vs2017 redistribute package
• Ubuntu 16.14 or above, 64bit

Windows 7 user please read WIN7-User-Guide

1.2 Typical Usage

Set board boot pin to serial download mode. Generally iMX ROM will fail back to usb serial download mode if boot failure.
Download uboot
uuu bootloader

Burn uboot into emmc

uuu -b emmc bootloader

Burn rootfs image into emmc

uuu -b emmc_all bootloader rootfs.sdcard

Decompress rootfs image and burn into emmc (since 1.1.87)

uuu -b emmc_all bootloader rootfs.sdcard.bz2/*

Notes: bootloader means bootable image, which included ROM required header. for imx6/7, it should be uboot.imx
generally. for imx8qxp\imx8qm\imx8mm\im8mq, it is flash.bin.
Burn release image into emmc
uuu L4.9.123_2.3.0_8mm-ga.zip

Note: some release combine multi board into one zip package, you need use uuu release.zip/uuu.auto-<boardname>
More usage please refer Example
UUU (Universal Update Utility) 2 / 19

1.3 Typical Script

uuu’s script is plain text file

**first line must be
uuu_version 1.0.1

Version show minimize version of uuu to run this script.

Then flow uuu commands.
UUU command format as
PROTOCOL: CMD
The below is example to boot uboot for imx6 and imx7.
uuu_version 1.0.1
SDP: dcd -f u-boot.imx
SDP: write -f u-boot.imx -ivt 0
SDP: jump -f u-boot.imx -ivt 0

more sample scripts see Sample-script

The below table environment may be used when write uuu script

Table 1: Table Fastboot environment

Variable Description
fastboot_dev fastboot flash device, support mmc and sata
fastboot_buffer fastboot download buffer adddress
fastboot_bytes fastboot download file size
emmc_dev eMMC device number
sd_dev sd slot device number

1.4 License

uuu is licensed under the BSD license. See LICENSE. The BSD licensed prebuilt Windows binary version of uuu is statically
linked with the LGPL libusb library, which remains LGPL.

• bzip2 (BSD license) is from https://github.com/enthought/bzip2-1.0.6

• zlib (zlib license) is from https://github.com/madler/zlib.git

• libusb (LGPL-2.1) is from https://github.com/libusb/libusb.git

1.5 What Firmware Need

What you want Firmware Need

Download bootloader N/A
Burn Image to eMMC/SD uboot with fastboot enable
Burn Image to qspi\spi\nor uboot with fastboot enable
Burn Image into Nand flash uboot(1), linux kernel\initramfs\uboot\dtb
Need linux shell cmd such as fdisk uboot(1), linux kernel\initramfs\uboot\dtb
Boot linux kenrel with rootfs already in eMMC uboot with fastboot enable
Boot Linux kernel with nfs over USB uboot with fastboot enable, initramfs
UUU (Universal Update Utility) 3 / 19

(1) prefer enable fastboot. If ROM HID support write additional image to DDR place, you can write kernel\dtb\initramfs to ddr
before jump to uboot. Enable fastboot give more flexibility to change kernel command line.

1.6 Setup auto parameter complete

1.6.1 windows

Just power shell support customized auto complete

Powershell: Enjoy auto [tab] command complete by run below command or put into Documents\WindowsPowerShell\Microsoft.PowerSh
Register-ArgumentCompleter -CommandName uuu -ScriptBlock {param($commandName, ←-
$parameterName,$wordToComplete,$commandAst,$fakeBoundParameter); C:\Users\ ←-
nxa23210\uuu\uuu\x64\Release\lib\uuu.exe -autocomplete $parameterName }

1.6.2 linux

Enjoy auto [tab] command complete by put below script into /etc/bash_completion.d/uuu
_uuu_autocomplete()
{
COMPREPLY=($(/home/lizhi/source/mfgtools/uuu/uuu $1 $2 $3))
}
complete -o nospace -F _uuu_autocomplete uuu

1.7 L4.9.123_2.3.0_8MM GA

It is first official BSP release to support uuu For L4.9.123_2.3.0_8MM GA with i.MX8M Mini, see [?]

2 Syntactic

uuu (Universal Update Utility) for nxp imx chips -- libuuu_1.1.87-7-gad2ec1f

uuu [-d -m -v -V] <bootloader|cmdlists|cmd>

bootloader download bootloader to board by usb

cmdlist run all commands in cmdlist file
If it is path, search uuu.auto in dir
If it is zip, search uuu.auto in zip
cmd Run one command, use -H see detail
example: SDPS: boot -f flash.bin
-d Deamon mode, wait for forever.
-v -V verbose mode, -V enable libusb error\warning info
-m USBPATH Only monitor these pathes.
-m 1:2 -m 1:3

uuu -s Enter shell mode. uuu.inputlog record all input commands

you can use "uuu uuu.inputlog" next time to run all commands

uuu -h -H show help, -H means detail helps

uuu [-d -m -v] -b[run] <emmc|emmc_all|qspi|sd|sd_all|spl> arg...

Run Built-in scripts
UUU (Universal Update Utility) 4 / 19

emmc burn boot loader to eMMC boot partition

arg0: _flash.bin
emmc_all burn whole image to eMMC
arg0: _flash.bin
arg1: _rootfs.sdcard
qspi burn boot loader to qspi nor flash
arg0: _flexspi.bin bootloader
arg1: _image[Optional] image burn to flexspi, default is the s ←-
ame as bootloader
sd burn boot loader to sd card
arg0: _flash.bin
sd_all burn whole image to sd card
arg0: _flash.bin
arg1: _rootfs.sdcard
spl boot spl and uboot
arg0: _flash.bin

uuu -bshow <emmc|emmc_all|qspi|sd|sd_all|spl>

Show built-in script

---------------------------------------------------------------------
Command Format PROTOCOL COMMAND ARG
PROTOCOL
ALL protocol supported common command
done #last command for whole flow
delay <ms> # delay ms
sh\shell <any shell command> #Run shell command, such as ←-
wget to file from network
< <any shell command> #use shell command's output ←-
as uuu command
this command generally used for burn some sequen ←-
ce number, such ←-
production id, mac address
for example:
FB:< echo ucmd print

CFG: Config protocol of specific usb device vid/pid

SDPS|SDP|FB\Fastboot|FBK -chip <chip name> -pid <pid> -vid <vid ←-
> [-bcdversion <ver>]

SDPS: Stream download after MX8QXPB0

boot -f <filename> [-offset 0x0000]

SDP: iMX6/iMX7 HID download protocol.

dcd -f <filename>
write -f <filename> [-addr 0x000000] [-ivt 0]
jump -f <filename> [-ivt 0]
boot -f <filename> [-nojump]

FB[-t timeout]:\Fastboot: android fastboot protocol. unit of timeout ←-

is ms
getvar
ucmd <any uboot command>
acmd <any never returned uboot command, like booti, reboo ←-
t>
flash [-raw2sparse] <partition> <filename>
download -f <filename>
UUU (Universal Update Utility) 5 / 19

FBK: community with kernel with fastboot protocol. DO NOT compatible ←-

with fastboot tools.
ucmd <any kernel command> and wait for command finish
acmd <any kernel command> don't wait for command finish
sync wait for acmd processs finish.
ucp <soure> <destinate> copy file from/to target
T:<filename> means target board ←-
←-
file.
T:- means copy data to target's ←-
←-
stdio pipe.
copy image T:/root/image ;downl ←-
oad ←-
image to path /root/image
copy T:/root/image image ;uploa ←-
d / ←-
root/image to file image.
Example for transfer big file
acmd tar - ; run tar background and ge ←-
t data from stdio
ucp rootfs.tar.gz T:- ; send to target stdio pipe
sync ; wait for tar process exit ←-
.

For example:
SDPS: boot -f <filename>
SDP: boot -f <filename>
CFG: SDP: -chip imx6ull -pid 0x1234 -vid 0x5678

SDP: boot -f u-boot-imx7dsabresd_sd.imx -nojump

SDP: write -f zImage -addr 0x80800000
SDP: write -f zImage-imx7d-sdb.dtb -addr 0x83000000
SDP: write -f fsl-image-mfgtool-initramfs-imx_mfgtools.cpio.gz.u-boot -addr 0x ←-
83800000
SDP: jump -f u-boot-dtb.imx -iv

3 Usage Example

3.1 Basic

3.1.1 Download boot loader for imx6\imx7

uuu uboot.imx

3.1.2 Download boot loader for imx8qxp

uuu flash.bin
UUU (Universal Update Utility) 6 / 19

3.1.3 Download SPL and uboot, such as imx8mq.

uuu sdp: boot -f flash.bin

uuu sdpu: delay 1000
uuu sdpu: write -f flash.bin -offset 0x57c00
uuu sdpu: jump

3.1.4 Burn Android Image to eMMC

uuu android.zip (not implement default yet)

3.1.5 Burn yocto Image to eMMC

uuu L4.9.123_2.3.0_8mm-ga.zip

3.2 Built-in script

uuu -b emmc bootloader Write bootloader to emmc

uuu -b emmc_all bootloader rootfs.sdcard Write rootfs to emmc
uuu -b emmc_all bootloader rootfs.sdcard.bz2/* Decompress rootfs and write ←-
rootfs to emmc
uuu -b sd bootloader Write bootloader to sd card
uuu -b sd_all bootloader rootfs.sdcard Write rootfs to sd card
uuu -b sd_all bootloader rootfs.sdcard.bz2/* Decompress rootfs and write ←-
rootfs to sd card
uuu -b qspi qspi_bootloader write bootloader to qspi
uuu -b qspi qspi_bootloader m4image write m4image to qpsi
uuu -b spl bootloader Download SPL and uboot

Notes:
Some boards have many sd slot. built-in script only work uboot environment ${ ←-
sd_dev} point to slot
Some boards have not emmc chip, emmc build in script does not work for such boards

3.3 multi boards support

3.3.1 For the same boards

uuu -d uuu.auto The same boards connected

3.3.2 For the difference boards

uuu -d -m 1:1 -m 2:1 boardA_uuu.auto monitor port 1:1 and 2:1 for ←-
boardsA.
uuu -d -m 1:3 -m 4:1 boardB_uuu.auto monitor port 1:3 and 4:1 for ←-
boardsB.

Note: please avoid monitor the same port by difference uuu instance, which cause unexpected result.
UUU (Universal Update Utility) 7 / 19

3.4 Talk with fastboot

3.4.1 boot linux kernel

uuu FB: ucmd setenv fastboot_buffer ${loadaddr}

uuu FB: download -f Image
uuu FB: ucmd setenv fastboot_buffer ${fdt_addr}
uuu FB: download -f imx8qxp_mek.dtb
uuu FB: acmd booti ${loadaddr} - ${fdt_addr}

Extended environment for fastboot

fastboot_buffer Image download address
fastboot_bytes reflect previous download image byte size

3.4.2 write image to emmc

uuu FB: flash -raw2sparse all <image file>

4 Sample scripts

5 Supported protocol

UUU is scripted base multi protocol system.

Built in config:
Pctl Chip Vid Pid BcdVersion
==================================================
SDPS: MX8QXP 0x1fc9 0x012f [0x0002..0xffff]
SDPS: MX8QM 0x1fc9 0x0129 [0x0002..0xffff]
SDP: MX7D 0x15a2 0x0076
SDP: MX6Q 0x15a2 0x0054
SDP: MX6D 0x15a2 0x0061
SDP: MX6SL 0x15a2 0x0063
SDP: MX6SX 0x15a2 0x0071
SDP: MX6UL 0x15a2 0x007d
SDP: MX6ULL 0x15a2 0x0080
SDP: MX6SLL 0x1fc9 0x0128
SDP: MX7ULP 0x1fc9 0x0126
SDP: MXRT106X 0x1fc9 0x0135
SDP: MX8MM 0x1fc9 0x0134
SDP: MX8MQ 0x1fc9 0x012b
SDPU: SPL 0x0525 0xb4a4 [0x0000..0x04ff]
SDPV: SPL1 0x0525 0xb4a4 [0x0500..0xffff]
FBK: 0x066f 0x9afe
FBK: 0x066f 0x9bff
FB: 0x0525 0xa4a5
FB: 0x18d1 0x0d02
UUU (Universal Update Utility) 8 / 19

Table 2: Table UUU Protocol to USB lower level Map

UUU Protocol USB Low level transfer

SDP HID i.MX6/7, i.MX8 MM, i.MX8M
SDPU\SDPV HID uboot implement of SDP, SPL download uboot
SDPS HID i.MX8QXP i.MX8QM
FB winusb (windows), raw transfer by libusb
FBK winusb (windows), raw transfer by libusb

5.1 SDP: i.MX6/7 ROM download protocol

5.1.1 Supported command:

Run DCD from image with ivt header

dcd -f <filename>

write image to address.

write -f <filename> [-addr 0x000000] [-ivt 0]

ivt 0 means write to the address, which ivt pointer

jump to image with ivt header
jump -f <filename> [-ivt 0]

boot image, include (dcd, write and jump three commands)

boot -f <filename> [-nojump]

5.2 SDPU\SDPV: uboot implement simplified ROM SDP protocol

Uboot implemented i.MX 6/7 ROM SDP protocol. The support command the same as SDP.
SDPV is upgrade version of SDPU, which support -skipspl option for write command
See below for uboot requirement uboot-config-requirement

5.3 SDPS: i.MX8QXP and i.MX8QM ROM download protocol

send image by sdp command.

boot -f <filename> [-offset 0x0000]

5.4 FB: Android fastboot protocol

refer fast boot protocol

See below for uboot requirement
UUU (Universal Update Utility) 9 / 19

5.4.1 Support command:

getvar
ucmd <any uboot command>
acmd <any never returned uboot command, like booti, reboot>

# partition "all" means whole device.

flash [-raw2sparse] <partition> <filename>
download -f <filename>

**Some Uboot command need long time to finish. Default FB timeout is 2s. You can use below method to change timeout value
# time out set to 10000ms
FB[-t 10000]: ucmd <any uboot command>

Table 3: Table Fastboot environment

Variable Description
fastboot_dev fastboot flash device, support mmc and sata
fastboot_buffer fastboot download buffer adddress
fastboot_bytes fastboot download file size
emmc_dev eMMC device number
sd_dev sd slot device number

5.5 FBK: Android fastboot protocol, implement at initramfs. See project imx-uuu

5.5.1 Support command:

ucmd <any kernel command> and wait for command finish

acmd <any kernel command> don't wait for command finish
sync wait for acmlid processs finish.
ucp <soure> <destinate> copy file from/to target
T:<filename> means target board file.
T:- means copy data to target's stdio pipe.
copy image T:/root/image ;download image to path /root/ ←-
image
copy T:/root/image image ;upload /root/image to file ←-
image......

Example for transfer big file

acmd tar - ; run tar background and get data from stdio
ucp rootfs.tar.gz T:- ; send to target stdio pipe
sync ; wait for tar process exit.

Linux environment:
Each command in separate process so environment can not be affect next command. Use below method to workaround this
problem.
FBK: ucmd source /tmp/mtd.sh; flash_erase /dev/mtd${nandrootfs} 0 0

5.6 Common command for all protocol

UUU (Universal Update Utility) 10 / 19

Table 4: Table Common command for all protocol

Command Description
Done last command for finish whole flow.
Delay Busy wait for millisecond
SH/SHELL run external command
< stdout as command, such as "< echo ucmd print", which
generally used for burn serial number

6 Migration from mfgtool ucl2.xml

**Most case user can use uboot fastboot protocol to finish image program work.
In case you have to load kernel to burn whole image.
The below simple map ucl2.xml to uuu script.

ucl2.xml uuu
<CMD state="BootStrap" type="boot" body="BootStrap" SDPS: boot -f flash.bin
file ="firmware/flash.bin" ifdev="MX8QXPB0">Loading
boot image</CMD>
<CMD state="BootStrap" type="boot" body="BootStrap" SDPS: boot -f flash.bin
file ="firmware/flash.bin" ifdev="MX8QXPB0">Loading
boot image</CMD>
<CMD state="BootStrap" type="boot" body="BootStrap" SDP: boot -f flash.bin SDP: boot -f flash.bin
file ="firmware/flash.bin" ifdev="MX8MM">Loading SDPU: write -f flash.bin -offset 0x57c00
U-boot</CMD> SDPU: jump
<CMD state="BootStrap" type="load" FB: ucmd download -f Image
file="firmware/Image" address="0x80280000"
loadSection="OTH" setSection="OTH"
HasFlashHeader="FALSE" ifdev="MX8QXP
MX8QM">Loading Kernel.</CMD>
<CMD state="BootStrap" type="load" FB: ucmd download -f initramfs.cpio.gz.uboot
file="firmware/initramfs.cpio.gz.uboot"
address="0x83800000" loadSection="OTH"
setSection="OTH" HasFlashHeader="FALSE"
ifdev="MX8QM MX8QXP">Loading Initramfs.</CMD>
<CMD state="BootStrap" type="load" FB: ucmd download -f fsl-imx8qxp.dtb
file="firmware/fsl-imx8qxp.dtb" address="0x83000000"
loadSection="OTH" setSection="OTH"
HasFlashHeader="FALSE" ifdev="MX8QXP">Loading
device tree.</CMD>
<CMD state="BootStrap" type="jump" > Jumping to OS
image. </CMD>
<!-- create partition -→ <CMD state="Updater" FBK: ucp mksdcard.sh.tar t:/tmp
type="push" body="send" file="mksdcard.sh.tar">Sending
partition shell</CMD>
<CMD state="Updater" type="push" body="$ tar xf $FILE FBK: ucmd tar xf /tmp/mksdcard.sh.tar -d /tmp
"> Partitioning. . . </CMD>
<CMD state="Updater" type="push" body="$ sh FBK: ucmd mksdcard.sh /dev/mmcblk0mmc
mksdcard.sh /dev/mmcblk%mmc%">
Partitioning. . . </CMD>
<!-- burn uboot -→ <CMD state="Updater" type="push" FBK: ucp imx-boot-imx8qxp-sd.bin t:/tmp
body="send" file="files/imx-boot-imx8qxp-sd.bin"
ifdev="MX8QXPB0">Sending u-boot.bin</CMD>
UUU (Universal Update Utility) 11 / 19

<CMD state="Updater" type="push" body="$ dd FBK: ucmd dd if=/dev/zero of=/dev/mmcblk0 bs=1k

if=/dev/zero of=/dev/mmcblk0 bs=1k seek=4096 seek=4096 conv=fsync count=8
conv=fsync count=8">clear u-boot arg</CMD>
<CMD state="Updater" type="push" body="$ dd if=$FILE FBK: ucmd dd if=/tmp/imx-boot-imx8qxp-sd.bin
of=/dev/mmcblk0 bs=1k seek=33 conv=fsync" of=/dev/mmcblk0 bs=1k seek=33 conv=fsync
ifdev="MX8QM MX8QXP MX8MQ">write u-boot.bin to
sd card</CMD>
<CMD state="Updater" type="push" body="$ while [ ! -e FBK: ucmd while [ ! -e /dev/mmcblk%mmc%p1 ]; do
/dev/mmcblk0p1 ]; do sleep 1; echo waiting. . . ; done sleep 1; echo waiting. . . ; done
">Waiting for the partition ready</CMD>
<CMD state="Updater" type="push" body="$ mkfs.vfat FBK: ucmd mkfs.vfat /dev/mmcblk0p1
/dev/mmcblk0p1">Formatting rootfs partition</CMD>
<CMD state="Updater" type="push" body="$ mkdir -p FBK: ucmd mkdir -p /mnt/mmcblk0p1
/mnt/mmcblk0p1"/>
<CMD state="Updater" type="push" body="$ mount -t FBK: ucmd vfat /dev/mmcblk0p1 /mnt/mmcblk0p1
vfat /dev/mmcblk0p1 /mnt/mmcblk0p1"/>
<!-- burn zImage -→ <CMD state="Updater" type="push" FBK: ucp Image t:/tmp
body="send" file="files/Image">Sending kernel</CMD>
<CMD state="Updater" type="push" body="$ cp $FILE FBK: ucmd /tmp/Image /mnt/mmcblk0p1/Image
/mnt/mmcblk0p1/Image">write kernel image to sd
card</CMD>
<!-- burn dtb -→ <CMD state="Updater" type="push" FBK: ucp fsl-imx8qxp.dtb /tmp
body="send" file="files/fsl-imx8qxp.dtb"
ifdev="MX8QXP MX8QXPB0">Sending Device Tree
file</CMD>
<CMD state="Updater" type="push" body="$ cp $FILE FBK: ucmd cp /tmp/fsl-imx8qxp.dtb /mnt/mmcblk0p1/
/mnt/mmcblk0p1/fsl-imx8qm.dtb" ifdev="MX8QM">write
device tree to sd card</CMD>
<CMD state="Updater" type="push" body="$ umount FBK: ucmd umount /mnt/mmcblk0p1
/mnt/mmcblk0p1">Unmounting vfat partition</CMD>
<!-- burn rootfs -→ <CMD state="Updater" type="push" FBK: ucmd mkfs.ext3 -F -j /dev/mmcblk0p2
body="$ mkfs.ext3 -F -j /dev/mmcblk0p2">Formatting
rootfs partition</CMD>
<!-- burn rootfs -→ <CMD state="Updater" type="push" FBK: ucmd mkfs.ext3 -F -j /dev/mmcblk0p2
body="$ mkfs.ext3 -F -j /dev/mmcblk0p2">Formatting
rootfs partition</CMD>
<CMD state="Updater" type="push" body="$ mkdir -p FBK: ucmd mkdir -p /mnt/mmcblk0p2
/mnt/mmcblk0p2"/>
<CMD state="Updater" type="push" body="$ mount -t FBK: ucmd mount -t ext3 /dev/mmcblk0p2
ext3 /dev/mmcblk0p2 /mnt/mmcblk0p2"/> /mnt/mmcblk0p2
<CMD state="Updater" type="push" body="pipe tar -jxv FBK: acmd tar -jxv -C /mnt/mmcblk0p2
-C /mnt/mmcblk0p2" file="files/rootfs.tar.bz2">Sending FBK: ucp rootfs.tar.bz2 t:-
and writting rootfs</CMD>
<CMD state="Updater" type="push" body="frf">Finishing FBK: sync
rootfs write</CMD>
<CMD state="Updater" type="push" body="$ umount FBK: ucmd umount /mnt/mmcblk0p2
/mnt/mmcblk0p2">Unmounting rootfs partition</CMD>
<CMD state="Updater" type="push" body="$ echo Update done
Complete!">Done</CMD>

7 Win 7 User Guide

Win7 user may face some additional one time setup work because original win7 missed a updated .inf file
UUU (Universal Update Utility) 12 / 19

7.1 Back Ground

Win7 ships with correct winusb.sys file. but is missing an updated .inf that associates with "usb\ms_comp_winusb" devices.
Normally if the USB device supports Microsoft OS descriptors, then it will allow Windows to automatically install the WinUSB
driver. This mechanism is supported "in-box" for Win8 and newer. For Win7 the mechanism is supported through Windows
update. Depending on the update policy for the Win7 machine, the appropriate driver may or may not be already available on the
machine. If it is not already on the machine, user can use the following manual procedure to install the driver if necessary. (copy
from https://www.silabs.com/community/interface/knowledge-base.entry.html/2017/02/06/manually_installwin-A2Jj")
Some windows update also included updated .inf file. You can try run uuu to see what happen. If windows report "can’t install
driver", that means your system missed such update file.

7.2 Install updated winusb inf file

• Download package
• unzip

• run install.bat as administrator permission.

• The below screen show install success

Notes:
4.9.123 8MM GA and 4.14 beta release missed a patch. Please apply below patch in uboot
UUU (Universal Update Utility) 13 / 19

7.3 Use zadig to install winusb driver

If still fail install winusb driver you can try below method. you can try download zadig from https://zadig.akeo.ie/
Choose USB download device and click install.

If you already apply patch and still see WCID is red "x", please submit issue.

8 FAQ

• Win7 can’t found driver

– Need install winusb driver, you can use https://zadig.akeo.ie/ to install winusb driver
– see page WIN7-User-Guide
• Linux: Open device failure
sudo uuu xxx

• Some iMX8mm(845) chip failure write at linux system

Need apply ROM patch, contact FAE to get it.

• How to use absolute path in scripts

Default all paths in script is related uuu scripts. if you want to use absolute ←-
path in scripts

Add ">" in path like

>/home/xxx

• uuu exit silence or report missed dll

Please upgrade to 1.2.x

• How to avoid sudo in linux

Put below context into /etc/udev/rules.d/99-uuu.rules (need sudo)
UUU (Universal Update Utility) 14 / 19

SUBSYSTEM=="usb", ATTRS{idVendor}=="1fc9", ATTRS{idProduct}=="012f", MODE="0666"

SUBSYSTEM=="usb", ATTRS{idVendor}=="1fc9", ATTRS{idProduct}=="0129", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="15a2", ATTRS{idProduct}=="0076", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="15a2", ATTRS{idProduct}=="0054", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="15a2", ATTRS{idProduct}=="0061", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="15a2", ATTRS{idProduct}=="0063", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="15a2", ATTRS{idProduct}=="0071", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="15a2", ATTRS{idProduct}=="007d", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="15a2", ATTRS{idProduct}=="0080", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="1fc9", ATTRS{idProduct}=="0128", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="1fc9", ATTRS{idProduct}=="0126", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="1fc9", ATTRS{idProduct}=="0135", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="1fc9", ATTRS{idProduct}=="0134", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="1fc9", ATTRS{idProduct}=="012b", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="0525", ATTRS{idProduct}=="b4a4", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="0525", ATTRS{idProduct}=="a4a5", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="066F", ATTRS{idProduct}=="9BFF", MODE="0666"

run sudo udevadm control --reload-rules

uuu -udev can show above help.

• How to get file in zip without decompress

Assume there are file name uuu.auto in A.zip file.

A.zip/uuu.auto

for example:

uuu A.zip/uuu.auto

• How to send out uncompress bz2

Added /* after bz2 file

for example

uuu -b emmc_all <bootloader> sdcard.bz2/*

• Boot fail after burn > 4G Image

uboot need below patch

diff --git a/common/image-sparse.c b/common/image-sparse.c

index ddf5772..86ff5a0 100644
--- a/common/image-sparse.c
+++ b/common/image-sparse.c
@@ -59,7 +59,7 @@ void write_sparse_image(
uint32_t bytes_written = 0;
unsigned int chunk;
unsigned int offset;
- unsigned int chunk_data_sz;
+ uint64_t chunk_data_sz;
UUU (Universal Update Utility) 15 / 19

uint32_t *fill_buf = NULL;

uint32_t fill_val;
sparse_header_t *sparse_header;
@@ -130,7 +130,7 @@ void write_sparse_image(
sizeof(chunk_header_t));
}

- chunk_data_sz = sparse_header->blk_sz * chunk_header-> ←-

chunk_sz;
+ chunk_data_sz = (uint64_t)sparse_header->blk_sz * (uint64_t) ←-
chunk_header->chunk_sz;
blkcnt = chunk_data_sz / info->blksz;
switch (chunk_header->chunk_type) {
case CHUNK_TYPE_RAW:

• WCID failure load

Apply below uboot patch

diff --git a/drivers/usb/gadget/f_fastboot.c b/drivers/usb/gadget/f_fastboot.c
index ae8fe80..cd46ca4 100644
--- a/drivers/usb/gadget/f_fastboot.c
+++ b/drivers/usb/gadget/f_fastboot.c
@@ -2543,10 +2543,10 @@ static int fastboot_bind(struct usb_configuration *c, ←-
struct usb_function *f)
f->os_desc_table->if_id = id;
INIT_LIST_HEAD(&fb_os_desc.ext_prop);
fb_ext_prop.name_len = strlen(fb_ext_prop.name) * 2 + 2;
- fb_os_desc.ext_prop_len = 14 + fb_ext_prop.name_len;
+ fb_os_desc.ext_prop_len = 10 + fb_ext_prop.name_len;
fb_os_desc.ext_prop_count = 1;
- fb_ext_prop.data_len = strlen(fb_ext_prop.data);
- fb_os_desc.ext_prop_len += fb_ext_prop.data_len;
+ fb_ext_prop.data_len = strlen(fb_ext_prop.data) * 2 + 2;
+ fb_os_desc.ext_prop_len += fb_ext_prop.data_len + 4;
list_add_tail(&fb_ext_prop.entry, &fb_os_desc.ext_prop);

id = usb_string_id(c->cdev);

9 Build Steps

9.1 windows

• download visual studio 2017 community version (free)

• git clone https://github.com/NXPmicro/mfgtools.git
• cd mfgtools
• git submodule init
• git submodule update
• open msvs/uuu.sln by vs2017
• click build
UUU (Universal Update Utility) 16 / 19

9.2 linux

• git clone https://github.com/NXPmicro/mfgtools.git

• cd mfgtools
• sudo apt-get install libusb-1.0.0-dev libzip-dev libbz2-dev
• cmake .
• make

10 Uboot config requirement

To talk with uuu, uboot need enable fastboot. fastboot need auto run when detect boot from USB.
CONFIG_CMD_FASTBOOT=y
CONFIG_USB_FUNCTION_FASTBOOT=y
CONFIG_USB_GADGET=y
CONFIG_USB_GADGET_DOWNLOAD=y
CONFIG_USB_GADGET_MANUFACTURER="FSL"
CONFIG_USB_GADGET_VENDOR_NUM=0x0525
CONFIG_USB_GADGET_PRODUCT_NUM=0xa4a5
CONFIG_CI_UDC=y # UDC need change according system, ←-
some system use CONFIG_USB_DWC3, some use CONFIG_USB_CDNS3
CONFIG_FSL_FASTBOOT=y
CONFIG_FASTBOOT=y
CONFIG_FASTBOOT_BUF_ADDR=0x83800000 # Address need change according ←-
system, generally it can be the same as ${LOADADDR}
CONFIG_FASTBOOT_BUF_SIZE=0x40000000
CONFIG_FASTBOOT_FLASH=y
CONFIG_FASTBOOT_FLASH_MMC_DEV=1
CONFIG_EFI_PARTITION=y
CONFIG_ANDROID_BOOT_IMAGE=y

If use SPL, SDP need be enabled.

CONFIG_SPL_USB_HOST_SUPPORT=y
CONFIG_SPL_USB_GADGET_SUPPORT=y
CONFIG_SPL_USB_SDP_SUPPORT=y
CONFIG_SDP_LOADADDR=0x40400000 # Address need change according ←-
system, choose free memory

uuu related patches.

https://source.codeaurora.org/external/imx/uboot-imx/log/?h=imx_v2017.03_4.9.123_imx8mm_ga
About Fastboot enable:
719651a MLK-18257-1 Enable fastboot support in qxp mek board
d5226a3 MLK-18257-2: fix fastboot build warning
219c989 MLK-18257-3 run fastboot if initramfs is in validate
09b1876 MLK-18257-4 use another method check if need run bootcmd_mfg
3b1fa9d MLK-18257-5 enhence fastboot uboot cmd
ca96e0b MLK-18406 fastboot support all partition

About uboot SDP enable:

UUU (Universal Update Utility) 17 / 19

192a26d MLK-18707-1: SDP: use CONFIG_SDP_LOADADDR as default load address

9764fb2 MLK-18707-2 iMX8M enable fastboot as default
db9a634 MLK-18862 imx8mm uuu can write emmc by fastboot

Additional environment need be define

Table 5: Table uuu environment

Variable Usage Description

emmc_dev emmc burn eMMC device number
sd_dev burn sd sd slot device number
kboot boot kernel\burn nand kernel boot command, it is booti for
arm64, bootz for arm32
weim_uboot burn weim nor uboot burn to position of weim nor
weim_base burn weim nor weim base address
mtdparts burn nand NAND flash partition configuration,
such as
"mtdparts=8000000.nor:1m(boot),-
(rootfs)\\;gpmi-
nand:64m(nandboot),16m(nandkernel),16m(nand
(nandrootfs)
"
spi_bus burn spi (not qspi\fspi) spi nor flash bus number
spi_uboot burn spi (not qspi\fspi) spi nor flash uboot offset

11 kernel config requirement

Some kernel config required

• USB CONFIG FS need be built-in

• One of UDC driver and PHY need be built-in
• Funnction FS need be enabled

Device Drivers
USB support
USB gadget support (very last entry)
USB Gadget Drivers (...)
USB functions configurable through configfs
Mass storage
Function filesystem (functionFS)

12 Release Notes

12.1 1.2.TBD (Next)

12.1.1 New features

• Auto parameter complete support

UUU (Universal Update Utility) 18 / 19

• Add option -udev to help create udev rule to avoid use sudo
• Remove VT color at win7
• Fail back to verbose mode at win7
• Enable uboot shell mode
• Just print help when run uuu
• Added blog command to fetch message from uboot boot log
• Support file path include space. need add "" at file path
• Windows version built-in libusb
• New SDPV support to support -skipsql for uboot, which support auto scan uboot position.

12.1.2 Bug fixes

• Fixed uuu "fb[-t 1000]:" ucmd wait forever problem

• Fixed missed sdpu: done at spl built in script
• Fixed show nothing when wait for usb connection
• Fixed random claim interface failure at windows platform
• Fixed random crash when multi-device download at windows platform
• Fixed memory leak.
• Fixed #79 file all zero when ucp from target to host
• Fixed crash when done is not last cmd

12.2 1.2.0

12.2.1 New features

• Support decompress bz2 file, sdcard.bz2/* means decompress it.

• Support enter shell after run script

12.2.2 Bug fixes

• Fix mx6 boot failure when enable security

• Fix windows version dependent on vs redistribute package

12.3 1.1.81

12.3.1 New features

• Support shell command

• Support shell command generate dynamic uuu command to burn sequence id, like MAC address
• Reduce cpu usage rate at windows platform by increase each bulk transfer size
• Added q(quit) to exit shell at -s mode
UUU (Universal Update Utility) 19 / 19

12.3.2 Bug fixes

• fixed some typo

• fixed build script qspi burn failure if file size > 1M

• fixed file locked by uuu to prevent user update it.
• fixed crash at special uboot size

12.4 1.1.41

12.4.1 New features

• Support SDP protocol (i.MX6x, i.MX7, i.MX8M, i.MX8MM)

• Support SDPS protocol (i.MX8QXP B0, i.MX8QM B0)
• Support SDPU protocol (uboot\SPL implemented SDP protocol)
• Support FB protocol (fastboot with uboot)

• Support FBK protocol (fastboot in kernel, daemon implement at imx-uuc)

• Support multi-device download
• Support built-in script

12.4.2 Bug fixes

• Fix sometime open usb device failure at windows platform.

• Fix protocol case sensitive problem in script
• Fix open zip file failure

13 Known issue

• some old i.MX8MM board HID can’t work in linux system. Need apply ROM patch to fix. Please contact FAE.
• QXP/QM NAND image can’t download by UUU because alignment requirement is difference