2 * USB Mass Storage Device emulation
4 * Copyright (c) 2006 CodeSourcery.
5 * Written by Paul Brook
7 * This code is licenced under the LGPL.
10 #include "qemu-common.h"
11 #include "qemu-option.h"
12 #include "qemu-config.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. */
57 /* For async completion. */
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)",
94 static const USBDescIface desc_iface_full
= {
95 .bInterfaceNumber
= 0,
97 .bInterfaceClass
= USB_CLASS_MASS_STORAGE
,
98 .bInterfaceSubClass
= 0x06, /* SCSI */
99 .bInterfaceProtocol
= 0x50, /* Bulk */
100 .eps
= (USBDescEndpoint
[]) {
102 .bEndpointAddress
= USB_DIR_IN
| 0x01,
103 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
104 .wMaxPacketSize
= 64,
106 .bEndpointAddress
= USB_DIR_OUT
| 0x02,
107 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
108 .wMaxPacketSize
= 64,
113 static const USBDescDevice desc_device_full
= {
115 .bMaxPacketSize0
= 8,
116 .bNumConfigurations
= 1,
117 .confs
= (USBDescConfig
[]) {
120 .bConfigurationValue
= 1,
121 .iConfiguration
= STR_CONFIG_FULL
,
122 .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,
157 .ifs
= &desc_iface_high
,
162 static const USBDesc desc
= {
167 .iManufacturer
= STR_MANUFACTURER
,
168 .iProduct
= STR_PRODUCT
,
169 .iSerialNumber
= STR_SERIALNUMBER
,
171 .full
= &desc_device_full
,
172 .high
= &desc_device_high
,
176 static void usb_msd_copy_data(MSDState
*s
)
180 if (len
> s
->scsi_len
)
182 if (s
->mode
== USB_MSDM_DATAIN
) {
183 memcpy(s
->usb_buf
, s
->scsi_buf
, len
);
185 memcpy(s
->scsi_buf
, s
->usb_buf
, len
);
192 if (s
->scsi_len
== 0 || s
->data_len
== 0) {
193 if (s
->mode
== USB_MSDM_DATAIN
) {
194 s
->scsi_dev
->info
->read_data(s
->req
);
195 } else if (s
->mode
== USB_MSDM_DATAOUT
) {
196 s
->scsi_dev
->info
->write_data(s
->req
);
201 static void usb_msd_send_status(MSDState
*s
, USBPacket
*p
)
203 struct usb_msd_csw csw
;
206 csw
.sig
= cpu_to_le32(0x53425355);
207 csw
.tag
= cpu_to_le32(s
->tag
);
208 csw
.residue
= s
->residue
;
209 csw
.status
= s
->result
;
211 len
= MIN(sizeof(csw
), p
->len
);
212 memcpy(p
->data
, &csw
, len
);
215 static void usb_msd_command_complete(SCSIRequest
*req
, int reason
, uint32_t arg
)
217 MSDState
*s
= DO_UPCAST(MSDState
, dev
.qdev
, req
->bus
->qbus
.parent
);
218 USBPacket
*p
= s
->packet
;
220 if (req
->tag
!= s
->tag
) {
221 fprintf(stderr
, "usb-msd: Unexpected SCSI Tag 0x%x\n", req
->tag
);
223 if (reason
== SCSI_REASON_DONE
) {
224 DPRINTF("Command complete %d\n", arg
);
225 s
->residue
= s
->data_len
;
226 s
->result
= arg
!= 0;
228 if (s
->data_len
== 0 && s
->mode
== USB_MSDM_DATAOUT
) {
229 /* A deferred packet with no write data remaining must be
230 the status read packet. */
231 usb_msd_send_status(s
, p
);
232 s
->mode
= USB_MSDM_CBW
;
235 s
->data_len
-= s
->usb_len
;
236 if (s
->mode
== USB_MSDM_DATAIN
)
237 memset(s
->usb_buf
, 0, s
->usb_len
);
240 if (s
->data_len
== 0)
241 s
->mode
= USB_MSDM_CSW
;
244 usb_packet_complete(&s
->dev
, p
);
245 } else if (s
->data_len
== 0) {
246 s
->mode
= USB_MSDM_CSW
;
253 s
->scsi_buf
= s
->scsi_dev
->info
->get_buf(req
);
255 usb_msd_copy_data(s
);
256 if (s
->usb_len
== 0) {
257 /* Set s->packet to NULL before calling usb_packet_complete
258 because another request may be issued before
259 usb_packet_complete returns. */
260 DPRINTF("Packet complete %p\n", p
);
262 usb_packet_complete(&s
->dev
, p
);
267 static void usb_msd_request_cancelled(SCSIRequest
*req
)
269 MSDState
*s
= DO_UPCAST(MSDState
, dev
.qdev
, req
->bus
->qbus
.parent
);
272 scsi_req_unref(s
->req
);
279 static void usb_msd_handle_reset(USBDevice
*dev
)
281 MSDState
*s
= (MSDState
*)dev
;
284 s
->mode
= USB_MSDM_CBW
;
287 static int usb_msd_handle_control(USBDevice
*dev
, int request
, int value
,
288 int index
, int length
, uint8_t *data
)
290 MSDState
*s
= (MSDState
*)dev
;
293 ret
= usb_desc_handle_control(dev
, request
, value
, index
, length
, data
);
300 case DeviceRequest
| USB_REQ_GET_INTERFACE
:
304 case DeviceOutRequest
| USB_REQ_SET_INTERFACE
:
307 case EndpointOutRequest
| USB_REQ_CLEAR_FEATURE
:
310 case InterfaceOutRequest
| USB_REQ_SET_INTERFACE
:
313 /* Class specific requests. */
314 case ClassInterfaceOutRequest
| MassStorageReset
:
315 /* Reset state ready for the next CBW. */
316 s
->mode
= USB_MSDM_CBW
;
319 case ClassInterfaceRequest
| GetMaxLun
:
330 static void usb_msd_cancel_io(USBPacket
*p
, void *opaque
)
332 MSDState
*s
= opaque
;
333 scsi_req_cancel(s
->req
);
336 static int usb_msd_handle_data(USBDevice
*dev
, USBPacket
*p
)
338 MSDState
*s
= (MSDState
*)dev
;
340 struct usb_msd_cbw cbw
;
341 uint8_t devep
= p
->devep
;
342 uint8_t *data
= p
->data
;
353 fprintf(stderr
, "usb-msd: Bad CBW size");
356 memcpy(&cbw
, data
, 31);
357 if (le32_to_cpu(cbw
.sig
) != 0x43425355) {
358 fprintf(stderr
, "usb-msd: Bad signature %08x\n",
359 le32_to_cpu(cbw
.sig
));
362 DPRINTF("Command on LUN %d\n", cbw
.lun
);
364 fprintf(stderr
, "usb-msd: Bad LUN %d\n", cbw
.lun
);
367 s
->tag
= le32_to_cpu(cbw
.tag
);
368 s
->data_len
= le32_to_cpu(cbw
.data_len
);
369 if (s
->data_len
== 0) {
370 s
->mode
= USB_MSDM_CSW
;
371 } else if (cbw
.flags
& 0x80) {
372 s
->mode
= USB_MSDM_DATAIN
;
374 s
->mode
= USB_MSDM_DATAOUT
;
376 DPRINTF("Command tag 0x%x flags %08x len %d data %d\n",
377 s
->tag
, cbw
.flags
, cbw
.cmd_len
, s
->data_len
);
380 s
->req
= s
->scsi_dev
->info
->alloc_req(s
->scsi_dev
, s
->tag
, 0);
381 s
->scsi_dev
->info
->send_command(s
->req
, cbw
.cmd
);
382 /* ??? Should check that USB and SCSI data transfer
384 if (s
->residue
== 0) {
385 if (s
->mode
== USB_MSDM_DATAIN
) {
386 s
->scsi_dev
->info
->read_data(s
->req
);
387 } else if (s
->mode
== USB_MSDM_DATAOUT
) {
388 s
->scsi_dev
->info
->write_data(s
->req
);
394 case USB_MSDM_DATAOUT
:
395 DPRINTF("Data out %d/%d\n", len
, s
->data_len
);
396 if (len
> s
->data_len
)
402 usb_msd_copy_data(s
);
404 if (s
->residue
&& s
->usb_len
) {
405 s
->data_len
-= s
->usb_len
;
406 if (s
->data_len
== 0)
407 s
->mode
= USB_MSDM_CSW
;
411 DPRINTF("Deferring packet %p\n", p
);
412 usb_defer_packet(p
, usb_msd_cancel_io
, s
);
421 DPRINTF("Unexpected write (len %d)\n", len
);
431 case USB_MSDM_DATAOUT
:
432 if (s
->data_len
!= 0 || len
< 13)
434 /* Waiting for SCSI write to complete. */
435 usb_defer_packet(p
, usb_msd_cancel_io
, s
);
441 DPRINTF("Command status %d tag 0x%x, len %d\n",
442 s
->result
, s
->tag
, len
);
446 usb_msd_send_status(s
, p
);
447 s
->mode
= USB_MSDM_CBW
;
451 case USB_MSDM_DATAIN
:
452 DPRINTF("Data in %d/%d, scsi_len %d\n", len
, s
->data_len
, s
->scsi_len
);
453 if (len
> s
->data_len
)
458 usb_msd_copy_data(s
);
460 if (s
->residue
&& s
->usb_len
) {
461 s
->data_len
-= s
->usb_len
;
462 memset(s
->usb_buf
, 0, s
->usb_len
);
463 if (s
->data_len
== 0)
464 s
->mode
= USB_MSDM_CSW
;
468 DPRINTF("Deferring packet %p\n", p
);
469 usb_defer_packet(p
, usb_msd_cancel_io
, s
);
478 DPRINTF("Unexpected read (len %d)\n", len
);
484 DPRINTF("Bad token\n");
493 static void usb_msd_password_cb(void *opaque
, int err
)
495 MSDState
*s
= opaque
;
498 usb_device_attach(&s
->dev
);
500 qdev_unplug(&s
->dev
.qdev
);
503 static const struct SCSIBusOps usb_msd_scsi_ops
= {
504 .complete
= usb_msd_command_complete
,
505 .cancel
= usb_msd_request_cancelled
508 static int usb_msd_initfn(USBDevice
*dev
)
510 MSDState
*s
= DO_UPCAST(MSDState
, dev
, dev
);
511 BlockDriverState
*bs
= s
->conf
.bs
;
515 error_report("usb-msd: drive property not set");
520 * Hack alert: this pretends to be a block device, but it's really
521 * a SCSI bus that can serve only a single device, which it
522 * creates automatically. But first it needs to detach from its
523 * blockdev, or else scsi_bus_legacy_add_drive() dies when it
526 * The hack is probably a bad idea.
528 bdrv_detach(bs
, &s
->dev
.qdev
);
531 dinfo
= drive_get_by_blockdev(bs
);
532 if (dinfo
&& dinfo
->serial
) {
533 usb_desc_set_string(dev
, STR_SERIALNUMBER
, dinfo
->serial
);
537 scsi_bus_new(&s
->bus
, &s
->dev
.qdev
, 0, 1, &usb_msd_scsi_ops
);
538 s
->scsi_dev
= scsi_bus_legacy_add_drive(&s
->bus
, bs
, 0, !!s
->removable
);
542 s
->bus
.qbus
.allow_hotplug
= 0;
543 usb_msd_handle_reset(dev
);
545 if (bdrv_key_required(bs
)) {
547 monitor_read_bdrv_key_start(cur_mon
, bs
, usb_msd_password_cb
, s
);
548 s
->dev
.auto_attach
= 0;
554 add_boot_device_path(s
->conf
.bootindex
, &dev
->qdev
, "/disk@0,0");
558 static USBDevice
*usb_msd_init(const char *filename
)
568 /* parse -usbdevice disk: syntax into drive opts */
569 snprintf(id
, sizeof(id
), "usb%d", nr
++);
570 opts
= qemu_opts_create(qemu_find_opts("drive"), id
, 0);
572 p1
= strchr(filename
, ':');
576 if (strstart(filename
, "format=", &p2
)) {
577 int len
= MIN(p1
- p2
, sizeof(fmt
));
578 pstrcpy(fmt
, len
, p2
);
579 qemu_opt_set(opts
, "format", fmt
);
580 } else if (*filename
!= ':') {
581 printf("unrecognized USB mass-storage option %s\n", filename
);
587 printf("block device specification needed\n");
590 qemu_opt_set(opts
, "file", filename
);
591 qemu_opt_set(opts
, "if", "none");
593 /* create host drive */
594 dinfo
= drive_init(opts
, 0);
600 /* create guest device */
601 dev
= usb_create(NULL
/* FIXME */, "usb-storage");
605 if (qdev_prop_set_drive(&dev
->qdev
, "drive", dinfo
->bdrv
) < 0) {
606 qdev_free(&dev
->qdev
);
609 if (qdev_init(&dev
->qdev
) < 0)
615 static struct USBDeviceInfo msd_info
= {
616 .product_desc
= "QEMU USB MSD",
617 .qdev
.name
= "usb-storage",
618 .qdev
.fw_name
= "storage",
619 .qdev
.size
= sizeof(MSDState
),
621 .init
= usb_msd_initfn
,
622 .handle_packet
= usb_generic_handle_packet
,
623 .handle_attach
= usb_desc_attach
,
624 .handle_reset
= usb_msd_handle_reset
,
625 .handle_control
= usb_msd_handle_control
,
626 .handle_data
= usb_msd_handle_data
,
627 .usbdevice_name
= "disk",
628 .usbdevice_init
= usb_msd_init
,
629 .qdev
.props
= (Property
[]) {
630 DEFINE_BLOCK_PROPERTIES(MSDState
, conf
),
631 DEFINE_PROP_BIT("removable", MSDState
, removable
, 0, false),
632 DEFINE_PROP_END_OF_LIST(),
636 static void usb_msd_register_devices(void)
638 usb_qdev_register(&msd_info
);
640 device_init(usb_msd_register_devices
)