]> git.proxmox.com Git - qemu.git/blame - hw/usb/dev-storage.c
usb: add usb-bot device (scsi bulk-only transport).
[qemu.git] / hw / usb / dev-storage.c
CommitLineData
5fafdf24 1/*
2e5d83bb
PB
2 * USB Mass Storage Device emulation
3 *
4 * Copyright (c) 2006 CodeSourcery.
5 * Written by Paul Brook
6 *
8e31bf38 7 * This code is licensed under the LGPL.
2e5d83bb
PB
8 */
9
87ecb68b 10#include "qemu-common.h"
1de7afc9
PB
11#include "qemu/option.h"
12#include "qemu/config-file.h"
f1ae32a1
GH
13#include "hw/usb.h"
14#include "hw/usb/desc.h"
15#include "hw/scsi.h"
28ecbaee 16#include "ui/console.h"
83c9089e 17#include "monitor/monitor.h"
9c17d615
PB
18#include "sysemu/sysemu.h"
19#include "sysemu/blockdev.h"
2e5d83bb
PB
20
21//#define DEBUG_MSD
22
23#ifdef DEBUG_MSD
001faf32
BS
24#define DPRINTF(fmt, ...) \
25do { printf("usb-msd: " fmt , ## __VA_ARGS__); } while (0)
2e5d83bb 26#else
001faf32 27#define DPRINTF(fmt, ...) do {} while(0)
2e5d83bb
PB
28#endif
29
30/* USB requests. */
31#define MassStorageReset 0xff
32#define GetMaxLun 0xfe
33
34enum USBMSDMode {
35 USB_MSDM_CBW, /* Command Block. */
94843f66 36 USB_MSDM_DATAOUT, /* Transfer data to device. */
2e5d83bb
PB
37 USB_MSDM_DATAIN, /* Transfer data from device. */
38 USB_MSDM_CSW /* Command Status. */
39};
40
92a114f6
GH
41struct usb_msd_csw {
42 uint32_t sig;
43 uint32_t tag;
44 uint32_t residue;
45 uint8_t status;
46};
47
2e5d83bb
PB
48typedef struct {
49 USBDevice dev;
50 enum USBMSDMode mode;
1dc90367 51 uint32_t scsi_off;
a917d384 52 uint32_t scsi_len;
2e5d83bb 53 uint32_t data_len;
92a114f6 54 struct usb_msd_csw csw;
5c6c0e51 55 SCSIRequest *req;
ca9c39fa 56 SCSIBus bus;
34707333
GH
57 /* For async completion. */
58 USBPacket *packet;
59 /* usb-storage only */
428c149b 60 BlockConf conf;
c3a90cb1 61 char *serial;
6bb7b867 62 uint32_t removable;
2e5d83bb
PB
63} MSDState;
64
a917d384
PB
65struct usb_msd_cbw {
66 uint32_t sig;
67 uint32_t tag;
68 uint32_t data_len;
69 uint8_t flags;
70 uint8_t lun;
71 uint8_t cmd_len;
72 uint8_t cmd[16];
73};
74
81bfd2f2
GH
75enum {
76 STR_MANUFACTURER = 1,
77 STR_PRODUCT,
78 STR_SERIALNUMBER,
ca0c730d
GH
79 STR_CONFIG_FULL,
80 STR_CONFIG_HIGH,
79b40459 81 STR_CONFIG_SUPER,
2e5d83bb
PB
82};
83
81bfd2f2 84static const USBDescStrings desc_strings = {
93bfef4c 85 [STR_MANUFACTURER] = "QEMU",
81bfd2f2
GH
86 [STR_PRODUCT] = "QEMU USB HARDDRIVE",
87 [STR_SERIALNUMBER] = "1",
ca0c730d
GH
88 [STR_CONFIG_FULL] = "Full speed config (usb 1.1)",
89 [STR_CONFIG_HIGH] = "High speed config (usb 2.0)",
79b40459 90 [STR_CONFIG_SUPER] = "Super speed config (usb 3.0)",
81bfd2f2
GH
91};
92
ca0c730d 93static const USBDescIface desc_iface_full = {
81bfd2f2
GH
94 .bInterfaceNumber = 0,
95 .bNumEndpoints = 2,
96 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
97 .bInterfaceSubClass = 0x06, /* SCSI */
98 .bInterfaceProtocol = 0x50, /* Bulk */
99 .eps = (USBDescEndpoint[]) {
100 {
101 .bEndpointAddress = USB_DIR_IN | 0x01,
102 .bmAttributes = USB_ENDPOINT_XFER_BULK,
103 .wMaxPacketSize = 64,
104 },{
105 .bEndpointAddress = USB_DIR_OUT | 0x02,
106 .bmAttributes = USB_ENDPOINT_XFER_BULK,
107 .wMaxPacketSize = 64,
108 },
109 }
110};
111
ca0c730d
GH
112static const USBDescDevice desc_device_full = {
113 .bcdUSB = 0x0200,
81bfd2f2
GH
114 .bMaxPacketSize0 = 8,
115 .bNumConfigurations = 1,
116 .confs = (USBDescConfig[]) {
117 {
118 .bNumInterfaces = 1,
119 .bConfigurationValue = 1,
ca0c730d 120 .iConfiguration = STR_CONFIG_FULL,
81bfd2f2 121 .bmAttributes = 0xc0,
add75088 122 .nif = 1,
ca0c730d
GH
123 .ifs = &desc_iface_full,
124 },
125 },
126};
127
128static const USBDescIface desc_iface_high = {
129 .bInterfaceNumber = 0,
130 .bNumEndpoints = 2,
131 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
132 .bInterfaceSubClass = 0x06, /* SCSI */
133 .bInterfaceProtocol = 0x50, /* Bulk */
134 .eps = (USBDescEndpoint[]) {
135 {
136 .bEndpointAddress = USB_DIR_IN | 0x01,
137 .bmAttributes = USB_ENDPOINT_XFER_BULK,
138 .wMaxPacketSize = 512,
139 },{
140 .bEndpointAddress = USB_DIR_OUT | 0x02,
141 .bmAttributes = USB_ENDPOINT_XFER_BULK,
142 .wMaxPacketSize = 512,
143 },
144 }
145};
146
147static const USBDescDevice desc_device_high = {
148 .bcdUSB = 0x0200,
149 .bMaxPacketSize0 = 64,
150 .bNumConfigurations = 1,
151 .confs = (USBDescConfig[]) {
152 {
153 .bNumInterfaces = 1,
154 .bConfigurationValue = 1,
155 .iConfiguration = STR_CONFIG_HIGH,
156 .bmAttributes = 0xc0,
add75088 157 .nif = 1,
ca0c730d 158 .ifs = &desc_iface_high,
81bfd2f2
GH
159 },
160 },
161};
162
79b40459
GH
163static const USBDescIface desc_iface_super = {
164 .bInterfaceNumber = 0,
165 .bNumEndpoints = 2,
166 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
167 .bInterfaceSubClass = 0x06, /* SCSI */
168 .bInterfaceProtocol = 0x50, /* Bulk */
169 .eps = (USBDescEndpoint[]) {
170 {
171 .bEndpointAddress = USB_DIR_IN | 0x01,
172 .bmAttributes = USB_ENDPOINT_XFER_BULK,
173 .wMaxPacketSize = 1024,
174 .bMaxBurst = 15,
175 },{
176 .bEndpointAddress = USB_DIR_OUT | 0x02,
177 .bmAttributes = USB_ENDPOINT_XFER_BULK,
178 .wMaxPacketSize = 1024,
179 .bMaxBurst = 15,
180 },
181 }
182};
183
184static const USBDescDevice desc_device_super = {
185 .bcdUSB = 0x0300,
186 .bMaxPacketSize0 = 9,
187 .bNumConfigurations = 1,
188 .confs = (USBDescConfig[]) {
189 {
190 .bNumInterfaces = 1,
191 .bConfigurationValue = 1,
192 .iConfiguration = STR_CONFIG_SUPER,
193 .bmAttributes = 0xc0,
194 .nif = 1,
195 .ifs = &desc_iface_super,
196 },
197 },
198};
199
81bfd2f2
GH
200static const USBDesc desc = {
201 .id = {
db80358a
RT
202 .idVendor = 0x46f4, /* CRC16() of "QEMU" */
203 .idProduct = 0x0001,
81bfd2f2
GH
204 .bcdDevice = 0,
205 .iManufacturer = STR_MANUFACTURER,
206 .iProduct = STR_PRODUCT,
207 .iSerialNumber = STR_SERIALNUMBER,
208 },
79b40459
GH
209 .full = &desc_device_full,
210 .high = &desc_device_high,
211 .super = &desc_device_super,
212 .str = desc_strings,
2e5d83bb
PB
213};
214
29c74f76 215static void usb_msd_copy_data(MSDState *s, USBPacket *p)
a917d384
PB
216{
217 uint32_t len;
9a77a0f5 218 len = p->iov.size - p->actual_length;
a917d384
PB
219 if (len > s->scsi_len)
220 len = s->scsi_len;
1dc90367 221 usb_packet_copy(p, scsi_req_get_buf(s->req) + s->scsi_off, len);
a917d384 222 s->scsi_len -= len;
1dc90367 223 s->scsi_off += len;
a917d384 224 s->data_len -= len;
fa7935c1 225 if (s->scsi_len == 0 || s->data_len == 0) {
ad3376cc 226 scsi_req_continue(s->req);
a917d384
PB
227 }
228}
229
ab4797ad 230static void usb_msd_send_status(MSDState *s, USBPacket *p)
a917d384 231{
ab4797ad 232 int len;
a917d384 233
e04da7c3 234 DPRINTF("Command status %d tag 0x%x, len %zd\n",
e2854bf3 235 s->csw.status, le32_to_cpu(s->csw.tag), p->iov.size);
92a114f6 236
e2854bf3 237 assert(s->csw.sig == cpu_to_le32(0x53425355));
92a114f6
GH
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));
a917d384
PB
241}
242
1e6ed80b
GH
243static void usb_msd_packet_complete(MSDState *s)
244{
245 USBPacket *p = s->packet;
246
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);
251 s->packet = NULL;
252 usb_packet_complete(&s->dev, p);
253}
254
aba1f023 255static void usb_msd_transfer_data(SCSIRequest *req, uint32_t len)
2e5d83bb 256{
5c6c0e51 257 MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
a917d384 258 USBPacket *p = s->packet;
4d611c9a 259
ad3376cc 260 assert((s->mode == USB_MSDM_DATAOUT) == (req->cmd.mode == SCSI_XFER_TO_DEV));
aba1f023 261 s->scsi_len = len;
1dc90367 262 s->scsi_off = 0;
a917d384 263 if (p) {
29c74f76
GH
264 usb_msd_copy_data(s, p);
265 p = s->packet;
9a77a0f5
HG
266 if (p && p->actual_length == p->iov.size) {
267 p->status = USB_RET_SUCCESS; /* Clear previous ASYNC status */
1e6ed80b 268 usb_msd_packet_complete(s);
a917d384 269 }
4d611c9a 270 }
2e5d83bb
PB
271}
272
01e95455 273static void usb_msd_command_complete(SCSIRequest *req, uint32_t status, size_t resid)
c6df7102
PB
274{
275 MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
276 USBPacket *p = s->packet;
277
7b863f41 278 DPRINTF("Command complete %d tag 0x%x\n", status, req->tag);
92a114f6
GH
279
280 s->csw.sig = cpu_to_le32(0x53425355);
7b863f41 281 s->csw.tag = cpu_to_le32(req->tag);
0659879e 282 s->csw.residue = cpu_to_le32(s->data_len);
414c4604 283 s->csw.status = status != 0;
92a114f6 284
c6df7102
PB
285 if (s->packet) {
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;
54414218
GH
291 } else if (s->mode == USB_MSDM_CSW) {
292 usb_msd_send_status(s, p);
293 s->mode = USB_MSDM_CBW;
c6df7102
PB
294 } else {
295 if (s->data_len) {
9a77a0f5 296 int len = (p->iov.size - p->actual_length);
29c74f76
GH
297 usb_packet_skip(p, len);
298 s->data_len -= len;
c6df7102
PB
299 }
300 if (s->data_len == 0) {
301 s->mode = USB_MSDM_CSW;
302 }
303 }
9a77a0f5 304 p->status = USB_RET_SUCCESS; /* Clear previous ASYNC status */
1e6ed80b 305 usb_msd_packet_complete(s);
c6df7102
PB
306 } else if (s->data_len == 0) {
307 s->mode = USB_MSDM_CSW;
308 }
309 scsi_req_unref(req);
310 s->req = NULL;
311}
312
94d3f98a
PB
313static void usb_msd_request_cancelled(SCSIRequest *req)
314{
315 MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
316
317 if (req == s->req) {
318 scsi_req_unref(s->req);
319 s->req = NULL;
94d3f98a
PB
320 s->scsi_len = 0;
321 }
322}
323
059809e4 324static void usb_msd_handle_reset(USBDevice *dev)
2e5d83bb
PB
325{
326 MSDState *s = (MSDState *)dev;
327
328 DPRINTF("Reset\n");
24a5bbe1
GH
329 if (s->req) {
330 scsi_req_cancel(s->req);
331 }
332 assert(s->req == NULL);
333
334 if (s->packet) {
9a77a0f5 335 s->packet->status = USB_RET_STALL;
1e6ed80b 336 usb_msd_packet_complete(s);
24a5bbe1
GH
337 }
338
2e5d83bb 339 s->mode = USB_MSDM_CBW;
2e5d83bb
PB
340}
341
9a77a0f5 342static void usb_msd_handle_control(USBDevice *dev, USBPacket *p,
007fd62f 343 int request, int value, int index, int length, uint8_t *data)
2e5d83bb
PB
344{
345 MSDState *s = (MSDState *)dev;
34707333
GH
346 SCSIDevice *scsi_dev;
347 int ret, maxlun;
2e5d83bb 348
007fd62f 349 ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
81bfd2f2 350 if (ret >= 0) {
9a77a0f5 351 return;
81bfd2f2
GH
352 }
353
2e5d83bb 354 switch (request) {
2e5d83bb 355 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
e5322f76 356 break;
2e5d83bb 357 /* Class specific requests. */
f3571b1a 358 case ClassInterfaceOutRequest | MassStorageReset:
2e5d83bb
PB
359 /* Reset state ready for the next CBW. */
360 s->mode = USB_MSDM_CBW;
2e5d83bb 361 break;
f3571b1a 362 case ClassInterfaceRequest | GetMaxLun:
34707333
GH
363 maxlun = 0;
364 for (;;) {
365 scsi_dev = scsi_device_find(&s->bus, 0, 0, maxlun+1);
366 if (scsi_dev == NULL) {
367 break;
368 }
369 if (scsi_dev->lun != maxlun+1) {
370 break;
371 }
372 maxlun++;
373 }
374 DPRINTF("MaxLun %d\n", maxlun);
375 data[0] = maxlun;
9a77a0f5 376 p->actual_length = 1;
2e5d83bb
PB
377 break;
378 default:
9a77a0f5 379 p->status = USB_RET_STALL;
2e5d83bb
PB
380 break;
381 }
2e5d83bb
PB
382}
383
eb5e680a 384static void usb_msd_cancel_io(USBDevice *dev, USBPacket *p)
4d611c9a 385{
eb5e680a 386 MSDState *s = DO_UPCAST(MSDState, dev, dev);
d3ac1a87 387
6d7aeeeb
GH
388 assert(s->packet == p);
389 s->packet = NULL;
390
d3ac1a87
GH
391 if (s->req) {
392 scsi_req_cancel(s->req);
393 }
4d611c9a
PB
394}
395
9a77a0f5 396static void usb_msd_handle_data(USBDevice *dev, USBPacket *p)
2e5d83bb
PB
397{
398 MSDState *s = (MSDState *)dev;
7b863f41 399 uint32_t tag;
2e5d83bb 400 struct usb_msd_cbw cbw;
079d0b7f 401 uint8_t devep = p->ep->nr;
34707333 402 SCSIDevice *scsi_dev;
2e5d83bb 403
4d611c9a 404 switch (p->pid) {
2e5d83bb
PB
405 case USB_TOKEN_OUT:
406 if (devep != 2)
407 goto fail;
408
409 switch (s->mode) {
410 case USB_MSDM_CBW:
29c74f76 411 if (p->iov.size != 31) {
2e5d83bb
PB
412 fprintf(stderr, "usb-msd: Bad CBW size");
413 goto fail;
414 }
29c74f76 415 usb_packet_copy(p, &cbw, 31);
2e5d83bb
PB
416 if (le32_to_cpu(cbw.sig) != 0x43425355) {
417 fprintf(stderr, "usb-msd: Bad signature %08x\n",
418 le32_to_cpu(cbw.sig));
419 goto fail;
420 }
421 DPRINTF("Command on LUN %d\n", cbw.lun);
34707333
GH
422 scsi_dev = scsi_device_find(&s->bus, 0, 0, cbw.lun);
423 if (scsi_dev == NULL) {
2e5d83bb
PB
424 fprintf(stderr, "usb-msd: Bad LUN %d\n", cbw.lun);
425 goto fail;
426 }
7b863f41 427 tag = le32_to_cpu(cbw.tag);
2e5d83bb
PB
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;
433 } else {
434 s->mode = USB_MSDM_DATAOUT;
435 }
436 DPRINTF("Command tag 0x%x flags %08x len %d data %d\n",
7b863f41 437 tag, cbw.flags, cbw.cmd_len, s->data_len);
0659879e 438 assert(le32_to_cpu(s->csw.residue) == 0);
ef0bdf77 439 s->scsi_len = 0;
34707333 440 s->req = scsi_req_new(scsi_dev, tag, cbw.lun, cbw.cmd, NULL);
06f9847d
GH
441#ifdef DEBUG_MSD
442 scsi_req_print(s->req);
443#endif
c39ce112 444 scsi_req_enqueue(s->req);
f4c0e501 445 if (s->req && s->req->cmd.xfer != SCSI_XFER_NONE) {
ad3376cc 446 scsi_req_continue(s->req);
a917d384 447 }
2e5d83bb
PB
448 break;
449
450 case USB_MSDM_DATAOUT:
29c74f76
GH
451 DPRINTF("Data out %zd/%d\n", p->iov.size, s->data_len);
452 if (p->iov.size > s->data_len) {
2e5d83bb 453 goto fail;
29c74f76 454 }
2e5d83bb 455
a917d384 456 if (s->scsi_len) {
29c74f76 457 usb_msd_copy_data(s, p);
a917d384 458 }
0659879e 459 if (le32_to_cpu(s->csw.residue)) {
9a77a0f5 460 int len = p->iov.size - p->actual_length;
29c74f76
GH
461 if (len) {
462 usb_packet_skip(p, len);
463 s->data_len -= len;
464 if (s->data_len == 0) {
465 s->mode = USB_MSDM_CSW;
466 }
467 }
a917d384 468 }
9a77a0f5 469 if (p->actual_length < p->iov.size) {
06f9847d 470 DPRINTF("Deferring packet %p [wait data-out]\n", p);
4d611c9a 471 s->packet = p;
9a77a0f5 472 p->status = USB_RET_ASYNC;
4d611c9a 473 }
2e5d83bb
PB
474 break;
475
476 default:
29c74f76 477 DPRINTF("Unexpected write (len %zd)\n", p->iov.size);
2e5d83bb
PB
478 goto fail;
479 }
480 break;
481
482 case USB_TOKEN_IN:
483 if (devep != 1)
484 goto fail;
485
486 switch (s->mode) {
a917d384 487 case USB_MSDM_DATAOUT:
29c74f76 488 if (s->data_len != 0 || p->iov.size < 13) {
a917d384 489 goto fail;
29c74f76 490 }
a917d384 491 /* Waiting for SCSI write to complete. */
a917d384 492 s->packet = p;
9a77a0f5 493 p->status = USB_RET_ASYNC;
a917d384
PB
494 break;
495
2e5d83bb 496 case USB_MSDM_CSW:
29c74f76 497 if (p->iov.size < 13) {
2e5d83bb 498 goto fail;
29c74f76 499 }
2e5d83bb 500
59310659
GH
501 if (s->req) {
502 /* still in flight */
06f9847d 503 DPRINTF("Deferring packet %p [wait status]\n", p);
59310659 504 s->packet = p;
9a77a0f5 505 p->status = USB_RET_ASYNC;
59310659
GH
506 } else {
507 usb_msd_send_status(s, p);
508 s->mode = USB_MSDM_CBW;
59310659 509 }
2e5d83bb
PB
510 break;
511
512 case USB_MSDM_DATAIN:
29c74f76
GH
513 DPRINTF("Data in %zd/%d, scsi_len %d\n",
514 p->iov.size, s->data_len, s->scsi_len);
a917d384 515 if (s->scsi_len) {
29c74f76 516 usb_msd_copy_data(s, p);
a917d384 517 }
0659879e 518 if (le32_to_cpu(s->csw.residue)) {
9a77a0f5 519 int len = p->iov.size - p->actual_length;
29c74f76
GH
520 if (len) {
521 usb_packet_skip(p, len);
522 s->data_len -= len;
523 if (s->data_len == 0) {
524 s->mode = USB_MSDM_CSW;
525 }
526 }
a917d384 527 }
9a77a0f5 528 if (p->actual_length < p->iov.size) {
06f9847d 529 DPRINTF("Deferring packet %p [wait data-in]\n", p);
4d611c9a 530 s->packet = p;
9a77a0f5 531 p->status = USB_RET_ASYNC;
4d611c9a 532 }
2e5d83bb
PB
533 break;
534
535 default:
29c74f76 536 DPRINTF("Unexpected read (len %zd)\n", p->iov.size);
2e5d83bb
PB
537 goto fail;
538 }
539 break;
540
541 default:
542 DPRINTF("Bad token\n");
543 fail:
9a77a0f5 544 p->status = USB_RET_STALL;
2e5d83bb
PB
545 break;
546 }
2e5d83bb
PB
547}
548
b3e461d3
GH
549static void usb_msd_password_cb(void *opaque, int err)
550{
551 MSDState *s = opaque;
552
553 if (!err)
fa19bf83
HG
554 err = usb_device_attach(&s->dev);
555
556 if (err)
56f9107e 557 qdev_unplug(&s->dev.qdev, NULL);
b3e461d3
GH
558}
559
5de88b1d
GH
560static void *usb_msd_load_request(QEMUFile *f, SCSIRequest *req)
561{
562 MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
563
564 /* nothing to load, just store req in our state struct */
565 assert(s->req == NULL);
566 scsi_req_ref(req);
567 s->req = req;
568 return NULL;
569}
570
34707333 571static const struct SCSIBusInfo usb_msd_scsi_info_storage = {
afd4030c 572 .tcq = false,
7e0380b9
PB
573 .max_target = 0,
574 .max_lun = 0,
afd4030c 575
c6df7102 576 .transfer_data = usb_msd_transfer_data,
94d3f98a 577 .complete = usb_msd_command_complete,
5de88b1d
GH
578 .cancel = usb_msd_request_cancelled,
579 .load_request = usb_msd_load_request,
cfdc1bb0
PB
580};
581
34707333
GH
582static const struct SCSIBusInfo usb_msd_scsi_info_bot = {
583 .tcq = false,
584 .max_target = 0,
585 .max_lun = 15,
586
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,
591};
592
593static int usb_msd_initfn_storage(USBDevice *dev)
806b6024
GH
594{
595 MSDState *s = DO_UPCAST(MSDState, dev, dev);
f8b6cc00 596 BlockDriverState *bs = s->conf.bs;
34707333 597 SCSIDevice *scsi_dev;
806b6024 598
f8b6cc00 599 if (!bs) {
6a84cb1f 600 error_report("drive property not set");
7fc2f2c0
GH
601 return -1;
602 }
603
911525db
MA
604 blkconf_serial(&s->conf, &s->serial);
605
14bafc54
MA
606 /*
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
18846dee
MA
609 * creates automatically. But first it needs to detach from its
610 * blockdev, or else scsi_bus_legacy_add_drive() dies when it
611 * attaches again.
14bafc54
MA
612 *
613 * The hack is probably a bad idea.
614 */
fa879d62 615 bdrv_detach_dev(bs, &s->dev.qdev);
f8b6cc00 616 s->conf.bs = NULL;
14bafc54 617
c3a90cb1
MA
618 if (s->serial) {
619 usb_desc_set_string(dev, STR_SERIALNUMBER, s->serial);
9d55d1ad
GH
620 } else {
621 usb_desc_create_serial(dev);
4a1e1bc4
GH
622 }
623
a980a065 624 usb_desc_init(dev);
34707333
GH
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,
ce4e7e46 627 s->conf.bootindex);
34707333 628 if (!scsi_dev) {
fa66b909
MA
629 return -1;
630 }
cb23117b 631 s->bus.qbus.allow_hotplug = 0;
7fc2f2c0 632 usb_msd_handle_reset(dev);
b3e461d3 633
f8b6cc00 634 if (bdrv_key_required(bs)) {
a4426488 635 if (cur_mon) {
f8b6cc00 636 monitor_read_bdrv_key_start(cur_mon, bs, usb_msd_password_cb, s);
b3e461d3
GH
637 s->dev.auto_attach = 0;
638 } else {
639 autostart = 0;
640 }
641 }
642
806b6024
GH
643 return 0;
644}
645
34707333
GH
646static int usb_msd_initfn_bot(USBDevice *dev)
647{
648 MSDState *s = DO_UPCAST(MSDState, dev, dev);
649
650 usb_desc_create_serial(dev);
651 usb_desc_init(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);
655
656 return 0;
657}
658
3741715c 659static USBDevice *usb_msd_init(USBBus *bus, const char *filename)
2e5d83bb 660{
7fc2f2c0
GH
661 static int nr=0;
662 char id[8];
663 QemuOpts *opts;
664 DriveInfo *dinfo;
806b6024 665 USBDevice *dev;
334c0241
AJ
666 const char *p1;
667 char fmt[32];
668
7fc2f2c0
GH
669 /* parse -usbdevice disk: syntax into drive opts */
670 snprintf(id, sizeof(id), "usb%d", nr++);
8be7e7e4 671 opts = qemu_opts_create(qemu_find_opts("drive"), id, 0, NULL);
7fc2f2c0 672
334c0241
AJ
673 p1 = strchr(filename, ':');
674 if (p1++) {
675 const char *p2;
676
677 if (strstart(filename, "format=", &p2)) {
678 int len = MIN(p1 - p2, sizeof(fmt));
679 pstrcpy(fmt, len, p2);
7fc2f2c0 680 qemu_opt_set(opts, "format", fmt);
334c0241
AJ
681 } else if (*filename != ':') {
682 printf("unrecognized USB mass-storage option %s\n", filename);
683 return NULL;
684 }
334c0241
AJ
685 filename = p1;
686 }
334c0241
AJ
687 if (!*filename) {
688 printf("block device specification needed\n");
689 return NULL;
690 }
7fc2f2c0
GH
691 qemu_opt_set(opts, "file", filename);
692 qemu_opt_set(opts, "if", "none");
2e5d83bb 693
7fc2f2c0 694 /* create host drive */
319ae529 695 dinfo = drive_init(opts, 0);
7fc2f2c0
GH
696 if (!dinfo) {
697 qemu_opts_del(opts);
806b6024 698 return NULL;
7fc2f2c0 699 }
2e5d83bb 700
7fc2f2c0 701 /* create guest device */
3741715c 702 dev = usb_create(bus, "usb-storage");
d44168ff
PB
703 if (!dev) {
704 return NULL;
705 }
18846dee
MA
706 if (qdev_prop_set_drive(&dev->qdev, "drive", dinfo->bdrv) < 0) {
707 qdev_free(&dev->qdev);
708 return NULL;
709 }
33e66b86
MA
710 if (qdev_init(&dev->qdev) < 0)
711 return NULL;
1f6e24e7 712
7fc2f2c0 713 return dev;
2e5d83bb 714}
bb5fc20f 715
f54b6563
GH
716static const VMStateDescription vmstate_usb_msd = {
717 .name = "usb-storage",
f54b6563
GH
718 .version_id = 1,
719 .minimum_version_id = 1,
720 .fields = (VMStateField []) {
721 VMSTATE_USB_DEVICE(dev, MSDState),
5de88b1d
GH
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),
f54b6563
GH
730 VMSTATE_END_OF_LIST()
731 }
732};
733
39bffca2
AL
734static 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(),
739};
740
34707333 741static void usb_msd_class_initfn_common(ObjectClass *klass)
62aed765 742{
39bffca2 743 DeviceClass *dc = DEVICE_CLASS(klass);
62aed765
AL
744 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
745
62aed765
AL
746 uc->product_desc = "QEMU USB MSD";
747 uc->usb_desc = &desc;
62aed765
AL
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;
39bffca2
AL
753 dc->fw_name = "storage";
754 dc->vmsd = &vmstate_usb_msd;
34707333
GH
755}
756
757static void usb_msd_class_initfn_storage(ObjectClass *klass, void *data)
758{
759 DeviceClass *dc = DEVICE_CLASS(klass);
760 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
761
762 uc->init = usb_msd_initfn_storage;
39bffca2 763 dc->props = msd_properties;
34707333
GH
764 usb_msd_class_initfn_common(klass);
765}
766
767static void usb_msd_class_initfn_bot(ObjectClass *klass, void *data)
768{
769 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
770
771 uc->init = usb_msd_initfn_bot;
772 usb_msd_class_initfn_common(klass);
62aed765
AL
773}
774
8c43a6f0 775static const TypeInfo msd_info = {
39bffca2
AL
776 .name = "usb-storage",
777 .parent = TYPE_USB_DEVICE,
778 .instance_size = sizeof(MSDState),
34707333
GH
779 .class_init = usb_msd_class_initfn_storage,
780};
781
782static const TypeInfo bot_info = {
783 .name = "usb-bot",
784 .parent = TYPE_USB_DEVICE,
785 .instance_size = sizeof(MSDState),
786 .class_init = usb_msd_class_initfn_bot,
806b6024
GH
787};
788
83f7d43a 789static void usb_msd_register_types(void)
806b6024 790{
39bffca2 791 type_register_static(&msd_info);
34707333 792 type_register_static(&bot_info);
ba02430f 793 usb_legacy_register("usb-storage", "disk", usb_msd_init);
806b6024 794}
83f7d43a
AF
795
796type_init(usb_msd_register_types)