4 打包脚本分析

4.1 脚本的调用流程

在Tina 主目录下执行make -j16 编译完成后便可以执行pack 进行打包工作，整个打包过程大概如下图所示：

结合上面的打包流程图分析，打包方法在Tina SDK 根目录下运行：

pack

最终打包出来的固件放在目录tina/out/platform−{board}/下。pack 命令实质上是tina SDK 内置的一个环境变量命令。

在使用tina SDK 时需要执行source build/envsetup.sh 这个命令。这个命令是把tina SDK 实现的一些shell 命令export 到当前shell 中。打开build/envsetup.sh 脚本，可以发现里面实现了一个shell 函数：

function pack()

在tina 根目录下执行pack 命令后调用到的就是build/envsetup.sh 脚本中的function pack()函数，function pack() 函数进行一些参数设置后最终调用到以下语句：

$T/scripts/pack_img.sh -c $chip -p $platform -b $board -d $debug -s $sigmode -m $mode -w
$programmer -v $securemode -i $tar_image -t $T
-c：输入的芯片类型例如：sun8iw18p1
-p：输入的平台例如：tina
-b：输入的板级方案例如：r328s2-perf1
-d：输入调试时log输入方式例如：uart0/card0
-s：输入是否打包成安全固件例如：none/secure
-m：输入是正常固件还是调试用的dump固件：normal/dump
-w：
-v：输入打包时是否使用安全boot，对于tinaSDK来说该参数功能已由-s替代，参数只是历史遗留或做兼容用，客户可以不
用理会该参数
-i：输入是否制作压缩包none/tar_image，调试时用，客户可以不用理会该参数
-t：Tina根目录的路径

从上面可以看出function pack() 函数最终调用到tina/scripts/pack_img.sh 这个脚本文件，这个脚本文件实现了打包的最终流程。目前打包脚本主要分为5 个阶段（其他阶段都是一些特殊化处理），分别是：

do_prepare
do_ini_to_dts
do_common
do_pack_tina
do_finish

4.2 打包的各阶段分析

4.2.1 do_prepare 阶段

此阶段完成文件拷贝动作。打包时需要拷贝若干文件到tina/out/xxxplatform/image 目录下，目前脚本对其进行了分类，分别是tools_file_list，configs_file_list，boot_resource_list 和boot_file_list，boot_file_secure，a64_boot_file_secure 如有新增文件，可以归入其中一类或者创建新类，后续打包会使用到这些文件。

function do_prepare()
{
......
#拷贝tools_file_list 类文件到tina/out/xxxplatform/image 目录下
printf "copying tools file\n"
for file in ${tools_file_list[@]} ; do
cp -f $file ${ROOT_DIR}/image/ 2> /dev/null
done
......
#拷贝configs_file_list 类文件到tina/out/xxxplatform/image 目录下
printf "copying configs file\n"
for file in ${configs_file_list[@]} ; do
cp -f $file ${ROOT_DIR}/image/ 2> /dev/null
done
......
#拷贝boot_resource_list 类文件到tina/out/xxxplatform/image 目录下
printf "copying boot resource\n"
#根据不同的arm架构拷贝不同的boot_file_secure 类文件到tina/out/xxxplatform/image 目录下
#32位系统
printf "copying secure boot file\n"
for file in ${boot_file_secure[@]} ; do
cp -f `echo $file | awk -F: '{print $1}'` \
${ROOT_DIR}/`echo $file | awk -F: '{print $2}'`
done
#64位系统
printf "copying arm64 secure boot file\n"
for file in ${a64_boot_file_secure[@]} ; do
cp -f `echo $file | awk -F: '{print $1}'` \
${ROOT_DIR}/`echo $file | awk -F: '{print $2}'`
done
}

4.2.2 do_ini_to_dts 阶段

在linux-3.10，引入了linux 设备树的概念。此阶段主要是编译生成描述设备树的sunxi.dtb 文件。该文件在linux 内核启动过程中会被解析，根据该文件中设备列表进行加载各个外设的设备驱动模块。具体实现分析如下：

function do_ini_to_dts()
{
if [ "x${PACK_KERN}" == "xlinux-3.4" ] ;
then return
fi
......
#根据不同的内核设置不同的参数，最后调用下的命令编译生成.dbt 文件
$DTC_COMPILER ${DTC_FLAGS} -O dtb -o ${ROOT_DIR}/image/sunxi{SUFFIX}.dtb \
-b 0\
-i $DTC_SRC_PATH\
-F $DTC_INI_FILE\
-d $DTC_DEP_FILE $DTC_SRC_FILE &int> /dev/null
if [ $? -ne 0 ]; then
pack_error "Conver script to dts failed" exit 1
fi
printf "Conver script to dts ok.\n"
......}

4.2.3 do_common 阶段

此阶段完成所有系统平台通用的文件解析，分区打包。具体实现分析如下。(代码顺序与脚本的不一致，主要是为了方便说明)，该阶段与存储介质、内核版本等有耦合。因此比较复杂，但主要包括下面的5 个阶段： (1) 使用unix2dos 工具确保文本文件为dos 格式。 (2) 使用script 工具解析文本文件，生成对应的二进制文件，便于后续工具解析。 (3) 更新boot0,uboot,scp 的头部参数。 (4) 生成boot_package。 (5) 生成env 分区数据env.fex。具体实现分析如下：

