README.md

   1 # uuu (Universal Update Utility), mfgtools 3.0
   2
   3 ![Build status](https://ci.appveyor.com/api/projects/status/github/NXPmicro/mfgtools?svg=true)
   4
   5 Freescale/NXP I.MX Chip image deploy tools.
   6 **original linux version uses "linux" branch, windows version uses "windows" branch**
   7
   8     uuu (universal update utility) for nxp imx chips -- libuuu-1.0.1-gffd9837
   9
  10     Succeded:0       Failed:3               Wait for Known USB Devices to Appear...
  11
  12     1:11     5/5 [                                        ] SDP: jump -f u-boot-dtb.imx -ivtinitramf....
  13     2:1      1/5 [===>                                    ] SDP: boot -f u-boot-imx7dsabresd_sd.imx ....
  14
  15 # Key features
  16  - The real cross platform. Linux, Windows, MacOS(not test yet)
  17  - Multi devices program support
  18  - Daemon mode support
  19  - Few depedencies (only libusb, zlibc, libbz2)
  20  - Firmware (uboot/kernel) uses WCID to auto load the winusb drvier on the Windows side. Windows7 users need to install the winusb driver from https://zadig.akeo.ie/  Windows10 will install the driver automatically.
  21
  22 # Examples:
  23 ```
  24   uuu u-boot.imx            Download u-boot.imx via HID device
  25
  26   uuu list.uu               Run all the commands in list.uu
  27
  28   uuu -s                    Enter shell mode. Input command.
  29
  30   uuu -v u-boot.imx         verbose mode
  31
  32   uuu -d u-boot.imx         Once it detects the attachement of a known device, download boot.imx.
  33
  34                             u-boot.imx can be replaced, new file will be download once board reset.
  35
  36                             Do not unplug the SD card, write to the SD card, nor plug in a SD card when debugging uboot.
  37
  38   uuu -b emmc u-boot.imx    write u-boot.imx to emmc boot partition. u-boot.imx need enable fastboot
  39
  40   uuu -b emmc_all u-boot.imx sdcard.bz2\*
  41                             decompress sdcard.bz2 file and download the whole image into emmc
  42 ```
  43
  44 # Prebuilt Image and pdf document
  45
  46 The prebuilt image and document are here:
  47   - https://github.com/NXPmicro/mfgtools/releases
  48   - UUU.pdf is snapshot of [wiki](https://github.com/NXPmicro/mfgtools/wiki)
  49
  50 # How to Build:
  51
  52 ## Windows
  53 - git clone https://github.com/NXPmicro/mfgtools.git
  54 - cd mfgtools
  55 - git submodule init
  56 - git submodule update
  57 - open msvs/uuu.sln with Visual Studio 2017
  58
  59 ## Linux
  60 - git clone https://github.com/NXPmicro/mfgtools.git
  61 - cd mfgtools
  62 - sudo apt-get install libusb-1.0.0-dev libzip-dev libbz2-dev pkg-config
  63 - cmake .
  64 - make
  65
  66 # Run environment
  67  - Windows 10 64 bit
  68  - Linux (Ubuntu) 64 bit
  69  - 32 bit systems will have problems with big files.
  70
  71 # License
  72 uuu is licensed under the BSD license. See LICENSE.
  73 The BSD licensed prebuilt Windows binary version of uuu is statically linked with the LGPL libusb library, which remains LGPL.
  74
  75  - bzip2 (BSD license) is from https://github.com/enthought/bzip2-1.0.6
  76  - zlib  (zlib license) is from https://github.com/madler/zlib.git
  77  - libusb (LGPL-2.1) is from  https://github.com/libusb/libusb.git