SigmaStar Ota Upgrade

version 1.0

1. 概述¶

本文介绍的是Sigmastar的IPC、NVR平台在OTA升级中打包、解包、升级的流程。仅支持分区打包、分区升级，个别文件升级，支持差分升级，支持新旧文件夹对比批量打包。

升级包后台服务器维护、终端下载及管理，请结合第三方服务。

2. 分区打包流程¶

2.1. 打包工具介绍¶

打包工具只会根据当前要升级的文件生成所需的文件头。

打包工具的bin所在目录：

project/image/makefiletools/bin/otapack

otapack工具命令参数介绍：

-c --create:

创建一个空的升级包文件头，此命令创建文件头的同时可以用-b或-e添加开始或结束升级的脚本。

-b --begin-script:

在服务器上指定一个文件，用于板子在升级前执行的脚本。

-e --end-scrip:

在服务器上指定一个文件，用于板子在升级结束后执行的脚本。

-a --append:

在已经创建的升级包中追加新的头信息，追加新的信息中，必须使用以下参数告知升级的相关讯息。

-s --src-file:

需要更新的源文件路径。

-d --dst-file:

需要更新的目标文件或者分区节点的路径。

-t --dst-file-size:

需要更新的目标文件或者分区的大小，单位为byte，可以用16/10进制表示。

-m --file-mode:

你要更新的文件mode。

-o --diff-old:

差分升级的接文件、文件夹目录。

-n --diff-new:

差分升级的新文件、文件夹目录。

--block-update：

打包的数据为一个裸数据的block升级。

--ubi-update：

打包的数据为UBI文件系统的volume升级。

--file-update：

打包的数据为一个文件升级。

--file-add:

用打包的数据添加一个文件。

--file-delete:

仅更新打包的数据头，删除板子上的目标文件。

--file-update-diff：

打包的数据为差分升级的diff data。

--dir-update:

扫描新旧两个文件夹中的内容，并比较差异、增加、减少的部分，然后进行批量打包。

--dir-update-diff:

扫描新旧两个文件夹中的内容，并比较差异、增加、减少的部分，然后进行批量打包。其中差异的文件对其差分数据进行打包。

--help：

打印帮助信息。

--debug：

打开调试信息。

otaunpack工具命令参数介绍：

-x: 解包并升级压缩的文件

-r: 解包并升级非压缩的文件

-t: 指定一个可写的文件夹路径用于差分升级。

2.2. 一般的打包流程举例¶

创建一个空的header
```
otapack -c SStarOta.bin
```

若有需要可以用-b/-e指令添加脚本

otapack -c SStarOta.bin -b start.sh -e end.sh

根据需要打包的文件更新header数据

otapack -a SStarOta.bin -s ./images/kernel -d /dev/mtdblock8 -t 0x500000 --block-update

循环执行3步骤，所有的文件进行打包
压缩升级包
```
gzip SStarOta.bin
```

2.3. 在ALKAID中打包介绍¶

OTA打包流程目前已经整合到了Makefile中。

当程序编译和打包完成后，在project下输入指令：

make image-ota

会出现如下交互界面，指定在板子上执行的脚本路径，可以选择添加或者不添加：

Start scripts:

End scripts:

在打包分区时，列出了打包的分区数据:

Make ipl ?(yes/no)

做出相关的选择后，会在project/image/output/images/下产生SStarOta.bin.gz

在配置partition的config文件中会配置分区进行打包。

举例：

文件 spinand.ubifs.p2.partition.config中有变量：OTA_IMAGE_LIST

在此变量后面追加需要打包的分区名称，并在分区的配置中添加字段xxx$(OTABLK)，配置该分区需要升级的目标节点路径。

只有在OTA_IMAGE_LIST添加了分区名，才会在make image-ota的时候会询问该分区是否要进行ota升级。

分区打包脚本的所有逻辑在image/ota.mk中实现，有兴趣的可以自行研究。

2.4. 不带文件系统的RAW DATA打包¶

分区升级步骤大多相似，把需要升级的文件填到对应的mtdblock中，打包的流程也一样。不同的是在RAW DATA分区打包要自行实现升级包头的创建和数据填充，这里以spinand的IPL分区打包举例：

