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