-
Notifications
You must be signed in to change notification settings - Fork 0
/
usbcdc.c
574 lines (494 loc) · 16.1 KB
/
usbcdc.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
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
/* This file is originally from https://github.com/dword1511/stm32-vserprog *
* revision 638cf019f54493386d09bc57e2cf23548c6bec00 , author "dword1511", license: GPLv3 */
#include <stdlib.h>
#include <libopencm3/cm3/nvic.h>
#include <libopencm3/usb/usbd.h>
#include <libopencm3/usb/cdc.h>
#include <libopencm3/stm32/st_usbfs.h>
#include <libopencm3/stm32/desig.h>
#include <libopencm3/cm3/cortex.h>
#include "main.h"
#include "debug.h"
#include "usbopt.h"
#define UID_LEN (12 * 2 + 1) /* 12-byte, each byte turnned into 2-byte hex, then '\0'. */
#define DEV_VID 0x0483 /* ST Microelectronics */
#define DEV_PID 0x5740 /* STM32 */
#define DEV_VER 0x0009 /* 0.9 */
/* NOTE: These IN/OUT are backwards to how they're supposed to be backwards. Double whammy. */
/* Serprog channel */
#define EP_INT 0x83
#define EP_OUT 0x82
#define EP_IN 0x01
/* Extuart channel (TODO). */
#define EP2_INT 0x85
#define EP2_OUT 0x84
#define EP2_IN 0x04
/* Debug console channel */
#define EP3_INT 0x87
#define EP3_OUT 0x86
#define EP3_IN 0x06
#define STR_MAN 0x01
#define STR_PROD 0x02
#define STR_SER 0x03
#include "usbcdc.h"
static const struct usb_device_descriptor dev = {
.bLength = USB_DT_DEVICE_SIZE,
.bDescriptorType = USB_DT_DEVICE,
.bcdUSB = 0x0200,
.bDeviceClass = USB_CLASS_CDC,
.bDeviceSubClass = 0,
.bDeviceProtocol = 0,
.bMaxPacketSize0 = USBCDC_PKT_SIZE_DAT,
.idVendor = DEV_VID,
.idProduct = DEV_PID,
.bcdDevice = DEV_VER,
.iManufacturer = STR_MAN,
.iProduct = STR_PROD,
.iSerialNumber = STR_SER,
.bNumConfigurations = 1,
};
/*
* This notification endpoint isn't implemented. According to CDC spec its
* optional, but its absence causes a NULL pointer dereference in Linux
* cdc_acm driver.
*/
static const struct usb_endpoint_descriptor comm_endp[] = {{
.bLength = USB_DT_ENDPOINT_SIZE,
.bDescriptorType = USB_DT_ENDPOINT,
.bEndpointAddress = EP_INT,
.bmAttributes = USB_ENDPOINT_ATTR_INTERRUPT,
.wMaxPacketSize = USBCDC_PKT_SIZE_INT,
.bInterval = 255,
}
};
static const struct usb_endpoint_descriptor data_endp[] = {{
.bLength = USB_DT_ENDPOINT_SIZE,
.bDescriptorType = USB_DT_ENDPOINT,
.bEndpointAddress = EP_IN,
.bmAttributes = USB_ENDPOINT_ATTR_BULK,
.wMaxPacketSize = USBCDC_PKT_SIZE_DAT,
.bInterval = 1,
}, {
.bLength = USB_DT_ENDPOINT_SIZE,
.bDescriptorType = USB_DT_ENDPOINT,
.bEndpointAddress = EP_OUT,
.bmAttributes = USB_ENDPOINT_ATTR_BULK,
.wMaxPacketSize = USBCDC_PKT_SIZE_DAT,
.bInterval = 1,
}
};
static const struct usb_endpoint_descriptor comm_endp2[] = {{
.bLength = USB_DT_ENDPOINT_SIZE,
.bDescriptorType = USB_DT_ENDPOINT,
.bEndpointAddress = EP2_INT,
.bmAttributes = USB_ENDPOINT_ATTR_INTERRUPT,
.wMaxPacketSize = USBCDC_PKT_SIZE_INT,
.bInterval = 255,
}
};
static const struct usb_endpoint_descriptor data_endp2[] = {{
.bLength = USB_DT_ENDPOINT_SIZE,
.bDescriptorType = USB_DT_ENDPOINT,
.bEndpointAddress = EP2_IN,
.bmAttributes = USB_ENDPOINT_ATTR_BULK,
.wMaxPacketSize = USBCDC_PKT_SIZE_DAT,
.bInterval = 1,
}, {
.bLength = USB_DT_ENDPOINT_SIZE,
.bDescriptorType = USB_DT_ENDPOINT,
.bEndpointAddress = EP2_OUT,
.bmAttributes = USB_ENDPOINT_ATTR_BULK,
.wMaxPacketSize = USBCDC_PKT_SIZE_DAT,
.bInterval = 1,
}
};
static const struct usb_endpoint_descriptor comm_endp3[] = {{
.bLength = USB_DT_ENDPOINT_SIZE,
.bDescriptorType = USB_DT_ENDPOINT,
.bEndpointAddress = EP3_INT,
.bmAttributes = USB_ENDPOINT_ATTR_INTERRUPT,
.wMaxPacketSize = USBCDC_PKT_SIZE_INT,
.bInterval = 255,
}
};
static const struct usb_endpoint_descriptor data_endp3[] = {{
.bLength = USB_DT_ENDPOINT_SIZE,
.bDescriptorType = USB_DT_ENDPOINT,
.bEndpointAddress = EP3_IN,
.bmAttributes = USB_ENDPOINT_ATTR_BULK,
.wMaxPacketSize = USBCDC_PKT_SIZE_DAT,
.bInterval = 1,
}, {
.bLength = USB_DT_ENDPOINT_SIZE,
.bDescriptorType = USB_DT_ENDPOINT,
.bEndpointAddress = EP3_OUT,
.bmAttributes = USB_ENDPOINT_ATTR_BULK,
.wMaxPacketSize = USBCDC_PKT_SIZE_DAT,
.bInterval = 1,
}
};
static const struct {
struct usb_cdc_header_descriptor header;
struct usb_cdc_call_management_descriptor call_mgmt;
struct usb_cdc_acm_descriptor acm;
struct usb_cdc_union_descriptor cdc_union;
} __attribute__((packed)) cdcacm_functional_descriptors = {
.header = {
.bFunctionLength = sizeof(struct usb_cdc_header_descriptor),
.bDescriptorType = CS_INTERFACE,
.bDescriptorSubtype = USB_CDC_TYPE_HEADER,
.bcdCDC = 0x0110,
},
.call_mgmt = {
.bFunctionLength = sizeof(struct usb_cdc_call_management_descriptor),
.bDescriptorType = CS_INTERFACE,
.bDescriptorSubtype = USB_CDC_TYPE_CALL_MANAGEMENT,
.bmCapabilities = 0,
.bDataInterface = 1,
},
.acm = {
.bFunctionLength = sizeof(struct usb_cdc_acm_descriptor),
.bDescriptorType = CS_INTERFACE,
.bDescriptorSubtype = USB_CDC_TYPE_ACM,
.bmCapabilities = 0,
},
.cdc_union = {
.bFunctionLength = sizeof(struct usb_cdc_union_descriptor),
.bDescriptorType = CS_INTERFACE,
.bDescriptorSubtype = USB_CDC_TYPE_UNION,
.bControlInterface = 0,
.bSubordinateInterface0 = 1,
},
};
static const struct {
struct usb_cdc_header_descriptor header;
struct usb_cdc_call_management_descriptor call_mgmt;
struct usb_cdc_acm_descriptor acm;
struct usb_cdc_union_descriptor cdc_union;
} __attribute__((packed)) cdcacm_functional_descriptors2 = {
.header = {
.bFunctionLength = sizeof(struct usb_cdc_header_descriptor),
.bDescriptorType = CS_INTERFACE,
.bDescriptorSubtype = USB_CDC_TYPE_HEADER,
.bcdCDC = 0x0110,
},
.call_mgmt = {
.bFunctionLength = sizeof(struct usb_cdc_call_management_descriptor),
.bDescriptorType = CS_INTERFACE,
.bDescriptorSubtype = USB_CDC_TYPE_CALL_MANAGEMENT,
.bmCapabilities = 0,
.bDataInterface = 3,
},
.acm = {
.bFunctionLength = sizeof(struct usb_cdc_acm_descriptor),
.bDescriptorType = CS_INTERFACE,
.bDescriptorSubtype = USB_CDC_TYPE_ACM,
.bmCapabilities = 0,
},
.cdc_union = {
.bFunctionLength = sizeof(struct usb_cdc_union_descriptor),
.bDescriptorType = CS_INTERFACE,
.bDescriptorSubtype = USB_CDC_TYPE_UNION,
.bControlInterface = 2,
.bSubordinateInterface0 = 3,
},
};
static const struct {
struct usb_cdc_header_descriptor header;
struct usb_cdc_call_management_descriptor call_mgmt;
struct usb_cdc_acm_descriptor acm;
struct usb_cdc_union_descriptor cdc_union;
} __attribute__((packed)) cdcacm_functional_descriptors3 = {
.header = {
.bFunctionLength = sizeof(struct usb_cdc_header_descriptor),
.bDescriptorType = CS_INTERFACE,
.bDescriptorSubtype = USB_CDC_TYPE_HEADER,
.bcdCDC = 0x0110,
},
.call_mgmt = {
.bFunctionLength = sizeof(struct usb_cdc_call_management_descriptor),
.bDescriptorType = CS_INTERFACE,
.bDescriptorSubtype = USB_CDC_TYPE_CALL_MANAGEMENT,
.bmCapabilities = 0,
.bDataInterface = 5,
},
.acm = {
.bFunctionLength = sizeof(struct usb_cdc_acm_descriptor),
.bDescriptorType = CS_INTERFACE,
.bDescriptorSubtype = USB_CDC_TYPE_ACM,
.bmCapabilities = 0,
},
.cdc_union = {
.bFunctionLength = sizeof(struct usb_cdc_union_descriptor),
.bDescriptorType = CS_INTERFACE,
.bDescriptorSubtype = USB_CDC_TYPE_UNION,
.bControlInterface = 4,
.bSubordinateInterface0 = 5,
},
};
static const struct usb_interface_descriptor comm_iface[] = {{
.bLength = USB_DT_INTERFACE_SIZE,
.bDescriptorType = USB_DT_INTERFACE,
.bInterfaceNumber = 0,
.bAlternateSetting = 0,
.bNumEndpoints = 1,
.bInterfaceClass = USB_CLASS_CDC,
.bInterfaceSubClass = USB_CDC_SUBCLASS_ACM,
.bInterfaceProtocol = USB_CDC_PROTOCOL_AT,
.iInterface = 0,
.endpoint = comm_endp,
.extra = &cdcacm_functional_descriptors,
.extralen = sizeof(cdcacm_functional_descriptors),
}
};
static const struct usb_interface_descriptor data_iface[] = {{
.bLength = USB_DT_INTERFACE_SIZE,
.bDescriptorType = USB_DT_INTERFACE,
.bInterfaceNumber = 1,
.bAlternateSetting = 0,
.bNumEndpoints = 2,
.bInterfaceClass = USB_CLASS_DATA,
.bInterfaceSubClass = 0,
.bInterfaceProtocol = 0,
.iInterface = 0,
.endpoint = data_endp,
}
};
static const struct usb_interface_descriptor comm_iface2[] = {{
.bLength = USB_DT_INTERFACE_SIZE,
.bDescriptorType = USB_DT_INTERFACE,
.bInterfaceNumber = 2,
.bAlternateSetting = 0,
.bNumEndpoints = 1,
.bInterfaceClass = USB_CLASS_CDC,
.bInterfaceSubClass = USB_CDC_SUBCLASS_ACM,
.bInterfaceProtocol = USB_CDC_PROTOCOL_AT,
.iInterface = 0,
.endpoint = comm_endp2,
.extra = &cdcacm_functional_descriptors2,
.extralen = sizeof(cdcacm_functional_descriptors),
}
};
static const struct usb_interface_descriptor data_iface2[] = {{
.bLength = USB_DT_INTERFACE_SIZE,
.bDescriptorType = USB_DT_INTERFACE,
.bInterfaceNumber = 3,
.bAlternateSetting = 0,
.bNumEndpoints = 2,
.bInterfaceClass = USB_CLASS_DATA,
.bInterfaceSubClass = 0,
.bInterfaceProtocol = 0,
.iInterface = 0,
.endpoint = data_endp2,
}
};
static const struct usb_interface_descriptor comm_iface3[] = {{
.bLength = USB_DT_INTERFACE_SIZE,
.bDescriptorType = USB_DT_INTERFACE,
.bInterfaceNumber = 4,
.bAlternateSetting = 0,
.bNumEndpoints = 1,
.bInterfaceClass = USB_CLASS_CDC,
.bInterfaceSubClass = USB_CDC_SUBCLASS_ACM,
.bInterfaceProtocol = USB_CDC_PROTOCOL_AT,
.iInterface = 0,
.endpoint = comm_endp3,
.extra = &cdcacm_functional_descriptors3,
.extralen = sizeof(cdcacm_functional_descriptors),
}
};
static const struct usb_interface_descriptor data_iface3[] = {{
.bLength = USB_DT_INTERFACE_SIZE,
.bDescriptorType = USB_DT_INTERFACE,
.bInterfaceNumber = 5,
.bAlternateSetting = 0,
.bNumEndpoints = 2,
.bInterfaceClass = USB_CLASS_DATA,
.bInterfaceSubClass = 0,
.bInterfaceProtocol = 0,
.iInterface = 0,
.endpoint = data_endp3,
}
};
static const struct usb_interface ifaces[] = {{
.num_altsetting = 1,
.altsetting = comm_iface,
}, {
.num_altsetting = 1,
.altsetting = data_iface,
}, {
.num_altsetting = 1,
.altsetting = comm_iface2,
}, {
.num_altsetting = 1,
.altsetting = data_iface2,
}, {
.num_altsetting = 1,
.altsetting = comm_iface3,
}, {
.num_altsetting = 1,
.altsetting = data_iface3,
}
};
static const struct usb_config_descriptor config = {
.bLength = USB_DT_CONFIGURATION_SIZE,
.bDescriptorType = USB_DT_CONFIGURATION,
.wTotalLength = 0,
.bNumInterfaces = 6,
.bConfigurationValue = 1,
.iConfiguration = 0,
.bmAttributes = 0x80,
.bMaxPower = 0x32,
.interface = ifaces,
};
/* Buffer to be used for control requests. */
static uint8_t usbd_control_buffer[128] ALIGNED;
static int cdcacm_control_request(usbd_device *usbd_dev UNUSED, struct usb_setup_data *req, uint8_t **buf UNUSED,
uint16_t *len, void (**complete)(usbd_device *usbd_dev, struct usb_setup_data *req) UNUSED)
{
switch (req->bRequest) {
case USB_CDC_REQ_SET_CONTROL_LINE_STATE: {
return 1;
}
case USB_CDC_REQ_SET_LINE_CODING:
if (*len < sizeof(struct usb_cdc_line_coding))
return 0;
return 1;
}
return 0;
}
volatile bool usb_ready = false;
static void cdcacm_reset(void)
{
usb_ready = false;
}
static void ep1_rx_callback(usbd_device *usb_dev UNUSED, uint8_t ep);
static void cdcacm_set_config(usbd_device *usbd_dev, uint16_t wValue)
{
usbd_ep_setup(usbd_dev, EP_IN , USB_ENDPOINT_ATTR_BULK, 64, ep1_rx_callback);
usbd_ep_setup(usbd_dev, EP_OUT, USB_ENDPOINT_ATTR_BULK|USB_ENDPOINT_ATTR_DBLBUF, 64, NULL);
usbd_ep_setup(usbd_dev, EP_INT, USB_ENDPOINT_ATTR_INTERRUPT, 16, NULL);
usbd_ep_setup(usbd_dev, EP2_IN , USB_ENDPOINT_ATTR_BULK, 64, NULL);
usbd_ep_setup(usbd_dev, EP2_OUT, USB_ENDPOINT_ATTR_BULK, 64, NULL);
usbd_ep_setup(usbd_dev, EP2_INT, USB_ENDPOINT_ATTR_INTERRUPT, 16, NULL);
usbd_ep_setup(usbd_dev, EP3_IN , USB_ENDPOINT_ATTR_BULK, 64, NULL);
usbd_ep_setup(usbd_dev, EP3_OUT, USB_ENDPOINT_ATTR_BULK, 64, NULL);
usbd_ep_setup(usbd_dev, EP3_INT, USB_ENDPOINT_ATTR_INTERRUPT, 16, NULL);
usbd_register_control_callback(
usbd_dev,
USB_REQ_TYPE_CLASS | USB_REQ_TYPE_INTERFACE,
USB_REQ_TYPE_TYPE | USB_REQ_TYPE_RECIPIENT,
cdcacm_control_request);
if (wValue > 0) {
usb_ready = true;
}
}
static usbd_device *usbd_dev; /* Just a pointer, need not to be volatile. */
static char serial[UID_LEN];
/* Vendor, device, version. */
static const char *usb_strings[] = {
"STM32-LPC",
"VCP for flashrom serprog",
serial,
};
void usbcdc_init(void)
{
desig_get_unique_id_as_string(serial, UID_LEN);
usbd_dev = usbd_init(&st_usbfs_v2_usb_driver, &dev, &config, usb_strings, 3, usbd_control_buffer,
sizeof(usbd_control_buffer));
usbd_register_set_config_callback(usbd_dev, cdcacm_set_config);
usbd_register_reset_callback(usbd_dev, cdcacm_reset);
/* NOTE: Must be called after USB setup since this enables calling usbd_poll(). */
nvic_set_priority(NVIC_USB_IRQ, 255);
nvic_enable_irq(NVIC_USB_IRQ);
}
/* Application-level functions */
uint16_t usbcdc_write(void *buf, size_t len)
{
uint16_t ret;
/* Blocking write */
while (0 == (ret = usbopt_ep_write_packet(usbd_dev, EP_OUT, buf, len)));
return ret;
}
uint16_t usbcdc_write_ch3(void *buf, size_t len)
{
return usbd_ep_write_packet(usbd_dev, EP3_OUT, buf, len);
}
static uint8_t usbcdc_txbuf[256] ALIGNED;
static uint8_t usbcdc_txbuf_cnt = 0;
void usbcdc_putc(uint8_t c)
{
usbcdc_txbuf[usbcdc_txbuf_cnt++] = c;
if (usbcdc_txbuf_cnt >= (128)) {
usbcdc_write(usbcdc_txbuf, usbcdc_txbuf_cnt);
usbcdc_txbuf_cnt = 0;
}
}
#define RX_SLOTS 4
static uint8_t usbcdc_rxbuf[RX_SLOTS][USBCDC_PKT_SIZE_DAT] ALIGNED;
static uint8_t usbcdc_rxbuf_cnt[RX_SLOTS];
static volatile uint8_t usbcdc_rxb_wslot = 0;
static uint8_t usbcdc_rxb_rslot = 0;
static void ep1_rx_cb(int len)
{
uint8_t nslot = (usbcdc_rxb_wslot+1) & (RX_SLOTS-1);
usbcdc_rxbuf_cnt[nslot] = len;
usbcdc_rxb_wslot = nslot;
// DBG("-READ-");
}
static void ep1_rx(void)
{
uint8_t nslot = (usbcdc_rxb_wslot+1) & (RX_SLOTS-1);
if (nslot != usbcdc_rxb_rslot) {
uint16_t l;
if ((l=usbd_ep_read_packet(usbd_dev, EP_IN, usbcdc_rxbuf[nslot], USBCDC_PKT_SIZE_DAT))) {
ep1_rx_cb(l);
}
}
}
static void ep1_rx_callback(usbd_device *usb_dev UNUSED, uint8_t ep UNUSED)
{
// DBG("RXC-");
ep1_rx();
}
static uint16_t usbcdc_fetch_packet(void)
{
if (usbcdc_txbuf_cnt) {
usbcdc_write(usbcdc_txbuf, usbcdc_txbuf_cnt);
usbcdc_txbuf_cnt = 0;
}
// DBG("-FTCH");
/* Blocking read. Assume RX user buffer is empty. TODO: consider setting a timeout */
while (usbcdc_rxb_rslot == usbcdc_rxb_wslot) {
uint16_t dummy;
//DBG("X");
usbd_ep_read_packet(usbd_dev, EP2_IN, &dummy, 2);
//DBG("Y");
usbd_ep_read_packet(usbd_dev, EP3_IN, &dummy, 2);
//DBG("Z");
yield();
}
usbcdc_rxb_rslot = (usbcdc_rxb_rslot+1) & (RX_SLOTS-1);
/* If there was a "skipped" callback due to slots full, give it a kick from here. */
cm_disable_interrupts();
ep1_rx();
cm_enable_interrupts();
return 1;
}
uint8_t usbcdc_getc(void)
{
static uint8_t usbcdc_rxbuf_off = 0;
uint8_t c;
if (usbcdc_rxbuf_off>=usbcdc_rxbuf_cnt[usbcdc_rxb_rslot]) {
usbcdc_fetch_packet();
usbcdc_rxbuf_off = 0;
// DBG("-ED.");
}
c = usbcdc_rxbuf[usbcdc_rxb_rslot][usbcdc_rxbuf_off++];
return c;
}
/* Interrupts */
void usb_isr(void)
{
usbd_poll(usbd_dev);
}