21ic电子技术开发论坛 › 单片机与嵌入式系统 › GigaDevice GD32 MCU › 【GD32F303红枫派使用手册】第二十八讲 USB-虚拟串口实 ...
返回列表 发新帖我要提问

[研电赛技术支持] 【GD32F303红枫派使用手册】第二十八讲 USB-虚拟串口实验

[复制链接]
 楼主| 聚沃科技 发表于 2024-7-3 10:44 | 显示全部楼层 |阅读模式
虚拟串口, 串口实验, 串口, USB, GD32F303
红枫派首图.png
28.1 实验内容
通过本实验主要学习以下内容：
• CDC虚拟串口协议原理及使用
• CDC虚拟串口通信操作
28.2 实验原理
USB的CDC类是USB通信设备类 (Communication Device Class)的简称。CDC类是USB组织定义的一类专门给各种通信设备使用的USB子类。该设备类采用批量传输。
本例程中实现了CDC设备类的相关请求，包括SET_LINE_CODING、GET_LINE_CODING、SET_CONTROL_LINE_STATE等。后续将会在代码解析章节进行介绍。
有关CDC协议可以通过以下USB官网下载或者通过红枫派开发板配套资料获取。
大家可以在学习的过程中结合历程代码和协议进行理解。
28.3 硬件设计
USB虚拟键盘实验章节已介绍。
28.4 代码解析
本例程主要实现USB虚拟串口的效果，在PC端可以通过串口调试助手或者设备管理器查到虚拟串口设备，并可实现通过该虚拟串口进行通信的现象。
本例程主函数如下，该函数架构与虚拟键盘例程相似，当USBD设备初始化且枚举完成后，USB设备首先通过cdc_acm_check_ready()函数check是否准备数据发送，如果不需要发送就调用cdc_acm_data_receive()函数接收上位机发送的数据，如果需要发送就调用cdc_acm_data_send()将接收到的数据发送给主机，主机再回显到串口调试助手的接收显示界面中。
复制
  1. C
    

  2. int main(void)
    

  3. {
    

  4.     /* system clocks configuration */
    

  5.     rcu_config();
    


  6. 

  7.     /* GPIO configuration */
    

  8.     gpio_config();
    


  9. 

  10.     /* USB device configuration */
    

  11.     usbd_init(&usbd_cdc, &cdc_desc, &cdc_class);
    


  12. 

  13.     /* NVIC configuration */
    

  14.     nvic_config();
    


  15. 

  16.     /* enabled USB pull-up */
    

  17.     usbd_connect(&usbd_cdc);
    


  18. 

  19.     while (USBD_CONFIGURED != usbd_cdc.cur_status) {
    

  20.         /* wait for standard USB enumeration is finished */
    

  21.     }
    


  22. 

  23.     while (1) {
    

  24.         if (0U == cdc_acm_check_ready(&usbd_cdc)) {
    

  25.             cdc_acm_data_receive(&usbd_cdc);
    

  26.         } else {
    

  27.             cdc_acm_data_send(&usbd_cdc);
    

  28.         }
    

  29.     }
    

  30. }
下面为大家介绍下虚拟串口设备所使用的设备及配置描述符。
设备描述符如下所示，其中bDevcieClass为0x02，表明当前设备为CDC设备类。
复制
  1. C
    

  2. usb_desc_dev cdc_dev_desc =
    

  3. {
    

  4.     .header = 
    

  5.      {
    

  6.          .bLength          = USB_DEV_DESC_LEN, 
    

  7.          .bDescriptorType  = USB_DESCTYPE_DEV,
    

  8.      },
    

  9.     .bcdUSB                = 0x0200U,
    

  10.     .bDeviceClass          = USB_CLASS_CDC,
    

  11.     .bDeviceSubClass       = 0x00U,
    

  12.     .bDeviceProtocol       = 0x00U,
    

  13.     .bMaxPacketSize0       = USBD_EP0_MAX_SIZE,
    

  14.     .idVendor              = USBD_VID,
    

  15.     .idProduct             = USBD_PID,
    

  16.     .bcdDevice             = 0x0100U,
    

  17.     .iManufacturer         = STR_IDX_MFC,
    

  18.     .iProduct              = STR_IDX_PRODUCT,
    

  19.     .iSerialNumber         = STR_IDX_SERIAL,
    

  20.     .bNumberConfigurations = USBD_CFG_MAX_NUM,
    

  21. };
