RT-Thread: 基于STM32CubeMX配置驱STM32驱动的USB虚拟串口调试

关键词：USB 虚拟串口 USB虚拟串口，RT-Thread Studio，STM32

说明：

1：文档记录 STM32F103系列基于 RT-Thread 系统的 USB虚拟串口的开启及数据收发应用流程介绍。

2：本文以STM32F103C8T6型号做测试，STM32CubeMX生成USB驱动。

1：创建 RT-Thread STM32F103C8T6 的工程

1.1 RT-Thread Studio 中创建工程

        由于 STM32F103C8T6 的资源有限，先按以下流程关闭一些系统的框架，以便节省 ROM ,其他 ROM大的 IC 可以不用考虑这一步操作。

关闭掉 finsh

去掉勾选 【使能内核调试功能】，这样系统编译后能减少20K左右

2：开启USB相关的框架设置

2.1 开启系统USB驱动程序

设置完成后点保存按钮保存。

2.2 board.h 中搜索 USB 按使用流程开启相关的宏定义

注意：这里用的是 USB DEVICE CONFIG

2.3 开启 #define BSP_USING_USBDEVICE 宏

/*-------------------------- USB DEVICE CONFIG BEGIN --------------------------*/

/** if you want to use usb device you can use the following instructions.
 *
 * STEP 1, open usb device driver framework support in the RT-Thread Settings file
 *
 * STEP 2 define macro related to the usb device
 *                 such as    BSP_USING_USBDEVICE
 *
 * STEP 3, copy your usb device init function from stm32xxxx_hal_msp.c generated by stm32cubemx to the end of board.c file
 *                 such as     void HAL_PCD_MspInit(PCD_HandleTypeDef* hpcd)
 *
 * STEP 4, config your usb peripheral clock in SystemClock_Config() generated by STM32CubeMX and replace this function in board.c
 *
 * STEP 5, modify your stm32xxxx_hal_config.h file to support usb device peripherals. define macro related to the peripherals
 *                 such as     #define HAL_PCD_MODULE_ENABLED
 *
 */

#define BSP_USING_USBDEVICE

2.4 开启 #define HAL_PCD_MODULE_ENABLED 宏

2.5 用STM32CubeMX生成 时钟配置代码 和 USB初始化代码

创建 MCU 对应的 STM32CubeMX 工程

设置时钟源为外部晶振

设置调试模式为 Serial Wire 否则我用 ST-LINK 调试时会出现只能下载一次程序的情况。

配置时钟，没有标注箭头的其他选项根据实际需求配置

配置USB相关配置项，其他的选择了默认选项，

项目配置，配置输出工程文件时的设置

输出代码,按钮在软件窗口右上角位置

导出的工程文件

3：移植 STM32CubeMX 生成 时钟配置和USB初始化代码 到 RT-Thread 工程

需要用到的代码 在 Core 文件夹中

3.1 时钟配置代码移植，时钟代码在  main.c 文件的  void SystemClock_Config(void) 函数中

把 void SystemClock_Config(void) 函数中的代码复制到 drv_ckl.c 文件中，替换掉 void system_clock_config(int target_freq_Mhz) 函数中的代码。

3.2 USB配置代码移植

usb.c 文件中包含了 USB 的配置和初始化代码，复制这些代码到 board.c 文件的末尾。

4：编译下载程序，并在电脑设备管理处查看 USB虚拟串口的识别情况

编译后大小约 54K ，编译没有报错后继续第 5 步。

        编译并烧录程序，把MCU的USB接口连接电脑，系统会自动检测并添加驱动，这个过程大概需要10s左右，添加成功后设备管理里面可以看到新增的 COM 口。

5：添加 USB 的收发数据的应用代码

文末附带测试工程，usb_com_drv.c 包含USB的数据收发功能函数

