利用 USB DFU实现 IAP功能

前言
伴随着固件升级需求的增加，STM32提供了灵活的升级方式。本文一步一步介绍如何利用USB DFU Class以及ST提供的DfuSe demo软件工具实现IAP（In Application Program）功能，但并不涉及到DFU class移植。
0 [5 G0 r  r5 m$ ~$ A7 H* x0 h
一 实现环境
开发板：STM32F746G-DISCO
开发库：STM32CubeF7 v1.3.0
集成开发环境：IAR v7.70.1.11486
                     ：MDK-ARM Plus v5.20.0.0 (只需两者中一种)
8 C$ D: f& M8 i. w7 S; G优化级别 : High (IAR)
7 Z5 T* l+ S3 a3 u) ]/ b              Level 3 (-O3) (MDK-ARM)
DFU演示软件: Dfu file manager v3.0.5
: Q5 _( b* v7 T# b                     DfuSeDemo v3.0.5
. M/ t( J) R5 c1 X( `
实现过程在STM32F7系列上展开，但USB DFU实现的IAP功能并不只局限于STM32F7系列，可以通过用户手册判断所采用微控制器型号是否支持USB以及IAP功能。STM32Cube开发库为各系列STM32提供了齐全的USB DFU例程可供参考。
! r$ C% \' g/ Z3 c4 \- L2 Z- W3 @
1 U+ @, a. J- o* l二 IAP介绍
IAP(In application program)主要为使用者提供了一种更加灵活的固件升级方式，可以根据应用需要定义何时、何种情况发生时进行固件升级。在介绍步骤前，需要对IAP原理有一定认识。结合下图（仅供参考，IAP实际应用方式更加灵活），IAP的应用中，用户程序与IAP驱动程序位于不同的存储区域。在应用过程中，利用IAP驱动程序将用户固件加载到固定位置，完成升级。更多关于IAP应用介绍请参考AN3965。
# {1 d  x; A. v2 v$ W0 [) _其中，IAP驱动程序首先烧录固化，并不会随着用户程序的升级而改变。用户固件升级完毕后，在IAP驱动程序引导下，跳转到用户固件对应Flash位置，执行用户程序。
; m5 K% j# ^- S1 [
8 s# Y0 _5 \$ }% c0 O; F% i" M1 O" t# y

" A# v; I; V) T3 ~3 x  |& C9 p三 实现步骤
4 ]" z$ l! N8 N, K% c4 \
' H3 E" e& F' [8 f. G3.1 DFU工具安装
安装DFU demo工具DfuSe v3.0.5，主要提供了驱动、Dfu file manager 和 DfuSeDemo。关于DfuSe的详细内容（安装步骤、使用介绍）请参考UM0412。

3.2 IAP驱动固件生成与装载
利用STM32CubeF7 v1.3.0开发库提供的USB DFU例程生成IAP驱动固件（文件夹路径： …\ STM32Cube_FW_F7_V1.3.0\Projects\STM32746G-Discovery\Applications\USB_Device\ DFU_Standalone）。
利用烧录工具烧录到开发板中。本例程实现重启后，如果板上User按键按下或者没有有效的用户应用程序，则进入USB DFU模式，等待升级；否则，进入用户应用。
下面是摘取的部分例程。
/ o/ q! H  C0 Q2 d) T
( H# @  F1 ?# S! Q6 ~

用户固件对应的首地址被定义在0x08008000。用户也可以自定义地址，需要注意如下几点：
8 i( ]# C& K/ p4 Y( ]# D& R  _1. 禁止定义在0x08008000地址前（STM32F7系列，0x0~0x0800FFFF属于Sector0，已经开辟为IAP驱动程序区域）
2 ~, n2 o/ v/ |8 t- q; [9 b, W3 Y2. 自定义地址所属Sector在升级时会全部擦除，即使定义地址并不位于对应Sector的首地址
3. 自定义地址需要保持512-byte对齐
4. 自定义地址需要与用户固件对应的装载地址以及用户中断向量表地址保持一致
/ n) Z( l: m7 Q; I8 i0 |. L在实现跳转到用户程序的代码中，将用户中断向量表中第一个4字节指向的栈首地址分配给MSP。第二个4字节为复位中断向量，指向执行首地址。
在开发IAP驱动程序时，需要避免PC指针跳到用户程序区域。同时，充分考虑Stack & Heap大小，避免出现USB DFU正常识别，但不能正常工作情况，如下图所示。
" i+ q( ?( M8 \& @5 L


3.3 用户固件生成
本文采用STM32CubeF7 v1.3.0开发库中TIM_TimeBase例程作为用户程序（文件夹路径：STM32Cube_FW_F7_V1.3.0\Projects\STM32746G-Discovery\Examples\TIM\TIM_TimeBase）。
IAP升级所需用户固件，主要有两处需要变动：
1. 在链接工具中，程序装载地址
6 t! ]7 P# w  e- }9 m6 y# K' W' F, g2. 中断向量表首地址
上述两种变动需要保持一致，并且与IAP中定义的用户区域首地址保持一致。
本IAP驱动程序中，用户固件装载地址相对于0x08000000偏移地址为0x8000。在MDK中，改动前后比较如下图所示。


在IAR中，更改步骤如下所示。

! W% u  d8 t. }% P& {* y$ f
) j" I0 ~# \; d# o  u, V1 ~- m
3 v1 b1 H, ~' |5 y  j" H9 Y+ w修改完毕后，生成hex文件（STM32746G_DISCOVERY.hex）。

6 W) T3 r5 `+ }4 g& X) \7 a9 U3.4 用户固件转换与升级
& X, |! P0 Z0 ]7 F' Y打开Dfu file manager工具，点击OK，进入转换工具主界面。

