x86: avoid AREG0 for SMM helpers
[qemu/opensuse.git] / hw / scsi-disk.c
blob409f760ef78eacd392a190ef227b804f1c639b40
1 /*
2 * SCSI Device emulation
4 * Copyright (c) 2006 CodeSourcery.
5 * Based on code by Fabrice Bellard
7 * Written by Paul Brook
8 * Modifications:
9 * 2009-Dec-12 Artyom Tarasenko : implemented stamdard inquiry for the case
10 * when the allocation length of CDB is smaller
11 * than 36.
12 * 2009-Oct-13 Artyom Tarasenko : implemented the block descriptor in the
13 * MODE SENSE response.
15 * This code is licensed under the LGPL.
17 * Note that this file only handles the SCSI architecture model and device
18 * commands. Emulation of interface/link layer protocols is handled by
19 * the host adapter emulator.
22 //#define DEBUG_SCSI
24 #ifdef DEBUG_SCSI
25 #define DPRINTF(fmt, ...) \
26 do { printf("scsi-disk: " fmt , ## __VA_ARGS__); } while (0)
27 #else
28 #define DPRINTF(fmt, ...) do {} while(0)
29 #endif
31 #include "qemu-common.h"
32 #include "qemu-error.h"
33 #include "scsi.h"
34 #include "scsi-defs.h"
35 #include "sysemu.h"
36 #include "blockdev.h"
37 #include "hw/block-common.h"
38 #include "dma.h"
40 #ifdef __linux
41 #include <scsi/sg.h>
42 #endif
44 #define SCSI_DMA_BUF_SIZE 131072
45 #define SCSI_MAX_INQUIRY_LEN 256
46 #define SCSI_MAX_MODE_LEN 256
48 typedef struct SCSIDiskState SCSIDiskState;
50 typedef struct SCSIDiskReq {
51 SCSIRequest req;
52 /* Both sector and sector_count are in terms of qemu 512 byte blocks. */
53 uint64_t sector;
54 uint32_t sector_count;
55 uint32_t buflen;
56 bool started;
57 struct iovec iov;
58 QEMUIOVector qiov;
59 BlockAcctCookie acct;
60 } SCSIDiskReq;
62 #define SCSI_DISK_F_REMOVABLE 0
63 #define SCSI_DISK_F_DPOFUA 1
65 struct SCSIDiskState
67 SCSIDevice qdev;
68 uint32_t features;
69 bool media_changed;
70 bool media_event;
71 bool eject_request;
72 uint64_t wwn;
73 QEMUBH *bh;
74 char *version;
75 char *serial;
76 char *vendor;
77 char *product;
78 bool tray_open;
79 bool tray_locked;
82 static int scsi_handle_rw_error(SCSIDiskReq *r, int error);
84 static void scsi_free_request(SCSIRequest *req)
86 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
88 if (r->iov.iov_base) {
89 qemu_vfree(r->iov.iov_base);
93 /* Helper function for command completion with sense. */
94 static void scsi_check_condition(SCSIDiskReq *r, SCSISense sense)
96 DPRINTF("Command complete tag=0x%x sense=%d/%d/%d\n",
97 r->req.tag, sense.key, sense.asc, sense.ascq);
98 scsi_req_build_sense(&r->req, sense);
99 scsi_req_complete(&r->req, CHECK_CONDITION);
102 /* Cancel a pending data transfer. */
103 static void scsi_cancel_io(SCSIRequest *req)
105 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
107 DPRINTF("Cancel tag=0x%x\n", req->tag);
108 if (r->req.aiocb) {
109 bdrv_aio_cancel(r->req.aiocb);
111 /* This reference was left in by scsi_*_data. We take ownership of
112 * it the moment scsi_req_cancel is called, independent of whether
113 * bdrv_aio_cancel completes the request or not. */
114 scsi_req_unref(&r->req);
116 r->req.aiocb = NULL;
119 static uint32_t scsi_init_iovec(SCSIDiskReq *r, size_t size)
121 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
123 if (!r->iov.iov_base) {
124 r->buflen = size;
125 r->iov.iov_base = qemu_blockalign(s->qdev.conf.bs, r->buflen);
127 r->iov.iov_len = MIN(r->sector_count * 512, r->buflen);
128 qemu_iovec_init_external(&r->qiov, &r->iov, 1);
129 return r->qiov.size / 512;
132 static void scsi_disk_save_request(QEMUFile *f, SCSIRequest *req)
134 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
136 qemu_put_be64s(f, &r->sector);
137 qemu_put_be32s(f, &r->sector_count);
138 qemu_put_be32s(f, &r->buflen);
139 if (r->buflen) {
140 if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
141 qemu_put_buffer(f, r->iov.iov_base, r->iov.iov_len);
142 } else if (!req->retry) {
143 uint32_t len = r->iov.iov_len;
144 qemu_put_be32s(f, &len);
145 qemu_put_buffer(f, r->iov.iov_base, r->iov.iov_len);
150 static void scsi_disk_load_request(QEMUFile *f, SCSIRequest *req)
152 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
154 qemu_get_be64s(f, &r->sector);
155 qemu_get_be32s(f, &r->sector_count);
156 qemu_get_be32s(f, &r->buflen);
157 if (r->buflen) {
158 scsi_init_iovec(r, r->buflen);
159 if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
160 qemu_get_buffer(f, r->iov.iov_base, r->iov.iov_len);
161 } else if (!r->req.retry) {
162 uint32_t len;
163 qemu_get_be32s(f, &len);
164 r->iov.iov_len = len;
165 assert(r->iov.iov_len <= r->buflen);
166 qemu_get_buffer(f, r->iov.iov_base, r->iov.iov_len);
170 qemu_iovec_init_external(&r->qiov, &r->iov, 1);
173 static void scsi_aio_complete(void *opaque, int ret)
175 SCSIDiskReq *r = (SCSIDiskReq *)opaque;
176 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
178 assert(r->req.aiocb != NULL);
179 r->req.aiocb = NULL;
180 bdrv_acct_done(s->qdev.conf.bs, &r->acct);
182 if (ret < 0) {
183 if (scsi_handle_rw_error(r, -ret)) {
184 goto done;
188 scsi_req_complete(&r->req, GOOD);
190 done:
191 if (!r->req.io_canceled) {
192 scsi_req_unref(&r->req);
196 static bool scsi_is_cmd_fua(SCSICommand *cmd)
198 switch (cmd->buf[0]) {
199 case READ_10:
200 case READ_12:
201 case READ_16:
202 case WRITE_10:
203 case WRITE_12:
204 case WRITE_16:
205 return (cmd->buf[1] & 8) != 0;
207 case VERIFY_10:
208 case VERIFY_12:
209 case VERIFY_16:
210 case WRITE_VERIFY_10:
211 case WRITE_VERIFY_12:
212 case WRITE_VERIFY_16:
213 return true;
215 case READ_6:
216 case WRITE_6:
217 default:
218 return false;
222 static void scsi_write_do_fua(SCSIDiskReq *r)
224 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
226 if (scsi_is_cmd_fua(&r->req.cmd)) {
227 bdrv_acct_start(s->qdev.conf.bs, &r->acct, 0, BDRV_ACCT_FLUSH);
228 r->req.aiocb = bdrv_aio_flush(s->qdev.conf.bs, scsi_aio_complete, r);
229 return;
232 scsi_req_complete(&r->req, GOOD);
233 if (!r->req.io_canceled) {
234 scsi_req_unref(&r->req);
238 static void scsi_dma_complete(void *opaque, int ret)
240 SCSIDiskReq *r = (SCSIDiskReq *)opaque;
241 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
243 assert(r->req.aiocb != NULL);
244 r->req.aiocb = NULL;
245 bdrv_acct_done(s->qdev.conf.bs, &r->acct);
247 if (ret < 0) {
248 if (scsi_handle_rw_error(r, -ret)) {
249 goto done;
253 r->sector += r->sector_count;
254 r->sector_count = 0;
255 if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
256 scsi_write_do_fua(r);
257 return;
258 } else {
259 scsi_req_complete(&r->req, GOOD);
262 done:
263 if (!r->req.io_canceled) {
264 scsi_req_unref(&r->req);
268 static void scsi_read_complete(void * opaque, int ret)
270 SCSIDiskReq *r = (SCSIDiskReq *)opaque;
271 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
272 int n;
274 assert(r->req.aiocb != NULL);
275 r->req.aiocb = NULL;
276 bdrv_acct_done(s->qdev.conf.bs, &r->acct);
278 if (ret < 0) {
279 if (scsi_handle_rw_error(r, -ret)) {
280 goto done;
284 DPRINTF("Data ready tag=0x%x len=%zd\n", r->req.tag, r->qiov.size);
286 n = r->qiov.size / 512;
287 r->sector += n;
288 r->sector_count -= n;
289 scsi_req_data(&r->req, r->qiov.size);
291 done:
292 if (!r->req.io_canceled) {
293 scsi_req_unref(&r->req);
297 /* Actually issue a read to the block device. */
298 static void scsi_do_read(void *opaque, int ret)
300 SCSIDiskReq *r = opaque;
301 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
302 uint32_t n;
304 if (r->req.aiocb != NULL) {
305 r->req.aiocb = NULL;
306 bdrv_acct_done(s->qdev.conf.bs, &r->acct);
309 if (ret < 0) {
310 if (scsi_handle_rw_error(r, -ret)) {
311 goto done;
315 if (r->req.io_canceled) {
316 return;
319 /* The request is used as the AIO opaque value, so add a ref. */
320 scsi_req_ref(&r->req);
322 if (r->req.sg) {
323 dma_acct_start(s->qdev.conf.bs, &r->acct, r->req.sg, BDRV_ACCT_READ);
324 r->req.resid -= r->req.sg->size;
325 r->req.aiocb = dma_bdrv_read(s->qdev.conf.bs, r->req.sg, r->sector,
326 scsi_dma_complete, r);
327 } else {
328 n = scsi_init_iovec(r, SCSI_DMA_BUF_SIZE);
329 bdrv_acct_start(s->qdev.conf.bs, &r->acct, n * BDRV_SECTOR_SIZE, BDRV_ACCT_READ);
330 r->req.aiocb = bdrv_aio_readv(s->qdev.conf.bs, r->sector, &r->qiov, n,
331 scsi_read_complete, r);
334 done:
335 if (!r->req.io_canceled) {
336 scsi_req_unref(&r->req);
340 /* Read more data from scsi device into buffer. */
341 static void scsi_read_data(SCSIRequest *req)
343 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
344 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
345 bool first;
347 DPRINTF("Read sector_count=%d\n", r->sector_count);
348 if (r->sector_count == 0) {
349 /* This also clears the sense buffer for REQUEST SENSE. */
350 scsi_req_complete(&r->req, GOOD);
351 return;
354 /* No data transfer may already be in progress */
355 assert(r->req.aiocb == NULL);
357 /* The request is used as the AIO opaque value, so add a ref. */
358 scsi_req_ref(&r->req);
359 if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
360 DPRINTF("Data transfer direction invalid\n");
361 scsi_read_complete(r, -EINVAL);
362 return;
365 if (s->tray_open) {
366 scsi_read_complete(r, -ENOMEDIUM);
367 return;
370 first = !r->started;
371 r->started = true;
372 if (first && scsi_is_cmd_fua(&r->req.cmd)) {
373 bdrv_acct_start(s->qdev.conf.bs, &r->acct, 0, BDRV_ACCT_FLUSH);
374 r->req.aiocb = bdrv_aio_flush(s->qdev.conf.bs, scsi_do_read, r);
375 } else {
376 scsi_do_read(r, 0);
381 * scsi_handle_rw_error has two return values. 0 means that the error
382 * must be ignored, 1 means that the error has been processed and the
383 * caller should not do anything else for this request. Note that
384 * scsi_handle_rw_error always manages its reference counts, independent
385 * of the return value.
387 static int scsi_handle_rw_error(SCSIDiskReq *r, int error)
389 int is_read = (r->req.cmd.xfer == SCSI_XFER_FROM_DEV);
390 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
391 BlockErrorAction action = bdrv_get_on_error(s->qdev.conf.bs, is_read);
393 if (action == BLOCK_ERR_IGNORE) {
394 bdrv_emit_qmp_error_event(s->qdev.conf.bs, BDRV_ACTION_IGNORE, is_read);
395 return 0;
398 if ((error == ENOSPC && action == BLOCK_ERR_STOP_ENOSPC)
399 || action == BLOCK_ERR_STOP_ANY) {
401 bdrv_emit_qmp_error_event(s->qdev.conf.bs, BDRV_ACTION_STOP, is_read);
402 vm_stop(RUN_STATE_IO_ERROR);
403 bdrv_iostatus_set_err(s->qdev.conf.bs, error);
404 scsi_req_retry(&r->req);
405 } else {
406 switch (error) {
407 case ENOMEDIUM:
408 scsi_check_condition(r, SENSE_CODE(NO_MEDIUM));
409 break;
410 case ENOMEM:
411 scsi_check_condition(r, SENSE_CODE(TARGET_FAILURE));
412 break;
413 case EINVAL:
414 scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
415 break;
416 default:
417 scsi_check_condition(r, SENSE_CODE(IO_ERROR));
418 break;
420 bdrv_emit_qmp_error_event(s->qdev.conf.bs, BDRV_ACTION_REPORT, is_read);
422 return 1;
425 static void scsi_write_complete(void * opaque, int ret)
427 SCSIDiskReq *r = (SCSIDiskReq *)opaque;
428 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
429 uint32_t n;
431 if (r->req.aiocb != NULL) {
432 r->req.aiocb = NULL;
433 bdrv_acct_done(s->qdev.conf.bs, &r->acct);
436 if (ret < 0) {
437 if (scsi_handle_rw_error(r, -ret)) {
438 goto done;
442 n = r->qiov.size / 512;
443 r->sector += n;
444 r->sector_count -= n;
445 if (r->sector_count == 0) {
446 scsi_write_do_fua(r);
447 return;
448 } else {
449 scsi_init_iovec(r, SCSI_DMA_BUF_SIZE);
450 DPRINTF("Write complete tag=0x%x more=%zd\n", r->req.tag, r->qiov.size);
451 scsi_req_data(&r->req, r->qiov.size);
454 done:
455 if (!r->req.io_canceled) {
456 scsi_req_unref(&r->req);
460 static void scsi_write_data(SCSIRequest *req)
462 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
463 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
464 uint32_t n;
466 /* No data transfer may already be in progress */
467 assert(r->req.aiocb == NULL);
469 /* The request is used as the AIO opaque value, so add a ref. */
470 scsi_req_ref(&r->req);
471 if (r->req.cmd.mode != SCSI_XFER_TO_DEV) {
472 DPRINTF("Data transfer direction invalid\n");
473 scsi_write_complete(r, -EINVAL);
474 return;
477 if (!r->req.sg && !r->qiov.size) {
478 /* Called for the first time. Ask the driver to send us more data. */
479 r->started = true;
480 scsi_write_complete(r, 0);
481 return;
483 if (s->tray_open) {
484 scsi_write_complete(r, -ENOMEDIUM);
485 return;
488 if (r->req.cmd.buf[0] == VERIFY_10 || r->req.cmd.buf[0] == VERIFY_12 ||
489 r->req.cmd.buf[0] == VERIFY_16) {
490 if (r->req.sg) {
491 scsi_dma_complete(r, 0);
492 } else {
493 scsi_write_complete(r, 0);
495 return;
498 if (r->req.sg) {
499 dma_acct_start(s->qdev.conf.bs, &r->acct, r->req.sg, BDRV_ACCT_WRITE);
500 r->req.resid -= r->req.sg->size;
501 r->req.aiocb = dma_bdrv_write(s->qdev.conf.bs, r->req.sg, r->sector,
502 scsi_dma_complete, r);
503 } else {
504 n = r->qiov.size / 512;
505 bdrv_acct_start(s->qdev.conf.bs, &r->acct, n * BDRV_SECTOR_SIZE, BDRV_ACCT_WRITE);
506 r->req.aiocb = bdrv_aio_writev(s->qdev.conf.bs, r->sector, &r->qiov, n,
507 scsi_write_complete, r);
511 /* Return a pointer to the data buffer. */
512 static uint8_t *scsi_get_buf(SCSIRequest *req)
514 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
516 return (uint8_t *)r->iov.iov_base;
519 static int scsi_disk_emulate_inquiry(SCSIRequest *req, uint8_t *outbuf)
521 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
522 int buflen = 0;
523 int start;
525 if (req->cmd.buf[1] & 0x1) {
526 /* Vital product data */
527 uint8_t page_code = req->cmd.buf[2];
529 outbuf[buflen++] = s->qdev.type & 0x1f;
530 outbuf[buflen++] = page_code ; // this page
531 outbuf[buflen++] = 0x00;
532 outbuf[buflen++] = 0x00;
533 start = buflen;
535 switch (page_code) {
536 case 0x00: /* Supported page codes, mandatory */
538 DPRINTF("Inquiry EVPD[Supported pages] "
539 "buffer size %zd\n", req->cmd.xfer);
540 outbuf[buflen++] = 0x00; // list of supported pages (this page)
541 if (s->serial) {
542 outbuf[buflen++] = 0x80; // unit serial number
544 outbuf[buflen++] = 0x83; // device identification
545 if (s->qdev.type == TYPE_DISK) {
546 outbuf[buflen++] = 0xb0; // block limits
547 outbuf[buflen++] = 0xb2; // thin provisioning
549 break;
551 case 0x80: /* Device serial number, optional */
553 int l;
555 if (!s->serial) {
556 DPRINTF("Inquiry (EVPD[Serial number] not supported\n");
557 return -1;
560 l = strlen(s->serial);
561 if (l > 20) {
562 l = 20;
565 DPRINTF("Inquiry EVPD[Serial number] "
566 "buffer size %zd\n", req->cmd.xfer);
567 memcpy(outbuf+buflen, s->serial, l);
568 buflen += l;
569 break;
572 case 0x83: /* Device identification page, mandatory */
574 const char *str = s->serial ?: bdrv_get_device_name(s->qdev.conf.bs);
575 int max_len = s->serial ? 20 : 255 - 8;
576 int id_len = strlen(str);
578 if (id_len > max_len) {
579 id_len = max_len;
581 DPRINTF("Inquiry EVPD[Device identification] "
582 "buffer size %zd\n", req->cmd.xfer);
584 outbuf[buflen++] = 0x2; // ASCII
585 outbuf[buflen++] = 0; // not officially assigned
586 outbuf[buflen++] = 0; // reserved
587 outbuf[buflen++] = id_len; // length of data following
588 memcpy(outbuf+buflen, str, id_len);
589 buflen += id_len;
591 if (s->wwn) {
592 outbuf[buflen++] = 0x1; // Binary
593 outbuf[buflen++] = 0x3; // NAA
594 outbuf[buflen++] = 0; // reserved
595 outbuf[buflen++] = 8;
596 stq_be_p(&outbuf[buflen], s->wwn);
597 buflen += 8;
599 break;
601 case 0xb0: /* block limits */
603 unsigned int unmap_sectors =
604 s->qdev.conf.discard_granularity / s->qdev.blocksize;
605 unsigned int min_io_size =
606 s->qdev.conf.min_io_size / s->qdev.blocksize;
607 unsigned int opt_io_size =
608 s->qdev.conf.opt_io_size / s->qdev.blocksize;
610 if (s->qdev.type == TYPE_ROM) {
611 DPRINTF("Inquiry (EVPD[%02X] not supported for CDROM\n",
612 page_code);
613 return -1;
615 /* required VPD size with unmap support */
616 buflen = 0x40;
617 memset(outbuf + 4, 0, buflen - 4);
619 /* optimal transfer length granularity */
620 outbuf[6] = (min_io_size >> 8) & 0xff;
621 outbuf[7] = min_io_size & 0xff;
623 /* optimal transfer length */
624 outbuf[12] = (opt_io_size >> 24) & 0xff;
625 outbuf[13] = (opt_io_size >> 16) & 0xff;
626 outbuf[14] = (opt_io_size >> 8) & 0xff;
627 outbuf[15] = opt_io_size & 0xff;
629 /* optimal unmap granularity */
630 outbuf[28] = (unmap_sectors >> 24) & 0xff;
631 outbuf[29] = (unmap_sectors >> 16) & 0xff;
632 outbuf[30] = (unmap_sectors >> 8) & 0xff;
633 outbuf[31] = unmap_sectors & 0xff;
634 break;
636 case 0xb2: /* thin provisioning */
638 buflen = 8;
639 outbuf[4] = 0;
640 outbuf[5] = 0xe0; /* unmap & write_same 10/16 all supported */
641 outbuf[6] = s->qdev.conf.discard_granularity ? 2 : 1;
642 outbuf[7] = 0;
643 break;
645 default:
646 return -1;
648 /* done with EVPD */
649 assert(buflen - start <= 255);
650 outbuf[start - 1] = buflen - start;
651 return buflen;
654 /* Standard INQUIRY data */
655 if (req->cmd.buf[2] != 0) {
656 return -1;
659 /* PAGE CODE == 0 */
660 buflen = req->cmd.xfer;
661 if (buflen > SCSI_MAX_INQUIRY_LEN) {
662 buflen = SCSI_MAX_INQUIRY_LEN;
664 memset(outbuf, 0, buflen);
666 outbuf[0] = s->qdev.type & 0x1f;
667 outbuf[1] = (s->features & (1 << SCSI_DISK_F_REMOVABLE)) ? 0x80 : 0;
669 strpadcpy((char *) &outbuf[16], 16, s->product, ' ');
670 strpadcpy((char *) &outbuf[8], 8, s->vendor, ' ');
672 memset(&outbuf[32], 0, 4);
673 memcpy(&outbuf[32], s->version, MIN(4, strlen(s->version)));
675 * We claim conformance to SPC-3, which is required for guests
676 * to ask for modern features like READ CAPACITY(16) or the
677 * block characteristics VPD page by default. Not all of SPC-3
678 * is actually implemented, but we're good enough.
680 outbuf[2] = 5;
681 outbuf[3] = 2; /* Format 2 */
683 if (buflen > 36) {
684 outbuf[4] = buflen - 5; /* Additional Length = (Len - 1) - 4 */
685 } else {
686 /* If the allocation length of CDB is too small,
687 the additional length is not adjusted */
688 outbuf[4] = 36 - 5;
691 /* Sync data transfer and TCQ. */
692 outbuf[7] = 0x10 | (req->bus->info->tcq ? 0x02 : 0);
693 return buflen;
696 static inline bool media_is_dvd(SCSIDiskState *s)
698 uint64_t nb_sectors;
699 if (s->qdev.type != TYPE_ROM) {
700 return false;
702 if (!bdrv_is_inserted(s->qdev.conf.bs)) {
703 return false;
705 bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
706 return nb_sectors > CD_MAX_SECTORS;
709 static inline bool media_is_cd(SCSIDiskState *s)
711 uint64_t nb_sectors;
712 if (s->qdev.type != TYPE_ROM) {
713 return false;
715 if (!bdrv_is_inserted(s->qdev.conf.bs)) {
716 return false;
718 bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
719 return nb_sectors <= CD_MAX_SECTORS;
722 static int scsi_read_disc_information(SCSIDiskState *s, SCSIDiskReq *r,
723 uint8_t *outbuf)
725 uint8_t type = r->req.cmd.buf[1] & 7;
727 if (s->qdev.type != TYPE_ROM) {
728 return -1;
731 /* Types 1/2 are only defined for Blu-Ray. */
732 if (type != 0) {
733 scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
734 return -1;
737 memset(outbuf, 0, 34);
738 outbuf[1] = 32;
739 outbuf[2] = 0xe; /* last session complete, disc finalized */
740 outbuf[3] = 1; /* first track on disc */
741 outbuf[4] = 1; /* # of sessions */
742 outbuf[5] = 1; /* first track of last session */
743 outbuf[6] = 1; /* last track of last session */
744 outbuf[7] = 0x20; /* unrestricted use */
745 outbuf[8] = 0x00; /* CD-ROM or DVD-ROM */
746 /* 9-10-11: most significant byte corresponding bytes 4-5-6 */
747 /* 12-23: not meaningful for CD-ROM or DVD-ROM */
748 /* 24-31: disc bar code */
749 /* 32: disc application code */
750 /* 33: number of OPC tables */
752 return 34;
755 static int scsi_read_dvd_structure(SCSIDiskState *s, SCSIDiskReq *r,
756 uint8_t *outbuf)
758 static const int rds_caps_size[5] = {
759 [0] = 2048 + 4,
760 [1] = 4 + 4,
761 [3] = 188 + 4,
762 [4] = 2048 + 4,
765 uint8_t media = r->req.cmd.buf[1];
766 uint8_t layer = r->req.cmd.buf[6];
767 uint8_t format = r->req.cmd.buf[7];
768 int size = -1;
770 if (s->qdev.type != TYPE_ROM) {
771 return -1;
773 if (media != 0) {
774 scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
775 return -1;
778 if (format != 0xff) {
779 if (s->tray_open || !bdrv_is_inserted(s->qdev.conf.bs)) {
780 scsi_check_condition(r, SENSE_CODE(NO_MEDIUM));
781 return -1;
783 if (media_is_cd(s)) {
784 scsi_check_condition(r, SENSE_CODE(INCOMPATIBLE_FORMAT));
785 return -1;
787 if (format >= ARRAY_SIZE(rds_caps_size)) {
788 return -1;
790 size = rds_caps_size[format];
791 memset(outbuf, 0, size);
794 switch (format) {
795 case 0x00: {
796 /* Physical format information */
797 uint64_t nb_sectors;
798 if (layer != 0) {
799 goto fail;
801 bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
803 outbuf[4] = 1; /* DVD-ROM, part version 1 */
804 outbuf[5] = 0xf; /* 120mm disc, minimum rate unspecified */
805 outbuf[6] = 1; /* one layer, read-only (per MMC-2 spec) */
806 outbuf[7] = 0; /* default densities */
808 stl_be_p(&outbuf[12], (nb_sectors >> 2) - 1); /* end sector */
809 stl_be_p(&outbuf[16], (nb_sectors >> 2) - 1); /* l0 end sector */
810 break;
813 case 0x01: /* DVD copyright information, all zeros */
814 break;
816 case 0x03: /* BCA information - invalid field for no BCA info */
817 return -1;
819 case 0x04: /* DVD disc manufacturing information, all zeros */
820 break;
822 case 0xff: { /* List capabilities */
823 int i;
824 size = 4;
825 for (i = 0; i < ARRAY_SIZE(rds_caps_size); i++) {
826 if (!rds_caps_size[i]) {
827 continue;
829 outbuf[size] = i;
830 outbuf[size + 1] = 0x40; /* Not writable, readable */
831 stw_be_p(&outbuf[size + 2], rds_caps_size[i]);
832 size += 4;
834 break;
837 default:
838 return -1;
841 /* Size of buffer, not including 2 byte size field */
842 stw_be_p(outbuf, size - 2);
843 return size;
845 fail:
846 return -1;
849 static int scsi_event_status_media(SCSIDiskState *s, uint8_t *outbuf)
851 uint8_t event_code, media_status;
853 media_status = 0;
854 if (s->tray_open) {
855 media_status = MS_TRAY_OPEN;
856 } else if (bdrv_is_inserted(s->qdev.conf.bs)) {
857 media_status = MS_MEDIA_PRESENT;
860 /* Event notification descriptor */
861 event_code = MEC_NO_CHANGE;
862 if (media_status != MS_TRAY_OPEN) {
863 if (s->media_event) {
864 event_code = MEC_NEW_MEDIA;
865 s->media_event = false;
866 } else if (s->eject_request) {
867 event_code = MEC_EJECT_REQUESTED;
868 s->eject_request = false;
872 outbuf[0] = event_code;
873 outbuf[1] = media_status;
875 /* These fields are reserved, just clear them. */
876 outbuf[2] = 0;
877 outbuf[3] = 0;
878 return 4;
881 static int scsi_get_event_status_notification(SCSIDiskState *s, SCSIDiskReq *r,
882 uint8_t *outbuf)
884 int size;
885 uint8_t *buf = r->req.cmd.buf;
886 uint8_t notification_class_request = buf[4];
887 if (s->qdev.type != TYPE_ROM) {
888 return -1;
890 if ((buf[1] & 1) == 0) {
891 /* asynchronous */
892 return -1;
895 size = 4;
896 outbuf[0] = outbuf[1] = 0;
897 outbuf[3] = 1 << GESN_MEDIA; /* supported events */
898 if (notification_class_request & (1 << GESN_MEDIA)) {
899 outbuf[2] = GESN_MEDIA;
900 size += scsi_event_status_media(s, &outbuf[size]);
901 } else {
902 outbuf[2] = 0x80;
904 stw_be_p(outbuf, size - 4);
905 return size;
908 static int scsi_get_configuration(SCSIDiskState *s, uint8_t *outbuf)
910 int current;
912 if (s->qdev.type != TYPE_ROM) {
913 return -1;
915 current = media_is_dvd(s) ? MMC_PROFILE_DVD_ROM : MMC_PROFILE_CD_ROM;
916 memset(outbuf, 0, 40);
917 stl_be_p(&outbuf[0], 36); /* Bytes after the data length field */
918 stw_be_p(&outbuf[6], current);
919 /* outbuf[8] - outbuf[19]: Feature 0 - Profile list */
920 outbuf[10] = 0x03; /* persistent, current */
921 outbuf[11] = 8; /* two profiles */
922 stw_be_p(&outbuf[12], MMC_PROFILE_DVD_ROM);
923 outbuf[14] = (current == MMC_PROFILE_DVD_ROM);
924 stw_be_p(&outbuf[16], MMC_PROFILE_CD_ROM);
925 outbuf[18] = (current == MMC_PROFILE_CD_ROM);
926 /* outbuf[20] - outbuf[31]: Feature 1 - Core feature */
927 stw_be_p(&outbuf[20], 1);
928 outbuf[22] = 0x08 | 0x03; /* version 2, persistent, current */
929 outbuf[23] = 8;
930 stl_be_p(&outbuf[24], 1); /* SCSI */
931 outbuf[28] = 1; /* DBE = 1, mandatory */
932 /* outbuf[32] - outbuf[39]: Feature 3 - Removable media feature */
933 stw_be_p(&outbuf[32], 3);
934 outbuf[34] = 0x08 | 0x03; /* version 2, persistent, current */
935 outbuf[35] = 4;
936 outbuf[36] = 0x39; /* tray, load=1, eject=1, unlocked at powerup, lock=1 */
937 /* TODO: Random readable, CD read, DVD read, drive serial number,
938 power management */
939 return 40;
942 static int scsi_emulate_mechanism_status(SCSIDiskState *s, uint8_t *outbuf)
944 if (s->qdev.type != TYPE_ROM) {
945 return -1;
947 memset(outbuf, 0, 8);
948 outbuf[5] = 1; /* CD-ROM */
949 return 8;
952 static int mode_sense_page(SCSIDiskState *s, int page, uint8_t **p_outbuf,
953 int page_control)
955 static const int mode_sense_valid[0x3f] = {
956 [MODE_PAGE_HD_GEOMETRY] = (1 << TYPE_DISK),
957 [MODE_PAGE_FLEXIBLE_DISK_GEOMETRY] = (1 << TYPE_DISK),
958 [MODE_PAGE_CACHING] = (1 << TYPE_DISK) | (1 << TYPE_ROM),
959 [MODE_PAGE_R_W_ERROR] = (1 << TYPE_DISK) | (1 << TYPE_ROM),
960 [MODE_PAGE_AUDIO_CTL] = (1 << TYPE_ROM),
961 [MODE_PAGE_CAPABILITIES] = (1 << TYPE_ROM),
964 uint8_t *p = *p_outbuf + 2;
965 int length;
967 if ((mode_sense_valid[page] & (1 << s->qdev.type)) == 0) {
968 return -1;
972 * If Changeable Values are requested, a mask denoting those mode parameters
973 * that are changeable shall be returned. As we currently don't support
974 * parameter changes via MODE_SELECT all bits are returned set to zero.
975 * The buffer was already menset to zero by the caller of this function.
977 * The offsets here are off by two compared to the descriptions in the
978 * SCSI specs, because those include a 2-byte header. This is unfortunate,
979 * but it is done so that offsets are consistent within our implementation
980 * of MODE SENSE and MODE SELECT. MODE SELECT has to deal with both
981 * 2-byte and 4-byte headers.
983 switch (page) {
984 case MODE_PAGE_HD_GEOMETRY:
985 length = 0x16;
986 if (page_control == 1) { /* Changeable Values */
987 break;
989 /* if a geometry hint is available, use it */
990 p[0] = (s->qdev.conf.cyls >> 16) & 0xff;
991 p[1] = (s->qdev.conf.cyls >> 8) & 0xff;
992 p[2] = s->qdev.conf.cyls & 0xff;
993 p[3] = s->qdev.conf.heads & 0xff;
994 /* Write precomp start cylinder, disabled */
995 p[4] = (s->qdev.conf.cyls >> 16) & 0xff;
996 p[5] = (s->qdev.conf.cyls >> 8) & 0xff;
997 p[6] = s->qdev.conf.cyls & 0xff;
998 /* Reduced current start cylinder, disabled */
999 p[7] = (s->qdev.conf.cyls >> 16) & 0xff;
1000 p[8] = (s->qdev.conf.cyls >> 8) & 0xff;
1001 p[9] = s->qdev.conf.cyls & 0xff;
1002 /* Device step rate [ns], 200ns */
1003 p[10] = 0;
1004 p[11] = 200;
1005 /* Landing zone cylinder */
1006 p[12] = 0xff;
1007 p[13] = 0xff;
1008 p[14] = 0xff;
1009 /* Medium rotation rate [rpm], 5400 rpm */
1010 p[18] = (5400 >> 8) & 0xff;
1011 p[19] = 5400 & 0xff;
1012 break;
1014 case MODE_PAGE_FLEXIBLE_DISK_GEOMETRY:
1015 length = 0x1e;
1016 if (page_control == 1) { /* Changeable Values */
1017 break;
1019 /* Transfer rate [kbit/s], 5Mbit/s */
1020 p[0] = 5000 >> 8;
1021 p[1] = 5000 & 0xff;
1022 /* if a geometry hint is available, use it */
1023 p[2] = s->qdev.conf.heads & 0xff;
1024 p[3] = s->qdev.conf.secs & 0xff;
1025 p[4] = s->qdev.blocksize >> 8;
1026 p[6] = (s->qdev.conf.cyls >> 8) & 0xff;
1027 p[7] = s->qdev.conf.cyls & 0xff;
1028 /* Write precomp start cylinder, disabled */
1029 p[8] = (s->qdev.conf.cyls >> 8) & 0xff;
1030 p[9] = s->qdev.conf.cyls & 0xff;
1031 /* Reduced current start cylinder, disabled */
1032 p[10] = (s->qdev.conf.cyls >> 8) & 0xff;
1033 p[11] = s->qdev.conf.cyls & 0xff;
1034 /* Device step rate [100us], 100us */
1035 p[12] = 0;
1036 p[13] = 1;
1037 /* Device step pulse width [us], 1us */
1038 p[14] = 1;
1039 /* Device head settle delay [100us], 100us */
1040 p[15] = 0;
1041 p[16] = 1;
1042 /* Motor on delay [0.1s], 0.1s */
1043 p[17] = 1;
1044 /* Motor off delay [0.1s], 0.1s */
1045 p[18] = 1;
1046 /* Medium rotation rate [rpm], 5400 rpm */
1047 p[26] = (5400 >> 8) & 0xff;
1048 p[27] = 5400 & 0xff;
1049 break;
1051 case MODE_PAGE_CACHING:
1052 length = 0x12;
1053 if (page_control == 1 || /* Changeable Values */
1054 bdrv_enable_write_cache(s->qdev.conf.bs)) {
1055 p[0] = 4; /* WCE */
1057 break;
1059 case MODE_PAGE_R_W_ERROR:
1060 length = 10;
1061 if (page_control == 1) { /* Changeable Values */
1062 break;
1064 p[0] = 0x80; /* Automatic Write Reallocation Enabled */
1065 if (s->qdev.type == TYPE_ROM) {
1066 p[1] = 0x20; /* Read Retry Count */
1068 break;
1070 case MODE_PAGE_AUDIO_CTL:
1071 length = 14;
1072 break;
1074 case MODE_PAGE_CAPABILITIES:
1075 length = 0x14;
1076 if (page_control == 1) { /* Changeable Values */
1077 break;
1080 p[0] = 0x3b; /* CD-R & CD-RW read */
1081 p[1] = 0; /* Writing not supported */
1082 p[2] = 0x7f; /* Audio, composite, digital out,
1083 mode 2 form 1&2, multi session */
1084 p[3] = 0xff; /* CD DA, DA accurate, RW supported,
1085 RW corrected, C2 errors, ISRC,
1086 UPC, Bar code */
1087 p[4] = 0x2d | (s->tray_locked ? 2 : 0);
1088 /* Locking supported, jumper present, eject, tray */
1089 p[5] = 0; /* no volume & mute control, no
1090 changer */
1091 p[6] = (50 * 176) >> 8; /* 50x read speed */
1092 p[7] = (50 * 176) & 0xff;
1093 p[8] = 2 >> 8; /* Two volume levels */
1094 p[9] = 2 & 0xff;
1095 p[10] = 2048 >> 8; /* 2M buffer */
1096 p[11] = 2048 & 0xff;
1097 p[12] = (16 * 176) >> 8; /* 16x read speed current */
1098 p[13] = (16 * 176) & 0xff;
1099 p[16] = (16 * 176) >> 8; /* 16x write speed */
1100 p[17] = (16 * 176) & 0xff;
1101 p[18] = (16 * 176) >> 8; /* 16x write speed current */
1102 p[19] = (16 * 176) & 0xff;
1103 break;
1105 default:
1106 return -1;
1109 assert(length < 256);
1110 (*p_outbuf)[0] = page;
1111 (*p_outbuf)[1] = length;
1112 *p_outbuf += length + 2;
1113 return length + 2;
1116 static int scsi_disk_emulate_mode_sense(SCSIDiskReq *r, uint8_t *outbuf)
1118 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
1119 uint64_t nb_sectors;
1120 bool dbd;
1121 int page, buflen, ret, page_control;
1122 uint8_t *p;
1123 uint8_t dev_specific_param;
1125 dbd = (r->req.cmd.buf[1] & 0x8) != 0;
1126 page = r->req.cmd.buf[2] & 0x3f;
1127 page_control = (r->req.cmd.buf[2] & 0xc0) >> 6;
1128 DPRINTF("Mode Sense(%d) (page %d, xfer %zd, page_control %d)\n",
1129 (r->req.cmd.buf[0] == MODE_SENSE) ? 6 : 10, page, r->req.cmd.xfer, page_control);
1130 memset(outbuf, 0, r->req.cmd.xfer);
1131 p = outbuf;
1133 if (s->qdev.type == TYPE_DISK) {
1134 dev_specific_param = s->features & (1 << SCSI_DISK_F_DPOFUA) ? 0x10 : 0;
1135 if (bdrv_is_read_only(s->qdev.conf.bs)) {
1136 dev_specific_param |= 0x80; /* Readonly. */
1138 } else {
1139 /* MMC prescribes that CD/DVD drives have no block descriptors,
1140 * and defines no device-specific parameter. */
1141 dev_specific_param = 0x00;
1142 dbd = true;
1145 if (r->req.cmd.buf[0] == MODE_SENSE) {
1146 p[1] = 0; /* Default media type. */
1147 p[2] = dev_specific_param;
1148 p[3] = 0; /* Block descriptor length. */
1149 p += 4;
1150 } else { /* MODE_SENSE_10 */
1151 p[2] = 0; /* Default media type. */
1152 p[3] = dev_specific_param;
1153 p[6] = p[7] = 0; /* Block descriptor length. */
1154 p += 8;
1157 bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
1158 if (!dbd && nb_sectors) {
1159 if (r->req.cmd.buf[0] == MODE_SENSE) {
1160 outbuf[3] = 8; /* Block descriptor length */
1161 } else { /* MODE_SENSE_10 */
1162 outbuf[7] = 8; /* Block descriptor length */
1164 nb_sectors /= (s->qdev.blocksize / 512);
1165 if (nb_sectors > 0xffffff) {
1166 nb_sectors = 0;
1168 p[0] = 0; /* media density code */
1169 p[1] = (nb_sectors >> 16) & 0xff;
1170 p[2] = (nb_sectors >> 8) & 0xff;
1171 p[3] = nb_sectors & 0xff;
1172 p[4] = 0; /* reserved */
1173 p[5] = 0; /* bytes 5-7 are the sector size in bytes */
1174 p[6] = s->qdev.blocksize >> 8;
1175 p[7] = 0;
1176 p += 8;
1179 if (page_control == 3) {
1180 /* Saved Values */
1181 scsi_check_condition(r, SENSE_CODE(SAVING_PARAMS_NOT_SUPPORTED));
1182 return -1;
1185 if (page == 0x3f) {
1186 for (page = 0; page <= 0x3e; page++) {
1187 mode_sense_page(s, page, &p, page_control);
1189 } else {
1190 ret = mode_sense_page(s, page, &p, page_control);
1191 if (ret == -1) {
1192 return -1;
1196 buflen = p - outbuf;
1198 * The mode data length field specifies the length in bytes of the
1199 * following data that is available to be transferred. The mode data
1200 * length does not include itself.
1202 if (r->req.cmd.buf[0] == MODE_SENSE) {
1203 outbuf[0] = buflen - 1;
1204 } else { /* MODE_SENSE_10 */
1205 outbuf[0] = ((buflen - 2) >> 8) & 0xff;
1206 outbuf[1] = (buflen - 2) & 0xff;
1208 return buflen;
1211 static int scsi_disk_emulate_read_toc(SCSIRequest *req, uint8_t *outbuf)
1213 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
1214 int start_track, format, msf, toclen;
1215 uint64_t nb_sectors;
1217 msf = req->cmd.buf[1] & 2;
1218 format = req->cmd.buf[2] & 0xf;
1219 start_track = req->cmd.buf[6];
1220 bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
1221 DPRINTF("Read TOC (track %d format %d msf %d)\n", start_track, format, msf >> 1);
1222 nb_sectors /= s->qdev.blocksize / 512;
1223 switch (format) {
1224 case 0:
1225 toclen = cdrom_read_toc(nb_sectors, outbuf, msf, start_track);
1226 break;
1227 case 1:
1228 /* multi session : only a single session defined */
1229 toclen = 12;
1230 memset(outbuf, 0, 12);
1231 outbuf[1] = 0x0a;
1232 outbuf[2] = 0x01;
1233 outbuf[3] = 0x01;
1234 break;
1235 case 2:
1236 toclen = cdrom_read_toc_raw(nb_sectors, outbuf, msf, start_track);
1237 break;
1238 default:
1239 return -1;
1241 return toclen;
1244 static int scsi_disk_emulate_start_stop(SCSIDiskReq *r)
1246 SCSIRequest *req = &r->req;
1247 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
1248 bool start = req->cmd.buf[4] & 1;
1249 bool loej = req->cmd.buf[4] & 2; /* load on start, eject on !start */
1250 int pwrcnd = req->cmd.buf[4] & 0xf0;
1252 if (pwrcnd) {
1253 /* eject/load only happens for power condition == 0 */
1254 return 0;
1257 if ((s->features & (1 << SCSI_DISK_F_REMOVABLE)) && loej) {
1258 if (!start && !s->tray_open && s->tray_locked) {
1259 scsi_check_condition(r,
1260 bdrv_is_inserted(s->qdev.conf.bs)
1261 ? SENSE_CODE(ILLEGAL_REQ_REMOVAL_PREVENTED)
1262 : SENSE_CODE(NOT_READY_REMOVAL_PREVENTED));
1263 return -1;
1266 if (s->tray_open != !start) {
1267 bdrv_eject(s->qdev.conf.bs, !start);
1268 s->tray_open = !start;
1271 return 0;
1274 static void scsi_disk_emulate_read_data(SCSIRequest *req)
1276 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
1277 int buflen = r->iov.iov_len;
1279 if (buflen) {
1280 DPRINTF("Read buf_len=%d\n", buflen);
1281 r->iov.iov_len = 0;
1282 r->started = true;
1283 scsi_req_data(&r->req, buflen);
1284 return;
1287 /* This also clears the sense buffer for REQUEST SENSE. */
1288 scsi_req_complete(&r->req, GOOD);
1291 static int scsi_disk_check_mode_select(SCSIDiskState *s, int page,
1292 uint8_t *inbuf, int inlen)
1294 uint8_t mode_current[SCSI_MAX_MODE_LEN];
1295 uint8_t mode_changeable[SCSI_MAX_MODE_LEN];
1296 uint8_t *p;
1297 int len, expected_len, changeable_len, i;
1299 /* The input buffer does not include the page header, so it is
1300 * off by 2 bytes.
1302 expected_len = inlen + 2;
1303 if (expected_len > SCSI_MAX_MODE_LEN) {
1304 return -1;
1307 p = mode_current;
1308 memset(mode_current, 0, inlen + 2);
1309 len = mode_sense_page(s, page, &p, 0);
1310 if (len < 0 || len != expected_len) {
1311 return -1;
1314 p = mode_changeable;
1315 memset(mode_changeable, 0, inlen + 2);
1316 changeable_len = mode_sense_page(s, page, &p, 1);
1317 assert(changeable_len == len);
1319 /* Check that unchangeable bits are the same as what MODE SENSE
1320 * would return.
1322 for (i = 2; i < len; i++) {
1323 if (((mode_current[i] ^ inbuf[i - 2]) & ~mode_changeable[i]) != 0) {
1324 return -1;
1327 return 0;
1330 static void scsi_disk_apply_mode_select(SCSIDiskState *s, int page, uint8_t *p)
1332 switch (page) {
1333 case MODE_PAGE_CACHING:
1334 bdrv_set_enable_write_cache(s->qdev.conf.bs, (p[0] & 4) != 0);
1335 break;
1337 default:
1338 break;
1342 static int mode_select_pages(SCSIDiskReq *r, uint8_t *p, int len, bool change)
1344 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
1346 while (len > 0) {
1347 int page, subpage, page_len;
1349 /* Parse both possible formats for the mode page headers. */
1350 page = p[0] & 0x3f;
1351 if (p[0] & 0x40) {
1352 if (len < 4) {
1353 goto invalid_param_len;
1355 subpage = p[1];
1356 page_len = lduw_be_p(&p[2]);
1357 p += 4;
1358 len -= 4;
1359 } else {
1360 if (len < 2) {
1361 goto invalid_param_len;
1363 subpage = 0;
1364 page_len = p[1];
1365 p += 2;
1366 len -= 2;
1369 if (subpage) {
1370 goto invalid_param;
1372 if (page_len > len) {
1373 goto invalid_param_len;
1376 if (!change) {
1377 if (scsi_disk_check_mode_select(s, page, p, page_len) < 0) {
1378 goto invalid_param;
1380 } else {
1381 scsi_disk_apply_mode_select(s, page, p);
1384 p += page_len;
1385 len -= page_len;
1387 return 0;
1389 invalid_param:
1390 scsi_check_condition(r, SENSE_CODE(INVALID_PARAM));
1391 return -1;
1393 invalid_param_len:
1394 scsi_check_condition(r, SENSE_CODE(INVALID_PARAM_LEN));
1395 return -1;
1398 static void scsi_disk_emulate_mode_select(SCSIDiskReq *r, uint8_t *inbuf)
1400 uint8_t *p = inbuf;
1401 int cmd = r->req.cmd.buf[0];
1402 int len = r->req.cmd.xfer;
1403 int hdr_len = (cmd == MODE_SELECT ? 4 : 8);
1404 int bd_len;
1405 int pass;
1407 /* We only support PF=1, SP=0. */
1408 if ((r->req.cmd.buf[1] & 0x11) != 0x10) {
1409 goto invalid_field;
1412 if (len < hdr_len) {
1413 goto invalid_param_len;
1416 bd_len = (cmd == MODE_SELECT ? p[3] : lduw_be_p(&p[6]));
1417 len -= hdr_len;
1418 p += hdr_len;
1419 if (len < bd_len) {
1420 goto invalid_param_len;
1422 if (bd_len != 0 && bd_len != 8) {
1423 goto invalid_param;
1426 len -= bd_len;
1427 p += bd_len;
1429 /* Ensure no change is made if there is an error! */
1430 for (pass = 0; pass < 2; pass++) {
1431 if (mode_select_pages(r, p, len, pass == 1) < 0) {
1432 assert(pass == 0);
1433 return;
1436 scsi_req_complete(&r->req, GOOD);
1437 return;
1439 invalid_param:
1440 scsi_check_condition(r, SENSE_CODE(INVALID_PARAM));
1441 return;
1443 invalid_param_len:
1444 scsi_check_condition(r, SENSE_CODE(INVALID_PARAM_LEN));
1445 return;
1447 invalid_field:
1448 scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
1449 return;
1452 typedef struct UnmapCBData {
1453 SCSIDiskReq *r;
1454 uint8_t *inbuf;
1455 int count;
1456 } UnmapCBData;
1458 static void scsi_unmap_complete(void *opaque, int ret)
1460 UnmapCBData *data = opaque;
1461 SCSIDiskReq *r = data->r;
1462 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
1463 uint64_t sector_num;
1464 uint32 nb_sectors;
1466 r->req.aiocb = NULL;
1467 if (ret < 0) {
1468 if (scsi_handle_rw_error(r, -ret)) {
1469 goto done;
1473 if (data->count > 0 && !r->req.io_canceled) {
1474 sector_num = ldq_be_p(&data->inbuf[0]);
1475 nb_sectors = ldl_be_p(&data->inbuf[8]) & 0xffffffffULL;
1476 if (sector_num > sector_num + nb_sectors ||
1477 sector_num + nb_sectors - 1 > s->qdev.max_lba) {
1478 scsi_check_condition(r, SENSE_CODE(LBA_OUT_OF_RANGE));
1479 goto done;
1482 r->req.aiocb = bdrv_aio_discard(s->qdev.conf.bs,
1483 sector_num * (s->qdev.blocksize / 512),
1484 nb_sectors * (s->qdev.blocksize / 512),
1485 scsi_unmap_complete, data);
1486 data->count--;
1487 data->inbuf += 16;
1488 return;
1491 done:
1492 if (data->count == 0) {
1493 scsi_req_complete(&r->req, GOOD);
1495 if (!r->req.io_canceled) {
1496 scsi_req_unref(&r->req);
1498 g_free(data);
1501 static void scsi_disk_emulate_unmap(SCSIDiskReq *r, uint8_t *inbuf)
1503 uint8_t *p = inbuf;
1504 int len = r->req.cmd.xfer;
1505 UnmapCBData *data;
1507 if (len < 8) {
1508 goto invalid_param_len;
1510 if (len < lduw_be_p(&p[0]) + 2) {
1511 goto invalid_param_len;
1513 if (len < lduw_be_p(&p[2]) + 8) {
1514 goto invalid_param_len;
1516 if (lduw_be_p(&p[2]) & 15) {
1517 goto invalid_param_len;
1520 data = g_new0(UnmapCBData, 1);
1521 data->r = r;
1522 data->inbuf = &p[8];
1523 data->count = lduw_be_p(&p[2]) >> 4;
1525 /* The matching unref is in scsi_unmap_complete, before data is freed. */
1526 scsi_req_ref(&r->req);
1527 scsi_unmap_complete(data, 0);
1528 return;
1530 invalid_param_len:
1531 scsi_check_condition(r, SENSE_CODE(INVALID_PARAM_LEN));
1532 return;
1535 static void scsi_disk_emulate_write_data(SCSIRequest *req)
1537 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
1539 if (r->iov.iov_len) {
1540 int buflen = r->iov.iov_len;
1541 DPRINTF("Write buf_len=%d\n", buflen);
1542 r->iov.iov_len = 0;
1543 scsi_req_data(&r->req, buflen);
1544 return;
1547 switch (req->cmd.buf[0]) {
1548 case MODE_SELECT:
1549 case MODE_SELECT_10:
1550 /* This also clears the sense buffer for REQUEST SENSE. */
1551 scsi_disk_emulate_mode_select(r, r->iov.iov_base);
1552 break;
1554 case UNMAP:
1555 scsi_disk_emulate_unmap(r, r->iov.iov_base);
1556 break;
1558 default:
1559 abort();
1563 static int32_t scsi_disk_emulate_command(SCSIRequest *req, uint8_t *buf)
1565 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
1566 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
1567 uint64_t nb_sectors;
1568 uint8_t *outbuf;
1569 int buflen;
1571 switch (req->cmd.buf[0]) {
1572 case INQUIRY:
1573 case MODE_SENSE:
1574 case MODE_SENSE_10:
1575 case RESERVE:
1576 case RESERVE_10:
1577 case RELEASE:
1578 case RELEASE_10:
1579 case START_STOP:
1580 case ALLOW_MEDIUM_REMOVAL:
1581 case GET_CONFIGURATION:
1582 case GET_EVENT_STATUS_NOTIFICATION:
1583 case MECHANISM_STATUS:
1584 case REQUEST_SENSE:
1585 break;
1587 default:
1588 if (s->tray_open || !bdrv_is_inserted(s->qdev.conf.bs)) {
1589 scsi_check_condition(r, SENSE_CODE(NO_MEDIUM));
1590 return 0;
1592 break;
1595 if (!r->iov.iov_base) {
1597 * FIXME: we shouldn't return anything bigger than 4k, but the code
1598 * requires the buffer to be as big as req->cmd.xfer in several
1599 * places. So, do not allow CDBs with a very large ALLOCATION
1600 * LENGTH. The real fix would be to modify scsi_read_data and
1601 * dma_buf_read, so that they return data beyond the buflen
1602 * as all zeros.
1604 if (req->cmd.xfer > 65536) {
1605 goto illegal_request;
1607 r->buflen = MAX(4096, req->cmd.xfer);
1608 r->iov.iov_base = qemu_blockalign(s->qdev.conf.bs, r->buflen);
1611 buflen = req->cmd.xfer;
1612 outbuf = r->iov.iov_base;
1613 switch (req->cmd.buf[0]) {
1614 case TEST_UNIT_READY:
1615 assert(!s->tray_open && bdrv_is_inserted(s->qdev.conf.bs));
1616 break;
1617 case INQUIRY:
1618 buflen = scsi_disk_emulate_inquiry(req, outbuf);
1619 if (buflen < 0) {
1620 goto illegal_request;
1622 break;
1623 case MODE_SENSE:
1624 case MODE_SENSE_10:
1625 buflen = scsi_disk_emulate_mode_sense(r, outbuf);
1626 if (buflen < 0) {
1627 goto illegal_request;
1629 break;
1630 case READ_TOC:
1631 buflen = scsi_disk_emulate_read_toc(req, outbuf);
1632 if (buflen < 0) {
1633 goto illegal_request;
1635 break;
1636 case RESERVE:
1637 if (req->cmd.buf[1] & 1) {
1638 goto illegal_request;
1640 break;
1641 case RESERVE_10:
1642 if (req->cmd.buf[1] & 3) {
1643 goto illegal_request;
1645 break;
1646 case RELEASE:
1647 if (req->cmd.buf[1] & 1) {
1648 goto illegal_request;
1650 break;
1651 case RELEASE_10:
1652 if (req->cmd.buf[1] & 3) {
1653 goto illegal_request;
1655 break;
1656 case START_STOP:
1657 if (scsi_disk_emulate_start_stop(r) < 0) {
1658 return 0;
1660 break;
1661 case ALLOW_MEDIUM_REMOVAL:
1662 s->tray_locked = req->cmd.buf[4] & 1;
1663 bdrv_lock_medium(s->qdev.conf.bs, req->cmd.buf[4] & 1);
1664 break;
1665 case READ_CAPACITY_10:
1666 /* The normal LEN field for this command is zero. */
1667 memset(outbuf, 0, 8);
1668 bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
1669 if (!nb_sectors) {
1670 scsi_check_condition(r, SENSE_CODE(LUN_NOT_READY));
1671 return -1;
1673 if ((req->cmd.buf[8] & 1) == 0 && req->cmd.lba) {
1674 goto illegal_request;
1676 nb_sectors /= s->qdev.blocksize / 512;
1677 /* Returned value is the address of the last sector. */
1678 nb_sectors--;
1679 /* Remember the new size for read/write sanity checking. */
1680 s->qdev.max_lba = nb_sectors;
1681 /* Clip to 2TB, instead of returning capacity modulo 2TB. */
1682 if (nb_sectors > UINT32_MAX) {
1683 nb_sectors = UINT32_MAX;
1685 outbuf[0] = (nb_sectors >> 24) & 0xff;
1686 outbuf[1] = (nb_sectors >> 16) & 0xff;
1687 outbuf[2] = (nb_sectors >> 8) & 0xff;
1688 outbuf[3] = nb_sectors & 0xff;
1689 outbuf[4] = 0;
1690 outbuf[5] = 0;
1691 outbuf[6] = s->qdev.blocksize >> 8;
1692 outbuf[7] = 0;
1693 buflen = 8;
1694 break;
1695 case REQUEST_SENSE:
1696 /* Just return "NO SENSE". */
1697 buflen = scsi_build_sense(NULL, 0, outbuf, r->buflen,
1698 (req->cmd.buf[1] & 1) == 0);
1699 break;
1700 case MECHANISM_STATUS:
1701 buflen = scsi_emulate_mechanism_status(s, outbuf);
1702 if (buflen < 0) {
1703 goto illegal_request;
1705 break;
1706 case GET_CONFIGURATION:
1707 buflen = scsi_get_configuration(s, outbuf);
1708 if (buflen < 0) {
1709 goto illegal_request;
1711 break;
1712 case GET_EVENT_STATUS_NOTIFICATION:
1713 buflen = scsi_get_event_status_notification(s, r, outbuf);
1714 if (buflen < 0) {
1715 goto illegal_request;
1717 break;
1718 case READ_DISC_INFORMATION:
1719 buflen = scsi_read_disc_information(s, r, outbuf);
1720 if (buflen < 0) {
1721 goto illegal_request;
1723 break;
1724 case READ_DVD_STRUCTURE:
1725 buflen = scsi_read_dvd_structure(s, r, outbuf);
1726 if (buflen < 0) {
1727 goto illegal_request;
1729 break;
1730 case SERVICE_ACTION_IN_16:
1731 /* Service Action In subcommands. */
1732 if ((req->cmd.buf[1] & 31) == SAI_READ_CAPACITY_16) {
1733 DPRINTF("SAI READ CAPACITY(16)\n");
1734 memset(outbuf, 0, req->cmd.xfer);
1735 bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
1736 if (!nb_sectors) {
1737 scsi_check_condition(r, SENSE_CODE(LUN_NOT_READY));
1738 return -1;
1740 if ((req->cmd.buf[14] & 1) == 0 && req->cmd.lba) {
1741 goto illegal_request;
1743 nb_sectors /= s->qdev.blocksize / 512;
1744 /* Returned value is the address of the last sector. */
1745 nb_sectors--;
1746 /* Remember the new size for read/write sanity checking. */
1747 s->qdev.max_lba = nb_sectors;
1748 outbuf[0] = (nb_sectors >> 56) & 0xff;
1749 outbuf[1] = (nb_sectors >> 48) & 0xff;
1750 outbuf[2] = (nb_sectors >> 40) & 0xff;
1751 outbuf[3] = (nb_sectors >> 32) & 0xff;
1752 outbuf[4] = (nb_sectors >> 24) & 0xff;
1753 outbuf[5] = (nb_sectors >> 16) & 0xff;
1754 outbuf[6] = (nb_sectors >> 8) & 0xff;
1755 outbuf[7] = nb_sectors & 0xff;
1756 outbuf[8] = 0;
1757 outbuf[9] = 0;
1758 outbuf[10] = s->qdev.blocksize >> 8;
1759 outbuf[11] = 0;
1760 outbuf[12] = 0;
1761 outbuf[13] = get_physical_block_exp(&s->qdev.conf);
1763 /* set TPE bit if the format supports discard */
1764 if (s->qdev.conf.discard_granularity) {
1765 outbuf[14] = 0x80;
1768 /* Protection, exponent and lowest lba field left blank. */
1769 buflen = req->cmd.xfer;
1770 break;
1772 DPRINTF("Unsupported Service Action In\n");
1773 goto illegal_request;
1774 case SYNCHRONIZE_CACHE:
1775 /* The request is used as the AIO opaque value, so add a ref. */
1776 scsi_req_ref(&r->req);
1777 bdrv_acct_start(s->qdev.conf.bs, &r->acct, 0, BDRV_ACCT_FLUSH);
1778 r->req.aiocb = bdrv_aio_flush(s->qdev.conf.bs, scsi_aio_complete, r);
1779 return 0;
1780 case SEEK_10:
1781 DPRINTF("Seek(10) (sector %" PRId64 ")\n", r->req.cmd.lba);
1782 if (r->req.cmd.lba > s->qdev.max_lba) {
1783 goto illegal_lba;
1785 break;
1786 case MODE_SELECT:
1787 DPRINTF("Mode Select(6) (len %lu)\n", (long)r->req.cmd.xfer);
1788 break;
1789 case MODE_SELECT_10:
1790 DPRINTF("Mode Select(10) (len %lu)\n", (long)r->req.cmd.xfer);
1791 break;
1792 case UNMAP:
1793 DPRINTF("Unmap (len %lu)\n", (long)r->req.cmd.xfer);
1794 break;
1795 case WRITE_SAME_10:
1796 nb_sectors = lduw_be_p(&req->cmd.buf[7]);
1797 goto write_same;
1798 case WRITE_SAME_16:
1799 nb_sectors = ldl_be_p(&req->cmd.buf[10]) & 0xffffffffULL;
1800 write_same:
1801 if (bdrv_is_read_only(s->qdev.conf.bs)) {
1802 scsi_check_condition(r, SENSE_CODE(WRITE_PROTECTED));
1803 return 0;
1805 if (r->req.cmd.lba > r->req.cmd.lba + nb_sectors ||
1806 r->req.cmd.lba + nb_sectors - 1 > s->qdev.max_lba) {
1807 goto illegal_lba;
1811 * We only support WRITE SAME with the unmap bit set for now.
1813 if (!(req->cmd.buf[1] & 0x8)) {
1814 goto illegal_request;
1817 /* The request is used as the AIO opaque value, so add a ref. */
1818 scsi_req_ref(&r->req);
1819 r->req.aiocb = bdrv_aio_discard(s->qdev.conf.bs,
1820 r->req.cmd.lba * (s->qdev.blocksize / 512),
1821 nb_sectors * (s->qdev.blocksize / 512),
1822 scsi_aio_complete, r);
1823 return 0;
1824 default:
1825 DPRINTF("Unknown SCSI command (%2.2x)\n", buf[0]);
1826 scsi_check_condition(r, SENSE_CODE(INVALID_OPCODE));
1827 return 0;
1829 assert(!r->req.aiocb);
1830 r->iov.iov_len = MIN(buflen, req->cmd.xfer);
1831 if (r->iov.iov_len == 0) {
1832 scsi_req_complete(&r->req, GOOD);
1834 if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
1835 assert(r->iov.iov_len == req->cmd.xfer);
1836 return -r->iov.iov_len;
1837 } else {
1838 return r->iov.iov_len;
1841 illegal_request:
1842 if (r->req.status == -1) {
1843 scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
1845 return 0;
1847 illegal_lba:
1848 scsi_check_condition(r, SENSE_CODE(LBA_OUT_OF_RANGE));
1849 return 0;
1852 /* Execute a scsi command. Returns the length of the data expected by the
1853 command. This will be Positive for data transfers from the device
1854 (eg. disk reads), negative for transfers to the device (eg. disk writes),
1855 and zero if the command does not transfer any data. */
1857 static int32_t scsi_disk_dma_command(SCSIRequest *req, uint8_t *buf)
1859 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
1860 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
1861 int32_t len;
1862 uint8_t command;
1864 command = buf[0];
1866 if (s->tray_open || !bdrv_is_inserted(s->qdev.conf.bs)) {
1867 scsi_check_condition(r, SENSE_CODE(NO_MEDIUM));
1868 return 0;
1871 switch (command) {
1872 case READ_6:
1873 case READ_10:
1874 case READ_12:
1875 case READ_16:
1876 len = r->req.cmd.xfer / s->qdev.blocksize;
1877 DPRINTF("Read (sector %" PRId64 ", count %d)\n", r->req.cmd.lba, len);
1878 if (r->req.cmd.buf[1] & 0xe0) {
1879 goto illegal_request;
1881 if (r->req.cmd.lba > r->req.cmd.lba + len ||
1882 r->req.cmd.lba + len - 1 > s->qdev.max_lba) {
1883 goto illegal_lba;
1885 r->sector = r->req.cmd.lba * (s->qdev.blocksize / 512);
1886 r->sector_count = len * (s->qdev.blocksize / 512);
1887 break;
1888 case WRITE_6:
1889 case WRITE_10:
1890 case WRITE_12:
1891 case WRITE_16:
1892 case WRITE_VERIFY_10:
1893 case WRITE_VERIFY_12:
1894 case WRITE_VERIFY_16:
1895 if (bdrv_is_read_only(s->qdev.conf.bs)) {
1896 scsi_check_condition(r, SENSE_CODE(WRITE_PROTECTED));
1897 return 0;
1899 /* fallthrough */
1900 case VERIFY_10:
1901 case VERIFY_12:
1902 case VERIFY_16:
1903 len = r->req.cmd.xfer / s->qdev.blocksize;
1904 DPRINTF("Write %s(sector %" PRId64 ", count %d)\n",
1905 (command & 0xe) == 0xe ? "And Verify " : "",
1906 r->req.cmd.lba, len);
1907 if (r->req.cmd.buf[1] & 0xe0) {
1908 goto illegal_request;
1910 if (r->req.cmd.lba > r->req.cmd.lba + len ||
1911 r->req.cmd.lba + len - 1 > s->qdev.max_lba) {
1912 goto illegal_lba;
1914 r->sector = r->req.cmd.lba * (s->qdev.blocksize / 512);
1915 r->sector_count = len * (s->qdev.blocksize / 512);
1916 break;
1917 default:
1918 abort();
1919 illegal_request:
1920 scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
1921 return 0;
1922 illegal_lba:
1923 scsi_check_condition(r, SENSE_CODE(LBA_OUT_OF_RANGE));
1924 return 0;
1926 if (r->sector_count == 0) {
1927 scsi_req_complete(&r->req, GOOD);
1929 assert(r->iov.iov_len == 0);
1930 if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
1931 return -r->sector_count * 512;
1932 } else {
1933 return r->sector_count * 512;
1937 static void scsi_disk_reset(DeviceState *dev)
1939 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev.qdev, dev);
1940 uint64_t nb_sectors;
1942 scsi_device_purge_requests(&s->qdev, SENSE_CODE(RESET));
1944 bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
1945 nb_sectors /= s->qdev.blocksize / 512;
1946 if (nb_sectors) {
1947 nb_sectors--;
1949 s->qdev.max_lba = nb_sectors;
1952 static void scsi_destroy(SCSIDevice *dev)
1954 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
1956 scsi_device_purge_requests(&s->qdev, SENSE_CODE(NO_SENSE));
1957 blockdev_mark_auto_del(s->qdev.conf.bs);
1960 static void scsi_disk_resize_cb(void *opaque)
1962 SCSIDiskState *s = opaque;
1964 /* SPC lists this sense code as available only for
1965 * direct-access devices.
1967 if (s->qdev.type == TYPE_DISK) {
1968 scsi_device_set_ua(&s->qdev, SENSE_CODE(CAPACITY_CHANGED));
1969 scsi_device_report_change(&s->qdev, SENSE_CODE(CAPACITY_CHANGED));
1973 static void scsi_cd_change_media_cb(void *opaque, bool load)
1975 SCSIDiskState *s = opaque;
1978 * When a CD gets changed, we have to report an ejected state and
1979 * then a loaded state to guests so that they detect tray
1980 * open/close and media change events. Guests that do not use
1981 * GET_EVENT_STATUS_NOTIFICATION to detect such tray open/close
1982 * states rely on this behavior.
1984 * media_changed governs the state machine used for unit attention
1985 * report. media_event is used by GET EVENT STATUS NOTIFICATION.
1987 s->media_changed = load;
1988 s->tray_open = !load;
1989 scsi_device_set_ua(&s->qdev, SENSE_CODE(UNIT_ATTENTION_NO_MEDIUM));
1990 s->media_event = true;
1991 s->eject_request = false;
1994 static void scsi_cd_eject_request_cb(void *opaque, bool force)
1996 SCSIDiskState *s = opaque;
1998 s->eject_request = true;
1999 if (force) {
2000 s->tray_locked = false;
2004 static bool scsi_cd_is_tray_open(void *opaque)
2006 return ((SCSIDiskState *)opaque)->tray_open;
2009 static bool scsi_cd_is_medium_locked(void *opaque)
2011 return ((SCSIDiskState *)opaque)->tray_locked;
2014 static const BlockDevOps scsi_disk_removable_block_ops = {
2015 .change_media_cb = scsi_cd_change_media_cb,
2016 .eject_request_cb = scsi_cd_eject_request_cb,
2017 .is_tray_open = scsi_cd_is_tray_open,
2018 .is_medium_locked = scsi_cd_is_medium_locked,
2020 .resize_cb = scsi_disk_resize_cb,
2023 static const BlockDevOps scsi_disk_block_ops = {
2024 .resize_cb = scsi_disk_resize_cb,
2027 static void scsi_disk_unit_attention_reported(SCSIDevice *dev)
2029 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
2030 if (s->media_changed) {
2031 s->media_changed = false;
2032 scsi_device_set_ua(&s->qdev, SENSE_CODE(MEDIUM_CHANGED));
2036 static int scsi_initfn(SCSIDevice *dev)
2038 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
2040 if (!s->qdev.conf.bs) {
2041 error_report("drive property not set");
2042 return -1;
2045 if (!(s->features & (1 << SCSI_DISK_F_REMOVABLE)) &&
2046 !bdrv_is_inserted(s->qdev.conf.bs)) {
2047 error_report("Device needs media, but drive is empty");
2048 return -1;
2051 blkconf_serial(&s->qdev.conf, &s->serial);
2052 if (dev->type == TYPE_DISK
2053 && blkconf_geometry(&dev->conf, NULL, 65535, 255, 255) < 0) {
2054 return -1;
2057 if (!s->version) {
2058 s->version = g_strdup(qemu_get_version());
2060 if (!s->vendor) {
2061 s->vendor = g_strdup("QEMU");
2064 if (bdrv_is_sg(s->qdev.conf.bs)) {
2065 error_report("unwanted /dev/sg*");
2066 return -1;
2069 if (s->features & (1 << SCSI_DISK_F_REMOVABLE)) {
2070 bdrv_set_dev_ops(s->qdev.conf.bs, &scsi_disk_removable_block_ops, s);
2071 } else {
2072 bdrv_set_dev_ops(s->qdev.conf.bs, &scsi_disk_block_ops, s);
2074 bdrv_set_buffer_alignment(s->qdev.conf.bs, s->qdev.blocksize);
2076 bdrv_iostatus_enable(s->qdev.conf.bs);
2077 add_boot_device_path(s->qdev.conf.bootindex, &dev->qdev, NULL);
2078 return 0;
2081 static int scsi_hd_initfn(SCSIDevice *dev)
2083 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
2084 s->qdev.blocksize = s->qdev.conf.logical_block_size;
2085 s->qdev.type = TYPE_DISK;
2086 if (!s->product) {
2087 s->product = g_strdup("QEMU HARDDISK");
2089 return scsi_initfn(&s->qdev);
2092 static int scsi_cd_initfn(SCSIDevice *dev)
2094 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
2095 s->qdev.blocksize = 2048;
2096 s->qdev.type = TYPE_ROM;
2097 s->features |= 1 << SCSI_DISK_F_REMOVABLE;
2098 if (!s->product) {
2099 s->product = g_strdup("QEMU CD-ROM");
2101 return scsi_initfn(&s->qdev);
2104 static int scsi_disk_initfn(SCSIDevice *dev)
2106 DriveInfo *dinfo;
2108 if (!dev->conf.bs) {
2109 return scsi_initfn(dev); /* ... and die there */
2112 dinfo = drive_get_by_blockdev(dev->conf.bs);
2113 if (dinfo->media_cd) {
2114 return scsi_cd_initfn(dev);
2115 } else {
2116 return scsi_hd_initfn(dev);
2120 static const SCSIReqOps scsi_disk_emulate_reqops = {
2121 .size = sizeof(SCSIDiskReq),
2122 .free_req = scsi_free_request,
2123 .send_command = scsi_disk_emulate_command,
2124 .read_data = scsi_disk_emulate_read_data,
2125 .write_data = scsi_disk_emulate_write_data,
2126 .get_buf = scsi_get_buf,
2129 static const SCSIReqOps scsi_disk_dma_reqops = {
2130 .size = sizeof(SCSIDiskReq),
2131 .free_req = scsi_free_request,
2132 .send_command = scsi_disk_dma_command,
2133 .read_data = scsi_read_data,
2134 .write_data = scsi_write_data,
2135 .cancel_io = scsi_cancel_io,
2136 .get_buf = scsi_get_buf,
2137 .load_request = scsi_disk_load_request,
2138 .save_request = scsi_disk_save_request,
2141 static const SCSIReqOps *const scsi_disk_reqops_dispatch[256] = {
2142 [TEST_UNIT_READY] = &scsi_disk_emulate_reqops,
2143 [INQUIRY] = &scsi_disk_emulate_reqops,
2144 [MODE_SENSE] = &scsi_disk_emulate_reqops,
2145 [MODE_SENSE_10] = &scsi_disk_emulate_reqops,
2146 [START_STOP] = &scsi_disk_emulate_reqops,
2147 [ALLOW_MEDIUM_REMOVAL] = &scsi_disk_emulate_reqops,
2148 [READ_CAPACITY_10] = &scsi_disk_emulate_reqops,
2149 [READ_TOC] = &scsi_disk_emulate_reqops,
2150 [READ_DVD_STRUCTURE] = &scsi_disk_emulate_reqops,
2151 [READ_DISC_INFORMATION] = &scsi_disk_emulate_reqops,
2152 [GET_CONFIGURATION] = &scsi_disk_emulate_reqops,
2153 [GET_EVENT_STATUS_NOTIFICATION] = &scsi_disk_emulate_reqops,
2154 [MECHANISM_STATUS] = &scsi_disk_emulate_reqops,
2155 [SERVICE_ACTION_IN_16] = &scsi_disk_emulate_reqops,
2156 [REQUEST_SENSE] = &scsi_disk_emulate_reqops,
2157 [SYNCHRONIZE_CACHE] = &scsi_disk_emulate_reqops,
2158 [SEEK_10] = &scsi_disk_emulate_reqops,
2159 [MODE_SELECT] = &scsi_disk_emulate_reqops,
2160 [MODE_SELECT_10] = &scsi_disk_emulate_reqops,
2161 [UNMAP] = &scsi_disk_emulate_reqops,
2162 [WRITE_SAME_10] = &scsi_disk_emulate_reqops,
2163 [WRITE_SAME_16] = &scsi_disk_emulate_reqops,
2165 [READ_6] = &scsi_disk_dma_reqops,
2166 [READ_10] = &scsi_disk_dma_reqops,
2167 [READ_12] = &scsi_disk_dma_reqops,
2168 [READ_16] = &scsi_disk_dma_reqops,
2169 [VERIFY_10] = &scsi_disk_dma_reqops,
2170 [VERIFY_12] = &scsi_disk_dma_reqops,
2171 [VERIFY_16] = &scsi_disk_dma_reqops,
2172 [WRITE_6] = &scsi_disk_dma_reqops,
2173 [WRITE_10] = &scsi_disk_dma_reqops,
2174 [WRITE_12] = &scsi_disk_dma_reqops,
2175 [WRITE_16] = &scsi_disk_dma_reqops,
2176 [WRITE_VERIFY_10] = &scsi_disk_dma_reqops,
2177 [WRITE_VERIFY_12] = &scsi_disk_dma_reqops,
2178 [WRITE_VERIFY_16] = &scsi_disk_dma_reqops,
2181 static SCSIRequest *scsi_new_request(SCSIDevice *d, uint32_t tag, uint32_t lun,
2182 uint8_t *buf, void *hba_private)
2184 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, d);
2185 SCSIRequest *req;
2186 const SCSIReqOps *ops;
2187 uint8_t command;
2189 command = buf[0];
2190 ops = scsi_disk_reqops_dispatch[command];
2191 if (!ops) {
2192 ops = &scsi_disk_emulate_reqops;
2194 req = scsi_req_alloc(ops, &s->qdev, tag, lun, hba_private);
2196 #ifdef DEBUG_SCSI
2197 DPRINTF("Command: lun=%d tag=0x%x data=0x%02x", lun, tag, buf[0]);
2199 int i;
2200 for (i = 1; i < req->cmd.len; i++) {
2201 printf(" 0x%02x", buf[i]);
2203 printf("\n");
2205 #endif
2207 return req;
2210 #ifdef __linux__
2211 static int get_device_type(SCSIDiskState *s)
2213 BlockDriverState *bdrv = s->qdev.conf.bs;
2214 uint8_t cmd[16];
2215 uint8_t buf[36];
2216 uint8_t sensebuf[8];
2217 sg_io_hdr_t io_header;
2218 int ret;
2220 memset(cmd, 0, sizeof(cmd));
2221 memset(buf, 0, sizeof(buf));
2222 cmd[0] = INQUIRY;
2223 cmd[4] = sizeof(buf);
2225 memset(&io_header, 0, sizeof(io_header));
2226 io_header.interface_id = 'S';
2227 io_header.dxfer_direction = SG_DXFER_FROM_DEV;
2228 io_header.dxfer_len = sizeof(buf);
2229 io_header.dxferp = buf;
2230 io_header.cmdp = cmd;
2231 io_header.cmd_len = sizeof(cmd);
2232 io_header.mx_sb_len = sizeof(sensebuf);
2233 io_header.sbp = sensebuf;
2234 io_header.timeout = 6000; /* XXX */
2236 ret = bdrv_ioctl(bdrv, SG_IO, &io_header);
2237 if (ret < 0 || io_header.driver_status || io_header.host_status) {
2238 return -1;
2240 s->qdev.type = buf[0];
2241 if (buf[1] & 0x80) {
2242 s->features |= 1 << SCSI_DISK_F_REMOVABLE;
2244 return 0;
2247 static int scsi_block_initfn(SCSIDevice *dev)
2249 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
2250 int sg_version;
2251 int rc;
2253 if (!s->qdev.conf.bs) {
2254 error_report("scsi-block: drive property not set");
2255 return -1;
2258 /* check we are using a driver managing SG_IO (version 3 and after) */
2259 if (bdrv_ioctl(s->qdev.conf.bs, SG_GET_VERSION_NUM, &sg_version) < 0 ||
2260 sg_version < 30000) {
2261 error_report("scsi-block: scsi generic interface too old");
2262 return -1;
2265 /* get device type from INQUIRY data */
2266 rc = get_device_type(s);
2267 if (rc < 0) {
2268 error_report("scsi-block: INQUIRY failed");
2269 return -1;
2272 /* Make a guess for the block size, we'll fix it when the guest sends.
2273 * READ CAPACITY. If they don't, they likely would assume these sizes
2274 * anyway. (TODO: check in /sys).
2276 if (s->qdev.type == TYPE_ROM || s->qdev.type == TYPE_WORM) {
2277 s->qdev.blocksize = 2048;
2278 } else {
2279 s->qdev.blocksize = 512;
2281 return scsi_initfn(&s->qdev);
2284 static SCSIRequest *scsi_block_new_request(SCSIDevice *d, uint32_t tag,
2285 uint32_t lun, uint8_t *buf,
2286 void *hba_private)
2288 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, d);
2290 switch (buf[0]) {
2291 case READ_6:
2292 case READ_10:
2293 case READ_12:
2294 case READ_16:
2295 case VERIFY_10:
2296 case VERIFY_12:
2297 case VERIFY_16:
2298 case WRITE_6:
2299 case WRITE_10:
2300 case WRITE_12:
2301 case WRITE_16:
2302 case WRITE_VERIFY_10:
2303 case WRITE_VERIFY_12:
2304 case WRITE_VERIFY_16:
2305 /* If we are not using O_DIRECT, we might read stale data from the
2306 * host cache if writes were made using other commands than these
2307 * ones (such as WRITE SAME or EXTENDED COPY, etc.). So, without
2308 * O_DIRECT everything must go through SG_IO.
2310 if (bdrv_get_flags(s->qdev.conf.bs) & BDRV_O_NOCACHE) {
2311 break;
2314 /* MMC writing cannot be done via pread/pwrite, because it sometimes
2315 * involves writing beyond the maximum LBA or to negative LBA (lead-in).
2316 * And once you do these writes, reading from the block device is
2317 * unreliable, too. It is even possible that reads deliver random data
2318 * from the host page cache (this is probably a Linux bug).
2320 * We might use scsi_disk_dma_reqops as long as no writing commands are
2321 * seen, but performance usually isn't paramount on optical media. So,
2322 * just make scsi-block operate the same as scsi-generic for them.
2324 if (s->qdev.type != TYPE_ROM) {
2325 return scsi_req_alloc(&scsi_disk_dma_reqops, &s->qdev, tag, lun,
2326 hba_private);
2330 return scsi_req_alloc(&scsi_generic_req_ops, &s->qdev, tag, lun,
2331 hba_private);
2333 #endif
2335 #define DEFINE_SCSI_DISK_PROPERTIES() \
2336 DEFINE_BLOCK_PROPERTIES(SCSIDiskState, qdev.conf), \
2337 DEFINE_PROP_STRING("ver", SCSIDiskState, version), \
2338 DEFINE_PROP_STRING("serial", SCSIDiskState, serial), \
2339 DEFINE_PROP_STRING("vendor", SCSIDiskState, vendor), \
2340 DEFINE_PROP_STRING("product", SCSIDiskState, product)
2342 static Property scsi_hd_properties[] = {
2343 DEFINE_SCSI_DISK_PROPERTIES(),
2344 DEFINE_PROP_BIT("removable", SCSIDiskState, features,
2345 SCSI_DISK_F_REMOVABLE, false),
2346 DEFINE_PROP_BIT("dpofua", SCSIDiskState, features,
2347 SCSI_DISK_F_DPOFUA, false),
2348 DEFINE_PROP_HEX64("wwn", SCSIDiskState, wwn, 0),
2349 DEFINE_BLOCK_CHS_PROPERTIES(SCSIDiskState, qdev.conf),
2350 DEFINE_PROP_END_OF_LIST(),
2353 static const VMStateDescription vmstate_scsi_disk_state = {
2354 .name = "scsi-disk",
2355 .version_id = 1,
2356 .minimum_version_id = 1,
2357 .minimum_version_id_old = 1,
2358 .fields = (VMStateField[]) {
2359 VMSTATE_SCSI_DEVICE(qdev, SCSIDiskState),
2360 VMSTATE_BOOL(media_changed, SCSIDiskState),
2361 VMSTATE_BOOL(media_event, SCSIDiskState),
2362 VMSTATE_BOOL(eject_request, SCSIDiskState),
2363 VMSTATE_BOOL(tray_open, SCSIDiskState),
2364 VMSTATE_BOOL(tray_locked, SCSIDiskState),
2365 VMSTATE_END_OF_LIST()
2369 static void scsi_hd_class_initfn(ObjectClass *klass, void *data)
2371 DeviceClass *dc = DEVICE_CLASS(klass);
2372 SCSIDeviceClass *sc = SCSI_DEVICE_CLASS(klass);
2374 sc->init = scsi_hd_initfn;
2375 sc->destroy = scsi_destroy;
2376 sc->alloc_req = scsi_new_request;
2377 sc->unit_attention_reported = scsi_disk_unit_attention_reported;
2378 dc->fw_name = "disk";
2379 dc->desc = "virtual SCSI disk";
2380 dc->reset = scsi_disk_reset;
2381 dc->props = scsi_hd_properties;
2382 dc->vmsd = &vmstate_scsi_disk_state;
2385 static TypeInfo scsi_hd_info = {
2386 .name = "scsi-hd",
2387 .parent = TYPE_SCSI_DEVICE,
2388 .instance_size = sizeof(SCSIDiskState),
2389 .class_init = scsi_hd_class_initfn,
2392 static Property scsi_cd_properties[] = {
2393 DEFINE_SCSI_DISK_PROPERTIES(),
2394 DEFINE_PROP_HEX64("wwn", SCSIDiskState, wwn, 0),
2395 DEFINE_PROP_END_OF_LIST(),
2398 static void scsi_cd_class_initfn(ObjectClass *klass, void *data)
2400 DeviceClass *dc = DEVICE_CLASS(klass);
2401 SCSIDeviceClass *sc = SCSI_DEVICE_CLASS(klass);
2403 sc->init = scsi_cd_initfn;
2404 sc->destroy = scsi_destroy;
2405 sc->alloc_req = scsi_new_request;
2406 sc->unit_attention_reported = scsi_disk_unit_attention_reported;
2407 dc->fw_name = "disk";
2408 dc->desc = "virtual SCSI CD-ROM";
2409 dc->reset = scsi_disk_reset;
2410 dc->props = scsi_cd_properties;
2411 dc->vmsd = &vmstate_scsi_disk_state;
2414 static TypeInfo scsi_cd_info = {
2415 .name = "scsi-cd",
2416 .parent = TYPE_SCSI_DEVICE,
2417 .instance_size = sizeof(SCSIDiskState),
2418 .class_init = scsi_cd_class_initfn,
2421 #ifdef __linux__
2422 static Property scsi_block_properties[] = {
2423 DEFINE_PROP_DRIVE("drive", SCSIDiskState, qdev.conf.bs),
2424 DEFINE_PROP_END_OF_LIST(),
2427 static void scsi_block_class_initfn(ObjectClass *klass, void *data)
2429 DeviceClass *dc = DEVICE_CLASS(klass);
2430 SCSIDeviceClass *sc = SCSI_DEVICE_CLASS(klass);
2432 sc->init = scsi_block_initfn;
2433 sc->destroy = scsi_destroy;
2434 sc->alloc_req = scsi_block_new_request;
2435 dc->fw_name = "disk";
2436 dc->desc = "SCSI block device passthrough";
2437 dc->reset = scsi_disk_reset;
2438 dc->props = scsi_block_properties;
2439 dc->vmsd = &vmstate_scsi_disk_state;
2442 static TypeInfo scsi_block_info = {
2443 .name = "scsi-block",
2444 .parent = TYPE_SCSI_DEVICE,
2445 .instance_size = sizeof(SCSIDiskState),
2446 .class_init = scsi_block_class_initfn,
2448 #endif
2450 static Property scsi_disk_properties[] = {
2451 DEFINE_SCSI_DISK_PROPERTIES(),
2452 DEFINE_PROP_BIT("removable", SCSIDiskState, features,
2453 SCSI_DISK_F_REMOVABLE, false),
2454 DEFINE_PROP_BIT("dpofua", SCSIDiskState, features,
2455 SCSI_DISK_F_DPOFUA, false),
2456 DEFINE_PROP_HEX64("wwn", SCSIDiskState, wwn, 0),
2457 DEFINE_PROP_END_OF_LIST(),
2460 static void scsi_disk_class_initfn(ObjectClass *klass, void *data)
2462 DeviceClass *dc = DEVICE_CLASS(klass);
2463 SCSIDeviceClass *sc = SCSI_DEVICE_CLASS(klass);
2465 sc->init = scsi_disk_initfn;
2466 sc->destroy = scsi_destroy;
2467 sc->alloc_req = scsi_new_request;
2468 sc->unit_attention_reported = scsi_disk_unit_attention_reported;
2469 dc->fw_name = "disk";
2470 dc->desc = "virtual SCSI disk or CD-ROM (legacy)";
2471 dc->reset = scsi_disk_reset;
2472 dc->props = scsi_disk_properties;
2473 dc->vmsd = &vmstate_scsi_disk_state;
2476 static TypeInfo scsi_disk_info = {
2477 .name = "scsi-disk",
2478 .parent = TYPE_SCSI_DEVICE,
2479 .instance_size = sizeof(SCSIDiskState),
2480 .class_init = scsi_disk_class_initfn,
2483 static void scsi_disk_register_types(void)
2485 type_register_static(&scsi_hd_info);
2486 type_register_static(&scsi_cd_info);
2487 #ifdef __linux__
2488 type_register_static(&scsi_block_info);
2489 #endif
2490 type_register_static(&scsi_disk_info);
2493 type_init(scsi_disk_register_types)