/*
 * Copyright (c) 2006-2020, RT-Thread Development Team
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Change Logs:
 * Date           Author       Notes
 * 2020-05-26     yl       the first version
 */
/*说明：本文档提供一个 基于 RT-Thread 的USB虚拟串口接收和数据解析功能函数，解析按制定的通信协议进行解析，解析收到的数据合法后再调用具体的功能解析函数去解析具体功能。
 *1.添加USB虚拟串口：board.h 中搜索 USB 关键词，查找到 #define BSP_USING_USBDEVICE 去除注释，开启流程按 USB DEVICE CONFIG BEGIN 介绍的流程操作。
 *2.添加功能解析函数：在宏定义添加功能解析函数  #define Uart_Function_Resolver      usb_data_sample();    这里填入需要调用的功能解析函数。
 *3.协议解析函数：这个函数按协议格式解析收到的数据是否符合协议规范 ，符合的再调用功能解析函数解析具体解析。
 * */

#include "user_cfg.h"

#define Sync                        0xAE                           /* 通讯协议头 */

#define SAMPLE_USB_NAME             "vcom"                         /* 需要操作的USB虚拟串口设备 */
#define rx_sem_usb                  usb_rx_sem                     /* 定义USB虚拟串口专用的信号量*/
#define Uart_Function_Resolver      usb_data_printf();             /* 这里填入需要调用的功能解析函数*/

#define UART_TIMEOUT                50                             /* USB虚拟串口接收数据的超时时间 */
#define ONE_DATA_MAXLEN_USB         255                            /* 不定长数据的最大长度 ,接收缓存大小*/
#define DATA_CMD_END                '\r'                           /* 结束位设置为 \r，即回车符 */

rt_device_t serial_usb;                                            /* USB虚拟串口设备句柄 */
static struct rt_semaphore rx_sem_usb;                             /* 用于接收消息的信号量 */
static uint8_t usb_rx_buffer[ONE_DATA_MAXLEN_USB];                 /* 定义用于接收USB虚拟串口数据的缓存数组 */


/*测试代码,打印USB虚拟串口收到的数据到 调试串口 和 USB虚拟串口*/
static void usb_data_printf(void)
{
    rt_device_write(serial_usb, 0, usb_rx_buffer, ONE_DATA_MAXLEN_USB);

    rt_kprintf("read_usb_data =  \r\n");
    for (uint8_t var = 0; var < ONE_DATA_MAXLEN_USB; ++var)
    {
        rt_kprintf("%02x " ,usb_rx_buffer[var]);

        if (var%30 == 0)
        {
            rt_kprintf("\r\n");
        }
    }
}


/* USB接收数据回调函数，USB虚拟串口接收到数据后产生中断，调用此回调函数，然后发送接收信号量 */
static rt_err_t uart_rx_ind(rt_device_t dev, rt_size_t size)
{
    /* ：USB虚拟串口接收到数据后产生中断，调用此回调函数，然后发送接收信号量 */
    if (size > 0)
    {
        rt_sem_release(&rx_sem_usb);/*释放信号量可以唤醒挂起在该信号量上的线程*/
    }
    return RT_EOK;
}

/* USB虚拟串口接收数据函数 */
static uint16_t uart_sample_get_char(void)
{
    rt_err_t timeout;
    char ch;

    while (rt_device_read(serial_usb, 0, &ch, 1) == 0)
    {
        rt_sem_control(&rx_sem_usb, RT_IPC_CMD_RESET, RT_NULL);
        timeout = rt_sem_take(&rx_sem_usb, UART_TIMEOUT);/* 获取信号量函数,阻塞等待接收信号量,等待时间，***个时钟节拍，1个节拍是1ms*/
        if (timeout == (-RT_ETIMEOUT)) /*判断是否是等待信号量超时退出*/
        {
            return 0xABCD;  /*超时退出返回一个16位数据，正常数据只会返回8位数据*/
        }
    }
    return ch;
}



