README.md

   1 # uuu (Universal Update Utility), mfgtools 3.0
   2
   3 [![Build status](https://ci.appveyor.com/api/projects/status/evp1xvj88ybuhfwi?svg=true)](https://ci.appveyor.com/project/nxpfrankli/mfgtools-kvqcg)
   4 [![Build Status](https://travis-ci.com/NXPmicro/mfgtools.svg?branch=master)](https://travis-ci.com/NXPmicro/mfgtools)
   5
   6 ![GitHub](https://img.shields.io/github/license/nxp-imx/mfgtools.svg)
   7
   8 [![universal-update-utility](https://snapcraft.io/universal-update-utility/badge.svg)](https://snapcraft.io/universal-update-utility)
   9
  10 Freescale/NXP I.MX Chip image deploy tools.
  11 **original linux version uses "linux" branch, windows version uses "windows" branch**
  12
  13     uuu (universal update utility) for nxp imx chips -- libuuu-1.0.1-gffd9837
  14
  15     Succeded:0       Failed:3               Wait for Known USB Devices to Appear...
  16
  17     1:11     5/5 [                                        ] SDP: jump -f u-boot-dtb.imx -ivtinitramf....
  18     2:1      1/5 [===>                                    ] SDP: boot -f u-boot-imx7dsabresd_sd.imx ....
  19
  20 # Key features
  21  - The real cross platform. Linux, Windows, MacOS(not test yet)
  22  - Multi devices program support
  23  - Daemon mode support
  24  - Few depedencies (only libusb, zlibc, libbz2)
  25  - Firmware (uboot/kernel) uses WCID to auto load the winusb driver on the Windows side. Windows7 users need to install the winusb driver from https://zadig.akeo.ie/  Windows10 will install the driver automatically.
  26
  27 # Examples:
  28 ```
  29   uuu u-boot.imx            Download u-boot.imx via HID device
  30
  31   uuu list.uu               Run all the commands in list.uu
  32
  33   uuu -s                    Enter shell mode. Input command.
  34
  35   uuu -v u-boot.imx         verbose mode
  36
  37   uuu -d u-boot.imx         Once it detects the attachement of a known device, download boot.imx.
  38
  39                             u-boot.imx can be replaced, new file will be download once board reset.
  40
  41                             Do not unplug the SD card, write to the SD card, nor plug in a SD card when debugging uboot.
  42
  43   uuu -b emmc u-boot.imx    write u-boot.imx to emmc boot partition. u-boot.imx need enable fastboot
  44
  45   uuu -b emmc_all u-boot.imx sdcard.bz2\*
  46                             decompress sdcard.bz2 file and download the whole image into emmc
  47 ```
  48
  49 # Prebuilt Image and pdf document
  50
  51 The prebuilt image and document are here:
  52   - https://github.com/nxp-imx/mfgtools/releases
  53   - UUU.pdf is snapshot of [wiki](https://github.com/nxp-imx/mfgtools/wiki)
  54
  55 # How to Build:
  56
  57 ## Windows
  58 - `git clone https://github.com/nxp-imx/mfgtools.git`
  59 - `cd mfgtools`
  60 - `git submodule init`
  61 - `git submodule update`
  62 - `open msvs/uuu.sln with Visual Studio 2017`
  63
  64 Visual Studio
  65
  66 Note that, since uuu is an OSI compliant Open Source project, you are entitled to download and use the freely available Visual Studio Community Edition to build, run or develop for uuu. As per the Visual Studio Community Edition license this applies regardless of whether you are an individual or a corporate user.
  67
  68 ## Linux
  69 - `git clone https://github.com/nxp-imx/mfgtools.git`
  70 - `cd mfgtools`
  71 - `sudo apt-get install libusb-1.0-0-dev libbz2-dev libzstd-dev pkg-config cmake libssl-dev g++`
  72 - `cmake . && make`
  73
  74 The above commands build mfgtools in source. To build it out of source
  75 (requires cmake 3.13 or newer):
  76 - `cmake -S . -B build`
  77 - `cmake --build build --target all`
  78
  79 For cmake prior 3.13:
  80 - `mkdir build && cd build`
  81 - `cmake .. && make`
  82
  83 ## macOS
  84 - `git clone https://github.com/nxp-imx/mfgtools.git`
  85 - `cd mfgtools`
  86 - `brew install cmake libusb openssl pkg-config`
  87 - `cmake -DOPENSSL_ROOT_DIR=$(brew --prefix)/opt/openssl . && make`
  88
  89 Note that we assume [brew](https://brew.sh) is installed and can be used to resolve dependencies as shown above. The remaining dependency `libbz2` can be resolved via the XCode supplied libraries.
  90
  91 # Run environment
  92  - Windows 10 64 bit
  93  - Linux (Ubuntu) 64 bit
  94  - macOS (Catalina)
  95  - 32 bit systems will have problems with big files.
  96
  97 # License
  98 uuu is licensed under the BSD license. See LICENSE.
  99 The BSD licensed prebuilt Windows binary version of uuu is statically linked with the LGPL libusb library, which remains LGPL.
 100
 101  - bzip2 (BSD license) is from https://github.com/enthought/bzip2-1.0.6
 102  - zlib  (zlib license) is from https://github.com/madler/zlib.git
 103  - libusb (LGPL-2.1) is from  https://github.com/libusb/libusb.git
 104  - zstd (Dual BSD\GPLv2 Licenses) is from https://github.com/facebook/zstd