]> git.proxmox.com Git - mirror_qemu.git/blame - hw/usb/dev-storage.c
virtio-blk: alias bootindex property explicitly for virt-blk-pci/ccw/s390
[mirror_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"
0d09e41a 15#include "hw/scsi/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;
6bb7b867 61 uint32_t removable;
2e5d83bb
PB
62} MSDState;
63
a917d384
PB
64struct usb_msd_cbw {
65 uint32_t sig;
66 uint32_t tag;
67 uint32_t data_len;
68 uint8_t flags;
69 uint8_t lun;
70 uint8_t cmd_len;
71 uint8_t cmd[16];
72};
73
81bfd2f2
GH
74enum {
75 STR_MANUFACTURER = 1,
76 STR_PRODUCT,
77 STR_SERIALNUMBER,
ca0c730d
GH
78 STR_CONFIG_FULL,
79 STR_CONFIG_HIGH,
79b40459 80 STR_CONFIG_SUPER,
2e5d83bb
PB
81};
82
81bfd2f2 83static const USBDescStrings desc_strings = {
93bfef4c 84 [STR_MANUFACTURER] = "QEMU",
81bfd2f2
GH
85 [STR_PRODUCT] = "QEMU USB HARDDRIVE",
86 [STR_SERIALNUMBER] = "1",
ca0c730d
GH
87 [STR_CONFIG_FULL] = "Full speed config (usb 1.1)",
88 [STR_CONFIG_HIGH] = "High speed config (usb 2.0)",
79b40459 89 [STR_CONFIG_SUPER] = "Super speed config (usb 3.0)",
81bfd2f2
GH
90};
91
ca0c730d 92static const USBDescIface desc_iface_full = {
81bfd2f2
GH
93 .bInterfaceNumber = 0,
94 .bNumEndpoints = 2,
95 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
96 .bInterfaceSubClass = 0x06, /* SCSI */
97 .bInterfaceProtocol = 0x50, /* Bulk */
98 .eps = (USBDescEndpoint[]) {
99 {
100 .bEndpointAddress = USB_DIR_IN | 0x01,
101 .bmAttributes = USB_ENDPOINT_XFER_BULK,
102 .wMaxPacketSize = 64,
103 },{
104 .bEndpointAddress = USB_DIR_OUT | 0x02,
105 .bmAttributes = USB_ENDPOINT_XFER_BULK,
106 .wMaxPacketSize = 64,
107 },
108 }
109};
110
ca0c730d
GH
111static const USBDescDevice desc_device_full = {
112 .bcdUSB = 0x0200,
81bfd2f2
GH
113 .bMaxPacketSize0 = 8,
114 .bNumConfigurations = 1,
115 .confs = (USBDescConfig[]) {
116 {
117 .bNumInterfaces = 1,
118 .bConfigurationValue = 1,
ca0c730d 119 .iConfiguration = STR_CONFIG_FULL,
bd93976a 120 .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER,
add75088 121 .nif = 1,
ca0c730d
GH
122 .ifs = &desc_iface_full,
123 },
124 },
125};
126
127static const USBDescIface desc_iface_high = {
128 .bInterfaceNumber = 0,
129 .bNumEndpoints = 2,
130 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
131 .bInterfaceSubClass = 0x06, /* SCSI */
132 .bInterfaceProtocol = 0x50, /* Bulk */
133 .eps = (USBDescEndpoint[]) {
134 {
135 .bEndpointAddress = USB_DIR_IN | 0x01,
136 .bmAttributes = USB_ENDPOINT_XFER_BULK,
137 .wMaxPacketSize = 512,
138 },{
139 .bEndpointAddress = USB_DIR_OUT | 0x02,
140 .bmAttributes = USB_ENDPOINT_XFER_BULK,
141 .wMaxPacketSize = 512,
142 },
143 }
144};
145
146static const USBDescDevice desc_device_high = {
147 .bcdUSB = 0x0200,
148 .bMaxPacketSize0 = 64,
149 .bNumConfigurations = 1,
150 .confs = (USBDescConfig[]) {
151 {
152 .bNumInterfaces = 1,
153 .bConfigurationValue = 1,
154 .iConfiguration = STR_CONFIG_HIGH,
bd93976a 155 .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER,
add75088 156 .nif = 1,
ca0c730d 157 .ifs = &desc_iface_high,
81bfd2f2
GH
158 },
159 },
160};
161
79b40459
GH
162static const USBDescIface desc_iface_super = {
163 .bInterfaceNumber = 0,
164 .bNumEndpoints = 2,
165 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
166 .bInterfaceSubClass = 0x06, /* SCSI */
167 .bInterfaceProtocol = 0x50, /* Bulk */
168 .eps = (USBDescEndpoint[]) {
169 {
170 .bEndpointAddress = USB_DIR_IN | 0x01,
171 .bmAttributes = USB_ENDPOINT_XFER_BULK,
172 .wMaxPacketSize = 1024,
173 .bMaxBurst = 15,
174 },{
175 .bEndpointAddress = USB_DIR_OUT | 0x02,
176 .bmAttributes = USB_ENDPOINT_XFER_BULK,
177 .wMaxPacketSize = 1024,
178 .bMaxBurst = 15,
179 },
180 }
181};
182
183static const USBDescDevice desc_device_super = {
184 .bcdUSB = 0x0300,
185 .bMaxPacketSize0 = 9,
186 .bNumConfigurations = 1,
187 .confs = (USBDescConfig[]) {
188 {
189 .bNumInterfaces = 1,
190 .bConfigurationValue = 1,
191 .iConfiguration = STR_CONFIG_SUPER,
bd93976a 192 .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER,
79b40459
GH
193 .nif = 1,
194 .ifs = &desc_iface_super,
195 },
196 },
197};
198
81bfd2f2
GH
199static const USBDesc desc = {
200 .id = {
db80358a
RT
201 .idVendor = 0x46f4, /* CRC16() of "QEMU" */
202 .idProduct = 0x0001,
81bfd2f2
GH
203 .bcdDevice = 0,
204 .iManufacturer = STR_MANUFACTURER,
205 .iProduct = STR_PRODUCT,
206 .iSerialNumber = STR_SERIALNUMBER,
207 },
79b40459
GH
208 .full = &desc_device_full,
209 .high = &desc_device_high,
210 .super = &desc_device_super,
211 .str = desc_strings,
2e5d83bb
PB
212};
213
29c74f76 214static void usb_msd_copy_data(MSDState *s, USBPacket *p)
a917d384
PB
215{
216 uint32_t len;
9a77a0f5 217 len = p->iov.size - p->actual_length;
a917d384
PB
218 if (len > s->scsi_len)
219 len = s->scsi_len;
1dc90367 220 usb_packet_copy(p, scsi_req_get_buf(s->req) + s->scsi_off, len);
a917d384 221 s->scsi_len -= len;
1dc90367 222 s->scsi_off += len;
a917d384 223 s->data_len -= len;
fa7935c1 224 if (s->scsi_len == 0 || s->data_len == 0) {
ad3376cc 225 scsi_req_continue(s->req);
a917d384
PB
226 }
227}
228
ab4797ad 229static void usb_msd_send_status(MSDState *s, USBPacket *p)
a917d384 230{
ab4797ad 231 int len;
a917d384 232
e04da7c3 233 DPRINTF("Command status %d tag 0x%x, len %zd\n",
e2854bf3 234 s->csw.status, le32_to_cpu(s->csw.tag), p->iov.size);
92a114f6 235
e2854bf3 236 assert(s->csw.sig == cpu_to_le32(0x53425355));
92a114f6
GH
237 len = MIN(sizeof(s->csw), p->iov.size);
238 usb_packet_copy(p, &s->csw, len);
239 memset(&s->csw, 0, sizeof(s->csw));
a917d384
PB
240}
241
1e6ed80b
GH
242static void usb_msd_packet_complete(MSDState *s)
243{
244 USBPacket *p = s->packet;
245
246 /* Set s->packet to NULL before calling usb_packet_complete
247 because another request may be issued before
248 usb_packet_complete returns. */
249 DPRINTF("Packet complete %p\n", p);
250 s->packet = NULL;
251 usb_packet_complete(&s->dev, p);
252}
253
aba1f023 254static void usb_msd_transfer_data(SCSIRequest *req, uint32_t len)
2e5d83bb 255{
5c6c0e51 256 MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
a917d384 257 USBPacket *p = s->packet;
4d611c9a 258
ad3376cc 259 assert((s->mode == USB_MSDM_DATAOUT) == (req->cmd.mode == SCSI_XFER_TO_DEV));
aba1f023 260 s->scsi_len = len;
1dc90367 261 s->scsi_off = 0;
a917d384 262 if (p) {
29c74f76
GH
263 usb_msd_copy_data(s, p);
264 p = s->packet;
9a77a0f5
HG
265 if (p && p->actual_length == p->iov.size) {
266 p->status = USB_RET_SUCCESS; /* Clear previous ASYNC status */
1e6ed80b 267 usb_msd_packet_complete(s);
a917d384 268 }
4d611c9a 269 }
2e5d83bb
PB
270}
271
01e95455 272static void usb_msd_command_complete(SCSIRequest *req, uint32_t status, size_t resid)
c6df7102
PB
273{
274 MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
275 USBPacket *p = s->packet;
276
7b863f41 277 DPRINTF("Command complete %d tag 0x%x\n", status, req->tag);
92a114f6
GH
278
279 s->csw.sig = cpu_to_le32(0x53425355);
7b863f41 280 s->csw.tag = cpu_to_le32(req->tag);
0659879e 281 s->csw.residue = cpu_to_le32(s->data_len);
414c4604 282 s->csw.status = status != 0;
92a114f6 283
c6df7102
PB
284 if (s->packet) {
285 if (s->data_len == 0 && s->mode == USB_MSDM_DATAOUT) {
286 /* A deferred packet with no write data remaining must be
287 the status read packet. */
288 usb_msd_send_status(s, p);
289 s->mode = USB_MSDM_CBW;
54414218
GH
290 } else if (s->mode == USB_MSDM_CSW) {
291 usb_msd_send_status(s, p);
292 s->mode = USB_MSDM_CBW;
c6df7102
PB
293 } else {
294 if (s->data_len) {
9a77a0f5 295 int len = (p->iov.size - p->actual_length);
29c74f76
GH
296 usb_packet_skip(p, len);
297 s->data_len -= len;
c6df7102
PB
298 }
299 if (s->data_len == 0) {
300 s->mode = USB_MSDM_CSW;
301 }
302 }
9a77a0f5 303 p->status = USB_RET_SUCCESS; /* Clear previous ASYNC status */
1e6ed80b 304 usb_msd_packet_complete(s);
c6df7102
PB
305 } else if (s->data_len == 0) {
306 s->mode = USB_MSDM_CSW;
307 }
308 scsi_req_unref(req);
309 s->req = NULL;
310}
311
94d3f98a
PB
312static void usb_msd_request_cancelled(SCSIRequest *req)
313{
314 MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
315
316 if (req == s->req) {
317 scsi_req_unref(s->req);
318 s->req = NULL;
94d3f98a
PB
319 s->scsi_len = 0;
320 }
321}
322
059809e4 323static void usb_msd_handle_reset(USBDevice *dev)
2e5d83bb
PB
324{
325 MSDState *s = (MSDState *)dev;
326
327 DPRINTF("Reset\n");
24a5bbe1
GH
328 if (s->req) {
329 scsi_req_cancel(s->req);
330 }
331 assert(s->req == NULL);
332
333 if (s->packet) {
9a77a0f5 334 s->packet->status = USB_RET_STALL;
1e6ed80b 335 usb_msd_packet_complete(s);
24a5bbe1
GH
336 }
337
2e5d83bb 338 s->mode = USB_MSDM_CBW;
2e5d83bb
PB
339}
340
9a77a0f5 341static void usb_msd_handle_control(USBDevice *dev, USBPacket *p,
007fd62f 342 int request, int value, int index, int length, uint8_t *data)
2e5d83bb
PB
343{
344 MSDState *s = (MSDState *)dev;
34707333
GH
345 SCSIDevice *scsi_dev;
346 int ret, maxlun;
2e5d83bb 347
007fd62f 348 ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
81bfd2f2 349 if (ret >= 0) {
9a77a0f5 350 return;
81bfd2f2
GH
351 }
352
2e5d83bb 353 switch (request) {
2e5d83bb 354 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
e5322f76 355 break;
2e5d83bb 356 /* Class specific requests. */
f3571b1a 357 case ClassInterfaceOutRequest | MassStorageReset:
2e5d83bb
PB
358 /* Reset state ready for the next CBW. */
359 s->mode = USB_MSDM_CBW;
2e5d83bb 360 break;
f3571b1a 361 case ClassInterfaceRequest | GetMaxLun:
34707333
GH
362 maxlun = 0;
363 for (;;) {
364 scsi_dev = scsi_device_find(&s->bus, 0, 0, maxlun+1);
365 if (scsi_dev == NULL) {
366 break;
367 }
368 if (scsi_dev->lun != maxlun+1) {
369 break;
370 }
371 maxlun++;
372 }
373 DPRINTF("MaxLun %d\n", maxlun);
374 data[0] = maxlun;
9a77a0f5 375 p->actual_length = 1;
2e5d83bb
PB
376 break;
377 default:
9a77a0f5 378 p->status = USB_RET_STALL;
2e5d83bb
PB
379 break;
380 }
2e5d83bb
PB
381}
382
eb5e680a 383static void usb_msd_cancel_io(USBDevice *dev, USBPacket *p)
4d611c9a 384{
eb5e680a 385 MSDState *s = DO_UPCAST(MSDState, dev, dev);
d3ac1a87 386
6d7aeeeb
GH
387 assert(s->packet == p);
388 s->packet = NULL;
389
d3ac1a87
GH
390 if (s->req) {
391 scsi_req_cancel(s->req);
392 }
4d611c9a
PB
393}
394
9a77a0f5 395static void usb_msd_handle_data(USBDevice *dev, USBPacket *p)
2e5d83bb
PB
396{
397 MSDState *s = (MSDState *)dev;
7b863f41 398 uint32_t tag;
2e5d83bb 399 struct usb_msd_cbw cbw;
079d0b7f 400 uint8_t devep = p->ep->nr;
34707333 401 SCSIDevice *scsi_dev;
9db7c414 402 uint32_t len;
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) {
f5dc5978 412 error_report("usb-msd: Bad CBW size");
2e5d83bb
PB
413 goto fail;
414 }
29c74f76 415 usb_packet_copy(p, &cbw, 31);
2e5d83bb 416 if (le32_to_cpu(cbw.sig) != 0x43425355) {
f5dc5978
GA
417 error_report("usb-msd: Bad signature %08x",
418 le32_to_cpu(cbw.sig));
2e5d83bb
PB
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) {
f5dc5978 424 error_report("usb-msd: Bad LUN %d", cbw.lun);
2e5d83bb
PB
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
9db7c414
GH
444 len = scsi_req_enqueue(s->req);
445 if (len) {
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;
7d553f27 552 Error *local_err = NULL;
b3e461d3 553
7d553f27
GA
554 if (!err) {
555 usb_device_attach(&s->dev, &local_err);
556 }
fa19bf83 557
7d553f27
GA
558 if (local_err) {
559 qerror_report_err(local_err);
560 error_free(local_err);
56f9107e 561 qdev_unplug(&s->dev.qdev, NULL);
7d553f27 562 }
b3e461d3
GH
563}
564
5de88b1d
GH
565static void *usb_msd_load_request(QEMUFile *f, SCSIRequest *req)
566{
567 MSDState *s = DO_UPCAST(MSDState, dev.qdev, req->bus->qbus.parent);
568
569 /* nothing to load, just store req in our state struct */
570 assert(s->req == NULL);
571 scsi_req_ref(req);
572 s->req = req;
573 return NULL;
574}
575
34707333 576static const struct SCSIBusInfo usb_msd_scsi_info_storage = {
afd4030c 577 .tcq = false,
7e0380b9
PB
578 .max_target = 0,
579 .max_lun = 0,
afd4030c 580
c6df7102 581 .transfer_data = usb_msd_transfer_data,
94d3f98a 582 .complete = usb_msd_command_complete,
5de88b1d
GH
583 .cancel = usb_msd_request_cancelled,
584 .load_request = usb_msd_load_request,
cfdc1bb0
PB
585};
586
34707333
GH
587static const struct SCSIBusInfo usb_msd_scsi_info_bot = {
588 .tcq = false,
589 .max_target = 0,
590 .max_lun = 15,
591
592 .transfer_data = usb_msd_transfer_data,
593 .complete = usb_msd_command_complete,
594 .cancel = usb_msd_request_cancelled,
595 .load_request = usb_msd_load_request,
596};
597
5a882e40 598static void usb_msd_realize_storage(USBDevice *dev, Error **errp)
806b6024
GH
599{
600 MSDState *s = DO_UPCAST(MSDState, dev, dev);
f8b6cc00 601 BlockDriverState *bs = s->conf.bs;
34707333 602 SCSIDevice *scsi_dev;
caad4eb3 603 Error *err = NULL;
806b6024 604
f8b6cc00 605 if (!bs) {
5a882e40
GA
606 error_setg(errp, "drive property not set");
607 return;
7fc2f2c0
GH
608 }
609
71938a09 610 blkconf_serial(&s->conf, &dev->serial);
911525db 611
14bafc54
MA
612 /*
613 * Hack alert: this pretends to be a block device, but it's really
614 * a SCSI bus that can serve only a single device, which it
18846dee
MA
615 * creates automatically. But first it needs to detach from its
616 * blockdev, or else scsi_bus_legacy_add_drive() dies when it
617 * attaches again.
14bafc54
MA
618 *
619 * The hack is probably a bad idea.
620 */
fa879d62 621 bdrv_detach_dev(bs, &s->dev.qdev);
f8b6cc00 622 s->conf.bs = NULL;
14bafc54 623
71938a09 624 usb_desc_create_serial(dev);
a980a065 625 usb_desc_init(dev);
b1187b51
AF
626 scsi_bus_new(&s->bus, sizeof(s->bus), DEVICE(dev),
627 &usb_msd_scsi_info_storage, NULL);
34707333 628 scsi_dev = scsi_bus_legacy_add_drive(&s->bus, bs, 0, !!s->removable,
caad4eb3
AF
629 s->conf.bootindex, dev->serial,
630 &err);
34707333 631 if (!scsi_dev) {
5a882e40
GA
632 error_propagate(errp, err);
633 return;
fa66b909 634 }
cb23117b 635 s->bus.qbus.allow_hotplug = 0;
7fc2f2c0 636 usb_msd_handle_reset(dev);
b3e461d3 637
f8b6cc00 638 if (bdrv_key_required(bs)) {
a4426488 639 if (cur_mon) {
f8b6cc00 640 monitor_read_bdrv_key_start(cur_mon, bs, usb_msd_password_cb, s);
b3e461d3
GH
641 s->dev.auto_attach = 0;
642 } else {
643 autostart = 0;
644 }
645 }
806b6024
GH
646}
647
5a882e40 648static void usb_msd_realize_bot(USBDevice *dev, Error **errp)
34707333
GH
649{
650 MSDState *s = DO_UPCAST(MSDState, dev, dev);
651
652 usb_desc_create_serial(dev);
653 usb_desc_init(dev);
b1187b51
AF
654 scsi_bus_new(&s->bus, sizeof(s->bus), DEVICE(dev),
655 &usb_msd_scsi_info_bot, NULL);
34707333
GH
656 s->bus.qbus.allow_hotplug = 0;
657 usb_msd_handle_reset(dev);
34707333
GH
658}
659
3741715c 660static USBDevice *usb_msd_init(USBBus *bus, const char *filename)
2e5d83bb 661{
7fc2f2c0
GH
662 static int nr=0;
663 char id[8];
664 QemuOpts *opts;
665 DriveInfo *dinfo;
806b6024 666 USBDevice *dev;
334c0241
AJ
667 const char *p1;
668 char fmt[32];
669
7fc2f2c0 670 /* parse -usbdevice disk: syntax into drive opts */
31376776
MA
671 do {
672 snprintf(id, sizeof(id), "usb%d", nr++);
673 opts = qemu_opts_create(qemu_find_opts("drive"), id, 1, NULL);
674 } while (!opts);
7fc2f2c0 675
334c0241
AJ
676 p1 = strchr(filename, ':');
677 if (p1++) {
678 const char *p2;
679
680 if (strstart(filename, "format=", &p2)) {
681 int len = MIN(p1 - p2, sizeof(fmt));
682 pstrcpy(fmt, len, p2);
7fc2f2c0 683 qemu_opt_set(opts, "format", fmt);
334c0241 684 } else if (*filename != ':') {
f5dc5978 685 error_report("unrecognized USB mass-storage option %s", filename);
334c0241
AJ
686 return NULL;
687 }
334c0241
AJ
688 filename = p1;
689 }
334c0241 690 if (!*filename) {
f5dc5978 691 error_report("block device specification needed");
334c0241
AJ
692 return NULL;
693 }
7fc2f2c0
GH
694 qemu_opt_set(opts, "file", filename);
695 qemu_opt_set(opts, "if", "none");
2e5d83bb 696
7fc2f2c0 697 /* create host drive */
60e19e06 698 dinfo = drive_new(opts, 0);
7fc2f2c0
GH
699 if (!dinfo) {
700 qemu_opts_del(opts);
806b6024 701 return NULL;
7fc2f2c0 702 }
2e5d83bb 703
7fc2f2c0 704 /* create guest device */
3741715c 705 dev = usb_create(bus, "usb-storage");
d44168ff
PB
706 if (!dev) {
707 return NULL;
708 }
18846dee 709 if (qdev_prop_set_drive(&dev->qdev, "drive", dinfo->bdrv) < 0) {
02a5c4c9 710 object_unparent(OBJECT(dev));
18846dee
MA
711 return NULL;
712 }
33e66b86
MA
713 if (qdev_init(&dev->qdev) < 0)
714 return NULL;
1f6e24e7 715
7fc2f2c0 716 return dev;
2e5d83bb 717}
bb5fc20f 718
f54b6563
GH
719static const VMStateDescription vmstate_usb_msd = {
720 .name = "usb-storage",
f54b6563
GH
721 .version_id = 1,
722 .minimum_version_id = 1,
6e3d652a 723 .fields = (VMStateField[]) {
f54b6563 724 VMSTATE_USB_DEVICE(dev, MSDState),
5de88b1d
GH
725 VMSTATE_UINT32(mode, MSDState),
726 VMSTATE_UINT32(scsi_len, MSDState),
727 VMSTATE_UINT32(scsi_off, MSDState),
728 VMSTATE_UINT32(data_len, MSDState),
729 VMSTATE_UINT32(csw.sig, MSDState),
730 VMSTATE_UINT32(csw.tag, MSDState),
731 VMSTATE_UINT32(csw.residue, MSDState),
732 VMSTATE_UINT8(csw.status, MSDState),
f54b6563
GH
733 VMSTATE_END_OF_LIST()
734 }
735};
736
39bffca2
AL
737static Property msd_properties[] = {
738 DEFINE_BLOCK_PROPERTIES(MSDState, conf),
39bffca2
AL
739 DEFINE_PROP_BIT("removable", MSDState, removable, 0, false),
740 DEFINE_PROP_END_OF_LIST(),
741};
742
34707333 743static void usb_msd_class_initfn_common(ObjectClass *klass)
62aed765 744{
39bffca2 745 DeviceClass *dc = DEVICE_CLASS(klass);
62aed765
AL
746 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
747
62aed765
AL
748 uc->product_desc = "QEMU USB MSD";
749 uc->usb_desc = &desc;
62aed765
AL
750 uc->cancel_packet = usb_msd_cancel_io;
751 uc->handle_attach = usb_desc_attach;
752 uc->handle_reset = usb_msd_handle_reset;
753 uc->handle_control = usb_msd_handle_control;
754 uc->handle_data = usb_msd_handle_data;
125ee0ed 755 set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
39bffca2
AL
756 dc->fw_name = "storage";
757 dc->vmsd = &vmstate_usb_msd;
34707333
GH
758}
759
760static void usb_msd_class_initfn_storage(ObjectClass *klass, void *data)
761{
762 DeviceClass *dc = DEVICE_CLASS(klass);
763 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
764
5a882e40 765 uc->realize = usb_msd_realize_storage;
39bffca2 766 dc->props = msd_properties;
34707333
GH
767 usb_msd_class_initfn_common(klass);
768}
769
770static void usb_msd_class_initfn_bot(ObjectClass *klass, void *data)
771{
772 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
773
5a882e40 774 uc->realize = usb_msd_realize_bot;
34707333 775 usb_msd_class_initfn_common(klass);
62aed765
AL
776}
777
8c43a6f0 778static const TypeInfo msd_info = {
39bffca2
AL
779 .name = "usb-storage",
780 .parent = TYPE_USB_DEVICE,
781 .instance_size = sizeof(MSDState),
34707333
GH
782 .class_init = usb_msd_class_initfn_storage,
783};
784
785static const TypeInfo bot_info = {
786 .name = "usb-bot",
787 .parent = TYPE_USB_DEVICE,
788 .instance_size = sizeof(MSDState),
789 .class_init = usb_msd_class_initfn_bot,
806b6024
GH
790};
791
83f7d43a 792static void usb_msd_register_types(void)
806b6024 793{
39bffca2 794 type_register_static(&msd_info);
34707333 795 type_register_static(&bot_info);
ba02430f 796 usb_legacy_register("usb-storage", "disk", usb_msd_init);
806b6024 797}
83f7d43a
AF
798
799type_init(usb_msd_register_types)