function do_common()
{
busybox unix2dos sys_config.fex
busybox unix2dos sys_partition.fex
busybox unix2dos sys_partition_nor.fex
#使用script 程序解析文本文件sys_config.fex 和sys_partition.fex/sys_partition_nor.fex
#生成相应的二进制文件sys_config.bin 和sys_partition.bin 便于后续工具程序解析
script sys_config.fex > /dev/null
script sys_partition.fex > /dev/null
script sys_partition_nor.fex > /dev/null
#根据sys_config.bin 参数,取出DRAM,UART 等参数更新boot0 头部参数
update_boot0 boot0_nand.fex sys_config.bin NAND > /dev/null
update_boot0 boot0_sdcard.fex sys_config.bin SDMMC_CARD > /dev/null
#根据sys_config.bin 参数设置,更新uboot 头部参数
update_uboot u-boot.fex sys_config.bin > /dev/null
#根据sys_config.bin 参数设置,更新fes1.fex 参数
update_fes1 fes1.fex sys_config.bin > /dev/null
    #制作启动过程相关资源的分区镜像
fsbuildboot-resource.inisplit_xxxx.fex > /dev/null
#根据配置生成uboot 基本配置二进制文件env.fex
mkenvimage -r -p 0x00 -s ${env_size} -o env.fex env_burn.cfg
u_boot_env_gen env.cfg env.fex > /dev/null
#根据boot_package.cfg配置生成boot_package
echo "pack boot package"
busybox unix2dos boot_package.cfg
dragonsecboot -pack boot_package.cfg
}

4.2.4 do_pack_tina 阶段

此阶段完成当前系统平台特有的工作以及安全相关的工作，主要对内核文件，文件系统等进行软链接，以及安全件的签名和toc0 的生成。具体实现分析如下：

function do_pack_tina()
{
#软链接boot.fex，rootfs.fex
ln -s ${ROOT_DIR}/boot.img boot.fex
ln -s ${ROOT_DIR}/rootfs.img rootfs.fex
......
#如果需要打包成安全固件就会调用do_signature函数
do_signature
{
#生成toc0文件
dragonsecboot -toc0 dragon_toc.cfg ${ROOT_DIR}/keys ${ROOT_DIR}/image/version_base.
mk
#根据sys_config.bin 参数，取出DRAM，UART 等参数更新toc0 头部参数
update_toc0 toc0.fex sys_config.bin
......
#生成toc1文件
dragonsecboot -toc1 dragon_toc.cfg ${ROOT_DIR}/keys \
${CNF_BASE_FILE} \
${ROOT_DIR}/image/version_base.mk
#对内核进行签名
sigbootimg --image boot.fex --cert toc1/cert/boot.der --output boot_sig.fex
#根据sys_config.bin 参数，取出DRAM，UART 等参数更新toc1 头部参数
update_toc1 toc1.fex sys_config.bin
}
}

4.2.5 do_finish 阶段

此阶段根据指定的固件成员完成打包。具体实现分析如下：

function do_finish()
{
......
#生成分区结构文件sunxi_mbr.fex 及分区下载文件列表文件dlinfo.fex
update_mbr sys_partition.bin 4 > /dev/null
#根据所列的成员文件及分区信息,组合完成打包
dragon image.cfg sys_partition.fex
......
}

4.3 打包过程数据流分析

上一章节讲述了打包脚本的几个阶段，本节我们换个视角看打包过程。打包过程是将编译好后的二进制镜像和各种配置文件，通过一些加工、转换和合成最终生成固件包。如下图所示，讲述了需要打包的各种文件在哪个位置，会经过如何处理，合成什么文件，最终生成了固件包。

其中蓝色的是源文件或者生成的中间文件；绿色的是打包用到的工具；红色的是最终生成的固件。固件里面包含哪些文件，可以参考下一章节。这里展示另一张图，可以从Tina SDK 全局看打包的作用位置，以及数据的流动。

4.4 固件组成成员分析

固件包本质是由一系列的文件组成，类似于一个压缩包，把多个文件压缩成了一个固件包。这里通过一个描述性的配置文件(image.cfg)，把需要添加到固件包的文件枚举出来。然后打包过程就读取这个配置文件，生成了最终的固件包。由do_finish 函数可以知道，生成固件的工具是dragon，dragon 工具需要2 个配置文件image.cfg 和sys_partition.fex，下面将会分析这2个配置文件。

4.4.1 image.cfg 配置文件分析

用文本方式，打开tina/out/xxxplatform/image/image.cfg 文件，可以看到大致如下的内容：

