Fix error in merging 2020 board files
[SCSI2SD-V6.git] / src / firmware / usb_device / usbd_desc.c
1 /**
2   ******************************************************************************
3   * @file           : usbd_desc.c
4   * @version        : v1.0_Cube
5   * @brief          : This file implements the USB Device descriptors
6   ******************************************************************************
7   *
8   * COPYRIGHT(c) 2016 STMicroelectronics
9   *
10   * Redistribution and use in source and binary forms, with or without modification,
11   * are permitted provided that the following conditions are met:
12   * 1. Redistributions of source code must retain the above copyright notice,
13   * this list of conditions and the following disclaimer.
14   * 2. Redistributions in binary form must reproduce the above copyright notice,
15   * this list of conditions and the following disclaimer in the documentation
16   * and/or other materials provided with the distribution.
17   * 3. Neither the name of STMicroelectronics nor the names of its contributors
18   * may be used to endorse or promote products derived from this software
19   * without specific prior written permission.
20   *
21   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31   *
32   ******************************************************************************
33 */
34
35 /* Includes ------------------------------------------------------------------*/
36 #include "usbd_core.h"
37 #include "usbd_desc.h"
38 #include "usbd_conf.h"
39
40 /** @addtogroup STM32_USB_OTG_DEVICE_LIBRARY
41   * @{
42   */
43
44 /** @defgroup USBD_DESC 
45   * @brief USBD descriptors module
46   * @{
47   */ 
48
49 /** @defgroup USBD_DESC_Private_TypesDefinitions
50   * @{
51   */ 
52 /**
53   * @}
54   */ 
55
56 /** @defgroup USBD_DESC_Private_Defines
57   * @{
58   */ 
59 #define USBD_VID                         0x16D0
60 #define USBD_LANGID_STRING               1033
61 #define USBD_MANUFACTURER_STRING         (uint8_t*)"codesrc.com"
62 #define USBD_PID_FS                      0x0BD4
63 #define USBD_PRODUCT_STRING_FS           (uint8_t*)"SCSI2SD"
64 #define USBD_CONFIGURATION_STRING_FS     (uint8_t*)"SCSI2SD Config"
65 #define USBD_INTERFACE_STRING_FS         (uint8_t*)"SCSI2SD Interface"
66
67 /**
68   * @}
69   */ 
70
71 /** @defgroup USBD_DESC_Private_Macros
72   * @{
73   */ 
74
75 static void Get_SerialNum(void);
76 static void IntToUnicode(uint32_t value, uint8_t * pbuf, uint8_t len);
77
78 /**
79   * @}
80   */ 
81
82 /** @defgroup USBD_DESC_Private_Variables
83   * @{
84   */ 
85 uint8_t *     USBD_FS_DeviceDescriptor( USBD_SpeedTypeDef speed , uint16_t *length);
86 uint8_t *     USBD_FS_LangIDStrDescriptor( USBD_SpeedTypeDef speed , uint16_t *length);
87 uint8_t *     USBD_FS_ManufacturerStrDescriptor ( USBD_SpeedTypeDef speed , uint16_t *length);
88 uint8_t *     USBD_FS_ProductStrDescriptor ( USBD_SpeedTypeDef speed , uint16_t *length);
89 uint8_t *     USBD_FS_SerialStrDescriptor( USBD_SpeedTypeDef speed , uint16_t *length);
90 uint8_t *     USBD_FS_ConfigStrDescriptor( USBD_SpeedTypeDef speed , uint16_t *length);
91 uint8_t *     USBD_FS_InterfaceStrDescriptor( USBD_SpeedTypeDef speed , uint16_t *length);
92
93 #ifdef USB_SUPPORT_USER_STRING_DESC
94 uint8_t *     USBD_FS_USRStringDesc (USBD_SpeedTypeDef speed, uint8_t idx , uint16_t *length);  
95 #endif /* USB_SUPPORT_USER_STRING_DESC */  
96
97 USBD_DescriptorsTypeDef FS_Desc =
98 {
99   USBD_FS_DeviceDescriptor,
100   USBD_FS_LangIDStrDescriptor, 
101   USBD_FS_ManufacturerStrDescriptor,
102   USBD_FS_ProductStrDescriptor,
103   USBD_FS_SerialStrDescriptor,
104   USBD_FS_ConfigStrDescriptor,
105   USBD_FS_InterfaceStrDescriptor,
106 };
107
108 #if defined ( __ICCARM__ ) /*!< IAR Compiler */
109   #pragma data_alignment=4   
110 #endif
111 /* USB Standard Device Descriptor */
112 __ALIGN_BEGIN uint8_t USBD_FS_DeviceDesc[USB_LEN_DEV_DESC] __ALIGN_END =
113   {
114     0x12,                       /*bLength */
115     USB_DESC_TYPE_DEVICE,       /*bDescriptorType*/
116     0x00,                       /* bcdUSB */  
117     0x02,
118     0x00,                       /*bDeviceClass*/
119     0x00,                       /*bDeviceSubClass*/
120     0x00,                       /*bDeviceProtocol*/
121     USB_MAX_EP0_SIZE,          /*bMaxPacketSize*/
122     LOBYTE(USBD_VID),           /*idVendor*/
123     HIBYTE(USBD_VID),           /*idVendor*/
124     LOBYTE(USBD_PID_FS),           /*idVendor*/
125     HIBYTE(USBD_PID_FS),           /*idVendor*/
126     0x00,                       /*bcdDevice rel. 2.00*/
127     0x02,
128     USBD_IDX_MFC_STR,           /*Index of manufacturer  string*/
129     USBD_IDX_PRODUCT_STR,       /*Index of product string*/
130     USBD_IDX_SERIAL_STR,        /*Index of serial number string*/
131     USBD_MAX_NUM_CONFIGURATION  /*bNumConfigurations*/
132   } ; 
133 /* USB_DeviceDescriptor */
134
135 #if defined ( __ICCARM__ ) /*!< IAR Compiler */
136   #pragma data_alignment=4   
137 #endif
138
139 /* USB Standard Device Descriptor */
140 __ALIGN_BEGIN uint8_t USBD_LangIDDesc[USB_LEN_LANGID_STR_DESC] __ALIGN_END =
141 {
142      USB_LEN_LANGID_STR_DESC,         
143      USB_DESC_TYPE_STRING,       
144      LOBYTE(USBD_LANGID_STRING),
145      HIBYTE(USBD_LANGID_STRING), 
146 };
147
148 #if defined ( __ICCARM__ ) /*!< IAR Compiler */
149   #pragma data_alignment=4   
150 #endif
151 __ALIGN_BEGIN uint8_t USBD_StrDesc[USBD_MAX_STR_DESC_SIZ] __ALIGN_END;
152 /**
153   * @}
154   */ 
155
156 /** @defgroup USBD_DESC_Private_FunctionPrototypes
157   * @{
158   */ 
159
160 #define  USB_SIZ_STRING_SERIAL       0x1A
161 __ALIGN_BEGIN uint8_t USBD_StringSerial[USB_SIZ_STRING_SERIAL] __ALIGN_END = {
162   USB_SIZ_STRING_SERIAL,
163   USB_DESC_TYPE_STRING,
164 };
165
166 /**
167   * @}
168   */ 
169
170 /** @defgroup USBD_DESC_Private_Functions
171   * @{
172   */ 
173
174 /**
175 * @brief  USBD_FS_DeviceDescriptor 
176 *         return the device descriptor
177 * @param  speed : current device speed
178 * @param  length : pointer to data length variable
179 * @retval pointer to descriptor buffer
180 */
181 uint8_t *  USBD_FS_DeviceDescriptor( USBD_SpeedTypeDef speed , uint16_t *length)
182 {
183   *length = sizeof(USBD_FS_DeviceDesc);
184   return USBD_FS_DeviceDesc;
185 }
186
187 /**
188 * @brief  USBD_FS_LangIDStrDescriptor 
189 *         return the LangID string descriptor
190 * @param  speed : current device speed
191 * @param  length : pointer to data length variable
192 * @retval pointer to descriptor buffer
193 */
194 uint8_t *  USBD_FS_LangIDStrDescriptor( USBD_SpeedTypeDef speed , uint16_t *length)
195 {
196   *length =  sizeof(USBD_LangIDDesc);  
197   return USBD_LangIDDesc;
198 }
199
200 /**
201 * @brief  USBD_FS_ProductStrDescriptor 
202 *         return the product string descriptor
203 * @param  speed : current device speed
204 * @param  length : pointer to data length variable
205 * @retval pointer to descriptor buffer
206 */
207 uint8_t *  USBD_FS_ProductStrDescriptor( USBD_SpeedTypeDef speed , uint16_t *length)
208 {
209   if(speed == 0)
210   {   
211     USBD_GetString (USBD_PRODUCT_STRING_FS, USBD_StrDesc, length);
212   }
213   else
214   {
215     USBD_GetString (USBD_PRODUCT_STRING_FS, USBD_StrDesc, length);    
216   }
217   return USBD_StrDesc;
218 }
219
220 /**
221 * @brief  USBD_FS_ManufacturerStrDescriptor 
222 *         return the manufacturer string descriptor
223 * @param  speed : current device speed
224 * @param  length : pointer to data length variable
225 * @retval pointer to descriptor buffer
226 */
227 uint8_t *  USBD_FS_ManufacturerStrDescriptor( USBD_SpeedTypeDef speed , uint16_t *length)
228 {
229   USBD_GetString (USBD_MANUFACTURER_STRING, USBD_StrDesc, length);
230   return USBD_StrDesc;
231 }
232
233 /**
234 * @brief  USBD_FS_SerialStrDescriptor 
235 *         return the serial number string descriptor
236 * @param  speed : current device speed
237 * @param  length : pointer to data length variable
238 * @retval pointer to descriptor buffer
239 */
240 uint8_t *  USBD_FS_SerialStrDescriptor( USBD_SpeedTypeDef speed , uint16_t *length)
241 {
242         *length = USB_SIZ_STRING_SERIAL;
243
244         // Update the serial number string descriptor with the data from the unique
245         // ID
246         Get_SerialNum();
247
248         return (uint8_t *) USBD_StringSerial;
249 }
250
251 /**
252  * @brief  Create the serial number string descriptor
253  * @param  None
254  * @retval None
255  */
256 static void Get_SerialNum(void)
257 {
258         uint32_t deviceserial0, deviceserial1, deviceserial2;
259
260 // UID_BASE good for STM32F2 and F4
261 #define                 UID_BASE                        0x1FFF7A10
262 #define         DEVICE_ID1          (UID_BASE)
263 #define         DEVICE_ID2          (UID_BASE + 0x4)
264 #define         DEVICE_ID3          (UID_BASE + 0x8)
265
266         deviceserial0 = *(uint32_t *) DEVICE_ID1;
267         deviceserial1 = *(uint32_t *) DEVICE_ID2;
268         deviceserial2 = *(uint32_t *) DEVICE_ID3;
269
270         deviceserial0 += deviceserial2;
271
272         if (deviceserial0 != 0)
273         {
274                 IntToUnicode(deviceserial0, &USBD_StringSerial[2], 8);
275                 IntToUnicode(deviceserial1, &USBD_StringSerial[18], 4);
276         }
277 }
278
279 /**
280  * @brief  Convert Hex 32Bits value into char
281  * @param  value: value to convert
282  * @param  pbuf: pointer to the buffer
283  * @param  len: buffer length
284  * @retval None
285  */
286 static void IntToUnicode(uint32_t value, uint8_t * pbuf, uint8_t len)
287 {
288         uint8_t idx = 0;
289
290         for (idx = 0; idx < len; idx++)
291         {
292                 if (((value >> 28)) < 0xA)
293                 {
294                         pbuf[2 * idx] = (value >> 28) + '0';
295                 }
296                 else
297                 {
298                         pbuf[2 * idx] = (value >> 28) + 'A' - 10;
299                 }
300
301                 value = value << 4;
302
303                 pbuf[2 * idx + 1] = 0;
304         }
305 }
306
307 /**
308 * @brief  USBD_FS_ConfigStrDescriptor 
309 *         return the configuration string descriptor
310 * @param  speed : current device speed
311 * @param  length : pointer to data length variable
312 * @retval pointer to descriptor buffer
313 */
314 uint8_t *  USBD_FS_ConfigStrDescriptor( USBD_SpeedTypeDef speed , uint16_t *length)
315 {
316   if(speed  == USBD_SPEED_HIGH)
317   {  
318     USBD_GetString (USBD_CONFIGURATION_STRING_FS, USBD_StrDesc, length);
319   }
320   else
321   {
322     USBD_GetString (USBD_CONFIGURATION_STRING_FS, USBD_StrDesc, length); 
323   }
324   return USBD_StrDesc;  
325 }
326
327 /**
328 * @brief  USBD_HS_InterfaceStrDescriptor 
329 *         return the interface string descriptor
330 * @param  speed : current device speed
331 * @param  length : pointer to data length variable
332 * @retval pointer to descriptor buffer
333 */
334 uint8_t *  USBD_FS_InterfaceStrDescriptor( USBD_SpeedTypeDef speed , uint16_t *length)
335 {
336   if(speed == 0)
337   {
338     USBD_GetString (USBD_INTERFACE_STRING_FS, USBD_StrDesc, length);
339   }
340   else
341   {
342     USBD_GetString (USBD_INTERFACE_STRING_FS, USBD_StrDesc, length);
343   }
344   return USBD_StrDesc;  
345 }
346 /**
347   * @}
348   */ 
349
350 /**
351   * @}
352   */ 
353
354 /**
355   * @}
356   */ 
357
358 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/