配置描述符如下所示，由配置描述符可知，该USB虚拟串口设备包含两个接口：CMD命令接口和data数据接口。CMD命令接口包含一个IN端点，用于传输命令，该端点采用中断传输方式，轮询间隔为10ms，最大包长为8字节。data数据接口包含一个OUT端点和一个IN端点，这两个端点均采用批量传输方式，最大包长为64字节。另外，该配置描述符中包含了一些类特殊接口描述符，具体请读者参阅CDC类标准协议。
复制
  1. C
    

  2. usb_cdc_desc_config_set cdc_config_desc = 
    

  3. {
    

  4.     .config = 
    

  5.     {
    

  6.         .header = 
    

  7.          {
    

  8.              .bLength         = sizeof(usb_desc_config), 
    

  9.              .bDescriptorType = USB_DESCTYPE_CONFIG,
    

  10.          },
    

  11.         .wTotalLength         = USB_CDC_ACM_CONFIG_DESC_SIZE,
    

  12.         .bNumInterfaces       = 0x02U,
    

  13.         .bConfigurationValue  = 0x01U,
    

  14.         .iConfiguration       = 0x00U,
    

  15.         .bmAttributes         = 0x80U,
    

  16.         .bMaxPower            = 0x32U
    

  17.     },
    


  18. 

  19.     .cmd_itf = 
    

  20.     {
    

  21.         .header = 
    

  22.          {
    

  23.              .bLength         = sizeof(usb_desc_itf), 
    

  24.              .bDescriptorType = USB_DESCTYPE_ITF 
    

  25.          },
    

  26.         .bInterfaceNumber     = 0x00U,
    

  27.         .bAlternateSetting    = 0x00U,
    

  28.         .bNumEndpoints        = 0x01U,
    

  29.         .bInterfaceClass      = USB_CLASS_CDC,
    

  30.         .bInterfaceSubClass   = USB_CDC_SUBCLASS_ACM,
    

  31.         .bInterfaceProtocol   = USB_CDC_PROTOCOL_AT,
    

  32.         .iInterface           = 0x00U
    

  33.     },
    


  34. 

  35.     .cdc_header = 
    

  36.     {
    

  37.         .header =
    

  38.          {
    

  39.             .bLength         = sizeof(usb_desc_header_func), 
    

  40.             .bDescriptorType = USB_DESCTYPE_CS_INTERFACE
    

  41.          },
    

  42.         .bDescriptorSubtype  = 0x00U,
    

  43.         .bcdCDC              = 0x0110U
    

  44.     },
    


  45. 

  46.     .cdc_call_managment = 
    

  47.     {
    

  48.         .header = 
    

  49.          {
    

  50.             .bLength         = sizeof(usb_desc_call_managment_func), 
    

  51.             .bDescriptorType = USB_DESCTYPE_CS_INTERFACE
    

  52.          },
    

  53.         .bDescriptorSubtype  = 0x01U,
    

  54.         .bmCapabilities      = 0x00U,
    

  55.         .bDataInterface      = 0x01U
    

  56.     },
    


  57. 

  58.     .cdc_acm = 
    

  59.     {
    

  60.         .header = 
    

  61.          {
    

  62.             .bLength         = sizeof(usb_desc_acm_func), 
    

  63.             .bDescriptorType = USB_DESCTYPE_CS_INTERFACE
    

  64.          },
    

  65.         .bDescriptorSubtype  = 0x02U,
    

  66.         .bmCapabilities      = 0x02U,
    

  67.     },
    


  68. 

  69.     .cdc_union = 
    

  70.     {
    

  71.         .header = 
    

  72.          {
    

  73.             .bLength         = sizeof(usb_desc_union_func), 
    

  74.             .bDescriptorType = USB_DESCTYPE_CS_INTERFACE
    

  75.          },
    

  76.         .bDescriptorSubtype  = 0x06U,
    

  77.         .bMasterInterface    = 0x00U,
    

  78.         .bSlaveInterface0    = 0x01U,
    

  79.     },
    


  80. 

  81.     .cdc_cmd_endpoint = 
    

  82.     {
    

  83.         .header = 
    

  84.          {
    

  85.             .bLength         = sizeof(usb_desc_ep), 
    

  86.             .bDescriptorType = USB_DESCTYPE_EP,
    

  87.          },
    

  88.         .bEndpointAddress    = CDC_CMD_EP,
    

  89.         .bmAttributes        = USB_EP_ATTR_INT,
    

  90.         .wMaxPacketSize      = CDC_ACM_CMD_PACKET_SIZE,
    

  91.         .bInterval           = 0x0AU
    

  92.     },
    


  93. 

  94.     .cdc_data_interface = 
    

  95.     {
    

  96.         .header = 
    

  97.          {
    

  98.             .bLength         = sizeof(usb_desc_itf), 
    

  99.             .bDescriptorType = USB_DESCTYPE_ITF,
    

  100.          },
    

  101.         .bInterfaceNumber    = 0x01U,
    

  102.         .bAlternateSetting   = 0x00U,
    

  103.         .bNumEndpoints       = 0x02U,
    

  104.         .bInterfaceClass     = USB_CLASS_DATA,
    

  105.         .bInterfaceSubClass  = 0x00U,
    

  106.         .bInterfaceProtocol  = USB_CDC_PROTOCOL_NONE,
    

  107.         .iInterface          = 0x00U
    

  108.     },
    


  109. 

  110.     .cdc_out_endpoint = 
    

  111.     {
    

  112.         .header = 
    

  113.          {
    

  114.              .bLength         = sizeof(usb_desc_ep), 
    

  115.              .bDescriptorType = USB_DESCTYPE_EP, 
    

  116.          },
    

  117.         .bEndpointAddress     = CDC_OUT_EP,
    

  118.         .bmAttributes         = USB_EP_ATTR_BULK,
    

  119.         .wMaxPacketSize       = CDC_ACM_DATA_PACKET_SIZE,
    

  120.         .bInterval            = 0x00U
    

  121.     },
    


  122. 

  123.     .cdc_in_endpoint = 
    

  124.     {
    

  125.         .header = 
    

  126.          {
    

  127.              .bLength         = sizeof(usb_desc_ep), 
    

  128.              .bDescriptorType = USB_DESCTYPE_EP 
    

  129.          },
    

  130.         .bEndpointAddress     = CDC_IN_EP,
    

  131.         .bmAttributes         = USB_EP_ATTR_BULK,
    

  132.         .wMaxPacketSize       = CDC_ACM_DATA_PACKET_SIZE,
    

  133.         .bInterval            = 0x00U
    

  134.     }
    

  135. };
