usbd_desc.c 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394
  1. /* USER CODE BEGIN Header */
  2. /**
  3. ******************************************************************************
  4. * @file : App/usbd_desc.c
  5. * @version : v2.0_Cube
  6. * @brief : This file implements the USB device descriptors.
  7. ******************************************************************************
  8. * @attention
  9. *
  10. * Copyright (c) 2024 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_core.h"
  22. #include "usbd_desc.h"
  23. #include "usbd_conf.h"
  24. /* USER CODE BEGIN INCLUDE */
  25. /* USER CODE END INCLUDE */
  26. /* Private typedef -----------------------------------------------------------*/
  27. /* Private define ------------------------------------------------------------*/
  28. /* Private macro -------------------------------------------------------------*/
  29. /* USER CODE BEGIN PV */
  30. /* Private variables ---------------------------------------------------------*/
  31. /* USER CODE END PV */
  32. /** @addtogroup STM32_USB_OTG_DEVICE_LIBRARY
  33. * @{
  34. */
  35. /** @addtogroup USBD_DESC
  36. * @{
  37. */
  38. /** @defgroup USBD_DESC_Private_TypesDefinitions USBD_DESC_Private_TypesDefinitions
  39. * @brief Private types.
  40. * @{
  41. */
  42. /* USER CODE BEGIN PRIVATE_TYPES */
  43. /* USER CODE END PRIVATE_TYPES */
  44. /**
  45. * @}
  46. */
  47. /** @defgroup USBD_DESC_Private_Defines USBD_DESC_Private_Defines
  48. * @brief Private defines.
  49. * @{
  50. */
  51. #define USBD_VID 1155
  52. #define USBD_LANGID_STRING 1033
  53. #define USBD_MANUFACTURER_STRING "STMicroelectronics"
  54. #define USBD_PID_FS 22336
  55. #define USBD_PRODUCT_STRING_FS "STM32 Virtual ComPort"
  56. #define USBD_CONFIGURATION_STRING_FS "CDC Config"
  57. #define USBD_INTERFACE_STRING_FS "CDC Interface"
  58. /* USER CODE BEGIN PRIVATE_DEFINES */
  59. /* USER CODE END PRIVATE_DEFINES */
  60. /**
  61. * @}
  62. */
  63. /* USER CODE BEGIN 0 */
  64. /* USER CODE END 0 */
  65. /** @defgroup USBD_DESC_Private_Macros USBD_DESC_Private_Macros
  66. * @brief Private macros.
  67. * @{
  68. */
  69. /* USER CODE BEGIN PRIVATE_MACRO */
  70. /* USER CODE END PRIVATE_MACRO */
  71. /**
  72. * @}
  73. */
  74. /** @defgroup USBD_DESC_Private_FunctionPrototypes USBD_DESC_Private_FunctionPrototypes
  75. * @brief Private functions declaration.
  76. * @{
  77. */
  78. static void Get_SerialNum(void);
  79. static void IntToUnicode(uint32_t value, uint8_t * pbuf, uint8_t len);
  80. /**
  81. * @}
  82. */
  83. /** @defgroup USBD_DESC_Private_FunctionPrototypes USBD_DESC_Private_FunctionPrototypes
  84. * @brief Private functions declaration for FS.
  85. * @{
  86. */
  87. uint8_t * USBD_FS_DeviceDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  88. uint8_t * USBD_FS_LangIDStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  89. uint8_t * USBD_FS_ManufacturerStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  90. uint8_t * USBD_FS_ProductStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  91. uint8_t * USBD_FS_SerialStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  92. uint8_t * USBD_FS_ConfigStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  93. uint8_t * USBD_FS_InterfaceStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  94. /**
  95. * @}
  96. */
  97. /** @defgroup USBD_DESC_Private_Variables USBD_DESC_Private_Variables
  98. * @brief Private variables.
  99. * @{
  100. */
  101. USBD_DescriptorsTypeDef FS_Desc =
  102. {
  103. USBD_FS_DeviceDescriptor
  104. , USBD_FS_LangIDStrDescriptor
  105. , USBD_FS_ManufacturerStrDescriptor
  106. , USBD_FS_ProductStrDescriptor
  107. , USBD_FS_SerialStrDescriptor
  108. , USBD_FS_ConfigStrDescriptor
  109. , USBD_FS_InterfaceStrDescriptor
  110. };
  111. #if defined ( __ICCARM__ ) /* IAR Compiler */
  112. #pragma data_alignment=4
  113. #endif /* defined ( __ICCARM__ ) */
  114. /** USB standard device descriptor. */
  115. __ALIGN_BEGIN uint8_t USBD_FS_DeviceDesc[USB_LEN_DEV_DESC] __ALIGN_END =
  116. {
  117. 0x12, /*bLength */
  118. USB_DESC_TYPE_DEVICE, /*bDescriptorType*/
  119. 0x00, /*bcdUSB */
  120. 0x02,
  121. 0x02, /*bDeviceClass*/
  122. 0x02, /*bDeviceSubClass*/
  123. 0x00, /*bDeviceProtocol*/
  124. USB_MAX_EP0_SIZE, /*bMaxPacketSize*/
  125. LOBYTE(USBD_VID), /*idVendor*/
  126. HIBYTE(USBD_VID), /*idVendor*/
  127. LOBYTE(USBD_PID_FS), /*idProduct*/
  128. HIBYTE(USBD_PID_FS), /*idProduct*/
  129. 0x00, /*bcdDevice rel. 2.00*/
  130. 0x02,
  131. USBD_IDX_MFC_STR, /*Index of manufacturer string*/
  132. USBD_IDX_PRODUCT_STR, /*Index of product string*/
  133. USBD_IDX_SERIAL_STR, /*Index of serial number string*/
  134. USBD_MAX_NUM_CONFIGURATION /*bNumConfigurations*/
  135. };
  136. /* USB_DeviceDescriptor */
  137. /**
  138. * @}
  139. */
  140. /** @defgroup USBD_DESC_Private_Variables USBD_DESC_Private_Variables
  141. * @brief Private variables.
  142. * @{
  143. */
  144. #if defined ( __ICCARM__ ) /* IAR Compiler */
  145. #pragma data_alignment=4
  146. #endif /* defined ( __ICCARM__ ) */
  147. /** USB lang identifier descriptor. */
  148. __ALIGN_BEGIN uint8_t USBD_LangIDDesc[USB_LEN_LANGID_STR_DESC] __ALIGN_END =
  149. {
  150. USB_LEN_LANGID_STR_DESC,
  151. USB_DESC_TYPE_STRING,
  152. LOBYTE(USBD_LANGID_STRING),
  153. HIBYTE(USBD_LANGID_STRING)
  154. };
  155. #if defined ( __ICCARM__ ) /* IAR Compiler */
  156. #pragma data_alignment=4
  157. #endif /* defined ( __ICCARM__ ) */
  158. /* Internal string descriptor. */
  159. __ALIGN_BEGIN uint8_t USBD_StrDesc[USBD_MAX_STR_DESC_SIZ] __ALIGN_END;
  160. #if defined ( __ICCARM__ ) /*!< IAR Compiler */
  161. #pragma data_alignment=4
  162. #endif
  163. __ALIGN_BEGIN uint8_t USBD_StringSerial[USB_SIZ_STRING_SERIAL] __ALIGN_END = {
  164. USB_SIZ_STRING_SERIAL,
  165. USB_DESC_TYPE_STRING,
  166. };
  167. /**
  168. * @}
  169. */
  170. /** @defgroup USBD_DESC_Private_Functions USBD_DESC_Private_Functions
  171. * @brief Private functions.
  172. * @{
  173. */
  174. /**
  175. * @brief Return the device descriptor
  176. * @param speed : Current device speed
  177. * @param length : Pointer to data length variable
  178. * @retval Pointer to descriptor buffer
  179. */
  180. uint8_t * USBD_FS_DeviceDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  181. {
  182. UNUSED(speed);
  183. *length = sizeof(USBD_FS_DeviceDesc);
  184. return USBD_FS_DeviceDesc;
  185. }
  186. /**
  187. * @brief Return the LangID string descriptor
  188. * @param speed : Current device speed
  189. * @param length : Pointer to data length variable
  190. * @retval Pointer to descriptor buffer
  191. */
  192. uint8_t * USBD_FS_LangIDStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  193. {
  194. UNUSED(speed);
  195. *length = sizeof(USBD_LangIDDesc);
  196. return USBD_LangIDDesc;
  197. }
  198. /**
  199. * @brief Return the product string descriptor
  200. * @param speed : Current device speed
  201. * @param length : Pointer to data length variable
  202. * @retval Pointer to descriptor buffer
  203. */
  204. uint8_t * USBD_FS_ProductStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  205. {
  206. if(speed == 0)
  207. {
  208. USBD_GetString((uint8_t *)USBD_PRODUCT_STRING_FS, USBD_StrDesc, length);
  209. }
  210. else
  211. {
  212. USBD_GetString((uint8_t *)USBD_PRODUCT_STRING_FS, USBD_StrDesc, length);
  213. }
  214. return USBD_StrDesc;
  215. }
  216. /**
  217. * @brief Return the manufacturer string descriptor
  218. * @param speed : Current device speed
  219. * @param length : Pointer to data length variable
  220. * @retval Pointer to descriptor buffer
  221. */
  222. uint8_t * USBD_FS_ManufacturerStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  223. {
  224. UNUSED(speed);
  225. USBD_GetString((uint8_t *)USBD_MANUFACTURER_STRING, USBD_StrDesc, length);
  226. return USBD_StrDesc;
  227. }
  228. /**
  229. * @brief Return the serial number string descriptor
  230. * @param speed : Current device speed
  231. * @param length : Pointer to data length variable
  232. * @retval Pointer to descriptor buffer
  233. */
  234. uint8_t * USBD_FS_SerialStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  235. {
  236. UNUSED(speed);
  237. *length = USB_SIZ_STRING_SERIAL;
  238. /* Update the serial number string descriptor with the data from the unique
  239. * ID */
  240. Get_SerialNum();
  241. /* USER CODE BEGIN USBD_FS_SerialStrDescriptor */
  242. /* USER CODE END USBD_FS_SerialStrDescriptor */
  243. return (uint8_t *) USBD_StringSerial;
  244. }
  245. /**
  246. * @brief Return the configuration string descriptor
  247. * @param speed : Current device speed
  248. * @param length : Pointer to data length variable
  249. * @retval Pointer to descriptor buffer
  250. */
  251. uint8_t * USBD_FS_ConfigStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  252. {
  253. if(speed == USBD_SPEED_HIGH)
  254. {
  255. USBD_GetString((uint8_t *)USBD_CONFIGURATION_STRING_FS, USBD_StrDesc, length);
  256. }
  257. else
  258. {
  259. USBD_GetString((uint8_t *)USBD_CONFIGURATION_STRING_FS, USBD_StrDesc, length);
  260. }
  261. return USBD_StrDesc;
  262. }
  263. /**
  264. * @brief Return the interface string descriptor
  265. * @param speed : Current device speed
  266. * @param length : Pointer to data length variable
  267. * @retval Pointer to descriptor buffer
  268. */
  269. uint8_t * USBD_FS_InterfaceStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  270. {
  271. if(speed == 0)
  272. {
  273. USBD_GetString((uint8_t *)USBD_INTERFACE_STRING_FS, USBD_StrDesc, length);
  274. }
  275. else
  276. {
  277. USBD_GetString((uint8_t *)USBD_INTERFACE_STRING_FS, USBD_StrDesc, length);
  278. }
  279. return USBD_StrDesc;
  280. }
  281. /**
  282. * @brief Create the serial number string descriptor
  283. * @param None
  284. * @retval None
  285. */
  286. static void Get_SerialNum(void)
  287. {
  288. uint32_t deviceserial0;
  289. uint32_t deviceserial1;
  290. uint32_t deviceserial2;
  291. deviceserial0 = *(uint32_t *) DEVICE_ID1;
  292. deviceserial1 = *(uint32_t *) DEVICE_ID2;
  293. deviceserial2 = *(uint32_t *) DEVICE_ID3;
  294. deviceserial0 += deviceserial2;
  295. if (deviceserial0 != 0)
  296. {
  297. IntToUnicode(deviceserial0, &USBD_StringSerial[2], 8);
  298. IntToUnicode(deviceserial1, &USBD_StringSerial[18], 4);
  299. }
  300. }
  301. /**
  302. * @brief Convert Hex 32Bits value into char
  303. * @param value: value to convert
  304. * @param pbuf: pointer to the buffer
  305. * @param len: buffer length
  306. * @retval None
  307. */
  308. static void IntToUnicode(uint32_t value, uint8_t * pbuf, uint8_t len)
  309. {
  310. uint8_t idx = 0;
  311. for (idx = 0; idx < len; idx++)
  312. {
  313. if (((value >> 28)) < 0xA)
  314. {
  315. pbuf[2 * idx] = (value >> 28) + '0';
  316. }
  317. else
  318. {
  319. pbuf[2 * idx] = (value >> 28) + 'A' - 10;
  320. }
  321. value = value << 4;
  322. pbuf[2 * idx + 1] = 0;
  323. }
  324. }
  325. /**
  326. * @}
  327. */
  328. /**
  329. * @}
  330. */
  331. /**
  332. * @}
  333. */