1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/*
* This file is part of the MicroPython project, http://micropython.org/
*/
/**
******************************************************************************
* @file USB_Device/CDC_Standalone/Src/usbd_desc.c
* @author MCD Application Team
* @version V1.0.1
* @date 26-February-2014
* @brief This file provides the USBD descriptors and string formating method.
******************************************************************************
* @attention
*
* <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
*
* Licensed under MCD-ST Liberty SW License Agreement V2, (the "License");
* You may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.st.com/software_license_agreement_liberty_v2
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
******************************************************************************
*/
#include "usbd_core.h"
#include "usbd_desc.h"
#include "usbd_conf.h"
// need this header just for MP_HAL_UNIQUE_ID_ADDRESS
#include "py/mphal.h"
// need this header for any overrides to the below constants
#include "py/mpconfig.h"
#ifndef USBD_LANGID_STRING
#define USBD_LANGID_STRING 0x409
#endif
#ifndef USBD_MANUFACTURER_STRING
#define USBD_MANUFACTURER_STRING "MicroPython"
#endif
#ifndef USBD_PRODUCT_HS_STRING
#define USBD_PRODUCT_HS_STRING "Pyboard Virtual Comm Port in HS Mode"
#endif
#ifndef USBD_PRODUCT_FS_STRING
#define USBD_PRODUCT_FS_STRING "Pyboard Virtual Comm Port in FS Mode"
#endif
#ifndef USBD_CONFIGURATION_HS_STRING
#define USBD_CONFIGURATION_HS_STRING "Pyboard Config"
#endif
#ifndef USBD_INTERFACE_HS_STRING
#define USBD_INTERFACE_HS_STRING "Pyboard Interface"
#endif
#ifndef USBD_CONFIGURATION_FS_STRING
#define USBD_CONFIGURATION_FS_STRING "Pyboard Config"
#endif
#ifndef USBD_INTERFACE_FS_STRING
#define USBD_INTERFACE_FS_STRING "Pyboard Interface"
#endif
__ALIGN_BEGIN static const uint8_t USBD_LangIDDesc[USB_LEN_LANGID_STR_DESC] __ALIGN_END = {
USB_LEN_LANGID_STR_DESC,
USB_DESC_TYPE_STRING,
LOBYTE(USBD_LANGID_STRING),
HIBYTE(USBD_LANGID_STRING),
};
// set the VID, PID and device release number
void USBD_SetVIDPIDRelease(usbd_cdc_msc_hid_state_t *usbd, uint16_t vid, uint16_t pid, uint16_t device_release_num, int cdc_only) {
uint8_t *dev_desc = &usbd->usbd_device_desc[0];
dev_desc[0] = USB_LEN_DEV_DESC; // bLength
dev_desc[1] = USB_DESC_TYPE_DEVICE; // bDescriptorType
dev_desc[2] = 0x00; // bcdUSB
dev_desc[3] = 0x02; // bcdUSB
if (cdc_only) {
// Make it look like a Communications device if we're only
// using CDC. Otherwise, windows gets confused when we tell it that
// its a composite device with only a cdc serial interface.
dev_desc[4] = 0x02; // bDeviceClass
dev_desc[5] = 0x00; // bDeviceSubClass
dev_desc[6] = 0x00; // bDeviceProtocol
} else {
// For the other modes, we make this look like a composite device.
dev_desc[4] = 0xef; // bDeviceClass: Miscellaneous Device Class
dev_desc[5] = 0x02; // bDeviceSubClass: Common Class
dev_desc[6] = 0x01; // bDeviceProtocol: Interface Association Descriptor
}
dev_desc[7] = USB_MAX_EP0_SIZE; // bMaxPacketSize
dev_desc[8] = LOBYTE(vid); // idVendor
dev_desc[9] = HIBYTE(vid); // idVendor
dev_desc[10] = LOBYTE(pid); // idVendor
dev_desc[11] = HIBYTE(pid); // idVendor
dev_desc[12] = LOBYTE(device_release_num); // bcdDevice
dev_desc[13] = HIBYTE(device_release_num); // bcdDevice
dev_desc[14] = USBD_IDX_MFC_STR; // Index of manufacturer string
dev_desc[15] = USBD_IDX_PRODUCT_STR; // Index of product string
dev_desc[16] = USBD_IDX_SERIAL_STR; // Index of serial number string
dev_desc[17] = USBD_MAX_NUM_CONFIGURATION; // bNumConfigurations
}
/**
* @brief Returns the device descriptor.
* @param speed: Current device speed
* @param length: Pointer to data length variable
* @retval Pointer to descriptor buffer
*/
STATIC uint8_t *USBD_DeviceDescriptor(USBD_HandleTypeDef *pdev, uint16_t *length) {
uint8_t *dev_desc = ((usbd_cdc_msc_hid_state_t *)pdev->pClassData)->usbd_device_desc;
*length = USB_LEN_DEV_DESC;
return dev_desc;
}
/**
* @brief Returns a string descriptor
* @param idx: Index of the string descriptor to retrieve
* @param length: Pointer to data length variable
* @retval Pointer to descriptor buffer, or NULL if idx is invalid
*/
STATIC uint8_t *USBD_StrDescriptor(USBD_HandleTypeDef *pdev, uint8_t idx, uint16_t *length) {
char str_buf[16];
const char *str = NULL;
switch (idx) {
case USBD_IDX_LANGID_STR:
*length = sizeof(USBD_LangIDDesc);
return (uint8_t *)USBD_LangIDDesc; // the data should only be read from this buf
case USBD_IDX_MFC_STR:
str = USBD_MANUFACTURER_STRING;
break;
case USBD_IDX_PRODUCT_STR:
if (pdev->dev_speed == USBD_SPEED_HIGH) {
str = USBD_PRODUCT_HS_STRING;
} else {
str = USBD_PRODUCT_FS_STRING;
}
break;
case USBD_IDX_SERIAL_STR: {
// This document: http://www.usb.org/developers/docs/devclass_docs/usbmassbulk_10.pdf
// says that the serial number has to be at least 12 digits long and that
// the last 12 digits need to be unique. It also stipulates that the valid
// character set is that of upper-case hexadecimal digits.
//
// The onboard DFU bootloader produces a 12-digit serial number based on
// the 96-bit unique ID, so for consistency we go with this algorithm.
// You can see the serial number if you use: lsusb -v
//
// See: https://my.st.com/52d187b7 for the algorithim used.
uint8_t *id = (uint8_t *)MP_HAL_UNIQUE_ID_ADDRESS;
snprintf(str_buf, sizeof(str_buf),
"%02X%02X%02X%02X%02X%02X",
id[11], id[10] + id[2], id[9], id[8] + id[0], id[7], id[6]);
str = str_buf;
break;
}
case USBD_IDX_CONFIG_STR:
if (pdev->dev_speed == USBD_SPEED_HIGH) {
str = USBD_CONFIGURATION_HS_STRING;
} else {
str = USBD_CONFIGURATION_FS_STRING;
}
break;
case USBD_IDX_INTERFACE_STR:
if (pdev->dev_speed == USBD_SPEED_HIGH) {
str = USBD_INTERFACE_HS_STRING;
} else {
str = USBD_INTERFACE_FS_STRING;
}
break;
default:
// invalid string index
return NULL;
}
uint8_t *str_desc = ((usbd_cdc_msc_hid_state_t *)pdev->pClassData)->usbd_str_desc;
USBD_GetString((uint8_t *)str, str_desc, length);
return str_desc;
}
const USBD_DescriptorsTypeDef USBD_Descriptors = {
USBD_DeviceDescriptor,
USBD_StrDescriptor,
};
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|
