AT32 IAP by Ymodem

AN0043 应用笔记

AT32 IAP by Ymodem

前言

对于大多数基于闪存的系统，一项重要要求是能够在最终产品中安装固件时进行更新。此功能称为应用程序内编程（IAP）。

本应用笔记的目的是提供在AT32微控制器上创建IAP by Ymodem应用程序的方法。

支持Ymodem的上位机软件和IAP by Ymodem示例的源代码位于BSP固件库的utilities文件夹内。

支持型号列表：

支持型号

AT32全系列

               

目录

1                   IAP 在线升级原理概述.. 5

2                   AT32 IAP by Ymodem快速使用方法.. 7

2.1        硬件资源... 7

2.2        软件资源... 7

2.3        Ymodem上位机使用... 8

3                   AT32 IAP by Ymodem程序设置.. 10

3.1        地址分布... 10

3.2        bootloader设置... 10

3.3        app设置... 10

3.4        MCU与上位机通信流程... 11

4                   版本历史.. 13

表目录

表1. 地址分布... 10

表2. 文档版本历史... 13

图目录

图1. IAP 代码执行流程... 5

图2. AT-START-F403A. 7

图 3. Ymodem上位机... 8

图 4. 上位机发送文件... 8

图 5. 上位机显示正在下载... 9

图 6. 上位机接收文件... 9

图 7. bootloader addr的设置... 10

图 8. app addr的设置... 11

图 9. Ymodem通信流程... 12

1. IAP 在线升级原理概述

IAP（In Application Programming）即在应用编程，IAP是用户自己的程序在运行过程中对User Flash的部分区域进行烧写，目的是为了在产品发布后可以方便地通过预留的通信口对产品中的固件程序进行更新升级。通常实现IAP功能时，即用户程序运行中作自身的更新操作，需要在设计固件程序时编写两个项目代码，第一个项目程序不执行正常的功能操作，而只是通过某种通信方式(如USB、USART)接收程序或数据，执行对第二部分代码的更新；第二个项目代码才是真正的功能代码。这两部分项目代码都同时烧录在User Flash中，当芯片上电后，首先是第一个项目代码开始运行，它作如下操作：

1. 检查是否需要对第二部分代码进行更新,
2. 如果不需要更新则转到 4
3. 执行更新操作
4. 跳转到第二部分代码执行

图1. IAP 代码执行流程

在图上图所示流程中，AT32复位后，还是从0X08000004地址取出复位中断向量的地址，并跳转到复位中断服务程序，在运行完复位中断服务程序之后跳转到IAP的main函数，如图标号①所示。在执行完IAP以后（即将新的APP代码写入AT32的FLASH，灰底部分。新程序的复位中断向量起始地址为0X08000004+N+M），跳转至新写入程序的复位向量表，取出新程序的复位中断向量的地址，并跳转执行新程序的复位中断服务程序，随后跳转至新程序的main函数，如图标号②和③所示，同样main函数为一个死循环，并且注意到此时AT32的FLASH，在不同位置上，共有两个中断向量表。

在main函数执行过程中，如果CPU得到一个中断请求，PC指针仍强制跳转到地址0X08000004中断向量表处，而不是新程序的中断向量表，如图标号④所示；程序再根据我们设置的中断向量表偏移量，跳转到对应中断源新的中断服务程序中，如图标号⑤所示；在执行完中断服务程序后，程序返回main函数继续运行，如图标号⑥所示。

通过以上两个过程的分析，我们知道IAP程序必须满足两个要求：

1. 新程序必须在IAP程序之后的某个偏移量为x的地址开始
2. 必须将新程序的中断向量表相应的移动，移动的偏移量为x

1. AT3 IAP by Ymodem快速使用方法
   1. 硬件资源

文档中是用AT-START-AT32F403A实验板的硬件条件为例。

1. 指示灯LED2/LED3
2. USART1(PA9/PA10)打印信息用非必须
3. USART2(PA2/PA3)
4. USER按键(PA0)
5. AT-START-AT32F403A实验板

图2. AT-START-F403A

