zboot

Generic STM32 serial bootloader, with a simple command-line interface

某次@xjtuecho提到他做的一个bootloader, 支持N多型号, 只要改下配置文件就能适应不同型号；此外还提供了简单的命令解释器, 可以在串口命令行实现查看/擦除任意位置flash, 模拟eeprom读写(与app共享)等功能. 是不是挺实用? 于是打算自己也实现一个.

开发环境

arm-none-eabi-gcc 4.9.3. Keil或IAR用户可能需要手动修改链接脚本和Makefile之类.

支持MCU列表(更新中)

STM32F030C8, 实测正常使用.
STM32F042F6, 实测正常使用.
STM32F051C8, 未充分测试.
STM32F070CB, 未充分测试.
STM32F072CB, 实测正常使用.
STM32F100C8, 实测正常使用.
STM32F103xC/xE, 实测正常使用 (GD32F103xC/xE可以直接代用.)
STM32F303CC, 实测正常使用.
STM32F401RC, 实测正常使用.
STM32F407VE, 未充分测试.
GD32F130F8, 实测正常使用.
GD32F330F8, 实测正常使用.
GD32F350CB, 实测正常使用.
GD32FFPRTGU6, 实测正常使用 (当作STM32F103xC/xE即可.)
GD32F303CC, 实测正常使用 (当作STM32F103xC/xE即可.)
STM32F103C8, 实测正常使用.

空间占用情况

在FLASH每页1K的MCU上共占用7或8K FLASH, 其中EEPROM占1页, 提供256字节EEPROM空间.
在FLASH每页2K的MCU上共占用10K FLASH, 提供512字节EEPROM空间.
在STM32F401/407上共占用32K FLASH, 提供4096字节EEPROM空间. (尚未充分测试!)
如果不使用EEPROM (修改zboot_misc.h中的宏定义), 可以节约2K FLASH.
如果不使用命令行界面，总占用FLASH可以降到2-3K. (未充分测试.)

时钟及波特率

为了时钟配置简单起见, bootloader以8M HSI时钟运行. 串口波特率定为8M / 16 = 500kbps.

配置流程

~~在usart.c里修改用到的usart外设和管脚, 需要仔细对照自己的stm32型号.~~

现在基本不需要修改usart.c了, 只要在zboot_misc.h里修改宏定义即可.

之后执行build.bat, 选择mcu型号, 即可编译出所需要的bootloader.

上位机见根目录的iap.py, python 3.6.4和python 3.7.1实测正常工作.

需要zlib和bincopy两个第三方库. (前者用于计算CRC32校验, 后者用于把hex格式转为binary.)

app这边需要做的:

写入bootloader后先在串口命令行执行## sysinfo, 取得app区的入口地址, 应该是0x08002000或0x08002800. STM32F401/407则是0x08008000.
修改你的app项目的链接文件(.ld或.lds, 在不同开发环境下可能不同), 把FLASH区的起始地址改为上面的入口地址, LENGTH要根据页大小减去8K或10K. STM32F401/407要减去32K.
Makefile或者其他类似指定了FLASH大小的场合, 要减去8K或10K. STM32F401/407要减去32K.
main.c在最前面加上两行, 其中VECT_TAB_OFFSET的值是0x2000或0x2800. STM32F401/407为0x8000. ( 如果不使用EEPROM, 入口地址应该是0x08001800或0x08002000. 如果不使用命令行界面, 则需要自行计算app区入口地址. 你的Makefile和main.c等处也要做相应调整. )

NVIC_SetVectorTable(NVIC_VectTab_FLASH, VECT_TAB_OFFSET);
__enable_irq();

如果是stm32f0系列呢? 它们不提供重定向中断向量表的功能, 所以NVIC_SetVectorTable就没用了.

不过bootloader还是能用的, 稍微麻烦一点, 需要在main.c最前面加上这几行, 把中断向量表复制到SRAM的起始位置, 然后把复位地址改为指向SRAM起始位置.

memcpy((void*)(0x20000000), (void*)APP_BASE, 256);
RCC_APB2PeriphClockCmd(RCC_APB2Periph_SYSCFG, ENABLE);
SYSCFG_MemoryRemapConfig(SYSCFG_MemoryRemap_SRAM);
__enable_irq();

APP_BASE的值是前面提到过的0x08002000/0x08002800之类. __enable_irq()则还是需要的. 此外, .ld/.lds文件里SRAM起始位置需要改为0x20000100, LENGTH要减去256.

使用方法

上电启动同时执行py iap.py xxx.hex即可. (启动延迟约1s后自动跳转到app.)
如果需要一键iap, 应该怎么操作呢? 需要在app里响应命令"## REBOOT"后, 先向串口输出任意字符, 然后执行NVIC_SystemReset()即可. 如果是stm32f0xx, 则还要先执行SYSCFG_MemoryRemapConfig(SYSCFG_MemoryRemap_Flash), 把系统起始位置改回FLASH.
可以在app的Makefile里增加一条目标iap, 这样更新程序时只要执行make iap即可, 省太多事了.

PYTHON := "py.exe"
IAP := $(PYTHON) iap.py
...
iap:
    $(IAP) xxx.hex

如果要在app里使用eeprom呢? 只要在app里加上flash_eeprom.h和flash_eeprom.c两个文件, 并在使用前先初始化即可:

FLASH_EEPROM_Config(APP_BASE - PAGE_SIZE, PAGE_SIZE);

如果不需要使用EEPROM呢? 在zboot_misc.h里把_USE_EEPROM后面的1改为0, 这样可以再节约2K flash.

如果不需要使用命令行界面, 可以在zboot_misc.h里再把_USE_CLI后面的1改为0. 这样总的flash空间用量可降到2或3K.

有些MCU的实际容量比标称的大, 比如STM32F103C8T6实际有可能和CBT6一样是128K, STM32F030F4P6是32K, STM32F103RCT6是512K等(不一定每片都可以). 如果想试试, 在zboot_misc.h里把_FORCE_FLASH_SIZE后面的0改为你需要的值(单位KB)即可. 如果写入出错, 请把这里改回0. 玩玩可以, 做产品不建议这么搞.

命令行操作

所有命令前面需要加上##.

- help: 显示帮助.
- empty: 检查app区是否为空.
- erase_all: 擦除app区全部内容.
- eeprom: 
    - eeprom read [addr] [size]: 读取EEPROM内容.
    - eeprom write addr data: 写入EEPROM内容, data为unsigned short型(2字节).
    - eeprom readall: 读取EEPROM全部内容.
    - eeprom eraseall: 擦除EEPROM全部内容.
- reboot: 复位.
- read [addr] [size]: 读取指定地址, 包括FLASH/SRAM/外设等均可. 如果读到非法地址会复位.
- sysinfo: 显示系统信息, 包括FLASH大小, SRAM大小, FLASH单页大小, Bootloader和APP占用空间, EEPROM和APP的起始地址.

注意事项

STM32F10X可能需要打开特定的REMAP, 请参照Datasheet/Reference Manual修改zboot.misc里#define _GPIO_PIN_REMAP这行.
STM32F0/F3支持TX/RX管脚交换, 只需要根据情况把#define _USART_PIN_SWAP后面改为1或0即可. F1/F4如果弄错TX/RX, 要么费点劲飞线, 要么就得重新做板了. GD32呢? F1X0和F3X0支持TX/RX交换, 而F10X和F30X不支持.

致谢

xjtuecho (@xjtuecho) elm-chan (http://elm-chan.org)

bd4sad/zboot