USB IAP

【红枫派开发板】第二十九讲 USB-IAP升级实验

发布于 2024-03-30 11:44:47

29.1 实验内容

通过本实验主要学习以下内容：

• USB IAP升级操作

29.2 实验原理

USB IAP升级本例程中使用的是Custom HID中的IAP设备类，其设备类协议的实现与HID的类似，主要包括GET_REPORT/GET_IDLE/GET_PROTOCOL/SET_REPORT/SET_IDLE/SET_PROTOCOL/USB_GET_DESCRIPTOR等。IAP的功能为通过USB接口通信的方式对app端代码进行更新。

29.3 硬件设计

USB虚拟键盘实验章节已介绍。

29.4 代码解析

IAP主函数如下所示，开始主要为delay延迟配置以及按键配置，之后判断KEY1按键是否被按下，如果KEY1按键没被按下，将会进入到跳转代码段，如果APP_LOADED_ADDR（0x08008000U）地址中有对应APP的堆栈指针，则认为APP段有数据可直接跳转执行。如果堆栈指针校验异常，则跳出判断执行后续代码；如果KEY1按键被按下，则跳过跳转语句段，直接运行USB IAP的升级代码。通过RCU/USB等相关配置后，在PC端将会识别一个USB IAP设备。

C
int main(void)
{
uint32_t app_address;
app_func application;
uint32_t sram_sect = REG32(APP_LOADED_ADDR);

driver_init();

/* configure KEY1 key to run firmware */
bsp_key_init(&KEY1);

/* KEY1 key must be pressed on board when power on */
if(SET !=bsp_key_state_get(&KEY1)) {
/* test if user code is programmed starting from address 0x8008000 */
if((sram_sect >= SRAM_BASE_ADDR) && (sram_sect < SRAM_END_ADDR)){
app_address = *(__IO uint32_t*) (APP_LOADED_ADDR + 4U);
application = (app_func) app_address;

/* initialize user application's stack pointer */
__set_MSP(*(__IO uint32_t*) APP_LOADED_ADDR);

/* jump to user application */
application();
}
}

/* system clocks configuration */
rcu_config();

/* GPIO configuration */
gpio_config();

/* USB device configuration */
usbd_init(&usbd_iap, &iap_desc, &iap_class);

/* NVIC configuration */
nvic_config();

/* enabled USB pull-up */
usbd_connect(&usbd_iap);

while (1){
}
}

HID报文描述符如下所示，该报文描述符描述了收发数据类型以及长度，其中，主机发送的IAP命令和数据长度为63个字节，MCU从机回复的状态数据长度为16个字节。

C
const uint8_t iap_report_desc[USB_DESC_LEN_IAP_REPORT] =
{
0x05, 0x01,     /* USAGE_PAGE (Generic Desktop) */
0x09, 0x00,     /* USAGE (Custom Device)        */
0xa1, 0x01,     /* COLLECTION (Application)     */

/* IAP command and data */
0x85, 0x01,     /* REPORT_ID (0x01)          */
0x09, 0x01,     /* USAGE (IAP command)       */
0x15, 0x00,     /* LOGICAL_MINIMUM (0)       */
0x25, 0xff,     /* LOGICAL_MAXIMUM (255)     */
0x75, 0x08,     /* REPORT_SIZE (8)           */
0x95, 0x3f,     /* REPORT_COUNT (63)         */
0x91, 0x82,     /* OUTPUT (Data,Var,Abs,Vol) */

/* device status and option byte */
0x85, 0x02,     /* REPORT_ID (0x02)               */
0x09, 0x02,     /* USAGE (Status and option byte) */
0x15, 0x00,     /* LOGICAL_MINIMUM (0)            */
0x25, 0xff,     /* LOGICAL_MAXIMUM (255)          */
0x75, 0x08,     /* REPORT_SIZE (8)                */
0x95, 0x10,     /* REPORT_COUNT (16)              */
0x81, 0x82,     /* INPUT (Data,Var,Abs,Vol)       */

0xc0 /* END_COLLECTION */
};

MCU接收到主机发送的数据后，将会进入iap_data_out回调函数，其中实现了IAP download（数据下载）、IAP Erase（擦除操作）、IAP OPTION BYTE（获取选项字节）、IAP LEAVE（退出IAP模式）、IAP GETBIN ADDRESS（获取APP起始地址）几个功能。

C
static void iap_data_out (usb_dev *udev ,uint8_t ep_num)
{
usbd_iap_handler *iap = (usbd_iap_handler *)udev->class_data[USBD_IAP_INTERFACE];

if (0x01U == iap->report_buf[0]) {
switch(iap->report_buf[1]) {
case IAP_DNLOAD:
iap_req_dnload(udev);
break;

case IAP_ERASE:
iap_req_erase(udev);
break;

case IAP_OPTION_BYTE:
iap_req_optionbyte(udev);
break;

case IAP_LEAVE:
iap_req_leave(udev);
break;

case IAP_GETBIN_ADDRESS:
iap_address_send(udev);
break;

default:
break;
}
}

usbd_ep_recev(udev, IAP_OUT_EP, iap->report_buf, IAP_OUT_PACKET);
}

29.5 实验结果

将本实验历程烧录到红枫派开发板中，打开GD32 ALL IN One上位机，如下图所示，接口选择USB，Bootloader协议选择IAP，之后点击connect进行连接。