代码规范 usbvpc文档

USB_DEVICE/App/usbd_cdc_if.c

@@ -31,7 +31,8 @@
 
 /* USER CODE BEGIN PV */
 /* Private variables ---------------------------------------------------------*/
-
+static USBCallback tx_cbk = NULL;
+static USBCallback rx_cbk = NULL;
 /* USER CODE END PV */
 
 /** @addtogroup STM32_USB_OTG_DEVICE_LIBRARY
@@ -123,9 +124,13 @@ extern USBD_HandleTypeDef hUsbDeviceHS;
   */
 
 static int8_t CDC_Init_HS(void);
+
 static int8_t CDC_DeInit_HS(void);
-static int8_t CDC_Control_HS(uint8_t cmd, uint8_t* pbuf, uint16_t length);
+
-static int8_t CDC_Receive_HS(uint8_t* pbuf, uint32_t *Len);
+static int8_t CDC_Control_HS(uint8_t cmd, uint8_t *pbuf, uint16_t length);
+
+static int8_t CDC_Receive_HS(uint8_t *pbuf, uint32_t *Len);
+
 static int8_t CDC_TransmitCplt_HS(uint8_t *pbuf, uint32_t *Len, uint8_t epnum);
 
 /* USER CODE BEGIN PRIVATE_FUNCTIONS_DECLARATION */
@@ -180,10 +185,10 @@ static int8_t CDC_DeInit_HS(void)
   * @param  length: Number of data to be sent (in bytes)
   * @retval Result of the operation: USBD_OK if all operations are OK else USBD_FAIL
   */
