UUU (Universal Update Utility)
UUU (Universal Update Utility)
UUU (Universal Update Utility)
REVISION HISTORY
1fccd7a Mon Jul 8 10:36:42 Add notes for super speed nxpfrankli
2019 -0500
REVISION HISTORY
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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
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 6
3.1 Basic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.1.1 Download boot loader for imx6\imx7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.1.2 Download boot loader for imx8qxp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.3.1 For the same boards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.3.2 For the difference boards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
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 HABv4 closed chip support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
5.3 SDPU\SDPV: uboot implement simplified ROM SDP protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.4 SDPS: i.MX8QXP and i.MX8QM ROM download protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
5.5 FB: Android fastboot protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
5.5.1 Support command: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
5.6 FBK: Android fastboot protocol, implement at initramfs. See project imx-uuu . . . . . . . . . . . . . . . . . . . 10
5.6.1 Support command: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
5.7 Common command for all protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
UUU (Universal Update Utility) v
8 FAQ 15
9 Build Steps 17
9.1 windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
9.2 linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
12 Release Notes 19
12.1 1.3.130 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
12.1.1 New features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
12.1.2 Bug fixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
12.2 1.3.102 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
12.2.1 New features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
12.2.2 Bug fixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
12.3 1.3.82 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
12.3.1 New features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
12.3.2 Bug fixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
12.4 1.2.135 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
12.4.1 New features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
12.4.2 Bug fixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
12.5 1.2.91 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
12.5.1 New features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
12.5.2 Bug fixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
12.6 1.2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
12.6.1 New features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
12.6.2 Bug fixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
12.7 1.1.81 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
12.7.1 New features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
12.7.2 Bug fixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
12.8 1.1.41 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
12.8.1 New features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
12.8.2 Bug fixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
13 Known issue 23
UUU (Universal Update Utility) 1 / 23
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
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.
Running environment
• Windows 10, 64bit, early version(below 1.2.0) need install vs2017 redistribute package
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
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
Typical Script
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
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.
(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.
windows
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
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 [?]
Syntactic
---------------------------------------------------------------------
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
dcd -f <filename>
write -f <filename> [-addr 0x000000] [-ivt 0]
jump -f <filename> [-ivt 0]
boot -f <filename> [-nojump]
For example:
SDPS: boot -f <filename>
SDP: boot -f <filename>
CFG: SDP: -chip imx6ull -pid 0x1234 -vid 0x5678
Notes: Some board supports super speed (USB3.0). USB 3.0 port path is difference USB 2.0. If use -m to filter port, you need
add USB 3.0 port number otherwise fastboot will not be detected.
UUU (Universal Update Utility) 6 / 23
Usage Example
Basic
uuu uboot.imx
uuu flash.bin
uuu L4.9.123_2.3.0_8mm-ga.zip
Built-in script
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
UUU (Universal Update Utility) 7 / 23
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.
Sample scripts
Supported protocol
Supported command:
For boot images not including a DCD table the same image used for SDCard/eMMC boot can be used with UUU tool.
For boot images including a DCD table, the DCD is loaded in OCRAM and must be properly signed.
Since U-Boot v2017.01 a build log containing the U-Boot and DCD addresses and lengths is available just after building U-Boot:
UUU (Universal Update Utility) 9 / 23
$ cat u-boot-dtb.imx.log
Image Type: Freescale IMX Boot Image
Image Ver: 2 (i.MX53/6/7 compatible)
Mode: DCD
Data Size: 602112 Bytes = 588.00 KiB = 0.57 MiB
Load Address: 877ff420
Entry Point: 87800000
HAB Blocks: 877ff400 00000000 0008ec00
DCD Blocks: 00910000 0000002c 000001c4
Users can copy the information above to create their CSF Authenticate Data command:
Block = 0x877ff400 0x00000000 0x0006DC00 "u-boot-dtb.imx", \
0x00910000 0x0000002c 0x000001c4 "u-boot-dtb.imx"
Alternatively users can also extract the DCD length from the DCD table header:
$ od -x -j 0x2c -N 4 --endian=big u-boot-dtb.imx
0000054 d201 c440
0000060
DCD Header: 0xd2, DCD Length: 0x01c4, DCD Version: 0x40
For the i.MX devices not supporting the skip DCD command (i.MX6Dual/Quad and i.MX6Sololite) the pointer to the DCD table
is cleared in the IVT in order to prevent the HAB library from processing the DCD table again during the authentication process.
There is no need to re-initialize memory when it already contains valid data.
Since the IVT is modified when downloading to the target the binary must be signed with a cleared DCD pointer. However, the
binary must be provided with a valid DCD pointer to allow the UUU tool to locate the DCD table.
The following script can be used to used to handle the DCD pointer:
#!/bin/bash
# DCD address must be cleared for signature, as UUU will clear it.
if [ "$1" == "clear_dcd_addr" ]; then
# store the DCD address
dd if=$2 of=dcd_addr.bin bs=1 count=4 skip=12
# generate a NULL address for the DCD
dd if=/dev/zero of=zero.bin bs=1 count=4
# replace the DCD address with the NULL address
dd if=zero.bin of=$2 seek=12 bs=1 conv=notrunc
fi
# DCD address must be set for mfgtool to localize the DCD table.
if [ "$1" == "set_dcd_addr" ]; then
# restore the DCD address with the original address dd
if=dcd_addr.bin of=$2 seek=12 bs=1 conv=notrunc
rm zero.bin
fi
Uboot implemented i.MX 6/7 ROM SDP protocol. The support command the same as SDP.
UUU (Universal Update Utility) 10 / 23
SDPV is upgrade version of SDPU, which support -skipspl option for write command
See below for uboot requirement uboot-config-requirement
Support command:
getvar
ucmd <any uboot command>
acmd <any never returned uboot command, like booti, reboot>
**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>
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
Support command:
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
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
**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>
UUU (Universal Update Utility) 12 / 23
<!-- 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>
Win7 user may face some additional one time setup work because original win7 missed a updated .inf file
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.
• Download package
• unzip
• run install.bat as administrator permission.
Notes:
4.9.123 8MM GA and 4.14 beta release missed a patch. Please apply below patch in uboot
Please make sure you success download uboot and uboot auto launch fastboot command. windows find Usb download device,
NOT SE Blank
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.
Notes:
"SE Blank xx" is ROM HID device. PLEASE DON’T CHOOSE IT TO WINUSB. libusb can work well with HID device. Only
"Usb download device" need check
UUU (Universal Update Utility) 15 / 23
FAQ
– 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
>/home/xxx
A.zip/uuu.auto
for example:
uuu A.zip/uuu.auto
for example
id = usb_string_id(c->cdev);
If use bz2 or zip file, it is possible out of memory. Please increase swap partition size in linux. increase virtual memory size in
windows.
Build Steps
windows
linux
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
Table 5: (continued)
Device Drivers
USB support
USB gadget support (very last entry)
USB Gadget Drivers (...)
USB functions configurable through configfs
Mass storage
Function filesystem (functionFS)
Release Notes
1.3.130
New features
Bug fixes
1.3.102
New features
Bug fixes
• fixed #136 fix decompress failure if use uncompressed method in zip file.
• fixed something wait forever when download bz2 from http
• fix http request failure at some host (use \r\n at http request)
1.3.82
New features
• Add -lsusb option to list all connected known devices to help find usb path when do multi boards support
UUU (Universal Update Utility) 21 / 23
Bug fixes
• Upgrade libusb to 1.0.23-rc3 to resolve some windows compatibility problem. such as exit if not usb port under virtual root
hub.
• Fix bz2 decompress problem if bz2 created by bzip2 instead of pbzip2.
• Fix missed last chunk data for android sparse image
• fixed #123: implement timeout for wait known usb device appear
1.2.135
New features
• Support i.MX28
• Add Read\write a memory address for i.MX6/i.MX7
Bug fixes
1.2.91
New features
• Add option -udev to help create udev rule to avoid use sudo
• Remove VT color at win7
• Fail back to verbose mode at win7
Bug fixes
1.2.0
New features
Bug fixes
1.1.81
New features
• 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
Bug fixes
1.1.41
New features
Bug fixes
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
• Bz2 file only support one that is generated by pbbz2. there are problem if use bzip2 generate bz2.