hw/usb/dev-storage.c

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