1
2
3
4
5
6
7
8
9
10
11#include "qemu-common.h"
12#include "qemu-error.h"
13#include "usb.h"
14#include "usb-desc.h"
15#include "qemu-char.h"
16
17
18
19#ifdef DEBUG_Serial
20#define DPRINTF(fmt, ...) \
21do { printf("usb-serial: " fmt , ## __VA_ARGS__); } while (0)
22#else
23#define DPRINTF(fmt, ...) do {} while(0)
24#endif
25
26#define RECV_BUF 384
27
28
29#define FTDI_RESET 0
30#define FTDI_SET_MDM_CTRL 1
31#define FTDI_SET_FLOW_CTRL 2
32#define FTDI_SET_BAUD 3
33#define FTDI_SET_DATA 4
34#define FTDI_GET_MDM_ST 5
35#define FTDI_SET_EVENT_CHR 6
36#define FTDI_SET_ERROR_CHR 7
37#define FTDI_SET_LATENCY 9
38#define FTDI_GET_LATENCY 10
39
40#define DeviceOutVendor ((USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8)
41#define DeviceInVendor ((USB_DIR_IN |USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8)
42
43
44
45#define FTDI_RESET_SIO 0
46#define FTDI_RESET_RX 1
47#define FTDI_RESET_TX 2
48
49
50
51#define FTDI_DTR 1
52#define FTDI_SET_DTR (FTDI_DTR << 8)
53#define FTDI_RTS 2
54#define FTDI_SET_RTS (FTDI_RTS << 8)
55
56
57
58#define FTDI_RTS_CTS_HS 1
59#define FTDI_DTR_DSR_HS 2
60#define FTDI_XON_XOFF_HS 4
61
62
63
64#define FTDI_PARITY (0x7 << 8)
65#define FTDI_ODD (0x1 << 8)
66#define FTDI_EVEN (0x2 << 8)
67#define FTDI_MARK (0x3 << 8)
68#define FTDI_SPACE (0x4 << 8)
69
70#define FTDI_STOP (0x3 << 11)
71#define FTDI_STOP1 (0x0 << 11)
72#define FTDI_STOP15 (0x1 << 11)
73#define FTDI_STOP2 (0x2 << 11)
74
75
76
77#define FTDI_CTS (1<<4)
78#define FTDI_DSR (1<<5)
79#define FTDI_RI (1<<6)
80#define FTDI_RLSD (1<<7)
81
82
83
84#define FTDI_DR (1<<0)
85#define FTDI_OE (1<<1)
86#define FTDI_PE (1<<2)
87#define FTDI_FE (1<<3)
88#define FTDI_BI (1<<4)
89#define FTDI_THRE (1<<5)
90#define FTDI_TEMT (1<<6)
91#define FTDI_FIFO (1<<7)
92
93typedef struct {
94 USBDevice dev;
95 uint8_t recv_buf[RECV_BUF];
96 uint16_t recv_ptr;
97 uint16_t recv_used;
98 uint8_t event_chr;
99 uint8_t error_chr;
100 uint8_t event_trigger;
101 QEMUSerialSetParams params;
102 int latency;
103 CharDriverState *cs;
104} USBSerialState;
105
106enum {
107 STR_MANUFACTURER = 1,
108 STR_PRODUCT_SERIAL,
109 STR_PRODUCT_BRAILLE,
110 STR_SERIALNUMBER,
111};
112
113static const USBDescStrings desc_strings = {
114 [STR_MANUFACTURER] = "QEMU " QEMU_VERSION,
115 [STR_PRODUCT_SERIAL] = "QEMU USB SERIAL",
116 [STR_PRODUCT_BRAILLE] = "QEMU USB BRAILLE",
117 [STR_SERIALNUMBER] = "1",
118};
119
120static const USBDescIface desc_iface0 = {
121 .bInterfaceNumber = 0,
122 .bNumEndpoints = 2,
123 .bInterfaceClass = 0xff,
124 .bInterfaceSubClass = 0xff,
125 .bInterfaceProtocol = 0xff,
126 .eps = (USBDescEndpoint[]) {
127 {
128 .bEndpointAddress = USB_DIR_IN | 0x01,
129 .bmAttributes = USB_ENDPOINT_XFER_BULK,
130 .wMaxPacketSize = 64,
131 },{
132 .bEndpointAddress = USB_DIR_OUT | 0x02,
133 .bmAttributes = USB_ENDPOINT_XFER_BULK,
134 .wMaxPacketSize = 64,
135 },
136 }
137};
138
139static const USBDescDevice desc_device = {
140 .bcdUSB = 0x0200,
141 .bMaxPacketSize0 = 8,
142 .bNumConfigurations = 1,
143 .confs = (USBDescConfig[]) {
144 {
145 .bNumInterfaces = 1,
146 .bConfigurationValue = 1,
147 .bmAttributes = 0x80,
148 .bMaxPower = 50,
149 .nif = 1,
150 .ifs = &desc_iface0,
151 },
152 },
153};
154
155static const USBDesc desc_serial = {
156 .id = {
157 .idVendor = 0x0403,
158 .idProduct = 0x6001,
159 .bcdDevice = 0x0400,
160 .iManufacturer = STR_MANUFACTURER,
161 .iProduct = STR_PRODUCT_SERIAL,
162 .iSerialNumber = STR_SERIALNUMBER,
163 },
164 .full = &desc_device,
165 .str = desc_strings,
166};
167
168static const USBDesc desc_braille = {
169 .id = {
170 .idVendor = 0x0403,
171 .idProduct = 0xfe72,
172 .bcdDevice = 0x0400,
173 .iManufacturer = STR_MANUFACTURER,
174 .iProduct = STR_PRODUCT_BRAILLE,
175 .iSerialNumber = STR_SERIALNUMBER,
176 },
177 .full = &desc_device,
178 .str = desc_strings,
179};
180
181static void usb_serial_reset(USBSerialState *s)
182{
183
184 s->event_chr = 0x0d;
185 s->event_trigger = 0;
186 s->recv_ptr = 0;
187 s->recv_used = 0;
188
189}
190
191static void usb_serial_handle_reset(USBDevice *dev)
192{
193 USBSerialState *s = (USBSerialState *)dev;
194
195 DPRINTF("Reset\n");
196
197 usb_serial_reset(s);
198
199}
200
201static uint8_t usb_get_modem_lines(USBSerialState *s)
202{
203 int flags;
204 uint8_t ret;
205
206 if (qemu_chr_fe_ioctl(s->cs, CHR_IOCTL_SERIAL_GET_TIOCM, &flags) == -ENOTSUP)
207 return FTDI_CTS|FTDI_DSR|FTDI_RLSD;
208
209 ret = 0;
210 if (flags & CHR_TIOCM_CTS)
211 ret |= FTDI_CTS;
212 if (flags & CHR_TIOCM_DSR)
213 ret |= FTDI_DSR;
214 if (flags & CHR_TIOCM_RI)
215 ret |= FTDI_RI;
216 if (flags & CHR_TIOCM_CAR)
217 ret |= FTDI_RLSD;
218
219 return ret;
220}
221
222static int usb_serial_handle_control(USBDevice *dev, USBPacket *p,
223 int request, int value, int index, int length, uint8_t *data)
224{
225 USBSerialState *s = (USBSerialState *)dev;
226 int ret;
227
228 DPRINTF("got control %x, value %x\n",request, value);
229 ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
230 if (ret >= 0) {
231 return ret;
232 }
233
234 ret = 0;
235 switch (request) {
236 case DeviceRequest | USB_REQ_GET_INTERFACE:
237 data[0] = 0;
238 ret = 1;
239 break;
240 case InterfaceOutRequest | USB_REQ_SET_INTERFACE:
241 ret = 0;
242 break;
243 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
244 ret = 0;
245 break;
246
247
248 case DeviceOutVendor | FTDI_RESET:
249 switch (value) {
250 case FTDI_RESET_SIO:
251 usb_serial_reset(s);
252 break;
253 case FTDI_RESET_RX:
254 s->recv_ptr = 0;
255 s->recv_used = 0;
256
257 break;
258 case FTDI_RESET_TX:
259
260 break;
261 }
262 break;
263 case DeviceOutVendor | FTDI_SET_MDM_CTRL:
264 {
265 static int flags;
266 qemu_chr_fe_ioctl(s->cs,CHR_IOCTL_SERIAL_GET_TIOCM, &flags);
267 if (value & FTDI_SET_RTS) {
268 if (value & FTDI_RTS)
269 flags |= CHR_TIOCM_RTS;
270 else
271 flags &= ~CHR_TIOCM_RTS;
272 }
273 if (value & FTDI_SET_DTR) {
274 if (value & FTDI_DTR)
275 flags |= CHR_TIOCM_DTR;
276 else
277 flags &= ~CHR_TIOCM_DTR;
278 }
279 qemu_chr_fe_ioctl(s->cs,CHR_IOCTL_SERIAL_SET_TIOCM, &flags);
280 break;
281 }
282 case DeviceOutVendor | FTDI_SET_FLOW_CTRL:
283
284 break;
285 case DeviceOutVendor | FTDI_SET_BAUD: {
286 static const int subdivisors8[8] = { 0, 4, 2, 1, 3, 5, 6, 7 };
287 int subdivisor8 = subdivisors8[((value & 0xc000) >> 14)
288 | ((index & 1) << 2)];
289 int divisor = value & 0x3fff;
290
291
292 if (divisor == 1 && subdivisor8 == 0)
293 subdivisor8 = 4;
294 if (divisor == 0 && subdivisor8 == 0)
295 divisor = 1;
296
297 s->params.speed = (48000000 / 2) / (8 * divisor + subdivisor8);
298 qemu_chr_fe_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params);
299 break;
300 }
301 case DeviceOutVendor | FTDI_SET_DATA:
302 switch (value & FTDI_PARITY) {
303 case 0:
304 s->params.parity = 'N';
305 break;
306 case FTDI_ODD:
307 s->params.parity = 'O';
308 break;
309 case FTDI_EVEN:
310 s->params.parity = 'E';
311 break;
312 default:
313 DPRINTF("unsupported parity %d\n", value & FTDI_PARITY);
314 goto fail;
315 }
316 switch (value & FTDI_STOP) {
317 case FTDI_STOP1:
318 s->params.stop_bits = 1;
319 break;
320 case FTDI_STOP2:
321 s->params.stop_bits = 2;
322 break;
323 default:
324 DPRINTF("unsupported stop bits %d\n", value & FTDI_STOP);
325 goto fail;
326 }
327 qemu_chr_fe_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params);
328
329 break;
330 case DeviceInVendor | FTDI_GET_MDM_ST:
331 data[0] = usb_get_modem_lines(s) | 1;
332 data[1] = 0;
333 ret = 2;
334 break;
335 case DeviceOutVendor | FTDI_SET_EVENT_CHR:
336
337 s->event_chr = value;
338 break;
339 case DeviceOutVendor | FTDI_SET_ERROR_CHR:
340
341 s->error_chr = value;
342 break;
343 case DeviceOutVendor | FTDI_SET_LATENCY:
344 s->latency = value;
345 break;
346 case DeviceInVendor | FTDI_GET_LATENCY:
347 data[0] = s->latency;
348 ret = 1;
349 break;
350 default:
351 fail:
352 DPRINTF("got unsupported/bogus control %x, value %x\n", request, value);
353 ret = USB_RET_STALL;
354 break;
355 }
356 return ret;
357}
358
359static int usb_serial_handle_data(USBDevice *dev, USBPacket *p)
360{
361 USBSerialState *s = (USBSerialState *)dev;
362 int i, ret = 0;
363 uint8_t devep = p->devep;
364 struct iovec *iov;
365 uint8_t header[2];
366 int first_len, len;
367
368 switch (p->pid) {
369 case USB_TOKEN_OUT:
370 if (devep != 2)
371 goto fail;
372 for (i = 0; i < p->iov.niov; i++) {
373 iov = p->iov.iov + i;
374 qemu_chr_fe_write(s->cs, iov->iov_base, iov->iov_len);
375 }
376 break;
377
378 case USB_TOKEN_IN:
379 if (devep != 1)
380 goto fail;
381 first_len = RECV_BUF - s->recv_ptr;
382 len = p->iov.size;
383 if (len <= 2) {
384 ret = USB_RET_NAK;
385 break;
386 }
387 header[0] = usb_get_modem_lines(s) | 1;
388
389
390 if (s->event_trigger && s->event_trigger & FTDI_BI) {
391 s->event_trigger &= ~FTDI_BI;
392 header[1] = FTDI_BI;
393 usb_packet_copy(p, header, 2);
394 ret = 2;
395 break;
396 } else {
397 header[1] = 0;
398 }
399 len -= 2;
400 if (len > s->recv_used)
401 len = s->recv_used;
402 if (!len) {
403 ret = USB_RET_NAK;
404 break;
405 }
406 if (first_len > len)
407 first_len = len;
408 usb_packet_copy(p, header, 2);
409 usb_packet_copy(p, s->recv_buf + s->recv_ptr, first_len);
410 if (len > first_len)
411 usb_packet_copy(p, s->recv_buf, len - first_len);
412 s->recv_used -= len;
413 s->recv_ptr = (s->recv_ptr + len) % RECV_BUF;
414 ret = len + 2;
415 break;
416
417 default:
418 DPRINTF("Bad token\n");
419 fail:
420 ret = USB_RET_STALL;
421 break;
422 }
423
424 return ret;
425}
426
427static void usb_serial_handle_destroy(USBDevice *dev)
428{
429 USBSerialState *s = (USBSerialState *)dev;
430
431 qemu_chr_delete(s->cs);
432}
433
434static int usb_serial_can_read(void *opaque)
435{
436 USBSerialState *s = opaque;
437 return RECV_BUF - s->recv_used;
438}
439
440static void usb_serial_read(void *opaque, const uint8_t *buf, int size)
441{
442 USBSerialState *s = opaque;
443 int first_size, start;
444
445
446 if (size > (RECV_BUF - s->recv_used))
447 size = RECV_BUF - s->recv_used;
448
449 start = s->recv_ptr + s->recv_used;
450 if (start < RECV_BUF) {
451
452 first_size = RECV_BUF - start;
453 if (first_size > size)
454 first_size = size;
455
456 memcpy(s->recv_buf + start, buf, first_size);
457
458
459 if (size > first_size)
460 memcpy(s->recv_buf, buf + first_size, size - first_size);
461 } else {
462 start -= RECV_BUF;
463 memcpy(s->recv_buf + start, buf, size);
464 }
465 s->recv_used += size;
466}
467
468static void usb_serial_event(void *opaque, int event)
469{
470 USBSerialState *s = opaque;
471
472 switch (event) {
473 case CHR_EVENT_BREAK:
474 s->event_trigger |= FTDI_BI;
475 break;
476 case CHR_EVENT_FOCUS:
477 break;
478 case CHR_EVENT_OPENED:
479 usb_serial_reset(s);
480
481 break;
482 }
483}
484
485static int usb_serial_initfn(USBDevice *dev)
486{
487 USBSerialState *s = DO_UPCAST(USBSerialState, dev, dev);
488
489 usb_desc_init(dev);
490
491 if (!s->cs) {
492 error_report("Property chardev is required");
493 return -1;
494 }
495
496 qemu_chr_add_handlers(s->cs, usb_serial_can_read, usb_serial_read,
497 usb_serial_event, s);
498 usb_serial_handle_reset(dev);
499 return 0;
500}
501
502static USBDevice *usb_serial_init(const char *filename)
503{
504 USBDevice *dev;
505 CharDriverState *cdrv;
506 uint32_t vendorid = 0, productid = 0;
507 char label[32];
508 static int index;
509
510 while (*filename && *filename != ':') {
511 const char *p;
512 char *e;
513 if (strstart(filename, "vendorid=", &p)) {
514 vendorid = strtol(p, &e, 16);
515 if (e == p || (*e && *e != ',' && *e != ':')) {
516 error_report("bogus vendor ID %s", p);
517 return NULL;
518 }
519 filename = e;
520 } else if (strstart(filename, "productid=", &p)) {
521 productid = strtol(p, &e, 16);
522 if (e == p || (*e && *e != ',' && *e != ':')) {
523 error_report("bogus product ID %s", p);
524 return NULL;
525 }
526 filename = e;
527 } else {
528 error_report("unrecognized serial USB option %s", filename);
529 return NULL;
530 }
531 while(*filename == ',')
532 filename++;
533 }
534 if (!*filename) {
535 error_report("character device specification needed");
536 return NULL;
537 }
538 filename++;
539
540 snprintf(label, sizeof(label), "usbserial%d", index++);
541 cdrv = qemu_chr_new(label, filename, NULL);
542 if (!cdrv)
543 return NULL;
544
545 dev = usb_create(NULL , "usb-serial");
546 if (!dev) {
547 return NULL;
548 }
549 qdev_prop_set_chr(&dev->qdev, "chardev", cdrv);
550 if (vendorid)
551 qdev_prop_set_uint16(&dev->qdev, "vendorid", vendorid);
552 if (productid)
553 qdev_prop_set_uint16(&dev->qdev, "productid", productid);
554 qdev_init_nofail(&dev->qdev);
555
556 return dev;
557}
558
559static USBDevice *usb_braille_init(const char *unused)
560{
561 USBDevice *dev;
562 CharDriverState *cdrv;
563
564 cdrv = qemu_chr_new("braille", "braille", NULL);
565 if (!cdrv)
566 return NULL;
567
568 dev = usb_create(NULL , "usb-braille");
569 qdev_prop_set_chr(&dev->qdev, "chardev", cdrv);
570 qdev_init_nofail(&dev->qdev);
571
572 return dev;
573}
574
575static const VMStateDescription vmstate_usb_serial = {
576 .name = "usb-serial",
577 .unmigratable = 1,
578};
579
580static struct USBDeviceInfo serial_info = {
581 .product_desc = "QEMU USB Serial",
582 .qdev.name = "usb-serial",
583 .qdev.size = sizeof(USBSerialState),
584 .qdev.vmsd = &vmstate_usb_serial,
585 .usb_desc = &desc_serial,
586 .init = usb_serial_initfn,
587 .handle_packet = usb_generic_handle_packet,
588 .handle_reset = usb_serial_handle_reset,
589 .handle_control = usb_serial_handle_control,
590 .handle_data = usb_serial_handle_data,
591 .handle_destroy = usb_serial_handle_destroy,
592 .usbdevice_name = "serial",
593 .usbdevice_init = usb_serial_init,
594 .qdev.props = (Property[]) {
595 DEFINE_PROP_CHR("chardev", USBSerialState, cs),
596 DEFINE_PROP_END_OF_LIST(),
597 },
598};
599
600static struct USBDeviceInfo braille_info = {
601 .product_desc = "QEMU USB Braille",
602 .qdev.name = "usb-braille",
603 .qdev.size = sizeof(USBSerialState),
604 .qdev.vmsd = &vmstate_usb_serial,
605 .usb_desc = &desc_braille,
606 .init = usb_serial_initfn,
607 .handle_packet = usb_generic_handle_packet,
608 .handle_reset = usb_serial_handle_reset,
609 .handle_control = usb_serial_handle_control,
610 .handle_data = usb_serial_handle_data,
611 .handle_destroy = usb_serial_handle_destroy,
612 .usbdevice_name = "braille",
613 .usbdevice_init = usb_braille_init,
614 .qdev.props = (Property[]) {
615 DEFINE_PROP_CHR("chardev", USBSerialState, cs),
616 DEFINE_PROP_END_OF_LIST(),
617 },
618};
619
620static void usb_serial_register_devices(void)
621{
622 usb_qdev_register(&serial_info);
623 usb_qdev_register(&braille_info);
624}
625device_init(usb_serial_register_devices)
626
