Rockchip SD Card Boot Reference
文件标识：RK-KF-YF-171
发布版本：1.2.0
日期：2021.04
文件密级：□绝密 □秘密 ■内部资料 □公开
免责声明
本文档按“现状”提供，瑞芯微电子股份有限公司（“本公司”，下同）不对本文档的任何陈述、信息和内容的准确性、可靠性、完整性、适销性、特定目的性和非侵权性提供任何明示或暗示的声明或保证。本文档仅作为使用指导的参考。
由于产品版本升级或其他原因，本文档将可能在未经任何通知的情况下，不定期进行更新或修改。
商标声明
“Rockchip”、“瑞芯微”、“瑞芯”均为本公司的注册商标，归本公司所有。
本文档可能提及的其他所有注册商标或商标，由其各自拥有者所有。
版权所有© 2020瑞芯微电子股份有限公司
超越合理使用范畴，非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。
瑞芯微电子股份有限公司
Rockchip Electronics Co., Ltd.
地址： 福建省福州市铜盘路软件园A区18号
客户服务电话： +86-4007-700-590
客户服务传真： +86-591-83951833
客户服务邮箱： fae@rock-chips.com
前言
概述
本文主要介绍 Rockchip 对 SD 卡的几种使用，包括制作固件，制作各种 SD 功能卡，固件在 SD 卡内的分布以及 boot 的流程，工程师可以依据文档排查使用 SD 卡过程出现的各类问题。
读者对象
本文档（本指南）主要适用于以下工程师：
技术支持工程师
软件开发工程师
产品版本
修订记录
| 日期 | 版本 | 作者 | 修改说明 |
|---|---|---|---|
| 2018-07-17 | V1.0.0 | 朱志展、刘翊 | 初始版本 |
| 2019-09-06 | V1.1.0 | 朱志展 | 升级卡支持GPT |
| 2021-04-15 | V1.2.0 | 朱志展 | 增加BCB标志说明及修正各个章节 |
[TOC]
类型简介
Rockchip 将 SD 卡划分为常规 SD 卡，SD 升级卡，SD 启动卡，SD 修复卡。可以通过瑞芯微创建升级磁盘工具将 update.img 下载到 SD 卡内，制作不同的卡类型。
| 卡类型 | 功能 |
|---|---|
| 常规 SD 卡 | 普通的存储设备 |
| SD 升级卡 | 设备从 SD 卡内启动到 recovery，由 recovery 负责把 sd 内固件更新到设备存储 |
| SD 启动卡 | 设备直接从 SD 卡启动 |
| SD 修复卡 | 从 pre-loader 开始拷贝 SD 卡内的固件到设备存储 |
固件制作
update.img 为 Rockchip 提供整套固件的一个合集，它不仅包含了完整固件，还包括固件完整性校验等一些数据。update.img 可以使得用户非常方便地更新整套固件。
Rockchip 提供了专门的工具来制作 update.img，如果使用 Rockchip sdk，可以进入RKTools/linux/Linux_Pack_Firmware/rockdev/目录，如下：
我们可以通过修改 package-file 来打包需要生成的 update.img。package-file 文件内容如下：
# NAME Relative path
#
#HWDEF HWDEF
package-file package-file
bootloader Image/MiniLoaderAll.bin
parameter Image/parameter.txt
uboot Image/uboot.img
trust Image/trust.img
misc Image/misc.img
resource Image/resource.img
kernel Image/kernel.img
boot Image/boot.img
#recovery Image/recovery.img
#system Image/system.img
#vendor Image/vendor.img
#oem Image/oem.img
# baseparamer Image/baseparamer.img
# 要写入backup分区的文件就是自身（update.img）
# SELF 是关键字，表示升级文件（update.img）自身
# 在生成升级文件时，不加入SELF文件的内容，但在头部信息中有记录
# 在解包升级文件时，不解包SELF文件的内容。
# RESERVED不打包backup
backup backupimage/backup.img
update-script update-script
recover-script recover-script
添加文件时，写入文件名及固件地址。如果是不需要打包某个固件，则在固件名前面加“#”屏蔽掉即可。 点击运行 mkupdate.bat 即可生成 update.img。
工具使用
常规 SD 卡
普通 SD 卡与 PC 使用完全一样，可以在 U-Boot 和 Kernel 系统中作为普通的存储空间使用，无需工具对 SD 卡做任何操作。
SD 升级卡
SD 卡升级卡是通过 RK 的工具制作，实现通过 SD 卡对本地存储(如 eMMC，nand flash)内系统的升级。SD 卡升级是可以脱离 PC 机或网络的一种固件升级方法。具体是将 SD 卡启动代码写到 SD 卡的保留区，然后将固件拷贝到 SD 卡可见分区。主控从 SD 卡启动时，SD 卡启动代码和升级代码将固件烧写到本地主存储中。同时 SD 升级卡支持 PCBA 测试和 Demo 文件的拷贝。SD 升级卡的这些功能可以使固件升级做到脱离 PC 机进行，提高生产效率。
制作 SD 升级卡流程如下：
操作步骤如下：
-
选择可移动磁盘设备
-
选择功能模式为固件升级
-
选择需要升级的固件
-
点击开始创建
具体配置可以参考上图设置。 再次制作： 已经制作好 SD 升级卡，如果只需要更新固件和 demo 文件时，可以按下面步骤来完成：
-
拷贝固件到 SD 卡根目录，并重命名为 sdupdate.img
-
拷贝 demo 文件到 SD 卡根目录下的 Demo 目录中
SD 引导升级卡格式(非 GPT)
| 偏移 | 数据段 |
|---|---|
| 扇区 0 | MBR |
| 扇区 64-4M | IDBLOCK(启动标志置 0) |
| 4M-8M | Parameter |
| 12M-16M | uboot |
| 16M-20M | trust |
| …… | misc（BCB写入recovery\n--rk_fwupdate\n） |
| …… | resource |
| …… | kernel |
| …… | recovery |
| 剩下空间 | Fat32 存放 update.img |
SD 引导升级卡格式(GPT)
| 偏移 | 数据段 |
|---|---|
| 扇区 0 | MBR |
| 扇区 1-34 | GPT 分区表 |
| 扇区 64-4M | IDBLOCK(启动标志置 0) |
| 4M-8M | Parameter |
| …… | uboot |
| …… | trust |
| …… | misc |
| …… | resource |
| …… | kernel |
| …… | recovery |
| 剩下空间 | Fat32 存放 update.img |
SD 启动卡
SD 启动卡是通过 RK 的工具制作，实现设备系统直接从 SD 卡启动，极大的方便用户更新新编译的固件而不用烧写固件到设备存储内，也可以作为设备主存储使用。目前主要用于系统从 SD 卡启动，或用于 PCBA 测试。注意：PCBA 测试只是 recovery 下面的一个功能项，可用于升级卡与启动卡。 制作启动卡流程如下：
-
选择可移动磁盘设备
-
选择功能模式为 SD 启动
-
选择需要升级的固件
-
点击开始创建
具体配置可以参考上图设置。
SD 引导启动卡格式(非 GPT)
| 偏移 | 数据段 |
|---|---|
| 扇区 0 | MBR |
| 扇区 64-4M | IDBLOCK(启动标志置 1) |
| 4M-8M | Parameter |
| 8M-12M | uboot |
| 12M-16M | trust |
| …… | misc |
| …… | resource |
| …… | boot |
| …… | kernel |
| …… | recovery |
| …… | system |
| …… | user |
SD 引导启动卡格式(GPT)
| 偏移 | 数据段 |
|---|---|
| 扇区 0 | MBR |
| 扇区 1-34 | GPT 分区表 |
| 扇区 64-4M | IDBLOCK(启动标志置 1) |
| …… | uboot |
| …… | Boot |
| …… | trust |
| …… | resource |
| …… | kernel |
| …… | recovery |
| …… | system |
| …… | vendor |
| …… | oem |
| …… | user |
| 最后 33 扇区 | 备份 GPT |
SD 修复卡
SD 修复卡运行功能，类似于 SD 卡升级功能，但固件升级发生在 pre-loader（miniloader）的 SD 卡升级代码。首先工具会将启动代码写到 SD 卡的保留区，然后将固件拷贝到 SD 卡可见分区上，主控从 SD 卡启动时，SD 卡升级代码将固件升级到本地主存储中。主要用于设备固件损坏，SD 卡可以修复设备。 制作修复卡流程如下：
-
选择可移动磁盘设备
-
选择功能模式为 SD 启动和修复
-
选择需要升级的固件
-
点击开始创建
具体配置可以参考上图设置。 SD 修复卡格式(非 GPT)
| 偏移 | 数据段 |
|---|---|
| 扇区 0 | MBR |
| 扇区 64-4M | IDBLOCK(启动标志置 2) |
| 4M-8M | Parameter |
| 8M-12M | uboot |
| 12M-16M | trust |
| …… | misc |
| …… | resource |
| …… | boot |
| …… | kernel |
| …… | recovery |
| …… | system |
| …… | user |
SD 修复卡格式(GPT)
| 偏移 | 数据段 |
|---|---|
| 扇区 0 | MBR |
| 扇区 1-34 | GPT 分区表 |
| 扇区 64-4M | IDBLOCK(启动标志置 2) |
| …… | uboot |
| …… | Boot |
| …… | trust |
| …… | resource |
| …… | kernel |
| …… | recovery |
| …… | system |
| …… | vendor |
| …… | oem |
| …… | user |
| 最后 33 扇区 | 备份 GPT |
标志说明
SD 卡作为各种不同功能的卡，会在 SD 卡内做一些标志。
在 SD 卡的第 64 扇区处，起始标志若为（magic number）为 0xFCDC8C3B，则为一些特殊卡，会从 SD 卡内读取固件，启动设备。如果不是，则作为普通 SD 卡看待。在第（64 扇区 + 616bytes）地方，存放各种卡的标志。目前有三种类型：
| 标志 | 卡类型 |
|---|---|
| 0 | 升级卡或 PCBA 测试卡 |
| 1 | 启动卡 |
| 2 | 修复卡 |
目前，这种写idb block flag的方式有以下劣势：
- RK独有设计，不兼容
- 存在安全问题，因为这个标志是制卡的时候写入到idb block，破坏idb block的完整性
- 新版的idb block没有预留该标志位置（其实没必要留，因为会碰到上面所述问题）
为了解决以上问题，RK复用Android BCB的设计，在recovery内添加recovery\n--rk_fwupdate\n作为进入SD升级的标志。
两种标志支持情况：
| 平台 | idb block flag | Android BCB |
|---|---|---|
| rk3568/rk3566 | ✔ | |
| rv1126/rv1109 | ✔ | ✔ |
| rk3399 | ✔ | ✔ |
| rk3368 | ✔ | ✔ |
| rk3328 | ✔ | ✔ |
| rk3326 | ✔ | ✔ |
| rk3308 | ✔ | ✔ |
| rk3288 | ✔ | ✔ |
| rk3229 | ✔ | ✔ |
| rk3128 | ✔ | ✔ |
| rk3126 | ✔ | ✔ |
后续随着平台升级，工具更新，会逐渐摒弃写idb block flag这种方式。
注意：SDDiskTool需要更新到v1.67或更高版本才会支持Android BCB这种方式。
流程分析
SD 卡的 boot 流程可分为 pre-loader/SPL 启动流程与 U-Boot启动流程，pre-loader与U-Boot流程都需要加载检测 SD 卡及 SD 卡 IDB Block 内 Startup Flag 标志，并且会依据这些标志执行不同的功能。SPL流程则是设置SD卡为最高优先级的启动设备，如果SD卡有可以启动的固件，则优先从sd卡加载固件并启动。
pre-loader 启动流程
SPL 启动流程
st=>start: Start
op1=>operation: SPL
op2=>operation: 查找存储设备
op3=>operation: 当前设备为SD卡
op4=>operation: 查找其他存储设备
op5=>operation: 启动下一级
cond1=>condition: 是否有SD卡?
cond2=>condition: 是否有可启动固件
e=>end: End
st->op1->op2->cond1
cond1(yes)->cond2
cond1(no)->op4
cond2(yes)->op5
cond2(no)->op4
op5->e
U-Boot 启动流程
st=>start: Start
op1=>operation: Uboot
op2=>operation: 查找存储设备
op3=>operation: 当前设备
设置为SD卡
op4=>operation: cmdline添加
sdfwupdate标志
op5=>operation: 从misc分区获取
启动模式为recovery
op6=>operation: 加载recovery，
进入recovery模式
op7=>operation: 检测其他
存储设备
op8=>operation: 没有检测
到存储设备
op9=>operation: cmdline添加
sdfwupdate标志
cond1=>condition: 是否有SD卡?
cond2=>condition: 64扇区
起始标志
是否为
0xFCDC8C3B?
cond3=>condition: 64扇区
616bytes标志
为0?
cond4=>condition: 64扇区
起始标志
是否为
0x534e4b52或
0x534e5252?
cond5=>condition: BCB的recovery
是否为
recovery\n--rk_fwupdate\n?
e=>end: End
st->op1->op2->cond1
cond1(yes)->cond2
cond1(no)->op7
cond2(yes)->cond3
cond2(no)->cond4
cond3(yes)->op3
cond3(no)->op7
cond4(yes)->op3
cond4(no)->op7
op3->op4->op5->cond5
cond5(yes)->op9
cond5(no)->op7
op9->op6->e
recovery 及 PCBA 说明
具体可参考《Rockchip Recovery 用户操作指南 V1.03.pdf》。
注意事项
-
非 GPT 格式，U-Boot 需要配置 CONFIG_RKPARM_PARTITION。
-
在制作 SD 升级卡时，update.img 必须包含 MiniloaderAll.bin，parameter.txt，uboot.img，trust.img，misc.img，resource.img，recovery.img 这些固件，否则烧写 update.img 会出现写入 MBR 失败的提示。