1. 1. 软件资源
2. Tool

1. AN0043_SourceCode_V2.0.0\utilities\AN0043_demo\tool，支持Ymodem协议的串口上位机Tera Term

1. SourceCode

1. AN0043_SourceCode_V2.0.0\utilities\AN0043_demo\source_code，IAP源程序 
2. AN0043_SourceCode_V2.0.0\libraries，AT32外设库
3. AN0043_SourceCode_V2.0.0\middlewares，其他资源

1. Doc

1. 《AN0043_AT32_MCU_IAP_by_Ymodem_V2.x.x.docx》

Note:工程基于keil v5建立，若用户需要在其他编译环境上使用，请参考

AT32F403A_407_Firmware_Library_V2.x.x\project\at_start_f403a\templates中各种编译环境（例如IAR6/7/8,keil 4/5,eclipse_gcc）进行对应修改即可。

1. 1. Ymodem上位机使用
2. 打开bootloader源程序，编译后下载到实验板
3. 运行AN0043_SourceCode_V2.0.0\utilities\AN0043_demo\tool\teraterm中的上位机安装程序teraterm-4.104，安装时均选择默认选项即可，安装后打开桌面的Tera Term图标，选择串口。该上位机软件默认的波特率为9600，如需调整可在Setup->Serial port中修改

图 3. Ymodem上位机

1. 如图，选择File->Transfer->YMODEM->Send，并选择需要下载的bin档

图 4. 上位机发送文件

1. 按一次AT-START-AT32F403A上的USER按键，LED3被点亮，表示开始下载，下载完成后LED3熄灭。

图 5. 上位机显示正在下载

1. 如图，选择File->Transfer->YMODEM->Receive，再次按下USER按键，MCU会将刚才下载的内容回传到上位机。LED3被点亮，表示开始上传，上传完成后LED3熄灭。此过程非必须，在此展示是供自己开发上位机的客户利用回传的文件来校验下载的正确性。

图 6. 上位机接收文件

1. 再次按下USER按键，MCU会跳转到下载的app中，LED3闪烁

1. AT2 IAP by Ymodem程序设置
   1. 地址分布

表1. 地址分布

ITEM	Address and Size
app code	Add2:0x800 4000 ~
bootloader code	Add1:0x800 0000   size:0x4000(16K Byte)

1. 1. bootloader设置
2. Keil设置

图 7. bootloader addr的设置

1. app address在bootloader源程序中的配置在iap.h文件中，该文件中还有目标MCU的page size等的配置，需要用户根据所用型号修改。

#define APP_START_ADDR               0x08004000

1. 1. app设置

该demo提供了1个app程序供测试用，以0x08004000为起始地址。app中LED3闪烁。

1. Keil工程设置

图 8. app addr的设置

1. app源程序设置

根据需要修改main.c中的中断向量偏移

/* config vector table offset */ nvic_vector_table_set(NVIC_VECTTAB_FLASH, 0x4000);

1. 编译生成bin文件

通过在User选项卡，设置编译后调用fromelf.exe，根据.axf文件生成.bin文件，用于IAP更新。

以上3个步骤，我们就可以得到一个app程序的bin档，通过bootloader程序即可实现更新。

1. 1. MCU与上位机通信流程
2. MCU与上位机通过Ymodem协议下载bin档的通信流程，其中命令的定义在ymodem.h中

#define SOH                     (0x01)  /* start of 128-byte data packet */ #define STX                     (0x02)  /* start of 1024-byte data packet */ #define EOT                     (0x04)  /* end of transmission */ #define ACK                     (0x06)  /* acknowledge */ #define NAK                     (0x15)  /* negative acknowledge */ #define CA                       (0x18)  /* two of these in succession aborts transfer */ #define CRC16                   (0x43)  /* 'C' == 0x43, request 16-bit CRC */

图 9. Ymodem通信流程

1. 版本历史

表2. 文档版本历史

日期	版本	变更
2022.10.28	2.0.0	最初版本
2023.6.5	2.0.1	更新文档部分拼写错误
2023.7.5	2.0.2	更新文档部分拼写错误