为了实现CDC设备类，设备需要支持一些设备类专用请求，这些类专用请求的处理在cdc_acm_req_handler()函数中，该函数的定义如下所示，其中SET_LINE_CODING命令用于响应主机向设备发送设备配置，包括波特率、停止位、字符位数等，收到的数据保存在noti_bu内。GET_LINE_CODING命令用于主机请求设备当前的波特率、停止位、奇偶校验位和字符位数，但在本例程中，主机并未请求该命令，所以设备所设置的串口数据并没有作用，主机可以选择任意波特率与设备进行通信。其他的命令在本例程中并未进行处理，读者可以参考标准CDC类协议。
复制
  1. C
    

  2. static uint8_t cdc_acm_req_handler (usb_dev *udev, usb_req *req)
    

  3. {
    

  4.     uint8_t status = REQ_NOTSUPP, noti_buf[10] = {0U};
    

  5.     usb_cdc_handler *cdc = (usb_cdc_handler *)udev->class_data[CDC_COM_INTERFACE];
    


  6. 

  7.     acm_notification *notif = (void *)noti_buf;
    


  8. 

  9.     switch (req->bRequest) {
    

  10.     case SEND_ENCAPSULATED_COMMAND:
    

  11.         break;
    


  12. 

  13.     case GET_ENCAPSULATED_RESPONSE:
    

  14.         break;
    


  15. 

  16.     case SET_COMM_FEATURE:
    

  17.         break;
    


  18. 

  19.     case GET_COMM_FEATURE:
    

  20.         break;
    


  21. 

  22.     case CLEAR_COMM_FEATURE:
    

  23.         break;
    


  24. 

  25.     case SET_LINE_CODING:
    

  26.         /* set the value of the current command to be processed */
    

  27.         udev->class_core->req_cmd = req->bRequest;
    


  28. 

  29.         usb_transc_config(&udev->transc_out[0U], (uint8_t *)&cdc->line_coding, req->wLength, 0U);
    


  30. 

  31.         status = REQ_SUPP;
    

  32.         break;
    


  33. 

  34.     case GET_LINE_CODING:
    

  35.         usb_transc_config(&udev->transc_in[0U], (uint8_t *)&cdc->line_coding, 7U, 0U);
    


  36. 

  37.         status = REQ_SUPP;
    

  38.         break;
    


  39. 

  40.     case SET_CONTROL_LINE_STATE:
    

  41.         notif->bmRequestType = 0xA1U;
    

  42.         notif->bNotification = USB_CDC_NOTIFY_SERIAL_STATE;
    

  43.         notif->wIndex = 0U;
    

  44.         notif->wValue = 0U;
    

  45.         notif->wLength = 2U;
    

  46.         noti_buf[8] = (uint8_t)req->wValue & 3U;
    

  47.         noti_buf[9] = 0U;
    


  48. 

  49.         status = REQ_SUPP;
    

  50.         break;
    


  51. 

  52.     case SEND_BREAK:
    

  53.         break;
    


  54. 

  55.     default:
    

  56.         break;
    

  57.     }
    


  58. 

  59.     return status;
    

  60. }
