1 /* 2 * FTDI FT232BM Device emulation 3 * 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 7 * 8 * This code is licensed under the LGPL. 9 */ 10 11 #include "qemu-common.h" 12 #include "monitor/monitor.h" 13 #include "hw/usb.h" 14 #include "hw/usb/desc.h" 15 #include "sysemu/char.h" 16 17 //#define DEBUG_Serial 18 19 #ifdef DEBUG_Serial 20 #define DPRINTF(fmt, ...) \ 21 do { 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 /* Commands */ 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 /* RESET */ 44 45 #define FTDI_RESET_SIO 0 46 #define FTDI_RESET_RX 1 47 #define FTDI_RESET_TX 2 48 49 /* SET_MDM_CTRL */ 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 /* SET_FLOW_CTRL */ 57 58 #define FTDI_RTS_CTS_HS 1 59 #define FTDI_DTR_DSR_HS 2 60 #define FTDI_XON_XOFF_HS 4 61 62 /* SET_DATA */ 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 /* GET_MDM_ST */ 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 81 82 /* Status */ 83 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 92 93 typedef 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; /* ms */ 103 CharDriverState *cs; 104 } USBSerialState; 105 106 enum { 107 STR_MANUFACTURER = 1, 108 STR_PRODUCT_SERIAL, 109 STR_PRODUCT_BRAILLE, 110 STR_SERIALNUMBER, 111 }; 112 113 static const USBDescStrings desc_strings = { 114 [STR_MANUFACTURER] = "QEMU", 115 [STR_PRODUCT_SERIAL] = "QEMU USB SERIAL", 116 [STR_PRODUCT_BRAILLE] = "QEMU USB BAUM BRAILLE", 117 [STR_SERIALNUMBER] = "1", 118 }; 119 120 static 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 139 static 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 = USB_CFG_ATT_ONE, 148 .bMaxPower = 50, 149 .nif = 1, 150 .ifs = &desc_iface0, 151 }, 152 }, 153 }; 154 155 static 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 168 static 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 181 static void usb_serial_reset(USBSerialState *s) 182 { 183 /* TODO: Set flow control to none */ 184 s->event_chr = 0x0d; 185 s->event_trigger = 0; 186 s->recv_ptr = 0; 187 s->recv_used = 0; 188 /* TODO: purge in char driver */ 189 } 190 191 static 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 /* TODO: Reset char device, send BREAK? */ 199 } 200 201 static 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 222 static void 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; 232 } 233 234 switch (request) { 235 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE: 236 break; 237 238 /* Class specific requests. */ 239 case DeviceOutVendor | FTDI_RESET: 240 switch (value) { 241 case FTDI_RESET_SIO: 242 usb_serial_reset(s); 243 break; 244 case FTDI_RESET_RX: 245 s->recv_ptr = 0; 246 s->recv_used = 0; 247 /* TODO: purge from char device */ 248 break; 249 case FTDI_RESET_TX: 250 /* TODO: purge from char device */ 251 break; 252 } 253 break; 254 case DeviceOutVendor | FTDI_SET_MDM_CTRL: 255 { 256 static int flags; 257 qemu_chr_fe_ioctl(s->cs,CHR_IOCTL_SERIAL_GET_TIOCM, &flags); 258 if (value & FTDI_SET_RTS) { 259 if (value & FTDI_RTS) 260 flags |= CHR_TIOCM_RTS; 261 else 262 flags &= ~CHR_TIOCM_RTS; 263 } 264 if (value & FTDI_SET_DTR) { 265 if (value & FTDI_DTR) 266 flags |= CHR_TIOCM_DTR; 267 else 268 flags &= ~CHR_TIOCM_DTR; 269 } 270 qemu_chr_fe_ioctl(s->cs,CHR_IOCTL_SERIAL_SET_TIOCM, &flags); 271 break; 272 } 273 case DeviceOutVendor | FTDI_SET_FLOW_CTRL: 274 /* TODO: ioctl */ 275 break; 276 case DeviceOutVendor | FTDI_SET_BAUD: { 277 static const int subdivisors8[8] = { 0, 4, 2, 1, 3, 5, 6, 7 }; 278 int subdivisor8 = subdivisors8[((value & 0xc000) >> 14) 279 | ((index & 1) << 2)]; 280 int divisor = value & 0x3fff; 281 282 /* chip special cases */ 283 if (divisor == 1 && subdivisor8 == 0) 284 subdivisor8 = 4; 285 if (divisor == 0 && subdivisor8 == 0) 286 divisor = 1; 287 288 s->params.speed = (48000000 / 2) / (8 * divisor + subdivisor8); 289 qemu_chr_fe_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params); 290 break; 291 } 292 case DeviceOutVendor | FTDI_SET_DATA: 293 switch (value & FTDI_PARITY) { 294 case 0: 295 s->params.parity = 'N'; 296 break; 297 case FTDI_ODD: 298 s->params.parity = 'O'; 299 break; 300 case FTDI_EVEN: 301 s->params.parity = 'E'; 302 break; 303 default: 304 DPRINTF("unsupported parity %d\n", value & FTDI_PARITY); 305 goto fail; 306 } 307 switch (value & FTDI_STOP) { 308 case FTDI_STOP1: 309 s->params.stop_bits = 1; 310 break; 311 case FTDI_STOP2: 312 s->params.stop_bits = 2; 313 break; 314 default: 315 DPRINTF("unsupported stop bits %d\n", value & FTDI_STOP); 316 goto fail; 317 } 318 qemu_chr_fe_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params); 319 /* TODO: TX ON/OFF */ 320 break; 321 case DeviceInVendor | FTDI_GET_MDM_ST: 322 data[0] = usb_get_modem_lines(s) | 1; 323 data[1] = 0; 324 p->actual_length = 2; 325 break; 326 case DeviceOutVendor | FTDI_SET_EVENT_CHR: 327 /* TODO: handle it */ 328 s->event_chr = value; 329 break; 330 case DeviceOutVendor | FTDI_SET_ERROR_CHR: 331 /* TODO: handle it */ 332 s->error_chr = value; 333 break; 334 case DeviceOutVendor | FTDI_SET_LATENCY: 335 s->latency = value; 336 break; 337 case DeviceInVendor | FTDI_GET_LATENCY: 338 data[0] = s->latency; 339 p->actual_length = 1; 340 break; 341 default: 342 fail: 343 DPRINTF("got unsupported/bogus control %x, value %x\n", request, value); 344 p->status = USB_RET_STALL; 345 break; 346 } 347 } 348 349 static void usb_serial_handle_data(USBDevice *dev, USBPacket *p) 350 { 351 USBSerialState *s = (USBSerialState *)dev; 352 uint8_t devep = p->ep->nr; 353 struct iovec *iov; 354 uint8_t header[2]; 355 int i, first_len, len; 356 357 switch (p->pid) { 358 case USB_TOKEN_OUT: 359 if (devep != 2) 360 goto fail; 361 for (i = 0; i < p->iov.niov; i++) { 362 iov = p->iov.iov + i; 363 qemu_chr_fe_write(s->cs, iov->iov_base, iov->iov_len); 364 } 365 p->actual_length = p->iov.size; 366 break; 367 368 case USB_TOKEN_IN: 369 if (devep != 1) 370 goto fail; 371 first_len = RECV_BUF - s->recv_ptr; 372 len = p->iov.size; 373 if (len <= 2) { 374 p->status = USB_RET_NAK; 375 break; 376 } 377 header[0] = usb_get_modem_lines(s) | 1; 378 /* We do not have the uart details */ 379 /* handle serial break */ 380 if (s->event_trigger && s->event_trigger & FTDI_BI) { 381 s->event_trigger &= ~FTDI_BI; 382 header[1] = FTDI_BI; 383 usb_packet_copy(p, header, 2); 384 break; 385 } else { 386 header[1] = 0; 387 } 388 len -= 2; 389 if (len > s->recv_used) 390 len = s->recv_used; 391 if (!len) { 392 p->status = USB_RET_NAK; 393 break; 394 } 395 if (first_len > len) 396 first_len = len; 397 usb_packet_copy(p, header, 2); 398 usb_packet_copy(p, s->recv_buf + s->recv_ptr, first_len); 399 if (len > first_len) 400 usb_packet_copy(p, s->recv_buf, len - first_len); 401 s->recv_used -= len; 402 s->recv_ptr = (s->recv_ptr + len) % RECV_BUF; 403 break; 404 405 default: 406 DPRINTF("Bad token\n"); 407 fail: 408 p->status = USB_RET_STALL; 409 break; 410 } 411 } 412 413 static int usb_serial_can_read(void *opaque) 414 { 415 USBSerialState *s = opaque; 416 417 if (!s->dev.attached) { 418 return 0; 419 } 420 return RECV_BUF - s->recv_used; 421 } 422 423 static void usb_serial_read(void *opaque, const uint8_t *buf, int size) 424 { 425 USBSerialState *s = opaque; 426 int first_size, start; 427 428 /* room in the buffer? */ 429 if (size > (RECV_BUF - s->recv_used)) 430 size = RECV_BUF - s->recv_used; 431 432 start = s->recv_ptr + s->recv_used; 433 if (start < RECV_BUF) { 434 /* copy data to end of buffer */ 435 first_size = RECV_BUF - start; 436 if (first_size > size) 437 first_size = size; 438 439 memcpy(s->recv_buf + start, buf, first_size); 440 441 /* wrap around to front if needed */ 442 if (size > first_size) 443 memcpy(s->recv_buf, buf + first_size, size - first_size); 444 } else { 445 start -= RECV_BUF; 446 memcpy(s->recv_buf + start, buf, size); 447 } 448 s->recv_used += size; 449 } 450 451 static void usb_serial_event(void *opaque, int event) 452 { 453 USBSerialState *s = opaque; 454 455 switch (event) { 456 case CHR_EVENT_BREAK: 457 s->event_trigger |= FTDI_BI; 458 break; 459 case CHR_EVENT_FOCUS: 460 break; 461 case CHR_EVENT_OPENED: 462 if (!s->dev.attached) { 463 usb_device_attach(&s->dev, &error_abort); 464 } 465 break; 466 case CHR_EVENT_CLOSED: 467 if (s->dev.attached) { 468 usb_device_detach(&s->dev); 469 } 470 break; 471 } 472 } 473 474 static void usb_serial_realize(USBDevice *dev, Error **errp) 475 { 476 USBSerialState *s = DO_UPCAST(USBSerialState, dev, dev); 477 Error *local_err = NULL; 478 479 usb_desc_create_serial(dev); 480 usb_desc_init(dev); 481 dev->auto_attach = 0; 482 483 if (!s->cs) { 484 error_setg(errp, "Property chardev is required"); 485 return; 486 } 487 488 usb_check_attach(dev, &local_err); 489 if (local_err) { 490 error_propagate(errp, local_err); 491 return; 492 } 493 494 qemu_chr_add_handlers(s->cs, usb_serial_can_read, usb_serial_read, 495 usb_serial_event, s); 496 usb_serial_handle_reset(dev); 497 498 if (s->cs->be_open && !dev->attached) { 499 usb_device_attach(dev, &error_abort); 500 } 501 } 502 503 static USBDevice *usb_serial_init(USBBus *bus, const char *filename) 504 { 505 USBDevice *dev; 506 CharDriverState *cdrv; 507 uint32_t vendorid = 0, productid = 0; 508 char label[32]; 509 static int index; 510 511 while (*filename && *filename != ':') { 512 const char *p; 513 char *e; 514 if (strstart(filename, "vendorid=", &p)) { 515 vendorid = strtol(p, &e, 16); 516 if (e == p || (*e && *e != ',' && *e != ':')) { 517 error_report("bogus vendor ID %s", p); 518 return NULL; 519 } 520 filename = e; 521 } else if (strstart(filename, "productid=", &p)) { 522 productid = strtol(p, &e, 16); 523 if (e == p || (*e && *e != ',' && *e != ':')) { 524 error_report("bogus product ID %s", p); 525 return NULL; 526 } 527 filename = e; 528 } else { 529 error_report("unrecognized serial USB option %s", filename); 530 return NULL; 531 } 532 while(*filename == ',') 533 filename++; 534 } 535 if (!*filename) { 536 error_report("character device specification needed"); 537 return NULL; 538 } 539 filename++; 540 541 snprintf(label, sizeof(label), "usbserial%d", index++); 542 cdrv = qemu_chr_new(label, filename, NULL); 543 if (!cdrv) 544 return NULL; 545 546 dev = usb_create(bus, "usb-serial"); 547 if (!dev) { 548 return NULL; 549 } 550 qdev_prop_set_chr(&dev->qdev, "chardev", cdrv); 551 if (vendorid) 552 qdev_prop_set_uint16(&dev->qdev, "vendorid", vendorid); 553 if (productid) 554 qdev_prop_set_uint16(&dev->qdev, "productid", productid); 555 qdev_init_nofail(&dev->qdev); 556 557 return dev; 558 } 559 560 static USBDevice *usb_braille_init(USBBus *bus, const char *unused) 561 { 562 USBDevice *dev; 563 CharDriverState *cdrv; 564 565 cdrv = qemu_chr_new("braille", "braille", NULL); 566 if (!cdrv) 567 return NULL; 568 569 dev = usb_create(bus, "usb-braille"); 570 qdev_prop_set_chr(&dev->qdev, "chardev", cdrv); 571 qdev_init_nofail(&dev->qdev); 572 573 return dev; 574 } 575 576 static const VMStateDescription vmstate_usb_serial = { 577 .name = "usb-serial", 578 .unmigratable = 1, 579 }; 580 581 static Property serial_properties[] = { 582 DEFINE_PROP_CHR("chardev", USBSerialState, cs), 583 DEFINE_PROP_END_OF_LIST(), 584 }; 585 586 static void usb_serial_class_initfn(ObjectClass *klass, void *data) 587 { 588 DeviceClass *dc = DEVICE_CLASS(klass); 589 USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 590 591 uc->realize = usb_serial_realize; 592 uc->product_desc = "QEMU USB Serial"; 593 uc->usb_desc = &desc_serial; 594 uc->handle_reset = usb_serial_handle_reset; 595 uc->handle_control = usb_serial_handle_control; 596 uc->handle_data = usb_serial_handle_data; 597 dc->vmsd = &vmstate_usb_serial; 598 dc->props = serial_properties; 599 set_bit(DEVICE_CATEGORY_INPUT, dc->categories); 600 } 601 602 static const TypeInfo serial_info = { 603 .name = "usb-serial", 604 .parent = TYPE_USB_DEVICE, 605 .instance_size = sizeof(USBSerialState), 606 .class_init = usb_serial_class_initfn, 607 }; 608 609 static Property braille_properties[] = { 610 DEFINE_PROP_CHR("chardev", USBSerialState, cs), 611 DEFINE_PROP_END_OF_LIST(), 612 }; 613 614 static void usb_braille_class_initfn(ObjectClass *klass, void *data) 615 { 616 DeviceClass *dc = DEVICE_CLASS(klass); 617 USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 618 619 uc->realize = usb_serial_realize; 620 uc->product_desc = "QEMU USB Braille"; 621 uc->usb_desc = &desc_braille; 622 uc->handle_reset = usb_serial_handle_reset; 623 uc->handle_control = usb_serial_handle_control; 624 uc->handle_data = usb_serial_handle_data; 625 dc->vmsd = &vmstate_usb_serial; 626 dc->props = braille_properties; 627 set_bit(DEVICE_CATEGORY_INPUT, dc->categories); 628 } 629 630 static const TypeInfo braille_info = { 631 .name = "usb-braille", 632 .parent = TYPE_USB_DEVICE, 633 .instance_size = sizeof(USBSerialState), 634 .class_init = usb_braille_class_initfn, 635 }; 636 637 static void usb_serial_register_types(void) 638 { 639 type_register_static(&serial_info); 640 usb_legacy_register("usb-serial", "serial", usb_serial_init); 641 type_register_static(&braille_info); 642 usb_legacy_register("usb-braille", "braille", usb_braille_init); 643 } 644 645 type_init(usb_serial_register_types) 646