2 * FTDI FT232BM Device emulation
4 * Copyright (c) 2006 CodeSourcery.
5 * Copyright (c) 2008 Samuel Thibault <samuel.thibault@ens-lyon.org>
6 * Written by Paul Brook, reused for FTDI by Samuel Thibault
8 * This code is licensed under the LGPL.
11 #include "qemu-common.h"
12 #include "qemu/error-report.h"
14 #include "hw/usb/desc.h"
15 #include "sysemu/char.h"
17 //#define DEBUG_Serial
20 #define DPRINTF(fmt, ...) \
21 do { printf("usb-serial: " fmt , ## __VA_ARGS__); } while (0)
23 #define DPRINTF(fmt, ...) do {} while(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
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)
45 #define FTDI_RESET_SIO 0
46 #define FTDI_RESET_RX 1
47 #define FTDI_RESET_TX 2
52 #define FTDI_SET_DTR (FTDI_DTR << 8)
54 #define FTDI_SET_RTS (FTDI_RTS << 8)
58 #define FTDI_RTS_CTS_HS 1
59 #define FTDI_DTR_DSR_HS 2
60 #define FTDI_XON_XOFF_HS 4
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)
70 #define FTDI_STOP (0x3 << 11)
71 #define FTDI_STOP1 (0x0 << 11)
72 #define FTDI_STOP15 (0x1 << 11)
73 #define FTDI_STOP2 (0x2 << 11)
76 /* TODO: should be sent every 40ms */
77 #define FTDI_CTS (1<<4) // CTS line status
78 #define FTDI_DSR (1<<5) // DSR line status
79 #define FTDI_RI (1<<6) // RI line status
80 #define FTDI_RLSD (1<<7) // Receive Line Signal Detect
84 #define FTDI_DR (1<<0) // Data Ready
85 #define FTDI_OE (1<<1) // Overrun Err
86 #define FTDI_PE (1<<2) // Parity Err
87 #define FTDI_FE (1<<3) // Framing Err
88 #define FTDI_BI (1<<4) // Break Interrupt
89 #define FTDI_THRE (1<<5) // Transmitter Holding Register
90 #define FTDI_TEMT (1<<6) // Transmitter Empty
91 #define FTDI_FIFO (1<<7) // Error in FIFO
95 uint8_t recv_buf[RECV_BUF];
100 uint8_t event_trigger;
101 QEMUSerialSetParams params;
102 int latency; /* ms */
106 #define TYPE_USB_SERIAL "usb-serial-dev"
107 #define USB_SERIAL_DEV(obj) OBJECT_CHECK(USBSerialState, (obj), TYPE_USB_SERIAL)
110 STR_MANUFACTURER = 1,
116 static const USBDescStrings desc_strings = {
117 [STR_MANUFACTURER] = "QEMU",
118 [STR_PRODUCT_SERIAL] = "QEMU USB SERIAL",
119 [STR_PRODUCT_BRAILLE] = "QEMU USB BAUM BRAILLE",
120 [STR_SERIALNUMBER] = "1",
123 static const USBDescIface desc_iface0 = {
124 .bInterfaceNumber = 0,
126 .bInterfaceClass = 0xff,
127 .bInterfaceSubClass = 0xff,
128 .bInterfaceProtocol = 0xff,
129 .eps = (USBDescEndpoint[]) {
131 .bEndpointAddress = USB_DIR_IN | 0x01,
132 .bmAttributes = USB_ENDPOINT_XFER_BULK,
133 .wMaxPacketSize = 64,
135 .bEndpointAddress = USB_DIR_OUT | 0x02,
136 .bmAttributes = USB_ENDPOINT_XFER_BULK,
137 .wMaxPacketSize = 64,
142 static const USBDescDevice desc_device = {
144 .bMaxPacketSize0 = 8,
145 .bNumConfigurations = 1,
146 .confs = (USBDescConfig[]) {
149 .bConfigurationValue = 1,
150 .bmAttributes = USB_CFG_ATT_ONE,
158 static const USBDesc desc_serial = {
163 .iManufacturer = STR_MANUFACTURER,
164 .iProduct = STR_PRODUCT_SERIAL,
165 .iSerialNumber = STR_SERIALNUMBER,
167 .full = &desc_device,
171 static const USBDesc desc_braille = {
176 .iManufacturer = STR_MANUFACTURER,
177 .iProduct = STR_PRODUCT_BRAILLE,
178 .iSerialNumber = STR_SERIALNUMBER,
180 .full = &desc_device,
184 static void usb_serial_reset(USBSerialState *s)
186 /* TODO: Set flow control to none */
188 s->event_trigger = 0;
191 /* TODO: purge in char driver */
194 static void usb_serial_handle_reset(USBDevice *dev)
196 USBSerialState *s = (USBSerialState *)dev;
201 /* TODO: Reset char device, send BREAK? */
204 static uint8_t usb_get_modem_lines(USBSerialState *s)
209 if (qemu_chr_fe_ioctl(s->cs, CHR_IOCTL_SERIAL_GET_TIOCM, &flags) == -ENOTSUP)
210 return FTDI_CTS|FTDI_DSR|FTDI_RLSD;
213 if (flags & CHR_TIOCM_CTS)
215 if (flags & CHR_TIOCM_DSR)
217 if (flags & CHR_TIOCM_RI)
219 if (flags & CHR_TIOCM_CAR)
225 static void usb_serial_handle_control(USBDevice *dev, USBPacket *p,
226 int request, int value, int index, int length, uint8_t *data)
228 USBSerialState *s = (USBSerialState *)dev;
231 DPRINTF("got control %x, value %x\n",request, value);
232 ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
238 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
241 /* Class specific requests. */
242 case DeviceOutVendor | FTDI_RESET:
250 /* TODO: purge from char device */
253 /* TODO: purge from char device */
257 case DeviceOutVendor | FTDI_SET_MDM_CTRL:
260 qemu_chr_fe_ioctl(s->cs,CHR_IOCTL_SERIAL_GET_TIOCM, &flags);
261 if (value & FTDI_SET_RTS) {
262 if (value & FTDI_RTS)
263 flags |= CHR_TIOCM_RTS;
265 flags &= ~CHR_TIOCM_RTS;
267 if (value & FTDI_SET_DTR) {
268 if (value & FTDI_DTR)
269 flags |= CHR_TIOCM_DTR;
271 flags &= ~CHR_TIOCM_DTR;
273 qemu_chr_fe_ioctl(s->cs,CHR_IOCTL_SERIAL_SET_TIOCM, &flags);
276 case DeviceOutVendor | FTDI_SET_FLOW_CTRL:
279 case DeviceOutVendor | FTDI_SET_BAUD: {
280 static const int subdivisors8[8] = { 0, 4, 2, 1, 3, 5, 6, 7 };
281 int subdivisor8 = subdivisors8[((value & 0xc000) >> 14)
282 | ((index & 1) << 2)];
283 int divisor = value & 0x3fff;
285 /* chip special cases */
286 if (divisor == 1 && subdivisor8 == 0)
288 if (divisor == 0 && subdivisor8 == 0)
291 s->params.speed = (48000000 / 2) / (8 * divisor + subdivisor8);
292 qemu_chr_fe_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params);
295 case DeviceOutVendor | FTDI_SET_DATA:
296 switch (value & FTDI_PARITY) {
298 s->params.parity = 'N';
301 s->params.parity = 'O';
304 s->params.parity = 'E';
307 DPRINTF("unsupported parity %d\n", value & FTDI_PARITY);
310 switch (value & FTDI_STOP) {
312 s->params.stop_bits = 1;
315 s->params.stop_bits = 2;
318 DPRINTF("unsupported stop bits %d\n", value & FTDI_STOP);
321 qemu_chr_fe_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params);
322 /* TODO: TX ON/OFF */
324 case DeviceInVendor | FTDI_GET_MDM_ST:
325 data[0] = usb_get_modem_lines(s) | 1;
327 p->actual_length = 2;
329 case DeviceOutVendor | FTDI_SET_EVENT_CHR:
330 /* TODO: handle it */
331 s->event_chr = value;
333 case DeviceOutVendor | FTDI_SET_ERROR_CHR:
334 /* TODO: handle it */
335 s->error_chr = value;
337 case DeviceOutVendor | FTDI_SET_LATENCY:
340 case DeviceInVendor | FTDI_GET_LATENCY:
341 data[0] = s->latency;
342 p->actual_length = 1;
346 DPRINTF("got unsupported/bogus control %x, value %x\n", request, value);
347 p->status = USB_RET_STALL;
352 static void usb_serial_handle_data(USBDevice *dev, USBPacket *p)
354 USBSerialState *s = (USBSerialState *)dev;
355 uint8_t devep = p->ep->nr;
358 int i, first_len, len;
364 for (i = 0; i < p->iov.niov; i++) {
365 iov = p->iov.iov + i;
366 qemu_chr_fe_write(s->cs, iov->iov_base, iov->iov_len);
368 p->actual_length = p->iov.size;
374 first_len = RECV_BUF - s->recv_ptr;
377 p->status = USB_RET_NAK;
380 header[0] = usb_get_modem_lines(s) | 1;
381 /* We do not have the uart details */
382 /* handle serial break */
383 if (s->event_trigger && s->event_trigger & FTDI_BI) {
384 s->event_trigger &= ~FTDI_BI;
386 usb_packet_copy(p, header, 2);
392 if (len > s->recv_used)
395 p->status = USB_RET_NAK;
400 usb_packet_copy(p, header, 2);
401 usb_packet_copy(p, s->recv_buf + s->recv_ptr, first_len);
403 usb_packet_copy(p, s->recv_buf, len - first_len);
405 s->recv_ptr = (s->recv_ptr + len) % RECV_BUF;
409 DPRINTF("Bad token\n");
411 p->status = USB_RET_STALL;
416 static int usb_serial_can_read(void *opaque)
418 USBSerialState *s = opaque;
420 if (!s->dev.attached) {
423 return RECV_BUF - s->recv_used;
426 static void usb_serial_read(void *opaque, const uint8_t *buf, int size)
428 USBSerialState *s = opaque;
429 int first_size, start;
431 /* room in the buffer? */
432 if (size > (RECV_BUF - s->recv_used))
433 size = RECV_BUF - s->recv_used;
435 start = s->recv_ptr + s->recv_used;
436 if (start < RECV_BUF) {
437 /* copy data to end of buffer */
438 first_size = RECV_BUF - start;
439 if (first_size > size)
442 memcpy(s->recv_buf + start, buf, first_size);
444 /* wrap around to front if needed */
445 if (size > first_size)
446 memcpy(s->recv_buf, buf + first_size, size - first_size);
449 memcpy(s->recv_buf + start, buf, size);
451 s->recv_used += size;
454 static void usb_serial_event(void *opaque, int event)
456 USBSerialState *s = opaque;
459 case CHR_EVENT_BREAK:
460 s->event_trigger |= FTDI_BI;
462 case CHR_EVENT_FOCUS:
464 case CHR_EVENT_OPENED:
465 if (!s->dev.attached) {
466 usb_device_attach(&s->dev, &error_abort);
469 case CHR_EVENT_CLOSED:
470 if (s->dev.attached) {
471 usb_device_detach(&s->dev);
477 static void usb_serial_realize(USBDevice *dev, Error **errp)
479 USBSerialState *s = USB_SERIAL_DEV(dev);
480 Error *local_err = NULL;
482 usb_desc_create_serial(dev);
484 dev->auto_attach = 0;
487 error_setg(errp, "Property chardev is required");
491 usb_check_attach(dev, &local_err);
493 error_propagate(errp, local_err);
497 qemu_chr_add_handlers(s->cs, usb_serial_can_read, usb_serial_read,
498 usb_serial_event, s);
499 usb_serial_handle_reset(dev);
501 if (s->cs->be_open && !dev->attached) {
502 usb_device_attach(dev, &error_abort);
506 static USBDevice *usb_serial_init(USBBus *bus, const char *filename)
509 CharDriverState *cdrv;
510 uint32_t vendorid = 0, productid = 0;
514 while (*filename && *filename != ':') {
517 if (strstart(filename, "vendorid=", &p)) {
518 vendorid = strtol(p, &e, 16);
519 if (e == p || (*e && *e != ',' && *e != ':')) {
520 error_report("bogus vendor ID %s", p);
524 } else if (strstart(filename, "productid=", &p)) {
525 productid = strtol(p, &e, 16);
526 if (e == p || (*e && *e != ',' && *e != ':')) {
527 error_report("bogus product ID %s", p);
532 error_report("unrecognized serial USB option %s", filename);
535 while(*filename == ',')
539 error_report("character device specification needed");
544 snprintf(label, sizeof(label), "usbserial%d", index++);
545 cdrv = qemu_chr_new(label, filename, NULL);
549 dev = usb_create(bus, "usb-serial");
550 qdev_prop_set_chr(&dev->qdev, "chardev", cdrv);
552 qdev_prop_set_uint16(&dev->qdev, "vendorid", vendorid);
554 qdev_prop_set_uint16(&dev->qdev, "productid", productid);
558 static USBDevice *usb_braille_init(USBBus *bus, const char *unused)
561 CharDriverState *cdrv;
563 cdrv = qemu_chr_new("braille", "braille", NULL);
567 dev = usb_create(bus, "usb-braille");
568 qdev_prop_set_chr(&dev->qdev, "chardev", cdrv);
572 static const VMStateDescription vmstate_usb_serial = {
573 .name = "usb-serial",
577 static Property serial_properties[] = {
578 DEFINE_PROP_CHR("chardev", USBSerialState, cs),
579 DEFINE_PROP_END_OF_LIST(),
582 static void usb_serial_dev_class_init(ObjectClass *klass, void *data)
584 DeviceClass *dc = DEVICE_CLASS(klass);
585 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
587 uc->realize = usb_serial_realize;
588 uc->handle_reset = usb_serial_handle_reset;
589 uc->handle_control = usb_serial_handle_control;
590 uc->handle_data = usb_serial_handle_data;
591 dc->vmsd = &vmstate_usb_serial;
592 set_bit(DEVICE_CATEGORY_INPUT, dc->categories);
595 static const TypeInfo usb_serial_dev_type_info = {
596 .name = TYPE_USB_SERIAL,
597 .parent = TYPE_USB_DEVICE,
598 .instance_size = sizeof(USBSerialState),
600 .class_init = usb_serial_dev_class_init,
603 static void usb_serial_class_initfn(ObjectClass *klass, void *data)
605 DeviceClass *dc = DEVICE_CLASS(klass);
606 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
608 uc->product_desc = "QEMU USB Serial";
609 uc->usb_desc = &desc_serial;
610 dc->props = serial_properties;
613 static const TypeInfo serial_info = {
614 .name = "usb-serial",
615 .parent = TYPE_USB_SERIAL,
616 .class_init = usb_serial_class_initfn,
619 static Property braille_properties[] = {
620 DEFINE_PROP_CHR("chardev", USBSerialState, cs),
621 DEFINE_PROP_END_OF_LIST(),
624 static void usb_braille_class_initfn(ObjectClass *klass, void *data)
626 DeviceClass *dc = DEVICE_CLASS(klass);
627 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
629 uc->product_desc = "QEMU USB Braille";
630 uc->usb_desc = &desc_braille;
631 dc->props = braille_properties;
634 static const TypeInfo braille_info = {
635 .name = "usb-braille",
636 .parent = TYPE_USB_SERIAL,
637 .class_init = usb_braille_class_initfn,
640 static void usb_serial_register_types(void)
642 type_register_static(&usb_serial_dev_type_info);
643 type_register_static(&serial_info);
644 usb_legacy_register("usb-serial", "serial", usb_serial_init);
645 type_register_static(&braille_info);
646 usb_legacy_register("usb-braille", "braille", usb_braille_init);
649 type_init(usb_serial_register_types)