define makeota
@read -p "Make $(1) ?(yes/no)" select;  \
if [ "$${select}" == "yes" -o "$${select}" == "y" ]; then   \
    $(foreach n,$(3),$(PROJ_ROOT)/image/makefiletools/bin/otabinheader -s $(2) -d $(n) -t $(4) -p $(5) -a $(IMAGEDIR)/SStarOta.bin;cat $(2) >> $(IMAGEDIR)/SStarOta.bin;) \
fi;
endef

ipl_spinand_mkota_:
    $(call makeota,$(patsubst %_spinand_mkota_,%,$@),$(IMAGEDIR)/ipl_s.bin,$($(patsubst %_spinand_mkota_,%,$@)$(OTABLK)),$($(patsubst %_spinand_mkota_,%,$@)$(PATSIZE)),0)

2.5. ubifs/ squashfs/ jffs2打包¶

如果新创建了这些分区，并且把它们加到OTA_IMAGE_LIST中，则无需再ota.mk中添加特殊处理，这一类的分区升级文件会统一处理。

UBIFS的分区升级方式与其它两种格式稍有差异，因此在打包的时候UBIFS打包的时候请使用--ubi-update

2.6. 个别文件打包¶

个别文件打包的选项是--file-update，目前ALKAID中还没有专门针对文件更新的打包，因此使用者需要自己手动添加。

2.7. 差分数据打包¶

对个别文件进行差分数据打包的选项是--file-update-diff，除了普通文件外，也可以对kernel、uboot等raw image进行差分，也可以对只读文件系统的镜像文件进行差分，但是不可以对可写的文件系统进行差分。

差分升级需要依赖于第三方开源的bsdiff、bspatch。

bsdiff工具在打包的时候会使用，bspatch在板子上使用。

bsdiff、bspatch工具的源码在project/tools/bsdiff

编译方式：

tar -vxf bzip2-1.0.6.tar.gz

cd bzip2-1.0.6

make

编译完成后在当前目录下可以看到执行档案bsdiff、bspatch

默认编译出来的是pc上使用的，编译板子上使用bspatch请改Makefile。

编译完成后的bsdiff要放到pc中的/usr/bin/路径下，或者环境变量$ PATH所指定的位置。

同理板子上bspatch也要放到对应的位置。

2.8. 新旧文件夹扫描并批量文件打包¶

文件夹扫描分两种，一种是扫描出的有差异的文件进行强制更新。另外一种是扫描出的有差异的文件进行差分升级。

--dir-update

命令举例：

otapack -a ./test-diff.bin -o ./old/ -n ./new/ -d /config --dir-update

--dir-update-diff

命令举例：

otapack -a ./test-diff.bin -o ./old/ -n ./new/ -d /config --dir-update-diff

3. 分区更新流程¶

3.1. 升级流程¶

3.2. 分区升级前注意¶

在分区升级之前请确保分区umount成功。可以在start scripts脚本中作相关的umount动作。若需更新文件，请确保文件在可读写的文件系统中，并且有写权限。

otaupack工具请找FAE获取。

3.3. 压缩的升级包更新¶

otaupack -x SStarOta.bin.gz

3.4. 非压缩的升级包更新¶

otaupack -r SStarOta.bin

3.5. 升级UI显示¶

升级时可指定一张全屏的背景图片贴到framebuffer上，图片支持jpg和png格式。同时在framebuffer中绘制进度条，otaunpack在0.2版本之后支持进度条和文字UI旋转，设定-s参数0/½/3支持None/90°/180°/270°旋转。

otaunpack -x SStarOta.bin.gz -p upgrade.jpg

3.6. 差分升级¶

若压缩包中存在差分升级的数据，需要指定一个临时的可以写的文件夹，命令：

otaupack -x SStarOta.bin.gz -t /tmp

3.7. 升级状态获取¶

在END script中利用内部变量OTA_STATUS可以获取升级的状态。

若OTA_STATUS为0则升级成功，否则为-1。

3.8. SPI-NAND坏块处理¶

使用--block-update命令打包升级的程序中，如果设定的是mtdblock块设备节点，这种操作不会处理坏块，推荐nor flash升级可以使用此节点，若spinand需要升级同时处理坏块，请用--block-update设定为mtd的字符设备节点，otapack和otaunpack应用程序在0.2版本后可以支援使用mtd-utils在升级的时候处理坏块，请在busybox中打开nand_write和flash_eraseall。