zh_CN translation of bootloader document

This commit is contained in:
suda-morris 2019-04-09 16:35:58 +08:00
parent b1d67ad344
commit ab406f8429
3 changed files with 61 additions and 2 deletions

View file

@ -1,5 +1,6 @@
Bootloader
=====================
:link_to_translation:`zh_CN:[中文]`
Bootloader performs the following functions:

View file

@ -1 +1,59 @@
.. include:: ../../en/api-guides/bootloader.rst
引导加载程序Bootloader
==========================
:link_to_translation:`en:[English]`
引导加载程序Bootloader主要执行以下任务
1. 内部模块的最小化初始配置;
2. 根据分区表和 ota_data如果存在选择需要引导的应用程序app分区
3. 将此应用程序映像加载到 RAMIRAM 和 DRAM最后把控制权转交给应用程序。
引导加载程序位于 Flash 的 `0x1000` 偏移地址处。
恢复出厂设置
------------
用户可以编写一个基本的工作固件然后将其加载到工厂分区factory中。
接下来,通过 OTA空中升级更新固件更新后的固件会被保存到某个 OTA app 分区中OTA 数据分区也会做相应更新以指示从该分区引导应用程序。
如果你希望回滚到出厂固件并清除设置,则需要设置 :ref:`CONFIG_BOOTLOADER_FACTORY_RESET`
出厂重置机制允许将设备重置为出厂模式:
- 清除一个或多个数据分区。
- 从工厂分区启动。
:ref:`CONFIG_BOOTLOADER_DATA_FACTORY_RESET` - 允许用户选择在恢复出厂设置时需要删除的数据分区。可以通过逗号来分隔多个分区的名字,并适当增加空格以便阅读(例如 "nvs, phy_init, nvs_custom, ...")。请确保此处指定的名称和分区表中的名称相同,且不含有 “app” 类型的分区。
:ref:`CONFIG_BOOTLOADER_OTA_DATA_ERASE` - 恢复出厂模式后设备会从工厂分区启动OTA 数据分区会被清除。
:ref:`CONFIG_BOOTLOADER_NUM_PIN_FACTORY_RESET`- 设置用于触发出厂重置的 GPIO 编号,必须在芯片复位时将此 GPIO 拉低才能触发出厂重置事件。
:ref:`CONFIG_BOOTLOADER_HOLD_TIME_GPIO`- 设置进入重置或测试模式所需要的保持时间(默认为 5 秒。设备复位后GPIO 必须在这段时间内持续保持低电平,然后才会执行出厂重置或引导测试分区。
示例分区表如下::
# Name, Type, SubType, Offset, Size, Flags
# 注意,如果你增大了引导加载程序的大小,请确保更新偏移量,避免和其它分区发生重叠
nvs, data, nvs, 0x9000, 0x4000
otadata, data, ota, 0xd000, 0x2000
phy_init, data, phy, 0xf000, 0x1000
factory, 0, 0, 0x10000, 1M
test, 0, test, , 512K
ota_0, 0, ota_0, , 512K
ota_1, 0, ota_1, , 512K
从测试固件启动
--------------
用户可以编写在生产环境中测试用的特殊固件,然后在需要的时候运行。此时需要在分区表中专门申请一块分区用于保存该测试固件(详情请参阅 :doc:`分区表 <partition-tables>`)。如果想要触发测试固件,还需要设置 :ref:`CONFIG_BOOTLOADER_APP_TEST`
:ref:`CONFIG_BOOTLOADER_NUM_PIN_APP_TEST` - 设置引导测试分区的 GPIO 管脚编号,该 GPIO 会被配置为输入模式,并且会使能内部上拉电阻。若想触发测试固件,该 GPIO 必须在芯片复位时拉低。设备重启时如果该 GPIO 没有被激活(即处于高电平状态),那么会加载常规配置的应用程序(可能位于工厂分区或者 OTA 分区)。
:ref:`CONFIG_BOOTLOADER_HOLD_TIME_GPIO` - 设置进入重置或测试模式所需要的保持时间(默认为 5 秒。设备复位后GPIO 必须在这段时间内持续保持低电平,然后才会执行出厂重置或引导测试分区。
自定义引导程序
--------------
用户可以重写当前的引导加载程序,具体做法是,复制 `/esp-idf/components/bootloader` 文件夹到项目目录中,然后编辑 `/your_project/components/bootloader/subproject/ain/bootloader_main.c` 文件。
在引导加载程序的代码中,用户不可以使用驱动和其他组件提供的函数,如果确实需要,请将该功能的实现部分放在 bootloader 目录中(注意,这会增加引导程序的大小)。监视生成的引导程序的大小是有必要的,因为它可能会与内存中的分区表发生重叠而损坏固件。目前,引导程序被限制在了分区表之前的区域(分区表位于 `0x8000` 地址处)。

View file

@ -18,7 +18,7 @@ API 指南
Thread Local Storage <thread-local-storage>
High Level Interrupts <hlinterrupts>
JTAG 调试 <jtag-debugging/index>
Bootloader <bootloader>
引导加载程序 <bootloader>
分区表 <partition-tables>
Secure Boot <../security/secure-boot>
ULP 协处理器 <ulp>