/**数据异常结果处理回复

 * @param data ;异常代码
 * @param
 * @return
 */
void USB_Data_Error(uint8_t Cmd,uint8_t Param )
{
    uint8_t response[6];
    uint16_t crc16;

    response[0] = Sync;
    response[1] = Cmd;
    response[2] = Param;
    response[3] = 0;
    crc16 =  yl_crc16(response, 4);
    response[4] = crc16;
    response[5] = crc16>>8;

    rt_device_write(serial_usb, 0, response, 6);
}




/**USB虚拟串口数据 按协议解析函数（按通信协议解析收到的USB虚拟串口数据） (YL已验证测试)

 * @param *read_data ;接收数据缓存指针
 * @param i 数据长度
 * @return
 */
static uint8_t USB_Data_Resolver(char *read_data,uint32_t i)
{

    uint16_t len = 0;               /* 数据长度*/
    uint16_t start_adr = 0;         /* 同步头开始地址*/
    uint16_t CRC16 = 0;             /* 计算收到数据的CRC*/
    uint16_t CRC16_READ = 0;        /* 数据中的CRC*/

    len = i;

    while(1)
    {
        /*查找同步头*/
        for (uint16_t var = 0; var < len; ++var)
        {
            if (*(read_data+var) == Sync)
            {
                start_adr = var;
                var = len +1;
            }
            if (var == (len-1) )
            {
                USB_Data_Error(7,0xFF);
                return 0;
            }
        }

        /*判断Data长度是否和Len相符*/
        /*命令中 len 位置描述的数据长度  ,   实际数据长度*/
        if (*(read_data+start_adr+3)>(len-start_adr-5))  /*判断收到的数据总长度 len 减掉 命令格式中的 crc+命令部分，剩余的数据应该 大于等于 命令中包含的数据长度*/
        {
            USB_Data_Error(6,0xFF);
            return 0;
        }

        /*判断CRC是否有效*/
        /*                            命令开始地址       ，命令中 len 里面描述的数据长度 + 命令格式字节*/
        CRC16 = yl_crc16((uint8_t *)(read_data+start_adr), *(read_data+start_adr+3)+4);
        CRC16_READ = *(read_data+start_adr+3+*(read_data+start_adr+3)+2);                   /*按格式取出命令数据中的CRC的高位*/
        CRC16_READ = (CRC16_READ<<8)|(*(read_data+start_adr+3+*(read_data+start_adr+3)+1)); /*按格式取出命令数据中的CRC的低位*/
        if (CRC16 != CRC16_READ)
        {
            USB_Data_Error(4,0xFF);
            return 0;
        }

        Uart_Function_Resolver; /*在此调用功能解析函数*/

        return 1;

    }

}

/**USB虚拟串口数据接收并解析线程 (YL已验证测试)

 * @param *read_data ;接收数据缓存指针
 * @param
 * @return
 */
static void usb_data_parsing(char *read_data)
{
    uint16_t ch;
    static rt_uint16_t i = 0;

    while (1)
    {
        ch = uart_sample_get_char();/*调用 USB串口读取函数*/

        if(ch == 0xABCD)       /* 判断USB虚拟串口是否接收超时 */
        {
            if(i)
            {
                /*此处添加需要调用的数据解析函数*/

                USB_Data_Resolver(read_data,i);


            }
            i = 0;
           continue;           /* 结束本次 while 循环*/

        }

        i = (i >= ONE_DATA_MAXLEN_USB-1) ? ONE_DATA_MAXLEN_USB-1 : i; /* 溢出保护，如果一次性收到的数据大于缓存容量，则丢弃溢出的数据，始终把新收到的数据存入缓存的最后一个位置*/
        i++;
        *(read_data+i) = (uint8_t)ch;

    }

}