-static int8_t CDC_Control_HS(uint8_t cmd, uint8_t* pbuf, uint16_t length)
+static int8_t CDC_Control_HS(uint8_t cmd, uint8_t *pbuf, uint16_t length)
 {
     /* USER CODE BEGIN 10 */
-  switch(cmd)
+    switch (cmd)
     {
         case CDC_SEND_ENCAPSULATED_COMMAND:
 
@@ -261,7 +266,7 @@ static int8_t CDC_Control_HS(uint8_t cmd, uint8_t* pbuf, uint16_t length)
   * @param  Len: Number of data received (in bytes)
   * @retval Result of the operation: USBD_OK if all operations are OK else USBD_FAILL
   */
-static int8_t CDC_Receive_HS(uint8_t* Buf, uint32_t *Len)
+static int8_t CDC_Receive_HS(uint8_t *Buf, uint32_t *Len)
 {
     /* USER CODE BEGIN 11 */
     USBD_CDC_SetRxBuffer(&hUsbDeviceHS, &Buf[0]);
@@ -277,12 +282,13 @@ static int8_t CDC_Receive_HS(uint8_t* Buf, uint32_t *Len)
   * @param  Len: Number of data to be sent (in bytes)
   * @retval Result of the operation: USBD_OK if all operations are OK else USBD_FAIL or USBD_BUSY
   */
-uint8_t CDC_Transmit_HS(uint8_t* Buf, uint16_t Len)
+uint8_t CDC_Transmit_HS(uint8_t *Buf, uint16_t Len)
 {
     uint8_t result = USBD_OK;
     /* USER CODE BEGIN 12 */
-  USBD_CDC_HandleTypeDef *hcdc = (USBD_CDC_HandleTypeDef*)hUsbDeviceHS.pClassData;
+    USBD_CDC_HandleTypeDef *hcdc = (USBD_CDC_HandleTypeDef *) hUsbDeviceHS.pClassData;
-  if (hcdc->TxState != 0){
+    if (hcdc->TxState != 0)
+    {
         return USBD_BUSY;
     }
     USBD_CDC_SetTxBuffer(&hUsbDeviceHS, Buf, Len);
@@ -310,11 +316,19 @@ static int8_t CDC_TransmitCplt_HS(uint8_t *Buf, uint32_t *Len, uint8_t epnum)
     UNUSED(Buf);
     UNUSED(Len);
     UNUSED(epnum);
+    if (tx_cbk)
+        tx_cbk(*Len);
     /* USER CODE END 14 */
     return result;
 }
 
 /* USER CODE BEGIN PRIVATE_FUNCTIONS_IMPLEMENTATION */
+uint8_t *CDCInitRxbufferNcallback(USBCallback transmit_cbk, USBCallback recv_cbk)
+{
+    tx_cbk = transmit_cbk;
+    rx_cbk = recv_cbk;
+    return UserRxBufferHS;
+}
 
 /* USER CODE END PRIVATE_FUNCTIONS_IMPLEMENTATION */
 

USB_DEVICE/App/usbd_cdc_if.h

@@ -24,7 +24,11 @@
 #define __USBD_CDC_IF_H__
 
 #ifdef __cplusplus
- extern "C" {
+extern "C"
+{
+
+
+
 #endif
 
 /* Includes ------------------------------------------------------------------*/
@@ -65,6 +69,7 @@
   */
 
 /* USER CODE BEGIN EXPORTED_TYPES */
+typedef void (*USBCallback)(uint16_t);
 
 /* USER CODE END EXPORTED_TYPES */
 
@@ -106,9 +111,10 @@ extern USBD_CDC_ItfTypeDef USBD_Interface_fops_HS;
   * @{
   */
 
-uint8_t CDC_Transmit_HS(uint8_t* Buf, uint16_t Len);
+uint8_t CDC_Transmit_HS(uint8_t *Buf, uint16_t Len);
 
 /* USER CODE BEGIN EXPORTED_FUNCTIONS */
+uint8_t *CDCInitRxbufferNcallback(USBCallback transmit_cbk, USBCallback recv_cbk);
 
 /* USER CODE END EXPORTED_FUNCTIONS */
 

User_Code/bsp/usbvpc/bsp_vpc.c

@@ -1,5 +1,31 @@
-//
+/**
-// Created by tuxmonkey on 2025/10/28.
+ * @file bsp_vpc.c
-//
+ * @author your name (you@domain.com)
+ * @brief usb是单例bsp,因此不保存实例
+ * @version 0.1
+ * @date 2023-02-09
+ *
+ * @copyright Copyright (c) 2023
+ *
+ */
 
 #include "bsp_vpc.h"
+#include "bsp_log.h"
+#include "bsp_dwt.h"
+
+static uint8_t *bsp_usb_rx_buffer; // 接收到的数据会被放在这里,buffer size为2048
+// 注意usb单个数据包(Full speed模式下)最大为64byte,超出可能会出现丢包情况
+
+uint8_t *USBInit(USB_Init_Config_s usb_conf)
+{
+    // usb的软件复位(模拟拔插)在usbd_conf.c中的HAL_PCD_MspInit()中
+    bsp_usb_rx_buffer = CDCInitRxbufferNcallback(usb_conf.tx_cbk, usb_conf.rx_cbk); // 获取接收数据指针
+    // usb的接收回调函数会在这里被设置,并将数据保存在bsp_usb_rx_buffer中
+    LOGINFO("USB init success");
+    return bsp_usb_rx_buffer;
+}
+
+void USBTransmit(uint8_t *buffer, uint16_t len)
+{
+    CDC_Transmit_HS(buffer, len); // 发送
+}

User_Code/bsp/usbvpc/bsp_vpc.h

@@ -1,8 +1,30 @@
-//
+/**
-// Created by tuxmonkey on 2025/10/28.
+* @file bsp_vpc.h
-//
+ * @author your name (you@domain.com)
+ * @brief 提供对usb vpc(virtal com port)的操作接口,hid和msf考虑后续添加
+ * @attention 这一版usb修改了usbd_cdc_if.c中的CDC_Receive_FS函数,若使用cube生成后会被覆盖.后续需要由usbcdciftemplate创建一套自己的模板
+ * @version 0.1
+ * @date 2025-11-25
+ *
+ * @copyright Copyright (c) 2025
+ *
+ */
+#pragma once
+#include "usb_device.h"
+#include "usbd_cdc.h"
+#include "usbd_conf.h"
+#include "usbd_desc.h"
+#include "usbd_cdc_if.h"
 
-#ifndef TRONONEH7_SCAFFOLD_BSP_VPC_H
+typedef struct
-#define TRONONEH7_SCAFFOLD_BSP_VPC_H
+{
+    USBCallback tx_cbk;
+    USBCallback rx_cbk;
+} USB_Init_Config_s;
 
-#endif //TRONONEH7_SCAFFOLD_BSP_VPC_H
+/* @note 虚拟串口的波特率/校验位/数据位等动态可变,取决于上位机的设定 */
+/* 使用时不需要关心这些设置(作为从机) */
+
+uint8_t *USBInit(USB_Init_Config_s usb_conf); // bsp初始化时调用会重新枚举设备
+
+void USBTransmit(uint8_t *buffer, uint16_t len); // 通过usb发送数据