-
Notifications
You must be signed in to change notification settings - Fork 7
/
usbcfg.c
483 lines (434 loc) · 17.4 KB
/
usbcfg.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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
/*
ChibiOS/RT - Copyright (C) 2006-2013 Giovanni Di Sirio
modified by Johannes Taelman
Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
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 "ch.h"
#include "hal.h"
#include "usbcfg.h"
#include "config.h"
/*
* Serial over USB Driver structure.
*/
MidiUSBDriver MDU1;
BulkUSBDriver BDU1;
/*
* USB Device Descriptor.
*/
static const uint8_t vcom_device_descriptor_data[18] = {
USB_DESC_DEVICE (0x0200, /* bcdUSB (2.0). */
0xEF, /* bDeviceClass (Misc). */
0x02, /* bDeviceSubClass. */
0x01, /* bDeviceProtocol. (IAD) */
0x40, /* bMaxPacketSize. */
0xF055, /* idVendor (FOSS). */
0x57C0, /* idProduct. */
0x0200, /* bcdDevice. */
1, /* iManufacturer. */
2, /* iProduct. */
3, /* iSerialNumber. */
1) /* bNumConfigurations. */
};
/*
* Device Descriptor wrapper.
*/
static const USBDescriptor vcom_device_descriptor = {
sizeof vcom_device_descriptor_data,
vcom_device_descriptor_data
};
static const uint8_t vcom_configuration_descriptor_data[]=
{
/* Configuration Descriptor.*/
USB_DESC_CONFIGURATION(140, /* wTotalLength. */
0x03, /* bNumInterfaces. */
0x01, /* bConfigurationValue. */
0, /* iConfiguration. */
0xC0, /* bmAttributes (self powered). */
50), /* bMaxPower (100mA). */
/* Interface Association Descriptor.*/
USB_DESC_INTERFACE_ASSOCIATION(0x00, /* bFirstInterface. */
0x02, /* bInterfaceCount. */
0x01, /* bFunctionClass (Audio). */
0x03, /* bFunctionSubClass. */
0x00, /* bFunctionProcotol */
0), /* iInterface. */
0x09, 0x04, 0x00, 0x00, 0x00, 0x01, 0x01, 0x00, 0x00, // Interface 0 INTERFACE DESC (bLength bDescType bInterfaceNumber bAltSetting bNumEndpoints bInterfaceClass bInterfaceSubClass bInterfaceProtocol iInterface)
0x09, 0x24, 0x01, 0x00, 0x01, 0x09, 0x00, 0x01, 0x01, // CS Interface (audio) CLASS SPECIFIC AC INTERFACE DESC
0x09, 0x04, 0x01, 0x00, 0x02, 0x01, 0x03, 0x00, 0x00, // Interface 1 INTERFACE DESC (bLength bDescType bInterfaceNumber bAltSetting bNumEndpoints bInterfaceClass bInterfaceSubClass bInterfaceProtocol iInterface)
0x07, 0x24, 0x01, 0x00, 0x01, 0x41, 0x00, // CS Interface (midi) CLASS SPECIFIC MS INTERFACE DESC
0x06, 0x24, 0x02, 0x01, 0x01, 0x00, // IN Jack 1 (emb) MIDI IN JACK DESC (bLength bDescType bDescSubType bJackType bJackID iJack)
0x06, 0x24, 0x02, 0x02, 0x02, 0x00, // IN Jack 2 (ext) MIDI IN JACK DESC (bLength bDescType bDescSubType bJackType bJackID iJack)
0x09, 0x24, 0x03, 0x01, 0x03, 0x01, 0x02, 0x01, 0x00, // OUT Jack 3 (emb) MIDI OUT JACK DESC (bLength bDescType bDescSubType bJackType bJackID bNrInputPins baSourceID(1) baSourceID(1) iJack)
0x09, 0x24, 0x03, 0x02, 0x04, 0x01, 0x01, 0x01, 0x00, // OUT Jack 4 (ext) MIDI OUT JACK DESC (bLength bDescType bDescSubType bJackType bJackID bNrInputPins baSourceID(1) baSourceID(1) iJack)
0x09, 0x05, 0x01, 0x02, 0x40, 0x00, 0x00, 0x00, 0x00, // Endpoint OUT ENDPOINT DESC (bLength bDescType bEndpointAddr bmAttr wMaxPacketSize(2 bytes) bInterval bRefresh bSyncAddress)
0x05, 0x25, 0x01, 0x01, 0x01, // CS EP IN Jack CLASS SPECIFIC MS BULK DATA EP DESC
0x09, 0x05, 0x81, 0x02, 0x40, 0x00, 0x00, 0x00, 0x00, // Endpoint IN ENDPOINT DESC (bLength bDescType bEndpointAddr bmAttr wMaxPacketSize(2 bytes) bInterval bRefresh bSyncAddress)
0x05, 0x25, 0x01, 0x01, 0x03, // CS EP OUT Jack CLASS SPECIFIC MS BULK DATA EP DESC
/* Interface Association Descriptor.*/
USB_DESC_INTERFACE_ASSOCIATION(0x02, /* bFirstInterface. */
0x01, /* bInterfaceCount. */
0xFF, /* bFunctionClass (Vendor Specific). */
0x00, /* bFunctionSubClass. */
0x00, /* bFunctionProcotol */
4), /* iInterface. */
/* Interface Descriptor.*/
USB_DESC_INTERFACE (0x02, /* bInterfaceNumber. */
0x00, /* bAlternateSetting. */
0x02, /* bNumEndpoints. */
0xFF, /* bInterfaceClass (Vendor Specific). */
0x00,
0x00,
4), /* iInterface. */
/* Endpoint 2 Descriptor.*/
USB_DESC_ENDPOINT (USBD2_DATA_AVAILABLE_EP, /* bEndpointAddress.*/
0x02, /* bmAttributes (Bulk). */
0x0040, /* wMaxPacketSize. */
0x00), /* bInterval. */
/* Endpoint 2 Descriptor.*/
USB_DESC_ENDPOINT (USBD2_DATA_REQUEST_EP|0x80, /* bEndpointAddress.*/
0x02, /* bmAttributes (Bulk). */
0x0040, /* wMaxPacketSize. */
0x00) /* bInterval. */
};
/*
* Configuration Descriptor wrapper.
*/
static const USBDescriptor vcom_configuration_descriptor = {
sizeof vcom_configuration_descriptor_data,
vcom_configuration_descriptor_data
};
/*
* U.S. English language identifier.
*/
static const uint8_t vcom_string0[] = {
USB_DESC_BYTE(4), /* bLength. */
USB_DESC_BYTE(USB_DESCRIPTOR_STRING), /* bDescriptorType. */
USB_DESC_WORD(0x0409) /* wLANGID (U.S. English). */
};
/*
* Manufacturer string.
*/
static const uint8_t descriptor_manufacturer_string[] = {
USB_DESC_BYTE(14), /* bLength. */
USB_DESC_BYTE(USB_DESCRIPTOR_STRING), /* bDescriptorType. */
'S', 0, 't', 0, 'r', 0, 'i', 0, 's', 0, 'o', 0,
};
/*
* Product string.
* modified on initialization!
*/
static uint8_t descriptor_product_string[] = {
USB_DESC_BYTE(26), /* bLength. */
USB_DESC_BYTE(USB_DESCRIPTOR_STRING), /* bDescriptorType. */
'S', 0, 't', 0, 'r', 0, 'i', 0, 's', 0, 'o', 0, ' ', 0,
'b', 0, 'o', 0, 'a', 0, 'r', 0, 'd', 0, ' ', 0,
' ', 0, ' ', 0, ' ', 0, ' ', 0, ' ', 0,
};
static uint8_t descriptor_serial_string[] = {
USB_DESC_BYTE(50), /* bLength. */
USB_DESC_BYTE(USB_DESCRIPTOR_STRING), /* bDescriptorType. */
'0', 0, '0', 0, '0', 0, '0', 0,
'0', 0, '0', 0, '0', 0, '0', 0,
'0', 0, '0', 0, '0', 0, '0', 0,
'0', 0, '0', 0, '0', 0, '0', 0,
'0', 0, '0', 0, '0', 0, '0', 0,
'0', 0, '0', 0, '0', 0, '0', 0
};
/*
* Device Description string.
*/
static const uint8_t vcom_string4[] = {
USB_DESC_BYTE(44), /* bLength. */
USB_DESC_BYTE(USB_DESCRIPTOR_STRING), /* bDescriptorType. */
'S', 0, 't', 0, 'r', 0, 'i', 0, 's', 0, 'o', 0, ' ', 0,
'B', 0, 'u', 0, 'l', 0, 'k', 0, ' ', 0,
'I', 0, 'n', 0, 't', 0, 'e', 0, 'r', 0, 'f', 0, 'a', 0, 'c', 0, 'e', 0,
};
/* WCID implementation reference:
* https://github.com/pbatard/libwdi/wiki/WCID-Devices
*/
static const uint8_t wcid_string[] = {
USB_DESC_BYTE(18), /* bLength. */
USB_DESC_BYTE(USB_DESCRIPTOR_STRING), /* bDescriptorType. */
'M', 0, 'S', 0, 'F', 0, 'T', 0, '1', 0, '0', 0, '0', 0, /* MSFT100 */
20, 0x00 /* vendor code, padding */
};
/*
* Strings wrappers array.
*/
static const USBDescriptor vcom_strings[] = {
{sizeof vcom_string0, vcom_string0},
{sizeof descriptor_manufacturer_string, descriptor_manufacturer_string},
{sizeof descriptor_product_string, descriptor_product_string},
{sizeof descriptor_serial_string, descriptor_serial_string},
{sizeof vcom_string4, vcom_string4}
};
static const USBDescriptor wcid_descriptor = {sizeof wcid_string, wcid_string};
void inttohex(uint32_t v, unsigned char *p){
int nibble;
for (nibble = 0;nibble<8;nibble++){
unsigned char c = (v>>(28-nibble*4))&0xF;
if (c<10) c=c+'0';
else c=c+'A'-10;
*p = c;
p += 2;
}
}
/*
* Initialize the device specific parts of the descriptor strings.
*/
void init_usb_descriptor(void) {
uint32_t* const UID = (uint32_t*)UID_BASE;
// use microcontroller unique ID as serial number (little-endian)
inttohex(UID[2],&descriptor_serial_string[2]);
inttohex(UID[1],&descriptor_serial_string[2+16]);
inttohex(UID[0],&descriptor_serial_string[2+32]);
// add Striso board number to product string (if available)
if (devspec_id->UID[0] == UID[0] &&
devspec_id->UID[1] == UID[1] &&
devspec_id->UID[2] == UID[2]) {
int n;
for (n = 0; n < 4 && devspec_id->id[n] >= 33 && devspec_id->id[n] < 128; n++) {
descriptor_product_string[28 + 2*n] = devspec_id->id[n];
}
descriptor_product_string[0] = USB_DESC_BYTE(28 + 2*n);
}
}
/*
* Handles the GET_DESCRIPTOR callback. All required descriptors must be
* handled here.
*/
static const USBDescriptor *get_descriptor(USBDriver *usbp,
uint8_t dtype,
uint8_t dindex,
uint16_t lang) {
(void)usbp;
(void)lang;
switch (dtype) {
case USB_DESCRIPTOR_DEVICE:
return &vcom_device_descriptor;
case USB_DESCRIPTOR_CONFIGURATION:
return &vcom_configuration_descriptor;
case USB_DESCRIPTOR_STRING:
if (dindex < 5)
return &vcom_strings[dindex];
if (dindex == 0xEE)
return &wcid_descriptor;
break;
}
return NULL;
}
/**
* @brief IN EP1 state.
*/
static USBInEndpointState ep1instate;
/**
* @brief OUT EP1 state.
*/
static USBOutEndpointState ep1outstate;
/**
* @brief EP1 initialization structure (both IN and OUT).
*/
static const USBEndpointConfig ep1config = {
USB_EP_MODE_TYPE_BULK,
NULL,
mduDataTransmitted,
mduDataReceived,
0x0040,
0x0040,
&ep1instate,
&ep1outstate,
1,
NULL
};
/**
* @brief IN EP2 state.
*/
static USBInEndpointState ep2instate;
/**
* @brief OUT EP2 state.
*/
static USBOutEndpointState ep2outstate;
/**
* @brief EP2 initialization structure (both IN and OUT).
*/
static const USBEndpointConfig ep2config = {
USB_EP_MODE_TYPE_BULK,
NULL,
bduDataTransmitted,
bduDataReceived,
0x0040,
0x0040,
&ep2instate,
&ep2outstate,
1,
NULL
};
/*
* Handles the USB driver global events.
*/
static void usb_event(USBDriver *usbp, usbevent_t event) {
switch (event) {
case USB_EVENT_ADDRESS:
return;
case USB_EVENT_CONFIGURED:
chSysLockFromISR();
if (usbp->state == USB_ACTIVE) {
/* Enables the endpoints specified into the configuration.
Note, this callback is invoked from an ISR so I-Class functions
must be used.*/
usbInitEndpointI(usbp, USBD1_DATA_REQUEST_EP, &ep1config);
usbInitEndpointI(usbp, USBD2_DATA_REQUEST_EP, &ep2config);
bduConfigureHookI(&BDU1);
mduConfigureHookI(&MDU1);
} else if (usbp->state == USB_SELECTED) {
usbDisableEndpointsI(usbp);
}
chSysUnlockFromISR();
return;
case USB_EVENT_RESET:
/* Falls into.*/
case USB_EVENT_UNCONFIGURED:
/* Falls into.*/
case USB_EVENT_SUSPEND:
chSysLockFromISR();
/* Disconnection event on suspend.*/
bduSuspendHookI(&BDU1);
mduSuspendHookI(&MDU1);
chSysUnlockFromISR();
return;
case USB_EVENT_WAKEUP:
chSysLockFromISR();
/* Connection event on wakeup.*/
bduWakeupHookI(&BDU1);
mduWakeupHookI(&MDU1);
chSysUnlockFromISR();
return;
case USB_EVENT_STALLED:
return;
}
return;
}
static const uint8_t mscompatid[] = {
0x40, 0x00, 0x00, 0x00, /* DWORD (LE) Descriptor length (64 bytes) */
0x00, 0x01, /* BCD WORD (LE) Version ('1.0') */
0x04, 0x00, /* WORD (LE) Compatibility ID Descriptor index (0x0004) */
0x02, /* BYTE Number of sections (2) */
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 7 BYTES Reserved */
0x00, /* BYTE Interface Number (Interface #0) */
0x01, /* BYTE Reserved */
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 8 BYTES (NUL-terminated?) ASCII String Compatible ID (null) */
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 8 BYTES (NUL-terminated?) ASCII String Sub-Compatible ID (unused) */
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 6 BYTES Reserved */
0x02, /* BYTE Interface Number (Interface #2) */
0x01, /* BYTE Reserved */
0x57, 0x49, 0x4E, 0x55, 0x53, 0x42, 0x00, 0x00, /* 8 BYTES (NUL-terminated?) ASCII String Compatible ID ("WINUSB\0\0") */
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 8 BYTES (NUL-terminated?) ASCII String Sub-Compatible ID (unused) */
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 6 BYTES Reserved */
};
static const uint8_t msdescriptor0[] = {
0x0A, 0x00, 0x00, 0x00, /* Descriptor length (10 bytes) */
0x00, 0x01, /*Version ('1.0') */
0x05, 0x00, /* WORD (LE) Descriptor index (5) */
0x00, 0x00 /* WORD (LE) Number of sections (0) */
};
static const uint8_t msdescriptor1[] = {
0x94, 0x00, 0x00, 0x00, /* Descriptor length (146 bytes) */
0x00, 0x01, /*Version ('1.0') */
0x05, 0x00, /* WORD (LE) Descriptor index (5) */
0x01, 0x00, /* WORD (LE) Number of sections (1) */
0x8A, 0x00, 0x00, 0x00, /* DWORD (LE) Size of the property section (136 bytes) */
0x07, 0x00, 0x00, 0x00, /* DWORD (LE) Property data type (7 = Unicode REG_MULTI_SZ, */
0x2a, 0x00, /* WORD (LE) Property name length (42 bytes) */
0x44, 0x00, 0x65, 0x00, 0x76, 0x00, 0x69, 0x00,
0x63, 0x00, 0x65, 0x00, 0x49, 0x00, 0x6E, 0x00,
0x74, 0x00, 0x65, 0x00, 0x72, 0x00, 0x66, 0x00,
0x61, 0x00, 0x63, 0x00, 0x65, 0x00, 0x47, 0x00,
0x55, 0x00, 0x49, 0x00, 0x44, 0x00, 0x73, 0x00, 0x00, 0x00, /* NUL-terminated Unicode String (LE) Property name "DeviceInterfaceGUIDs" */
0x50, 0x00, 0x00, 0x00, /* DWORD (LE) Property data length (80 bytes) */
0x7B, 0x00, 0x38, 0x00, 0x38, 0x00, 0x42, 0x00,
0x41, 0x00, 0x45, 0x00, 0x30, 0x00, 0x33, 0x00,
0x32, 0x00, 0x2D, 0x00, 0x35, 0x00, 0x41, 0x00,
0x38, 0x00, 0x31, 0x00, 0x2D, 0x00, 0x34, 0x00,
0x39, 0x00, 0x66, 0x00, 0x30, 0x00, 0x2D, 0x00,
0x42, 0x00, 0x43, 0x00, 0x33, 0x00, 0x44, 0x00,
0x2D, 0x00, 0x41, 0x00, 0x34, 0x00, 0x46, 0x00,
0x46, 0x00, 0x31, 0x00, 0x33, 0x00, 0x38, 0x00,
0x32, 0x00, 0x31, 0x00, 0x36, 0x00, 0x44, 0x00,
0x36, 0x00, 0x7D, 0x00, 0x00, 0x00, 0x00, 0x00
/* double NUL-terminated Unicode String (LE) Property name "{88BAE032-5A81-49f0-BC3D-A4FF138216D6}" */
};
static bool specialRequestsHook(USBDriver *usbp) {
if (
(usbp->setup[0] == 0xC0) &&
(usbp->setup[1] == 0x14) &&
(usbp->setup[2] == 0x00) &&
(usbp->setup[3] == 0x00) &&
(usbp->setup[4] == 0x04)
) {
usbSetupTransfer(usbp, (uint8_t *)&mscompatid, usbp->setup[6], NULL);
return TRUE;
} else if (
(usbp->setup[0] == 0xC1) &&
(usbp->setup[1] == 0x14) &&
(usbp->setup[2] == 0x00) &&
(usbp->setup[3] == 0x00) &&
(usbp->setup[4] == 0x05)
) {
usbSetupTransfer(usbp, (uint8_t *)&msdescriptor0, usbp->setup[6], NULL);
return TRUE;
} else if (
(usbp->setup[0] == 0xC1) &&
(usbp->setup[1] == 0x14) &&
(usbp->setup[2] == 0x02) &&
(usbp->setup[3] == 0x00) &&
(usbp->setup[4] == 0x05)
) {
usbSetupTransfer(usbp, (uint8_t *)&msdescriptor1, usbp->setup[6], NULL);
return TRUE;
}
return FALSE;
}
/*
* Handles the USB driver global events.
*/
static void sof_handler(USBDriver *usbp) {
(void)usbp;
osalSysLockFromISR();
bduSOFHookI(&BDU1);
mduSOFHookI(&MDU1);
osalSysUnlockFromISR();
}
/*
* USB driver configuration.
*/
const USBConfig usbcfg = {
usb_event,
get_descriptor,
specialRequestsHook,
sof_handler
};
/*
* Midi USB driver configuration.
*/
const MidiUSBConfig midiusbcfg = {
&USBD1,
USBD1_DATA_REQUEST_EP,
USBD1_DATA_AVAILABLE_EP
};
/*
* Bulk USB driver configuration.
*/
const BulkUSBConfig bulkusbcfg = {
&USBD1,
USBD2_DATA_REQUEST_EP,
USBD2_DATA_AVAILABLE_EP
};