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_command_complete(SCSIRequest *req, int reason, 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     if (reason == SCSI_REASON_DONE) {
 220         DPRINTF("Command complete %d\n", arg);
 221         s->residue = s->data_len;
 222         s->result = arg != 0;
 223         if (s->packet) {
 224             if (s->data_len == 0 && s->mode == USB_MSDM_DATAOUT) {
 225                 /* A deferred packet with no write data remaining must be
 226                    the status read packet.  */
 227                 usb_msd_send_status(s, p);
 228                 s->mode = USB_MSDM_CBW;
 229             } else {
 230                 if (s->data_len) {
 231                     s->data_len -= s->usb_len;
 232                     if (s->mode == USB_MSDM_DATAIN)
 233                         memset(s->usb_buf, 0, s->usb_len);
 234                     s->usb_len = 0;
 235                 }
 236                 if (s->data_len == 0)
 237                     s->mode = USB_MSDM_CSW;
 238             }
 239             s->packet = NULL;
 240             usb_packet_complete(&s->dev, p);
 241         } else if (s->data_len == 0) {
 242             s->mode = USB_MSDM_CSW;
 243         }
 244         scsi_req_unref(req);
 245         s->req = NULL;
 246         return;
 247     }
 248     assert((s->mode == USB_MSDM_DATAOUT) == (req->cmd.mode == SCSI_XFER_TO_DEV));
 249     s->scsi_len = arg;
 250     s->scsi_buf = scsi_req_get_buf(req);
 251     if (p) {
 252         usb_msd_copy_data(s);
 253         if (s->usb_len == 0) {
 254             /* Set s->packet to NULL before calling usb_packet_complete
 255                because another request may be issued before
 256                usb_packet_complete returns.  */
 257             DPRINTF("Packet complete %p\n", p);
 258             s->packet = NULL;
 259             usb_packet_complete(&s->dev, p);
 260         }
 261     }
 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->packet = NULL;
 272         s->scsi_len = 0;
 273     }
 274 }
 275
 276 static void usb_msd_handle_reset(USBDevice *dev)
 277 {
 278     MSDState *s = (MSDState *)dev;
 279
 280     DPRINTF("Reset\n");
 281     s->mode = USB_MSDM_CBW;
 282 }
 283
 284 static int usb_msd_handle_control(USBDevice *dev, int request, int value,
 285                                   int index, int length, uint8_t *data)
 286 {
 287     MSDState *s = (MSDState *)dev;
 288     int ret;
 289
 290     ret = usb_desc_handle_control(dev, request, value, index, length, data);
 291     if (ret >= 0) {
 292         return ret;
 293     }
 294
 295     ret = 0;
 296     switch (request) {
 297     case DeviceRequest | USB_REQ_GET_INTERFACE:
 298         data[0] = 0;
 299         ret = 1;
 300         break;
 301     case DeviceOutRequest | USB_REQ_SET_INTERFACE:
 302         ret = 0;
 303         break;
 304     case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
 305         ret = 0;
 306         break;
 307     case InterfaceOutRequest | USB_REQ_SET_INTERFACE:
 308         ret = 0;
 309         break;
 310         /* Class specific requests.  */
 311     case ClassInterfaceOutRequest | MassStorageReset:
 312         /* Reset state ready for the next CBW.  */
 313         s->mode = USB_MSDM_CBW;
 314         ret = 0;
 315         break;
 316     case ClassInterfaceRequest | GetMaxLun:
 317         data[0] = 0;
 318         ret = 1;
 319         break;
 320     default:
 321         ret = USB_RET_STALL;
 322         break;
 323     }
 324     return ret;
 325 }
 326
 327 static void usb_msd_cancel_io(USBPacket *p, void *opaque)
 328 {
 329     MSDState *s = opaque;
 330     scsi_req_cancel(s->req);
 331 }
 332
 333 static int usb_msd_handle_data(USBDevice *dev, USBPacket *p)
 334 {
 335     MSDState *s = (MSDState *)dev;
 336     int ret = 0;
 337     struct usb_msd_cbw cbw;
 338     uint8_t devep = p->devep;
 339     uint8_t *data = p->data;
 340     int len = p->len;
 341
 342     switch (p->pid) {
 343     case USB_TOKEN_OUT:
 344         if (devep != 2)
 345             goto fail;
 346
 347         switch (s->mode) {
 348         case USB_MSDM_CBW:
 349             if (len != 31) {
 350                 fprintf(stderr, "usb-msd: Bad CBW size");
 351                 goto fail;
 352             }
 353             memcpy(&cbw, data, 31);
 354             if (le32_to_cpu(cbw.sig) != 0x43425355) {
 355                 fprintf(stderr, "usb-msd: Bad signature %08x\n",
 356                         le32_to_cpu(cbw.sig));
 357                 goto fail;
 358             }
 359             DPRINTF("Command on LUN %d\n", cbw.lun);
 360             if (cbw.lun != 0) {
 361                 fprintf(stderr, "usb-msd: Bad LUN %d\n", cbw.lun);
 362                 goto fail;
 363             }
 364             s->tag = le32_to_cpu(cbw.tag);
 365             s->data_len = le32_to_cpu(cbw.data_len);
 366             if (s->data_len == 0) {
 367                 s->mode = USB_MSDM_CSW;
 368             } else if (cbw.flags & 0x80) {
 369                 s->mode = USB_MSDM_DATAIN;
 370             } else {
 371                 s->mode = USB_MSDM_DATAOUT;
 372             }
 373             DPRINTF("Command tag 0x%x flags %08x len %d data %d\n",
 374                     s->tag, cbw.flags, cbw.cmd_len, s->data_len);
 375             s->residue = 0;
 376             s->scsi_len = 0;
 377             s->req = scsi_req_new(s->scsi_dev, s->tag, 0);
 378             scsi_req_enqueue(s->req, cbw.cmd);
 379             /* ??? Should check that USB and SCSI data transfer
 380                directions match.  */
 381             if (s->mode != USB_MSDM_CSW && s->residue == 0) {
 382                 scsi_req_continue(s->req);
 383             }
 384             ret = len;
 385             break;
 386
 387         case USB_MSDM_DATAOUT:
 388             DPRINTF("Data out %d/%d\n", len, s->data_len);
 389             if (len > s->data_len)
 390                 goto fail;
 391
 392             s->usb_buf = data;
 393             s->usb_len = len;
 394             if (s->scsi_len) {
 395                 usb_msd_copy_data(s);
 396             }
 397             if (s->residue && s->usb_len) {
 398                 s->data_len -= s->usb_len;
 399                 if (s->data_len == 0)
 400                     s->mode = USB_MSDM_CSW;
 401                 s->usb_len = 0;
 402             }
 403             if (s->usb_len) {
 404                 DPRINTF("Deferring packet %p\n", p);
 405                 usb_defer_packet(p, usb_msd_cancel_io, s);
 406                 s->packet = p;
 407                 ret = USB_RET_ASYNC;
 408             } else {
 409                 ret = len;
 410             }
 411             break;
 412
 413         default:
 414             DPRINTF("Unexpected write (len %d)\n", len);
 415             goto fail;
 416         }
 417         break;
 418
 419     case USB_TOKEN_IN:
 420         if (devep != 1)
 421             goto fail;
 422
 423         switch (s->mode) {
 424         case USB_MSDM_DATAOUT:
 425             if (s->data_len != 0 || len < 13)
 426                 goto fail;
 427             /* Waiting for SCSI write to complete.  */
 428             usb_defer_packet(p, usb_msd_cancel_io, s);
 429             s->packet = p;
 430             ret = USB_RET_ASYNC;
 431             break;
 432
 433         case USB_MSDM_CSW:
 434             DPRINTF("Command status %d tag 0x%x, len %d\n",
 435                     s->result, s->tag, len);
 436             if (len < 13)
 437                 goto fail;
 438
 439             usb_msd_send_status(s, p);
 440             s->mode = USB_MSDM_CBW;
 441             ret = 13;
 442             break;
 443
 444         case USB_MSDM_DATAIN:
 445             DPRINTF("Data in %d/%d, scsi_len %d\n", len, s->data_len, s->scsi_len);
 446             if (len > s->data_len)
 447                 len = s->data_len;
 448             s->usb_buf = data;
 449             s->usb_len = len;
 450             if (s->scsi_len) {
 451                 usb_msd_copy_data(s);
 452             }
 453             if (s->residue && s->usb_len) {
 454                 s->data_len -= s->usb_len;
 455                 memset(s->usb_buf, 0, s->usb_len);
 456                 if (s->data_len == 0)
 457                     s->mode = USB_MSDM_CSW;
 458                 s->usb_len = 0;
 459             }
 460             if (s->usb_len) {
 461                 DPRINTF("Deferring packet %p\n", p);
 462                 usb_defer_packet(p, usb_msd_cancel_io, s);
 463                 s->packet = p;
 464                 ret = USB_RET_ASYNC;
 465             } else {
 466                 ret = len;
 467             }
 468             break;
 469
 470         default:
 471             DPRINTF("Unexpected read (len %d)\n", len);
 472             goto fail;
 473         }
 474         break;
 475
 476     default:
 477         DPRINTF("Bad token\n");
 478     fail:
 479         ret = USB_RET_STALL;
 480         break;
 481     }
 482
 483     return ret;
 484 }
 485
 486 static void usb_msd_password_cb(void *opaque, int err)
 487 {
 488     MSDState *s = opaque;
 489
 490     if (!err)
 491         usb_device_attach(&s->dev);
 492     else
 493         qdev_unplug(&s->dev.qdev);
 494 }
 495
 496 static const struct SCSIBusOps usb_msd_scsi_ops = {
 497     .complete = usb_msd_command_complete,
 498     .cancel = usb_msd_request_cancelled
 499 };
 500
 501 static int usb_msd_initfn(USBDevice *dev)
 502 {
 503     MSDState *s = DO_UPCAST(MSDState, dev, dev);
 504     BlockDriverState *bs = s->conf.bs;
 505     DriveInfo *dinfo;
 506
 507     if (!bs) {
 508         error_report("usb-msd: drive property not set");
 509         return -1;
 510     }
 511
 512     /*
 513      * Hack alert: this pretends to be a block device, but it's really
 514      * a SCSI bus that can serve only a single device, which it
 515      * creates automatically.  But first it needs to detach from its
 516      * blockdev, or else scsi_bus_legacy_add_drive() dies when it
 517      * attaches again.
 518      *
 519      * The hack is probably a bad idea.
 520      */
 521     bdrv_detach(bs, &s->dev.qdev);
 522     s->conf.bs = NULL;
 523
 524     dinfo = drive_get_by_blockdev(bs);
 525     if (dinfo && dinfo->serial) {
 526         usb_desc_set_string(dev, STR_SERIALNUMBER, dinfo->serial);
 527     }
 528
 529     usb_desc_init(dev);
 530     scsi_bus_new(&s->bus, &s->dev.qdev, 0, 1, &usb_msd_scsi_ops);
 531     s->scsi_dev = scsi_bus_legacy_add_drive(&s->bus, bs, 0, !!s->removable);
 532     if (!s->scsi_dev) {
 533         return -1;
 534     }
 535     s->bus.qbus.allow_hotplug = 0;
 536     usb_msd_handle_reset(dev);
 537
 538     if (bdrv_key_required(bs)) {
 539         if (cur_mon) {
 540             monitor_read_bdrv_key_start(cur_mon, bs, usb_msd_password_cb, s);
 541             s->dev.auto_attach = 0;
 542         } else {
 543             autostart = 0;
 544         }
 545     }
 546
 547     add_boot_device_path(s->conf.bootindex, &dev->qdev, "/disk@0,0");
 548     return 0;
 549 }
 550
 551 static USBDevice *usb_msd_init(const char *filename)
 552 {
 553     static int nr=0;
 554     char id[8];
 555     QemuOpts *opts;
 556     DriveInfo *dinfo;
 557     USBDevice *dev;
 558     const char *p1;
 559     char fmt[32];
 560
 561     /* parse -usbdevice disk: syntax into drive opts */
 562     snprintf(id, sizeof(id), "usb%d", nr++);
 563     opts = qemu_opts_create(qemu_find_opts("drive"), id, 0);
 564
 565     p1 = strchr(filename, ':');
 566     if (p1++) {
 567         const char *p2;
 568
 569         if (strstart(filename, "format=", &p2)) {
 570             int len = MIN(p1 - p2, sizeof(fmt));
 571             pstrcpy(fmt, len, p2);
 572             qemu_opt_set(opts, "format", fmt);
 573         } else if (*filename != ':') {
 574             printf("unrecognized USB mass-storage option %s\n", filename);
 575             return NULL;
 576         }
 577         filename = p1;
 578     }
 579     if (!*filename) {
 580         printf("block device specification needed\n");
 581         return NULL;
 582     }
 583     qemu_opt_set(opts, "file", filename);
 584     qemu_opt_set(opts, "if", "none");
 585
 586     /* create host drive */
 587     dinfo = drive_init(opts, 0);
 588     if (!dinfo) {
 589         qemu_opts_del(opts);
 590         return NULL;
 591     }
 592
 593     /* create guest device */
 594     dev = usb_create(NULL /* FIXME */, "usb-storage");
 595     if (!dev) {
 596         return NULL;
 597     }
 598     if (qdev_prop_set_drive(&dev->qdev, "drive", dinfo->bdrv) < 0) {
 599         qdev_free(&dev->qdev);
 600         return NULL;
 601     }
 602     if (qdev_init(&dev->qdev) < 0)
 603         return NULL;
 604
 605     return dev;
 606 }
 607
 608 static struct USBDeviceInfo msd_info = {
 609     .product_desc   = "QEMU USB MSD",
 610     .qdev.name      = "usb-storage",
 611     .qdev.fw_name      = "storage",
 612     .qdev.size      = sizeof(MSDState),
 613     .usb_desc       = &desc,
 614     .init           = usb_msd_initfn,
 615     .handle_packet  = usb_generic_handle_packet,
 616     .handle_attach  = usb_desc_attach,
 617     .handle_reset   = usb_msd_handle_reset,
 618     .handle_control = usb_msd_handle_control,
 619     .handle_data    = usb_msd_handle_data,
 620     .usbdevice_name = "disk",
 621     .usbdevice_init = usb_msd_init,
 622     .qdev.props     = (Property[]) {
 623         DEFINE_BLOCK_PROPERTIES(MSDState, conf),
 624         DEFINE_PROP_BIT("removable", MSDState, removable, 0, false),
 625         DEFINE_PROP_END_OF_LIST(),
 626     },
 627 };
 628
 629 static void usb_msd_register_devices(void)
 630 {
 631     usb_qdev_register(&msd_info);
 632 }
 633 device_init(usb_msd_register_devices)