search

rom1nux / mtkimg

Unpack/Repack boot.img, recovery.img and logo.bin for Mediatek CPU based devices
GNU General Public License v3.0
63 stars 27 forks source link

readme 

             __  __ _______ _  _______ __  __  _____ 
            |  \/  |__   __| |/ /_   _|  \/  |/ ____|
            | \  / |  | |  |   /  | | | \  / | |  __ 
            | |\/| |  | |  |  <   | | | |\/| | | |_ |
            | |  | |  | |  |   \ _| |_| |  | | |__| |
            |_|  |_|  |_|  |_|\_\_____|_|  |_|\_____|

                   Copyright (c) 2015 rom1nux

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

A - INTRODUCTION

MTKIMG is a simple and portable utility to manage Mediatek Android ROM image file like boot.img, recovery.img or logo.bin.

Characteristics :

B - HOW TO USE

Be sure "find", "gzip", "cpio" and "chmod" utilities are installed on your system and are in your PATH environment variable :

Linux : Use your package manager to download utilities. Osx : Use your package manager to download utilities. Cygwin : Use Cygwin setup.exe to install packages utilities. Windows : If you dont have the bundle version of MTKIMG, download "mtkimg-win64-utilities.zip" extract files in the directory of "mtkimg.exe"

Launch a terminal, cd into directory where "mtkimg" (mtkimg.exe) is, and execute MTKIMG without arguments to see full help/usage. (On Windows bundle version, you can start terminal by click on "winterm.bat" that add externals utilities automatically in your PATH environment variable for the current session.)

On Linux, Cygwin or Osx hit "./mtkimg", on Windows hit "mtkimg.exe" to see full help.

Basically :

To unpack boot image execute : ./mtkimg unpack boot.img To repack boot image execute : ./mtkimg repack newboot.img

To unpack logo image execute : ./mtkimg unpack -t logo logo.bin To repack logo image execute : ./mtkimg repack -t logo newlogo.bin

At each unpack, MTKIMG create an image configuration file (image.cfg by default) that keep the original image configuration for next repack.

C - TUTORIALS

Here you can find some usefull tutorials (with screen shot) about how to use MTKIMG and more.

D - WHERE TO SPEAK ABOUT

E - SOURCE CODE

Code source is multi-platform (Linux, Cygwin, Windows) and got several utilities to build, test, backup and distribute executable. It can be download from : https://github.com/rom1nux/mtkimg

mtkimg |- build : Build directory (output of compilation) |- doc : Documents directory | -html : HTML source code documentation directory |- index.html : Index of source code documentation |- release : Release packages |- src : Sources code directory | - readme.txt : Distrib readme file |- tools : Utilities directory |- mtkimgtest.sh : Automatic test suite to check building (Linux/Cygwin only) |- .gitignore : GIT files/directory ignore |- cyterm32.bat : Cygwin 32 bits terminal launcher |- cyterm64.bat : Cygwin 64 bits terminal launcher |- licence.txt : GPL3 license file |- make.bat : Windows make wrapper (invoke "mink32-make.exe') |- Makefile : Source code builder and management script |- readme.txt : This help file |- winterm32.bat : Windows 64 bits terminal launcher `- winterm64.bat : Windows 32 bits terminal launcher

F - HOW TO BUILD SOURCE CODE

First, be sure you got a "gcc" compiler and "make" utility are installed on your system and be sure /bin directory is in your PATH environment variable.

Second, MTKIMG use "zlib" and "libpng" for logo unpack/repack to work. Be sure "zlib-dev" (zlib-devel) and "libpng-dev" (libpng-devel) are installed on your system.

Note for Windows: You need MinGW32 or MinGW64 (See UTILTIES FOR BUILDING SOURCE CODE section). MinGW contain a port of "make" utility named "ming32-make" invoked by "make.bat'. You need to manually build "zlib" and "libpng" first before building MTKIMG. (see HOW TO BUILD ZLIB AND LIBPNG ON WINDOWS section) .

You can adjust "cygterm32.bat", "cygterm64.bat", "winterm32.bat" or "winterm64.bat" terminal launcher to your platform.

Here is the few steps to follow to build MTKIMG on your platform :

1 - Uncompress source code or pull source code from GitHub.

2 - Open terminal in source code directory : Linux : Open terminal Cygwin : From Windows click on "cygterm32.bat" or "cygterm64.bat" Windows : Click on "winterm32.bat" or "winterm64.bat"

3 - Execute : make

4 - Execute : make clean

5 - "mtkimg" (mtkimg.exe) is ready into "build" directory.

6 - You can copy and paste it into your bin directory or the working directory you are working in.

Look at "src/readme.txt" for more information about using mtkimg.

G - HOW TO BUILD ZLIB AND LIBPNG ON WINDOWS

Understand "zlib" need to be build before "libpng". Create the "libs" directory into MTKIMG source directory and create "win32" or "win64" directory into "libs" directory. Respect the name of directories, MTKIMG Makefile use this path for building, but adjust "win32" or "win64" accordantly to your platform. "make-mingw32" is the same on MINGW32 and MINGW64.

For zlib :

1 - Download and unpack the latest "zlib" into "libs/win64/zlib" directory.
2 - Click on "winterm64.bat" or "winterm32.bat" 3 - Execute : cd libs\win64\zlib 4 - Execute : mingw32-make -f win32\Makefile.gcc 5 - "zlib.h" and "libz.a" are ready into "libs\win64\zlib" directory.

For libpng :

1 - Download and unpack the latest "libpng" into "libs/win64/libpng" directory. 2 - Edit "libs\win64\libpng\scripts\Makefile.gcc" with text editor At line ~19 : Change "CP = cp" to "CP = copy" At line ~35 : Change the slash to backslash (scripts/... to scripts...) 3 - Click on "winterm64.bat" or "winterm32.bat" 4 - Execute : cd libs\win64\libpng 5 - Execute : mingw32-make -f scripts\Makefile.gcc
6 - "png.h" and "libpng.a" are ready into "libs\win64\libpng" directory

H - MAKEFILE COMMANDS

Makefile is used to manage the source code on all platform. (On Windows make.bat invoke and pass command to mingw32-make)

This is Makefile supported command :

make : Build MTKIMG executable in ./build directory make clean : Remove all object files (.o) from ./build directory make mrproper : Remove the build directory make rebuild : Force rebuild all object files make doc : Invoke Doxygen to build ./doc/html source documentation make release : Create binary distribution zip into ./release directory make distro : Create source distribution zip into ./release directory make backup : Create a source zip backup into ../bkp

I - UTILTIES FOR BUILDING SOURCE CODE

J - CHANGELOG