简介
USB CDC(communication device class)类是usb2.0标准下的一个子类,定义了通信相关设备的抽象集合。usb2.0标准下定义了很多子类,有音频类,CDC类,HID类,打印,大容量存储类,HUB和智能卡等等。
CDC类下根据应用场合,又分为多个子类,官方文档主要讲的是PSTN。PSTN(Public Switched Telephone Network)是一个与电信相关的子类,这里只是将其当作一个普通的通信设备使用,并没有使用它的一些电话特性。
使用USB中的CDC类来虚拟串口 Virtual COM Port
(VCP)进行通讯是一种非常好用的方式,一方面对于上位机来说显示出来的就是一个串口,所有操作都还是对串口的操作;另一方面实际数据传输是基于USB的,数据传输速度得到大大提升。并且STM32 CDC VCP对于win10和较新版本的Linux来说是免驱的。
示例
使用STM32CubeIDE生成代码。
将代码编译烧录后,我们可以看到多了一个串口设备。
其他说明
从USB版本来说目前STM32系列MCU可以认为都是USB2.0的。从硬件接口功能上来说STM32系列MCU的USB分为 USB_FS 、 USB_OTG_FS 、 USB_OTG_HS 三种。其中的FS指的是全速(Full Speed),HS指的是高速(High Speed)。OTG指的是既可以作为Device(从设备)使用,也可以作为Host(主机)使用。
Full Speed 理论上速度为12Mbit/s,High Speed 理论上速度为480Mbit/s ,当然这都是理论速度,实际上通讯速度还依赖于所用通讯方式和设备性能。
对于STM32系列MCU而言,USB FS的使用只要使用 DM / D- 和 DP / D+ 这两个引脚就行了,最多也就加上ID、SOF、VBUS这三个引脚。而使用USB HS大多数还需要外接PHY芯片(比如USB3300),这样使用的引脚就多了,至少也要用到12个引脚。STM32系列MCU中目前只有STM32F723内置USB HS PHY功能,不需要外接PHY芯片。
我们在上面的示例中,是外接了PHY芯片的,所以选择配置的时候是用的USB_HS。
用户代码分析
上述配置生成的代码中,对于用户来说USB使用相关的代码都在 USB_DEVICE > App
中,这其中最重要的就是 usbd_cdc_if.c
文件,大多数时候我们只要改写这个文件就可以实现相关需求了,该文件主要结构与说明如下:
#include "usbd_cdc_if.h"
// 数据收发缓存,这部分也可以完全由用户自行定义
uint8_t UserRxBufferFS[APP_RX_DATA_SIZE]; // 接收缓存
uint8_t UserTxBufferFS[APP_TX_DATA_SIZE]; // 发送缓存
extern USBD_HandleTypeDef hUsbDeviceFS;
// 初始化USB_CDC
static int8_t CDC_Init_FS(void)
{
USBD_CDC_SetTxBuffer(&hUsbDeviceFS, UserTxBufferFS, 0); // 设置发送缓存
USBD_CDC_SetRxBuffer(&hUsbDeviceFS, UserRxBufferFS); // 设置接收缓存
}
// 反初始化USB_CDC
static int8_t CDC_DeInit_FS(void){}
// 来自主机的请求处理
// cmd: 命令代码
// pbuf & length: 请求数据指针与长度
static int8_t CDC_Control_FS(uint8_t cmd, uint8_t* pbuf, uint16_t length)
{
switch(cmd)
{
/***********************************************************************************************/
/* Line Coding Structure */
/*---------------------------------------------------------------------------------------------*/
/* Offset | Field | Size | Description */
/* 0 | dwDTERate | 4 | Data terminal rate, in bits per second */
/* 4 | bCharFormat | 1 | Stop bits: 0 - 1 Stop bit; 1 - 1.5 Stop bits; 2 - 2 Stop bits */
/* 5 | bParityType | 1 | Parity: 0 - None; 1 - Odd; 2 - Even; 3 - Mark; 4 - Space */
/* 6 | bDataBits | 1 | Data bits (5, 6, 7, 8 or 16). */
/***********************************************************************************************/
case CDC_SET_LINE_CODING: break; // 主机设置串口参数
}
}
// 接收回调函数
// Buf & Len: 当前收到这一包数据指针与长度
static int8_t CDC_Receive_FS(uint8_t* Buf, uint32_t *Len)
{
USBD_CDC_SetRxBuffer(&hUsbDeviceFS, &Buf[0]); // 重新设置接收缓存
// 注意默认情况下上面一行代码相当于 USBD_CDC_SetRxBuffer(&hUsbDeviceFS, UserRxBufferFS);
USBD_CDC_ReceivePacket(&hUsbDeviceFS); // 重新启动数据接收
}
// 数据发送函数
// Buf & Len: 要发送的数据指针与长度
uint8_t CDC_Transmit_FS(uint8_t* Buf, uint16_t Len)
{
USBD_CDC_HandleTypeDef *hcdc = (USBD_CDC_HandleTypeDef*)hUsbDeviceFS.pClassData;
if (hcdc->TxState != 0){
return USBD_BUSY; // 如果当前USB繁忙则返回USBD_BUSY
}
USBD_CDC_SetTxBuffer(&hUsbDeviceFS, Buf, Len); // 设置要发送的数据
result = USBD_CDC_TransmitPacket(&hUsbDeviceFS); // 发送数据
}
// 发送完成回调函数
// Buf & Len: 所送的数据指针与长度
static int8_t CDC_TransmitCplt_FS(uint8_t *Buf, uint32_t *Len, uint8_t epnum){}
上面代码中最常处理的只有下面四个函数:
CDC_Control_FS()
来自主机请求的回调函数
CDC_Receive_FS()
接收数据回调函数;
CDC_Transmit_FS()
用来发送数据;
CDC_TransmitCplt_FS()
发送完成回调函数;
发送
uint8_t CDC_Transmit_FS ( uint8_t* Buf, uint16_t Len );
static int8_t CDC_TransmitCplt_HS(uint8_t *Buf, uint32_t *Len, uint8_t epnum)
我们需要发送数据的时候,需要调用CDC_Transmit_FS函数,该函数的Len参数好像并不会限制在2048。然后我们在发生完成函数中修改如下:
static int8_t CDC_TransmitCplt_HS(uint8_t *Buf, uint32_t *Len, uint8_t epnum)
{
uint8_t result = USBD_OK;
/* USER CODE BEGIN 14 */
printf("CDC_TransmitCplt_HS Len=%d\r\n", *Len);
UNUSED(Buf);
UNUSED(Len);
UNUSED(epnum);
/* USER CODE END 14 */
return result;
}
我们可以看到,当一次性发送的数据包大于512的时候,发送函数内部会自动分包,直至发完,就会调用CDC_TransmitCplt_HS函数。接收端好像也会自动组包然后一次性收完?
还有一点需要注意,在发送函数内部,有一个设备状态判断,这意味着如果当前正在发送一包数据,然后你又调用该函数发送一包数据,是会发送失败的。可以理解为发送函数它是一个异步函数,数据真正发完的时候会调用CDC_TransmitCplt_HS函数。所以,我们在发送下一包数据的时候,需要确保上一包数据已经发送完成了,一般可以使用一个信号量进行阻塞之类的。
关于发送函数的总结:
- 发送函数的数据长度可以大于一包USB数据的长度,函数内部会自动分包。
- 发送函数是一个异步函数,调用CDC_TransmitCplt_HS函数的时候,数据才真正发完。
接收
当USB CDC接收到来自USB主机的数据时,触发中断进入中断函数,继而自动调用接收回调函数:
int8_t CDC_Receive_FS (uint8_t* Buf, uint32_t *Len);
- uint8_t* Buf: 指向接收缓冲区的指针,即数据缓存的地址。
- uint16_t* Len: 当前数据包的字节数。
我们将代码改为如下
static int8_t CDC_Receive_HS(uint8_t* Buf, uint32_t *Len)
{
/* USER CODE BEGIN 11 */
printf("CDC_Receive_HS Len=%d\r\n",*Len);
USBD_CDC_SetRxBuffer(&hUsbDeviceHS, &Buf[0]);
USBD_CDC_ReceivePacket(&hUsbDeviceHS);
return (USBD_OK);
/* USER CODE END 11 */
}
然后使用串口助手往底板发送数据的结果如下:
可以看到,我们串口一次性发送了6868个字节的数据,在底板是分多次接收的。这是为什么呢?这是因为我们在配置USB CDC的时候,USB协议已经规定了一个USB包的数据最大就是512字节,这并不意味着超过512字节的数据帧就不能够发送给单片机,从上例就可以看出,USB协议会自动分包,然后单片机会有多次接收,只是一次接收不能接收所有完整的数据帧。所以,如果有大于512的数据帧时,我们可以在接收端手动组包,将多次接收的一个数据包组成完成的数据帧。组包的机制可以是定义帧头帧尾或者定义包序号,这里就不展开了。
还有一点示例可能看不出来,就是接收函数其实就是一个中断服务函数。所以,我们在该函数中的处理时间应该尽可能的短,因为在接收函数中进行耗时操作时,可能正好有一包数据需要接收,这时可能就会漏收。一般建议在该函数中接收数据时,将数据转存到其他的队列或者缓存空间。
关于接收函数的总结:
- 如果上位机一次发送的数据帧大于USB最大包长度,那么在接收端需要注意组包。
- 在接收函数中尽量不要进行耗时的操作,如需处理数据可以先转存到其他地方。