usbd_desc.c 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595
  1. /* USER CODE BEGIN Header */
  2. /**
  3. ******************************************************************************
  4. * @file : usbd_desc.c
  5. * @version : v1.0_Cube
  6. * @brief : This file implements the USB device descriptors.
  7. ******************************************************************************
  8. * @attention
  9. *
  10. * <h2><center>&copy; Copyright (c) 2021 STMicroelectronics.
  11. * All rights reserved.</center></h2>
  12. *
  13. * This software component is licensed by ST under Ultimate Liberty license
  14. * SLA0044, the "License"; You may not use this file except in compliance with
  15. * the License. You may obtain a copy of the License at:
  16. * www.st.com/SLA0044
  17. *
  18. ******************************************************************************
  19. */
  20. /* USER CODE END Header */
  21. /* Includes ------------------------------------------------------------------*/
  22. #include "usbd_core.h"
  23. #include "usbd_desc.h"
  24. #include "usbd_conf.h"
  25. /* USER CODE BEGIN INCLUDE */
  26. /* USER CODE END INCLUDE */
  27. /* Private typedef -----------------------------------------------------------*/
  28. /* Private define ------------------------------------------------------------*/
  29. /* Private macro -------------------------------------------------------------*/
  30. /* USER CODE BEGIN PV */
  31. /* Private variables ---------------------------------------------------------*/
  32. /* USER CODE END PV */
  33. /** @addtogroup STM32_USB_OTG_DEVICE_LIBRARY
  34. * @{
  35. */
  36. /** @addtogroup USBD_DESC
  37. * @{
  38. */
  39. /** @defgroup USBD_DESC_Private_TypesDefinitions USBD_DESC_Private_TypesDefinitions
  40. * @brief Private types.
  41. * @{
  42. */
  43. /* USER CODE BEGIN PRIVATE_TYPES */
  44. /* USER CODE END PRIVATE_TYPES */
  45. /**
  46. * @}
  47. */
  48. /** @defgroup USBD_DESC_Private_Defines USBD_DESC_Private_Defines
  49. * @brief Private defines.
  50. * @{
  51. */
  52. #define USBD_VID 1155
  53. #define USBD_LANGID_STRING 1033
  54. #define USBD_MANUFACTURER_STRING "STMicroelectronics"
  55. #define USBD_PID_HS 22314
  56. #define USBD_PRODUCT_STRING_HS "STM32 Mass Storage"
  57. #define USBD_CONFIGURATION_STRING_HS "MSC Config"
  58. #define USBD_INTERFACE_STRING_HS "MSC Interface"
  59. #define USBD_PID_FS 22314
  60. #define USBD_PRODUCT_STRING_FS "STM32 Mass Storage"
  61. #define USBD_CONFIGURATION_STRING_FS "MSC Config"
  62. #define USBD_INTERFACE_STRING_FS "MSC Interface"
  63. /* USER CODE BEGIN PRIVATE_DEFINES */
  64. /* USER CODE END PRIVATE_DEFINES */
  65. /**
  66. * @}
  67. */
  68. /* USER CODE BEGIN 0 */
  69. /* USER CODE END 0 */
  70. /** @defgroup USBD_DESC_Private_Macros USBD_DESC_Private_Macros
  71. * @brief Private macros.
  72. * @{
  73. */
  74. /* USER CODE BEGIN PRIVATE_MACRO */
  75. /* USER CODE END PRIVATE_MACRO */
  76. /**
  77. * @}
  78. */
  79. /** @defgroup USBD_DESC_Private_FunctionPrototypes USBD_DESC_Private_FunctionPrototypes
  80. * @brief Private functions declaration.
  81. * @{
  82. */
  83. static void Get_SerialNum(void);
  84. static void IntToUnicode(uint32_t value, uint8_t * pbuf, uint8_t len);
  85. /**
  86. * @}
  87. */
  88. /** @defgroup USBD_DESC_Private_FunctionPrototypes USBD_DESC_Private_FunctionPrototypes
  89. * @brief Private functions declaration for FS.
  90. * @{
  91. */
  92. uint8_t * USBD_FS_DeviceDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  93. uint8_t * USBD_FS_LangIDStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  94. uint8_t * USBD_FS_ManufacturerStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  95. uint8_t * USBD_FS_ProductStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  96. uint8_t * USBD_FS_SerialStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  97. uint8_t * USBD_FS_ConfigStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  98. uint8_t * USBD_FS_InterfaceStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  99. /**
  100. * @}
  101. */
  102. /** @defgroup USBD_DESC_Private_Variables USBD_DESC_Private_Variables
  103. * @brief Private variables.
  104. * @{
  105. */
  106. USBD_DescriptorsTypeDef FS_Desc =
  107. {
  108. USBD_FS_DeviceDescriptor
  109. , USBD_FS_LangIDStrDescriptor
  110. , USBD_FS_ManufacturerStrDescriptor
  111. , USBD_FS_ProductStrDescriptor
  112. , USBD_FS_SerialStrDescriptor
  113. , USBD_FS_ConfigStrDescriptor
  114. , USBD_FS_InterfaceStrDescriptor
  115. };
  116. #if defined ( __ICCARM__ ) /* IAR Compiler */
  117. #pragma data_alignment=4
  118. #endif /* defined ( __ICCARM__ ) */
  119. /** USB standard device descriptor. */
  120. __ALIGN_BEGIN uint8_t USBD_FS_DeviceDesc[USB_LEN_DEV_DESC] __ALIGN_END =
  121. {
  122. 0x12, /*bLength */
  123. USB_DESC_TYPE_DEVICE, /*bDescriptorType*/
  124. 0x00, /*bcdUSB */
  125. 0x02,
  126. 0x00, /*bDeviceClass*/
  127. 0x00, /*bDeviceSubClass*/
  128. 0x00, /*bDeviceProtocol*/
  129. USB_MAX_EP0_SIZE, /*bMaxPacketSize*/
  130. LOBYTE(USBD_VID), /*idVendor*/
  131. HIBYTE(USBD_VID), /*idVendor*/
  132. LOBYTE(USBD_PID_FS), /*idProduct*/
  133. HIBYTE(USBD_PID_FS), /*idProduct*/
  134. 0x00, /*bcdDevice rel. 2.00*/
  135. 0x02,
  136. USBD_IDX_MFC_STR, /*Index of manufacturer string*/
  137. USBD_IDX_PRODUCT_STR, /*Index of product string*/
  138. USBD_IDX_SERIAL_STR, /*Index of serial number string*/
  139. USBD_MAX_NUM_CONFIGURATION /*bNumConfigurations*/
  140. };
  141. /* USB_DeviceDescriptor */
  142. /**
  143. * @}
  144. */
  145. /** @defgroup USBD_DESC_Private_FunctionPrototypes USBD_DESC_Private_FunctionPrototypes
  146. * @brief Private functions declaration for HS.
  147. * @{
  148. */
  149. uint8_t * USBD_HS_DeviceDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  150. uint8_t * USBD_HS_LangIDStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  151. uint8_t * USBD_HS_ManufacturerStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  152. uint8_t * USBD_HS_ProductStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  153. uint8_t * USBD_HS_SerialStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  154. uint8_t * USBD_HS_ConfigStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  155. uint8_t * USBD_HS_InterfaceStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
  156. /**
  157. * @}
  158. */
  159. /** @defgroup USBD_DESC_Private_Variables USBD_DESC_Private_Variables
  160. * @brief Private variables.
  161. * @{
  162. */
  163. USBD_DescriptorsTypeDef HS_Desc =
  164. {
  165. USBD_HS_DeviceDescriptor
  166. , USBD_HS_LangIDStrDescriptor
  167. , USBD_HS_ManufacturerStrDescriptor
  168. , USBD_HS_ProductStrDescriptor
  169. , USBD_HS_SerialStrDescriptor
  170. , USBD_HS_ConfigStrDescriptor
  171. , USBD_HS_InterfaceStrDescriptor
  172. };
  173. #if defined ( __ICCARM__ ) /* IAR Compiler */
  174. #pragma data_alignment=4
  175. #endif /* defined ( __ICCARM__ ) */
  176. /** USB standard device descriptor. */
  177. __ALIGN_BEGIN uint8_t USBD_HS_DeviceDesc[USB_LEN_DEV_DESC] __ALIGN_END =
  178. {
  179. 0x12, /*bLength */
  180. USB_DESC_TYPE_DEVICE, /*bDescriptorType*/
  181. 0x00, /*bcdUSB */
  182. 0x02,
  183. 0x00, /*bDeviceClass*/
  184. 0x00, /*bDeviceSubClass*/
  185. 0x00, /*bDeviceProtocol*/
  186. USB_MAX_EP0_SIZE, /*bMaxPacketSize*/
  187. LOBYTE(USBD_VID), /*idVendor*/
  188. HIBYTE(USBD_VID), /*idVendor*/
  189. LOBYTE(USBD_PID_HS), /*idProduct*/
  190. HIBYTE(USBD_PID_HS), /*idProduct*/
  191. 0x00, /*bcdDevice rel. 2.00*/
  192. 0x02,
  193. USBD_IDX_MFC_STR, /*Index of manufacturer string*/
  194. USBD_IDX_PRODUCT_STR, /*Index of product string*/
  195. USBD_IDX_SERIAL_STR, /*Index of serial number string*/
  196. USBD_MAX_NUM_CONFIGURATION /*bNumConfigurations*/
  197. };
  198. /**
  199. * @}
  200. */
  201. /** @defgroup USBD_DESC_Private_Variables USBD_DESC_Private_Variables
  202. * @brief Private variables.
  203. * @{
  204. */
  205. #if defined ( __ICCARM__ ) /* IAR Compiler */
  206. #pragma data_alignment=4
  207. #endif /* defined ( __ICCARM__ ) */
  208. /** USB lang indentifier descriptor. */
  209. __ALIGN_BEGIN uint8_t USBD_LangIDDesc[USB_LEN_LANGID_STR_DESC] __ALIGN_END =
  210. {
  211. USB_LEN_LANGID_STR_DESC,
  212. USB_DESC_TYPE_STRING,
  213. LOBYTE(USBD_LANGID_STRING),
  214. HIBYTE(USBD_LANGID_STRING)
  215. };
  216. #if defined ( __ICCARM__ ) /* IAR Compiler */
  217. #pragma data_alignment=4
  218. #endif /* defined ( __ICCARM__ ) */
  219. /* Internal string descriptor. */
  220. __ALIGN_BEGIN uint8_t USBD_StrDesc[USBD_MAX_STR_DESC_SIZ] __ALIGN_END;
  221. #if defined ( __ICCARM__ ) /*!< IAR Compiler */
  222. #pragma data_alignment=4
  223. #endif
  224. __ALIGN_BEGIN uint8_t USBD_StringSerial[USB_SIZ_STRING_SERIAL] __ALIGN_END = {
  225. USB_SIZ_STRING_SERIAL,
  226. USB_DESC_TYPE_STRING,
  227. };
  228. /**
  229. * @}
  230. */
  231. /** @defgroup USBD_DESC_Private_Functions USBD_DESC_Private_Functions
  232. * @brief Private functions.
  233. * @{
  234. */
  235. /**
  236. * @brief Return the device descriptor
  237. * @param speed : Current device speed
  238. * @param length : Pointer to data length variable
  239. * @retval Pointer to descriptor buffer
  240. */
  241. uint8_t * USBD_HS_DeviceDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  242. {
  243. UNUSED(speed);
  244. *length = sizeof(USBD_HS_DeviceDesc);
  245. return USBD_HS_DeviceDesc;
  246. }
  247. /**
  248. * @brief Return the LangID string descriptor
  249. * @param speed : Current device speed
  250. * @param length : Pointer to data length variable
  251. * @retval Pointer to descriptor buffer
  252. */
  253. uint8_t * USBD_HS_LangIDStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  254. {
  255. UNUSED(speed);
  256. *length = sizeof(USBD_LangIDDesc);
  257. return USBD_LangIDDesc;
  258. }
  259. /**
  260. * @brief Return the product string descriptor
  261. * @param speed : current device speed
  262. * @param length : pointer to data length variable
  263. * @retval pointer to descriptor buffer
  264. */
  265. uint8_t * USBD_HS_ProductStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  266. {
  267. if(speed == 0)
  268. {
  269. USBD_GetString((uint8_t *)USBD_PRODUCT_STRING_HS, USBD_StrDesc, length);
  270. }
  271. else
  272. {
  273. USBD_GetString((uint8_t *)USBD_PRODUCT_STRING_HS, USBD_StrDesc, length);
  274. }
  275. return USBD_StrDesc;
  276. }
  277. /**
  278. * @brief Return the manufacturer string descriptor
  279. * @param speed : Current device speed
  280. * @param length : Pointer to data length variable
  281. * @retval Pointer to descriptor buffer
  282. */
  283. uint8_t * USBD_HS_ManufacturerStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  284. {
  285. UNUSED(speed);
  286. USBD_GetString((uint8_t *)USBD_MANUFACTURER_STRING, USBD_StrDesc, length);
  287. return USBD_StrDesc;
  288. }
  289. /**
  290. * @brief Return the serial number string descriptor
  291. * @param speed : Current device speed
  292. * @param length : Pointer to data length variable
  293. * @retval Pointer to descriptor buffer
  294. */
  295. uint8_t * USBD_HS_SerialStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  296. {
  297. UNUSED(speed);
  298. *length = USB_SIZ_STRING_SERIAL;
  299. /* Update the serial number string descriptor with the data from the unique
  300. * ID */
  301. Get_SerialNum();
  302. /* USER CODE BEGIN USBD_HS_SerialStrDescriptor */
  303. /* USER CODE END USBD_HS_SerialStrDescriptor */
  304. return (uint8_t *) USBD_StringSerial;
  305. }
  306. /**
  307. * @brief Return the configuration string descriptor
  308. * @param speed : Current device speed
  309. * @param length : Pointer to data length variable
  310. * @retval Pointer to descriptor buffer
  311. */
  312. uint8_t * USBD_HS_ConfigStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  313. {
  314. if(speed == USBD_SPEED_HIGH)
  315. {
  316. USBD_GetString((uint8_t *)USBD_CONFIGURATION_STRING_HS, USBD_StrDesc, length);
  317. }
  318. else
  319. {
  320. USBD_GetString((uint8_t *)USBD_CONFIGURATION_STRING_HS, USBD_StrDesc, length);
  321. }
  322. return USBD_StrDesc;
  323. }
  324. /**
  325. * @brief Return the interface string descriptor
  326. * @param speed : Current device speed
  327. * @param length : Pointer to data length variable
  328. * @retval Pointer to descriptor buffer
  329. */
  330. uint8_t * USBD_HS_InterfaceStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  331. {
  332. if(speed == 0)
  333. {
  334. USBD_GetString((uint8_t *)USBD_INTERFACE_STRING_HS, USBD_StrDesc, length);
  335. }
  336. else
  337. {
  338. USBD_GetString((uint8_t *)USBD_INTERFACE_STRING_HS, USBD_StrDesc, length);
  339. }
  340. return USBD_StrDesc;
  341. }
  342. #if (USBD_LPM_ENABLED == 1)
  343. /**
  344. * @brief Return the BOS descriptor
  345. * @param speed : Current device speed
  346. * @param length : Pointer to data length variable
  347. * @retval Pointer to descriptor buffer
  348. */
  349. uint8_t * USBD_HS_USR_BOSDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  350. {
  351. UNUSED(speed);
  352. *length = sizeof(USBD_HS_BOSDesc);
  353. return (uint8_t*)USBD_HS_BOSDesc;
  354. }
  355. #endif /* (USBD_LPM_ENABLED == 1) */
  356. /**
  357. * @brief Return the device descriptor
  358. * @param speed : Current device speed
  359. * @param length : Pointer to data length variable
  360. * @retval Pointer to descriptor buffer
  361. */
  362. uint8_t * USBD_FS_DeviceDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  363. {
  364. UNUSED(speed);
  365. *length = sizeof(USBD_FS_DeviceDesc);
  366. return USBD_FS_DeviceDesc;
  367. }
  368. /**
  369. * @brief Return the LangID string descriptor
  370. * @param speed : Current device speed
  371. * @param length : Pointer to data length variable
  372. * @retval Pointer to descriptor buffer
  373. */
  374. uint8_t * USBD_FS_LangIDStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  375. {
  376. UNUSED(speed);
  377. *length = sizeof(USBD_LangIDDesc);
  378. return USBD_LangIDDesc;
  379. }
  380. /**
  381. * @brief Return the product string descriptor
  382. * @param speed : Current device speed
  383. * @param length : Pointer to data length variable
  384. * @retval Pointer to descriptor buffer
  385. */
  386. uint8_t * USBD_FS_ProductStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  387. {
  388. if(speed == 0)
  389. {
  390. USBD_GetString((uint8_t *)USBD_PRODUCT_STRING_FS, USBD_StrDesc, length);
  391. }
  392. else
  393. {
  394. USBD_GetString((uint8_t *)USBD_PRODUCT_STRING_FS, USBD_StrDesc, length);
  395. }
  396. return USBD_StrDesc;
  397. }
  398. /**
  399. * @brief Return the manufacturer string descriptor
  400. * @param speed : Current device speed
  401. * @param length : Pointer to data length variable
  402. * @retval Pointer to descriptor buffer
  403. */
  404. uint8_t * USBD_FS_ManufacturerStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  405. {
  406. UNUSED(speed);
  407. USBD_GetString((uint8_t *)USBD_MANUFACTURER_STRING, USBD_StrDesc, length);
  408. return USBD_StrDesc;
  409. }
  410. /**
  411. * @brief Return the serial number string descriptor
  412. * @param speed : Current device speed
  413. * @param length : Pointer to data length variable
  414. * @retval Pointer to descriptor buffer
  415. */
  416. uint8_t * USBD_FS_SerialStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  417. {
  418. UNUSED(speed);
  419. *length = USB_SIZ_STRING_SERIAL;
  420. /* Update the serial number string descriptor with the data from the unique
  421. * ID */
  422. Get_SerialNum();
  423. /* USER CODE BEGIN USBD_FS_SerialStrDescriptor */
  424. /* USER CODE END USBD_FS_SerialStrDescriptor */
  425. return (uint8_t *) USBD_StringSerial;
  426. }
  427. /**
  428. * @brief Return the configuration string descriptor
  429. * @param speed : Current device speed
  430. * @param length : Pointer to data length variable
  431. * @retval Pointer to descriptor buffer
  432. */
  433. uint8_t * USBD_FS_ConfigStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  434. {
  435. if(speed == USBD_SPEED_HIGH)
  436. {
  437. USBD_GetString((uint8_t *)USBD_CONFIGURATION_STRING_FS, USBD_StrDesc, length);
  438. }
  439. else
  440. {
  441. USBD_GetString((uint8_t *)USBD_CONFIGURATION_STRING_FS, USBD_StrDesc, length);
  442. }
  443. return USBD_StrDesc;
  444. }
  445. /**
  446. * @brief Return the interface string descriptor
  447. * @param speed : Current device speed
  448. * @param length : Pointer to data length variable
  449. * @retval Pointer to descriptor buffer
  450. */
  451. uint8_t * USBD_FS_InterfaceStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
  452. {
  453. if(speed == 0)
  454. {
  455. USBD_GetString((uint8_t *)USBD_INTERFACE_STRING_FS, USBD_StrDesc, length);
  456. }
  457. else
  458. {
  459. USBD_GetString((uint8_t *)USBD_INTERFACE_STRING_FS, USBD_StrDesc, length);
  460. }
  461. return USBD_StrDesc;
  462. }
  463. /**
  464. * @brief Create the serial number string descriptor
  465. * @param None
  466. * @retval None
  467. */
  468. static void Get_SerialNum(void)
  469. {
  470. uint32_t deviceserial0, deviceserial1, deviceserial2;
  471. deviceserial0 = *(uint32_t *) DEVICE_ID1;
  472. deviceserial1 = *(uint32_t *) DEVICE_ID2;
  473. deviceserial2 = *(uint32_t *) DEVICE_ID3;
  474. deviceserial0 += deviceserial2;
  475. if (deviceserial0 != 0)
  476. {
  477. IntToUnicode(deviceserial0, &USBD_StringSerial[2], 8);
  478. IntToUnicode(deviceserial1, &USBD_StringSerial[18], 4);
  479. }
  480. }
  481. /**
  482. * @brief Convert Hex 32Bits value into char
  483. * @param value: value to convert
  484. * @param pbuf: pointer to the buffer
  485. * @param len: buffer length
  486. * @retval None
  487. */
  488. static void IntToUnicode(uint32_t value, uint8_t * pbuf, uint8_t len)
  489. {
  490. uint8_t idx = 0;
  491. for (idx = 0; idx < len; idx++)
  492. {
  493. if (((value >> 28)) < 0xA)
  494. {
  495. pbuf[2 * idx] = (value >> 28) + '0';
  496. }
  497. else
  498. {
  499. pbuf[2 * idx] = (value >> 28) + 'A' - 10;
  500. }
  501. value = value << 4;
  502. pbuf[2 * idx + 1] = 0;
  503. }
  504. }
  505. /**
  506. * @}
  507. */
  508. /**
  509. * @}
  510. */
  511. /**
  512. * @}
  513. */
  514. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/