-
Notifications
You must be signed in to change notification settings - Fork 1
/
usb_descriptors.c
426 lines (394 loc) · 14 KB
/
usb_descriptors.c
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
/*
* The MIT License (MIT)
*
* Copyright (c) 2019 Ha Thach (tinyusb.org)
* 2022 rppicomidi
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*/
#include "tusb.h"
#include "stdlib.h"
#include "usb_descriptors.h"
#include "usb_midi_host.h"
static tusb_desc_device_t desc_device_connected;
static uint8_t* desc_fs_configuration = NULL;
static uint8_t daddr;
struct devstring_set_s {
uint16_t langid;
uint16_t** string_list;
};
static struct devstring_set_s* devstrings = NULL;
static uint8_t num_langids = 0;
static uint8_t langid_idx = 0;
static uint8_t string_idx = 0;
static uint8_t* string_idx_list = NULL;
static uint8_t nstrings = 0;
#define SZ_SCRATCHPAD 128
static uint8_t scratchpad[SZ_SCRATCHPAD];
static enum {UNCLONED, START_CLONING, CLONING, CLONE_NEXT_DESCRIPTOR, CLONED} clone_state = UNCLONED;
void set_cloning_required()
{
clone_state = START_CLONING;
}
bool cloning_is_required()
{
return clone_state == START_CLONING;
}
bool clone_next_string_is_required()
{
return clone_state == CLONE_NEXT_DESCRIPTOR;
}
bool descriptors_are_cloned(void)
{
return clone_state == CLONED;
}
void set_descriptors_uncloned(void)
{
clone_state = UNCLONED;
}
static void clone_string_cb(tuh_xfer_t* xfer)
{
if (XFER_RESULT_SUCCESS == xfer->result) {
devstrings[langid_idx].string_list[string_idx] = malloc(xfer->buffer[0]);
memcpy(devstrings[langid_idx].string_list[string_idx], xfer->buffer, xfer->buffer[0]);
if (++string_idx < nstrings) {
clone_state = CLONE_NEXT_DESCRIPTOR;
}
else {
TU_LOG2("All strings for langid 0x%04x:\r\n", devstrings[langid_idx].langid);
for (uint8_t idx=0; idx < nstrings; idx++) {
uint8_t length_string = (*((uint8_t*)(devstrings[langid_idx].string_list[idx])) - 2);
char* cptr = (char*)(devstrings[langid_idx].string_list[idx])+2;
for (uint8_t jdx=0; jdx < length_string; jdx++) {
if (cptr[jdx]) {
TU_LOG2("%c", cptr[jdx]);
}
}
TU_LOG2("\r\n");
}
if (++langid_idx < num_langids) {
string_idx = 0;
clone_state = CLONE_NEXT_DESCRIPTOR;
}
else {
clone_state = CLONED;
TU_LOG2("all strings cloned\r\n");
if (device_clone_complete_cb) device_clone_complete_cb();
}
}
}
}
void clone_next_string()
{
if (langid_idx < num_langids && string_idx < nstrings)
{
if (tuh_descriptor_get_string(daddr, string_idx_list[string_idx], devstrings[langid_idx].langid, scratchpad, SZ_SCRATCHPAD, clone_string_cb, 0)) {
clone_state = CLONING;
}
}
}
static void clone_langids_cb(tuh_xfer_t* xfer)
{
if (XFER_RESULT_SUCCESS == xfer->result) {
num_langids = (xfer->actual_len - 2)/2;
uint16_t* langids = (uint16_t*)(xfer->buffer+2);
devstrings = calloc(num_langids, sizeof(uint16_t));
TU_LOG2("num_langids=%u\r\n", num_langids);
int idx;
for (idx = 0; idx < num_langids; idx++) {
devstrings[idx].langid = langids[idx];
TU_LOG2("langid %u=0x%04x\r\n", idx, langids[idx]);
devstrings[idx].string_list = calloc(nstrings, sizeof(*(devstrings[idx].string_list)));
}
if (nstrings > 0) {
clone_state = CLONE_NEXT_DESCRIPTOR;
}
else {
clone_state = CLONED;
}
}
// Continue until all strings for all langids are fetched.
// Then call clone_complete_cb()--that should trigger tud_init(0) call.
}
// The callback functions capture the device descriptor and configuration descriptor
// This function starts the process that extracts the string descriptors.
// It assumes that captured device descriptor and configuration descriptor
// are valid and that all string descriptor indices are available
static void clone_string_descriptors(uint8_t dev_addr)
{
int idx, jdx;
const uint8_t* midi_string_idxs;
uint8_t nmidi_strings;
TU_LOG2("clone string descriptors for addr=%u\r\n", dev_addr);
if (dev_addr == daddr) {
// first free any old devstrings
if (devstrings != NULL) {
for (idx = 0; idx < num_langids; idx++) {
for (jdx = 0; jdx < nstrings; jdx++) {
free(devstrings[idx].string_list[jdx]);
}
free(devstrings+idx);
}
}
// Get the list of string indexs
nmidi_strings = tuh_midi_get_all_istrings(dev_addr, &midi_string_idxs);
nstrings = nmidi_strings;
if (desc_device_connected.iManufacturer != 0) {
++nstrings;
}
if (desc_device_connected.iProduct != 0) {
++nstrings;
}
if (desc_device_connected.iSerialNumber != 0) {
++nstrings;
}
string_idx_list = malloc(nstrings);
string_idx = 0;
if (desc_device_connected.iManufacturer != 0) {
string_idx_list[string_idx++] = desc_device_connected.iManufacturer;
}
if (desc_device_connected.iProduct != 0) {
string_idx_list[string_idx++] = desc_device_connected.iProduct;
}
if (desc_device_connected.iSerialNumber != 0) {
string_idx_list[string_idx++] = desc_device_connected.iSerialNumber;
}
if (nmidi_strings > 0)
memcpy(string_idx_list+string_idx, midi_string_idxs, nmidi_strings);
TU_LOG2("All %u string indices\n", string_idx+nmidi_strings);
TU_LOG2_MEM(string_idx_list, string_idx+nmidi_strings, 2);
// Kick off the process of fetching all strings for all languages from the host-connected device
string_idx = 0;
langid_idx = 0;
// get the string langid list
if (tuh_descriptor_get_string(daddr, 0, 0, scratchpad, SZ_SCRATCHPAD, clone_langids_cb, 0)) {
clone_state = CLONING;
TU_LOG2("getting langid list\r\n");
}
else {
TU_LOG2("getting langid list failed\r\n");
clone_state = UNCLONED;
}
}
}
static void clone_config_cb(tuh_xfer_t* xfer)
{
if (XFER_RESULT_SUCCESS == xfer->result && xfer->actual_len == xfer->user_data) {
// We have the configuration descriptor. Now clone the string descriptors
TU_LOG2("cloning the string descriptors\r\n");
clone_string_descriptors(xfer->daddr);
}
else {
TU_LOG2("failed to clone the config descriptor\r\n");
}
}
static void clone_config_sz_cb(tuh_xfer_t* xfer)
{
if (XFER_RESULT_SUCCESS == xfer->result) {
TU_LOG2("clone got config size\r\n");
tusb_desc_configuration_t* base = (tusb_desc_configuration_t*)scratchpad;
desc_fs_configuration = malloc(base->wTotalLength);
if (!desc_fs_configuration || !tuh_descriptor_get_configuration(xfer->daddr, 0, desc_fs_configuration, base->wTotalLength,
clone_config_cb, base->wTotalLength)) {
if (desc_fs_configuration) {
free(desc_fs_configuration);
desc_fs_configuration = NULL;
}
clone_state = UNCLONED;
TU_LOG2("failed to start cloning the config descriptor\r\n");
}
else {
TU_LOG2("cloning the configuration descriptor\r\n");
}
}
}
static void clone_device_cb(tuh_xfer_t* xfer)
{
if (XFER_RESULT_SUCCESS == xfer->result) {
if (xfer->actual_len == sizeof(desc_device_connected) && desc_device_connected.bNumConfigurations == 1) {
// device descriptor copied and has exactly one configuration (all this software can handle)
desc_fs_configuration = calloc(desc_device_connected.bNumConfigurations, sizeof(desc_fs_configuration[0]));
if (!desc_fs_configuration || !tuh_descriptor_get_configuration(xfer->daddr, 0, scratchpad, sizeof(tusb_desc_configuration_t),
clone_config_sz_cb, 0)) {
clone_state = UNCLONED;
TU_LOG2("failed send get config size\r\n");
}
else {
TU_LOG2("sent get config size\r\n");
}
}
else {
TU_LOG2("xfer->actual_len=%lu num config=%u\r\n", xfer->actual_len, desc_device_connected.bNumConfigurations);
}
}
else {
TU_LOG2("device clone cb xfer failed result=%u\r\n", xfer->result);
}
}
void start_cloning(uint8_t dev_addr)
{
// Free any old configuration descriptors
if (desc_fs_configuration != NULL) {
free(desc_fs_configuration);
desc_fs_configuration = NULL;
}
daddr = dev_addr;
if (tuh_descriptor_get_device(dev_addr, &desc_device_connected, sizeof(desc_device_connected),
clone_device_cb, 0)) {
clone_state = CLONING;
TU_LOG2("Sent get device descriptor to addr %u\r\n", dev_addr);
}
else {
clone_state = UNCLONED;
TU_LOG2("Failed send get device descriptor to addr %u\r\n", dev_addr);
}
}
#if 0
// grab the device descriptor during enumeration
void tuh_desc_device_cb(uint8_t dev_addr, const tusb_desc_device_t *desc)
{
daddr = dev_addr;
memcpy(&desc_device_connected, desc, sizeof(desc_device_connected));
TU_LOG2("device descriptor cloned\r\n");
TU_LOG2_MEM((uint8_t*)&desc_device_connected, sizeof(desc_device_connected), 2);
}
void tuh_desc_config_cb(uint8_t dev_addr, const tusb_desc_configuration_t *desc_config)
{
if (daddr == dev_addr && desc_config->wTotalLength > 0) {
desc_fs_configuration = malloc(desc_config->wTotalLength);
if (desc_fs_configuration) {
memcpy(desc_fs_configuration, desc_config, desc_config->wTotalLength);
TU_LOG2("configuration descriptor cloned\r\n");
TU_LOG2_MEM((uint8_t*)desc_fs_configuration, desc_config->wTotalLength, 2);
}
}
}
#endif
// Invoked when received GET DEVICE DESCRIPTOR
// Application return pointer to descriptor
uint8_t const * tud_descriptor_device_cb(void)
{
TU_LOG2("midi device descriptor returned\r\n");
return (uint8_t const *) &desc_device_connected;
}
uint8_t midid_get_endpoint0_size()
{
return desc_device_connected.bMaxPacketSize0;
}
//--------------------------------------------------------------------+
// Configuration Descriptor
//--------------------------------------------------------------------+
// Invoked when received GET CONFIGURATION DESCRIPTOR
// Application return pointer to descriptor
// Descriptor contents must exist long enough for transfer to complete
uint8_t const * tud_descriptor_configuration_cb(uint8_t index)
{
(void) index;
if (desc_fs_configuration == NULL) {
TU_LOG2("midi device configuration %u not available\r\n", index);
return NULL;
}
TU_LOG2("midi device configuration %u returned\r\n", index);
return desc_fs_configuration;
}
//--------------------------------------------------------------------+
// String Descriptors
//--------------------------------------------------------------------+
// Invoked when received GET STRING DESCRIPTOR request
// Application return pointer to descriptor, whose contents must exist long enough for transfer to complete
uint16_t const* tud_descriptor_string_cb(uint8_t index, uint16_t langid)
{
uint16_t* ptr = NULL;
// return the langid list descriptor if index == 0
if (index == 0) {
scratchpad[0] = (num_langids * 2) + 2; // descriptor length
scratchpad[1] = TUSB_DESC_STRING;
ptr = (uint16_t*)(scratchpad+2);
for (int idx=0; idx < num_langids; idx++) {
*ptr++ = devstrings[idx].langid;
}
ptr = (uint16_t*)scratchpad;
}
else {
// find the string descriptor index for this langid
int lang;
for (lang = 0; lang < num_langids && devstrings[lang].langid != langid; lang++) {
}
if (lang < num_langids) {
// then we found the devstrings structure for this langid
int idx;
for (idx = 0; idx < nstrings && string_idx_list[idx] != index; idx++) {
}
if (idx < nstrings) {
ptr = (uint16_t*)(devstrings[lang].string_list[idx]);
}
}
}
return ptr;
}
bool get_product_string(char* prodstr, uint8_t max_prodstr)
{
bool success = false;
char* temp = prodstr;
if (clone_state == CLONED && desc_device_connected.iProduct != 0 && prodstr && max_prodstr > 0) {
uint8_t devstr_len = get_product_string_length() / 2;
if (devstr_len >= max_prodstr)
devstr_len = max_prodstr - 1;
uint8_t idx;
for (idx = 0; idx < nstrings && string_idx_list[idx] != desc_device_connected.iProduct; idx++) {
}
uint16_t* ptr = devstrings[0].string_list[idx] + 1;
// discarding the most significant 8 bits for each character will translate the string to an
// ASCII c_str
for (idx = 0; idx < devstr_len; idx++)
*prodstr++ = (char)(*ptr++);
*prodstr = '\0';
success = true;
printf("product string=%s %u chars\r\n", temp, devstr_len);
}
return success;
}
uint8_t get_product_string_length(void)
{
uint8_t len = 0;
if (clone_state == CLONED && desc_device_connected.iProduct != 0) {
int idx;
for (idx = 0; idx < nstrings && string_idx_list[idx] != desc_device_connected.iProduct; idx++) {
}
len = ((*devstrings[0].string_list[idx]) & 0xff) - 2;
}
return len;
}
uint16_t get_vid()
{
uint16_t vid = 0;
if (clone_state == CLONED) {
vid = desc_device_connected.idVendor;
}
return vid;
}
uint16_t get_pid()
{
uint16_t pid = 0;
if (clone_state == CLONED) {
pid = desc_device_connected.idProduct;
}
return pid;
}