hw/usb-msd.c

   1 /*
   2  * USB Mass Storage Device emulation
   3  *
   4  * Copyright (c) 2006 CodeSourcery.
   5  * Written by Paul Brook
   6  *
   7  * This code is licenced under the LGPL.
   8  */
   9
  10 #include "qemu-common.h"
  11 #include "qemu-option.h"
  12 #include "qemu-config.h"
  13 #include "usb.h"
  14 #include "usb-desc.h"
  15 #include "scsi.h"
  16 #include "console.h"
  17 #include "monitor.h"
  18 #include "sysemu.h"
  19 #include "blockdev.h"
  20
  21 //#define DEBUG_MSD
  22
  23 #ifdef DEBUG_MSD
  24 #define DPRINTF(fmt, ...) \
  25 do { printf("usb-msd: " fmt , ## __VA_ARGS__); } while (0)
  26 #else
  27 #define DPRINTF(fmt, ...) do {} while(0)
  28 #endif
  29
  30 /* USB requests.  */
  31 #define MassStorageReset  0xff
  32 #define GetMaxLun         0xfe
  33
  34 enum USBMSDMode {
  35     USB_MSDM_CBW, /* Command Block.  */
  36     USB_MSDM_DATAOUT, /* Transfer data to device.  */
  37     USB_MSDM_DATAIN, /* Transfer data from device.  */
  38     USB_MSDM_CSW /* Command Status.  */
  39 };
  40
  41 typedef struct {
  42     USBDevice dev;
  43     enum USBMSDMode mode;
  44     uint32_t scsi_len;
  45     uint8_t *scsi_buf;
  46     uint32_t usb_len;
  47     uint8_t *usb_buf;
  48     uint32_t data_len;
  49     uint32_t residue;
  50     uint32_t tag;
  51     SCSIRequest *req;
  52     SCSIBus bus;
  53     BlockConf conf;
  54     SCSIDevice *scsi_dev;
  55     uint32_t removable;
  56     int result;
  57     /* For async completion.  */
  58     USBPacket *packet;
  59 } MSDState;
  60
  61 struct usb_msd_cbw {
  62     uint32_t sig;
  63     uint32_t tag;
  64     uint32_t data_len;
  65     uint8_t flags;
  66     uint8_t lun;
  67     uint8_t cmd_len;
  68     uint8_t cmd[16];
  69 };
  70
  71 struct usb_msd_csw {
  72     uint32_t sig;
  73     uint32_t tag;
  74     uint32_t residue;
  75     uint8_t status;
  76 };
  77
  78 enum {
  79     STR_MANUFACTURER = 1,
  80     STR_PRODUCT,
  81     STR_SERIALNUMBER,
  82     STR_CONFIG_FULL,
  83     STR_CONFIG_HIGH,
  84 };
  85
  86 static const USBDescStrings desc_strings = {
  87     [STR_MANUFACTURER] = "QEMU " QEMU_VERSION,
  88     [STR_PRODUCT]      = "QEMU USB HARDDRIVE",
  89     [STR_SERIALNUMBER] = "1",
  90     [STR_CONFIG_FULL]  = "Full speed config (usb 1.1)",
  91     [STR_CONFIG_HIGH]  = "High speed config (usb 2.0)",
  92 };
  93
  94 static const USBDescIface desc_iface_full = {
  95     .bInterfaceNumber              = 0,
  96     .bNumEndpoints                 = 2,
  97     .bInterfaceClass               = USB_CLASS_MASS_STORAGE,
  98     .bInterfaceSubClass            = 0x06, /* SCSI */
  99     .bInterfaceProtocol            = 0x50, /* Bulk */
 100     .eps = (USBDescEndpoint[]) {
 101         {
 102             .bEndpointAddress      = USB_DIR_IN | 0x01,
 103             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
 104             .wMaxPacketSize        = 64,
 105         },{
 106             .bEndpointAddress      = USB_DIR_OUT | 0x02,
 107             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
 108             .wMaxPacketSize        = 64,
 109         },
 110     }
 111 };
 112
 113 static const USBDescDevice desc_device_full = {
 114     .bcdUSB                        = 0x0200,
 115     .bMaxPacketSize0               = 8,
 116     .bNumConfigurations            = 1,
 117     .confs = (USBDescConfig[]) {
 118         {
 119             .bNumInterfaces        = 1,
 120             .bConfigurationValue   = 1,
 121             .iConfiguration        = STR_CONFIG_FULL,
 122             .bmAttributes          = 0xc0,
 123             .ifs = &desc_iface_full,
 124         },
 125     },
 126 };
 127
 128 static const USBDescIface desc_iface_high = {
 129     .bInterfaceNumber              = 0,
 130     .bNumEndpoints                 = 2,
 131     .bInterfaceClass               = USB_CLASS_MASS_STORAGE,
 132     .bInterfaceSubClass            = 0x06, /* SCSI */
 133     .bInterfaceProtocol            = 0x50, /* Bulk */
 134     .eps = (USBDescEndpoint[]) {
 135         {
 136             .bEndpointAddress      = USB_DIR_IN | 0x01,
 137             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
 138             .wMaxPacketSize        = 512,
 139         },{
 140             .bEndpointAddress      = USB_DIR_OUT | 0x02,
 141             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
 142             .wMaxPacketSize        = 512,
 143         },
 144     }
 145 };
 146
 147 static const USBDescDevice desc_device_high = {
 148     .bcdUSB                        = 0x0200,
 149     .bMaxPacketSize0               = 64,
 150     .bNumConfigurations            = 1,
 151     .confs = (USBDescConfig[]) {
 152         {
 153             .bNumInterfaces        = 1,
 154             .bConfigurationValue   = 1,
 155             .iConfiguration        = STR_CONFIG_HIGH,
 156             .bmAttributes          = 0xc0,
 157             .ifs = &desc_iface_high,
 158         },
 159     },
 160 };
 161
 162 static const USBDesc desc = {
 163     .id = {
 164         .idVendor          = 0,
 165         .idProduct         = 0,
 166         .bcdDevice         = 0,
 167         .iManufacturer     = STR_MANUFACTURER,
 168         .iProduct          = STR_PRODUCT,
 169         .iSerialNumber     = STR_SERIALNUMBER,
 170     },
 171     .full = &desc_device_full,
 172     .high = &desc_device_high,
 173     .str  = desc_strings,
 174 };
 175
 176 static void usb_msd_copy_data(MSDState *s)
 177 {
 178     uint32_t len;
 179     len = s->usb_len;
 180     if (len > s->scsi_len)
 181         len = s->scsi_len;
 182     if (s->mode == USB_MSDM_DATAIN) {
 183         memcpy(s->usb_buf, s->scsi_buf, len);
 184     } else {
 185         memcpy(s->scsi_buf, s->usb_buf, len);
 186     }
 187     s->usb_len -= len;
 188     s->scsi_len -= len;
 189     s->usb_buf += len;
 190     s->scsi_buf += len;
 191     s->data_len -= len;
 192     if (s->scsi_len == 0 || s->data_len == 0) {
 193         scsi_req_continue(s->req);
 194     }
 195 }
 196
 197 static void usb_msd_send_status(MSDState *s, USBPacket *p)
 198 {
 199     struct usb_msd_csw csw;
 200     int len;
 201
 202     csw.sig = cpu_to_le32(0x53425355);
 203     csw.tag = cpu_to_le32(s->tag);
 204     csw.residue = s->residue;
 205     csw.status = s->result;
 206
 207     len = MIN(sizeof(csw), p->len);
 208     memcpy(p->data, &csw, len);
 209 }
 210
 211 static void usb_msd_transfer_data(SCSIRequest *req, uint32_t arg)
 212 {
 213     MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
 214     USBPacket *p = s->packet;
 215
 216     if (req->tag != s->tag) {
 217         fprintf(stderr, "usb-msd: Unexpected SCSI Tag 0x%x\n", req->tag);
 218     }
 219
 220     assert((s->mode == USB_MSDM_DATAOUT) == (req->cmd.mode == SCSI_XFER_TO_DEV));
 221     s->scsi_len = arg;
 222     s->scsi_buf = scsi_req_get_buf(req);
 223     if (p) {
 224         usb_msd_copy_data(s);
 225         if (s->usb_len == 0) {
 226             /* Set s->packet to NULL before calling usb_packet_complete
 227                because another request may be issued before
 228                usb_packet_complete returns.  */
 229             DPRINTF("Packet complete %p\n", p);
 230             s->packet = NULL;
 231             usb_packet_complete(&s->dev, p);
 232         }
 233     }
 234 }
 235
 236 static void usb_msd_command_complete(SCSIRequest *req, uint32_t arg)
 237 {
 238     MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
 239     USBPacket *p = s->packet;
 240
 241     if (req->tag != s->tag) {
 242         fprintf(stderr, "usb-msd: Unexpected SCSI Tag 0x%x\n", req->tag);
 243     }
 244     DPRINTF("Command complete %d\n", arg);
 245     s->residue = s->data_len;
 246     s->result = arg != 0;
 247     if (s->packet) {
 248         if (s->data_len == 0 && s->mode == USB_MSDM_DATAOUT) {
 249             /* A deferred packet with no write data remaining must be
 250                the status read packet.  */
 251             usb_msd_send_status(s, p);
 252             s->mode = USB_MSDM_CBW;
 253         } else {
 254             if (s->data_len) {
 255                 s->data_len -= s->usb_len;
 256                 if (s->mode == USB_MSDM_DATAIN) {
 257                     memset(s->usb_buf, 0, s->usb_len);
 258                 }
 259                 s->usb_len = 0;
 260             }
 261             if (s->data_len == 0) {
 262                 s->mode = USB_MSDM_CSW;
 263             }
 264         }
 265         s->packet = NULL;
 266         usb_packet_complete(&s->dev, p);
 267     } else if (s->data_len == 0) {
 268         s->mode = USB_MSDM_CSW;
 269     }
 270     scsi_req_unref(req);
 271     s->req = NULL;
 272 }
 273
 274 static void usb_msd_request_cancelled(SCSIRequest *req)
 275 {
 276     MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
 277
 278     if (req == s->req) {
 279         scsi_req_unref(s->req);
 280         s->req = NULL;
 281         s->packet = NULL;
 282         s->scsi_len = 0;
 283     }
 284 }
 285
 286 static void usb_msd_handle_reset(USBDevice *dev)
 287 {
 288     MSDState *s = (MSDState *)dev;
 289
 290     DPRINTF("Reset\n");
 291     s->mode = USB_MSDM_CBW;
 292 }
 293
 294 static int usb_msd_handle_control(USBDevice *dev, int request, int value,
 295                                   int index, int length, uint8_t *data)
 296 {
 297     MSDState *s = (MSDState *)dev;
 298     int ret;
 299
 300     ret = usb_desc_handle_control(dev, request, value, index, length, data);
 301     if (ret >= 0) {
 302         return ret;
 303     }
 304
 305     ret = 0;
 306     switch (request) {
 307     case DeviceRequest | USB_REQ_GET_INTERFACE:
 308         data[0] = 0;
 309         ret = 1;
 310         break;
 311     case DeviceOutRequest | USB_REQ_SET_INTERFACE:
 312         ret = 0;
 313         break;
 314     case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
 315         ret = 0;
 316         break;
 317     case InterfaceOutRequest | USB_REQ_SET_INTERFACE:
 318         ret = 0;
 319         break;
 320         /* Class specific requests.  */
 321     case ClassInterfaceOutRequest | MassStorageReset:
 322         /* Reset state ready for the next CBW.  */
 323         s->mode = USB_MSDM_CBW;
 324         ret = 0;
 325         break;
 326     case ClassInterfaceRequest | GetMaxLun:
 327         data[0] = 0;
 328         ret = 1;
 329         break;
 330     default:
 331         ret = USB_RET_STALL;
 332         break;
 333     }
 334     return ret;
 335 }
 336
 337 static void usb_msd_cancel_io(USBPacket *p, void *opaque)
 338 {
 339     MSDState *s = opaque;
 340     scsi_req_cancel(s->req);
 341 }
 342
 343 static int usb_msd_handle_data(USBDevice *dev, USBPacket *p)
 344 {
 345     MSDState *s = (MSDState *)dev;
 346     int ret = 0;
 347     struct usb_msd_cbw cbw;
 348     uint8_t devep = p->devep;
 349     uint8_t *data = p->data;
 350     int len = p->len;
 351
 352     switch (p->pid) {
 353     case USB_TOKEN_OUT:
 354         if (devep != 2)
 355             goto fail;
 356
 357         switch (s->mode) {
 358         case USB_MSDM_CBW:
 359             if (len != 31) {
 360                 fprintf(stderr, "usb-msd: Bad CBW size");
 361                 goto fail;
 362             }
 363             memcpy(&cbw, data, 31);
 364             if (le32_to_cpu(cbw.sig) != 0x43425355) {
 365                 fprintf(stderr, "usb-msd: Bad signature %08x\n",
 366                         le32_to_cpu(cbw.sig));
 367                 goto fail;
 368             }
 369             DPRINTF("Command on LUN %d\n", cbw.lun);
 370             if (cbw.lun != 0) {
 371                 fprintf(stderr, "usb-msd: Bad LUN %d\n", cbw.lun);
 372                 goto fail;
 373             }
 374             s->tag = le32_to_cpu(cbw.tag);
 375             s->data_len = le32_to_cpu(cbw.data_len);
 376             if (s->data_len == 0) {
 377                 s->mode = USB_MSDM_CSW;
 378             } else if (cbw.flags & 0x80) {
 379                 s->mode = USB_MSDM_DATAIN;
 380             } else {
 381                 s->mode = USB_MSDM_DATAOUT;
 382             }
 383             DPRINTF("Command tag 0x%x flags %08x len %d data %d\n",
 384                     s->tag, cbw.flags, cbw.cmd_len, s->data_len);
 385             s->residue = 0;
 386             s->scsi_len = 0;
 387             s->req = scsi_req_new(s->scsi_dev, s->tag, 0);
 388             scsi_req_enqueue(s->req, cbw.cmd);
 389             /* ??? Should check that USB and SCSI data transfer
 390                directions match.  */
 391             if (s->mode != USB_MSDM_CSW && s->residue == 0) {
 392                 scsi_req_continue(s->req);
 393             }
 394             ret = len;
 395             break;
 396
 397         case USB_MSDM_DATAOUT:
 398             DPRINTF("Data out %d/%d\n", len, s->data_len);
 399             if (len > s->data_len)
 400                 goto fail;
 401
 402             s->usb_buf = data;
 403             s->usb_len = len;
 404             if (s->scsi_len) {
 405                 usb_msd_copy_data(s);
 406             }
 407             if (s->residue && s->usb_len) {
 408                 s->data_len -= s->usb_len;
 409                 if (s->data_len == 0)
 410                     s->mode = USB_MSDM_CSW;
 411                 s->usb_len = 0;
 412             }
 413             if (s->usb_len) {
 414                 DPRINTF("Deferring packet %p\n", p);
 415                 usb_defer_packet(p, usb_msd_cancel_io, s);
 416                 s->packet = p;
 417                 ret = USB_RET_ASYNC;
 418             } else {
 419                 ret = len;
 420             }
 421             break;
 422
 423         default:
 424             DPRINTF("Unexpected write (len %d)\n", len);
 425             goto fail;
 426         }
 427         break;
 428
 429     case USB_TOKEN_IN:
 430         if (devep != 1)
 431             goto fail;
 432
 433         switch (s->mode) {
 434         case USB_MSDM_DATAOUT:
 435             if (s->data_len != 0 || len < 13)
 436                 goto fail;
 437             /* Waiting for SCSI write to complete.  */
 438             usb_defer_packet(p, usb_msd_cancel_io, s);
 439             s->packet = p;
 440             ret = USB_RET_ASYNC;
 441             break;
 442
 443         case USB_MSDM_CSW:
 444             DPRINTF("Command status %d tag 0x%x, len %d\n",
 445                     s->result, s->tag, len);
 446             if (len < 13)
 447                 goto fail;
 448
 449             usb_msd_send_status(s, p);
 450             s->mode = USB_MSDM_CBW;
 451             ret = 13;
 452             break;
 453
 454         case USB_MSDM_DATAIN:
 455             DPRINTF("Data in %d/%d, scsi_len %d\n", len, s->data_len, s->scsi_len);
 456             if (len > s->data_len)
 457                 len = s->data_len;
 458             s->usb_buf = data;
 459             s->usb_len = len;
 460             if (s->scsi_len) {
 461                 usb_msd_copy_data(s);
 462             }
 463             if (s->residue && s->usb_len) {
 464                 s->data_len -= s->usb_len;
 465                 memset(s->usb_buf, 0, s->usb_len);
 466                 if (s->data_len == 0)
 467                     s->mode = USB_MSDM_CSW;
 468                 s->usb_len = 0;
 469             }
 470             if (s->usb_len) {
 471                 DPRINTF("Deferring packet %p\n", p);
 472                 usb_defer_packet(p, usb_msd_cancel_io, s);
 473                 s->packet = p;
 474                 ret = USB_RET_ASYNC;
 475             } else {
 476                 ret = len;
 477             }
 478             break;
 479
 480         default:
 481             DPRINTF("Unexpected read (len %d)\n", len);
 482             goto fail;
 483         }
 484         break;
 485
 486     default:
 487         DPRINTF("Bad token\n");
 488     fail:
 489         ret = USB_RET_STALL;
 490         break;
 491     }
 492
 493     return ret;
 494 }
 495
 496 static void usb_msd_password_cb(void *opaque, int err)
 497 {
 498     MSDState *s = opaque;
 499
 500     if (!err)
 501         usb_device_attach(&s->dev);
 502     else
 503         qdev_unplug(&s->dev.qdev);
 504 }
 505
 506 static const struct SCSIBusOps usb_msd_scsi_ops = {
 507     .transfer_data = usb_msd_transfer_data,
 508     .complete = usb_msd_command_complete,
 509     .cancel = usb_msd_request_cancelled
 510 };
 511
 512 static int usb_msd_initfn(USBDevice *dev)
 513 {
 514     MSDState *s = DO_UPCAST(MSDState, dev, dev);
 515     BlockDriverState *bs = s->conf.bs;
 516     DriveInfo *dinfo;
 517
 518     if (!bs) {
 519         error_report("usb-msd: drive property not set");
 520         return -1;
 521     }
 522
 523     /*
 524      * Hack alert: this pretends to be a block device, but it's really
 525      * a SCSI bus that can serve only a single device, which it
 526      * creates automatically.  But first it needs to detach from its
 527      * blockdev, or else scsi_bus_legacy_add_drive() dies when it
 528      * attaches again.
 529      *
 530      * The hack is probably a bad idea.
 531      */
 532     bdrv_detach(bs, &s->dev.qdev);
 533     s->conf.bs = NULL;
 534
 535     dinfo = drive_get_by_blockdev(bs);
 536     if (dinfo && dinfo->serial) {
 537         usb_desc_set_string(dev, STR_SERIALNUMBER, dinfo->serial);
 538     }
 539
 540     usb_desc_init(dev);
 541     scsi_bus_new(&s->bus, &s->dev.qdev, 0, 1, &usb_msd_scsi_ops);
 542     s->scsi_dev = scsi_bus_legacy_add_drive(&s->bus, bs, 0, !!s->removable);
 543     if (!s->scsi_dev) {
 544         return -1;
 545     }
 546     s->bus.qbus.allow_hotplug = 0;
 547     usb_msd_handle_reset(dev);
 548
 549     if (bdrv_key_required(bs)) {
 550         if (cur_mon) {
 551             monitor_read_bdrv_key_start(cur_mon, bs, usb_msd_password_cb, s);
 552             s->dev.auto_attach = 0;
 553         } else {
 554             autostart = 0;
 555         }
 556     }
 557
 558     add_boot_device_path(s->conf.bootindex, &dev->qdev, "/disk@0,0");
 559     return 0;
 560 }
 561
 562 static USBDevice *usb_msd_init(const char *filename)
 563 {
 564     static int nr=0;
 565     char id[8];
 566     QemuOpts *opts;
 567     DriveInfo *dinfo;
 568     USBDevice *dev;
 569     const char *p1;
 570     char fmt[32];
 571
 572     /* parse -usbdevice disk: syntax into drive opts */
 573     snprintf(id, sizeof(id), "usb%d", nr++);
 574     opts = qemu_opts_create(qemu_find_opts("drive"), id, 0);
 575
 576     p1 = strchr(filename, ':');
 577     if (p1++) {
 578         const char *p2;
 579
 580         if (strstart(filename, "format=", &p2)) {
 581             int len = MIN(p1 - p2, sizeof(fmt));
 582             pstrcpy(fmt, len, p2);
 583             qemu_opt_set(opts, "format", fmt);
 584         } else if (*filename != ':') {
 585             printf("unrecognized USB mass-storage option %s\n", filename);
 586             return NULL;
 587         }
 588         filename = p1;
 589     }
 590     if (!*filename) {
 591         printf("block device specification needed\n");
 592         return NULL;
 593     }
 594     qemu_opt_set(opts, "file", filename);
 595     qemu_opt_set(opts, "if", "none");
 596
 597     /* create host drive */
 598     dinfo = drive_init(opts, 0);
 599     if (!dinfo) {
 600         qemu_opts_del(opts);
 601         return NULL;
 602     }
 603
 604     /* create guest device */
 605     dev = usb_create(NULL /* FIXME */, "usb-storage");
 606     if (!dev) {
 607         return NULL;
 608     }
 609     if (qdev_prop_set_drive(&dev->qdev, "drive", dinfo->bdrv) < 0) {
 610         qdev_free(&dev->qdev);
 611         return NULL;
 612     }
 613     if (qdev_init(&dev->qdev) < 0)
 614         return NULL;
 615
 616     return dev;
 617 }
 618
 619 static struct USBDeviceInfo msd_info = {
 620     .product_desc   = "QEMU USB MSD",
 621     .qdev.name      = "usb-storage",
 622     .qdev.fw_name      = "storage",
 623     .qdev.size      = sizeof(MSDState),
 624     .usb_desc       = &desc,
 625     .init           = usb_msd_initfn,
 626     .handle_packet  = usb_generic_handle_packet,
 627     .handle_attach  = usb_desc_attach,
 628     .handle_reset   = usb_msd_handle_reset,
 629     .handle_control = usb_msd_handle_control,
 630     .handle_data    = usb_msd_handle_data,
 631     .usbdevice_name = "disk",
 632     .usbdevice_init = usb_msd_init,
 633     .qdev.props     = (Property[]) {
 634         DEFINE_BLOCK_PROPERTIES(MSDState, conf),
 635         DEFINE_PROP_BIT("removable", MSDState, removable, 0, false),
 636         DEFINE_PROP_END_OF_LIST(),
 637     },
 638 };
 639
 640 static void usb_msd_register_devices(void)
 641 {
 642     usb_qdev_register(&msd_info);
 643 }
 644 device_init(usb_msd_register_devices)