Merge remote-tracking branch 'remotes/kevin/tags/for-upstream' into staging
[qemu/ar7.git] / hw / scsi / scsi-disk.c
blobf5ab767ab5d1a09e895b9bf1534d5cb07dec1e23
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/osdep.h"
32 #include "qapi/error.h"
33 #include "qemu/error-report.h"
34 #include "hw/scsi/scsi.h"
35 #include "scsi/constants.h"
36 #include "sysemu/sysemu.h"
37 #include "sysemu/block-backend.h"
38 #include "sysemu/blockdev.h"
39 #include "hw/block/block.h"
40 #include "sysemu/dma.h"
41 #include "qemu/cutils.h"
43 #ifdef __linux
44 #include <scsi/sg.h>
45 #endif
47 #define SCSI_WRITE_SAME_MAX 524288
48 #define SCSI_DMA_BUF_SIZE 131072
49 #define SCSI_MAX_INQUIRY_LEN 256
50 #define SCSI_MAX_MODE_LEN 256
52 #define DEFAULT_DISCARD_GRANULARITY 4096
53 #define DEFAULT_MAX_UNMAP_SIZE (1 << 30) /* 1 GB */
54 #define DEFAULT_MAX_IO_SIZE INT_MAX /* 2 GB - 1 block */
56 #define TYPE_SCSI_DISK_BASE "scsi-disk-base"
58 #define SCSI_DISK_BASE(obj) \
59 OBJECT_CHECK(SCSIDiskState, (obj), TYPE_SCSI_DISK_BASE)
60 #define SCSI_DISK_BASE_CLASS(klass) \
61 OBJECT_CLASS_CHECK(SCSIDiskClass, (klass), TYPE_SCSI_DISK_BASE)
62 #define SCSI_DISK_BASE_GET_CLASS(obj) \
63 OBJECT_GET_CLASS(SCSIDiskClass, (obj), TYPE_SCSI_DISK_BASE)
65 typedef struct SCSIDiskClass {
66 SCSIDeviceClass parent_class;
67 DMAIOFunc *dma_readv;
68 DMAIOFunc *dma_writev;
69 bool (*need_fua_emulation)(SCSICommand *cmd);
70 } SCSIDiskClass;
72 typedef struct SCSIDiskReq {
73 SCSIRequest req;
74 /* Both sector and sector_count are in terms of qemu 512 byte blocks. */
75 uint64_t sector;
76 uint32_t sector_count;
77 uint32_t buflen;
78 bool started;
79 bool need_fua_emulation;
80 struct iovec iov;
81 QEMUIOVector qiov;
82 BlockAcctCookie acct;
83 unsigned char *status;
84 } SCSIDiskReq;
86 #define SCSI_DISK_F_REMOVABLE 0
87 #define SCSI_DISK_F_DPOFUA 1
88 #define SCSI_DISK_F_NO_REMOVABLE_DEVOPS 2
90 typedef struct SCSIDiskState
92 SCSIDevice qdev;
93 uint32_t features;
94 bool media_changed;
95 bool media_event;
96 bool eject_request;
97 uint16_t port_index;
98 uint64_t max_unmap_size;
99 uint64_t max_io_size;
100 QEMUBH *bh;
101 char *version;
102 char *serial;
103 char *vendor;
104 char *product;
105 bool tray_open;
106 bool tray_locked;
108 * 0x0000 - rotation rate not reported
109 * 0x0001 - non-rotating medium (SSD)
110 * 0x0002-0x0400 - reserved
111 * 0x0401-0xffe - rotations per minute
112 * 0xffff - reserved
114 uint16_t rotation_rate;
115 } SCSIDiskState;
117 static bool scsi_handle_rw_error(SCSIDiskReq *r, int error, bool acct_failed);
119 static void scsi_free_request(SCSIRequest *req)
121 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
123 qemu_vfree(r->iov.iov_base);
126 /* Helper function for command completion with sense. */
127 static void scsi_check_condition(SCSIDiskReq *r, SCSISense sense)
129 DPRINTF("Command complete tag=0x%x sense=%d/%d/%d\n",
130 r->req.tag, sense.key, sense.asc, sense.ascq);
131 scsi_req_build_sense(&r->req, sense);
132 scsi_req_complete(&r->req, CHECK_CONDITION);
135 static void scsi_init_iovec(SCSIDiskReq *r, size_t size)
137 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
139 if (!r->iov.iov_base) {
140 r->buflen = size;
141 r->iov.iov_base = blk_blockalign(s->qdev.conf.blk, r->buflen);
143 r->iov.iov_len = MIN(r->sector_count * 512, r->buflen);
144 qemu_iovec_init_external(&r->qiov, &r->iov, 1);
147 static void scsi_disk_save_request(QEMUFile *f, SCSIRequest *req)
149 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
151 qemu_put_be64s(f, &r->sector);
152 qemu_put_be32s(f, &r->sector_count);
153 qemu_put_be32s(f, &r->buflen);
154 if (r->buflen) {
155 if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
156 qemu_put_buffer(f, r->iov.iov_base, r->iov.iov_len);
157 } else if (!req->retry) {
158 uint32_t len = r->iov.iov_len;
159 qemu_put_be32s(f, &len);
160 qemu_put_buffer(f, r->iov.iov_base, r->iov.iov_len);
165 static void scsi_disk_load_request(QEMUFile *f, SCSIRequest *req)
167 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
169 qemu_get_be64s(f, &r->sector);
170 qemu_get_be32s(f, &r->sector_count);
171 qemu_get_be32s(f, &r->buflen);
172 if (r->buflen) {
173 scsi_init_iovec(r, r->buflen);
174 if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
175 qemu_get_buffer(f, r->iov.iov_base, r->iov.iov_len);
176 } else if (!r->req.retry) {
177 uint32_t len;
178 qemu_get_be32s(f, &len);
179 r->iov.iov_len = len;
180 assert(r->iov.iov_len <= r->buflen);
181 qemu_get_buffer(f, r->iov.iov_base, r->iov.iov_len);
185 qemu_iovec_init_external(&r->qiov, &r->iov, 1);
188 static bool scsi_disk_req_check_error(SCSIDiskReq *r, int ret, bool acct_failed)
190 if (r->req.io_canceled) {
191 scsi_req_cancel_complete(&r->req);
192 return true;
195 if (ret < 0 || (r->status && *r->status)) {
196 return scsi_handle_rw_error(r, -ret, acct_failed);
199 return false;
202 static void scsi_aio_complete(void *opaque, int ret)
204 SCSIDiskReq *r = (SCSIDiskReq *)opaque;
205 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
207 assert(r->req.aiocb != NULL);
208 r->req.aiocb = NULL;
209 aio_context_acquire(blk_get_aio_context(s->qdev.conf.blk));
210 if (scsi_disk_req_check_error(r, ret, true)) {
211 goto done;
214 block_acct_done(blk_get_stats(s->qdev.conf.blk), &r->acct);
215 scsi_req_complete(&r->req, GOOD);
217 done:
218 aio_context_release(blk_get_aio_context(s->qdev.conf.blk));
219 scsi_req_unref(&r->req);
222 static bool scsi_is_cmd_fua(SCSICommand *cmd)
224 switch (cmd->buf[0]) {
225 case READ_10:
226 case READ_12:
227 case READ_16:
228 case WRITE_10:
229 case WRITE_12:
230 case WRITE_16:
231 return (cmd->buf[1] & 8) != 0;
233 case VERIFY_10:
234 case VERIFY_12:
235 case VERIFY_16:
236 case WRITE_VERIFY_10:
237 case WRITE_VERIFY_12:
238 case WRITE_VERIFY_16:
239 return true;
241 case READ_6:
242 case WRITE_6:
243 default:
244 return false;
248 static void scsi_write_do_fua(SCSIDiskReq *r)
250 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
252 assert(r->req.aiocb == NULL);
253 assert(!r->req.io_canceled);
255 if (r->need_fua_emulation) {
256 block_acct_start(blk_get_stats(s->qdev.conf.blk), &r->acct, 0,
257 BLOCK_ACCT_FLUSH);
258 r->req.aiocb = blk_aio_flush(s->qdev.conf.blk, scsi_aio_complete, r);
259 return;
262 scsi_req_complete(&r->req, GOOD);
263 scsi_req_unref(&r->req);
266 static void scsi_dma_complete_noio(SCSIDiskReq *r, int ret)
268 assert(r->req.aiocb == NULL);
269 if (scsi_disk_req_check_error(r, ret, false)) {
270 goto done;
273 r->sector += r->sector_count;
274 r->sector_count = 0;
275 if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
276 scsi_write_do_fua(r);
277 return;
278 } else {
279 scsi_req_complete(&r->req, GOOD);
282 done:
283 scsi_req_unref(&r->req);
286 static void scsi_dma_complete(void *opaque, int ret)
288 SCSIDiskReq *r = (SCSIDiskReq *)opaque;
289 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
291 assert(r->req.aiocb != NULL);
292 r->req.aiocb = NULL;
294 aio_context_acquire(blk_get_aio_context(s->qdev.conf.blk));
295 if (ret < 0) {
296 block_acct_failed(blk_get_stats(s->qdev.conf.blk), &r->acct);
297 } else {
298 block_acct_done(blk_get_stats(s->qdev.conf.blk), &r->acct);
300 scsi_dma_complete_noio(r, ret);
301 aio_context_release(blk_get_aio_context(s->qdev.conf.blk));
304 static void scsi_read_complete(void * opaque, int ret)
306 SCSIDiskReq *r = (SCSIDiskReq *)opaque;
307 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
308 int n;
310 assert(r->req.aiocb != NULL);
311 r->req.aiocb = NULL;
312 aio_context_acquire(blk_get_aio_context(s->qdev.conf.blk));
313 if (scsi_disk_req_check_error(r, ret, true)) {
314 goto done;
317 block_acct_done(blk_get_stats(s->qdev.conf.blk), &r->acct);
318 DPRINTF("Data ready tag=0x%x len=%zd\n", r->req.tag, r->qiov.size);
320 n = r->qiov.size / 512;
321 r->sector += n;
322 r->sector_count -= n;
323 scsi_req_data(&r->req, r->qiov.size);
325 done:
326 scsi_req_unref(&r->req);
327 aio_context_release(blk_get_aio_context(s->qdev.conf.blk));
330 /* Actually issue a read to the block device. */
331 static void scsi_do_read(SCSIDiskReq *r, int ret)
333 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
334 SCSIDiskClass *sdc = (SCSIDiskClass *) object_get_class(OBJECT(s));
336 assert (r->req.aiocb == NULL);
337 if (scsi_disk_req_check_error(r, ret, false)) {
338 goto done;
341 /* The request is used as the AIO opaque value, so add a ref. */
342 scsi_req_ref(&r->req);
344 if (r->req.sg) {
345 dma_acct_start(s->qdev.conf.blk, &r->acct, r->req.sg, BLOCK_ACCT_READ);
346 r->req.resid -= r->req.sg->size;
347 r->req.aiocb = dma_blk_io(blk_get_aio_context(s->qdev.conf.blk),
348 r->req.sg, r->sector << BDRV_SECTOR_BITS,
349 BDRV_SECTOR_SIZE,
350 sdc->dma_readv, r, scsi_dma_complete, r,
351 DMA_DIRECTION_FROM_DEVICE);
352 } else {
353 scsi_init_iovec(r, SCSI_DMA_BUF_SIZE);
354 block_acct_start(blk_get_stats(s->qdev.conf.blk), &r->acct,
355 r->qiov.size, BLOCK_ACCT_READ);
356 r->req.aiocb = sdc->dma_readv(r->sector << BDRV_SECTOR_BITS, &r->qiov,
357 scsi_read_complete, r, r);
360 done:
361 scsi_req_unref(&r->req);
364 static void scsi_do_read_cb(void *opaque, int ret)
366 SCSIDiskReq *r = (SCSIDiskReq *)opaque;
367 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
369 assert (r->req.aiocb != NULL);
370 r->req.aiocb = NULL;
372 aio_context_acquire(blk_get_aio_context(s->qdev.conf.blk));
373 if (ret < 0) {
374 block_acct_failed(blk_get_stats(s->qdev.conf.blk), &r->acct);
375 } else {
376 block_acct_done(blk_get_stats(s->qdev.conf.blk), &r->acct);
378 scsi_do_read(opaque, ret);
379 aio_context_release(blk_get_aio_context(s->qdev.conf.blk));
382 /* Read more data from scsi device into buffer. */
383 static void scsi_read_data(SCSIRequest *req)
385 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
386 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
387 bool first;
389 DPRINTF("Read sector_count=%d\n", r->sector_count);
390 if (r->sector_count == 0) {
391 /* This also clears the sense buffer for REQUEST SENSE. */
392 scsi_req_complete(&r->req, GOOD);
393 return;
396 /* No data transfer may already be in progress */
397 assert(r->req.aiocb == NULL);
399 /* The request is used as the AIO opaque value, so add a ref. */
400 scsi_req_ref(&r->req);
401 if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
402 DPRINTF("Data transfer direction invalid\n");
403 scsi_read_complete(r, -EINVAL);
404 return;
407 if (!blk_is_available(req->dev->conf.blk)) {
408 scsi_read_complete(r, -ENOMEDIUM);
409 return;
412 first = !r->started;
413 r->started = true;
414 if (first && r->need_fua_emulation) {
415 block_acct_start(blk_get_stats(s->qdev.conf.blk), &r->acct, 0,
416 BLOCK_ACCT_FLUSH);
417 r->req.aiocb = blk_aio_flush(s->qdev.conf.blk, scsi_do_read_cb, r);
418 } else {
419 scsi_do_read(r, 0);
424 * scsi_handle_rw_error has two return values. False means that the error
425 * must be ignored, true means that the error has been processed and the
426 * caller should not do anything else for this request. Note that
427 * scsi_handle_rw_error always manages its reference counts, independent
428 * of the return value.
430 static bool scsi_handle_rw_error(SCSIDiskReq *r, int error, bool acct_failed)
432 bool is_read = (r->req.cmd.mode == SCSI_XFER_FROM_DEV);
433 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
434 BlockErrorAction action = blk_get_error_action(s->qdev.conf.blk,
435 is_read, error);
437 if (action == BLOCK_ERROR_ACTION_REPORT) {
438 if (acct_failed) {
439 block_acct_failed(blk_get_stats(s->qdev.conf.blk), &r->acct);
441 switch (error) {
442 case 0:
443 /* The command has run, no need to fake sense. */
444 assert(r->status && *r->status);
445 scsi_req_complete(&r->req, *r->status);
446 break;
447 case ENOMEDIUM:
448 scsi_check_condition(r, SENSE_CODE(NO_MEDIUM));
449 break;
450 case ENOMEM:
451 scsi_check_condition(r, SENSE_CODE(TARGET_FAILURE));
452 break;
453 case EINVAL:
454 scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
455 break;
456 case ENOSPC:
457 scsi_check_condition(r, SENSE_CODE(SPACE_ALLOC_FAILED));
458 break;
459 default:
460 scsi_check_condition(r, SENSE_CODE(IO_ERROR));
461 break;
464 if (!error) {
465 assert(r->status && *r->status);
466 error = scsi_sense_buf_to_errno(r->req.sense, sizeof(r->req.sense));
468 if (error == ECANCELED || error == EAGAIN || error == ENOTCONN ||
469 error == 0) {
470 /* These errors are handled by guest. */
471 scsi_req_complete(&r->req, *r->status);
472 return true;
476 blk_error_action(s->qdev.conf.blk, action, is_read, error);
477 if (action == BLOCK_ERROR_ACTION_STOP) {
478 scsi_req_retry(&r->req);
480 return action != BLOCK_ERROR_ACTION_IGNORE;
483 static void scsi_write_complete_noio(SCSIDiskReq *r, int ret)
485 uint32_t n;
487 assert (r->req.aiocb == NULL);
488 if (scsi_disk_req_check_error(r, ret, false)) {
489 goto done;
492 n = r->qiov.size / 512;
493 r->sector += n;
494 r->sector_count -= n;
495 if (r->sector_count == 0) {
496 scsi_write_do_fua(r);
497 return;
498 } else {
499 scsi_init_iovec(r, SCSI_DMA_BUF_SIZE);
500 DPRINTF("Write complete tag=0x%x more=%zd\n", r->req.tag, r->qiov.size);
501 scsi_req_data(&r->req, r->qiov.size);
504 done:
505 scsi_req_unref(&r->req);
508 static void scsi_write_complete(void * opaque, int ret)
510 SCSIDiskReq *r = (SCSIDiskReq *)opaque;
511 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
513 assert (r->req.aiocb != NULL);
514 r->req.aiocb = NULL;
516 aio_context_acquire(blk_get_aio_context(s->qdev.conf.blk));
517 if (ret < 0) {
518 block_acct_failed(blk_get_stats(s->qdev.conf.blk), &r->acct);
519 } else {
520 block_acct_done(blk_get_stats(s->qdev.conf.blk), &r->acct);
522 scsi_write_complete_noio(r, ret);
523 aio_context_release(blk_get_aio_context(s->qdev.conf.blk));
526 static void scsi_write_data(SCSIRequest *req)
528 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
529 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
530 SCSIDiskClass *sdc = (SCSIDiskClass *) object_get_class(OBJECT(s));
532 /* No data transfer may already be in progress */
533 assert(r->req.aiocb == NULL);
535 /* The request is used as the AIO opaque value, so add a ref. */
536 scsi_req_ref(&r->req);
537 if (r->req.cmd.mode != SCSI_XFER_TO_DEV) {
538 DPRINTF("Data transfer direction invalid\n");
539 scsi_write_complete_noio(r, -EINVAL);
540 return;
543 if (!r->req.sg && !r->qiov.size) {
544 /* Called for the first time. Ask the driver to send us more data. */
545 r->started = true;
546 scsi_write_complete_noio(r, 0);
547 return;
549 if (!blk_is_available(req->dev->conf.blk)) {
550 scsi_write_complete_noio(r, -ENOMEDIUM);
551 return;
554 if (r->req.cmd.buf[0] == VERIFY_10 || r->req.cmd.buf[0] == VERIFY_12 ||
555 r->req.cmd.buf[0] == VERIFY_16) {
556 if (r->req.sg) {
557 scsi_dma_complete_noio(r, 0);
558 } else {
559 scsi_write_complete_noio(r, 0);
561 return;
564 if (r->req.sg) {
565 dma_acct_start(s->qdev.conf.blk, &r->acct, r->req.sg, BLOCK_ACCT_WRITE);
566 r->req.resid -= r->req.sg->size;
567 r->req.aiocb = dma_blk_io(blk_get_aio_context(s->qdev.conf.blk),
568 r->req.sg, r->sector << BDRV_SECTOR_BITS,
569 BDRV_SECTOR_SIZE,
570 sdc->dma_writev, r, scsi_dma_complete, r,
571 DMA_DIRECTION_TO_DEVICE);
572 } else {
573 block_acct_start(blk_get_stats(s->qdev.conf.blk), &r->acct,
574 r->qiov.size, BLOCK_ACCT_WRITE);
575 r->req.aiocb = sdc->dma_writev(r->sector << BDRV_SECTOR_BITS, &r->qiov,
576 scsi_write_complete, r, r);
580 /* Return a pointer to the data buffer. */
581 static uint8_t *scsi_get_buf(SCSIRequest *req)
583 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
585 return (uint8_t *)r->iov.iov_base;
588 static int scsi_disk_emulate_inquiry(SCSIRequest *req, uint8_t *outbuf)
590 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
591 int buflen = 0;
592 int start;
594 if (req->cmd.buf[1] & 0x1) {
595 /* Vital product data */
596 uint8_t page_code = req->cmd.buf[2];
598 outbuf[buflen++] = s->qdev.type & 0x1f;
599 outbuf[buflen++] = page_code ; // this page
600 outbuf[buflen++] = 0x00;
601 outbuf[buflen++] = 0x00;
602 start = buflen;
604 switch (page_code) {
605 case 0x00: /* Supported page codes, mandatory */
607 DPRINTF("Inquiry EVPD[Supported pages] "
608 "buffer size %zd\n", req->cmd.xfer);
609 outbuf[buflen++] = 0x00; // list of supported pages (this page)
610 if (s->serial) {
611 outbuf[buflen++] = 0x80; // unit serial number
613 outbuf[buflen++] = 0x83; // device identification
614 if (s->qdev.type == TYPE_DISK) {
615 outbuf[buflen++] = 0xb0; // block limits
616 outbuf[buflen++] = 0xb1; /* block device characteristics */
617 outbuf[buflen++] = 0xb2; // thin provisioning
619 break;
621 case 0x80: /* Device serial number, optional */
623 int l;
625 if (!s->serial) {
626 DPRINTF("Inquiry (EVPD[Serial number] not supported\n");
627 return -1;
630 l = strlen(s->serial);
631 if (l > 36) {
632 l = 36;
635 DPRINTF("Inquiry EVPD[Serial number] "
636 "buffer size %zd\n", req->cmd.xfer);
637 memcpy(outbuf+buflen, s->serial, l);
638 buflen += l;
639 break;
642 case 0x83: /* Device identification page, mandatory */
644 const char *str = s->serial ?: blk_name(s->qdev.conf.blk);
645 int max_len = s->serial ? 20 : 255 - 8;
646 int id_len = strlen(str);
648 if (id_len > max_len) {
649 id_len = max_len;
651 DPRINTF("Inquiry EVPD[Device identification] "
652 "buffer size %zd\n", req->cmd.xfer);
654 outbuf[buflen++] = 0x2; // ASCII
655 outbuf[buflen++] = 0; // not officially assigned
656 outbuf[buflen++] = 0; // reserved
657 outbuf[buflen++] = id_len; // length of data following
658 memcpy(outbuf+buflen, str, id_len);
659 buflen += id_len;
661 if (s->qdev.wwn) {
662 outbuf[buflen++] = 0x1; // Binary
663 outbuf[buflen++] = 0x3; // NAA
664 outbuf[buflen++] = 0; // reserved
665 outbuf[buflen++] = 8;
666 stq_be_p(&outbuf[buflen], s->qdev.wwn);
667 buflen += 8;
670 if (s->qdev.port_wwn) {
671 outbuf[buflen++] = 0x61; // SAS / Binary
672 outbuf[buflen++] = 0x93; // PIV / Target port / NAA
673 outbuf[buflen++] = 0; // reserved
674 outbuf[buflen++] = 8;
675 stq_be_p(&outbuf[buflen], s->qdev.port_wwn);
676 buflen += 8;
679 if (s->port_index) {
680 outbuf[buflen++] = 0x61; // SAS / Binary
681 outbuf[buflen++] = 0x94; // PIV / Target port / relative target port
682 outbuf[buflen++] = 0; // reserved
683 outbuf[buflen++] = 4;
684 stw_be_p(&outbuf[buflen + 2], s->port_index);
685 buflen += 4;
687 break;
689 case 0xb0: /* block limits */
691 unsigned int unmap_sectors =
692 s->qdev.conf.discard_granularity / s->qdev.blocksize;
693 unsigned int min_io_size =
694 s->qdev.conf.min_io_size / s->qdev.blocksize;
695 unsigned int opt_io_size =
696 s->qdev.conf.opt_io_size / s->qdev.blocksize;
697 unsigned int max_unmap_sectors =
698 s->max_unmap_size / s->qdev.blocksize;
699 unsigned int max_io_sectors =
700 s->max_io_size / s->qdev.blocksize;
702 if (s->qdev.type == TYPE_ROM) {
703 DPRINTF("Inquiry (EVPD[%02X] not supported for CDROM\n",
704 page_code);
705 return -1;
707 if (s->qdev.type == TYPE_DISK) {
708 int max_transfer_blk = blk_get_max_transfer(s->qdev.conf.blk);
709 int max_io_sectors_blk =
710 max_transfer_blk / s->qdev.blocksize;
712 max_io_sectors =
713 MIN_NON_ZERO(max_io_sectors_blk, max_io_sectors);
715 /* min_io_size and opt_io_size can't be greater than
716 * max_io_sectors */
717 min_io_size =
718 MIN_NON_ZERO(min_io_size, max_io_sectors);
719 opt_io_size =
720 MIN_NON_ZERO(opt_io_size, max_io_sectors);
722 /* required VPD size with unmap support */
723 buflen = 0x40;
724 memset(outbuf + 4, 0, buflen - 4);
726 outbuf[4] = 0x1; /* wsnz */
728 /* optimal transfer length granularity */
729 outbuf[6] = (min_io_size >> 8) & 0xff;
730 outbuf[7] = min_io_size & 0xff;
732 /* maximum transfer length */
733 outbuf[8] = (max_io_sectors >> 24) & 0xff;
734 outbuf[9] = (max_io_sectors >> 16) & 0xff;
735 outbuf[10] = (max_io_sectors >> 8) & 0xff;
736 outbuf[11] = max_io_sectors & 0xff;
738 /* optimal transfer length */
739 outbuf[12] = (opt_io_size >> 24) & 0xff;
740 outbuf[13] = (opt_io_size >> 16) & 0xff;
741 outbuf[14] = (opt_io_size >> 8) & 0xff;
742 outbuf[15] = opt_io_size & 0xff;
744 /* max unmap LBA count, default is 1GB */
745 outbuf[20] = (max_unmap_sectors >> 24) & 0xff;
746 outbuf[21] = (max_unmap_sectors >> 16) & 0xff;
747 outbuf[22] = (max_unmap_sectors >> 8) & 0xff;
748 outbuf[23] = max_unmap_sectors & 0xff;
750 /* max unmap descriptors, 255 fit in 4 kb with an 8-byte header. */
751 outbuf[24] = 0;
752 outbuf[25] = 0;
753 outbuf[26] = 0;
754 outbuf[27] = 255;
756 /* optimal unmap granularity */
757 outbuf[28] = (unmap_sectors >> 24) & 0xff;
758 outbuf[29] = (unmap_sectors >> 16) & 0xff;
759 outbuf[30] = (unmap_sectors >> 8) & 0xff;
760 outbuf[31] = unmap_sectors & 0xff;
762 /* max write same size */
763 outbuf[36] = 0;
764 outbuf[37] = 0;
765 outbuf[38] = 0;
766 outbuf[39] = 0;
768 outbuf[40] = (max_io_sectors >> 24) & 0xff;
769 outbuf[41] = (max_io_sectors >> 16) & 0xff;
770 outbuf[42] = (max_io_sectors >> 8) & 0xff;
771 outbuf[43] = max_io_sectors & 0xff;
772 break;
774 case 0xb1: /* block device characteristics */
776 buflen = 8;
777 outbuf[4] = (s->rotation_rate >> 8) & 0xff;
778 outbuf[5] = s->rotation_rate & 0xff;
779 outbuf[6] = 0;
780 outbuf[7] = 0;
781 break;
783 case 0xb2: /* thin provisioning */
785 buflen = 8;
786 outbuf[4] = 0;
787 outbuf[5] = 0xe0; /* unmap & write_same 10/16 all supported */
788 outbuf[6] = s->qdev.conf.discard_granularity ? 2 : 1;
789 outbuf[7] = 0;
790 break;
792 default:
793 return -1;
795 /* done with EVPD */
796 assert(buflen - start <= 255);
797 outbuf[start - 1] = buflen - start;
798 return buflen;
801 /* Standard INQUIRY data */
802 if (req->cmd.buf[2] != 0) {
803 return -1;
806 /* PAGE CODE == 0 */
807 buflen = req->cmd.xfer;
808 if (buflen > SCSI_MAX_INQUIRY_LEN) {
809 buflen = SCSI_MAX_INQUIRY_LEN;
812 outbuf[0] = s->qdev.type & 0x1f;
813 outbuf[1] = (s->features & (1 << SCSI_DISK_F_REMOVABLE)) ? 0x80 : 0;
815 strpadcpy((char *) &outbuf[16], 16, s->product, ' ');
816 strpadcpy((char *) &outbuf[8], 8, s->vendor, ' ');
818 memset(&outbuf[32], 0, 4);
819 memcpy(&outbuf[32], s->version, MIN(4, strlen(s->version)));
821 * We claim conformance to SPC-3, which is required for guests
822 * to ask for modern features like READ CAPACITY(16) or the
823 * block characteristics VPD page by default. Not all of SPC-3
824 * is actually implemented, but we're good enough.
826 outbuf[2] = 5;
827 outbuf[3] = 2 | 0x10; /* Format 2, HiSup */
829 if (buflen > 36) {
830 outbuf[4] = buflen - 5; /* Additional Length = (Len - 1) - 4 */
831 } else {
832 /* If the allocation length of CDB is too small,
833 the additional length is not adjusted */
834 outbuf[4] = 36 - 5;
837 /* Sync data transfer and TCQ. */
838 outbuf[7] = 0x10 | (req->bus->info->tcq ? 0x02 : 0);
839 return buflen;
842 static inline bool media_is_dvd(SCSIDiskState *s)
844 uint64_t nb_sectors;
845 if (s->qdev.type != TYPE_ROM) {
846 return false;
848 if (!blk_is_available(s->qdev.conf.blk)) {
849 return false;
851 blk_get_geometry(s->qdev.conf.blk, &nb_sectors);
852 return nb_sectors > CD_MAX_SECTORS;
855 static inline bool media_is_cd(SCSIDiskState *s)
857 uint64_t nb_sectors;
858 if (s->qdev.type != TYPE_ROM) {
859 return false;
861 if (!blk_is_available(s->qdev.conf.blk)) {
862 return false;
864 blk_get_geometry(s->qdev.conf.blk, &nb_sectors);
865 return nb_sectors <= CD_MAX_SECTORS;
868 static int scsi_read_disc_information(SCSIDiskState *s, SCSIDiskReq *r,
869 uint8_t *outbuf)
871 uint8_t type = r->req.cmd.buf[1] & 7;
873 if (s->qdev.type != TYPE_ROM) {
874 return -1;
877 /* Types 1/2 are only defined for Blu-Ray. */
878 if (type != 0) {
879 scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
880 return -1;
883 memset(outbuf, 0, 34);
884 outbuf[1] = 32;
885 outbuf[2] = 0xe; /* last session complete, disc finalized */
886 outbuf[3] = 1; /* first track on disc */
887 outbuf[4] = 1; /* # of sessions */
888 outbuf[5] = 1; /* first track of last session */
889 outbuf[6] = 1; /* last track of last session */
890 outbuf[7] = 0x20; /* unrestricted use */
891 outbuf[8] = 0x00; /* CD-ROM or DVD-ROM */
892 /* 9-10-11: most significant byte corresponding bytes 4-5-6 */
893 /* 12-23: not meaningful for CD-ROM or DVD-ROM */
894 /* 24-31: disc bar code */
895 /* 32: disc application code */
896 /* 33: number of OPC tables */
898 return 34;
901 static int scsi_read_dvd_structure(SCSIDiskState *s, SCSIDiskReq *r,
902 uint8_t *outbuf)
904 static const int rds_caps_size[5] = {
905 [0] = 2048 + 4,
906 [1] = 4 + 4,
907 [3] = 188 + 4,
908 [4] = 2048 + 4,
911 uint8_t media = r->req.cmd.buf[1];
912 uint8_t layer = r->req.cmd.buf[6];
913 uint8_t format = r->req.cmd.buf[7];
914 int size = -1;
916 if (s->qdev.type != TYPE_ROM) {
917 return -1;
919 if (media != 0) {
920 scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
921 return -1;
924 if (format != 0xff) {
925 if (!blk_is_available(s->qdev.conf.blk)) {
926 scsi_check_condition(r, SENSE_CODE(NO_MEDIUM));
927 return -1;
929 if (media_is_cd(s)) {
930 scsi_check_condition(r, SENSE_CODE(INCOMPATIBLE_FORMAT));
931 return -1;
933 if (format >= ARRAY_SIZE(rds_caps_size)) {
934 return -1;
936 size = rds_caps_size[format];
937 memset(outbuf, 0, size);
940 switch (format) {
941 case 0x00: {
942 /* Physical format information */
943 uint64_t nb_sectors;
944 if (layer != 0) {
945 goto fail;
947 blk_get_geometry(s->qdev.conf.blk, &nb_sectors);
949 outbuf[4] = 1; /* DVD-ROM, part version 1 */
950 outbuf[5] = 0xf; /* 120mm disc, minimum rate unspecified */
951 outbuf[6] = 1; /* one layer, read-only (per MMC-2 spec) */
952 outbuf[7] = 0; /* default densities */
954 stl_be_p(&outbuf[12], (nb_sectors >> 2) - 1); /* end sector */
955 stl_be_p(&outbuf[16], (nb_sectors >> 2) - 1); /* l0 end sector */
956 break;
959 case 0x01: /* DVD copyright information, all zeros */
960 break;
962 case 0x03: /* BCA information - invalid field for no BCA info */
963 return -1;
965 case 0x04: /* DVD disc manufacturing information, all zeros */
966 break;
968 case 0xff: { /* List capabilities */
969 int i;
970 size = 4;
971 for (i = 0; i < ARRAY_SIZE(rds_caps_size); i++) {
972 if (!rds_caps_size[i]) {
973 continue;
975 outbuf[size] = i;
976 outbuf[size + 1] = 0x40; /* Not writable, readable */
977 stw_be_p(&outbuf[size + 2], rds_caps_size[i]);
978 size += 4;
980 break;
983 default:
984 return -1;
987 /* Size of buffer, not including 2 byte size field */
988 stw_be_p(outbuf, size - 2);
989 return size;
991 fail:
992 return -1;
995 static int scsi_event_status_media(SCSIDiskState *s, uint8_t *outbuf)
997 uint8_t event_code, media_status;
999 media_status = 0;
1000 if (s->tray_open) {
1001 media_status = MS_TRAY_OPEN;
1002 } else if (blk_is_inserted(s->qdev.conf.blk)) {
1003 media_status = MS_MEDIA_PRESENT;
1006 /* Event notification descriptor */
1007 event_code = MEC_NO_CHANGE;
1008 if (media_status != MS_TRAY_OPEN) {
1009 if (s->media_event) {
1010 event_code = MEC_NEW_MEDIA;
1011 s->media_event = false;
1012 } else if (s->eject_request) {
1013 event_code = MEC_EJECT_REQUESTED;
1014 s->eject_request = false;
1018 outbuf[0] = event_code;
1019 outbuf[1] = media_status;
1021 /* These fields are reserved, just clear them. */
1022 outbuf[2] = 0;
1023 outbuf[3] = 0;
1024 return 4;
1027 static int scsi_get_event_status_notification(SCSIDiskState *s, SCSIDiskReq *r,
1028 uint8_t *outbuf)
1030 int size;
1031 uint8_t *buf = r->req.cmd.buf;
1032 uint8_t notification_class_request = buf[4];
1033 if (s->qdev.type != TYPE_ROM) {
1034 return -1;
1036 if ((buf[1] & 1) == 0) {
1037 /* asynchronous */
1038 return -1;
1041 size = 4;
1042 outbuf[0] = outbuf[1] = 0;
1043 outbuf[3] = 1 << GESN_MEDIA; /* supported events */
1044 if (notification_class_request & (1 << GESN_MEDIA)) {
1045 outbuf[2] = GESN_MEDIA;
1046 size += scsi_event_status_media(s, &outbuf[size]);
1047 } else {
1048 outbuf[2] = 0x80;
1050 stw_be_p(outbuf, size - 4);
1051 return size;
1054 static int scsi_get_configuration(SCSIDiskState *s, uint8_t *outbuf)
1056 int current;
1058 if (s->qdev.type != TYPE_ROM) {
1059 return -1;
1062 if (media_is_dvd(s)) {
1063 current = MMC_PROFILE_DVD_ROM;
1064 } else if (media_is_cd(s)) {
1065 current = MMC_PROFILE_CD_ROM;
1066 } else {
1067 current = MMC_PROFILE_NONE;
1070 memset(outbuf, 0, 40);
1071 stl_be_p(&outbuf[0], 36); /* Bytes after the data length field */
1072 stw_be_p(&outbuf[6], current);
1073 /* outbuf[8] - outbuf[19]: Feature 0 - Profile list */
1074 outbuf[10] = 0x03; /* persistent, current */
1075 outbuf[11] = 8; /* two profiles */
1076 stw_be_p(&outbuf[12], MMC_PROFILE_DVD_ROM);
1077 outbuf[14] = (current == MMC_PROFILE_DVD_ROM);
1078 stw_be_p(&outbuf[16], MMC_PROFILE_CD_ROM);
1079 outbuf[18] = (current == MMC_PROFILE_CD_ROM);
1080 /* outbuf[20] - outbuf[31]: Feature 1 - Core feature */
1081 stw_be_p(&outbuf[20], 1);
1082 outbuf[22] = 0x08 | 0x03; /* version 2, persistent, current */
1083 outbuf[23] = 8;
1084 stl_be_p(&outbuf[24], 1); /* SCSI */
1085 outbuf[28] = 1; /* DBE = 1, mandatory */
1086 /* outbuf[32] - outbuf[39]: Feature 3 - Removable media feature */
1087 stw_be_p(&outbuf[32], 3);
1088 outbuf[34] = 0x08 | 0x03; /* version 2, persistent, current */
1089 outbuf[35] = 4;
1090 outbuf[36] = 0x39; /* tray, load=1, eject=1, unlocked at powerup, lock=1 */
1091 /* TODO: Random readable, CD read, DVD read, drive serial number,
1092 power management */
1093 return 40;
1096 static int scsi_emulate_mechanism_status(SCSIDiskState *s, uint8_t *outbuf)
1098 if (s->qdev.type != TYPE_ROM) {
1099 return -1;
1101 memset(outbuf, 0, 8);
1102 outbuf[5] = 1; /* CD-ROM */
1103 return 8;
1106 static int mode_sense_page(SCSIDiskState *s, int page, uint8_t **p_outbuf,
1107 int page_control)
1109 static const int mode_sense_valid[0x3f] = {
1110 [MODE_PAGE_HD_GEOMETRY] = (1 << TYPE_DISK),
1111 [MODE_PAGE_FLEXIBLE_DISK_GEOMETRY] = (1 << TYPE_DISK),
1112 [MODE_PAGE_CACHING] = (1 << TYPE_DISK) | (1 << TYPE_ROM),
1113 [MODE_PAGE_R_W_ERROR] = (1 << TYPE_DISK) | (1 << TYPE_ROM),
1114 [MODE_PAGE_AUDIO_CTL] = (1 << TYPE_ROM),
1115 [MODE_PAGE_CAPABILITIES] = (1 << TYPE_ROM),
1118 uint8_t *p = *p_outbuf + 2;
1119 int length;
1121 if ((mode_sense_valid[page] & (1 << s->qdev.type)) == 0) {
1122 return -1;
1126 * If Changeable Values are requested, a mask denoting those mode parameters
1127 * that are changeable shall be returned. As we currently don't support
1128 * parameter changes via MODE_SELECT all bits are returned set to zero.
1129 * The buffer was already menset to zero by the caller of this function.
1131 * The offsets here are off by two compared to the descriptions in the
1132 * SCSI specs, because those include a 2-byte header. This is unfortunate,
1133 * but it is done so that offsets are consistent within our implementation
1134 * of MODE SENSE and MODE SELECT. MODE SELECT has to deal with both
1135 * 2-byte and 4-byte headers.
1137 switch (page) {
1138 case MODE_PAGE_HD_GEOMETRY:
1139 length = 0x16;
1140 if (page_control == 1) { /* Changeable Values */
1141 break;
1143 /* if a geometry hint is available, use it */
1144 p[0] = (s->qdev.conf.cyls >> 16) & 0xff;
1145 p[1] = (s->qdev.conf.cyls >> 8) & 0xff;
1146 p[2] = s->qdev.conf.cyls & 0xff;
1147 p[3] = s->qdev.conf.heads & 0xff;
1148 /* Write precomp start cylinder, disabled */
1149 p[4] = (s->qdev.conf.cyls >> 16) & 0xff;
1150 p[5] = (s->qdev.conf.cyls >> 8) & 0xff;
1151 p[6] = s->qdev.conf.cyls & 0xff;
1152 /* Reduced current start cylinder, disabled */
1153 p[7] = (s->qdev.conf.cyls >> 16) & 0xff;
1154 p[8] = (s->qdev.conf.cyls >> 8) & 0xff;
1155 p[9] = s->qdev.conf.cyls & 0xff;
1156 /* Device step rate [ns], 200ns */
1157 p[10] = 0;
1158 p[11] = 200;
1159 /* Landing zone cylinder */
1160 p[12] = 0xff;
1161 p[13] = 0xff;
1162 p[14] = 0xff;
1163 /* Medium rotation rate [rpm], 5400 rpm */
1164 p[18] = (5400 >> 8) & 0xff;
1165 p[19] = 5400 & 0xff;
1166 break;
1168 case MODE_PAGE_FLEXIBLE_DISK_GEOMETRY:
1169 length = 0x1e;
1170 if (page_control == 1) { /* Changeable Values */
1171 break;
1173 /* Transfer rate [kbit/s], 5Mbit/s */
1174 p[0] = 5000 >> 8;
1175 p[1] = 5000 & 0xff;
1176 /* if a geometry hint is available, use it */
1177 p[2] = s->qdev.conf.heads & 0xff;
1178 p[3] = s->qdev.conf.secs & 0xff;
1179 p[4] = s->qdev.blocksize >> 8;
1180 p[6] = (s->qdev.conf.cyls >> 8) & 0xff;
1181 p[7] = s->qdev.conf.cyls & 0xff;
1182 /* Write precomp start cylinder, disabled */
1183 p[8] = (s->qdev.conf.cyls >> 8) & 0xff;
1184 p[9] = s->qdev.conf.cyls & 0xff;
1185 /* Reduced current start cylinder, disabled */
1186 p[10] = (s->qdev.conf.cyls >> 8) & 0xff;
1187 p[11] = s->qdev.conf.cyls & 0xff;
1188 /* Device step rate [100us], 100us */
1189 p[12] = 0;
1190 p[13] = 1;
1191 /* Device step pulse width [us], 1us */
1192 p[14] = 1;
1193 /* Device head settle delay [100us], 100us */
1194 p[15] = 0;
1195 p[16] = 1;
1196 /* Motor on delay [0.1s], 0.1s */
1197 p[17] = 1;
1198 /* Motor off delay [0.1s], 0.1s */
1199 p[18] = 1;
1200 /* Medium rotation rate [rpm], 5400 rpm */
1201 p[26] = (5400 >> 8) & 0xff;
1202 p[27] = 5400 & 0xff;
1203 break;
1205 case MODE_PAGE_CACHING:
1206 length = 0x12;
1207 if (page_control == 1 || /* Changeable Values */
1208 blk_enable_write_cache(s->qdev.conf.blk)) {
1209 p[0] = 4; /* WCE */
1211 break;
1213 case MODE_PAGE_R_W_ERROR:
1214 length = 10;
1215 if (page_control == 1) { /* Changeable Values */
1216 break;
1218 p[0] = 0x80; /* Automatic Write Reallocation Enabled */
1219 if (s->qdev.type == TYPE_ROM) {
1220 p[1] = 0x20; /* Read Retry Count */
1222 break;
1224 case MODE_PAGE_AUDIO_CTL:
1225 length = 14;
1226 break;
1228 case MODE_PAGE_CAPABILITIES:
1229 length = 0x14;
1230 if (page_control == 1) { /* Changeable Values */
1231 break;
1234 p[0] = 0x3b; /* CD-R & CD-RW read */
1235 p[1] = 0; /* Writing not supported */
1236 p[2] = 0x7f; /* Audio, composite, digital out,
1237 mode 2 form 1&2, multi session */
1238 p[3] = 0xff; /* CD DA, DA accurate, RW supported,
1239 RW corrected, C2 errors, ISRC,
1240 UPC, Bar code */
1241 p[4] = 0x2d | (s->tray_locked ? 2 : 0);
1242 /* Locking supported, jumper present, eject, tray */
1243 p[5] = 0; /* no volume & mute control, no
1244 changer */
1245 p[6] = (50 * 176) >> 8; /* 50x read speed */
1246 p[7] = (50 * 176) & 0xff;
1247 p[8] = 2 >> 8; /* Two volume levels */
1248 p[9] = 2 & 0xff;
1249 p[10] = 2048 >> 8; /* 2M buffer */
1250 p[11] = 2048 & 0xff;
1251 p[12] = (16 * 176) >> 8; /* 16x read speed current */
1252 p[13] = (16 * 176) & 0xff;
1253 p[16] = (16 * 176) >> 8; /* 16x write speed */
1254 p[17] = (16 * 176) & 0xff;
1255 p[18] = (16 * 176) >> 8; /* 16x write speed current */
1256 p[19] = (16 * 176) & 0xff;
1257 break;
1259 default:
1260 return -1;
1263 assert(length < 256);
1264 (*p_outbuf)[0] = page;
1265 (*p_outbuf)[1] = length;
1266 *p_outbuf += length + 2;
1267 return length + 2;
1270 static int scsi_disk_emulate_mode_sense(SCSIDiskReq *r, uint8_t *outbuf)
1272 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
1273 uint64_t nb_sectors;
1274 bool dbd;
1275 int page, buflen, ret, page_control;
1276 uint8_t *p;
1277 uint8_t dev_specific_param;
1279 dbd = (r->req.cmd.buf[1] & 0x8) != 0;
1280 page = r->req.cmd.buf[2] & 0x3f;
1281 page_control = (r->req.cmd.buf[2] & 0xc0) >> 6;
1282 DPRINTF("Mode Sense(%d) (page %d, xfer %zd, page_control %d)\n",
1283 (r->req.cmd.buf[0] == MODE_SENSE) ? 6 : 10, page, r->req.cmd.xfer, page_control);
1284 memset(outbuf, 0, r->req.cmd.xfer);
1285 p = outbuf;
1287 if (s->qdev.type == TYPE_DISK) {
1288 dev_specific_param = s->features & (1 << SCSI_DISK_F_DPOFUA) ? 0x10 : 0;
1289 if (blk_is_read_only(s->qdev.conf.blk)) {
1290 dev_specific_param |= 0x80; /* Readonly. */
1292 } else {
1293 /* MMC prescribes that CD/DVD drives have no block descriptors,
1294 * and defines no device-specific parameter. */
1295 dev_specific_param = 0x00;
1296 dbd = true;
1299 if (r->req.cmd.buf[0] == MODE_SENSE) {
1300 p[1] = 0; /* Default media type. */
1301 p[2] = dev_specific_param;
1302 p[3] = 0; /* Block descriptor length. */
1303 p += 4;
1304 } else { /* MODE_SENSE_10 */
1305 p[2] = 0; /* Default media type. */
1306 p[3] = dev_specific_param;
1307 p[6] = p[7] = 0; /* Block descriptor length. */
1308 p += 8;
1311 blk_get_geometry(s->qdev.conf.blk, &nb_sectors);
1312 if (!dbd && nb_sectors) {
1313 if (r->req.cmd.buf[0] == MODE_SENSE) {
1314 outbuf[3] = 8; /* Block descriptor length */
1315 } else { /* MODE_SENSE_10 */
1316 outbuf[7] = 8; /* Block descriptor length */
1318 nb_sectors /= (s->qdev.blocksize / 512);
1319 if (nb_sectors > 0xffffff) {
1320 nb_sectors = 0;
1322 p[0] = 0; /* media density code */
1323 p[1] = (nb_sectors >> 16) & 0xff;
1324 p[2] = (nb_sectors >> 8) & 0xff;
1325 p[3] = nb_sectors & 0xff;
1326 p[4] = 0; /* reserved */
1327 p[5] = 0; /* bytes 5-7 are the sector size in bytes */
1328 p[6] = s->qdev.blocksize >> 8;
1329 p[7] = 0;
1330 p += 8;
1333 if (page_control == 3) {
1334 /* Saved Values */
1335 scsi_check_condition(r, SENSE_CODE(SAVING_PARAMS_NOT_SUPPORTED));
1336 return -1;
1339 if (page == 0x3f) {
1340 for (page = 0; page <= 0x3e; page++) {
1341 mode_sense_page(s, page, &p, page_control);
1343 } else {
1344 ret = mode_sense_page(s, page, &p, page_control);
1345 if (ret == -1) {
1346 return -1;
1350 buflen = p - outbuf;
1352 * The mode data length field specifies the length in bytes of the
1353 * following data that is available to be transferred. The mode data
1354 * length does not include itself.
1356 if (r->req.cmd.buf[0] == MODE_SENSE) {
1357 outbuf[0] = buflen - 1;
1358 } else { /* MODE_SENSE_10 */
1359 outbuf[0] = ((buflen - 2) >> 8) & 0xff;
1360 outbuf[1] = (buflen - 2) & 0xff;
1362 return buflen;
1365 static int scsi_disk_emulate_read_toc(SCSIRequest *req, uint8_t *outbuf)
1367 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
1368 int start_track, format, msf, toclen;
1369 uint64_t nb_sectors;
1371 msf = req->cmd.buf[1] & 2;
1372 format = req->cmd.buf[2] & 0xf;
1373 start_track = req->cmd.buf[6];
1374 blk_get_geometry(s->qdev.conf.blk, &nb_sectors);
1375 DPRINTF("Read TOC (track %d format %d msf %d)\n", start_track, format, msf >> 1);
1376 nb_sectors /= s->qdev.blocksize / 512;
1377 switch (format) {
1378 case 0:
1379 toclen = cdrom_read_toc(nb_sectors, outbuf, msf, start_track);
1380 break;
1381 case 1:
1382 /* multi session : only a single session defined */
1383 toclen = 12;
1384 memset(outbuf, 0, 12);
1385 outbuf[1] = 0x0a;
1386 outbuf[2] = 0x01;
1387 outbuf[3] = 0x01;
1388 break;
1389 case 2:
1390 toclen = cdrom_read_toc_raw(nb_sectors, outbuf, msf, start_track);
1391 break;
1392 default:
1393 return -1;
1395 return toclen;
1398 static int scsi_disk_emulate_start_stop(SCSIDiskReq *r)
1400 SCSIRequest *req = &r->req;
1401 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
1402 bool start = req->cmd.buf[4] & 1;
1403 bool loej = req->cmd.buf[4] & 2; /* load on start, eject on !start */
1404 int pwrcnd = req->cmd.buf[4] & 0xf0;
1406 if (pwrcnd) {
1407 /* eject/load only happens for power condition == 0 */
1408 return 0;
1411 if ((s->features & (1 << SCSI_DISK_F_REMOVABLE)) && loej) {
1412 if (!start && !s->tray_open && s->tray_locked) {
1413 scsi_check_condition(r,
1414 blk_is_inserted(s->qdev.conf.blk)
1415 ? SENSE_CODE(ILLEGAL_REQ_REMOVAL_PREVENTED)
1416 : SENSE_CODE(NOT_READY_REMOVAL_PREVENTED));
1417 return -1;
1420 if (s->tray_open != !start) {
1421 blk_eject(s->qdev.conf.blk, !start);
1422 s->tray_open = !start;
1425 return 0;
1428 static void scsi_disk_emulate_read_data(SCSIRequest *req)
1430 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
1431 int buflen = r->iov.iov_len;
1433 if (buflen) {
1434 DPRINTF("Read buf_len=%d\n", buflen);
1435 r->iov.iov_len = 0;
1436 r->started = true;
1437 scsi_req_data(&r->req, buflen);
1438 return;
1441 /* This also clears the sense buffer for REQUEST SENSE. */
1442 scsi_req_complete(&r->req, GOOD);
1445 static int scsi_disk_check_mode_select(SCSIDiskState *s, int page,
1446 uint8_t *inbuf, int inlen)
1448 uint8_t mode_current[SCSI_MAX_MODE_LEN];
1449 uint8_t mode_changeable[SCSI_MAX_MODE_LEN];
1450 uint8_t *p;
1451 int len, expected_len, changeable_len, i;
1453 /* The input buffer does not include the page header, so it is
1454 * off by 2 bytes.
1456 expected_len = inlen + 2;
1457 if (expected_len > SCSI_MAX_MODE_LEN) {
1458 return -1;
1461 p = mode_current;
1462 memset(mode_current, 0, inlen + 2);
1463 len = mode_sense_page(s, page, &p, 0);
1464 if (len < 0 || len != expected_len) {
1465 return -1;
1468 p = mode_changeable;
1469 memset(mode_changeable, 0, inlen + 2);
1470 changeable_len = mode_sense_page(s, page, &p, 1);
1471 assert(changeable_len == len);
1473 /* Check that unchangeable bits are the same as what MODE SENSE
1474 * would return.
1476 for (i = 2; i < len; i++) {
1477 if (((mode_current[i] ^ inbuf[i - 2]) & ~mode_changeable[i]) != 0) {
1478 return -1;
1481 return 0;
1484 static void scsi_disk_apply_mode_select(SCSIDiskState *s, int page, uint8_t *p)
1486 switch (page) {
1487 case MODE_PAGE_CACHING:
1488 blk_set_enable_write_cache(s->qdev.conf.blk, (p[0] & 4) != 0);
1489 break;
1491 default:
1492 break;
1496 static int mode_select_pages(SCSIDiskReq *r, uint8_t *p, int len, bool change)
1498 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
1500 while (len > 0) {
1501 int page, subpage, page_len;
1503 /* Parse both possible formats for the mode page headers. */
1504 page = p[0] & 0x3f;
1505 if (p[0] & 0x40) {
1506 if (len < 4) {
1507 goto invalid_param_len;
1509 subpage = p[1];
1510 page_len = lduw_be_p(&p[2]);
1511 p += 4;
1512 len -= 4;
1513 } else {
1514 if (len < 2) {
1515 goto invalid_param_len;
1517 subpage = 0;
1518 page_len = p[1];
1519 p += 2;
1520 len -= 2;
1523 if (subpage) {
1524 goto invalid_param;
1526 if (page_len > len) {
1527 goto invalid_param_len;
1530 if (!change) {
1531 if (scsi_disk_check_mode_select(s, page, p, page_len) < 0) {
1532 goto invalid_param;
1534 } else {
1535 scsi_disk_apply_mode_select(s, page, p);
1538 p += page_len;
1539 len -= page_len;
1541 return 0;
1543 invalid_param:
1544 scsi_check_condition(r, SENSE_CODE(INVALID_PARAM));
1545 return -1;
1547 invalid_param_len:
1548 scsi_check_condition(r, SENSE_CODE(INVALID_PARAM_LEN));
1549 return -1;
1552 static void scsi_disk_emulate_mode_select(SCSIDiskReq *r, uint8_t *inbuf)
1554 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
1555 uint8_t *p = inbuf;
1556 int cmd = r->req.cmd.buf[0];
1557 int len = r->req.cmd.xfer;
1558 int hdr_len = (cmd == MODE_SELECT ? 4 : 8);
1559 int bd_len;
1560 int pass;
1562 /* We only support PF=1, SP=0. */
1563 if ((r->req.cmd.buf[1] & 0x11) != 0x10) {
1564 goto invalid_field;
1567 if (len < hdr_len) {
1568 goto invalid_param_len;
1571 bd_len = (cmd == MODE_SELECT ? p[3] : lduw_be_p(&p[6]));
1572 len -= hdr_len;
1573 p += hdr_len;
1574 if (len < bd_len) {
1575 goto invalid_param_len;
1577 if (bd_len != 0 && bd_len != 8) {
1578 goto invalid_param;
1581 len -= bd_len;
1582 p += bd_len;
1584 /* Ensure no change is made if there is an error! */
1585 for (pass = 0; pass < 2; pass++) {
1586 if (mode_select_pages(r, p, len, pass == 1) < 0) {
1587 assert(pass == 0);
1588 return;
1591 if (!blk_enable_write_cache(s->qdev.conf.blk)) {
1592 /* The request is used as the AIO opaque value, so add a ref. */
1593 scsi_req_ref(&r->req);
1594 block_acct_start(blk_get_stats(s->qdev.conf.blk), &r->acct, 0,
1595 BLOCK_ACCT_FLUSH);
1596 r->req.aiocb = blk_aio_flush(s->qdev.conf.blk, scsi_aio_complete, r);
1597 return;
1600 scsi_req_complete(&r->req, GOOD);
1601 return;
1603 invalid_param:
1604 scsi_check_condition(r, SENSE_CODE(INVALID_PARAM));
1605 return;
1607 invalid_param_len:
1608 scsi_check_condition(r, SENSE_CODE(INVALID_PARAM_LEN));
1609 return;
1611 invalid_field:
1612 scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
1615 static inline bool check_lba_range(SCSIDiskState *s,
1616 uint64_t sector_num, uint32_t nb_sectors)
1619 * The first line tests that no overflow happens when computing the last
1620 * sector. The second line tests that the last accessed sector is in
1621 * range.
1623 * Careful, the computations should not underflow for nb_sectors == 0,
1624 * and a 0-block read to the first LBA beyond the end of device is
1625 * valid.
1627 return (sector_num <= sector_num + nb_sectors &&
1628 sector_num + nb_sectors <= s->qdev.max_lba + 1);
1631 typedef struct UnmapCBData {
1632 SCSIDiskReq *r;
1633 uint8_t *inbuf;
1634 int count;
1635 } UnmapCBData;
1637 static void scsi_unmap_complete(void *opaque, int ret);
1639 static void scsi_unmap_complete_noio(UnmapCBData *data, int ret)
1641 SCSIDiskReq *r = data->r;
1642 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
1643 uint64_t sector_num;
1644 uint32_t nb_sectors;
1646 assert(r->req.aiocb == NULL);
1647 if (scsi_disk_req_check_error(r, ret, false)) {
1648 goto done;
1651 if (data->count > 0) {
1652 sector_num = ldq_be_p(&data->inbuf[0]);
1653 nb_sectors = ldl_be_p(&data->inbuf[8]) & 0xffffffffULL;
1654 if (!check_lba_range(s, sector_num, nb_sectors)) {
1655 scsi_check_condition(r, SENSE_CODE(LBA_OUT_OF_RANGE));
1656 goto done;
1659 r->req.aiocb = blk_aio_pdiscard(s->qdev.conf.blk,
1660 sector_num * s->qdev.blocksize,
1661 nb_sectors * s->qdev.blocksize,
1662 scsi_unmap_complete, data);
1663 data->count--;
1664 data->inbuf += 16;
1665 return;
1668 scsi_req_complete(&r->req, GOOD);
1670 done:
1671 scsi_req_unref(&r->req);
1672 g_free(data);
1675 static void scsi_unmap_complete(void *opaque, int ret)
1677 UnmapCBData *data = opaque;
1678 SCSIDiskReq *r = data->r;
1679 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
1681 assert(r->req.aiocb != NULL);
1682 r->req.aiocb = NULL;
1684 aio_context_acquire(blk_get_aio_context(s->qdev.conf.blk));
1685 scsi_unmap_complete_noio(data, ret);
1686 aio_context_release(blk_get_aio_context(s->qdev.conf.blk));
1689 static void scsi_disk_emulate_unmap(SCSIDiskReq *r, uint8_t *inbuf)
1691 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
1692 uint8_t *p = inbuf;
1693 int len = r->req.cmd.xfer;
1694 UnmapCBData *data;
1696 /* Reject ANCHOR=1. */
1697 if (r->req.cmd.buf[1] & 0x1) {
1698 goto invalid_field;
1701 if (len < 8) {
1702 goto invalid_param_len;
1704 if (len < lduw_be_p(&p[0]) + 2) {
1705 goto invalid_param_len;
1707 if (len < lduw_be_p(&p[2]) + 8) {
1708 goto invalid_param_len;
1710 if (lduw_be_p(&p[2]) & 15) {
1711 goto invalid_param_len;
1714 if (blk_is_read_only(s->qdev.conf.blk)) {
1715 scsi_check_condition(r, SENSE_CODE(WRITE_PROTECTED));
1716 return;
1719 data = g_new0(UnmapCBData, 1);
1720 data->r = r;
1721 data->inbuf = &p[8];
1722 data->count = lduw_be_p(&p[2]) >> 4;
1724 /* The matching unref is in scsi_unmap_complete, before data is freed. */
1725 scsi_req_ref(&r->req);
1726 scsi_unmap_complete_noio(data, 0);
1727 return;
1729 invalid_param_len:
1730 scsi_check_condition(r, SENSE_CODE(INVALID_PARAM_LEN));
1731 return;
1733 invalid_field:
1734 scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
1737 typedef struct WriteSameCBData {
1738 SCSIDiskReq *r;
1739 int64_t sector;
1740 int nb_sectors;
1741 QEMUIOVector qiov;
1742 struct iovec iov;
1743 } WriteSameCBData;
1745 static void scsi_write_same_complete(void *opaque, int ret)
1747 WriteSameCBData *data = opaque;
1748 SCSIDiskReq *r = data->r;
1749 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
1751 assert(r->req.aiocb != NULL);
1752 r->req.aiocb = NULL;
1753 aio_context_acquire(blk_get_aio_context(s->qdev.conf.blk));
1754 if (scsi_disk_req_check_error(r, ret, true)) {
1755 goto done;
1758 block_acct_done(blk_get_stats(s->qdev.conf.blk), &r->acct);
1760 data->nb_sectors -= data->iov.iov_len / 512;
1761 data->sector += data->iov.iov_len / 512;
1762 data->iov.iov_len = MIN(data->nb_sectors * 512, data->iov.iov_len);
1763 if (data->iov.iov_len) {
1764 block_acct_start(blk_get_stats(s->qdev.conf.blk), &r->acct,
1765 data->iov.iov_len, BLOCK_ACCT_WRITE);
1766 /* Reinitialize qiov, to handle unaligned WRITE SAME request
1767 * where final qiov may need smaller size */
1768 qemu_iovec_init_external(&data->qiov, &data->iov, 1);
1769 r->req.aiocb = blk_aio_pwritev(s->qdev.conf.blk,
1770 data->sector << BDRV_SECTOR_BITS,
1771 &data->qiov, 0,
1772 scsi_write_same_complete, data);
1773 aio_context_release(blk_get_aio_context(s->qdev.conf.blk));
1774 return;
1777 scsi_req_complete(&r->req, GOOD);
1779 done:
1780 scsi_req_unref(&r->req);
1781 qemu_vfree(data->iov.iov_base);
1782 g_free(data);
1783 aio_context_release(blk_get_aio_context(s->qdev.conf.blk));
1786 static void scsi_disk_emulate_write_same(SCSIDiskReq *r, uint8_t *inbuf)
1788 SCSIRequest *req = &r->req;
1789 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
1790 uint32_t nb_sectors = scsi_data_cdb_xfer(r->req.cmd.buf);
1791 WriteSameCBData *data;
1792 uint8_t *buf;
1793 int i;
1795 /* Fail if PBDATA=1 or LBDATA=1 or ANCHOR=1. */
1796 if (nb_sectors == 0 || (req->cmd.buf[1] & 0x16)) {
1797 scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
1798 return;
1801 if (blk_is_read_only(s->qdev.conf.blk)) {
1802 scsi_check_condition(r, SENSE_CODE(WRITE_PROTECTED));
1803 return;
1805 if (!check_lba_range(s, r->req.cmd.lba, nb_sectors)) {
1806 scsi_check_condition(r, SENSE_CODE(LBA_OUT_OF_RANGE));
1807 return;
1810 if ((req->cmd.buf[1] & 0x1) || buffer_is_zero(inbuf, s->qdev.blocksize)) {
1811 int flags = (req->cmd.buf[1] & 0x8) ? BDRV_REQ_MAY_UNMAP : 0;
1813 /* The request is used as the AIO opaque value, so add a ref. */
1814 scsi_req_ref(&r->req);
1815 block_acct_start(blk_get_stats(s->qdev.conf.blk), &r->acct,
1816 nb_sectors * s->qdev.blocksize,
1817 BLOCK_ACCT_WRITE);
1818 r->req.aiocb = blk_aio_pwrite_zeroes(s->qdev.conf.blk,
1819 r->req.cmd.lba * s->qdev.blocksize,
1820 nb_sectors * s->qdev.blocksize,
1821 flags, scsi_aio_complete, r);
1822 return;
1825 data = g_new0(WriteSameCBData, 1);
1826 data->r = r;
1827 data->sector = r->req.cmd.lba * (s->qdev.blocksize / 512);
1828 data->nb_sectors = nb_sectors * (s->qdev.blocksize / 512);
1829 data->iov.iov_len = MIN(data->nb_sectors * 512, SCSI_WRITE_SAME_MAX);
1830 data->iov.iov_base = buf = blk_blockalign(s->qdev.conf.blk,
1831 data->iov.iov_len);
1832 qemu_iovec_init_external(&data->qiov, &data->iov, 1);
1834 for (i = 0; i < data->iov.iov_len; i += s->qdev.blocksize) {
1835 memcpy(&buf[i], inbuf, s->qdev.blocksize);
1838 scsi_req_ref(&r->req);
1839 block_acct_start(blk_get_stats(s->qdev.conf.blk), &r->acct,
1840 data->iov.iov_len, BLOCK_ACCT_WRITE);
1841 r->req.aiocb = blk_aio_pwritev(s->qdev.conf.blk,
1842 data->sector << BDRV_SECTOR_BITS,
1843 &data->qiov, 0,
1844 scsi_write_same_complete, data);
1847 static void scsi_disk_emulate_write_data(SCSIRequest *req)
1849 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
1851 if (r->iov.iov_len) {
1852 int buflen = r->iov.iov_len;
1853 DPRINTF("Write buf_len=%d\n", buflen);
1854 r->iov.iov_len = 0;
1855 scsi_req_data(&r->req, buflen);
1856 return;
1859 switch (req->cmd.buf[0]) {
1860 case MODE_SELECT:
1861 case MODE_SELECT_10:
1862 /* This also clears the sense buffer for REQUEST SENSE. */
1863 scsi_disk_emulate_mode_select(r, r->iov.iov_base);
1864 break;
1866 case UNMAP:
1867 scsi_disk_emulate_unmap(r, r->iov.iov_base);
1868 break;
1870 case VERIFY_10:
1871 case VERIFY_12:
1872 case VERIFY_16:
1873 if (r->req.status == -1) {
1874 scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
1876 break;
1878 case WRITE_SAME_10:
1879 case WRITE_SAME_16:
1880 scsi_disk_emulate_write_same(r, r->iov.iov_base);
1881 break;
1883 default:
1884 abort();
1888 static int32_t scsi_disk_emulate_command(SCSIRequest *req, uint8_t *buf)
1890 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
1891 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
1892 uint64_t nb_sectors;
1893 uint8_t *outbuf;
1894 int buflen;
1896 switch (req->cmd.buf[0]) {
1897 case INQUIRY:
1898 case MODE_SENSE:
1899 case MODE_SENSE_10:
1900 case RESERVE:
1901 case RESERVE_10:
1902 case RELEASE:
1903 case RELEASE_10:
1904 case START_STOP:
1905 case ALLOW_MEDIUM_REMOVAL:
1906 case GET_CONFIGURATION:
1907 case GET_EVENT_STATUS_NOTIFICATION:
1908 case MECHANISM_STATUS:
1909 case REQUEST_SENSE:
1910 break;
1912 default:
1913 if (!blk_is_available(s->qdev.conf.blk)) {
1914 scsi_check_condition(r, SENSE_CODE(NO_MEDIUM));
1915 return 0;
1917 break;
1921 * FIXME: we shouldn't return anything bigger than 4k, but the code
1922 * requires the buffer to be as big as req->cmd.xfer in several
1923 * places. So, do not allow CDBs with a very large ALLOCATION
1924 * LENGTH. The real fix would be to modify scsi_read_data and
1925 * dma_buf_read, so that they return data beyond the buflen
1926 * as all zeros.
1928 if (req->cmd.xfer > 65536) {
1929 goto illegal_request;
1931 r->buflen = MAX(4096, req->cmd.xfer);
1933 if (!r->iov.iov_base) {
1934 r->iov.iov_base = blk_blockalign(s->qdev.conf.blk, r->buflen);
1937 buflen = req->cmd.xfer;
1938 outbuf = r->iov.iov_base;
1939 memset(outbuf, 0, r->buflen);
1940 switch (req->cmd.buf[0]) {
1941 case TEST_UNIT_READY:
1942 assert(blk_is_available(s->qdev.conf.blk));
1943 break;
1944 case INQUIRY:
1945 buflen = scsi_disk_emulate_inquiry(req, outbuf);
1946 if (buflen < 0) {
1947 goto illegal_request;
1949 break;
1950 case MODE_SENSE:
1951 case MODE_SENSE_10:
1952 buflen = scsi_disk_emulate_mode_sense(r, outbuf);
1953 if (buflen < 0) {
1954 goto illegal_request;
1956 break;
1957 case READ_TOC:
1958 buflen = scsi_disk_emulate_read_toc(req, outbuf);
1959 if (buflen < 0) {
1960 goto illegal_request;
1962 break;
1963 case RESERVE:
1964 if (req->cmd.buf[1] & 1) {
1965 goto illegal_request;
1967 break;
1968 case RESERVE_10:
1969 if (req->cmd.buf[1] & 3) {
1970 goto illegal_request;
1972 break;
1973 case RELEASE:
1974 if (req->cmd.buf[1] & 1) {
1975 goto illegal_request;
1977 break;
1978 case RELEASE_10:
1979 if (req->cmd.buf[1] & 3) {
1980 goto illegal_request;
1982 break;
1983 case START_STOP:
1984 if (scsi_disk_emulate_start_stop(r) < 0) {
1985 return 0;
1987 break;
1988 case ALLOW_MEDIUM_REMOVAL:
1989 s->tray_locked = req->cmd.buf[4] & 1;
1990 blk_lock_medium(s->qdev.conf.blk, req->cmd.buf[4] & 1);
1991 break;
1992 case READ_CAPACITY_10:
1993 /* The normal LEN field for this command is zero. */
1994 memset(outbuf, 0, 8);
1995 blk_get_geometry(s->qdev.conf.blk, &nb_sectors);
1996 if (!nb_sectors) {
1997 scsi_check_condition(r, SENSE_CODE(LUN_NOT_READY));
1998 return 0;
2000 if ((req->cmd.buf[8] & 1) == 0 && req->cmd.lba) {
2001 goto illegal_request;
2003 nb_sectors /= s->qdev.blocksize / 512;
2004 /* Returned value is the address of the last sector. */
2005 nb_sectors--;
2006 /* Remember the new size for read/write sanity checking. */
2007 s->qdev.max_lba = nb_sectors;
2008 /* Clip to 2TB, instead of returning capacity modulo 2TB. */
2009 if (nb_sectors > UINT32_MAX) {
2010 nb_sectors = UINT32_MAX;
2012 outbuf[0] = (nb_sectors >> 24) & 0xff;
2013 outbuf[1] = (nb_sectors >> 16) & 0xff;
2014 outbuf[2] = (nb_sectors >> 8) & 0xff;
2015 outbuf[3] = nb_sectors & 0xff;
2016 outbuf[4] = 0;
2017 outbuf[5] = 0;
2018 outbuf[6] = s->qdev.blocksize >> 8;
2019 outbuf[7] = 0;
2020 break;
2021 case REQUEST_SENSE:
2022 /* Just return "NO SENSE". */
2023 buflen = scsi_convert_sense(NULL, 0, outbuf, r->buflen,
2024 (req->cmd.buf[1] & 1) == 0);
2025 if (buflen < 0) {
2026 goto illegal_request;
2028 break;
2029 case MECHANISM_STATUS:
2030 buflen = scsi_emulate_mechanism_status(s, outbuf);
2031 if (buflen < 0) {
2032 goto illegal_request;
2034 break;
2035 case GET_CONFIGURATION:
2036 buflen = scsi_get_configuration(s, outbuf);
2037 if (buflen < 0) {
2038 goto illegal_request;
2040 break;
2041 case GET_EVENT_STATUS_NOTIFICATION:
2042 buflen = scsi_get_event_status_notification(s, r, outbuf);
2043 if (buflen < 0) {
2044 goto illegal_request;
2046 break;
2047 case READ_DISC_INFORMATION:
2048 buflen = scsi_read_disc_information(s, r, outbuf);
2049 if (buflen < 0) {
2050 goto illegal_request;
2052 break;
2053 case READ_DVD_STRUCTURE:
2054 buflen = scsi_read_dvd_structure(s, r, outbuf);
2055 if (buflen < 0) {
2056 goto illegal_request;
2058 break;
2059 case SERVICE_ACTION_IN_16:
2060 /* Service Action In subcommands. */
2061 if ((req->cmd.buf[1] & 31) == SAI_READ_CAPACITY_16) {
2062 DPRINTF("SAI READ CAPACITY(16)\n");
2063 memset(outbuf, 0, req->cmd.xfer);
2064 blk_get_geometry(s->qdev.conf.blk, &nb_sectors);
2065 if (!nb_sectors) {
2066 scsi_check_condition(r, SENSE_CODE(LUN_NOT_READY));
2067 return 0;
2069 if ((req->cmd.buf[14] & 1) == 0 && req->cmd.lba) {
2070 goto illegal_request;
2072 nb_sectors /= s->qdev.blocksize / 512;
2073 /* Returned value is the address of the last sector. */
2074 nb_sectors--;
2075 /* Remember the new size for read/write sanity checking. */
2076 s->qdev.max_lba = nb_sectors;
2077 outbuf[0] = (nb_sectors >> 56) & 0xff;
2078 outbuf[1] = (nb_sectors >> 48) & 0xff;
2079 outbuf[2] = (nb_sectors >> 40) & 0xff;
2080 outbuf[3] = (nb_sectors >> 32) & 0xff;
2081 outbuf[4] = (nb_sectors >> 24) & 0xff;
2082 outbuf[5] = (nb_sectors >> 16) & 0xff;
2083 outbuf[6] = (nb_sectors >> 8) & 0xff;
2084 outbuf[7] = nb_sectors & 0xff;
2085 outbuf[8] = 0;
2086 outbuf[9] = 0;
2087 outbuf[10] = s->qdev.blocksize >> 8;
2088 outbuf[11] = 0;
2089 outbuf[12] = 0;
2090 outbuf[13] = get_physical_block_exp(&s->qdev.conf);
2092 /* set TPE bit if the format supports discard */
2093 if (s->qdev.conf.discard_granularity) {
2094 outbuf[14] = 0x80;
2097 /* Protection, exponent and lowest lba field left blank. */
2098 break;
2100 DPRINTF("Unsupported Service Action In\n");
2101 goto illegal_request;
2102 case SYNCHRONIZE_CACHE:
2103 /* The request is used as the AIO opaque value, so add a ref. */
2104 scsi_req_ref(&r->req);
2105 block_acct_start(blk_get_stats(s->qdev.conf.blk), &r->acct, 0,
2106 BLOCK_ACCT_FLUSH);
2107 r->req.aiocb = blk_aio_flush(s->qdev.conf.blk, scsi_aio_complete, r);
2108 return 0;
2109 case SEEK_10:
2110 DPRINTF("Seek(10) (sector %" PRId64 ")\n", r->req.cmd.lba);
2111 if (r->req.cmd.lba > s->qdev.max_lba) {
2112 goto illegal_lba;
2114 break;
2115 case MODE_SELECT:
2116 DPRINTF("Mode Select(6) (len %lu)\n", (unsigned long)r->req.cmd.xfer);
2117 break;
2118 case MODE_SELECT_10:
2119 DPRINTF("Mode Select(10) (len %lu)\n", (unsigned long)r->req.cmd.xfer);
2120 break;
2121 case UNMAP:
2122 DPRINTF("Unmap (len %lu)\n", (unsigned long)r->req.cmd.xfer);
2123 break;
2124 case VERIFY_10:
2125 case VERIFY_12:
2126 case VERIFY_16:
2127 DPRINTF("Verify (bytchk %d)\n", (req->cmd.buf[1] >> 1) & 3);
2128 if (req->cmd.buf[1] & 6) {
2129 goto illegal_request;
2131 break;
2132 case WRITE_SAME_10:
2133 case WRITE_SAME_16:
2134 DPRINTF("WRITE SAME %d (len %lu)\n",
2135 req->cmd.buf[0] == WRITE_SAME_10 ? 10 : 16,
2136 (unsigned long)r->req.cmd.xfer);
2137 break;
2138 default:
2139 DPRINTF("Unknown SCSI command (%2.2x=%s)\n", buf[0],
2140 scsi_command_name(buf[0]));
2141 scsi_check_condition(r, SENSE_CODE(INVALID_OPCODE));
2142 return 0;
2144 assert(!r->req.aiocb);
2145 r->iov.iov_len = MIN(r->buflen, req->cmd.xfer);
2146 if (r->iov.iov_len == 0) {
2147 scsi_req_complete(&r->req, GOOD);
2149 if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
2150 assert(r->iov.iov_len == req->cmd.xfer);
2151 return -r->iov.iov_len;
2152 } else {
2153 return r->iov.iov_len;
2156 illegal_request:
2157 if (r->req.status == -1) {
2158 scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
2160 return 0;
2162 illegal_lba:
2163 scsi_check_condition(r, SENSE_CODE(LBA_OUT_OF_RANGE));
2164 return 0;
2167 /* Execute a scsi command. Returns the length of the data expected by the
2168 command. This will be Positive for data transfers from the device
2169 (eg. disk reads), negative for transfers to the device (eg. disk writes),
2170 and zero if the command does not transfer any data. */
2172 static int32_t scsi_disk_dma_command(SCSIRequest *req, uint8_t *buf)
2174 SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
2175 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
2176 SCSIDiskClass *sdc = (SCSIDiskClass *) object_get_class(OBJECT(s));
2177 uint32_t len;
2178 uint8_t command;
2180 command = buf[0];
2182 if (!blk_is_available(s->qdev.conf.blk)) {
2183 scsi_check_condition(r, SENSE_CODE(NO_MEDIUM));
2184 return 0;
2187 len = scsi_data_cdb_xfer(r->req.cmd.buf);
2188 switch (command) {
2189 case READ_6:
2190 case READ_10:
2191 case READ_12:
2192 case READ_16:
2193 DPRINTF("Read (sector %" PRId64 ", count %u)\n", r->req.cmd.lba, len);
2194 if (r->req.cmd.buf[1] & 0xe0) {
2195 goto illegal_request;
2197 if (!check_lba_range(s, r->req.cmd.lba, len)) {
2198 goto illegal_lba;
2200 r->sector = r->req.cmd.lba * (s->qdev.blocksize / 512);
2201 r->sector_count = len * (s->qdev.blocksize / 512);
2202 break;
2203 case WRITE_6:
2204 case WRITE_10:
2205 case WRITE_12:
2206 case WRITE_16:
2207 case WRITE_VERIFY_10:
2208 case WRITE_VERIFY_12:
2209 case WRITE_VERIFY_16:
2210 if (blk_is_read_only(s->qdev.conf.blk)) {
2211 scsi_check_condition(r, SENSE_CODE(WRITE_PROTECTED));
2212 return 0;
2214 DPRINTF("Write %s(sector %" PRId64 ", count %u)\n",
2215 (command & 0xe) == 0xe ? "And Verify " : "",
2216 r->req.cmd.lba, len);
2217 /* fall through */
2218 case VERIFY_10:
2219 case VERIFY_12:
2220 case VERIFY_16:
2221 /* We get here only for BYTCHK == 0x01 and only for scsi-block.
2222 * As far as DMA is concerned, we can treat it the same as a write;
2223 * scsi_block_do_sgio will send VERIFY commands.
2225 if (r->req.cmd.buf[1] & 0xe0) {
2226 goto illegal_request;
2228 if (!check_lba_range(s, r->req.cmd.lba, len)) {
2229 goto illegal_lba;
2231 r->sector = r->req.cmd.lba * (s->qdev.blocksize / 512);
2232 r->sector_count = len * (s->qdev.blocksize / 512);
2233 break;
2234 default:
2235 abort();
2236 illegal_request:
2237 scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
2238 return 0;
2239 illegal_lba:
2240 scsi_check_condition(r, SENSE_CODE(LBA_OUT_OF_RANGE));
2241 return 0;
2243 r->need_fua_emulation = sdc->need_fua_emulation(&r->req.cmd);
2244 if (r->sector_count == 0) {
2245 scsi_req_complete(&r->req, GOOD);
2247 assert(r->iov.iov_len == 0);
2248 if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
2249 return -r->sector_count * 512;
2250 } else {
2251 return r->sector_count * 512;
2255 static void scsi_disk_reset(DeviceState *dev)
2257 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev.qdev, dev);
2258 uint64_t nb_sectors;
2260 scsi_device_purge_requests(&s->qdev, SENSE_CODE(RESET));
2262 blk_get_geometry(s->qdev.conf.blk, &nb_sectors);
2263 nb_sectors /= s->qdev.blocksize / 512;
2264 if (nb_sectors) {
2265 nb_sectors--;
2267 s->qdev.max_lba = nb_sectors;
2268 /* reset tray statuses */
2269 s->tray_locked = 0;
2270 s->tray_open = 0;
2273 static void scsi_disk_resize_cb(void *opaque)
2275 SCSIDiskState *s = opaque;
2277 /* SPC lists this sense code as available only for
2278 * direct-access devices.
2280 if (s->qdev.type == TYPE_DISK) {
2281 scsi_device_report_change(&s->qdev, SENSE_CODE(CAPACITY_CHANGED));
2285 static void scsi_cd_change_media_cb(void *opaque, bool load, Error **errp)
2287 SCSIDiskState *s = opaque;
2290 * When a CD gets changed, we have to report an ejected state and
2291 * then a loaded state to guests so that they detect tray
2292 * open/close and media change events. Guests that do not use
2293 * GET_EVENT_STATUS_NOTIFICATION to detect such tray open/close
2294 * states rely on this behavior.
2296 * media_changed governs the state machine used for unit attention
2297 * report. media_event is used by GET EVENT STATUS NOTIFICATION.
2299 s->media_changed = load;
2300 s->tray_open = !load;
2301 scsi_device_set_ua(&s->qdev, SENSE_CODE(UNIT_ATTENTION_NO_MEDIUM));
2302 s->media_event = true;
2303 s->eject_request = false;
2306 static void scsi_cd_eject_request_cb(void *opaque, bool force)
2308 SCSIDiskState *s = opaque;
2310 s->eject_request = true;
2311 if (force) {
2312 s->tray_locked = false;
2316 static bool scsi_cd_is_tray_open(void *opaque)
2318 return ((SCSIDiskState *)opaque)->tray_open;
2321 static bool scsi_cd_is_medium_locked(void *opaque)
2323 return ((SCSIDiskState *)opaque)->tray_locked;
2326 static const BlockDevOps scsi_disk_removable_block_ops = {
2327 .change_media_cb = scsi_cd_change_media_cb,
2328 .eject_request_cb = scsi_cd_eject_request_cb,
2329 .is_tray_open = scsi_cd_is_tray_open,
2330 .is_medium_locked = scsi_cd_is_medium_locked,
2332 .resize_cb = scsi_disk_resize_cb,
2335 static const BlockDevOps scsi_disk_block_ops = {
2336 .resize_cb = scsi_disk_resize_cb,
2339 static void scsi_disk_unit_attention_reported(SCSIDevice *dev)
2341 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
2342 if (s->media_changed) {
2343 s->media_changed = false;
2344 scsi_device_set_ua(&s->qdev, SENSE_CODE(MEDIUM_CHANGED));
2348 static void scsi_realize(SCSIDevice *dev, Error **errp)
2350 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
2352 if (!s->qdev.conf.blk) {
2353 error_setg(errp, "drive property not set");
2354 return;
2357 if (!(s->features & (1 << SCSI_DISK_F_REMOVABLE)) &&
2358 !blk_is_inserted(s->qdev.conf.blk)) {
2359 error_setg(errp, "Device needs media, but drive is empty");
2360 return;
2363 blkconf_serial(&s->qdev.conf, &s->serial);
2364 blkconf_blocksizes(&s->qdev.conf);
2366 if (s->qdev.conf.logical_block_size >
2367 s->qdev.conf.physical_block_size) {
2368 error_setg(errp,
2369 "logical_block_size > physical_block_size not supported");
2370 return;
2373 if (dev->type == TYPE_DISK) {
2374 if (!blkconf_geometry(&dev->conf, NULL, 65535, 255, 255, errp)) {
2375 return;
2378 if (!blkconf_apply_backend_options(&dev->conf,
2379 blk_is_read_only(s->qdev.conf.blk),
2380 dev->type == TYPE_DISK, errp)) {
2381 return;
2384 if (s->qdev.conf.discard_granularity == -1) {
2385 s->qdev.conf.discard_granularity =
2386 MAX(s->qdev.conf.logical_block_size, DEFAULT_DISCARD_GRANULARITY);
2389 if (!s->version) {
2390 s->version = g_strdup(qemu_hw_version());
2392 if (!s->vendor) {
2393 s->vendor = g_strdup("QEMU");
2396 if (blk_is_sg(s->qdev.conf.blk)) {
2397 error_setg(errp, "unwanted /dev/sg*");
2398 return;
2401 if ((s->features & (1 << SCSI_DISK_F_REMOVABLE)) &&
2402 !(s->features & (1 << SCSI_DISK_F_NO_REMOVABLE_DEVOPS))) {
2403 blk_set_dev_ops(s->qdev.conf.blk, &scsi_disk_removable_block_ops, s);
2404 } else {
2405 blk_set_dev_ops(s->qdev.conf.blk, &scsi_disk_block_ops, s);
2407 blk_set_guest_block_size(s->qdev.conf.blk, s->qdev.blocksize);
2409 blk_iostatus_enable(s->qdev.conf.blk);
2412 static void scsi_hd_realize(SCSIDevice *dev, Error **errp)
2414 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
2415 /* can happen for devices without drive. The error message for missing
2416 * backend will be issued in scsi_realize
2418 if (s->qdev.conf.blk) {
2419 blkconf_blocksizes(&s->qdev.conf);
2421 s->qdev.blocksize = s->qdev.conf.logical_block_size;
2422 s->qdev.type = TYPE_DISK;
2423 if (!s->product) {
2424 s->product = g_strdup("QEMU HARDDISK");
2426 scsi_realize(&s->qdev, errp);
2429 static void scsi_cd_realize(SCSIDevice *dev, Error **errp)
2431 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
2432 int ret;
2434 if (!dev->conf.blk) {
2435 /* Anonymous BlockBackend for an empty drive. As we put it into
2436 * dev->conf, qdev takes care of detaching on unplug. */
2437 dev->conf.blk = blk_new(0, BLK_PERM_ALL);
2438 ret = blk_attach_dev(dev->conf.blk, &dev->qdev);
2439 assert(ret == 0);
2442 s->qdev.blocksize = 2048;
2443 s->qdev.type = TYPE_ROM;
2444 s->features |= 1 << SCSI_DISK_F_REMOVABLE;
2445 if (!s->product) {
2446 s->product = g_strdup("QEMU CD-ROM");
2448 scsi_realize(&s->qdev, errp);
2451 static void scsi_disk_realize(SCSIDevice *dev, Error **errp)
2453 DriveInfo *dinfo;
2454 Error *local_err = NULL;
2456 if (!dev->conf.blk) {
2457 scsi_realize(dev, &local_err);
2458 assert(local_err);
2459 error_propagate(errp, local_err);
2460 return;
2463 dinfo = blk_legacy_dinfo(dev->conf.blk);
2464 if (dinfo && dinfo->media_cd) {
2465 scsi_cd_realize(dev, errp);
2466 } else {
2467 scsi_hd_realize(dev, errp);
2471 static const SCSIReqOps scsi_disk_emulate_reqops = {
2472 .size = sizeof(SCSIDiskReq),
2473 .free_req = scsi_free_request,
2474 .send_command = scsi_disk_emulate_command,
2475 .read_data = scsi_disk_emulate_read_data,
2476 .write_data = scsi_disk_emulate_write_data,
2477 .get_buf = scsi_get_buf,
2480 static const SCSIReqOps scsi_disk_dma_reqops = {
2481 .size = sizeof(SCSIDiskReq),
2482 .free_req = scsi_free_request,
2483 .send_command = scsi_disk_dma_command,
2484 .read_data = scsi_read_data,
2485 .write_data = scsi_write_data,
2486 .get_buf = scsi_get_buf,
2487 .load_request = scsi_disk_load_request,
2488 .save_request = scsi_disk_save_request,
2491 static const SCSIReqOps *const scsi_disk_reqops_dispatch[256] = {
2492 [TEST_UNIT_READY] = &scsi_disk_emulate_reqops,
2493 [INQUIRY] = &scsi_disk_emulate_reqops,
2494 [MODE_SENSE] = &scsi_disk_emulate_reqops,
2495 [MODE_SENSE_10] = &scsi_disk_emulate_reqops,
2496 [START_STOP] = &scsi_disk_emulate_reqops,
2497 [ALLOW_MEDIUM_REMOVAL] = &scsi_disk_emulate_reqops,
2498 [READ_CAPACITY_10] = &scsi_disk_emulate_reqops,
2499 [READ_TOC] = &scsi_disk_emulate_reqops,
2500 [READ_DVD_STRUCTURE] = &scsi_disk_emulate_reqops,
2501 [READ_DISC_INFORMATION] = &scsi_disk_emulate_reqops,
2502 [GET_CONFIGURATION] = &scsi_disk_emulate_reqops,
2503 [GET_EVENT_STATUS_NOTIFICATION] = &scsi_disk_emulate_reqops,
2504 [MECHANISM_STATUS] = &scsi_disk_emulate_reqops,
2505 [SERVICE_ACTION_IN_16] = &scsi_disk_emulate_reqops,
2506 [REQUEST_SENSE] = &scsi_disk_emulate_reqops,
2507 [SYNCHRONIZE_CACHE] = &scsi_disk_emulate_reqops,
2508 [SEEK_10] = &scsi_disk_emulate_reqops,
2509 [MODE_SELECT] = &scsi_disk_emulate_reqops,
2510 [MODE_SELECT_10] = &scsi_disk_emulate_reqops,
2511 [UNMAP] = &scsi_disk_emulate_reqops,
2512 [WRITE_SAME_10] = &scsi_disk_emulate_reqops,
2513 [WRITE_SAME_16] = &scsi_disk_emulate_reqops,
2514 [VERIFY_10] = &scsi_disk_emulate_reqops,
2515 [VERIFY_12] = &scsi_disk_emulate_reqops,
2516 [VERIFY_16] = &scsi_disk_emulate_reqops,
2518 [READ_6] = &scsi_disk_dma_reqops,
2519 [READ_10] = &scsi_disk_dma_reqops,
2520 [READ_12] = &scsi_disk_dma_reqops,
2521 [READ_16] = &scsi_disk_dma_reqops,
2522 [WRITE_6] = &scsi_disk_dma_reqops,
2523 [WRITE_10] = &scsi_disk_dma_reqops,
2524 [WRITE_12] = &scsi_disk_dma_reqops,
2525 [WRITE_16] = &scsi_disk_dma_reqops,
2526 [WRITE_VERIFY_10] = &scsi_disk_dma_reqops,
2527 [WRITE_VERIFY_12] = &scsi_disk_dma_reqops,
2528 [WRITE_VERIFY_16] = &scsi_disk_dma_reqops,
2531 static SCSIRequest *scsi_new_request(SCSIDevice *d, uint32_t tag, uint32_t lun,
2532 uint8_t *buf, void *hba_private)
2534 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, d);
2535 SCSIRequest *req;
2536 const SCSIReqOps *ops;
2537 uint8_t command;
2539 command = buf[0];
2540 ops = scsi_disk_reqops_dispatch[command];
2541 if (!ops) {
2542 ops = &scsi_disk_emulate_reqops;
2544 req = scsi_req_alloc(ops, &s->qdev, tag, lun, hba_private);
2546 #ifdef DEBUG_SCSI
2547 DPRINTF("Command: lun=%d tag=0x%x data=0x%02x", lun, tag, buf[0]);
2549 int i;
2550 for (i = 1; i < scsi_cdb_length(buf); i++) {
2551 printf(" 0x%02x", buf[i]);
2553 printf("\n");
2555 #endif
2557 return req;
2560 #ifdef __linux__
2561 static int get_device_type(SCSIDiskState *s)
2563 uint8_t cmd[16];
2564 uint8_t buf[36];
2565 uint8_t sensebuf[8];
2566 sg_io_hdr_t io_header;
2567 int ret;
2569 memset(cmd, 0, sizeof(cmd));
2570 memset(buf, 0, sizeof(buf));
2571 cmd[0] = INQUIRY;
2572 cmd[4] = sizeof(buf);
2574 memset(&io_header, 0, sizeof(io_header));
2575 io_header.interface_id = 'S';
2576 io_header.dxfer_direction = SG_DXFER_FROM_DEV;
2577 io_header.dxfer_len = sizeof(buf);
2578 io_header.dxferp = buf;
2579 io_header.cmdp = cmd;
2580 io_header.cmd_len = sizeof(cmd);
2581 io_header.mx_sb_len = sizeof(sensebuf);
2582 io_header.sbp = sensebuf;
2583 io_header.timeout = 6000; /* XXX */
2585 ret = blk_ioctl(s->qdev.conf.blk, SG_IO, &io_header);
2586 if (ret < 0 || io_header.driver_status || io_header.host_status) {
2587 return -1;
2589 s->qdev.type = buf[0];
2590 if (buf[1] & 0x80) {
2591 s->features |= 1 << SCSI_DISK_F_REMOVABLE;
2593 return 0;
2596 static void scsi_block_realize(SCSIDevice *dev, Error **errp)
2598 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
2599 int sg_version;
2600 int rc;
2602 if (!s->qdev.conf.blk) {
2603 error_setg(errp, "drive property not set");
2604 return;
2607 /* check we are using a driver managing SG_IO (version 3 and after) */
2608 rc = blk_ioctl(s->qdev.conf.blk, SG_GET_VERSION_NUM, &sg_version);
2609 if (rc < 0) {
2610 error_setg_errno(errp, -rc, "cannot get SG_IO version number");
2611 if (rc != -EPERM) {
2612 error_append_hint(errp, "Is this a SCSI device?\n");
2614 return;
2616 if (sg_version < 30000) {
2617 error_setg(errp, "scsi generic interface too old");
2618 return;
2621 /* get device type from INQUIRY data */
2622 rc = get_device_type(s);
2623 if (rc < 0) {
2624 error_setg(errp, "INQUIRY failed");
2625 return;
2628 /* Make a guess for the block size, we'll fix it when the guest sends.
2629 * READ CAPACITY. If they don't, they likely would assume these sizes
2630 * anyway. (TODO: check in /sys).
2632 if (s->qdev.type == TYPE_ROM || s->qdev.type == TYPE_WORM) {
2633 s->qdev.blocksize = 2048;
2634 } else {
2635 s->qdev.blocksize = 512;
2638 /* Makes the scsi-block device not removable by using HMP and QMP eject
2639 * command.
2641 s->features |= (1 << SCSI_DISK_F_NO_REMOVABLE_DEVOPS);
2643 scsi_realize(&s->qdev, errp);
2644 scsi_generic_read_device_identification(&s->qdev);
2647 typedef struct SCSIBlockReq {
2648 SCSIDiskReq req;
2649 sg_io_hdr_t io_header;
2651 /* Selected bytes of the original CDB, copied into our own CDB. */
2652 uint8_t cmd, cdb1, group_number;
2654 /* CDB passed to SG_IO. */
2655 uint8_t cdb[16];
2656 } SCSIBlockReq;
2658 static BlockAIOCB *scsi_block_do_sgio(SCSIBlockReq *req,
2659 int64_t offset, QEMUIOVector *iov,
2660 int direction,
2661 BlockCompletionFunc *cb, void *opaque)
2663 sg_io_hdr_t *io_header = &req->io_header;
2664 SCSIDiskReq *r = &req->req;
2665 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
2666 int nb_logical_blocks;
2667 uint64_t lba;
2668 BlockAIOCB *aiocb;
2670 /* This is not supported yet. It can only happen if the guest does
2671 * reads and writes that are not aligned to one logical sectors
2672 * _and_ cover multiple MemoryRegions.
2674 assert(offset % s->qdev.blocksize == 0);
2675 assert(iov->size % s->qdev.blocksize == 0);
2677 io_header->interface_id = 'S';
2679 /* The data transfer comes from the QEMUIOVector. */
2680 io_header->dxfer_direction = direction;
2681 io_header->dxfer_len = iov->size;
2682 io_header->dxferp = (void *)iov->iov;
2683 io_header->iovec_count = iov->niov;
2684 assert(io_header->iovec_count == iov->niov); /* no overflow! */
2686 /* Build a new CDB with the LBA and length patched in, in case
2687 * DMA helpers split the transfer in multiple segments. Do not
2688 * build a CDB smaller than what the guest wanted, and only build
2689 * a larger one if strictly necessary.
2691 io_header->cmdp = req->cdb;
2692 lba = offset / s->qdev.blocksize;
2693 nb_logical_blocks = io_header->dxfer_len / s->qdev.blocksize;
2695 if ((req->cmd >> 5) == 0 && lba <= 0x1ffff) {
2696 /* 6-byte CDB */
2697 stl_be_p(&req->cdb[0], lba | (req->cmd << 24));
2698 req->cdb[4] = nb_logical_blocks;
2699 req->cdb[5] = 0;
2700 io_header->cmd_len = 6;
2701 } else if ((req->cmd >> 5) <= 1 && lba <= 0xffffffffULL) {
2702 /* 10-byte CDB */
2703 req->cdb[0] = (req->cmd & 0x1f) | 0x20;
2704 req->cdb[1] = req->cdb1;
2705 stl_be_p(&req->cdb[2], lba);
2706 req->cdb[6] = req->group_number;
2707 stw_be_p(&req->cdb[7], nb_logical_blocks);
2708 req->cdb[9] = 0;
2709 io_header->cmd_len = 10;
2710 } else if ((req->cmd >> 5) != 4 && lba <= 0xffffffffULL) {
2711 /* 12-byte CDB */
2712 req->cdb[0] = (req->cmd & 0x1f) | 0xA0;
2713 req->cdb[1] = req->cdb1;
2714 stl_be_p(&req->cdb[2], lba);
2715 stl_be_p(&req->cdb[6], nb_logical_blocks);
2716 req->cdb[10] = req->group_number;
2717 req->cdb[11] = 0;
2718 io_header->cmd_len = 12;
2719 } else {
2720 /* 16-byte CDB */
2721 req->cdb[0] = (req->cmd & 0x1f) | 0x80;
2722 req->cdb[1] = req->cdb1;
2723 stq_be_p(&req->cdb[2], lba);
2724 stl_be_p(&req->cdb[10], nb_logical_blocks);
2725 req->cdb[14] = req->group_number;
2726 req->cdb[15] = 0;
2727 io_header->cmd_len = 16;
2730 /* The rest is as in scsi-generic.c. */
2731 io_header->mx_sb_len = sizeof(r->req.sense);
2732 io_header->sbp = r->req.sense;
2733 io_header->timeout = UINT_MAX;
2734 io_header->usr_ptr = r;
2735 io_header->flags |= SG_FLAG_DIRECT_IO;
2737 aiocb = blk_aio_ioctl(s->qdev.conf.blk, SG_IO, io_header, cb, opaque);
2738 assert(aiocb != NULL);
2739 return aiocb;
2742 static bool scsi_block_no_fua(SCSICommand *cmd)
2744 return false;
2747 static BlockAIOCB *scsi_block_dma_readv(int64_t offset,
2748 QEMUIOVector *iov,
2749 BlockCompletionFunc *cb, void *cb_opaque,
2750 void *opaque)
2752 SCSIBlockReq *r = opaque;
2753 return scsi_block_do_sgio(r, offset, iov,
2754 SG_DXFER_FROM_DEV, cb, cb_opaque);
2757 static BlockAIOCB *scsi_block_dma_writev(int64_t offset,
2758 QEMUIOVector *iov,
2759 BlockCompletionFunc *cb, void *cb_opaque,
2760 void *opaque)
2762 SCSIBlockReq *r = opaque;
2763 return scsi_block_do_sgio(r, offset, iov,
2764 SG_DXFER_TO_DEV, cb, cb_opaque);
2767 static bool scsi_block_is_passthrough(SCSIDiskState *s, uint8_t *buf)
2769 switch (buf[0]) {
2770 case VERIFY_10:
2771 case VERIFY_12:
2772 case VERIFY_16:
2773 /* Check if BYTCHK == 0x01 (data-out buffer contains data
2774 * for the number of logical blocks specified in the length
2775 * field). For other modes, do not use scatter/gather operation.
2777 if ((buf[1] & 6) == 2) {
2778 return false;
2780 break;
2782 case READ_6:
2783 case READ_10:
2784 case READ_12:
2785 case READ_16:
2786 case WRITE_6:
2787 case WRITE_10:
2788 case WRITE_12:
2789 case WRITE_16:
2790 case WRITE_VERIFY_10:
2791 case WRITE_VERIFY_12:
2792 case WRITE_VERIFY_16:
2793 /* MMC writing cannot be done via DMA helpers, because it sometimes
2794 * involves writing beyond the maximum LBA or to negative LBA (lead-in).
2795 * We might use scsi_block_dma_reqops as long as no writing commands are
2796 * seen, but performance usually isn't paramount on optical media. So,
2797 * just make scsi-block operate the same as scsi-generic for them.
2799 if (s->qdev.type != TYPE_ROM) {
2800 return false;
2802 break;
2804 default:
2805 break;
2808 return true;
2812 static int32_t scsi_block_dma_command(SCSIRequest *req, uint8_t *buf)
2814 SCSIBlockReq *r = (SCSIBlockReq *)req;
2815 r->cmd = req->cmd.buf[0];
2816 switch (r->cmd >> 5) {
2817 case 0:
2818 /* 6-byte CDB. */
2819 r->cdb1 = r->group_number = 0;
2820 break;
2821 case 1:
2822 /* 10-byte CDB. */
2823 r->cdb1 = req->cmd.buf[1];
2824 r->group_number = req->cmd.buf[6];
2825 break;
2826 case 4:
2827 /* 12-byte CDB. */
2828 r->cdb1 = req->cmd.buf[1];
2829 r->group_number = req->cmd.buf[10];
2830 break;
2831 case 5:
2832 /* 16-byte CDB. */
2833 r->cdb1 = req->cmd.buf[1];
2834 r->group_number = req->cmd.buf[14];
2835 break;
2836 default:
2837 abort();
2840 if (r->cdb1 & 0xe0) {
2841 /* Protection information is not supported. */
2842 scsi_check_condition(&r->req, SENSE_CODE(INVALID_FIELD));
2843 return 0;
2846 r->req.status = &r->io_header.status;
2847 return scsi_disk_dma_command(req, buf);
2850 static const SCSIReqOps scsi_block_dma_reqops = {
2851 .size = sizeof(SCSIBlockReq),
2852 .free_req = scsi_free_request,
2853 .send_command = scsi_block_dma_command,
2854 .read_data = scsi_read_data,
2855 .write_data = scsi_write_data,
2856 .get_buf = scsi_get_buf,
2857 .load_request = scsi_disk_load_request,
2858 .save_request = scsi_disk_save_request,
2861 static SCSIRequest *scsi_block_new_request(SCSIDevice *d, uint32_t tag,
2862 uint32_t lun, uint8_t *buf,
2863 void *hba_private)
2865 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, d);
2867 if (scsi_block_is_passthrough(s, buf)) {
2868 return scsi_req_alloc(&scsi_generic_req_ops, &s->qdev, tag, lun,
2869 hba_private);
2870 } else {
2871 return scsi_req_alloc(&scsi_block_dma_reqops, &s->qdev, tag, lun,
2872 hba_private);
2876 static int scsi_block_parse_cdb(SCSIDevice *d, SCSICommand *cmd,
2877 uint8_t *buf, void *hba_private)
2879 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, d);
2881 if (scsi_block_is_passthrough(s, buf)) {
2882 return scsi_bus_parse_cdb(&s->qdev, cmd, buf, hba_private);
2883 } else {
2884 return scsi_req_parse_cdb(&s->qdev, cmd, buf);
2888 #endif
2890 static
2891 BlockAIOCB *scsi_dma_readv(int64_t offset, QEMUIOVector *iov,
2892 BlockCompletionFunc *cb, void *cb_opaque,
2893 void *opaque)
2895 SCSIDiskReq *r = opaque;
2896 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
2897 return blk_aio_preadv(s->qdev.conf.blk, offset, iov, 0, cb, cb_opaque);
2900 static
2901 BlockAIOCB *scsi_dma_writev(int64_t offset, QEMUIOVector *iov,
2902 BlockCompletionFunc *cb, void *cb_opaque,
2903 void *opaque)
2905 SCSIDiskReq *r = opaque;
2906 SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
2907 return blk_aio_pwritev(s->qdev.conf.blk, offset, iov, 0, cb, cb_opaque);
2910 static void scsi_disk_base_class_initfn(ObjectClass *klass, void *data)
2912 DeviceClass *dc = DEVICE_CLASS(klass);
2913 SCSIDiskClass *sdc = SCSI_DISK_BASE_CLASS(klass);
2915 dc->fw_name = "disk";
2916 dc->reset = scsi_disk_reset;
2917 sdc->dma_readv = scsi_dma_readv;
2918 sdc->dma_writev = scsi_dma_writev;
2919 sdc->need_fua_emulation = scsi_is_cmd_fua;
2922 static const TypeInfo scsi_disk_base_info = {
2923 .name = TYPE_SCSI_DISK_BASE,
2924 .parent = TYPE_SCSI_DEVICE,
2925 .class_init = scsi_disk_base_class_initfn,
2926 .instance_size = sizeof(SCSIDiskState),
2927 .class_size = sizeof(SCSIDiskClass),
2928 .abstract = true,
2931 #define DEFINE_SCSI_DISK_PROPERTIES() \
2932 DEFINE_BLOCK_PROPERTIES(SCSIDiskState, qdev.conf), \
2933 DEFINE_BLOCK_ERROR_PROPERTIES(SCSIDiskState, qdev.conf), \
2934 DEFINE_PROP_STRING("ver", SCSIDiskState, version), \
2935 DEFINE_PROP_STRING("serial", SCSIDiskState, serial), \
2936 DEFINE_PROP_STRING("vendor", SCSIDiskState, vendor), \
2937 DEFINE_PROP_STRING("product", SCSIDiskState, product)
2939 static Property scsi_hd_properties[] = {
2940 DEFINE_SCSI_DISK_PROPERTIES(),
2941 DEFINE_PROP_BIT("removable", SCSIDiskState, features,
2942 SCSI_DISK_F_REMOVABLE, false),
2943 DEFINE_PROP_BIT("dpofua", SCSIDiskState, features,
2944 SCSI_DISK_F_DPOFUA, false),
2945 DEFINE_PROP_UINT64("wwn", SCSIDiskState, qdev.wwn, 0),
2946 DEFINE_PROP_UINT64("port_wwn", SCSIDiskState, qdev.port_wwn, 0),
2947 DEFINE_PROP_UINT16("port_index", SCSIDiskState, port_index, 0),
2948 DEFINE_PROP_UINT64("max_unmap_size", SCSIDiskState, max_unmap_size,
2949 DEFAULT_MAX_UNMAP_SIZE),
2950 DEFINE_PROP_UINT64("max_io_size", SCSIDiskState, max_io_size,
2951 DEFAULT_MAX_IO_SIZE),
2952 DEFINE_PROP_UINT16("rotation_rate", SCSIDiskState, rotation_rate, 0),
2953 DEFINE_BLOCK_CHS_PROPERTIES(SCSIDiskState, qdev.conf),
2954 DEFINE_PROP_END_OF_LIST(),
2957 static const VMStateDescription vmstate_scsi_disk_state = {
2958 .name = "scsi-disk",
2959 .version_id = 1,
2960 .minimum_version_id = 1,
2961 .fields = (VMStateField[]) {
2962 VMSTATE_SCSI_DEVICE(qdev, SCSIDiskState),
2963 VMSTATE_BOOL(media_changed, SCSIDiskState),
2964 VMSTATE_BOOL(media_event, SCSIDiskState),
2965 VMSTATE_BOOL(eject_request, SCSIDiskState),
2966 VMSTATE_BOOL(tray_open, SCSIDiskState),
2967 VMSTATE_BOOL(tray_locked, SCSIDiskState),
2968 VMSTATE_END_OF_LIST()
2972 static void scsi_hd_class_initfn(ObjectClass *klass, void *data)
2974 DeviceClass *dc = DEVICE_CLASS(klass);
2975 SCSIDeviceClass *sc = SCSI_DEVICE_CLASS(klass);
2977 sc->realize = scsi_hd_realize;
2978 sc->alloc_req = scsi_new_request;
2979 sc->unit_attention_reported = scsi_disk_unit_attention_reported;
2980 dc->desc = "virtual SCSI disk";
2981 dc->props = scsi_hd_properties;
2982 dc->vmsd = &vmstate_scsi_disk_state;
2985 static const TypeInfo scsi_hd_info = {
2986 .name = "scsi-hd",
2987 .parent = TYPE_SCSI_DISK_BASE,
2988 .class_init = scsi_hd_class_initfn,
2991 static Property scsi_cd_properties[] = {
2992 DEFINE_SCSI_DISK_PROPERTIES(),
2993 DEFINE_PROP_UINT64("wwn", SCSIDiskState, qdev.wwn, 0),
2994 DEFINE_PROP_UINT64("port_wwn", SCSIDiskState, qdev.port_wwn, 0),
2995 DEFINE_PROP_UINT16("port_index", SCSIDiskState, port_index, 0),
2996 DEFINE_PROP_UINT64("max_io_size", SCSIDiskState, max_io_size,
2997 DEFAULT_MAX_IO_SIZE),
2998 DEFINE_PROP_END_OF_LIST(),
3001 static void scsi_cd_class_initfn(ObjectClass *klass, void *data)
3003 DeviceClass *dc = DEVICE_CLASS(klass);
3004 SCSIDeviceClass *sc = SCSI_DEVICE_CLASS(klass);
3006 sc->realize = scsi_cd_realize;
3007 sc->alloc_req = scsi_new_request;
3008 sc->unit_attention_reported = scsi_disk_unit_attention_reported;
3009 dc->desc = "virtual SCSI CD-ROM";
3010 dc->props = scsi_cd_properties;
3011 dc->vmsd = &vmstate_scsi_disk_state;
3014 static const TypeInfo scsi_cd_info = {
3015 .name = "scsi-cd",
3016 .parent = TYPE_SCSI_DISK_BASE,
3017 .class_init = scsi_cd_class_initfn,
3020 #ifdef __linux__
3021 static Property scsi_block_properties[] = {
3022 DEFINE_BLOCK_ERROR_PROPERTIES(SCSIDiskState, qdev.conf), \
3023 DEFINE_PROP_DRIVE("drive", SCSIDiskState, qdev.conf.blk),
3024 DEFINE_PROP_BOOL("share-rw", SCSIDiskState, qdev.conf.share_rw, false),
3025 DEFINE_PROP_UINT16("rotation_rate", SCSIDiskState, rotation_rate, 0),
3026 DEFINE_PROP_END_OF_LIST(),
3029 static void scsi_block_class_initfn(ObjectClass *klass, void *data)
3031 DeviceClass *dc = DEVICE_CLASS(klass);
3032 SCSIDeviceClass *sc = SCSI_DEVICE_CLASS(klass);
3033 SCSIDiskClass *sdc = SCSI_DISK_BASE_CLASS(klass);
3035 sc->realize = scsi_block_realize;
3036 sc->alloc_req = scsi_block_new_request;
3037 sc->parse_cdb = scsi_block_parse_cdb;
3038 sdc->dma_readv = scsi_block_dma_readv;
3039 sdc->dma_writev = scsi_block_dma_writev;
3040 sdc->need_fua_emulation = scsi_block_no_fua;
3041 dc->desc = "SCSI block device passthrough";
3042 dc->props = scsi_block_properties;
3043 dc->vmsd = &vmstate_scsi_disk_state;
3046 static const TypeInfo scsi_block_info = {
3047 .name = "scsi-block",
3048 .parent = TYPE_SCSI_DISK_BASE,
3049 .class_init = scsi_block_class_initfn,
3051 #endif
3053 static Property scsi_disk_properties[] = {
3054 DEFINE_SCSI_DISK_PROPERTIES(),
3055 DEFINE_PROP_BIT("removable", SCSIDiskState, features,
3056 SCSI_DISK_F_REMOVABLE, false),
3057 DEFINE_PROP_BIT("dpofua", SCSIDiskState, features,
3058 SCSI_DISK_F_DPOFUA, false),
3059 DEFINE_PROP_UINT64("wwn", SCSIDiskState, qdev.wwn, 0),
3060 DEFINE_PROP_UINT64("port_wwn", SCSIDiskState, qdev.port_wwn, 0),
3061 DEFINE_PROP_UINT16("port_index", SCSIDiskState, port_index, 0),
3062 DEFINE_PROP_UINT64("max_unmap_size", SCSIDiskState, max_unmap_size,
3063 DEFAULT_MAX_UNMAP_SIZE),
3064 DEFINE_PROP_UINT64("max_io_size", SCSIDiskState, max_io_size,
3065 DEFAULT_MAX_IO_SIZE),
3066 DEFINE_PROP_END_OF_LIST(),
3069 static void scsi_disk_class_initfn(ObjectClass *klass, void *data)
3071 DeviceClass *dc = DEVICE_CLASS(klass);
3072 SCSIDeviceClass *sc = SCSI_DEVICE_CLASS(klass);
3074 sc->realize = scsi_disk_realize;
3075 sc->alloc_req = scsi_new_request;
3076 sc->unit_attention_reported = scsi_disk_unit_attention_reported;
3077 dc->fw_name = "disk";
3078 dc->desc = "virtual SCSI disk or CD-ROM (legacy)";
3079 dc->reset = scsi_disk_reset;
3080 dc->props = scsi_disk_properties;
3081 dc->vmsd = &vmstate_scsi_disk_state;
3084 static const TypeInfo scsi_disk_info = {
3085 .name = "scsi-disk",
3086 .parent = TYPE_SCSI_DISK_BASE,
3087 .class_init = scsi_disk_class_initfn,
3090 static void scsi_disk_register_types(void)
3092 type_register_static(&scsi_disk_base_info);
3093 type_register_static(&scsi_hd_info);
3094 type_register_static(&scsi_cd_info);
3095 #ifdef __linux__
3096 type_register_static(&scsi_block_info);
3097 #endif
3098 type_register_static(&scsi_disk_info);
3101 type_init(scsi_disk_register_types)