/* step：USB虚拟串口初始化函数，创建USB虚拟串口线程并打开线程 */
int usb_data_sample(void)
{

    char str[] = "usb_test";

    /*step1：查找 usb 设备 */
    serial_usb = rt_device_find(SAMPLE_USB_NAME);
    serial_usb = serial_usb;

    if (!serial_usb)
    {
        rt_kprintf("find %s failed!\n", SAMPLE_USB_NAME);
        //return RT_ERROR;
    }

    /*step4： 初始化信号量 */
    rt_sem_init(&rx_sem_usb, "rx_sem_usb", 0, RT_IPC_FLAG_FIFO);

    /*step5：以中断接收及轮询发送模式打开USB虚拟串口设备 */
    rt_device_open(serial_usb, RT_DEVICE_FLAG_INT_RX);
    //rt_device_open(serial_usb, RT_DEVICE_FLAG_RDWR);

    /*step6： 设置接收回调函数:可以通过如下函数来设置数据接收指示，当USB虚拟串口收到数据时，通知上层应用线程有数据到达  */
    rt_device_set_rx_indicate(serial_usb, uart_rx_ind);

    /*step7：发送字符串 */
    rt_device_write(serial_usb, 0, str, (sizeof(str)-1));

    /*step8 创建线程 ，名称是 serial_usb，入口是 usb_data_parsing*/
    rt_thread_t thread;     /* 创建线程控制块指针来接收线程创建函数的返回值，目的是通过返回值判断线程是否创建ok */

    /* 创建线程 */
    thread = rt_thread_create("usb_thread",                                   // 线程名称，系统打印线程时会显示这个线程的名字
                            (void (*)(void *parameter))usb_data_parsing,      // 线程入口函数,入口函数函数名
                            usb_rx_buffer,                                    // 入口参数
                            1000,                                             // 设置内存堆栈大小
                            8,                                                // 设置优先级
                            200);                                             // 时间片参数，时间片是在有多个相同优先级线程时，这个线程每次被执行多少个时间片


    /*step9： 创建成功则启动线程 */
    if (thread != RT_NULL)
    {
        rt_thread_startup(thread);
    }
    else
    {
        return RT_ERROR;
    }

    return RT_EOK;
}

INIT_APP_EXPORT(usb_data_sample);


/*  函数使用范例  */
// yl_rt_device_write(serial_usb, 0, &ch, 1); /* 发送收到的一字节数据到USB虚拟串口*/

CRC16 代码

/*
 * Copyright (c) 2006-2020, RT-Thread Development Team
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Change Logs:
 * Date           Author       Notes
 */
#include "user_cfg.h"
//#define CRC16_XModem    /*定义使用哪一种CRC16算法*/
#define CRC16_Modbus  /*定义使用哪一种CRC16算法*/


