usbd_cdc_if.c 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327
  1. /* USER CODE BEGIN Header */
  2. /**
  3. ******************************************************************************
  4. * @file : usbd_cdc_if.c
  5. * @version : v1.0_Cube
  6. * @brief : Usb device for Virtual Com Port.
  7. ******************************************************************************
  8. * @attention
  9. *
  10. * Copyright (c) 2022 STMicroelectronics.
  11. * All rights reserved.
  12. *
  13. * This software is licensed under terms that can be found in the LICENSE file
  14. * in the root directory of this software component.
  15. * If no LICENSE file comes with this software, it is provided AS-IS.
  16. *
  17. ******************************************************************************
  18. */
  19. /* USER CODE END Header */
  20. /* Includes ------------------------------------------------------------------*/
  21. #include "usbd_cdc_if.h"
  22. /* USER CODE BEGIN INCLUDE */
  23. /* USER CODE END INCLUDE */
  24. /* Private typedef -----------------------------------------------------------*/
  25. /* Private define ------------------------------------------------------------*/
  26. /* Private macro -------------------------------------------------------------*/
  27. /* USER CODE BEGIN PV */
  28. /* Private variables ---------------------------------------------------------*/
  29. /* USER CODE END PV */
  30. /** @addtogroup STM32_USB_OTG_DEVICE_LIBRARY
  31. * @brief Usb device library.
  32. * @{
  33. */
  34. /** @addtogroup USBD_CDC_IF
  35. * @{
  36. */
  37. /** @defgroup USBD_CDC_IF_Private_TypesDefinitions USBD_CDC_IF_Private_TypesDefinitions
  38. * @brief Private types.
  39. * @{
  40. */
  41. /* USER CODE BEGIN PRIVATE_TYPES */
  42. /* USER CODE END PRIVATE_TYPES */
  43. /**
  44. * @}
  45. */
  46. /** @defgroup USBD_CDC_IF_Private_Defines USBD_CDC_IF_Private_Defines
  47. * @brief Private defines.
  48. * @{
  49. */
  50. /* USER CODE BEGIN PRIVATE_DEFINES */
  51. /* USER CODE END PRIVATE_DEFINES */
  52. /**
  53. * @}
  54. */
  55. /** @defgroup USBD_CDC_IF_Private_Macros USBD_CDC_IF_Private_Macros
  56. * @brief Private macros.
  57. * @{
  58. */
  59. /* USER CODE BEGIN PRIVATE_MACRO */
  60. /* USER CODE END PRIVATE_MACRO */
  61. /**
  62. * @}
  63. */
  64. /** @defgroup USBD_CDC_IF_Private_Variables USBD_CDC_IF_Private_Variables
  65. * @brief Private variables.
  66. * @{
  67. */
  68. /* Create buffer for reception and transmission */
  69. /* It's up to user to redefine and/or remove those define */
  70. /** Received data over USB are stored in this buffer */
  71. uint8_t UserRxBufferHS[APP_RX_DATA_SIZE];
  72. /** Data to send over USB CDC are stored in this buffer */
  73. uint8_t UserTxBufferHS[APP_TX_DATA_SIZE];
  74. /* USER CODE BEGIN PRIVATE_VARIABLES */
  75. /* USER CODE END PRIVATE_VARIABLES */
  76. /**
  77. * @}
  78. */
  79. /** @defgroup USBD_CDC_IF_Exported_Variables USBD_CDC_IF_Exported_Variables
  80. * @brief Public variables.
  81. * @{
  82. */
  83. extern USBD_HandleTypeDef hUsbDeviceHS;
  84. /* USER CODE BEGIN EXPORTED_VARIABLES */
  85. /* USER CODE END EXPORTED_VARIABLES */
  86. /**
  87. * @}
  88. */
  89. /** @defgroup USBD_CDC_IF_Private_FunctionPrototypes USBD_CDC_IF_Private_FunctionPrototypes
  90. * @brief Private functions declaration.
  91. * @{
  92. */
  93. static int8_t CDC_Init_HS(void);
  94. static int8_t CDC_DeInit_HS(void);
  95. static int8_t CDC_Control_HS(uint8_t cmd, uint8_t* pbuf, uint16_t length);
  96. static int8_t CDC_Receive_HS(uint8_t* pbuf, uint32_t *Len);
  97. static int8_t CDC_TransmitCplt_HS(uint8_t *pbuf, uint32_t *Len, uint8_t epnum);
  98. /* USER CODE BEGIN PRIVATE_FUNCTIONS_DECLARATION */
  99. /* USER CODE END PRIVATE_FUNCTIONS_DECLARATION */
  100. /**
  101. * @}
  102. */
  103. USBD_CDC_ItfTypeDef USBD_Interface_fops_HS =
  104. {
  105. CDC_Init_HS,
  106. CDC_DeInit_HS,
  107. CDC_Control_HS,
  108. CDC_Receive_HS,
  109. CDC_TransmitCplt_HS
  110. };
  111. /* Private functions ---------------------------------------------------------*/
  112. /**
  113. * @brief Initializes the CDC media low layer over the USB HS IP
  114. * @retval USBD_OK if all operations are OK else USBD_FAIL
  115. */
  116. static int8_t CDC_Init_HS(void)
  117. {
  118. /* USER CODE BEGIN 8 */
  119. /* Set Application Buffers */
  120. USBD_CDC_SetTxBuffer(&hUsbDeviceHS, UserTxBufferHS, 0);
  121. USBD_CDC_SetRxBuffer(&hUsbDeviceHS, UserRxBufferHS);
  122. return (USBD_OK);
  123. /* USER CODE END 8 */
  124. }
  125. /**
  126. * @brief DeInitializes the CDC media low layer
  127. * @param None
  128. * @retval USBD_OK if all operations are OK else USBD_FAIL
  129. */
  130. static int8_t CDC_DeInit_HS(void)
  131. {
  132. /* USER CODE BEGIN 9 */
  133. return (USBD_OK);
  134. /* USER CODE END 9 */
  135. }
  136. /**
  137. * @brief Manage the CDC class requests
  138. * @param cmd: Command code
  139. * @param pbuf: Buffer containing command data (request parameters)
  140. * @param length: Number of data to be sent (in bytes)
  141. * @retval Result of the operation: USBD_OK if all operations are OK else USBD_FAIL
  142. */
  143. static int8_t CDC_Control_HS(uint8_t cmd, uint8_t* pbuf, uint16_t length)
  144. {
  145. /* USER CODE BEGIN 10 */
  146. switch(cmd)
  147. {
  148. case CDC_SEND_ENCAPSULATED_COMMAND:
  149. break;
  150. case CDC_GET_ENCAPSULATED_RESPONSE:
  151. break;
  152. case CDC_SET_COMM_FEATURE:
  153. break;
  154. case CDC_GET_COMM_FEATURE:
  155. break;
  156. case CDC_CLEAR_COMM_FEATURE:
  157. break;
  158. /*******************************************************************************/
  159. /* Line Coding Structure */
  160. /*-----------------------------------------------------------------------------*/
  161. /* Offset | Field | Size | Value | Description */
  162. /* 0 | dwDTERate | 4 | Number |Data terminal rate, in bits per second*/
  163. /* 4 | bCharFormat | 1 | Number | Stop bits */
  164. /* 0 - 1 Stop bit */
  165. /* 1 - 1.5 Stop bits */
  166. /* 2 - 2 Stop bits */
  167. /* 5 | bParityType | 1 | Number | Parity */
  168. /* 0 - None */
  169. /* 1 - Odd */
  170. /* 2 - Even */
  171. /* 3 - Mark */
  172. /* 4 - Space */
  173. /* 6 | bDataBits | 1 | Number Data bits (5, 6, 7, 8 or 16). */
  174. /*******************************************************************************/
  175. case CDC_SET_LINE_CODING:
  176. break;
  177. case CDC_GET_LINE_CODING:
  178. break;
  179. case CDC_SET_CONTROL_LINE_STATE:
  180. break;
  181. case CDC_SEND_BREAK:
  182. break;
  183. default:
  184. break;
  185. }
  186. return (USBD_OK);
  187. /* USER CODE END 10 */
  188. }
  189. /**
  190. * @brief Data received over USB OUT endpoint are sent over CDC interface
  191. * through this function.
  192. *
  193. * @note
  194. * This function will issue a NAK packet on any OUT packet received on
  195. * USB endpoint until exiting this function. If you exit this function
  196. * before transfer is complete on CDC interface (ie. using DMA controller)
  197. * it will result in receiving more data while previous ones are still
  198. * not sent.
  199. *
  200. * @param Buf: Buffer of data to be received
  201. * @param Len: Number of data received (in bytes)
  202. * @retval Result of the operation: USBD_OK if all operations are OK else USBD_FAILL
  203. */
  204. static int8_t CDC_Receive_HS(uint8_t* Buf, uint32_t *Len)
  205. {
  206. /* USER CODE BEGIN 11 */
  207. USBD_CDC_SetRxBuffer(&hUsbDeviceHS, &Buf[0]);
  208. USBD_CDC_ReceivePacket(&hUsbDeviceHS);
  209. return (USBD_OK);
  210. /* USER CODE END 11 */
  211. }
  212. /**
  213. * @brief Data to send over USB IN endpoint are sent over CDC interface
  214. * through this function.
  215. * @param Buf: Buffer of data to be sent
  216. * @param Len: Number of data to be sent (in bytes)
  217. * @retval Result of the operation: USBD_OK if all operations are OK else USBD_FAIL or USBD_BUSY
  218. */
  219. uint8_t CDC_Transmit_HS(uint8_t* Buf, uint16_t Len)
  220. {
  221. uint8_t result = USBD_OK;
  222. /* USER CODE BEGIN 12 */
  223. USBD_CDC_HandleTypeDef *hcdc = (USBD_CDC_HandleTypeDef*)hUsbDeviceHS.pClassData;
  224. if (hcdc->TxState != 0){
  225. return USBD_BUSY;
  226. }
  227. USBD_CDC_SetTxBuffer(&hUsbDeviceHS, Buf, Len);
  228. result = USBD_CDC_TransmitPacket(&hUsbDeviceHS);
  229. /* USER CODE END 12 */
  230. return result;
  231. }
  232. /**
  233. * @brief CDC_TransmitCplt_HS
  234. * Data transmitted callback
  235. *
  236. * @note
  237. * This function is IN transfer complete callback used to inform user that
  238. * the submitted Data is successfully sent over USB.
  239. *
  240. * @param Buf: Buffer of data to be received
  241. * @param Len: Number of data received (in bytes)
  242. * @retval Result of the operation: USBD_OK if all operations are OK else USBD_FAIL
  243. */
  244. static int8_t CDC_TransmitCplt_HS(uint8_t *Buf, uint32_t *Len, uint8_t epnum)
  245. {
  246. uint8_t result = USBD_OK;
  247. /* USER CODE BEGIN 14 */
  248. UNUSED(Buf);
  249. UNUSED(Len);
  250. UNUSED(epnum);
  251. /* USER CODE END 14 */
  252. return result;
  253. }
  254. /* USER CODE BEGIN PRIVATE_FUNCTIONS_IMPLEMENTATION */
  255. /* USER CODE END PRIVATE_FUNCTIONS_IMPLEMENTATION */
  256. /**
  257. * @}
  258. */
  259. /**
  260. * @}
  261. */