|  **银杏科技有限公司旗下技术文档发布平台**  ||||
|技术支持电话|**0379-69926675-801**|||
|技术支持邮件|Gingko@vip.163.com|||
^  版本  ^  日期  ^  作者  ^  修改内容  ^
|  V1.0  |  2020-07-07 |  gingko  |  初次建立  | 

===== 实验十八：USB_VCP实验——虚拟串口 =====

==== 一、 实验目的与意义 ====

  - 了解STM32 USB VCP结构。
  - 了解STM32 USB VCP特征。
  - 掌握USB VCP的使用方法。
  - 掌握STM32 HAL库中USB VCP属性的配置方法。
  - 掌握KEIL MDK 集成开发环境使用方法。
==== 二、 实验设备及平台 ====

  - iCore4 双核心板[[https://item.taobao.com/item.htm?spm=a1z10.1-c-s.w4004-22598974120.15.5923532fsFrHiE&id=551864196684|点击购买]]。
  - JLINK（或相同功能）仿真器[[https://item.taobao.com/item.htm?id=554869837940|点击购买]]。
  - Micro USB线缆。
  - Keil MDK 开发平台。
  - STM32CubeMX开发平台。
  - 装有WIN XP（及更高版本）系统的计算机。
==== 三、 实验原理 ====

=== 1、USB虚拟串口简介 ===
  * USB虚拟串口，简称VCP，是VirtualCOMPort的简写，它是利用USB的CDC类来实现的一种通信接口。
  * USB虚拟串口属于USB通信设备类。在物理层通过USB总线，采用虚拟串口的方式为主机提供一个物理串口。在系统内部，USB控制器提供了一个批量传输IN端点和一个批量传输的OUT端点，用于数据的接收和发送，模拟串口的RX和TX线。另外USB控制器还提供中断IN端点，发送当前串口的状态，实现对串口传输的控制。串口设备的数据，由系统的串口采集，在芯片内完成USB包的封装，通过USB总线上传至主机，再由相应的串口应用程序进行处理。对用户来说，看到的是基于串口的数据采集和传输，而实际上实现的是基于USB协议包的数据传输。
  * 我们可以利用STM32自带的USB功能，来实现一个USB虚拟串口，从而通过USB，实现电脑与STM32的数据互传。上位机无需编写专门的USB程序，只需要一个串口调试助手即可调试，非常实用。
  * 本实验利用STM32自带的USB功能，连接电脑USB，虚拟出一个USB串口，实现电脑和开发板的数据通信。
=== 2、USB CDC协议简介 ===
  * USB的CDC类是USB通信设备类（Communication Device Class）的简称。CDC类是USB组织定义的一类专门给各种通信设备（电信通信设备和中速网络通信设备）使用的USB子类。根据CDC类所针对通信设备的不同，CDC类又被分成以下不同的模型：USB传统纯电话业务（POTS）模型，USBISDN模型和USB网络模型，其中USB传统纯电话业务模型又可分为直线控制模型（Direct Line Control Model）、抽象模型、电话模型。虚拟串口就属于USB传统纯电话业务模型下的抽象控制模型。
  * 如下图所示，USB CDC类的通信部分主要包含三部分：枚举过程、虚拟串口操作和数据通信。其中虚拟串口操作部分并不一定强制需要，因为若跳过这些虚拟串口的操作，实际上USB依然是可以通信的，这也就是为什么下图中，在操作虚拟串口之前会有两条数据通信的数据。之所以会有虚拟串口操作，主要是我们通常使用PC作为Host端，在PC端使用一个串口工具来与其进行通信，PC端的对应驱动将其虚拟成一个普通串口，这样一来，可以方便PC端软件通过操作串口的方式来与其进行通信，但实际上，Host端与Device端物理上是通过USB总线来进行通信的，与串口没有关系，这一虚拟化过程，起决定性作用的是对应驱动，包含如何将每一条具体的虚拟串口操作对应到实际上的USB操作。需要注意的是，Host端与Device端的USB通信速率并不受所谓的串口波特率影响，它就是标准的USB2.0全速(12Mbps)速度，实际速率取决于总线的实际使用率、驱动访问USB外设有效速率(两边)以及外部环境对通信本身造成的干扰率等因素组成。
{{ :icore4:icore4_arm_hal_18_1.jpg?direct&700 |}} 
=== 3、CDC类软件框架 ===

  * 如下图所示，黄色USB Device Core部分为USB设备库文件,属于中间件,它为USB协议栈的核心源文件，一般不需要修改：
    * USB Device Core中,Log/debug为打印/调试开关;
    * core为USB设备核心;
    * USB request中定义了枚举过程中各种标准请求的处理；
    * I/O request为底层针对USB通信接口的封装。
  * 黄色USB Device Class部分为USB类文件，也属于中间件,USB设备库，目前ST DEMO中支持的类有HID, Customer HID, CDC, MSC, DFU, Audio, ST提供了这些类的源码框架，其他的Class或者是复合设备需要自己根据实际需求情况进行扩展或定制。如果用户需求只是需要一个标准类，比如CDC通信，那么最好就使用现成的代码，不需要做任何修改就可以实现这个CDC类通信的功能。
  * 蓝色USB Device HAL Driver为HAL库部分，是对USB外设接口的封装，属于底层驱动，不需要修改，它分为PCD和LL Driver，PCD处于LL Driver之上。
  * 洋红色USB Device Configuration为USB配置封装，位于USB底层HAL层驱动与中间件USB协议栈之间，一方面向上层(USB设备库)提供各种操作调用接口，另一方面，向底层USB驱动提供各种回调接口。正是由于它的存在，使得USB协议栈(USB设备库)与底层硬件完全分离，从而使USB设备库具有更加兼容所有STM32的通用性。USB Device Configuration为开放给用户的源文件，用户可以根据自己的某些特殊需要进行修改，也可以使用默认的源文件，假如没有任何特殊要求的话，我们使用默认即可。
  * Application为应用层，USB Device Class有可能将自己对应该的操作接口封装在一个操作数据结构中，由应用来具体实现这些操作，在系统初始化时，由应用将已经定义好的操作接口注册到对应的USB类中，比如usbd_cdc_if， 就这样，使得应用层的应用代码与属于中间件层的USB协议栈分离。同时，USB协议栈会将一些字符串描述符放到APP中，当USB初始化时将这些已经定义好的字符串通过指针初始化到USB协议栈中，以便后续需要时获取。
{{ :icore4:icore4_arm_hal_18_2.png?direct&750 |}} 
=== 4、原理图 ===
{{ :icore4:icore4_arm_hal_18_3.png?direct& |}}
  * 本实验利用STM32自带的USB功能，连接电脑USB，虚拟出一个USB串口，实现电脑和开发板的数据通信。本例程功能完全同实验四（串口通信实验），只不过串口变成了STM32的USB虚拟串口。
==== 四、 实验程序 ====

=== 1、主函数 ===
<code c>
int main(void)
{
  /* MCU 配置 */
  /* 重置所有外围设备，初始化Flash接口和Systick. */
  HAL_Init();
  /* 系统时钟配置 */
  SystemClock_Config();
 /* 初始化所有已配置的外围设备 */
  MX_GPIO_Init();
  MX_USB_DEVICE_Init();

  LED_GREEN_ON;
  //接收发送处理均在usbd_cdc_if.c文件中
  while (1)
  {
  }
}

</code> 
=== 2、USB DEVICE初始化 ===
<code c>
void MX_USB_DEVICE_Init(void)
{
  /* 初始化设备库，添加支持的类并启动该库*/
  /* 初始化设备堆栈并加载类驱动程序*/
  USBD_Init(&hUsbDeviceHS, &HS_Desc, DEVICE_HS);/
  /* 将类驱动程序链接到设备核心*/
  USBD_RegisterClass(&hUsbDeviceHS, & USBD_Interface_fops_HS);
/* 启动USB设备核心 */
  USBD_Start(&hUsbDeviceHS);
}
</code>
=== 3、CDC初始化函数介绍 ===
<code c>
/* 在USB HS IP上初始化CDC底层媒体 */
/* 如果所有操作均正常，则为USBD_OK，否则为USBD_FAIL  */
static int8_t CDC_Init_HS(void)
{
  /* 设置应用程序缓冲区 */
  USBD_CDC_SetTxBuffer(&hUsbDeviceHS, UserTxBufferHS, 0);
  USBD_CDC_SetRxBuffer(&hUsbDeviceHS, UserRxBufferHS);
  return (USBD_OK);
}
/* 取消初始化CDC媒体低层 */  
/* 如果所有操作均正常，则为USBD_OK，否则为USBD_FAIL */
static int8_t CDC_DeInit_HS(void)
{
  return (USBD_OK);
}

</code>
=== 4、CDC类请求管理 ===
<code c>
/**
  * @brief  管理CDC类请求
  * @param  cmd: 指令码
  * @param  pbuf: 包含命令数据（请求参数）的缓冲区
  * @param  length:要发送的数据数（以字节为单位）
 * @retval 操作结果: 如果所有操作均正常，则为USBD_OK，否则为USBD_FAIL
  */
static int8_t CDC_Control_HS(uint8_t cmd, uint8_t* pbuf, uint16_t length)
{ 
  switch (cmd)
  {
  case CDC_SEND_ENCAPSULATED_COMMAND:
    break;
  case CDC_GET_ENCAPSULATED_RESPONSE:
    break；
  case CDC_SET_COMM_FEATURE:
    break；
  case CDC_GET_COMM_FEATURE:
    break;
  case CDC_CLEAR_COMM_FEATURE:
    break;   
  case CDC_SET_LINE_CODING:   
    break;
  case CDC_GET_LINE_CODING:     
    break;
  case CDC_SET_CONTROL_LINE_STATE:
    break;
  case CDC_SEND_BREAK:
    break;    
  default:
    break;
  }
  return (USBD_OK);
}

</code>
=== 5、CDC接受数据 ===
<code c>
/**
  * @brief  USB OUT端点接收的数据通过此函数发送给CDC接口 
  * @note 此函数将阻止USB端点上的所有OUT数据包接收，直到退出此功能。如果在CDC接口上完成
            传输之前退出此功能（即使用DMA控制器），它将导致接收更多数据，而先前的数据仍未发送。
  * @param  Buf: 待接收数据的缓冲区
  * @param  Len: 接收的数据数（以字节为单位）
  * @retval 如果所有操作均正常，则为USBD_OK，否则为USBD_FAIL
  */
static int8_t CDC_Receive_HS (uint8_t* Buf, uint32_t *Len)
{
  USBD_CDC_SetRxBuffer(&hUsbDeviceHS, &Buf[0]);
  USBD_CDC_ReceivePacket(&hUsbDeviceHS);
  CDC_Transmit_HS(Buf,(uint16_t)(*Len));
  return (USBD_OK);
}

</code>
=== 6、CDC发送数据 ===
<code c>
/**
* @brief  通过USB IN端点发送的数据通过此函数发送给CDC接口
* @param  Buf: 要发送的数据缓冲区
* @param  Len: 要发送的数据数（以字节为单位）
* @retval 操作结果: 如果所有操作均正常返回USBD_OK，否则返回USBD_FAIL或USBD_BUSY 
*/
uint8_t CDC_Transmit_HS(uint8_t* Buf, uint16_t Len)
{
  uint8_t result = USBD_OK; 
  USBD_CDC_HandleTypeDef *hcdc = (USBD_CDC_HandleTypeDef*)hUsbDeviceHS.pClassData;

  if (hcdc->TxState != 0){
    return USBD_BUSY;
  }

  USBD_CDC_SetTxBuffer(&hUsbDeviceHS, Buf, Len);
  result = USBD_CDC_TransmitPacket(&hUsbDeviceHS);
  return result;
}

</code>
==== 五、 实验步骤 ====
  - 把仿真器与iCore4的SWD调试口相连（直接相连或者通过转接器相连）；
  - 将跳线帽插到USB_OTG;
  - 把iCore4（USB_OTG）通过Micro USB线与计算机相连，为iCore4供电；
  - 打开Keil MDK 开发环境，并打开本实验工程；
  - 烧写程序到iCore4上；
  - 打开Commix串口终端；
  - 也可以进入Debug模式，单步运行或设置断点验证程序逻辑。
==== 六、 实验现象 ====

  * 通过Commix串口终端向iCore4发送信息，iCore4将接收到的信息返回给终端。
{{ :icore4:icore4_arm_hal_18_4.png?direct |}}