README.md

   1 # uuu (Universal Update Utility), mfgtools 3.0
   2
   3 [![macOS Build](https://github.com/nxp-imx/mfgtools/actions/workflows/macOS.yaml/badge.svg?branch=master)](https://github.com/nxp-imx/mfgtools/actions/workflows/macOS.yaml)
   4 [![Build with VS Studio](https://github.com/nxp-imx/mfgtools/actions/workflows/win.yaml/badge.svg)](https://github.com/nxp-imx/mfgtools/actions/workflows/win.yaml)
   5 [![Build for x64 ubuntu-lastest](https://github.com/nxp-imx/mfgtools/actions/workflows/build.yaml/badge.svg)](https://github.com/nxp-imx/mfgtools/actions/workflows/build.yaml)
   6
   7 ![GitHub](https://img.shields.io/github/license/nxp-imx/mfgtools.svg)
   8
   9 [![universal-update-utility](https://snapcraft.io/universal-update-utility/badge.svg)](https://snapcraft.io/universal-update-utility)
  10
  11 Freescale/NXP I.MX Chip image deploy tools.
  12 **original linux version uses "linux" branch, windows version uses "windows" branch**
  13
  14     uuu (universal update utility) for nxp imx chips -- libuuu-1.0.1-gffd9837
  15
  16     Succeded:0       Failed:3               Wait for Known USB Devices to Appear...
  17
  18     1:11     5/5 [                                        ] SDP: jump -f u-boot-dtb.imx -ivtinitramf....
  19     2:1      1/5 [===>                                    ] SDP: boot -f u-boot-imx7dsabresd_sd.imx ....
  20
  21 # Key features
  22  - The real cross platform. Linux, Windows, MacOS(not test yet)
  23  - Multi devices program support
  24  - Daemon mode support
  25  - Few dependencies (only libusb, zlibc, libbz2)
  26  - 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.
  27
  28 # Examples:
  29 ```
  30   uuu u-boot.imx            Download u-boot.imx via HID device
  31
  32   uuu list.uu               Run all the commands in list.uu
  33
  34   uuu -s                    Enter shell mode. Input command.
  35
  36   uuu -v u-boot.imx         verbose mode
  37
  38   uuu -d u-boot.imx         Once it detects the attachment of a known device, download boot.imx.
  39
  40                             u-boot.imx can be replaced, new file will be download once board reset.
  41
  42                             Do not unplug the SD card, write to the SD card, nor plug in a SD card when debugging uboot.
  43
  44   uuu -b emmc u-boot.imx    write u-boot.imx to emmc boot partition. u-boot.imx need enable fastboot
  45
  46   uuu -b emmc_all wic.zst   decompress wic.zst 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   - **ubuntu 22.04, 'apt-get install uuu'**
  54   - UUU.pdf is snapshot of [wiki](https://github.com/nxp-imx/mfgtools/wiki)
  55
  56 # How to Build:
  57
  58 ## Windows
  59 - `git clone --recurse-submodules https://github.com/nxp-imx/mfgtools.git`
  60 - `cd mfgtools`
  61 - `open msvs/uuu.sln with Visual Studio 2017`
  62
  63 Visual Studio
  64
  65 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.
  66
  67 ## Linux
  68 - `git clone https://github.com/nxp-imx/mfgtools.git`
  69 - `cd mfgtools`
  70 - `sudo apt-get install libusb-1.0-0-dev libbz2-dev libzstd-dev pkg-config cmake libssl-dev g++ zlib1g-dev libtinyxml2-dev`
  71 - `cmake . && make`
  72
  73 The above commands build mfgtools in source. To build it out of source
  74 (requires cmake 3.13 or newer):
  75 - `cmake -S . -B build`
  76 - `cmake --build build --target all`
  77
  78 For cmake prior 3.13:
  79 - `mkdir build && cd build`
  80 - `cmake .. && make`
  81
  82 ## macOS
  83 - `git clone https://github.com/nxp-imx/mfgtools.git`
  84 - `cd mfgtools`
  85 - `brew install cmake libusb openssl pkg-config tinyxml2`
  86 - `cmake -DOPENSSL_ROOT_DIR=$(brew --prefix)/opt/openssl . && make`
  87
  88 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.
  89
  90 Note if you meet "can't detach kernel driver" try to check libusb version.
  91 ```
  92 brew info libusb
  93 ==> libusb: stable 1.0.26 (bottled), HEAD
  94 ```
  95
  96 # Run environment
  97  - Windows 10 64 bit
  98  - Linux (Ubuntu) 64 bit
  99  - macOS (Catalina)
 100  - 32 bit systems will have problems with big files.
 101
 102 # License
 103 uuu is licensed under the BSD license. See LICENSE.
 104 The BSD licensed prebuilt Windows binary version of uuu is statically linked with the LGPL libusb library, which remains LGPL.
 105
 106  - bzip2 (BSD license) is from https://github.com/enthought/bzip2-1.0.6
 107  - zlib  (zlib license) is from https://github.com/madler/zlib.git
 108  - libusb (LGPL-2.1) is from  https://github.com/libusb/libusb.git
 109  - zstd (Dual BSD\GPLv2 Licenses) is from https://github.com/facebook/zstd
 110  - tinyxml (zlib license) is from https://github.com/leethomason/tinyxml2