// Table of CRC constants - implements x^16+x^12+x^5+1
static const uint16_t crc16_tab[] = {
    0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7,
    0x8108, 0x9129, 0xa14a, 0xb16b, 0xc18c, 0xd1ad, 0xe1ce, 0xf1ef,
    0x1231, 0x0210, 0x3273, 0x2252, 0x52b5, 0x4294, 0x72f7, 0x62d6,
    0x9339, 0x8318, 0xb37b, 0xa35a, 0xd3bd, 0xc39c, 0xf3ff, 0xe3de,
    0x2462, 0x3443, 0x0420, 0x1401, 0x64e6, 0x74c7, 0x44a4, 0x5485,
    0xa56a, 0xb54b, 0x8528, 0x9509, 0xe5ee, 0xf5cf, 0xc5ac, 0xd58d,
    0x3653, 0x2672, 0x1611, 0x0630, 0x76d7, 0x66f6, 0x5695, 0x46b4,
    0xb75b, 0xa77a, 0x9719, 0x8738, 0xf7df, 0xe7fe, 0xd79d, 0xc7bc,
    0x48c4, 0x58e5, 0x6886, 0x78a7, 0x0840, 0x1861, 0x2802, 0x3823,
    0xc9cc, 0xd9ed, 0xe98e, 0xf9af, 0x8948, 0x9969, 0xa90a, 0xb92b,
    0x5af5, 0x4ad4, 0x7ab7, 0x6a96, 0x1a71, 0x0a50, 0x3a33, 0x2a12,
    0xdbfd, 0xcbdc, 0xfbbf, 0xeb9e, 0x9b79, 0x8b58, 0xbb3b, 0xab1a,
    0x6ca6, 0x7c87, 0x4ce4, 0x5cc5, 0x2c22, 0x3c03, 0x0c60, 0x1c41,
    0xedae, 0xfd8f, 0xcdec, 0xddcd, 0xad2a, 0xbd0b, 0x8d68, 0x9d49,
    0x7e97, 0x6eb6, 0x5ed5, 0x4ef4, 0x3e13, 0x2e32, 0x1e51, 0x0e70,
    0xff9f, 0xefbe, 0xdfdd, 0xcffc, 0xbf1b, 0xaf3a, 0x9f59, 0x8f78,
    0x9188, 0x81a9, 0xb1ca, 0xa1eb, 0xd10c, 0xc12d, 0xf14e, 0xe16f,
    0x1080, 0x00a1, 0x30c2, 0x20e3, 0x5004, 0x4025, 0x7046, 0x6067,
    0x83b9, 0x9398, 0xa3fb, 0xb3da, 0xc33d, 0xd31c, 0xe37f, 0xf35e,
    0x02b1, 0x1290, 0x22f3, 0x32d2, 0x4235, 0x5214, 0x6277, 0x7256,
    0xb5ea, 0xa5cb, 0x95a8, 0x8589, 0xf56e, 0xe54f, 0xd52c, 0xc50d,
    0x34e2, 0x24c3, 0x14a0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
    0xa7db, 0xb7fa, 0x8799, 0x97b8, 0xe75f, 0xf77e, 0xc71d, 0xd73c,
    0x26d3, 0x36f2, 0x0691, 0x16b0, 0x6657, 0x7676, 0x4615, 0x5634,
    0xd94c, 0xc96d, 0xf90e, 0xe92f, 0x99c8, 0x89e9, 0xb98a, 0xa9ab,
    0x5844, 0x4865, 0x7806, 0x6827, 0x18c0, 0x08e1, 0x3882, 0x28a3,
    0xcb7d, 0xdb5c, 0xeb3f, 0xfb1e, 0x8bf9, 0x9bd8, 0xabbb, 0xbb9a,
    0x4a75, 0x5a54, 0x6a37, 0x7a16, 0x0af1, 0x1ad0, 0x2ab3, 0x3a92,
    0xfd2e, 0xed0f, 0xdd6c, 0xcd4d, 0xbdaa, 0xad8b, 0x9de8, 0x8dc9,
    0x7c26, 0x6c07, 0x5c64, 0x4c45, 0x3ca2, 0x2c83, 0x1ce0, 0x0cc1,
    0xef1f, 0xff3e, 0xcf5d, 0xdf7c, 0xaf9b, 0xbfba, 0x8fd9, 0x9ff8,
    0x6e17, 0x7e36, 0x4e55, 0x5e74, 0x2e93, 0x3eb2, 0x0ed1, 0x1ef0,
};

