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