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/osdep.h"
  11 #include "qapi/error.h"
  12 #include "qemu/error-report.h"
  13 #include "qemu/module.h"
  14 #include "qemu/option.h"
  15 #include "qemu/config-file.h"
  16 #include "hw/usb.h"
  17 #include "desc.h"
  18 #include "hw/qdev-properties.h"
  19 #include "hw/scsi/scsi.h"
  20 #include "migration/vmstate.h"
  21 #include "sysemu/sysemu.h"
  22 #include "sysemu/block-backend.h"
  23 #include "qapi/visitor.h"
  24 #include "qemu/cutils.h"
  25 #include "qom/object.h"
  26 #include "trace.h"
  27
  28 //#define DEBUG_MSD
  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 struct MSDState {
  49     USBDevice dev;
  50     enum USBMSDMode mode;
  51     uint32_t scsi_off;
  52     uint32_t scsi_len;
  53     uint32_t data_len;
  54     struct usb_msd_csw csw;
  55     SCSIRequest *req;
  56     SCSIBus bus;
  57     /* For async completion.  */
  58     USBPacket *packet;
  59     /* usb-storage only */
  60     BlockConf conf;
  61     uint32_t removable;
  62     SCSIDevice *scsi_dev;
  63 };
  64 typedef struct MSDState MSDState;
  65
  66 #define TYPE_USB_STORAGE "usb-storage-dev"
  67 DECLARE_INSTANCE_CHECKER(MSDState, USB_STORAGE_DEV,
  68                          TYPE_USB_STORAGE)
  69
  70 struct usb_msd_cbw {
  71     uint32_t sig;
  72     uint32_t tag;
  73     uint32_t data_len;
  74     uint8_t flags;
  75     uint8_t lun;
  76     uint8_t cmd_len;
  77     uint8_t cmd[16];
  78 };
  79
  80 enum {
  81     STR_MANUFACTURER = 1,
  82     STR_PRODUCT,
  83     STR_SERIALNUMBER,
  84     STR_CONFIG_FULL,
  85     STR_CONFIG_HIGH,
  86     STR_CONFIG_SUPER,
  87 };
  88
  89 static const USBDescStrings desc_strings = {
  90     [STR_MANUFACTURER] = "QEMU",
  91     [STR_PRODUCT]      = "QEMU USB HARDDRIVE",
  92     [STR_SERIALNUMBER] = "1",
  93     [STR_CONFIG_FULL]  = "Full speed config (usb 1.1)",
  94     [STR_CONFIG_HIGH]  = "High speed config (usb 2.0)",
  95     [STR_CONFIG_SUPER] = "Super speed config (usb 3.0)",
  96 };
  97
  98 static const USBDescIface desc_iface_full = {
  99     .bInterfaceNumber              = 0,
 100     .bNumEndpoints                 = 2,
 101     .bInterfaceClass               = USB_CLASS_MASS_STORAGE,
 102     .bInterfaceSubClass            = 0x06, /* SCSI */
 103     .bInterfaceProtocol            = 0x50, /* Bulk */
 104     .eps = (USBDescEndpoint[]) {
 105         {
 106             .bEndpointAddress      = USB_DIR_IN | 0x01,
 107             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
 108             .wMaxPacketSize        = 64,
 109         },{
 110             .bEndpointAddress      = USB_DIR_OUT | 0x02,
 111             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
 112             .wMaxPacketSize        = 64,
 113         },
 114     }
 115 };
 116
 117 static const USBDescDevice desc_device_full = {
 118     .bcdUSB                        = 0x0200,
 119     .bMaxPacketSize0               = 8,
 120     .bNumConfigurations            = 1,
 121     .confs = (USBDescConfig[]) {
 122         {
 123             .bNumInterfaces        = 1,
 124             .bConfigurationValue   = 1,
 125             .iConfiguration        = STR_CONFIG_FULL,
 126             .bmAttributes          = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER,
 127             .nif = 1,
 128             .ifs = &desc_iface_full,
 129         },
 130     },
 131 };
 132
 133 static const USBDescIface desc_iface_high = {
 134     .bInterfaceNumber              = 0,
 135     .bNumEndpoints                 = 2,
 136     .bInterfaceClass               = USB_CLASS_MASS_STORAGE,
 137     .bInterfaceSubClass            = 0x06, /* SCSI */
 138     .bInterfaceProtocol            = 0x50, /* Bulk */
 139     .eps = (USBDescEndpoint[]) {
 140         {
 141             .bEndpointAddress      = USB_DIR_IN | 0x01,
 142             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
 143             .wMaxPacketSize        = 512,
 144         },{
 145             .bEndpointAddress      = USB_DIR_OUT | 0x02,
 146             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
 147             .wMaxPacketSize        = 512,
 148         },
 149     }
 150 };
 151
 152 static const USBDescDevice desc_device_high = {
 153     .bcdUSB                        = 0x0200,
 154     .bMaxPacketSize0               = 64,
 155     .bNumConfigurations            = 1,
 156     .confs = (USBDescConfig[]) {
 157         {
 158             .bNumInterfaces        = 1,
 159             .bConfigurationValue   = 1,
 160             .iConfiguration        = STR_CONFIG_HIGH,
 161             .bmAttributes          = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER,
 162             .nif = 1,
 163             .ifs = &desc_iface_high,
 164         },
 165     },
 166 };
 167
 168 static const USBDescIface desc_iface_super = {
 169     .bInterfaceNumber              = 0,
 170     .bNumEndpoints                 = 2,
 171     .bInterfaceClass               = USB_CLASS_MASS_STORAGE,
 172     .bInterfaceSubClass            = 0x06, /* SCSI */
 173     .bInterfaceProtocol            = 0x50, /* Bulk */
 174     .eps = (USBDescEndpoint[]) {
 175         {
 176             .bEndpointAddress      = USB_DIR_IN | 0x01,
 177             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
 178             .wMaxPacketSize        = 1024,
 179             .bMaxBurst             = 15,
 180         },{
 181             .bEndpointAddress      = USB_DIR_OUT | 0x02,
 182             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
 183             .wMaxPacketSize        = 1024,
 184             .bMaxBurst             = 15,
 185         },
 186     }
 187 };
 188
 189 static const USBDescDevice desc_device_super = {
 190     .bcdUSB                        = 0x0300,
 191     .bMaxPacketSize0               = 9,
 192     .bNumConfigurations            = 1,
 193     .confs = (USBDescConfig[]) {
 194         {
 195             .bNumInterfaces        = 1,
 196             .bConfigurationValue   = 1,
 197             .iConfiguration        = STR_CONFIG_SUPER,
 198             .bmAttributes          = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER,
 199             .nif = 1,
 200             .ifs = &desc_iface_super,
 201         },
 202     },
 203 };
 204
 205 static const USBDesc desc = {
 206     .id = {
 207         .idVendor          = 0x46f4, /* CRC16() of "QEMU" */
 208         .idProduct         = 0x0001,
 209         .bcdDevice         = 0,
 210         .iManufacturer     = STR_MANUFACTURER,
 211         .iProduct          = STR_PRODUCT,
 212         .iSerialNumber     = STR_SERIALNUMBER,
 213     },
 214     .full  = &desc_device_full,
 215     .high  = &desc_device_high,
 216     .super = &desc_device_super,
 217     .str   = desc_strings,
 218 };
 219
 220 static void usb_msd_copy_data(MSDState *s, USBPacket *p)
 221 {
 222     uint32_t len;
 223     len = p->iov.size - p->actual_length;
 224     if (len > s->scsi_len)
 225         len = s->scsi_len;
 226     usb_packet_copy(p, scsi_req_get_buf(s->req) + s->scsi_off, len);
 227     s->scsi_len -= len;
 228     s->scsi_off += len;
 229     if (len > s->data_len) {
 230         len = s->data_len;
 231     }
 232     s->data_len -= len;
 233     if (s->scsi_len == 0 || s->data_len == 0) {
 234         scsi_req_continue(s->req);
 235     }
 236 }
 237
 238 static void usb_msd_send_status(MSDState *s, USBPacket *p)
 239 {
 240     int len;
 241
 242     trace_usb_msd_send_status(s->csw.status, le32_to_cpu(s->csw.tag),
 243                               p->iov.size);
 244
 245     assert(s->csw.sig == cpu_to_le32(0x53425355));
 246     len = MIN(sizeof(s->csw), p->iov.size);
 247     usb_packet_copy(p, &s->csw, len);
 248     memset(&s->csw, 0, sizeof(s->csw));
 249 }
 250
 251 static void usb_msd_packet_complete(MSDState *s)
 252 {
 253     USBPacket *p = s->packet;
 254
 255     /* Set s->packet to NULL before calling usb_packet_complete
 256        because another request may be issued before
 257        usb_packet_complete returns.  */
 258     trace_usb_msd_packet_complete();
 259     s->packet = NULL;
 260     usb_packet_complete(&s->dev, p);
 261 }
 262
 263 static void usb_msd_transfer_data(SCSIRequest *req, uint32_t len)
 264 {
 265     MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
 266     USBPacket *p = s->packet;
 267
 268     assert((s->mode == USB_MSDM_DATAOUT) == (req->cmd.mode == SCSI_XFER_TO_DEV));
 269     s->scsi_len = len;
 270     s->scsi_off = 0;
 271     if (p) {
 272         usb_msd_copy_data(s, p);
 273         p = s->packet;
 274         if (p && p->actual_length == p->iov.size) {
 275             p->status = USB_RET_SUCCESS; /* Clear previous ASYNC status */
 276             usb_msd_packet_complete(s);
 277         }
 278     }
 279 }
 280
 281 static void usb_msd_command_complete(SCSIRequest *req, uint32_t status, size_t resid)
 282 {
 283     MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
 284     USBPacket *p = s->packet;
 285
 286     trace_usb_msd_cmd_complete(status, req->tag);
 287
 288     s->csw.sig = cpu_to_le32(0x53425355);
 289     s->csw.tag = cpu_to_le32(req->tag);
 290     s->csw.residue = cpu_to_le32(s->data_len);
 291     s->csw.status = status != 0;
 292
 293     if (s->packet) {
 294         if (s->data_len == 0 && s->mode == USB_MSDM_DATAOUT) {
 295             /* A deferred packet with no write data remaining must be
 296                the status read packet.  */
 297             usb_msd_send_status(s, p);
 298             s->mode = USB_MSDM_CBW;
 299         } else if (s->mode == USB_MSDM_CSW) {
 300             usb_msd_send_status(s, p);
 301             s->mode = USB_MSDM_CBW;
 302         } else {
 303             if (s->data_len) {
 304                 int len = (p->iov.size - p->actual_length);
 305                 usb_packet_skip(p, len);
 306                 if (len > s->data_len) {
 307                     len = s->data_len;
 308                 }
 309                 s->data_len -= len;
 310             }
 311             if (s->data_len == 0) {
 312                 s->mode = USB_MSDM_CSW;
 313             }
 314         }
 315         p->status = USB_RET_SUCCESS; /* Clear previous ASYNC status */
 316         usb_msd_packet_complete(s);
 317     } else if (s->data_len == 0) {
 318         s->mode = USB_MSDM_CSW;
 319     }
 320     scsi_req_unref(req);
 321     s->req = NULL;
 322 }
 323
 324 static void usb_msd_request_cancelled(SCSIRequest *req)
 325 {
 326     MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
 327
 328     trace_usb_msd_cmd_cancel(req->tag);
 329
 330     if (req == s->req) {
 331         scsi_req_unref(s->req);
 332         s->req = NULL;
 333         s->scsi_len = 0;
 334     }
 335 }
 336
 337 static void usb_msd_handle_reset(USBDevice *dev)
 338 {
 339     MSDState *s = (MSDState *)dev;
 340
 341     trace_usb_msd_reset();
 342     if (s->req) {
 343         scsi_req_cancel(s->req);
 344     }
 345     assert(s->req == NULL);
 346
 347     if (s->packet) {
 348         s->packet->status = USB_RET_STALL;
 349         usb_msd_packet_complete(s);
 350     }
 351
 352     s->mode = USB_MSDM_CBW;
 353 }
 354
 355 static void usb_msd_handle_control(USBDevice *dev, USBPacket *p,
 356                int request, int value, int index, int length, uint8_t *data)
 357 {
 358     MSDState *s = (MSDState *)dev;
 359     SCSIDevice *scsi_dev;
 360     int ret, maxlun;
 361
 362     ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
 363     if (ret >= 0) {
 364         return;
 365     }
 366
 367     switch (request) {
 368     case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
 369         break;
 370         /* Class specific requests.  */
 371     case ClassInterfaceOutRequest | MassStorageReset:
 372         /* Reset state ready for the next CBW.  */
 373         s->mode = USB_MSDM_CBW;
 374         break;
 375     case ClassInterfaceRequest | GetMaxLun:
 376         maxlun = 0;
 377         for (;;) {
 378             scsi_dev = scsi_device_find(&s->bus, 0, 0, maxlun+1);
 379             if (scsi_dev == NULL) {
 380                 break;
 381             }
 382             if (scsi_dev->lun != maxlun+1) {
 383                 break;
 384             }
 385             maxlun++;
 386         }
 387         trace_usb_msd_maxlun(maxlun);
 388         data[0] = maxlun;
 389         p->actual_length = 1;
 390         break;
 391     default:
 392         p->status = USB_RET_STALL;
 393         break;
 394     }
 395 }
 396
 397 static void usb_msd_cancel_io(USBDevice *dev, USBPacket *p)
 398 {
 399     MSDState *s = USB_STORAGE_DEV(dev);
 400
 401     assert(s->packet == p);
 402     s->packet = NULL;
 403
 404     if (s->req) {
 405         scsi_req_cancel(s->req);
 406     }
 407 }
 408
 409 static void usb_msd_handle_data(USBDevice *dev, USBPacket *p)
 410 {
 411     MSDState *s = (MSDState *)dev;
 412     uint32_t tag;
 413     struct usb_msd_cbw cbw;
 414     uint8_t devep = p->ep->nr;
 415     SCSIDevice *scsi_dev;
 416     uint32_t len;
 417
 418     switch (p->pid) {
 419     case USB_TOKEN_OUT:
 420         if (devep != 2)
 421             goto fail;
 422
 423         switch (s->mode) {
 424         case USB_MSDM_CBW:
 425             if (p->iov.size != 31) {
 426                 error_report("usb-msd: Bad CBW size");
 427                 goto fail;
 428             }
 429             usb_packet_copy(p, &cbw, 31);
 430             if (le32_to_cpu(cbw.sig) != 0x43425355) {
 431                 error_report("usb-msd: Bad signature %08x",
 432                              le32_to_cpu(cbw.sig));
 433                 goto fail;
 434             }
 435             scsi_dev = scsi_device_find(&s->bus, 0, 0, cbw.lun);
 436             if (scsi_dev == NULL) {
 437                 error_report("usb-msd: Bad LUN %d", cbw.lun);
 438                 goto fail;
 439             }
 440             tag = le32_to_cpu(cbw.tag);
 441             s->data_len = le32_to_cpu(cbw.data_len);
 442             if (s->data_len == 0) {
 443                 s->mode = USB_MSDM_CSW;
 444             } else if (cbw.flags & 0x80) {
 445                 s->mode = USB_MSDM_DATAIN;
 446             } else {
 447                 s->mode = USB_MSDM_DATAOUT;
 448             }
 449             trace_usb_msd_cmd_submit(cbw.lun, tag, cbw.flags,
 450                                      cbw.cmd_len, s->data_len);
 451             assert(le32_to_cpu(s->csw.residue) == 0);
 452             s->scsi_len = 0;
 453             s->req = scsi_req_new(scsi_dev, tag, cbw.lun, cbw.cmd, NULL);
 454 #ifdef DEBUG_MSD
 455             scsi_req_print(s->req);
 456 #endif
 457             len = scsi_req_enqueue(s->req);
 458             if (len) {
 459                 scsi_req_continue(s->req);
 460             }
 461             break;
 462
 463         case USB_MSDM_DATAOUT:
 464             trace_usb_msd_data_out(p->iov.size, s->data_len);
 465             if (p->iov.size > s->data_len) {
 466                 goto fail;
 467             }
 468
 469             if (s->scsi_len) {
 470                 usb_msd_copy_data(s, p);
 471             }
 472             if (le32_to_cpu(s->csw.residue)) {
 473                 int len = p->iov.size - p->actual_length;
 474                 if (len) {
 475                     usb_packet_skip(p, len);
 476                     if (len > s->data_len) {
 477                         len = s->data_len;
 478                     }
 479                     s->data_len -= len;
 480                     if (s->data_len == 0) {
 481                         s->mode = USB_MSDM_CSW;
 482                     }
 483                 }
 484             }
 485             if (p->actual_length < p->iov.size) {
 486                 trace_usb_msd_packet_async();
 487                 s->packet = p;
 488                 p->status = USB_RET_ASYNC;
 489             }
 490             break;
 491
 492         default:
 493             goto fail;
 494         }
 495         break;
 496
 497     case USB_TOKEN_IN:
 498         if (devep != 1)
 499             goto fail;
 500
 501         switch (s->mode) {
 502         case USB_MSDM_DATAOUT:
 503             if (s->data_len != 0 || p->iov.size < 13) {
 504                 goto fail;
 505             }
 506             /* Waiting for SCSI write to complete.  */
 507             trace_usb_msd_packet_async();
 508             s->packet = p;
 509             p->status = USB_RET_ASYNC;
 510             break;
 511
 512         case USB_MSDM_CSW:
 513             if (p->iov.size < 13) {
 514                 goto fail;
 515             }
 516
 517             if (s->req) {
 518                 /* still in flight */
 519                 trace_usb_msd_packet_async();
 520                 s->packet = p;
 521                 p->status = USB_RET_ASYNC;
 522             } else {
 523                 usb_msd_send_status(s, p);
 524                 s->mode = USB_MSDM_CBW;
 525             }
 526             break;
 527
 528         case USB_MSDM_DATAIN:
 529             trace_usb_msd_data_in(p->iov.size, s->data_len, s->scsi_len);
 530             if (s->scsi_len) {
 531                 usb_msd_copy_data(s, p);
 532             }
 533             if (le32_to_cpu(s->csw.residue)) {
 534                 int len = p->iov.size - p->actual_length;
 535                 if (len) {
 536                     usb_packet_skip(p, len);
 537                     if (len > s->data_len) {
 538                         len = s->data_len;
 539                     }
 540                     s->data_len -= len;
 541                     if (s->data_len == 0) {
 542                         s->mode = USB_MSDM_CSW;
 543                     }
 544                 }
 545             }
 546             if (p->actual_length < p->iov.size && s->mode == USB_MSDM_DATAIN) {
 547                 trace_usb_msd_packet_async();
 548                 s->packet = p;
 549                 p->status = USB_RET_ASYNC;
 550             }
 551             break;
 552
 553         default:
 554             goto fail;
 555         }
 556         break;
 557
 558     default:
 559     fail:
 560         p->status = USB_RET_STALL;
 561         break;
 562     }
 563 }
 564
 565 static void *usb_msd_load_request(QEMUFile *f, SCSIRequest *req)
 566 {
 567     MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
 568
 569     /* nothing to load, just store req in our state struct */
 570     assert(s->req == NULL);
 571     scsi_req_ref(req);
 572     s->req = req;
 573     return NULL;
 574 }
 575
 576 static const struct SCSIBusInfo usb_msd_scsi_info_storage = {
 577     .tcq = false,
 578     .max_target = 0,
 579     .max_lun = 0,
 580
 581     .transfer_data = usb_msd_transfer_data,
 582     .complete = usb_msd_command_complete,
 583     .cancel = usb_msd_request_cancelled,
 584     .load_request = usb_msd_load_request,
 585 };
 586
 587 static const struct SCSIBusInfo usb_msd_scsi_info_bot = {
 588     .tcq = false,
 589     .max_target = 0,
 590     .max_lun = 15,
 591
 592     .transfer_data = usb_msd_transfer_data,
 593     .complete = usb_msd_command_complete,
 594     .cancel = usb_msd_request_cancelled,
 595     .load_request = usb_msd_load_request,
 596 };
 597
 598 static void usb_msd_storage_realize(USBDevice *dev, Error **errp)
 599 {
 600     MSDState *s = USB_STORAGE_DEV(dev);
 601     BlockBackend *blk = s->conf.blk;
 602     SCSIDevice *scsi_dev;
 603
 604     if (!blk) {
 605         error_setg(errp, "drive property not set");
 606         return;
 607     }
 608
 609     if (!blkconf_blocksizes(&s->conf, errp)) {
 610         return;
 611     }
 612
 613     if (!blkconf_apply_backend_options(&s->conf, blk_is_read_only(blk), true,
 614                                        errp)) {
 615         return;
 616     }
 617
 618     /*
 619      * Hack alert: this pretends to be a block device, but it's really
 620      * a SCSI bus that can serve only a single device, which it
 621      * creates automatically.  But first it needs to detach from its
 622      * blockdev, or else scsi_bus_legacy_add_drive() dies when it
 623      * attaches again. We also need to take another reference so that
 624      * blk_detach_dev() doesn't free blk while we still need it.
 625      *
 626      * The hack is probably a bad idea.
 627      */
 628     blk_ref(blk);
 629     blk_detach_dev(blk, DEVICE(s));
 630     s->conf.blk = NULL;
 631
 632     usb_desc_create_serial(dev);
 633     usb_desc_init(dev);
 634     scsi_bus_new(&s->bus, sizeof(s->bus), DEVICE(dev),
 635                  &usb_msd_scsi_info_storage, NULL);
 636     scsi_dev = scsi_bus_legacy_add_drive(&s->bus, blk, 0, !!s->removable,
 637                                          s->conf.bootindex, s->conf.share_rw,
 638                                          s->conf.rerror, s->conf.werror,
 639                                          dev->serial,
 640                                          errp);
 641     blk_unref(blk);
 642     if (!scsi_dev) {
 643         return;
 644     }
 645     usb_msd_handle_reset(dev);
 646     s->scsi_dev = scsi_dev;
 647 }
 648
 649 static void usb_msd_bot_realize(USBDevice *dev, Error **errp)
 650 {
 651     MSDState *s = USB_STORAGE_DEV(dev);
 652     DeviceState *d = DEVICE(dev);
 653
 654     usb_desc_create_serial(dev);
 655     usb_desc_init(dev);
 656     if (d->hotplugged) {
 657         s->dev.auto_attach = 0;
 658     }
 659
 660     scsi_bus_new(&s->bus, sizeof(s->bus), DEVICE(dev),
 661                  &usb_msd_scsi_info_bot, NULL);
 662     usb_msd_handle_reset(dev);
 663 }
 664
 665 static const VMStateDescription vmstate_usb_msd = {
 666     .name = "usb-storage",
 667     .version_id = 1,
 668     .minimum_version_id = 1,
 669     .fields = (VMStateField[]) {
 670         VMSTATE_USB_DEVICE(dev, MSDState),
 671         VMSTATE_UINT32(mode, MSDState),
 672         VMSTATE_UINT32(scsi_len, MSDState),
 673         VMSTATE_UINT32(scsi_off, MSDState),
 674         VMSTATE_UINT32(data_len, MSDState),
 675         VMSTATE_UINT32(csw.sig, MSDState),
 676         VMSTATE_UINT32(csw.tag, MSDState),
 677         VMSTATE_UINT32(csw.residue, MSDState),
 678         VMSTATE_UINT8(csw.status, MSDState),
 679         VMSTATE_END_OF_LIST()
 680     }
 681 };
 682
 683 static Property msd_properties[] = {
 684     DEFINE_BLOCK_PROPERTIES(MSDState, conf),
 685     DEFINE_BLOCK_ERROR_PROPERTIES(MSDState, conf),
 686     DEFINE_PROP_BIT("removable", MSDState, removable, 0, false),
 687     DEFINE_PROP_END_OF_LIST(),
 688 };
 689
 690 static void usb_msd_class_initfn_common(ObjectClass *klass, void *data)
 691 {
 692     DeviceClass *dc = DEVICE_CLASS(klass);
 693     USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
 694
 695     uc->product_desc   = "QEMU USB MSD";
 696     uc->usb_desc       = &desc;
 697     uc->cancel_packet  = usb_msd_cancel_io;
 698     uc->handle_attach  = usb_desc_attach;
 699     uc->handle_reset   = usb_msd_handle_reset;
 700     uc->handle_control = usb_msd_handle_control;
 701     uc->handle_data    = usb_msd_handle_data;
 702     set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
 703     dc->fw_name = "storage";
 704     dc->vmsd = &vmstate_usb_msd;
 705 }
 706
 707 static void usb_msd_class_storage_initfn(ObjectClass *klass, void *data)
 708 {
 709     DeviceClass *dc = DEVICE_CLASS(klass);
 710     USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
 711
 712     uc->realize = usb_msd_storage_realize;
 713     device_class_set_props(dc, msd_properties);
 714 }
 715
 716 static void usb_msd_get_bootindex(Object *obj, Visitor *v, const char *name,
 717                                   void *opaque, Error **errp)
 718 {
 719     USBDevice *dev = USB_DEVICE(obj);
 720     MSDState *s = USB_STORAGE_DEV(dev);
 721
 722     visit_type_int32(v, name, &s->conf.bootindex, errp);
 723 }
 724
 725 static void usb_msd_set_bootindex(Object *obj, Visitor *v, const char *name,
 726                                   void *opaque, Error **errp)
 727 {
 728     USBDevice *dev = USB_DEVICE(obj);
 729     MSDState *s = USB_STORAGE_DEV(dev);
 730     int32_t boot_index;
 731     Error *local_err = NULL;
 732
 733     if (!visit_type_int32(v, name, &boot_index, errp)) {
 734         return;
 735     }
 736     /* check whether bootindex is present in fw_boot_order list  */
 737     check_boot_index(boot_index, &local_err);
 738     if (local_err) {
 739         goto out;
 740     }
 741     /* change bootindex to a new one */
 742     s->conf.bootindex = boot_index;
 743
 744     if (s->scsi_dev) {
 745         object_property_set_int(OBJECT(s->scsi_dev), "bootindex", boot_index,
 746                                 &error_abort);
 747     }
 748
 749 out:
 750     error_propagate(errp, local_err);
 751 }
 752
 753 static const TypeInfo usb_storage_dev_type_info = {
 754     .name = TYPE_USB_STORAGE,
 755     .parent = TYPE_USB_DEVICE,
 756     .instance_size = sizeof(MSDState),
 757     .abstract = true,
 758     .class_init = usb_msd_class_initfn_common,
 759 };
 760
 761 static void usb_msd_instance_init(Object *obj)
 762 {
 763     object_property_add(obj, "bootindex", "int32",
 764                         usb_msd_get_bootindex,
 765                         usb_msd_set_bootindex, NULL, NULL);
 766     object_property_set_int(obj, "bootindex", -1, NULL);
 767 }
 768
 769 static void usb_msd_class_bot_initfn(ObjectClass *klass, void *data)
 770 {
 771     USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
 772
 773     uc->realize = usb_msd_bot_realize;
 774     uc->attached_settable = true;
 775 }
 776
 777 static const TypeInfo msd_info = {
 778     .name          = "usb-storage",
 779     .parent        = TYPE_USB_STORAGE,
 780     .class_init    = usb_msd_class_storage_initfn,
 781     .instance_init = usb_msd_instance_init,
 782 };
 783
 784 static const TypeInfo bot_info = {
 785     .name          = "usb-bot",
 786     .parent        = TYPE_USB_STORAGE,
 787     .class_init    = usb_msd_class_bot_initfn,
 788 };
 789
 790 static void usb_msd_register_types(void)
 791 {
 792     type_register_static(&usb_storage_dev_type_info);
 793     type_register_static(&msd_info);
 794     type_register_static(&bot_info);
 795 }
 796
 797 type_init(usb_msd_register_types)