/* CRC16代码备份
uint16_t yl_crc16_XModem(unsigned char *buf, int len)
{
    int i;
    uint16_t cksum;

    cksum = 0;
    for (i = 0;  i < len;  i++) {
        cksum = crc16_tab[((cksum>>8) ^ *buf++) & 0xFF] ^ (cksum << 8);
    }
    return cksum;
}



uint16_t yl_crc16_Modbus(uint8_t *buffer, uint16_t len)
{
    uint16_t wcrc = 0XFFFF;         //16位crc寄存器预置
    uint8_t temp;
    uint16_t i = 0, j = 0;          //计数
    for (i = 0; i < len; i++)       //循环计算每个数据
    {
        temp = *buffer & 0X00FF;    //将八位数据与crc寄存器亦或
        buffer++;                   //指针地址增加，指向下个数据
        wcrc ^= temp;               //将数据存入crc寄存器
        for (j = 0; j < 8; j++)     //循环计算数据的
        {
            if (wcrc & 0X0001)      //判断右移出的是不是1，如果是1则与多项式进行异或。
            {
                wcrc >>= 1;         //先将数据右移一位
                wcrc ^= 0XA001;     //与上面的多项式进行异或
            }
            else                    //如果不是1，则直接移出
            {
                wcrc >>= 1;         //直接移出
            }
        }
    }
    uint8_t CRC_L;                  //定义数组
    uint8_t CRC_H;
    CRC_L = wcrc&0xff;              //crc的低八位
    CRC_H = wcrc >> 8;              //crc的高八位
//    return ((CRC_L << 8) | CRC_H);
    return wcrc;
}*/

uint16_t yl_crc16(unsigned char *buffer, uint16_t len)
{

#if defined  CRC16_XModem

    int i;
    uint16_t cksum;

    cksum = 0;
    for (i = 0;  i < len;  i++) {
        cksum = crc16_tab[((cksum>>8) ^ *buffer++) & 0xFF] ^ (cksum << 8);
    }
    return cksum;
#endif

#if defined  CRC16_Modbus
    uint16_t wcrc = 0XFFFF;         //16位crc寄存器预置
    uint8_t temp;
    uint16_t i = 0, j = 0;          //计数
    for (i = 0; i < len; i++)       //循环计算每个数据
    {
        temp = *buffer & 0X00FF;    //将八位数据与crc寄存器亦或
        buffer++;                   //指针地址增加，指向下个数据
        wcrc ^= temp;               //将数据存入crc寄存器
        for (j = 0; j < 8; j++)     //循环计算数据的
        {
            if (wcrc & 0X0001)      //判断右移出的是不是1，如果是1则与多项式进行异或。
            {
                wcrc >>= 1;         //先将数据右移一位
                wcrc ^= 0XA001;     //与上面的多项式进行异或
            }
            else                    //如果不是1，则直接移出
            {
                wcrc >>= 1;         //直接移出
            }
        }
    }

    return wcrc;

#endif


}

/* 带初始值的CRC16函数  */
uint16_t yl_crc16_2(unsigned char *buffer, uint16_t len ,uint16_t wcrc)
{

#if defined  CRC16_XModem

    int i;
    uint16_t cksum;

    cksum = 0;
    for (i = 0;  i < len;  i++) {
        cksum = crc16_tab[((cksum>>8) ^ *buffer++) & 0xFF] ^ (cksum << 8);
    }
    return cksum;
#endif

#if defined  CRC16_Modbus
//    uint16_t wcrc = 0XFFFF;         //16位crc寄存器预置
    uint8_t temp;
    uint16_t i = 0, j = 0;          //计数
    for (i = 0; i < len; i++)       //循环计算每个数据
    {
        temp = *buffer & 0X00FF;    //将八位数据与crc寄存器亦或
        buffer++;                   //指针地址增加，指向下个数据
        wcrc ^= temp;               //将数据存入crc寄存器
        for (j = 0; j < 8; j++)     //循环计算数据的
        {
            if (wcrc & 0X0001)      //判断右移出的是不是1，如果是1则与多项式进行异或。
            {
                wcrc >>= 1;         //先将数据右移一位
                wcrc ^= 0XA001;     //与上面的多项式进行异或
            }
            else                    //如果不是1，则直接移出
            {
                wcrc >>= 1;         //直接移出
            }
        }
    }

    return wcrc;

#endif


}

6：测试工程下载链接

https://download.csdn.net/download/yutian0606/88717877