[FAQ03718]如何解包和打包boot.img/recovery.img/system.img/userdata.img

[DESCRIPTION]

      MTK在ALPS codebase中已经提供了针对boot.img/recovery.img/system.img(ext4)/userdata.img(ext4)的解包和打包工具，主要针对以下几种应用场景：

(1) 在debug时，需要快速修改或替换image中的文件然后再打包dowload到手机中做验证;

(2) 解包image后替换其中的资源文件或APK，即客制化ROM的操作，然后再打包生成新的ROM;

(3) 客退机，产线download或stress test后无法正常开机，这时需要解包比较image中内容是否有被修改或变化;   

(4) 该工具不建议作为商业软件发布的打包工具，尤其是androild L全面开启了SELinux，打包工具不支援文件的SELinux属性设置，因此请不要在android L使用此工具打包system image，但是解包仍然是可以的。

 

[KEYWORD]

打包(pack)

解包(unpack)

boot.img

recovery.img

system.img

userdata.img

 

[SOLUTION]

• 解包/打包工具老版本路径：alps/mediatek/build/tools/images/
• 对于较早的JB2/JB3/JB5 branch, 工具会存在使用异常，因此请先确认是否有打上ALPS00393168这笔Patch，如果没有的话，请到PMS系统申请。
• 该工具只能解包和打包针对emmc的ext4格式的system.img/userdata.img，针对nand flash的ubifs格式的system.img/userdata.img暂时还不能支援。
• 最新版本的tool已经不会随codebase一同release，如果有需要的话，请提交e-service申请。

 

环境设定：

1. alps/mediatek/build/tools/images/目录下的工具只能在Linux环境下使用，建议最好是在可以正常build ALPS的机器上来运行以减少软件兼容性方面的问题；

2. 这个工具部分基于python，python版本(python --version查看版本)不正确的可能出现错误：RuntimeError: Bad magic number in .pyc file; 目前codebase中default release的.pyc文件是基于python 2.6.5(Ubuntu 10.04)生成的;如果发现有以上的执行错误，请提交CR，我们会release基于python 2.7.3(Ubuntu 12.04)版本的pyc文件；

3. alps/mediatek/build/tools/images/目录下的工具可以整体拷贝到一个目录下(tool_dir)，然后编辑~/.bashrc文件把tool_dir添加到$PATH环境变量中，然后source ~/.bashrc使设置生效；

     当然也可以直接把要解包的image拷贝到alps/mediatek/build/tools/images/目录下直接在该目录下执行解包/打包工具。

 

Image解包：

    Image解包使用的工具是diff.pyc，用法如下,

* python diff.pyc 

- 把image解包到/tmp/tmpXXXXXX这样的目录下，目录名称会被随机定义.

 

或

* python diff.pyc -o  

- 是自己定义将要解包的目录，可以是绝对路径或相对路径.

- 是被解包的image，name并不限定于boot.img/recovery.img/system.img/userdata.img，这里不会检查image name，而是会自动判断image的类型；

- 如果解包的是boot.img和recovery.img，额外在的同级目录下还会生成

   a, kernel image，命名方法是-kernel，比如要解包boot.img到当前目录下的ramdisk目录，那么执行python diff.pyc -o ramdisk boot.img之后，就会在当前目录下生成ramdisk-kernel文件.

   b, BoardConfig.mk，命名方法是-BoardConfig.mk，这支文件的作用是保存boot.img/recovery.img中的一些配置参数，在pack.pyc打包时会用到。如果您目前的tool运行后不能生成这个文件，请提交e-service申请最新版本的tool。

- 需要注意的的是解包boot.img/recovery.img时，传入的路径的最后请不要带上"/"，否则生成的kernel image文件会跑到目录下并被命名成-kernel.

 

      diff.pyc可以同时对sparse(透过build flow编译生成)和raw ext4(透过flash tool从手机readback)格式的image进行解包操作。如果您需要从手机中readback回image后再解包，那么请先参考以下这两个FAQ:

[FAQ05169][Storage]如何从手机上readback任意分区的image回来？

[FAQ10347][SP FlashTool]MT6592平台在format,readback,write memory时需要选择对应的emmc region

 

Image打包：

      Image打包使用的工具是pack.pyc，用法如下,

(1) 打包boot.img/recovery.img

* python pack.pyc kernel ramdisk BoardConfig.mk

- kernel 是kernel image文件

- ramdisk 包含ramdisk rootfs的目录

- 最新的diff.pyc在解开boot.img/recovery.img时会生成BoardConfig.mk，打包时传入这个参数即可

- 执行命令后会当前目录的out目录下生成重新打包后的boot.img/recovery.img文件

 

   请在打包之前先执行python pack.pyc，查看一下usage，如果输出不是以下这样，请提交e-service申请最新的tool.

$python pack.pyc
Usages:
    1. pack.pyc -[2|4|eMMC_size] source_dir
    2. pack.pyc kernel ramdisk BoardConfig.mk

 

(2) 打包system.img/userdata.img (ext4 sparse)

* python pack.pyc -

- -表示要生成的image分区的size，比如-600就表示600MB。具体分区的size，请参考download时使用的scatter file(MT65XX_Android_scatter.txt)，查看其中ANDROID，USRDATA, CACHE分区的大小;

- 目录的名字只能是system, data, cache其中一个，目前不接受其他的目录名，生成的image分别对应的是system.img, userdata.img和cache.img

- 例如pack.pyc -600 system, 把当前目录下的system目录中的内容打包成partition size为600MB的system.img

 

    特别需要注意的是，打包system.img时会设定多个目录/文件的权限，这些权限配置信息的来源是android_filesystem_config.h (alps\system\core\include\private)，如果您有修改过这个.h文件，那么请重新编译过整个工程后，使用您最新build出来的alps/out/host/linux-x86/bin/make_ext4fs这支文件替换tool_dir目录下的同名文件后再执行打包的操作，否则可能会造成打包后的文件/目录权限与您设置的有差异。