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_INTERFACE:
 258         data[0] = 0;
 259         ret = 1;
 260         break;
 261     case InterfaceOutRequest | USB_REQ_SET_INTERFACE:
 262         ret = 0;
 263         break;
 264     case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
 265         ret = 0;
 266         break;
 267
 268         /* Class specific requests.  */
 269     case DeviceOutVendor | FTDI_RESET:
 270         switch (value) {
 271         case FTDI_RESET_SIO:
 272             usb_serial_reset(s);
 273             break;
 274         case FTDI_RESET_RX:
 275             s->recv_ptr = 0;
 276             s->recv_used = 0;
 277             /* TODO: purge from char device */
 278             break;
 279         case FTDI_RESET_TX:
 280             /* TODO: purge from char device */
 281             break;
 282         }
 283         break;
 284     case DeviceOutVendor | FTDI_SET_MDM_CTRL:
 285     {
 286         static int flags;
 287         qemu_chr_ioctl(s->cs,CHR_IOCTL_SERIAL_GET_TIOCM, &flags);
 288         if (value & FTDI_SET_RTS) {
 289             if (value & FTDI_RTS)
 290                 flags |= CHR_TIOCM_RTS;
 291             else
 292                 flags &= ~CHR_TIOCM_RTS;
 293         }
 294         if (value & FTDI_SET_DTR) {
 295             if (value & FTDI_DTR)
 296                 flags |= CHR_TIOCM_DTR;
 297             else
 298                 flags &= ~CHR_TIOCM_DTR;
 299         }
 300         qemu_chr_ioctl(s->cs,CHR_IOCTL_SERIAL_SET_TIOCM, &flags);
 301         break;
 302     }
 303     case DeviceOutVendor | FTDI_SET_FLOW_CTRL:
 304         /* TODO: ioctl */
 305         break;
 306     case DeviceOutVendor | FTDI_SET_BAUD: {
 307         static const int subdivisors8[8] = { 0, 4, 2, 1, 3, 5, 6, 7 };
 308         int subdivisor8 = subdivisors8[((value & 0xc000) >> 14)
 309                                      | ((index & 1) << 2)];
 310         int divisor = value & 0x3fff;
 311
 312         /* chip special cases */
 313         if (divisor == 1 && subdivisor8 == 0)
 314             subdivisor8 = 4;
 315         if (divisor == 0 && subdivisor8 == 0)
 316             divisor = 1;
 317
 318         s->params.speed = (48000000 / 2) / (8 * divisor + subdivisor8);
 319         qemu_chr_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params);
 320         break;
 321     }
 322     case DeviceOutVendor | FTDI_SET_DATA:
 323         switch (value & FTDI_PARITY) {
 324             case 0:
 325                 s->params.parity = 'N';
 326                 break;
 327             case FTDI_ODD:
 328                 s->params.parity = 'O';
 329                 break;
 330             case FTDI_EVEN:
 331                 s->params.parity = 'E';
 332                 break;
 333             default:
 334                 DPRINTF("unsupported parity %d\n", value & FTDI_PARITY);
 335                 goto fail;
 336         }
 337         switch (value & FTDI_STOP) {
 338             case FTDI_STOP1:
 339                 s->params.stop_bits = 1;
 340                 break;
 341             case FTDI_STOP2:
 342                 s->params.stop_bits = 2;
 343                 break;
 344             default:
 345                 DPRINTF("unsupported stop bits %d\n", value & FTDI_STOP);
 346                 goto fail;
 347         }
 348         qemu_chr_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params);
 349         /* TODO: TX ON/OFF */
 350         break;
 351     case DeviceInVendor | FTDI_GET_MDM_ST:
 352         data[0] = usb_get_modem_lines(s) | 1;
 353         data[1] = 0;
 354         ret = 2;
 355         break;
 356     case DeviceOutVendor | FTDI_SET_EVENT_CHR:
 357         /* TODO: handle it */
 358         s->event_chr = value;
 359         break;
 360     case DeviceOutVendor | FTDI_SET_ERROR_CHR:
 361         /* TODO: handle it */
 362         s->error_chr = value;
 363         break;
 364     case DeviceOutVendor | FTDI_SET_LATENCY:
 365         s->latency = value;
 366         break;
 367     case DeviceInVendor | FTDI_GET_LATENCY:
 368         data[0] = s->latency;
 369         ret = 1;
 370         break;
 371     default:
 372     fail:
 373         DPRINTF("got unsupported/bogus control %x, value %x\n", request, value);
 374         ret = USB_RET_STALL;
 375         break;
 376     }
 377     return ret;
 378 }
 379
 380 static int usb_serial_handle_data(USBDevice *dev, USBPacket *p)
 381 {
 382     USBSerialState *s = (USBSerialState *)dev;
 383     int ret = 0;
 384     uint8_t devep = p->devep;
 385     uint8_t *data = p->data;
 386     int len = p->len;
 387     int first_len;
 388
 389     switch (p->pid) {
 390     case USB_TOKEN_OUT:
 391         if (devep != 2)
 392             goto fail;
 393         qemu_chr_write(s->cs, data, len);
 394         break;
 395
 396     case USB_TOKEN_IN:
 397         if (devep != 1)
 398             goto fail;
 399         first_len = RECV_BUF - s->recv_ptr;
 400         if (len <= 2) {
 401             ret = USB_RET_NAK;
 402             break;
 403         }
 404         *data++ = usb_get_modem_lines(s) | 1;
 405         /* We do not have the uart details */
 406         /* handle serial break */
 407         if (s->event_trigger && s->event_trigger & FTDI_BI) {
 408             s->event_trigger &= ~FTDI_BI;
 409             *data = FTDI_BI;
 410             ret = 2;
 411             break;
 412         } else {
 413             *data++ = 0;
 414         }
 415         len -= 2;
 416         if (len > s->recv_used)
 417             len = s->recv_used;
 418         if (!len) {
 419             ret = USB_RET_NAK;
 420             break;
 421         }
 422         if (first_len > len)
 423             first_len = len;
 424         memcpy(data, s->recv_buf + s->recv_ptr, first_len);
 425         if (len > first_len)
 426             memcpy(data + first_len, s->recv_buf, len - first_len);
 427         s->recv_used -= len;
 428         s->recv_ptr = (s->recv_ptr + len) % RECV_BUF;
 429         ret = len + 2;
 430         break;
 431
 432     default:
 433         DPRINTF("Bad token\n");
 434     fail:
 435         ret = USB_RET_STALL;
 436         break;
 437     }
 438
 439     return ret;
 440 }
 441
 442 static void usb_serial_handle_destroy(USBDevice *dev)
 443 {
 444     USBSerialState *s = (USBSerialState *)dev;
 445
 446     qemu_chr_close(s->cs);
 447 }
 448
 449 static int usb_serial_can_read(void *opaque)
 450 {
 451     USBSerialState *s = opaque;
 452     return RECV_BUF - s->recv_used;
 453 }
 454
 455 static void usb_serial_read(void *opaque, const uint8_t *buf, int size)
 456 {
 457     USBSerialState *s = opaque;
 458     int first_size, start;
 459
 460     /* room in the buffer? */
 461     if (size > (RECV_BUF - s->recv_used))
 462         size = RECV_BUF - s->recv_used;
 463
 464     start = s->recv_ptr + s->recv_used;
 465     if (start < RECV_BUF) {
 466         /* copy data to end of buffer */
 467         first_size = RECV_BUF - start;
 468         if (first_size > size)
 469             first_size = size;
 470
 471         memcpy(s->recv_buf + start, buf, first_size);
 472
 473         /* wrap around to front if needed */
 474         if (size > first_size)
 475             memcpy(s->recv_buf, buf + first_size, size - first_size);
 476     } else {
 477         start -= RECV_BUF;
 478         memcpy(s->recv_buf + start, buf, size);
 479     }
 480     s->recv_used += size;
 481 }
 482
 483 static void usb_serial_event(void *opaque, int event)
 484 {
 485     USBSerialState *s = opaque;
 486
 487     switch (event) {
 488         case CHR_EVENT_BREAK:
 489             s->event_trigger |= FTDI_BI;
 490             break;
 491         case CHR_EVENT_FOCUS:
 492             break;
 493         case CHR_EVENT_OPENED:
 494             usb_serial_reset(s);
 495             /* TODO: Reset USB port */
 496             break;
 497     }
 498 }
 499
 500 static int usb_serial_initfn(USBDevice *dev)
 501 {
 502     USBSerialState *s = DO_UPCAST(USBSerialState, dev, dev);
 503
 504     usb_desc_init(dev);
 505
 506     if (!s->cs) {
 507         error_report("Property chardev is required");
 508         return -1;
 509     }
 510
 511     qemu_chr_add_handlers(s->cs, usb_serial_can_read, usb_serial_read,
 512                           usb_serial_event, s);
 513     usb_serial_handle_reset(dev);
 514     return 0;
 515 }
 516
 517 static USBDevice *usb_serial_init(const char *filename)
 518 {
 519     USBDevice *dev;
 520     CharDriverState *cdrv;
 521     uint32_t vendorid = 0, productid = 0;
 522     char label[32];
 523     static int index;
 524
 525     while (*filename && *filename != ':') {
 526         const char *p;
 527         char *e;
 528         if (strstart(filename, "vendorid=", &p)) {
 529             vendorid = strtol(p, &e, 16);
 530             if (e == p || (*e && *e != ',' && *e != ':')) {
 531                 error_report("bogus vendor ID %s", p);
 532                 return NULL;
 533             }
 534             filename = e;
 535         } else if (strstart(filename, "productid=", &p)) {
 536             productid = strtol(p, &e, 16);
 537             if (e == p || (*e && *e != ',' && *e != ':')) {
 538                 error_report("bogus product ID %s", p);
 539                 return NULL;
 540             }
 541             filename = e;
 542         } else {
 543             error_report("unrecognized serial USB option %s", filename);
 544             return NULL;
 545         }
 546         while(*filename == ',')
 547             filename++;
 548     }
 549     if (!*filename) {
 550         error_report("character device specification needed");
 551         return NULL;
 552     }
 553     filename++;
 554
 555     snprintf(label, sizeof(label), "usbserial%d", index++);
 556     cdrv = qemu_chr_open(label, filename, NULL);
 557     if (!cdrv)
 558         return NULL;
 559
 560     dev = usb_create(NULL /* FIXME */, "usb-serial");
 561     if (!dev) {
 562         return NULL;
 563     }
 564     qdev_prop_set_chr(&dev->qdev, "chardev", cdrv);
 565     if (vendorid)
 566         qdev_prop_set_uint16(&dev->qdev, "vendorid", vendorid);
 567     if (productid)
 568         qdev_prop_set_uint16(&dev->qdev, "productid", productid);
 569     qdev_init_nofail(&dev->qdev);
 570
 571     return dev;
 572 }
 573
 574 static USBDevice *usb_braille_init(const char *unused)
 575 {
 576     USBDevice *dev;
 577     CharDriverState *cdrv;
 578
 579     cdrv = qemu_chr_open("braille", "braille", NULL);
 580     if (!cdrv)
 581         return NULL;
 582
 583     dev = usb_create(NULL /* FIXME */, "usb-braille");
 584     qdev_prop_set_chr(&dev->qdev, "chardev", cdrv);
 585     qdev_init_nofail(&dev->qdev);
 586
 587     return dev;
 588 }
 589
 590 static struct USBDeviceInfo serial_info = {
 591     .product_desc   = "QEMU USB Serial",
 592     .qdev.name      = "usb-serial",
 593     .qdev.size      = sizeof(USBSerialState),
 594     .usb_desc       = &desc_serial,
 595     .init           = usb_serial_initfn,
 596     .handle_packet  = usb_generic_handle_packet,
 597     .handle_reset   = usb_serial_handle_reset,
 598     .handle_control = usb_serial_handle_control,
 599     .handle_data    = usb_serial_handle_data,
 600     .handle_destroy = usb_serial_handle_destroy,
 601     .usbdevice_name = "serial",
 602     .usbdevice_init = usb_serial_init,
 603     .qdev.props     = (Property[]) {
 604         DEFINE_PROP_CHR("chardev", USBSerialState, cs),
 605         DEFINE_PROP_END_OF_LIST(),
 606     },
 607 };
 608
 609 static struct USBDeviceInfo braille_info = {
 610     .product_desc   = "QEMU USB Braille",
 611     .qdev.name      = "usb-braille",
 612     .qdev.size      = sizeof(USBSerialState),
 613     .usb_desc       = &desc_braille,
 614     .init           = usb_serial_initfn,
 615     .handle_packet  = usb_generic_handle_packet,
 616     .handle_reset   = usb_serial_handle_reset,
 617     .handle_control = usb_serial_handle_control,
 618     .handle_data    = usb_serial_handle_data,
 619     .handle_destroy = usb_serial_handle_destroy,
 620     .usbdevice_name = "braille",
 621     .usbdevice_init = usb_braille_init,
 622     .qdev.props     = (Property[]) {
 623         DEFINE_PROP_CHR("chardev", USBSerialState, cs),
 624         DEFINE_PROP_END_OF_LIST(),
 625     },
 626 };
 627
 628 static void usb_serial_register_devices(void)
 629 {
 630     usb_qdev_register(&serial_info);
 631     usb_qdev_register(&braille_info);
 632 }
 633 device_init(usb_serial_register_devices)