4 K6 A2 n( [" I: c

' ^+ C+ B) V- h7 _- {8 J按照下图步骤，首先载入生成的HEX文件（STM32746G_DISCOVERY.hex）；然后在Target ID、 Target Name、 Device properties中自定义内容，这部分内容在DfuSe Demo工具中选择.dfu文件时会予以显示，并不影响烧录文件内容。最后，点击Generate完成HEX文件DFU文件转换。
* d7 R2 E& a6 [" P' L  V! P1 j
; N7 l5 p2 p, b) H, i1 P
5 Q2 d# j$ C0 \8 ?/ `6 n
* i$ i/ w, A4 a1 q. I为STM32F746G-DISCO板供电，通过USB线将板上USB_FS接口与电脑相连。由于ST Discovery板已经加载了IAP应用程序，并且没有有效的用户应用程序，因此在IAP应用程序中，直接进入USB DFU模式，以供电脑识别USB DFU器件。正常识别情况如左下图。
" `$ x2 h  _6 @1 V. v% E1 F$ p: r右下图情况是由于没有正确装载Driver导致，可以通过右击“DFU in FS Mode”选择更新驱动程序软件\浏览计算机以查找驱动程序软件（驱动文件位于DfuSe v3.0.5安装目录\ DfuSe v3.0.5\Bin\ Driver）。

+ c3 x. {7 L/ r  i4 S& c4 n* @
  V" c5 b; I) X2 [& t
+ _+ u6 H! x* t# N* x6 M打开DfuSeDemo，结合下图步骤，点击’Choose’加载之前转换的.dfu文件；选择配置；点击’Update’完成擦除与下载；另外，可以通过点击’Verify’验证是否下载成功。更多关于DfuSe内容，请参考UM0412。

. b7 G* I# F2 H7 x6 L" |

用户固件升级完成。重启后，正常进入用户应用。如果重启过程中，板上USER键按下，进入USB DFU模式，等待升级。

( k9 ^. i' _( |$ V四 小结
( e  F8 F( K) q7 u介绍了利用USB DFU实现IAP过程，以及实现过程中注意事项。在DfuSe v3.0.5安装目录中包含了必要的文档，介绍如何使用DfuSe工具，以及如何开发基于STMicroelectronics DFU方案的上位机应用。
( A3 m2 V. l% R1 j
相关文档
AN4657      STM32 in-application programming (IAP) using the USART
7 p: j# C4 p8 o0 e( [AN3965      使用 USART 实现STM32F40x/STM32F41x 的 IAP
UM0412     Getting started with DfuSe USB device firmware upgrade STMicroelectronics extension

相关工具&链接
* ]& T2 H% R) Q8 g! [DfuSe_Demo
/ X$ g* G2 O! L' X1 m7 mhttp://www.st.com/content/st_com/en/products/development-tools/software-development-tools/stm32-software-development-tools/stm32-programmers/stsw-stm32080.html?dl=537587854391172693#
STM32CubeF7
# d: R1 ^4 y) w7 \8 ghttp://www.st.com/content/st_com/en/products/embedded-software/mcus-embedded-software/stm32-embedded-software/stm32cube-embedded-software/stm32cubef7.html
! t+ s7 U6 V6 w/ o3 b- o
# Q& M, w7 E" X' l7 {
$ r! k& @8 `) U% U& N. ]  {文档下载地址：
https://www.stmcu.org.cn/document/detail/index/id-217183
, g) ?& Z% k3 v
7 {0 g- q$ ~7 ?+ l- U. U实战经验汇总：
" Y$ M2 |$ l- r: e  o% Rhttps://www.stmcu.org.cn/module/forum/thread-576401-1-1.html

% J- m8 `% g- q( P! S4 c

DFU方式很方便，只要一个USB就可以，不用其它编程器。

谢谢楼主分享。
在下在用STM32F103ZE实现USB DFU的时候出现以下疑惑：
+ [' A; T. g/ z; _+ B1、在USB设备标识符中指出有1个接口，而所有的接口描述符都是通过一个宏实现
0 w. t5 t* _8 l9 x: Z#define USBD_DFU_IF_DESC(n)            0x09,   /* bLength: Interface Descriptor size */ \
6 C8 T( Q5 Q/ p/ H                                      USB_DESC_TYPE_INTERFACE,   /* bDescriptorType */ \
( F' U- [/ Q- T( N$ m  Y                                      0x00,   /* bInterfaceNumber: Number of Interface */ \
/ k5 p3 u) p' u" E1 l- \" V2 R                                      (n),      /* bAlternateSetting: Alternate setting */ \
: c8 x" f  [5 Q. E8 q; |( s                                      0x00,   /* bNumEndpoints*/ \
                                      0xFE,   /* bInterfaceClass: Application Specific Class Code */ \
                                      0x01,   /* bInterfaceSubClass : Device Firmware Upgrade Code */ \
                                      0x02,   /* nInterfaceProtocol: DFU mode protocol */ \
                                      USBD_IDX_INTERFACE_STR + (n) + 1 /* iInterface: Index of string descriptor */ \
但是在这个接口描述符中指出端点数为0，但是发现USB状态机里面用的都是端点4的状态，这里有点费解
+ ]5 |! J, e! a/ [% {6 u" D2、在DFU上位机中有个“Leaves DFU mode”按键，用于退出DFU模式，但是总是在49%时出错，查阅资料发现网上有许多人出现此问题。测试发现，如果在点击“Leaves DFU mode”按键后，USB设备只要响应完返回状态这个请求后，把USB设备的USB接口从PC拔出，则上位机显示成功。

请教下楼主，如果烧录的固件是USB-HID设备，那边还可以用上述方式吗？就是我又想用DFU，可是更新的那个又是HID

请教下楼主，如果想用U盘来升级固件，是否有方法。现实中有的客户连装下USB设备都没能力，最好是给个文件写到U盘里，直接上电复位检测是否有新固件来升级，这样最傻瓜。

kylongmu 发表于 2018-3-29 16:27
请教下楼主，如果想用U盘来升级固件，是否有方法。现实中有的客户连装下USB设备都没能力，最好是给个文件写 ...

你好，我的毕设课题就是跟这个相关的，可以麻烦你讲讲固件升级在客户中的应用情况吗？

让用户拿一个U盘就能升级，这是最方便的途径了