下面为大家介绍USBD虚拟串口设备数据的收发。
数据接收通过cdc_acm_data_receive()函数实现，该函数的程序如下所示。在该函数中，首先将packet_receive标志位设置为0，表明接下来将进行接收数据，当接收完成时，在cdc_acm_data_out()函数中，将packet_receive标志位置1，表明数据接收完成。usbd_ep_recev()用于配置接收操作，利用CDC_OUT_EP端点，将接收到的数据放置在cdc->data用户缓冲区中。
复制
  1. C
    

  2. void cdc_acm_data_receive(usb_dev *udev)
    

  3. {
    

  4.     usb_cdc_handler *cdc = (usb_cdc_handler *)udev->class_data[CDC_COM_INTERFACE];
    


  5. 

  6.     cdc->packet_receive = 0U;
    

  7.     cdc->pre_packet_send = 0U;
    


  8. 

  9.     usbd_ep_recev(udev, CDC_OUT_EP, (uint8_t*)(cdc->data), USB_CDC_RX_LEN);
    

  10. }
    

  11. static void cdc_acm_data_out (usb_dev *udev, uint8_t ep_num)
    

  12. {
    

  13.     usb_cdc_handler *cdc = (usb_cdc_handler *)udev->class_data[CDC_COM_INTERFACE];
    


  14. 

  15.     cdc->packet_receive = 1U;
    


  16. 

  17.     cdc->receive_length = udev->transc_out[ep_num].xfer_count;
    

  18. }
数据发送通过cdc_acm_data_send()函数实现，该函数的程序如下所示。在该函数中，首先将packet_sent标志位设置为0，表明接下来将进行发送数据，当数据发送完成时，在cdc_acm_data_in()函数中，将packet_sent标志位设置为1，表明数据发送完成。usbd_ep_send()用于配置发送操作，利用CDC_IN_EP端点，将以cdc->data地址为起始data_len长度的数据发送给主机。
复制
  1. C
    

  2. void cdc_acm_data_send (usb_dev *udev)
    

  3. {
    

  4.     usb_cdc_handler *cdc = (usb_cdc_handler *)udev->class_data[CDC_COM_INTERFACE];
    

  5.     uint32_t data_len = cdc->receive_length;
    


  6. 

  7.     if ((0U != data_len) && (1U == cdc->packet_sent)) {
    

  8.         cdc->packet_sent = 0U;
    

  9.         usbd_ep_send(udev, CDC_IN_EP, (uint8_t*)(cdc->data), (uint16_t)data_len);
    

  10.         cdc->receive_length = 0U;
    

  11.     }
    

  12. }
    

  13. static void cdc_acm_data_in (usb_dev *udev, uint8_t ep_num)
    

  14. {
    

  15.     usb_transc *transc = &udev->transc_in[ep_num];
    

  16.     usb_cdc_handler *cdc = (usb_cdc_handler *)udev->class_data[CDC_COM_INTERFACE];
    


  17. 

  18.     if (transc->xfer_count == transc->max_len) {
    

  19.         usbd_ep_send(udev, EP_ID(ep_num), NULL, 0U);
    

  20.     } else {
    

  21.         cdc->packet_sent = 1U;
    

  22.         cdc->pre_packet_send = 1U;
    

  23.     }
    

  24. }
28.5 实验结果
将本例程烧录到红枫派开发板中，并通过TypeC数据线连接USB通信接口和PC，在WIN7上虚拟串口需要安装驱动，在WIN8 WIN10以及后续版本的系统上不需要安装驱动。
下面介绍WIN7系统的驱动安装过程。
在WIN7系统上，将Tyep C数据线连接到PC后，将会在设备管理器中发现一个未知设备，通过以下连接可以下载官方提供的虚拟串口驱动：https://www.gd32mcu.com/download/down/document_id/44/path_type/1
图片1.png
下载驱动并进行安装，之后将会在设备管理器中发现虚拟串口设备已经识别。
图片2.png
之后即可通过串口调试助手与MCU进行CDC通信，在串口调试助手中打开对应虚拟串口的端口，然后输入任意字符，进行发送，将会在接收窗口中看到MCU返回的接收数据，具体现象如下所示。
图片3.png
本教程由GD32 MCU方案商聚沃科技原创发布，了解更多GD32 MCU教程，关注聚沃科技官网，GD32MCU技术交流群：859440462


回复 赏

举报

相关帖子
返回列表 发新帖
高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 注册

本版积分规则

聚沃科技

170

主题

190

帖子

13

粉丝
快速回复 在线客服 返回列表 返回顶部
聚沃科技

170

主题

190

帖子

13

粉丝
快速回复 在线客服 返回列表 返回顶部