2 * USB Mass Storage Device emulation
4 * Copyright (c) 2006 CodeSourcery.
5 * Written by Paul Brook
7 * This code is licensed under the LGPL.
10 #include "qemu-common.h"
11 #include "qemu/option.h"
12 #include "qemu/config-file.h"
14 #include "hw/usb/desc.h"
16 #include "ui/console.h"
17 #include "monitor/monitor.h"
18 #include "sysemu/sysemu.h"
19 #include "sysemu/blockdev.h"
24 #define DPRINTF(fmt, ...) \
25 do { printf("usb-msd: " fmt , ## __VA_ARGS__); } while (0)
27 #define DPRINTF(fmt, ...) do {} while(0)
31 #define MassStorageReset 0xff
32 #define GetMaxLun 0xfe
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. */
54 struct usb_msd_csw csw;
57 /* For async completion. */
59 /* usb-storage only */
84 static const USBDescStrings desc_strings = {
85 [STR_MANUFACTURER] = "QEMU",
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 [STR_CONFIG_SUPER] = "Super speed config (usb 3.0)",
93 static const USBDescIface desc_iface_full = {
94 .bInterfaceNumber = 0,
96 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
97 .bInterfaceSubClass = 0x06, /* SCSI */
98 .bInterfaceProtocol = 0x50, /* Bulk */
99 .eps = (USBDescEndpoint[]) {
101 .bEndpointAddress = USB_DIR_IN | 0x01,
102 .bmAttributes = USB_ENDPOINT_XFER_BULK,
103 .wMaxPacketSize = 64,
105 .bEndpointAddress = USB_DIR_OUT | 0x02,
106 .bmAttributes = USB_ENDPOINT_XFER_BULK,
107 .wMaxPacketSize = 64,
112 static const USBDescDevice desc_device_full = {
114 .bMaxPacketSize0 = 8,
115 .bNumConfigurations = 1,
116 .confs = (USBDescConfig[]) {
119 .bConfigurationValue = 1,
120 .iConfiguration = STR_CONFIG_FULL,
121 .bmAttributes = 0xc0,
123 .ifs = &desc_iface_full,
128 static const USBDescIface desc_iface_high = {
129 .bInterfaceNumber = 0,
131 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
132 .bInterfaceSubClass = 0x06, /* SCSI */
133 .bInterfaceProtocol = 0x50, /* Bulk */
134 .eps = (USBDescEndpoint[]) {
136 .bEndpointAddress = USB_DIR_IN | 0x01,
137 .bmAttributes = USB_ENDPOINT_XFER_BULK,
138 .wMaxPacketSize = 512,
140 .bEndpointAddress = USB_DIR_OUT | 0x02,
141 .bmAttributes = USB_ENDPOINT_XFER_BULK,
142 .wMaxPacketSize = 512,
147 static const USBDescDevice desc_device_high = {
149 .bMaxPacketSize0 = 64,
150 .bNumConfigurations = 1,
151 .confs = (USBDescConfig[]) {
154 .bConfigurationValue = 1,
155 .iConfiguration = STR_CONFIG_HIGH,
156 .bmAttributes = 0xc0,
158 .ifs = &desc_iface_high,
163 static const USBDescIface desc_iface_super = {
164 .bInterfaceNumber = 0,
166 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
167 .bInterfaceSubClass = 0x06, /* SCSI */
168 .bInterfaceProtocol = 0x50, /* Bulk */
169 .eps = (USBDescEndpoint[]) {
171 .bEndpointAddress = USB_DIR_IN | 0x01,
172 .bmAttributes = USB_ENDPOINT_XFER_BULK,
173 .wMaxPacketSize = 1024,
176 .bEndpointAddress = USB_DIR_OUT | 0x02,
177 .bmAttributes = USB_ENDPOINT_XFER_BULK,
178 .wMaxPacketSize = 1024,
184 static const USBDescDevice desc_device_super = {
186 .bMaxPacketSize0 = 9,
187 .bNumConfigurations = 1,
188 .confs = (USBDescConfig[]) {
191 .bConfigurationValue = 1,
192 .iConfiguration = STR_CONFIG_SUPER,
193 .bmAttributes = 0xc0,
195 .ifs = &desc_iface_super,
200 static const USBDesc desc = {
202 .idVendor = 0x46f4, /* CRC16() of "QEMU" */
205 .iManufacturer = STR_MANUFACTURER,
206 .iProduct = STR_PRODUCT,
207 .iSerialNumber = STR_SERIALNUMBER,
209 .full = &desc_device_full,
210 .high = &desc_device_high,
211 .super = &desc_device_super,
215 static void usb_msd_copy_data(MSDState *s, USBPacket *p)
218 len = p->iov.size - p->actual_length;
219 if (len > s->scsi_len)
221 usb_packet_copy(p, scsi_req_get_buf(s->req) + s->scsi_off, len);
225 if (s->scsi_len == 0 || s->data_len == 0) {
226 scsi_req_continue(s->req);
230 static void usb_msd_send_status(MSDState *s, USBPacket *p)
234 DPRINTF("Command status %d tag 0x%x, len %zd\n",
235 s->csw.status, le32_to_cpu(s->csw.tag), p->iov.size);
237 assert(s->csw.sig == cpu_to_le32(0x53425355));
238 len = MIN(sizeof(s->csw), p->iov.size);
239 usb_packet_copy(p, &s->csw, len);
240 memset(&s->csw, 0, sizeof(s->csw));
243 static void usb_msd_packet_complete(MSDState *s)
245 USBPacket *p = s->packet;
247 /* Set s->packet to NULL before calling usb_packet_complete
248 because another request may be issued before
249 usb_packet_complete returns. */
250 DPRINTF("Packet complete %p\n", p);
252 usb_packet_complete(&s->dev, p);
255 static void usb_msd_transfer_data(SCSIRequest *req, uint32_t len)
257 MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
258 USBPacket *p = s->packet;
260 assert((s->mode == USB_MSDM_DATAOUT) == (req->cmd.mode == SCSI_XFER_TO_DEV));
264 usb_msd_copy_data(s, p);
266 if (p && p->actual_length == p->iov.size) {
267 p->status = USB_RET_SUCCESS; /* Clear previous ASYNC status */
268 usb_msd_packet_complete(s);
273 static void usb_msd_command_complete(SCSIRequest *req, uint32_t status, size_t resid)
275 MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
276 USBPacket *p = s->packet;
278 DPRINTF("Command complete %d tag 0x%x\n", status, req->tag);
280 s->csw.sig = cpu_to_le32(0x53425355);
281 s->csw.tag = cpu_to_le32(req->tag);
282 s->csw.residue = cpu_to_le32(s->data_len);
283 s->csw.status = status != 0;
286 if (s->data_len == 0 && s->mode == USB_MSDM_DATAOUT) {
287 /* A deferred packet with no write data remaining must be
288 the status read packet. */
289 usb_msd_send_status(s, p);
290 s->mode = USB_MSDM_CBW;
291 } else if (s->mode == USB_MSDM_CSW) {
292 usb_msd_send_status(s, p);
293 s->mode = USB_MSDM_CBW;
296 int len = (p->iov.size - p->actual_length);
297 usb_packet_skip(p, len);
300 if (s->data_len == 0) {
301 s->mode = USB_MSDM_CSW;
304 p->status = USB_RET_SUCCESS; /* Clear previous ASYNC status */
305 usb_msd_packet_complete(s);
306 } else if (s->data_len == 0) {
307 s->mode = USB_MSDM_CSW;
313 static void usb_msd_request_cancelled(SCSIRequest *req)
315 MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
318 scsi_req_unref(s->req);
324 static void usb_msd_handle_reset(USBDevice *dev)
326 MSDState *s = (MSDState *)dev;
330 scsi_req_cancel(s->req);
332 assert(s->req == NULL);
335 s->packet->status = USB_RET_STALL;
336 usb_msd_packet_complete(s);
339 s->mode = USB_MSDM_CBW;
342 static void usb_msd_handle_control(USBDevice *dev, USBPacket *p,
343 int request, int value, int index, int length, uint8_t *data)
345 MSDState *s = (MSDState *)dev;
346 SCSIDevice *scsi_dev;
349 ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
355 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
357 /* Class specific requests. */
358 case ClassInterfaceOutRequest | MassStorageReset:
359 /* Reset state ready for the next CBW. */
360 s->mode = USB_MSDM_CBW;
362 case ClassInterfaceRequest | GetMaxLun:
365 scsi_dev = scsi_device_find(&s->bus, 0, 0, maxlun+1);
366 if (scsi_dev == NULL) {
369 if (scsi_dev->lun != maxlun+1) {
374 DPRINTF("MaxLun %d\n", maxlun);
376 p->actual_length = 1;
379 p->status = USB_RET_STALL;
384 static void usb_msd_cancel_io(USBDevice *dev, USBPacket *p)
386 MSDState *s = DO_UPCAST(MSDState, dev, dev);
388 assert(s->packet == p);
392 scsi_req_cancel(s->req);
396 static void usb_msd_handle_data(USBDevice *dev, USBPacket *p)
398 MSDState *s = (MSDState *)dev;
400 struct usb_msd_cbw cbw;
401 uint8_t devep = p->ep->nr;
402 SCSIDevice *scsi_dev;
411 if (p->iov.size != 31) {
412 fprintf(stderr, "usb-msd: Bad CBW size");
415 usb_packet_copy(p, &cbw, 31);
416 if (le32_to_cpu(cbw.sig) != 0x43425355) {
417 fprintf(stderr, "usb-msd: Bad signature %08x\n",
418 le32_to_cpu(cbw.sig));
421 DPRINTF("Command on LUN %d\n", cbw.lun);
422 scsi_dev = scsi_device_find(&s->bus, 0, 0, cbw.lun);
423 if (scsi_dev == NULL) {
424 fprintf(stderr, "usb-msd: Bad LUN %d\n", cbw.lun);
427 tag = le32_to_cpu(cbw.tag);
428 s->data_len = le32_to_cpu(cbw.data_len);
429 if (s->data_len == 0) {
430 s->mode = USB_MSDM_CSW;
431 } else if (cbw.flags & 0x80) {
432 s->mode = USB_MSDM_DATAIN;
434 s->mode = USB_MSDM_DATAOUT;
436 DPRINTF("Command tag 0x%x flags %08x len %d data %d\n",
437 tag, cbw.flags, cbw.cmd_len, s->data_len);
438 assert(le32_to_cpu(s->csw.residue) == 0);
440 s->req = scsi_req_new(scsi_dev, tag, cbw.lun, cbw.cmd, NULL);
442 scsi_req_print(s->req);
444 scsi_req_enqueue(s->req);
445 if (s->req && s->req->cmd.xfer != SCSI_XFER_NONE) {
446 scsi_req_continue(s->req);
450 case USB_MSDM_DATAOUT:
451 DPRINTF("Data out %zd/%d\n", p->iov.size, s->data_len);
452 if (p->iov.size > s->data_len) {
457 usb_msd_copy_data(s, p);
459 if (le32_to_cpu(s->csw.residue)) {
460 int len = p->iov.size - p->actual_length;
462 usb_packet_skip(p, len);
464 if (s->data_len == 0) {
465 s->mode = USB_MSDM_CSW;
469 if (p->actual_length < p->iov.size) {
470 DPRINTF("Deferring packet %p [wait data-out]\n", p);
472 p->status = USB_RET_ASYNC;
477 DPRINTF("Unexpected write (len %zd)\n", p->iov.size);
487 case USB_MSDM_DATAOUT:
488 if (s->data_len != 0 || p->iov.size < 13) {
491 /* Waiting for SCSI write to complete. */
493 p->status = USB_RET_ASYNC;
497 if (p->iov.size < 13) {
502 /* still in flight */
503 DPRINTF("Deferring packet %p [wait status]\n", p);
505 p->status = USB_RET_ASYNC;
507 usb_msd_send_status(s, p);
508 s->mode = USB_MSDM_CBW;
512 case USB_MSDM_DATAIN:
513 DPRINTF("Data in %zd/%d, scsi_len %d\n",
514 p->iov.size, s->data_len, s->scsi_len);
516 usb_msd_copy_data(s, p);
518 if (le32_to_cpu(s->csw.residue)) {
519 int len = p->iov.size - p->actual_length;
521 usb_packet_skip(p, len);
523 if (s->data_len == 0) {
524 s->mode = USB_MSDM_CSW;
528 if (p->actual_length < p->iov.size) {
529 DPRINTF("Deferring packet %p [wait data-in]\n", p);
531 p->status = USB_RET_ASYNC;
536 DPRINTF("Unexpected read (len %zd)\n", p->iov.size);
542 DPRINTF("Bad token\n");
544 p->status = USB_RET_STALL;
549 static void usb_msd_password_cb(void *opaque, int err)
551 MSDState *s = opaque;
554 err = usb_device_attach(&s->dev);
557 qdev_unplug(&s->dev.qdev, NULL);
560 static void *usb_msd_load_request(QEMUFile *f, SCSIRequest *req)
562 MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
564 /* nothing to load, just store req in our state struct */
565 assert(s->req == NULL);
571 static const struct SCSIBusInfo usb_msd_scsi_info_storage = {
576 .transfer_data = usb_msd_transfer_data,
577 .complete = usb_msd_command_complete,
578 .cancel = usb_msd_request_cancelled,
579 .load_request = usb_msd_load_request,
582 static const struct SCSIBusInfo usb_msd_scsi_info_bot = {
587 .transfer_data = usb_msd_transfer_data,
588 .complete = usb_msd_command_complete,
589 .cancel = usb_msd_request_cancelled,
590 .load_request = usb_msd_load_request,
593 static int usb_msd_initfn_storage(USBDevice *dev)
595 MSDState *s = DO_UPCAST(MSDState, dev, dev);
596 BlockDriverState *bs = s->conf.bs;
597 SCSIDevice *scsi_dev;
600 error_report("drive property not set");
604 blkconf_serial(&s->conf, &s->serial);
607 * Hack alert: this pretends to be a block device, but it's really
608 * a SCSI bus that can serve only a single device, which it
609 * creates automatically. But first it needs to detach from its
610 * blockdev, or else scsi_bus_legacy_add_drive() dies when it
613 * The hack is probably a bad idea.
615 bdrv_detach_dev(bs, &s->dev.qdev);
619 usb_desc_set_string(dev, STR_SERIALNUMBER, s->serial);
621 usb_desc_create_serial(dev);
625 scsi_bus_new(&s->bus, &s->dev.qdev, &usb_msd_scsi_info_storage);
626 scsi_dev = scsi_bus_legacy_add_drive(&s->bus, bs, 0, !!s->removable,
631 s->bus.qbus.allow_hotplug = 0;
632 usb_msd_handle_reset(dev);
634 if (bdrv_key_required(bs)) {
636 monitor_read_bdrv_key_start(cur_mon, bs, usb_msd_password_cb, s);
637 s->dev.auto_attach = 0;
646 static int usb_msd_initfn_bot(USBDevice *dev)
648 MSDState *s = DO_UPCAST(MSDState, dev, dev);
650 usb_desc_create_serial(dev);
652 scsi_bus_new(&s->bus, &s->dev.qdev, &usb_msd_scsi_info_bot);
653 s->bus.qbus.allow_hotplug = 0;
654 usb_msd_handle_reset(dev);
659 static USBDevice *usb_msd_init(USBBus *bus, const char *filename)
669 /* parse -usbdevice disk: syntax into drive opts */
670 snprintf(id, sizeof(id), "usb%d", nr++);
671 opts = qemu_opts_create(qemu_find_opts("drive"), id, 0, NULL);
673 p1 = strchr(filename, ':');
677 if (strstart(filename, "format=", &p2)) {
678 int len = MIN(p1 - p2, sizeof(fmt));
679 pstrcpy(fmt, len, p2);
680 qemu_opt_set(opts, "format", fmt);
681 } else if (*filename != ':') {
682 printf("unrecognized USB mass-storage option %s\n", filename);
688 printf("block device specification needed\n");
691 qemu_opt_set(opts, "file", filename);
692 qemu_opt_set(opts, "if", "none");
694 /* create host drive */
695 dinfo = drive_init(opts, 0);
701 /* create guest device */
702 dev = usb_create(bus, "usb-storage");
706 if (qdev_prop_set_drive(&dev->qdev, "drive", dinfo->bdrv) < 0) {
707 qdev_free(&dev->qdev);
710 if (qdev_init(&dev->qdev) < 0)
716 static const VMStateDescription vmstate_usb_msd = {
717 .name = "usb-storage",
719 .minimum_version_id = 1,
720 .fields = (VMStateField []) {
721 VMSTATE_USB_DEVICE(dev, MSDState),
722 VMSTATE_UINT32(mode, MSDState),
723 VMSTATE_UINT32(scsi_len, MSDState),
724 VMSTATE_UINT32(scsi_off, MSDState),
725 VMSTATE_UINT32(data_len, MSDState),
726 VMSTATE_UINT32(csw.sig, MSDState),
727 VMSTATE_UINT32(csw.tag, MSDState),
728 VMSTATE_UINT32(csw.residue, MSDState),
729 VMSTATE_UINT8(csw.status, MSDState),
730 VMSTATE_END_OF_LIST()
734 static Property msd_properties[] = {
735 DEFINE_BLOCK_PROPERTIES(MSDState, conf),
736 DEFINE_PROP_STRING("serial", MSDState, serial),
737 DEFINE_PROP_BIT("removable", MSDState, removable, 0, false),
738 DEFINE_PROP_END_OF_LIST(),
741 static void usb_msd_class_initfn_common(ObjectClass *klass)
743 DeviceClass *dc = DEVICE_CLASS(klass);
744 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
746 uc->product_desc = "QEMU USB MSD";
747 uc->usb_desc = &desc;
748 uc->cancel_packet = usb_msd_cancel_io;
749 uc->handle_attach = usb_desc_attach;
750 uc->handle_reset = usb_msd_handle_reset;
751 uc->handle_control = usb_msd_handle_control;
752 uc->handle_data = usb_msd_handle_data;
753 dc->fw_name = "storage";
754 dc->vmsd = &vmstate_usb_msd;
757 static void usb_msd_class_initfn_storage(ObjectClass *klass, void *data)
759 DeviceClass *dc = DEVICE_CLASS(klass);
760 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
762 uc->init = usb_msd_initfn_storage;
763 dc->props = msd_properties;
764 usb_msd_class_initfn_common(klass);
767 static void usb_msd_class_initfn_bot(ObjectClass *klass, void *data)
769 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
771 uc->init = usb_msd_initfn_bot;
772 usb_msd_class_initfn_common(klass);
775 static const TypeInfo msd_info = {
776 .name = "usb-storage",
777 .parent = TYPE_USB_DEVICE,
778 .instance_size = sizeof(MSDState),
779 .class_init = usb_msd_class_initfn_storage,
782 static const TypeInfo bot_info = {
784 .parent = TYPE_USB_DEVICE,
785 .instance_size = sizeof(MSDState),
786 .class_init = usb_msd_class_initfn_bot,
789 static void usb_msd_register_types(void)
791 type_register_static(&msd_info);
792 type_register_static(&bot_info);
793 usb_legacy_register("usb-storage", "disk", usb_msd_init);
796 type_init(usb_msd_register_types)