[FILELIST]
{filename = "sys_config.fex", maintype = ITEM_COMMON, subtype = "
SYS_CONFIG100000",},
{filename = "config.fex", maintype = ITEM_COMMON, subtype = "
SYS_CONFIG_BIN00",},
{filename = "board.fex", maintype = ITEM_COMMON, subtype = "
BOARD_CONFIG_BIN",},
{filename = "split_xxxx.fex", maintype = ITEM_COMMON, subtype = "
SPLIT_0000000000",},
{filename = "sys_partition.fex", maintype = ITEM_COMMON, subtype = "
SYS_CONFIG000000",},
{filename = "sunxi.fex", maintype = ITEM_COMMON, subtype = "
DTB_CONFIG000000",},
{filename = "boot0_nand.fex", maintype = ITEM_BOOT, subtype = "
BOOT0_0000000000",},
{filename = "boot0_sdcard.fex", maintype = "12345678", subtype = "1234567890
BOOT_0",},
{filename = "u-boot.fex", maintype = "12345678", subtype = "
UBOOT_0000000000",},
{filename = "toc1.fex", maintype = "12345678", subtype = "
TOC1_00000000000",},
{filename = "toc0.fex", maintype = "12345678", subtype = "
TOC0_00000000000",},
{filename = "fes1.fex", maintype = ITEM_FES, subtype = "FES_1
-0000000000",},
{filename = "boot_package.fex", maintype = "12345678", subtype = "BOOTPKG
-00000000",},
;-------------------------------usb量产部分-------------------------------------;
;-->tools文件
{filename = "usbtool.fex", maintype = "PXTOOLSB", subtype = "
xxxxxxxxxxxxxxxx",},
{filename = "aultools.fex", maintype = "UPFLYTLS", subtype = "
xxxxxxxxxxxxxxxx",},
{filename = "aultls32.fex", maintype = "UPFLTL32", subtype = "
xxxxxxxxxxxxxxxx",},
;-------------------------------卡量产部分----------------------------------------;
;-->固定不变的PC使用
{filename = "cardtool.fex", maintype = "12345678", subtype = "1234567890
cardtl",},
{filename = "cardscript.fex", maintype = "12345678", subtype = "1234567890
script",},
;-->需要烧写到卡上的文件
{filename = "sunxi_mbr.fex", maintype = "12345678", subtype = "1234567890
___MBR",},
{filename = "dlinfo.fex", maintype = "12345678", subtype = "1234567890
DLINFO",},
{filename = "arisc.fex", maintype = "12345678", subtype = "1234567890
ARISC" ,},
;镜像配置信息
[IMAGE_CFG]
version = 0x100234 ;-->Image的版本
pid = 0x00001234 ;-->产品ID
vid = 0x00008743 ;-->供应商ID
hardwareid = 0x100 ;-->硬件ID bootrom
firmwareid = 0x100 ;-->固件ID bootrom
bootromconfig = "bootrom_071203_00001234.cfg"
rootfsconfig = "rootfs.cfg"
filelist = FILELIST
imagename = tina_XXXXXX.img

该文件项的格式：

filename= name,maintype=ITEM_ROOTFSFAT16,subtype = user_define

当用户需要添加文件的时候，按照同样的格式，把自己需要的文件写到脚本文件中即可。

• filename：打包文件是指文件的全路径。可以使用相对路径，如上述文件中，就使用了相对路径。 • maintype：打包格式表明文件的格式类型，该文件有此类型定义的列表。 • subtype：自定义名称用户自己定义的名称，使用数字和英文字符(区分大小写)，最大长度必须为16 字节。只要按照上述规则书写，并放到文件的[FILELIST] 之后，等到打包的时候就会自动把文件添加到固件包中。下表描述image.cfg 文件中的各固件成员的作用。

4.4.2 sys_partition.fex 配置文件分析

除image.cfg 文件所列的文件，固件还包含了sys_partition.fex 所列的分区的文件。用文本文件打开sys_partition.fex，可以看到大致如下的内容（主要分区有3 个，不同方案分区表可能不一样，用户也可以添加自己的分区）：

[partition_start]
[partition]
name = env
size = 32768
downloadfile = "env.fex"
user_type = 0x8000
[partition]
name = boot
size = 131072
downloadfile = "boot.fex"
user_type = 0x8000
[partition]
name = rootfs
size = 1048576
downloadfile = "rootfs.fex"
user_type = 0x8000

这是一个规划磁盘分区的文件，一个分区的属性，有如下几项： • 分区名称 • 分区的大小 • 下载的文件 • 分区的用户属性

以下是文件中所描述的一个分区的属性： • name：分区名称分区名称由用户自定义。当用户在定义一个分区的时候，可以把这里改成自己希望的字符串，但是长度不能超过16 个字节。 • size: 分区的大小定义该分区的大小，以扇区的单位。 • downloadfile: 下载的文件下载文件的路径和名称，可以使用相对路径，相对是指相对于image.cfg 文件所在分区，也可以使用绝对路径。 • user_type: 分区的用户属性

目前该标志位只有spi nand 的ubi 文件系统还在使用，是历史遗留问题，客户可以不理会，仿照文档中的分区填写即可（例如0x8000）。下表描述了sys_partition.fex 文件指定的分区里的文件。

固件成员	成员作用
env.fex	u-boot 的基本配置文件
boot.fex	tina SDK 生成的boot.img 的软链接，主要包含kernel
rootfs.fex	tina SDK 生成的rootfs 镜像的软链接，根文件系统