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
)
201 struct usb_msd_csw csw
;
203 csw
.sig
= cpu_to_le32(0x53425355);
204 csw
.tag
= cpu_to_le32(s
->tag
);
205 csw
.residue
= s
->residue
;
206 csw
.status
= s
->result
;
207 memcpy(s
->usb_buf
, &csw
, 13);
210 static void usb_msd_command_complete(SCSIBus
*bus
, int reason
, uint32_t tag
,
213 MSDState
*s
= DO_UPCAST(MSDState
, dev
.qdev
, bus
->qbus
.parent
);
214 USBPacket
*p
= s
->packet
;
217 fprintf(stderr
, "usb-msd: Unexpected SCSI Tag 0x%x\n", tag
);
219 if (reason
== SCSI_REASON_DONE
) {
220 DPRINTF("Command complete %d\n", arg
);
221 s
->residue
= s
->data_len
;
222 s
->result
= arg
!= 0;
224 if (s
->data_len
== 0 && s
->mode
== USB_MSDM_DATAOUT
) {
225 /* A deferred packet with no write data remaining must be
226 the status read packet. */
227 usb_msd_send_status(s
);
228 s
->mode
= USB_MSDM_CBW
;
231 s
->data_len
-= s
->usb_len
;
232 if (s
->mode
== USB_MSDM_DATAIN
)
233 memset(s
->usb_buf
, 0, s
->usb_len
);
236 if (s
->data_len
== 0)
237 s
->mode
= USB_MSDM_CSW
;
240 usb_packet_complete(p
);
241 } else if (s
->data_len
== 0) {
242 s
->mode
= USB_MSDM_CSW
;
247 s
->scsi_buf
= s
->scsi_dev
->info
->get_buf(s
->scsi_dev
, tag
);
249 usb_msd_copy_data(s
);
250 if (s
->usb_len
== 0) {
251 /* Set s->packet to NULL before calling usb_packet_complete
252 because annother request may be issued before
253 usb_packet_complete returns. */
254 DPRINTF("Packet complete %p\n", p
);
256 usb_packet_complete(p
);
261 static void usb_msd_handle_reset(USBDevice
*dev
)
263 MSDState
*s
= (MSDState
*)dev
;
266 s
->mode
= USB_MSDM_CBW
;
269 static int usb_msd_handle_control(USBDevice
*dev
, int request
, int value
,
270 int index
, int length
, uint8_t *data
)
272 MSDState
*s
= (MSDState
*)dev
;
275 ret
= usb_desc_handle_control(dev
, request
, value
, index
, length
, data
);
282 case DeviceRequest
| USB_REQ_GET_INTERFACE
:
286 case DeviceOutRequest
| USB_REQ_SET_INTERFACE
:
289 case EndpointOutRequest
| USB_REQ_CLEAR_FEATURE
:
292 case InterfaceOutRequest
| USB_REQ_SET_INTERFACE
:
295 /* Class specific requests. */
296 case ClassInterfaceOutRequest
| MassStorageReset
:
297 /* Reset state ready for the next CBW. */
298 s
->mode
= USB_MSDM_CBW
;
301 case ClassInterfaceRequest
| GetMaxLun
:
312 static void usb_msd_cancel_io(USBPacket
*p
, void *opaque
)
314 MSDState
*s
= opaque
;
315 s
->scsi_dev
->info
->cancel_io(s
->scsi_dev
, s
->tag
);
320 static int usb_msd_handle_data(USBDevice
*dev
, USBPacket
*p
)
322 MSDState
*s
= (MSDState
*)dev
;
324 struct usb_msd_cbw cbw
;
325 uint8_t devep
= p
->devep
;
326 uint8_t *data
= p
->data
;
337 fprintf(stderr
, "usb-msd: Bad CBW size");
340 memcpy(&cbw
, data
, 31);
341 if (le32_to_cpu(cbw
.sig
) != 0x43425355) {
342 fprintf(stderr
, "usb-msd: Bad signature %08x\n",
343 le32_to_cpu(cbw
.sig
));
346 DPRINTF("Command on LUN %d\n", cbw
.lun
);
348 fprintf(stderr
, "usb-msd: Bad LUN %d\n", cbw
.lun
);
351 s
->tag
= le32_to_cpu(cbw
.tag
);
352 s
->data_len
= le32_to_cpu(cbw
.data_len
);
353 if (s
->data_len
== 0) {
354 s
->mode
= USB_MSDM_CSW
;
355 } else if (cbw
.flags
& 0x80) {
356 s
->mode
= USB_MSDM_DATAIN
;
358 s
->mode
= USB_MSDM_DATAOUT
;
360 DPRINTF("Command tag 0x%x flags %08x len %d data %d\n",
361 s
->tag
, cbw
.flags
, cbw
.cmd_len
, s
->data_len
);
363 s
->scsi_dev
->info
->send_command(s
->scsi_dev
, s
->tag
, cbw
.cmd
, 0);
364 /* ??? Should check that USB and SCSI data transfer
366 if (s
->residue
== 0) {
367 if (s
->mode
== USB_MSDM_DATAIN
) {
368 s
->scsi_dev
->info
->read_data(s
->scsi_dev
, s
->tag
);
369 } else if (s
->mode
== USB_MSDM_DATAOUT
) {
370 s
->scsi_dev
->info
->write_data(s
->scsi_dev
, s
->tag
);
376 case USB_MSDM_DATAOUT
:
377 DPRINTF("Data out %d/%d\n", len
, s
->data_len
);
378 if (len
> s
->data_len
)
384 usb_msd_copy_data(s
);
386 if (s
->residue
&& s
->usb_len
) {
387 s
->data_len
-= s
->usb_len
;
388 if (s
->data_len
== 0)
389 s
->mode
= USB_MSDM_CSW
;
393 DPRINTF("Deferring packet %p\n", p
);
394 usb_defer_packet(p
, usb_msd_cancel_io
, s
);
403 DPRINTF("Unexpected write (len %d)\n", len
);
413 case USB_MSDM_DATAOUT
:
414 if (s
->data_len
!= 0 || len
< 13)
416 /* Waiting for SCSI write to complete. */
417 usb_defer_packet(p
, usb_msd_cancel_io
, s
);
423 DPRINTF("Command status %d tag 0x%x, len %d\n",
424 s
->result
, s
->tag
, len
);
430 usb_msd_send_status(s
);
431 s
->mode
= USB_MSDM_CBW
;
435 case USB_MSDM_DATAIN
:
436 DPRINTF("Data in %d/%d\n", len
, s
->data_len
);
437 if (len
> s
->data_len
)
442 usb_msd_copy_data(s
);
444 if (s
->residue
&& s
->usb_len
) {
445 s
->data_len
-= s
->usb_len
;
446 memset(s
->usb_buf
, 0, s
->usb_len
);
447 if (s
->data_len
== 0)
448 s
->mode
= USB_MSDM_CSW
;
452 DPRINTF("Deferring packet %p\n", p
);
453 usb_defer_packet(p
, usb_msd_cancel_io
, s
);
462 DPRINTF("Unexpected read (len %d)\n", len
);
468 DPRINTF("Bad token\n");
477 static void usb_msd_password_cb(void *opaque
, int err
)
479 MSDState
*s
= opaque
;
482 usb_device_attach(&s
->dev
);
484 qdev_unplug(&s
->dev
.qdev
);
487 static int usb_msd_initfn(USBDevice
*dev
)
489 MSDState
*s
= DO_UPCAST(MSDState
, dev
, dev
);
490 BlockDriverState
*bs
= s
->conf
.bs
;
494 error_report("usb-msd: drive property not set");
499 * Hack alert: this pretends to be a block device, but it's really
500 * a SCSI bus that can serve only a single device, which it
501 * creates automatically. But first it needs to detach from its
502 * blockdev, or else scsi_bus_legacy_add_drive() dies when it
505 * The hack is probably a bad idea.
507 bdrv_detach(bs
, &s
->dev
.qdev
);
510 dinfo
= drive_get_by_blockdev(bs
);
511 if (dinfo
&& dinfo
->serial
) {
512 usb_desc_set_string(dev
, STR_SERIALNUMBER
, dinfo
->serial
);
516 scsi_bus_new(&s
->bus
, &s
->dev
.qdev
, 0, 1, usb_msd_command_complete
);
517 s
->scsi_dev
= scsi_bus_legacy_add_drive(&s
->bus
, bs
, 0);
521 s
->bus
.qbus
.allow_hotplug
= 0;
522 usb_msd_handle_reset(dev
);
524 if (bdrv_key_required(bs
)) {
526 monitor_read_bdrv_key_start(cur_mon
, bs
, usb_msd_password_cb
, s
);
527 s
->dev
.auto_attach
= 0;
536 static USBDevice
*usb_msd_init(const char *filename
)
547 /* parse -usbdevice disk: syntax into drive opts */
548 snprintf(id
, sizeof(id
), "usb%d", nr
++);
549 opts
= qemu_opts_create(qemu_find_opts("drive"), id
, 0);
551 p1
= strchr(filename
, ':');
555 if (strstart(filename
, "format=", &p2
)) {
556 int len
= MIN(p1
- p2
, sizeof(fmt
));
557 pstrcpy(fmt
, len
, p2
);
558 qemu_opt_set(opts
, "format", fmt
);
559 } else if (*filename
!= ':') {
560 printf("unrecognized USB mass-storage option %s\n", filename
);
566 printf("block device specification needed\n");
569 qemu_opt_set(opts
, "file", filename
);
570 qemu_opt_set(opts
, "if", "none");
572 /* create host drive */
573 dinfo
= drive_init(opts
, 0, &fatal_error
);
579 /* create guest device */
580 dev
= usb_create(NULL
/* FIXME */, "usb-storage");
584 if (qdev_prop_set_drive(&dev
->qdev
, "drive", dinfo
->bdrv
) < 0) {
585 qdev_free(&dev
->qdev
);
588 if (qdev_init(&dev
->qdev
) < 0)
594 static struct USBDeviceInfo msd_info
= {
595 .product_desc
= "QEMU USB MSD",
596 .qdev
.name
= "usb-storage",
597 .qdev
.size
= sizeof(MSDState
),
599 .init
= usb_msd_initfn
,
600 .handle_packet
= usb_generic_handle_packet
,
601 .handle_attach
= usb_desc_attach
,
602 .handle_reset
= usb_msd_handle_reset
,
603 .handle_control
= usb_msd_handle_control
,
604 .handle_data
= usb_msd_handle_data
,
605 .usbdevice_name
= "disk",
606 .usbdevice_init
= usb_msd_init
,
607 .qdev
.props
= (Property
[]) {
608 DEFINE_BLOCK_PROPERTIES(MSDState
, conf
),
609 DEFINE_PROP_END_OF_LIST(),
613 static void usb_msd_register_devices(void)
615 usb_qdev_register(&msd_info
);
617 device_init(usb_msd_register_devices
)