hw/usb-serial.c

   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 licenced under the LGPL.
   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 //#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 " QEMU_VERSION,
 115     [STR_PRODUCT_SERIAL]  = "QEMU USB SERIAL",
 116     [STR_PRODUCT_BRAILLE] = "QEMU USB 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          = 0x80,
 148             .bMaxPower             = 50,
 149             .ifs = &desc_iface0,
 150         },
 151     },
 152 };
 153
 154 static const USBDesc desc_serial = {
 155     .id = {
 156         .idVendor          = 0x0403,
 157         .idProduct         = 0x6001,
 158         .bcdDevice         = 0x0400,
 159         .iManufacturer     = STR_MANUFACTURER,
 160         .iProduct          = STR_PRODUCT_SERIAL,
 161         .iSerialNumber     = STR_SERIALNUMBER,
 162     },
 163     .full = &desc_device,
 164     .str  = desc_strings,
 165 };
 166
 167 static const USBDesc desc_braille = {
 168     .id = {
 169         .idVendor          = 0x0403,
 170         .idProduct         = 0xfe72,
 171         .bcdDevice         = 0x0400,
 172         .iManufacturer     = STR_MANUFACTURER,
 173         .iProduct          = STR_PRODUCT_BRAILLE,
 174         .iSerialNumber     = STR_SERIALNUMBER,
 175     },
 176     .full = &desc_device,
 177     .str  = desc_strings,
 178 };
 179
 180 static void usb_serial_reset(USBSerialState *s)
 181 {
 182     /* TODO: Set flow control to none */
 183     s->event_chr = 0x0d;
 184     s->event_trigger = 0;
 185     s->recv_ptr = 0;
 186     s->recv_used = 0;
 187     /* TODO: purge in char driver */
 188 }
 189
 190 static void usb_serial_handle_reset(USBDevice *dev)
 191 {
 192     USBSerialState *s = (USBSerialState *)dev;
 193
 194     DPRINTF("Reset\n");
 195
 196     usb_serial_reset(s);
 197     /* TODO: Reset char device, send BREAK? */
 198 }
 199
 200 static uint8_t usb_get_modem_lines(USBSerialState *s)
 201 {
 202     int flags;
 203     uint8_t ret;
 204
 205     if (qemu_chr_ioctl(s->cs, CHR_IOCTL_SERIAL_GET_TIOCM, &flags) == -ENOTSUP)
 206         return FTDI_CTS|FTDI_DSR|FTDI_RLSD;
 207
 208     ret = 0;
 209     if (flags & CHR_TIOCM_CTS)
 210         ret |= FTDI_CTS;
 211     if (flags & CHR_TIOCM_DSR)
 212         ret |= FTDI_DSR;
 213     if (flags & CHR_TIOCM_RI)
 214         ret |= FTDI_RI;
 215     if (flags & CHR_TIOCM_CAR)
 216         ret |= FTDI_RLSD;
 217
 218     return ret;
 219 }
 220
 221 static int usb_serial_handle_control(USBDevice *dev, int request, int value,
 222                                   int index, int length, uint8_t *data)
 223 {
 224     USBSerialState *s = (USBSerialState *)dev;
 225     int ret;
 226
 227     DPRINTF("got control %x, value %x\n",request, value);
 228     ret = usb_desc_handle_control(dev, request, value, index, length, data);
 229     if (ret >= 0) {
 230         return ret;
 231     }
 232
 233     ret = 0;
 234     switch (request) {
 235     case DeviceRequest | USB_REQ_GET_STATUS:
 236         data[0] = (0 << USB_DEVICE_SELF_POWERED) |
 237             (dev->remote_wakeup << USB_DEVICE_REMOTE_WAKEUP);
 238         data[1] = 0x00;
 239         ret = 2;
 240         break;
 241     case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
 242         if (value == USB_DEVICE_REMOTE_WAKEUP) {
 243             dev->remote_wakeup = 0;
 244         } else {
 245             goto fail;
 246         }
 247         ret = 0;
 248         break;
 249     case DeviceOutRequest | USB_REQ_SET_FEATURE:
 250         if (value == USB_DEVICE_REMOTE_WAKEUP) {
 251             dev->remote_wakeup = 1;
 252         } else {
 253             goto fail;
 254         }
 255         ret = 0;
 256         break;
 257     case DeviceRequest | USB_REQ_GET_CONFIGURATION:
 258         data[0] = 1;
 259         ret = 1;
 260         break;
 261     case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
 262         ret = 0;
 263         break;
 264     case DeviceRequest | USB_REQ_GET_INTERFACE:
 265         data[0] = 0;
 266         ret = 1;
 267         break;
 268     case InterfaceOutRequest | USB_REQ_SET_INTERFACE:
 269         ret = 0;
 270         break;
 271     case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
 272         ret = 0;
 273         break;
 274
 275         /* Class specific requests.  */
 276     case DeviceOutVendor | FTDI_RESET:
 277         switch (value) {
 278         case FTDI_RESET_SIO:
 279             usb_serial_reset(s);
 280             break;
 281         case FTDI_RESET_RX:
 282             s->recv_ptr = 0;
 283             s->recv_used = 0;
 284             /* TODO: purge from char device */
 285             break;
 286         case FTDI_RESET_TX:
 287             /* TODO: purge from char device */
 288             break;
 289         }
 290         break;
 291     case DeviceOutVendor | FTDI_SET_MDM_CTRL:
 292     {
 293         static int flags;
 294         qemu_chr_ioctl(s->cs,CHR_IOCTL_SERIAL_GET_TIOCM, &flags);
 295         if (value & FTDI_SET_RTS) {
 296             if (value & FTDI_RTS)
 297                 flags |= CHR_TIOCM_RTS;
 298             else
 299                 flags &= ~CHR_TIOCM_RTS;
 300         }
 301         if (value & FTDI_SET_DTR) {
 302             if (value & FTDI_DTR)
 303                 flags |= CHR_TIOCM_DTR;
 304             else
 305                 flags &= ~CHR_TIOCM_DTR;
 306         }
 307         qemu_chr_ioctl(s->cs,CHR_IOCTL_SERIAL_SET_TIOCM, &flags);
 308         break;
 309     }
 310     case DeviceOutVendor | FTDI_SET_FLOW_CTRL:
 311         /* TODO: ioctl */
 312         break;
 313     case DeviceOutVendor | FTDI_SET_BAUD: {
 314         static const int subdivisors8[8] = { 0, 4, 2, 1, 3, 5, 6, 7 };
 315         int subdivisor8 = subdivisors8[((value & 0xc000) >> 14)
 316                                      | ((index & 1) << 2)];
 317         int divisor = value & 0x3fff;
 318
 319         /* chip special cases */
 320         if (divisor == 1 && subdivisor8 == 0)
 321             subdivisor8 = 4;
 322         if (divisor == 0 && subdivisor8 == 0)
 323             divisor = 1;
 324
 325         s->params.speed = (48000000 / 2) / (8 * divisor + subdivisor8);
 326         qemu_chr_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params);
 327         break;
 328     }
 329     case DeviceOutVendor | FTDI_SET_DATA:
 330         switch (value & FTDI_PARITY) {
 331             case 0:
 332                 s->params.parity = 'N';
 333                 break;
 334             case FTDI_ODD:
 335                 s->params.parity = 'O';
 336                 break;
 337             case FTDI_EVEN:
 338                 s->params.parity = 'E';
 339                 break;
 340             default:
 341                 DPRINTF("unsupported parity %d\n", value & FTDI_PARITY);
 342                 goto fail;
 343         }
 344         switch (value & FTDI_STOP) {
 345             case FTDI_STOP1:
 346                 s->params.stop_bits = 1;
 347                 break;
 348             case FTDI_STOP2:
 349                 s->params.stop_bits = 2;
 350                 break;
 351             default:
 352                 DPRINTF("unsupported stop bits %d\n", value & FTDI_STOP);
 353                 goto fail;
 354         }
 355         qemu_chr_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params);
 356         /* TODO: TX ON/OFF */
 357         break;
 358     case DeviceInVendor | FTDI_GET_MDM_ST:
 359         data[0] = usb_get_modem_lines(s) | 1;
 360         data[1] = 0;
 361         ret = 2;
 362         break;
 363     case DeviceOutVendor | FTDI_SET_EVENT_CHR:
 364         /* TODO: handle it */
 365         s->event_chr = value;
 366         break;
 367     case DeviceOutVendor | FTDI_SET_ERROR_CHR:
 368         /* TODO: handle it */
 369         s->error_chr = value;
 370         break;
 371     case DeviceOutVendor | FTDI_SET_LATENCY:
 372         s->latency = value;
 373         break;
 374     case DeviceInVendor | FTDI_GET_LATENCY:
 375         data[0] = s->latency;
 376         ret = 1;
 377         break;
 378     default:
 379     fail:
 380         DPRINTF("got unsupported/bogus control %x, value %x\n", request, value);
 381         ret = USB_RET_STALL;
 382         break;
 383     }
 384     return ret;
 385 }
 386
 387 static int usb_serial_handle_data(USBDevice *dev, USBPacket *p)
 388 {
 389     USBSerialState *s = (USBSerialState *)dev;
 390     int ret = 0;
 391     uint8_t devep = p->devep;
 392     uint8_t *data = p->data;
 393     int len = p->len;
 394     int first_len;
 395
 396     switch (p->pid) {
 397     case USB_TOKEN_OUT:
 398         if (devep != 2)
 399             goto fail;
 400         qemu_chr_write(s->cs, data, len);
 401         break;
 402
 403     case USB_TOKEN_IN:
 404         if (devep != 1)
 405             goto fail;
 406         first_len = RECV_BUF - s->recv_ptr;
 407         if (len <= 2) {
 408             ret = USB_RET_NAK;
 409             break;
 410         }
 411         *data++ = usb_get_modem_lines(s) | 1;
 412         /* We do not have the uart details */
 413         /* handle serial break */
 414         if (s->event_trigger && s->event_trigger & FTDI_BI) {
 415             s->event_trigger &= ~FTDI_BI;
 416             *data = FTDI_BI;
 417             ret = 2;
 418             break;
 419         } else {
 420             *data++ = 0;
 421         }
 422         len -= 2;
 423         if (len > s->recv_used)
 424             len = s->recv_used;
 425         if (!len) {
 426             ret = USB_RET_NAK;
 427             break;
 428         }
 429         if (first_len > len)
 430             first_len = len;
 431         memcpy(data, s->recv_buf + s->recv_ptr, first_len);
 432         if (len > first_len)
 433             memcpy(data + first_len, s->recv_buf, len - first_len);
 434         s->recv_used -= len;
 435         s->recv_ptr = (s->recv_ptr + len) % RECV_BUF;
 436         ret = len + 2;
 437         break;
 438
 439     default:
 440         DPRINTF("Bad token\n");
 441     fail:
 442         ret = USB_RET_STALL;
 443         break;
 444     }
 445
 446     return ret;
 447 }
 448
 449 static void usb_serial_handle_destroy(USBDevice *dev)
 450 {
 451     USBSerialState *s = (USBSerialState *)dev;
 452
 453     qemu_chr_close(s->cs);
 454 }
 455
 456 static int usb_serial_can_read(void *opaque)
 457 {
 458     USBSerialState *s = opaque;
 459     return RECV_BUF - s->recv_used;
 460 }
 461
 462 static void usb_serial_read(void *opaque, const uint8_t *buf, int size)
 463 {
 464     USBSerialState *s = opaque;
 465     int first_size, start;
 466
 467     /* room in the buffer? */
 468     if (size > (RECV_BUF - s->recv_used))
 469         size = RECV_BUF - s->recv_used;
 470
 471     start = s->recv_ptr + s->recv_used;
 472     if (start < RECV_BUF) {
 473         /* copy data to end of buffer */
 474         first_size = RECV_BUF - start;
 475         if (first_size > size)
 476             first_size = size;
 477
 478         memcpy(s->recv_buf + start, buf, first_size);
 479
 480         /* wrap around to front if needed */
 481         if (size > first_size)
 482             memcpy(s->recv_buf, buf + first_size, size - first_size);
 483     } else {
 484         start -= RECV_BUF;
 485         memcpy(s->recv_buf + start, buf, size);
 486     }
 487     s->recv_used += size;
 488 }
 489
 490 static void usb_serial_event(void *opaque, int event)
 491 {
 492     USBSerialState *s = opaque;
 493
 494     switch (event) {
 495         case CHR_EVENT_BREAK:
 496             s->event_trigger |= FTDI_BI;
 497             break;
 498         case CHR_EVENT_FOCUS:
 499             break;
 500         case CHR_EVENT_OPENED:
 501             usb_serial_reset(s);
 502             /* TODO: Reset USB port */
 503             break;
 504     }
 505 }
 506
 507 static int usb_serial_initfn(USBDevice *dev)
 508 {
 509     USBSerialState *s = DO_UPCAST(USBSerialState, dev, dev);
 510     s->dev.speed = USB_SPEED_FULL;
 511
 512     if (!s->cs) {
 513         error_report("Property chardev is required");
 514         return -1;
 515     }
 516
 517     qemu_chr_add_handlers(s->cs, usb_serial_can_read, usb_serial_read,
 518                           usb_serial_event, s);
 519     usb_serial_handle_reset(dev);
 520     return 0;
 521 }
 522
 523 static USBDevice *usb_serial_init(const char *filename)
 524 {
 525     USBDevice *dev;
 526     CharDriverState *cdrv;
 527     uint32_t vendorid = 0, productid = 0;
 528     char label[32];
 529     static int index;
 530
 531     while (*filename && *filename != ':') {
 532         const char *p;
 533         char *e;
 534         if (strstart(filename, "vendorid=", &p)) {
 535             vendorid = strtol(p, &e, 16);
 536             if (e == p || (*e && *e != ',' && *e != ':')) {
 537                 error_report("bogus vendor ID %s", p);
 538                 return NULL;
 539             }
 540             filename = e;
 541         } else if (strstart(filename, "productid=", &p)) {
 542             productid = strtol(p, &e, 16);
 543             if (e == p || (*e && *e != ',' && *e != ':')) {
 544                 error_report("bogus product ID %s", p);
 545                 return NULL;
 546             }
 547             filename = e;
 548         } else {
 549             error_report("unrecognized serial USB option %s", filename);
 550             return NULL;
 551         }
 552         while(*filename == ',')
 553             filename++;
 554     }
 555     if (!*filename) {
 556         error_report("character device specification needed");
 557         return NULL;
 558     }
 559     filename++;
 560
 561     snprintf(label, sizeof(label), "usbserial%d", index++);
 562     cdrv = qemu_chr_open(label, filename, NULL);
 563     if (!cdrv)
 564         return NULL;
 565
 566     dev = usb_create(NULL /* FIXME */, "usb-serial");
 567     if (!dev) {
 568         return NULL;
 569     }
 570     qdev_prop_set_chr(&dev->qdev, "chardev", cdrv);
 571     if (vendorid)
 572         qdev_prop_set_uint16(&dev->qdev, "vendorid", vendorid);
 573     if (productid)
 574         qdev_prop_set_uint16(&dev->qdev, "productid", productid);
 575     qdev_init_nofail(&dev->qdev);
 576
 577     return dev;
 578 }
 579
 580 static USBDevice *usb_braille_init(const char *unused)
 581 {
 582     USBDevice *dev;
 583     CharDriverState *cdrv;
 584
 585     cdrv = qemu_chr_open("braille", "braille", NULL);
 586     if (!cdrv)
 587         return NULL;
 588
 589     dev = usb_create(NULL /* FIXME */, "usb-braille");
 590     qdev_prop_set_chr(&dev->qdev, "chardev", cdrv);
 591     qdev_init_nofail(&dev->qdev);
 592
 593     return dev;
 594 }
 595
 596 static struct USBDeviceInfo serial_info = {
 597     .product_desc   = "QEMU USB Serial",
 598     .qdev.name      = "usb-serial",
 599     .qdev.size      = sizeof(USBSerialState),
 600     .usb_desc       = &desc_serial,
 601     .init           = usb_serial_initfn,
 602     .handle_packet  = usb_generic_handle_packet,
 603     .handle_reset   = usb_serial_handle_reset,
 604     .handle_control = usb_serial_handle_control,
 605     .handle_data    = usb_serial_handle_data,
 606     .handle_destroy = usb_serial_handle_destroy,
 607     .usbdevice_name = "serial",
 608     .usbdevice_init = usb_serial_init,
 609     .qdev.props     = (Property[]) {
 610         DEFINE_PROP_CHR("chardev", USBSerialState, cs),
 611         DEFINE_PROP_END_OF_LIST(),
 612     },
 613 };
 614
 615 static struct USBDeviceInfo braille_info = {
 616     .product_desc   = "QEMU USB Braille",
 617     .qdev.name      = "usb-braille",
 618     .qdev.size      = sizeof(USBSerialState),
 619     .usb_desc       = &desc_braille,
 620     .init           = usb_serial_initfn,
 621     .handle_packet  = usb_generic_handle_packet,
 622     .handle_reset   = usb_serial_handle_reset,
 623     .handle_control = usb_serial_handle_control,
 624     .handle_data    = usb_serial_handle_data,
 625     .handle_destroy = usb_serial_handle_destroy,
 626     .usbdevice_name = "braille",
 627     .usbdevice_init = usb_braille_init,
 628     .qdev.props     = (Property[]) {
 629         DEFINE_PROP_CHR("chardev", USBSerialState, cs),
 630         DEFINE_PROP_END_OF_LIST(),
 631     },
 632 };
 633
 634 static void usb_serial_register_devices(void)
 635 {
 636     usb_qdev_register(&serial_info);
 637     usb_qdev_register(&braille_info);
 638 }
 639 device_init(usb_serial_register_devices)