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
, /* Tranfer data to device. */
37 USB_MSDM_DATAIN
, /* Transfer data from device. */
38 USB_MSDM_CSW
/* Command Status. */
55 /* For async completion. */
84 static const USBDescStrings desc_strings
= {
85 [STR_MANUFACTURER
] = "QEMU " QEMU_VERSION
,
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)",
92 static const USBDescIface desc_iface_full
= {
93 .bInterfaceNumber
= 0,
95 .bInterfaceClass
= USB_CLASS_MASS_STORAGE
,
96 .bInterfaceSubClass
= 0x06, /* SCSI */
97 .bInterfaceProtocol
= 0x50, /* Bulk */
98 .eps
= (USBDescEndpoint
[]) {
100 .bEndpointAddress
= USB_DIR_IN
| 0x01,
101 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
102 .wMaxPacketSize
= 64,
104 .bEndpointAddress
= USB_DIR_OUT
| 0x02,
105 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
106 .wMaxPacketSize
= 64,
111 static const USBDescDevice desc_device_full
= {
113 .bMaxPacketSize0
= 8,
114 .bNumConfigurations
= 1,
115 .confs
= (USBDescConfig
[]) {
118 .bConfigurationValue
= 1,
119 .iConfiguration
= STR_CONFIG_FULL
,
120 .bmAttributes
= 0xc0,
121 .ifs
= &desc_iface_full
,
126 static const USBDescIface desc_iface_high
= {
127 .bInterfaceNumber
= 0,
129 .bInterfaceClass
= USB_CLASS_MASS_STORAGE
,
130 .bInterfaceSubClass
= 0x06, /* SCSI */
131 .bInterfaceProtocol
= 0x50, /* Bulk */
132 .eps
= (USBDescEndpoint
[]) {
134 .bEndpointAddress
= USB_DIR_IN
| 0x01,
135 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
136 .wMaxPacketSize
= 512,
138 .bEndpointAddress
= USB_DIR_OUT
| 0x02,
139 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
140 .wMaxPacketSize
= 512,
145 static const USBDescDevice desc_device_high
= {
147 .bMaxPacketSize0
= 64,
148 .bNumConfigurations
= 1,
149 .confs
= (USBDescConfig
[]) {
152 .bConfigurationValue
= 1,
153 .iConfiguration
= STR_CONFIG_HIGH
,
154 .bmAttributes
= 0xc0,
155 .ifs
= &desc_iface_high
,
160 static const USBDesc desc
= {
165 .iManufacturer
= STR_MANUFACTURER
,
166 .iProduct
= STR_PRODUCT
,
167 .iSerialNumber
= STR_SERIALNUMBER
,
169 .full
= &desc_device_full
,
170 .high
= &desc_device_high
,
174 static void usb_msd_copy_data(MSDState
*s
)
178 if (len
> s
->scsi_len
)
180 if (s
->mode
== USB_MSDM_DATAIN
) {
181 memcpy(s
->usb_buf
, s
->scsi_buf
, len
);
183 memcpy(s
->scsi_buf
, s
->usb_buf
, len
);
190 if (s
->scsi_len
== 0) {
191 if (s
->mode
== USB_MSDM_DATAIN
) {
192 s
->scsi_dev
->info
->read_data(s
->scsi_dev
, s
->tag
);
193 } else if (s
->mode
== USB_MSDM_DATAOUT
) {
194 s
->scsi_dev
->info
->write_data(s
->scsi_dev
, s
->tag
);
199 static void usb_msd_send_status(MSDState
*s
, USBPacket
*p
)
201 struct usb_msd_csw csw
;
204 csw
.sig
= cpu_to_le32(0x53425355);
205 csw
.tag
= cpu_to_le32(s
->tag
);
206 csw
.residue
= s
->residue
;
207 csw
.status
= s
->result
;
209 len
= MIN(sizeof(csw
), p
->len
);
210 memcpy(p
->data
, &csw
, len
);
213 static void usb_msd_command_complete(SCSIBus
*bus
, int reason
, uint32_t tag
,
216 MSDState
*s
= DO_UPCAST(MSDState
, dev
.qdev
, bus
->qbus
.parent
);
217 USBPacket
*p
= s
->packet
;
220 fprintf(stderr
, "usb-msd: Unexpected SCSI Tag 0x%x\n", tag
);
222 if (reason
== SCSI_REASON_DONE
) {
223 DPRINTF("Command complete %d\n", arg
);
224 s
->residue
= s
->data_len
;
225 s
->result
= arg
!= 0;
227 if (s
->data_len
== 0 && s
->mode
== USB_MSDM_DATAOUT
) {
228 /* A deferred packet with no write data remaining must be
229 the status read packet. */
230 usb_msd_send_status(s
, p
);
231 s
->mode
= USB_MSDM_CBW
;
234 s
->data_len
-= s
->usb_len
;
235 if (s
->mode
== USB_MSDM_DATAIN
)
236 memset(s
->usb_buf
, 0, s
->usb_len
);
239 if (s
->data_len
== 0)
240 s
->mode
= USB_MSDM_CSW
;
243 usb_packet_complete(p
);
244 } else if (s
->data_len
== 0) {
245 s
->mode
= USB_MSDM_CSW
;
250 s
->scsi_buf
= s
->scsi_dev
->info
->get_buf(s
->scsi_dev
, tag
);
252 usb_msd_copy_data(s
);
253 if (s
->usb_len
== 0) {
254 /* Set s->packet to NULL before calling usb_packet_complete
255 because annother request may be issued before
256 usb_packet_complete returns. */
257 DPRINTF("Packet complete %p\n", p
);
259 usb_packet_complete(p
);
264 static void usb_msd_handle_reset(USBDevice
*dev
)
266 MSDState
*s
= (MSDState
*)dev
;
269 s
->mode
= USB_MSDM_CBW
;
272 static int usb_msd_handle_control(USBDevice
*dev
, int request
, int value
,
273 int index
, int length
, uint8_t *data
)
275 MSDState
*s
= (MSDState
*)dev
;
278 ret
= usb_desc_handle_control(dev
, request
, value
, index
, length
, data
);
285 case DeviceRequest
| USB_REQ_GET_INTERFACE
:
289 case DeviceOutRequest
| USB_REQ_SET_INTERFACE
:
292 case EndpointOutRequest
| USB_REQ_CLEAR_FEATURE
:
295 case InterfaceOutRequest
| USB_REQ_SET_INTERFACE
:
298 /* Class specific requests. */
299 case ClassInterfaceOutRequest
| MassStorageReset
:
300 /* Reset state ready for the next CBW. */
301 s
->mode
= USB_MSDM_CBW
;
304 case ClassInterfaceRequest
| GetMaxLun
:
315 static void usb_msd_cancel_io(USBPacket
*p
, void *opaque
)
317 MSDState
*s
= opaque
;
318 s
->scsi_dev
->info
->cancel_io(s
->scsi_dev
, s
->tag
);
323 static int usb_msd_handle_data(USBDevice
*dev
, USBPacket
*p
)
325 MSDState
*s
= (MSDState
*)dev
;
327 struct usb_msd_cbw cbw
;
328 uint8_t devep
= p
->devep
;
329 uint8_t *data
= p
->data
;
340 fprintf(stderr
, "usb-msd: Bad CBW size");
343 memcpy(&cbw
, data
, 31);
344 if (le32_to_cpu(cbw
.sig
) != 0x43425355) {
345 fprintf(stderr
, "usb-msd: Bad signature %08x\n",
346 le32_to_cpu(cbw
.sig
));
349 DPRINTF("Command on LUN %d\n", cbw
.lun
);
351 fprintf(stderr
, "usb-msd: Bad LUN %d\n", cbw
.lun
);
354 s
->tag
= le32_to_cpu(cbw
.tag
);
355 s
->data_len
= le32_to_cpu(cbw
.data_len
);
356 if (s
->data_len
== 0) {
357 s
->mode
= USB_MSDM_CSW
;
358 } else if (cbw
.flags
& 0x80) {
359 s
->mode
= USB_MSDM_DATAIN
;
361 s
->mode
= USB_MSDM_DATAOUT
;
363 DPRINTF("Command tag 0x%x flags %08x len %d data %d\n",
364 s
->tag
, cbw
.flags
, cbw
.cmd_len
, s
->data_len
);
366 s
->scsi_dev
->info
->send_command(s
->scsi_dev
, s
->tag
, cbw
.cmd
, 0);
367 /* ??? Should check that USB and SCSI data transfer
369 if (s
->residue
== 0) {
370 if (s
->mode
== USB_MSDM_DATAIN
) {
371 s
->scsi_dev
->info
->read_data(s
->scsi_dev
, s
->tag
);
372 } else if (s
->mode
== USB_MSDM_DATAOUT
) {
373 s
->scsi_dev
->info
->write_data(s
->scsi_dev
, s
->tag
);
379 case USB_MSDM_DATAOUT
:
380 DPRINTF("Data out %d/%d\n", len
, s
->data_len
);
381 if (len
> s
->data_len
)
387 usb_msd_copy_data(s
);
389 if (s
->residue
&& s
->usb_len
) {
390 s
->data_len
-= s
->usb_len
;
391 if (s
->data_len
== 0)
392 s
->mode
= USB_MSDM_CSW
;
396 DPRINTF("Deferring packet %p\n", p
);
397 usb_defer_packet(p
, usb_msd_cancel_io
, s
);
406 DPRINTF("Unexpected write (len %d)\n", len
);
416 case USB_MSDM_DATAOUT
:
417 if (s
->data_len
!= 0 || len
< 13)
419 /* Waiting for SCSI write to complete. */
420 usb_defer_packet(p
, usb_msd_cancel_io
, s
);
426 DPRINTF("Command status %d tag 0x%x, len %d\n",
427 s
->result
, s
->tag
, len
);
431 usb_msd_send_status(s
, p
);
432 s
->mode
= USB_MSDM_CBW
;
436 case USB_MSDM_DATAIN
:
437 DPRINTF("Data in %d/%d\n", len
, s
->data_len
);
438 if (len
> s
->data_len
)
443 usb_msd_copy_data(s
);
445 if (s
->residue
&& s
->usb_len
) {
446 s
->data_len
-= s
->usb_len
;
447 memset(s
->usb_buf
, 0, s
->usb_len
);
448 if (s
->data_len
== 0)
449 s
->mode
= USB_MSDM_CSW
;
453 DPRINTF("Deferring packet %p\n", p
);
454 usb_defer_packet(p
, usb_msd_cancel_io
, s
);
463 DPRINTF("Unexpected read (len %d)\n", len
);
469 DPRINTF("Bad token\n");
478 static void usb_msd_password_cb(void *opaque
, int err
)
480 MSDState
*s
= opaque
;
483 usb_device_attach(&s
->dev
);
485 qdev_unplug(&s
->dev
.qdev
);
488 static int usb_msd_initfn(USBDevice
*dev
)
490 MSDState
*s
= DO_UPCAST(MSDState
, dev
, dev
);
491 BlockDriverState
*bs
= s
->conf
.bs
;
495 error_report("usb-msd: drive property not set");
500 * Hack alert: this pretends to be a block device, but it's really
501 * a SCSI bus that can serve only a single device, which it
502 * creates automatically. But first it needs to detach from its
503 * blockdev, or else scsi_bus_legacy_add_drive() dies when it
506 * The hack is probably a bad idea.
508 bdrv_detach(bs
, &s
->dev
.qdev
);
511 dinfo
= drive_get_by_blockdev(bs
);
512 if (dinfo
&& dinfo
->serial
) {
513 usb_desc_set_string(dev
, STR_SERIALNUMBER
, dinfo
->serial
);
517 scsi_bus_new(&s
->bus
, &s
->dev
.qdev
, 0, 1, usb_msd_command_complete
);
518 s
->scsi_dev
= scsi_bus_legacy_add_drive(&s
->bus
, bs
, 0);
522 s
->bus
.qbus
.allow_hotplug
= 0;
523 usb_msd_handle_reset(dev
);
525 if (bdrv_key_required(bs
)) {
527 monitor_read_bdrv_key_start(cur_mon
, bs
, usb_msd_password_cb
, s
);
528 s
->dev
.auto_attach
= 0;
537 static USBDevice
*usb_msd_init(const char *filename
)
548 /* parse -usbdevice disk: syntax into drive opts */
549 snprintf(id
, sizeof(id
), "usb%d", nr
++);
550 opts
= qemu_opts_create(qemu_find_opts("drive"), id
, 0);
552 p1
= strchr(filename
, ':');
556 if (strstart(filename
, "format=", &p2
)) {
557 int len
= MIN(p1
- p2
, sizeof(fmt
));
558 pstrcpy(fmt
, len
, p2
);
559 qemu_opt_set(opts
, "format", fmt
);
560 } else if (*filename
!= ':') {
561 printf("unrecognized USB mass-storage option %s\n", filename
);
567 printf("block device specification needed\n");
570 qemu_opt_set(opts
, "file", filename
);
571 qemu_opt_set(opts
, "if", "none");
573 /* create host drive */
574 dinfo
= drive_init(opts
, 0, &fatal_error
);
580 /* create guest device */
581 dev
= usb_create(NULL
/* FIXME */, "usb-storage");
585 if (qdev_prop_set_drive(&dev
->qdev
, "drive", dinfo
->bdrv
) < 0) {
586 qdev_free(&dev
->qdev
);
589 if (qdev_init(&dev
->qdev
) < 0)
595 static struct USBDeviceInfo msd_info
= {
596 .product_desc
= "QEMU USB MSD",
597 .qdev
.name
= "usb-storage",
598 .qdev
.size
= sizeof(MSDState
),
600 .init
= usb_msd_initfn
,
601 .handle_packet
= usb_generic_handle_packet
,
602 .handle_attach
= usb_desc_attach
,
603 .handle_reset
= usb_msd_handle_reset
,
604 .handle_control
= usb_msd_handle_control
,
605 .handle_data
= usb_msd_handle_data
,
606 .usbdevice_name
= "disk",
607 .usbdevice_init
= usb_msd_init
,
608 .qdev
.props
= (Property
[]) {
609 DEFINE_BLOCK_PROPERTIES(MSDState
, conf
),
610 DEFINE_PROP_END_OF_LIST(),
614 static void usb_msd_register_devices(void)
616 usb_qdev_register(&msd_info
);
618 device_init(usb_msd_register_devices
)