1# OTA升级 2 3 4## 概述 5 6 7### 简介 8 9随着设备系统日新月异，用户如何及时获取系统的更新，体验新版本带来的新的体验，以及提升系统的稳定和安全性成为了每个厂商都面临的严峻问题。 10 11OTA（Over the Air）提供对设备远程升级的能力。升级子系统对用户屏蔽了底层芯片的差异，对外提供了统一的升级接口。基于接口进行二次开发后，可以让厂商的设备（如IP摄像头等）轻松支持远程升级能力。 12 13 14### 基本概念 15 16- 全量升级包：将所有目标版本的镜像均通过全量镜像的方式打包获得的升级包。 17 18- 差分升级包：对源版本和目标版本差分，获得两个版本镜像之间的差异，以这种方式打包制作升级包。 19 20 21### 实现原理 22 23OTA 的升级原理是利用升级包制作工具，将编译出的版本打包生成升级包。厂商设备集成 OTA 升级能力后，将升级包上传至服务器，通过升级应用下载升级包，触发并完成升级。 24 25<a href="#ab-升级场景">AB 升级</a>：是 OTA 升级的一个场景，原理是设备有一套备份的B系统，在A系统运行时，可以在正常使用的状态下，静默更新B系统，升级成功后，重启切换新系统，实现版本更新的机制。 26 27 28### 约束与限制 29 30- 支持基于Hi3861/Hi3516DV300/RK3568芯片的开源套件。 31 32- 对Hi3516DV300/RK3568开源套件，设备需要支持SD卡（VFAT格式）。 33 34- 生成升级包需要在linux系统下面执行。 35 36- 目前轻量和小型系统仅支持全量包升级，暂不支持差分包、变分区包升级。 37 38- AB 升级只适用于标准系统支持 AB 分区启动的设备。 39 40 41## 环境准备 42 43- 在Windows上，下载安装OpenSSL工具，并配置环境变量。 44- 准备升级包制作工具 45- 编译出版本镜像文件 46- 将编译结果中的 out/rk3568/clang_x64/updater/updater/ 下的 diff 文件，out/rk3568/clang_x64/thirdparty/e2fsprogs 路径下的 libext2fs.so、e2fsdriod、libext2_com_err.so、libext2_misc.so 文件放入做包工具此路径下：packaging_tools/lib/ 47 48 49## 开发流程 50 51<a href="#生成公私钥对">1. 使用OpenSSL工具生成公私钥对</a> 52 53<a href="#制作升级包">2. 使用升级包制作工具制作升级包</a> 54 55  <a href="#轻量与小型系统升级包制作">2.1 轻量与小型系统升级包</a> 56 57  <a href="#标准系统升级包制作">2.2 标准系统升级包</a> 58 59<a href="#上传升级包">3. 将升级包上传到厂商的OTA服务器</a> 60 61<a href="#下载升级包">4. 厂商应用从OTA服务器下载升级包</a> 62 63<a href="#厂商应用集成ota能力">5. 厂商应用集成OTA能力</a> 64 65  <a href="#api-应用默认场景">5.1 API 应用默认场景</a> 66 67  <a href="#api-应用定制场景">5.2 API 应用定制场景</a> 68 69  <a href="#ab-升级场景">5.2 AB 升级场景</a> 70 71 72## 开发步骤 73 74 75### 生成公私钥对 761. 使用OpenSSL工具生成公私钥对，将公钥 signing_cert.crt 放入做包工具此路径下：packaging_tools/sign_cert/ 77 783. 请妥善保管私钥文件，在升级包制作过程中将私钥文件作为制作命令的参数带入，用于升级包签名，公钥用于升级时对升级包进行签名校验，公钥的放置如下： 轻量和小型系统将生成的公钥内容预置在代码中，需要厂商实现 HotaHalGetPubKey 这个接口来获取公钥。标准系统需要将生成的公钥放在device或vendor目录下的 /hisilicon/hi3516dv300/build/updater_config/signing_cert.crt 这个文件中。 79 805. 对使用 Hi3516DV300 套件的小型系统，在上一步的基础上，还需用public_arr.txt里面的全部内容替换uboot模块third_party\u-boot\u-boot-2020.01\product\hiupdate\verify\update_public_key.c 中的g_pub_key中的全部内容。 81 示例，uboot模块的公钥： 82 83 ```c 84 static unsigned char g_pub_key[] = { 85 0x30, 0x82, 0x01, 0x0A, 0x02, 0x82, 0x01, 0x01, 86 0x00, 0xBF, 0xAA, 0xA5, 0xB3, 0xC2, 0x78, 0x5E, 87 } 88 ``` 89 90 91### 制作升级包 92 93 94#### 轻量与小型系统升级包制作 95 961. 创建目标版本（target_package）文件夹，文件格式如下： 97 98 轻量级系统和AB升级的小型系统不需要 OTA.tag 和 config。 99 100 ```text 101 target_package 102 ├── OTA.tag 103 ├── config 104 ├── {component_1} 105 ├── {component_2} 106 ├── ...... 107 ├── {component_N} 108 └── updater_config 109 └── updater_specified_config.xml 110 ``` 111 1122. 将待升级的组件，包括镜像文件（例如：rootfs.img）等放入目标版本文件夹的根目录下，代替上文结构中的{component_N}部分。 113 1143. 填写“updater_config”文件夹中的“updater_specified_config.xml”组件配置文件。 115 组件配置文件“updater_specified_config.xml”，格式如下： 116 117 118 ```xml 119 <?xml version="1.0"?> 120 <package> 121 <head name="Component header information"> 122 <info fileVersion="02" prdID="hisi" softVersion="OpenHarmony x.x" date="202x.xx.xx" time="xx:xx:xx">head info</info> 123 </head> 124 <group name="Component information"> 125 <component compAddr="ota_tag" compId="27" resType="5" compType="0" compVer="1.0">./OTA.tag</component> 126 <component compAddr="config" compId="23" resType="5" compType="0" compVer="1.0">./config</component> 127 <component compAddr="bootloader" compId="24" resType="5" compType="0" compVer="1.0">./u-boot-xxxx.bin</component> 128 </group> 129 </package> 130 ``` 131 132 **表1** 组件配置文件节点说明 133 134 | 信息类别 | 节点名称 | 节点标签 | 是否必填 | 内容说明 | 135 | -------- | -------- | -------- | -------- | -------- | 136 | 头信息（head节点） | info节点 | / | 必填 | 该节点内容配置为：head info | 137 | 头信息（head节点） | info节点 | fileVersion | 必填 | update.bin文件校验方式，该节点内容配置为：02 | 138 | 头信息（head节点） | info节点 | prdID | 必填 | 保留字段，内容不影响升级包生成 | 139 | 头信息（head节点） | info节点 | softVersion | 必填 | 软件版本号，即升级包版本号，版本必须比基础版本大，且OpenHarmony后没有其他字母，否则无法生产升级 | 140 | 头信息（head节点） | info节点 | _date_ | _必填_ | 升级包制作日期，保留字段，不影响升级包生成 | 141 | 头信息（head节点） | info节点 | _time_ | _必填_ | 升级包制作时间，保留字段，不影响升级包生成 | 142 | 组件信息（group节点） | component节点 | / | 必填 | 该节点内容配置为：要打入升级包的组件/镜像文件的路径，默认为版本包根路径 | 143 | 组件信息（group节点） | component节点 | compAddr | 必填 | 该组件所对应的分区名称，例如：system、vendor等。 | 144 | 组件信息（group节点） | component节点 | compId | 必填 | 组件Id，不同组件Id不重复 | 145 | 组件信息（group节点） | component节点 | resType | 必填 | 保留字段，不影响升级包生成 | 146 | 组件信息（group节点） | component节点 | compType | 必填 | 处理方式全量/差分，配置镜像处理方式的，0为全量处理、1为差分处理。 | 147 148 >  **说明：** 149 > 对轻量系统/小型系统，不支持做差分升级，component标签中，属性compType值，不能配为 1，必须全部配置为 0。 150 > 151 > 对轻量系统/小型系统，不支持变分区升级包的制作。 152 1534. 创建“OTA.tag文件”，内容为OTA升级包的魔数，固定如下： 154 155 ```text 156 package_type:ota1234567890qwertw 157 ``` 158 1595. 创建“config文件”，内容为设置bootargs以及bootcmd的信息。 160 配置例如下： 161 162 163 ```text 164 setenv bootargs 'mem=128M console=ttyAMA0,115200 root=/dev/mmcblk0p3 rw rootfstype=ext4 rootwait blkdevparts=mmcblk0:1M 165 (u-boot.bin),9M(kernel.bin),50M(rootfs_ext4.img),50M(userfs.img)' setenv bootcmd 'mmc read 0x0 0x82000000 0x800 0x4800;bootm 0x82000000' 166 ``` 167 1686. 执行升级包制作命令。 169 170 ```text 171 python build_update.py ./target_package/ ./output_package/ -pk ./rsa_private_key3072.pem -nz -nl2 172 ``` 173 174 - ./target_package/：指定target_package路径。 175 - ./output_package/：指定升级包输出路径。 176 - -pk ./rsa_private_key3072.pem：指定私钥路径。 177 - -nz：打开not zip模式开关 178 - -nl2：打开非“标准系统”模式开关 179 180 181#### 标准系统升级包制作 1821. 创建目标版本（target_package）文件夹，文件格式如下： 183 184 185 ```text 186 target_package 187 ├── {component_1} 188 ├── {component_2} 189 ├── ...... 190 ├── {component_N} 191 └── updater_config 192 ├── BOARD.list 193 ├── VERSION.mbn 194 └── updater_specified_config.xml 195 ``` 196 1972. 将待升级的组件（包括镜像文件和updater_binary文件）放入目标版本文件夹的根目录下，代替上文结构中的{component_N}部分。 198 199 以RK3568为例，镜像文件的构建位置为：out/rk3568/packages/phone/images/ 200 201 二进制升级文件updater_binary位置为：out/rk3568/packages/phone/system/bin/ 202 2033. 填写“updater_config”文件夹中的组件配置文件。 204 2054. 配置“updater_config”文件夹中当前升级包支持的产品list：**BOARD.list**。 206 207 例如配置如下： 208 209 210 ```text 211 HI3516 212 RK3568 213 ``` 214 215 厂家可在路径base/updater/updater/utils/utils.cpp文件中的GetLocalBoardId()接口进行Local BoardId的配置。请确保utils.cpp文件中的Local BoardId包含在BOARD.list中，否则无法升级。 216 2175. 配置“updater_config”文件夹中当前升级包所支持的版本范围：**VERSION.mbn**。 218 219 版本名称格式：Hi3516DV300-eng 10 QP1A.XXXXXX.{大版本号（6位）}.XXX{小版本号（3位）}。 220 221 例如：Hi3516DV300-eng 10 QP1A.190711.020。名称中“190711”为大版本号，“020”为小版本号。 222 223 配置例如下： 224 225 226 ```text 227 Hi3516DV300-eng 10 QP1A.190711.001 228 Hi3516DV300-eng 10 QP1A.190711.020 229 ``` 230 231 请确保基础版本号包含在VERSION.mbn中 232 2336. 针对增量（差分）升级包，还需要准备一个源版本（source_package），文件内容格式与目标版本（target_package）相同，需要打包成zip格式，即为：source_package.zip。 234 2357. 针对变分区升级包，还需要提供分区表文件“partition_file.xml”，partition_file.xml配置节点说明如下，可通过-pf参数指定。 236 237 分区表会随镜像一起生成，格式如下： 238 239 240 ```xml 241 <?xml version="1.0" encoding="GB2312" ?> 242 <Partition_Info> 243 <Part Sel="1" PartitionName="镜像名称1" FlashType="flash磁盘类型" FileSystem="文件系统类型" Start="该分区起始地址" Length="该分区大小" SelectFile="实际镜像所在路径"/> 244 <Part Sel="1" PartitionName="镜像名称2" FlashType="flash磁盘类型" FileSystem="文件系统类型" Start="该分区起始地址" Length="该分区大小" SelectFile="实际镜像所在路径"/> 245 </Partition_Info> 246 ``` 247 248 **表2** 分区表Part标签说明 249 250 | 标签名称 | 标签说明 | 251 | -------- | -------- | 252 | Sel | 该分区是否生效，1表明生效，0表明不生效。 | 253 | PartitionName | 分区名称，例如：fastboot、boot等。 | 254 | FlashType | flash磁盘类型，例如emmc、ufs等。 | 255 | FileSystem | 文件系统类型，例如ext3/4、f2fs等，也可能为none。 | 256 | Start | 分区起始位置，所有分区最起始为0，单位为兆（M）。 | 257 | Length | 分区占用长度，单位为兆（M）。 | 258 | SelectFile | 实际镜像或文件所在路径。 | 259 2608. 执行升级包制作命令。 261 262 **全量升级包** 263 264 命令如下： 265 266 267 ```text 268 python build_update.py ./target_package/ ./output_package/ -pk ./rsa_private_key2048.pem 269 ``` 270 271 - ./target_package/：指定target_package路径。 272 - ./output_package/：指定升级包输出路径。 273 - -pk ./rsa_private_key2048.pem：指定私钥文件路径。 274 275 **增量（差分）升级包** 276 277 命令如下： 278 279 280 ```text 281 python build_update.py ./target_package/ ./output_package/ -s ./source_package.zip -pk ./rsa_private_key2048.pem 282 ``` 283 284 - ./target_package/：指定target_package路径。 285 - ./output_package/：指定升级包输出路径。 286 - -s ./source_package.zip：指定“source_package.zip”路径，当存在镜像需要进行差分处理时，必须使用-s参数指定source版本包。 287 - -pk ./rsa_private_key2048.pem：指定私钥文件路径。 288 289 **变分区升级包** 290 291 命令如下： 292 293 294 ```text 295 python build_update.py ./target_package/ ./output_package/ -pk ./rsa_private_key2048.pem -pf ./partition_file.xml 296 ``` 297 298 - ./target_package/：指定target_package路径。 299 - ./output_package/：指定升级包路径。 300 - -pk ./rsa_private_key2048.pem：指定私钥文件路径。 301 - -pf ./partition_file.xml：指定分区表文件路径。 302 303 304### 上传升级包 305 306将升级包上传到厂商的OTA服务器。 307 308 309### 下载升级包 310 3111. 厂商应用从OTA服务器下载升级包。 312 3132. 对Hi3516DV300开源套件，需要插入SD卡(容量>100MBytes)。 314 315 316### 厂商应用集成OTA能力 317 3181. 轻量与小型系统 319 320 - 调用OTA模块的动态库libhota.so，对应头文件hota_partition.h和hota_updater.h路径：base\update\sys_installer_lite\interfaces\kits\。 321 - libhota.so对应的源码路径为：base\update\sys_installer_lite\frameworks\source。 322 - API的使用方法，见本文“API应用场景”和API文档的OTA接口章节。 323 - 如果需要适配开发板，请参考HAL层头文件：base\update\sys_installer_lite\hals\hal_hota_board.h。 324 3252. 标准系统请参考[JS参考规范](../../application-dev/reference/apis/js-apis-update.md)指导中的升级接口参考规范。 326 327 328#### API 应用默认场景 329 330升级包是按照上文“生成公私钥对”和“生成升级包”章节制作的。 331 332 333##### 开发指导 334 3351. 应用侧通过下载，获取当前设备升级包后，调用HotaInit接口初始化OTA模块。 336 3372. 调用HotaWrite接口传入升级包数据流，接口内部实现校验、解析及写入升级数据流。 338 3393. 写入完成后，调用HotaRestart接口重启系统，升级过程中，使用HotaCancel接口可以取消升级。 340 341 342##### 示例代码 343 344 使用OpenHarmony的“升级包格式和校验方法”进行升级。 345 346```cpp 347int main(int argc, char **argv) 348{ 349 printf("this is update print!\r\n"); 350 if (HotaInit(NULL, NULL) < 0) { 351 printf("ota update init fail!\r\n"); 352 return -1; 353 } 354 int fd = open(OTA_PKG_FILE, O_RDWR, S_IRUSR | S_IWUSR); 355 if (fd < 0) { 356 printf("file open failed, fd = %d\r\n", fd); 357 (void)HotaCancel(); 358 return -1; 359 } 360 int offset = 0; 361 int fileLen = lseek(fd, 0, SEEK_END); 362 int leftLen = fileLen; 363 while (leftLen > 0) { 364 if (lseek(fd, offset, SEEK_SET) < 0) { 365 close(fd); 366 printf("lseek fail!\r\n"); 367 (void)HotaCancel(); 368 return -1; 369 } 370 int tmpLen = leftLen >= READ_BUF_LEN ? READ_BUF_LEN : leftLen; 371 (void)memset_s(g_readBuf, READ_BUF_LEN, 0, READ_BUF_LEN); 372 if (read(fd, g_readBuf, tmpLen) < 0) { 373 close(fd); 374 printf("read fail!\r\n"); 375 (void)HotaCancel(); 376 return -1; 377 } 378 if (HotaWrite((unsigned char *)g_readBuf, offset, tmpLen) != 0) { 379 printf("ota write fail!\r\n"); 380 close(fd); 381 (void)HotaCancel(); 382 return -1; 383 } 384 offset += READ_BUF_LEN; 385 leftLen -= tmpLen; 386 } 387 close(fd); 388 printf("ota write finish!\r\n"); 389 printf("device will reboot in 10s...\r\n"); 390 sleep(10); 391 (void)HotaRestart(); 392 return 0; 393} 394``` 395 396 397#### API 应用定制场景 398 399升级包不是按照上文“生成公私钥对”和“生成升级包”章节制作的，是通过其它方式制作的。 400 401 402##### 开发指导 403 4041. 应用侧通过下载，获取当前设备升级包后，调用HotaInit接口初始化。 405 4062. 使用HotaSetPackageType接口设置NOT_USE_DEFAULT_PKG，使用"定制"流程。 407 4083. 调用HotaWrite接口传入升级包数据流，写入设备。 409 4104. 写入完成后，调用HotaRead接口读取数据，厂商可以自行校验升级包。 411 4125. 调用HotaSetBootSettings设置启动标记，在重启后需要进入uboot模式时使用（可选）。 413 4146. 调用HotaRestart接口，进行重启，升级过程中，使用HotaCancel接口可以取消升级。 415 416 417##### 示例代码 418 419 使用非OpenHarmony的“升级包格式和校验方法“进行升级。 420 421```cpp 422int main(int argc, char **argv) 423{ 424 printf("this is update print!\r\n"); 425 if (HotaInit(NULL, NULL) < 0) { 426 printf("ota update init fail!\r\n"); 427 (void)HotaCancel(); 428 return -1; 429 } 430 (void)HotaSetPackageType(NOT_USE_DEFAULT_PKG); 431 int fd = open(OTA_PKG_FILE, O_RDWR, S_IRUSR | S_IWUSR); 432 if (fd < 0) { 433 printf("file open failed, fd = %d\r\n", fd); 434 (void)HotaCancel(); 435 return -1; 436 } 437 int offset = 0; 438 int fileLen = lseek(fd, 0, SEEK_END); 439 int leftLen = fileLen; 440 while (leftLen > 0) { 441 if (lseek(fd, offset, SEEK_SET) < 0) { 442 close(fd); 443 printf("lseek fail!\r\n"); 444 (void)HotaCancel(); 445 return -1; 446 } 447 int tmpLen = leftLen >= READ_BUF_LEN ? READ_BUF_LEN : leftLen; 448 (void)memset_s(g_readBuf, READ_BUF_LEN, 0, READ_BUF_LEN); 449 if (read(fd, g_readBuf, tmpLen) < 0) { 450 close(fd); 451 printf("read fail!\r\n"); 452 (void)HotaCancel(); 453 return -1; 454 } 455 if (HotaWrite((unsigned char *)g_readBuf, offset, tmpLen) != 0) { 456 printf("ota write fail!\r\n"); 457 close(fd); 458 (void)HotaCancel(); 459 return -1; 460 } 461 offset += READ_BUF_LEN; 462 leftLen -= tmpLen; 463 } 464 close(fd); 465 printf("ota write finish!\r\n"); 466 leftLen = fileLen; 467 while (leftLen > 0) { 468 int tmpLen = leftLen >= READ_BUF_LEN ? READ_BUF_LEN : leftLen; 469 (void)memset_s(g_readBuf, READ_BUF_LEN, 0, READ_BUF_LEN); 470 if (HotaRead(offset, READ_BUF_LEN, (unsigned char *)g_readBuf) != 0) { 471 printf("ota write fail!\r\n"); 472 (void)HotaCancel(); 473 return -1; 474 } 475 /* do your verify and parse */ 476 offset += READ_BUF_LEN; 477 leftLen -= tmpLen; 478 } 479 /* set your boot settings */ 480 (void)HotaSetBootSettings(); 481 printf("device will reboot in 10s...\r\n"); 482 sleep(10); 483 (void)HotaRestart(); 484 return 0; 485} 486``` 487 488 489##### 系统升级 490 491厂商应用调用OTA模块的API，OTA模块执行升级包的签名验证、版本防回滚、烧写落盘功能，升级完成后自动重启系统。 492 493对于使用Hi3516DV300开源套件的轻量和小型系统，在需要实现防回滚功能的版本中，需要增加LOCAL_VERSION的值，如"ohos default 1.0"->"ohos default 1.1"，LOCAL_VERSION在device\hisilicon\third_party\uboot\u-boot-2020.01\product\hiupdate\ota_update\ota_local_info.c中。 494 495 示例，增加版本号。 496 497```cpp 498const char *get_local_version(void) 499{ 500#if defined(CONFIG_TARGET_HI3516EV200) || \ 501 defined(CONFIG_TARGET_HI3516DV300) 502#define LOCAL_VERSION "ohos default 1.0" /* increase: default release version */ 503``` 504 505 506#### AB 升级场景 507 508 509##### 开发流程 510 5111. 应用侧下载获取当前设备升级包 5122. update_service 通过 SAMGR 将系统安装部件拉起 5133. 由系统安装部件完成静默热安装 5144. 下一次重启时激活新版本 515 516 517##### 开发步骤 518 519- JS API 通过 update_service 模块处理AB升级相关流程 520 521 1.升级包安装进度显示接口： 522 ```cpp 523 on(eventType: "upgradeProgress", callback: UpdateProgressCallback): void; 524 ``` 525 526 2.设置激活策略（立即重启，夜间重启，随下次重启激活）接口： 527 ```cpp 528 upgrade(apply) 529 ``` 530 531 532- update_service 通过 SAMGR 将系统安装服务拉起 533 534 1.拉起系统安装服务，并建立IPC连接： 535 ```cpp 536 int SysInstallerInit(void* callback) 537 ``` 538 539 2.安装指定路径的AB升级包： 540 ```cpp 541 int StartUpdatePackageZip(string path) 542 ``` 543 544 3.设置进度回调： 545 ```cpp 546 int SetUpdateProgressCallback(void* callback) 547 ``` 548 549 4.获取升级包安装状态（0 未开始,1 安装中,2 安装结束）: 550 ```cpp 551 int GetUpdateStatus() 552 ``` 553 554 555- 使用 HDI 接口南向激活新版本 556 557 1.获取当前启动的slot，来决策待升级的分区： 558 ```cpp 559 int GetCurrentSlot() 560 ``` 561 562 2.在升级结束后，将已升级好的slot进行切换，重启完成新版本更新： 563 ```cpp 564 int SetActiveBootSlot(int slot) 565 ``` 566 567 3.在升级开始时，将待升级的分区slot设置成unbootable状态： 568 ```cpp 569 int setSlotUnbootable(int slot) 570 ``` 571 572 4.获取slot个数，1位非AB，2为AB分区，用例兼容AB和非AB的流程判断： 573 ```cpp 574 int32 GetSlotNum(void) 575 ``` 576 577 578##### 常见问题 579 5801. 升级包下载，安装过程出现异常 581<br>系统保持当前版本继续运行，在下一个搜包周期重新完成版本升级过程 582 5832. 升级包完成非启动分区的包安装，在激活过程中出现异常 584<br>需要进行异常回滚，并将无法启动的分区设置为 unbootable，下次则不从该分区启动 585 586 587##### 调测验证 588 589设备能在正常使用的情况下，在后台从服务器下载升级包，完成静默升级，并按照厂商设置的策略重启激活版本。
