scsi-disk.c 62.5 KB
Newer Older
P
pbrook 已提交
1 2 3 4 5 6 7
/*
 * SCSI Device emulation
 *
 * Copyright (c) 2006 CodeSourcery.
 * Based on code by Fabrice Bellard
 *
 * Written by Paul Brook
8 9 10 11 12 13
 * Modifications:
 *  2009-Dec-12 Artyom Tarasenko : implemented stamdard inquiry for the case
 *                                 when the allocation length of CDB is smaller
 *                                 than 36.
 *  2009-Oct-13 Artyom Tarasenko : implemented the block descriptor in the
 *                                 MODE SENSE response.
P
pbrook 已提交
14
 *
M
Matthew Fernandez 已提交
15
 * This code is licensed under the LGPL.
P
pbrook 已提交
16 17
 *
 * Note that this file only handles the SCSI architecture model and device
18 19
 * commands.  Emulation of interface/link layer protocols is handled by
 * the host adapter emulator.
P
pbrook 已提交
20 21 22 23 24
 */

//#define DEBUG_SCSI

#ifdef DEBUG_SCSI
25 26
#define DPRINTF(fmt, ...) \
do { printf("scsi-disk: " fmt , ## __VA_ARGS__); } while (0)
P
pbrook 已提交
27
#else
28
#define DPRINTF(fmt, ...) do {} while(0)
P
pbrook 已提交
29 30
#endif

P
pbrook 已提交
31
#include "qemu-common.h"
32
#include "qemu-error.h"
G
Gerd Hoffmann 已提交
33
#include "scsi.h"
G
Gerd Hoffmann 已提交
34
#include "scsi-defs.h"
35
#include "sysemu.h"
B
Blue Swirl 已提交
36
#include "blockdev.h"
37
#include "hw/block-common.h"
38
#include "dma.h"
39

40 41 42 43
#ifdef __linux
#include <scsi/sg.h>
#endif

44
#define SCSI_DMA_BUF_SIZE    131072
45
#define SCSI_MAX_INQUIRY_LEN 256
P
pbrook 已提交
46

47 48
typedef struct SCSIDiskState SCSIDiskState;

49 50
typedef struct SCSIDiskReq {
    SCSIRequest req;
P
pbrook 已提交
51
    /* Both sector and sector_count are in terms of qemu 512 byte blocks.  */
52 53
    uint64_t sector;
    uint32_t sector_count;
54
    uint32_t buflen;
55
    bool started;
56 57
    struct iovec iov;
    QEMUIOVector qiov;
58
    BlockAcctCookie acct;
59
} SCSIDiskReq;
P
pbrook 已提交
60

61
#define SCSI_DISK_F_REMOVABLE   0
P
Paolo Bonzini 已提交
62
#define SCSI_DISK_F_DPOFUA      1
63

64
struct SCSIDiskState
P
pbrook 已提交
65
{
66
    SCSIDevice qdev;
67
    uint32_t features;
68
    bool media_changed;
69
    bool media_event;
70
    bool eject_request;
71
    uint64_t wwn;
72
    QEMUBH *bh;
G
Gerd Hoffmann 已提交
73
    char *version;
74
    char *serial;
75
    bool tray_open;
76
    bool tray_locked;
P
pbrook 已提交
77 78
};

79
static int scsi_handle_rw_error(SCSIDiskReq *r, int error);
K
Kevin Wolf 已提交
80

P
Paolo Bonzini 已提交
81
static void scsi_free_request(SCSIRequest *req)
P
pbrook 已提交
82
{
P
Paolo Bonzini 已提交
83 84
    SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);

85 86 87
    if (r->iov.iov_base) {
        qemu_vfree(r->iov.iov_base);
    }
P
pbrook 已提交
88 89
}

90 91
/* Helper function for command completion with sense.  */
static void scsi_check_condition(SCSIDiskReq *r, SCSISense sense)
G
Gerd Hoffmann 已提交
92
{
B
Blue Swirl 已提交
93 94
    DPRINTF("Command complete tag=0x%x sense=%d/%d/%d\n",
            r->req.tag, sense.key, sense.asc, sense.ascq);
95 96
    scsi_req_build_sense(&r->req, sense);
    scsi_req_complete(&r->req, CHECK_CONDITION);
P
pbrook 已提交
97 98 99
}

/* Cancel a pending data transfer.  */
100
static void scsi_cancel_io(SCSIRequest *req)
P
pbrook 已提交
101
{
102 103 104 105 106
    SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);

    DPRINTF("Cancel tag=0x%x\n", req->tag);
    if (r->req.aiocb) {
        bdrv_aio_cancel(r->req.aiocb);
107 108 109 110 111

        /* This reference was left in by scsi_*_data.  We take ownership of
         * it the moment scsi_req_cancel is called, independent of whether
         * bdrv_aio_cancel completes the request or not.  */
        scsi_req_unref(&r->req);
P
pbrook 已提交
112
    }
113
    r->req.aiocb = NULL;
P
pbrook 已提交
114 115
}

P
Paolo Bonzini 已提交
116
static uint32_t scsi_init_iovec(SCSIDiskReq *r, size_t size)
117
{
118 119 120
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);

    if (!r->iov.iov_base) {
P
Paolo Bonzini 已提交
121
        r->buflen = size;
122
        r->iov.iov_base = qemu_blockalign(s->qdev.conf.bs, r->buflen);
123 124
    }
    r->iov.iov_len = MIN(r->sector_count * 512, r->buflen);
125 126 127 128
    qemu_iovec_init_external(&r->qiov, &r->iov, 1);
    return r->qiov.size / 512;
}

P
Paolo Bonzini 已提交
129 130 131 132 133 134 135
static void scsi_disk_save_request(QEMUFile *f, SCSIRequest *req)
{
    SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);

    qemu_put_be64s(f, &r->sector);
    qemu_put_be32s(f, &r->sector_count);
    qemu_put_be32s(f, &r->buflen);
136 137 138 139 140 141 142 143
    if (r->buflen) {
        if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
            qemu_put_buffer(f, r->iov.iov_base, r->iov.iov_len);
        } else if (!req->retry) {
            uint32_t len = r->iov.iov_len;
            qemu_put_be32s(f, &len);
            qemu_put_buffer(f, r->iov.iov_base, r->iov.iov_len);
        }
P
Paolo Bonzini 已提交
144 145 146 147 148 149 150 151 152 153 154 155 156 157
    }
}

static void scsi_disk_load_request(QEMUFile *f, SCSIRequest *req)
{
    SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);

    qemu_get_be64s(f, &r->sector);
    qemu_get_be32s(f, &r->sector_count);
    qemu_get_be32s(f, &r->buflen);
    if (r->buflen) {
        scsi_init_iovec(r, r->buflen);
        if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
            qemu_get_buffer(f, r->iov.iov_base, r->iov.iov_len);
158 159 160 161 162 163
        } else if (!r->req.retry) {
            uint32_t len;
            qemu_get_be32s(f, &len);
            r->iov.iov_len = len;
            assert(r->iov.iov_len <= r->buflen);
            qemu_get_buffer(f, r->iov.iov_base, r->iov.iov_len);
P
Paolo Bonzini 已提交
164 165 166 167 168 169
        }
    }

    qemu_iovec_init_external(&r->qiov, &r->iov, 1);
}

170
static void scsi_flush_complete(void * opaque, int ret)
171 172 173 174 175 176
{
    SCSIDiskReq *r = (SCSIDiskReq *)opaque;
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);

    bdrv_acct_done(s->qdev.conf.bs, &r->acct);

177
    if (ret < 0) {
178 179 180 181 182 183 184 185
        if (scsi_handle_rw_error(r, -ret)) {
            goto done;
        }
    }

    scsi_req_complete(&r->req, GOOD);

done:
186 187 188
    if (!r->req.io_canceled) {
        scsi_req_unref(&r->req);
    }
189 190
}

191 192 193 194 195 196 197 198 199 200 201
static bool scsi_is_cmd_fua(SCSICommand *cmd)
{
    switch (cmd->buf[0]) {
    case READ_10:
    case READ_12:
    case READ_16:
    case WRITE_10:
    case WRITE_12:
    case WRITE_16:
        return (cmd->buf[1] & 8) != 0;

202 203 204
    case VERIFY_10:
    case VERIFY_12:
    case VERIFY_16:
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
    case WRITE_VERIFY_10:
    case WRITE_VERIFY_12:
    case WRITE_VERIFY_16:
        return true;

    case READ_6:
    case WRITE_6:
    default:
        return false;
    }
}

static void scsi_write_do_fua(SCSIDiskReq *r)
{
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);

    if (scsi_is_cmd_fua(&r->req.cmd)) {
        bdrv_acct_start(s->qdev.conf.bs, &r->acct, 0, BDRV_ACCT_FLUSH);
        r->req.aiocb = bdrv_aio_flush(s->qdev.conf.bs, scsi_flush_complete, r);
        return;
    }

    scsi_req_complete(&r->req, GOOD);
    if (!r->req.io_canceled) {
        scsi_req_unref(&r->req);
    }
}

233
static void scsi_dma_complete(void *opaque, int ret)
P
pbrook 已提交
234
{
235
    SCSIDiskReq *r = (SCSIDiskReq *)opaque;
236
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
P
pbrook 已提交
237

238 239 240 241
    if (r->req.aiocb != NULL) {
        r->req.aiocb = NULL;
        bdrv_acct_done(s->qdev.conf.bs, &r->acct);
    }
242

243
    if (ret < 0) {
244
        if (scsi_handle_rw_error(r, -ret)) {
245
            goto done;
K
Kevin Wolf 已提交
246
        }
P
pbrook 已提交
247
    }
K
Kevin Wolf 已提交
248

249 250
    r->sector += r->sector_count;
    r->sector_count = 0;
251 252 253 254 255 256
    if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
        scsi_write_do_fua(r);
        return;
    } else {
        scsi_req_complete(&r->req, GOOD);
    }
257 258 259 260 261

done:
    if (!r->req.io_canceled) {
        scsi_req_unref(&r->req);
    }
P
pbrook 已提交
262 263
}

264
static void scsi_read_complete(void * opaque, int ret)
265 266 267
{
    SCSIDiskReq *r = (SCSIDiskReq *)opaque;
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
268
    int n;
269

270 271 272 273
    if (r->req.aiocb != NULL) {
        r->req.aiocb = NULL;
        bdrv_acct_done(s->qdev.conf.bs, &r->acct);
    }
274 275

    if (ret < 0) {
276
        if (scsi_handle_rw_error(r, -ret)) {
277
            goto done;
278 279 280
        }
    }

281 282 283 284 285 286
    DPRINTF("Data ready tag=0x%x len=%zd\n", r->req.tag, r->qiov.size);

    n = r->qiov.size / 512;
    r->sector += n;
    r->sector_count -= n;
    scsi_req_data(&r->req, r->qiov.size);
287 288 289 290 291

done:
    if (!r->req.io_canceled) {
        scsi_req_unref(&r->req);
    }
292
}
K
Kevin Wolf 已提交
293

P
Paolo Bonzini 已提交
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
/* Actually issue a read to the block device.  */
static void scsi_do_read(void *opaque, int ret)
{
    SCSIDiskReq *r = opaque;
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
    uint32_t n;

    if (r->req.aiocb != NULL) {
        r->req.aiocb = NULL;
        bdrv_acct_done(s->qdev.conf.bs, &r->acct);
    }

    if (ret < 0) {
        if (scsi_handle_rw_error(r, -ret)) {
            goto done;
        }
    }

P
Paolo Bonzini 已提交
312 313 314 315 316 317 318
    if (r->req.io_canceled) {
        return;
    }

    /* The request is used as the AIO opaque value, so add a ref.  */
    scsi_req_ref(&r->req);

P
Paolo Bonzini 已提交
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
    if (r->req.sg) {
        dma_acct_start(s->qdev.conf.bs, &r->acct, r->req.sg, BDRV_ACCT_READ);
        r->req.resid -= r->req.sg->size;
        r->req.aiocb = dma_bdrv_read(s->qdev.conf.bs, r->req.sg, r->sector,
                                     scsi_dma_complete, r);
    } else {
        n = scsi_init_iovec(r, SCSI_DMA_BUF_SIZE);
        bdrv_acct_start(s->qdev.conf.bs, &r->acct, n * BDRV_SECTOR_SIZE, BDRV_ACCT_READ);
        r->req.aiocb = bdrv_aio_readv(s->qdev.conf.bs, r->sector, &r->qiov, n,
                                      scsi_read_complete, r);
    }

done:
    if (!r->req.io_canceled) {
        scsi_req_unref(&r->req);
    }
}

337 338
/* Read more data from scsi device into buffer.  */
static void scsi_read_data(SCSIRequest *req)
P
pbrook 已提交
339
{
340
    SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
K
Kevin Wolf 已提交
341
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
P
Paolo Bonzini 已提交
342
    bool first;
P
pbrook 已提交
343

P
pbrook 已提交
344
    if (r->sector_count == (uint32_t)-1) {
345
        DPRINTF("Read buf_len=%zd\n", r->iov.iov_len);
P
pbrook 已提交
346
        r->sector_count = 0;
347
        r->started = true;
P
Paolo Bonzini 已提交
348
        scsi_req_data(&r->req, r->iov.iov_len);
P
pbrook 已提交
349
        return;
P
pbrook 已提交
350
    }
P
pbrook 已提交
351 352
    DPRINTF("Read sector_count=%d\n", r->sector_count);
    if (r->sector_count == 0) {
353 354
        /* This also clears the sense buffer for REQUEST SENSE.  */
        scsi_req_complete(&r->req, GOOD);
P
pbrook 已提交
355
        return;
P
pbrook 已提交
356 357
    }

358 359 360
    /* No data transfer may already be in progress */
    assert(r->req.aiocb == NULL);

361 362
    /* The request is used as the AIO opaque value, so add a ref.  */
    scsi_req_ref(&r->req);
363 364 365 366 367 368
    if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
        DPRINTF("Data transfer direction invalid\n");
        scsi_read_complete(r, -EINVAL);
        return;
    }

369 370
    if (s->tray_open) {
        scsi_read_complete(r, -ENOMEDIUM);
371
        return;
372
    }
373

P
Paolo Bonzini 已提交
374
    first = !r->started;
375
    r->started = true;
P
Paolo Bonzini 已提交
376 377 378
    if (first && scsi_is_cmd_fua(&r->req.cmd)) {
        bdrv_acct_start(s->qdev.conf.bs, &r->acct, 0, BDRV_ACCT_FLUSH);
        r->req.aiocb = bdrv_aio_flush(s->qdev.conf.bs, scsi_do_read, r);
379
    } else {
P
Paolo Bonzini 已提交
380
        scsi_do_read(r, 0);
381
    }
P
pbrook 已提交
382 383
}

384 385 386 387 388 389 390
/*
 * scsi_handle_rw_error has two return values.  0 means that the error
 * must be ignored, 1 means that the error has been processed and the
 * caller should not do anything else for this request.  Note that
 * scsi_handle_rw_error always manages its reference counts, independent
 * of the return value.
 */
391
static int scsi_handle_rw_error(SCSIDiskReq *r, int error)
K
Kevin Wolf 已提交
392
{
393
    int is_read = (r->req.cmd.xfer == SCSI_XFER_FROM_DEV);
394
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
395
    BlockErrorAction action = bdrv_get_on_error(s->qdev.conf.bs, is_read);
396

397
    if (action == BLOCK_ERR_IGNORE) {
398
        bdrv_emit_qmp_error_event(s->qdev.conf.bs, BDRV_ACTION_IGNORE, is_read);
399
        return 0;
400
    }
401 402 403

    if ((error == ENOSPC && action == BLOCK_ERR_STOP_ENOSPC)
            || action == BLOCK_ERR_STOP_ANY) {
K
Kevin Wolf 已提交
404

405
        bdrv_emit_qmp_error_event(s->qdev.conf.bs, BDRV_ACTION_STOP, is_read);
406
        vm_stop(RUN_STATE_IO_ERROR);
407
        bdrv_iostatus_set_err(s->qdev.conf.bs, error);
408
        scsi_req_retry(&r->req);
409
    } else {
410
        switch (error) {
411 412 413
        case ENOMEDIUM:
            scsi_check_condition(r, SENSE_CODE(NO_MEDIUM));
            break;
414
        case ENOMEM:
415
            scsi_check_condition(r, SENSE_CODE(TARGET_FAILURE));
416 417
            break;
        case EINVAL:
418
            scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
419 420
            break;
        default:
421
            scsi_check_condition(r, SENSE_CODE(IO_ERROR));
422
            break;
423
        }
424
        bdrv_emit_qmp_error_event(s->qdev.conf.bs, BDRV_ACTION_REPORT, is_read);
425 426 427 428
    }
    return 1;
}

P
pbrook 已提交
429 430
static void scsi_write_complete(void * opaque, int ret)
{
431
    SCSIDiskReq *r = (SCSIDiskReq *)opaque;
432
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
433 434
    uint32_t n;

P
Paolo Bonzini 已提交
435 436
    if (r->req.aiocb != NULL) {
        r->req.aiocb = NULL;
437
        bdrv_acct_done(s->qdev.conf.bs, &r->acct);
P
Paolo Bonzini 已提交
438
    }
439

440
    if (ret < 0) {
441
        if (scsi_handle_rw_error(r, -ret)) {
442
            goto done;
K
Kevin Wolf 已提交
443
        }
P
pbrook 已提交
444 445
    }

446
    n = r->qiov.size / 512;
447 448
    r->sector += n;
    r->sector_count -= n;
P
pbrook 已提交
449
    if (r->sector_count == 0) {
450 451
        scsi_write_do_fua(r);
        return;
P
pbrook 已提交
452
    } else {
P
Paolo Bonzini 已提交
453
        scsi_init_iovec(r, SCSI_DMA_BUF_SIZE);
454 455
        DPRINTF("Write complete tag=0x%x more=%d\n", r->req.tag, r->qiov.size);
        scsi_req_data(&r->req, r->qiov.size);
P
pbrook 已提交
456
    }
457 458 459 460 461

done:
    if (!r->req.io_canceled) {
        scsi_req_unref(&r->req);
    }
P
pbrook 已提交
462 463
}

464
static void scsi_write_data(SCSIRequest *req)
465
{
466
    SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
467
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
468 469
    uint32_t n;

470 471 472
    /* No data transfer may already be in progress */
    assert(r->req.aiocb == NULL);

473 474
    /* The request is used as the AIO opaque value, so add a ref.  */
    scsi_req_ref(&r->req);
475 476 477
    if (r->req.cmd.mode != SCSI_XFER_TO_DEV) {
        DPRINTF("Data transfer direction invalid\n");
        scsi_write_complete(r, -EINVAL);
478
        return;
479 480
    }

481 482
    if (!r->req.sg && !r->qiov.size) {
        /* Called for the first time.  Ask the driver to send us more data.  */
483
        r->started = true;
484 485 486 487 488 489 490 491
        scsi_write_complete(r, 0);
        return;
    }
    if (s->tray_open) {
        scsi_write_complete(r, -ENOMEDIUM);
        return;
    }

492 493 494 495 496 497 498 499 500 501
    if (r->req.cmd.buf[0] == VERIFY_10 || r->req.cmd.buf[0] == VERIFY_12 ||
        r->req.cmd.buf[0] == VERIFY_16) {
        if (r->req.sg) {
            scsi_dma_complete(r, 0);
        } else {
            scsi_write_complete(r, 0);
        }
        return;
    }

502 503 504 505 506 507 508
    if (r->req.sg) {
        dma_acct_start(s->qdev.conf.bs, &r->acct, r->req.sg, BDRV_ACCT_WRITE);
        r->req.resid -= r->req.sg->size;
        r->req.aiocb = dma_bdrv_write(s->qdev.conf.bs, r->req.sg, r->sector,
                                      scsi_dma_complete, r);
    } else {
        n = r->qiov.size / 512;
509 510
        bdrv_acct_start(s->qdev.conf.bs, &r->acct, n * BDRV_SECTOR_SIZE, BDRV_ACCT_WRITE);
        r->req.aiocb = bdrv_aio_writev(s->qdev.conf.bs, r->sector, &r->qiov, n,
511
                                       scsi_write_complete, r);
512
    }
P
pbrook 已提交
513
}
P
pbrook 已提交
514

P
pbrook 已提交
515
/* Return a pointer to the data buffer.  */
516
static uint8_t *scsi_get_buf(SCSIRequest *req)
P
pbrook 已提交
517
{
518
    SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
P
pbrook 已提交
519

520
    return (uint8_t *)r->iov.iov_base;
P
pbrook 已提交
521 522
}

523 524
static int scsi_disk_emulate_inquiry(SCSIRequest *req, uint8_t *outbuf)
{
G
Gerd Hoffmann 已提交
525
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
526
    int buflen = 0;
527
    int start;
528 529 530 531 532

    if (req->cmd.buf[1] & 0x1) {
        /* Vital product data */
        uint8_t page_code = req->cmd.buf[2];

533
        outbuf[buflen++] = s->qdev.type & 0x1f;
534 535
        outbuf[buflen++] = page_code ; // this page
        outbuf[buflen++] = 0x00;
536 537
        outbuf[buflen++] = 0x00;
        start = buflen;
538 539 540

        switch (page_code) {
        case 0x00: /* Supported page codes, mandatory */
H
Hannes Reinecke 已提交
541
        {
542 543 544
            DPRINTF("Inquiry EVPD[Supported pages] "
                    "buffer size %zd\n", req->cmd.xfer);
            outbuf[buflen++] = 0x00; // list of supported pages (this page)
545
            if (s->serial) {
546
                outbuf[buflen++] = 0x80; // unit serial number
547
            }
548
            outbuf[buflen++] = 0x83; // device identification
H
Hannes Reinecke 已提交
549
            if (s->qdev.type == TYPE_DISK) {
550 551
                outbuf[buflen++] = 0xb0; // block limits
                outbuf[buflen++] = 0xb2; // thin provisioning
H
Hannes Reinecke 已提交
552
            }
553
            break;
H
Hannes Reinecke 已提交
554
        }
555 556
        case 0x80: /* Device serial number, optional */
        {
557
            int l;
558

559 560 561 562 563 564
            if (!s->serial) {
                DPRINTF("Inquiry (EVPD[Serial number] not supported\n");
                return -1;
            }

            l = strlen(s->serial);
565
            if (l > 20) {
566
                l = 20;
567
            }
568 569 570

            DPRINTF("Inquiry EVPD[Serial number] "
                    "buffer size %zd\n", req->cmd.xfer);
571
            memcpy(outbuf+buflen, s->serial, l);
572 573 574 575 576 577
            buflen += l;
            break;
        }

        case 0x83: /* Device identification page, mandatory */
        {
578 579 580
            const char *str = s->serial ?: bdrv_get_device_name(s->qdev.conf.bs);
            int max_len = s->serial ? 20 : 255 - 8;
            int id_len = strlen(str);
581

582
            if (id_len > max_len) {
583
                id_len = max_len;
584
            }
585 586 587 588 589 590 591
            DPRINTF("Inquiry EVPD[Device identification] "
                    "buffer size %zd\n", req->cmd.xfer);

            outbuf[buflen++] = 0x2; // ASCII
            outbuf[buflen++] = 0;   // not officially assigned
            outbuf[buflen++] = 0;   // reserved
            outbuf[buflen++] = id_len; // length of data following
592
            memcpy(outbuf+buflen, str, id_len);
593
            buflen += id_len;
594 595 596 597 598 599 600 601 602

            if (s->wwn) {
                outbuf[buflen++] = 0x1; // Binary
                outbuf[buflen++] = 0x3; // NAA
                outbuf[buflen++] = 0;   // reserved
                outbuf[buflen++] = 8;
                stq_be_p(&outbuf[buflen], s->wwn);
                buflen += 8;
            }
603 604
            break;
        }
605
        case 0xb0: /* block limits */
C
Christoph Hellwig 已提交
606
        {
607 608
            unsigned int unmap_sectors =
                    s->qdev.conf.discard_granularity / s->qdev.blocksize;
609 610 611 612
            unsigned int min_io_size =
                    s->qdev.conf.min_io_size / s->qdev.blocksize;
            unsigned int opt_io_size =
                    s->qdev.conf.opt_io_size / s->qdev.blocksize;
C
Christoph Hellwig 已提交
613

H
Hannes Reinecke 已提交
614
            if (s->qdev.type == TYPE_ROM) {
H
Hannes Reinecke 已提交
615 616 617 618
                DPRINTF("Inquiry (EVPD[%02X] not supported for CDROM\n",
                        page_code);
                return -1;
            }
C
Christoph Hellwig 已提交
619
            /* required VPD size with unmap support */
620
            buflen = 0x40;
C
Christoph Hellwig 已提交
621 622 623 624 625 626 627 628 629 630 631
            memset(outbuf + 4, 0, buflen - 4);

            /* optimal transfer length granularity */
            outbuf[6] = (min_io_size >> 8) & 0xff;
            outbuf[7] = min_io_size & 0xff;

            /* optimal transfer length */
            outbuf[12] = (opt_io_size >> 24) & 0xff;
            outbuf[13] = (opt_io_size >> 16) & 0xff;
            outbuf[14] = (opt_io_size >> 8) & 0xff;
            outbuf[15] = opt_io_size & 0xff;
632 633 634 635 636 637 638 639 640 641

            /* optimal unmap granularity */
            outbuf[28] = (unmap_sectors >> 24) & 0xff;
            outbuf[29] = (unmap_sectors >> 16) & 0xff;
            outbuf[30] = (unmap_sectors >> 8) & 0xff;
            outbuf[31] = unmap_sectors & 0xff;
            break;
        }
        case 0xb2: /* thin provisioning */
        {
642
            buflen = 8;
643
            outbuf[4] = 0;
644
            outbuf[5] = 0x60; /* write_same 10/16 supported */
645
            outbuf[6] = s->qdev.conf.discard_granularity ? 2 : 1;
646
            outbuf[7] = 0;
C
Christoph Hellwig 已提交
647 648
            break;
        }
649 650 651 652
        default:
            return -1;
        }
        /* done with EVPD */
653 654
        assert(buflen - start <= 255);
        outbuf[start - 1] = buflen - start;
655 656 657 658 659 660 661 662 663 664
        return buflen;
    }

    /* Standard INQUIRY data */
    if (req->cmd.buf[2] != 0) {
        return -1;
    }

    /* PAGE CODE == 0 */
    buflen = req->cmd.xfer;
665
    if (buflen > SCSI_MAX_INQUIRY_LEN) {
666
        buflen = SCSI_MAX_INQUIRY_LEN;
667
    }
668 669
    memset(outbuf, 0, buflen);

H
Hannes Reinecke 已提交
670
    outbuf[0] = s->qdev.type & 0x1f;
671
    outbuf[1] = (s->features & (1 << SCSI_DISK_F_REMOVABLE)) ? 0x80 : 0;
H
Hannes Reinecke 已提交
672
    if (s->qdev.type == TYPE_ROM) {
L
Laszlo Ast 已提交
673
        memcpy(&outbuf[16], "QEMU CD-ROM     ", 16);
674
    } else {
L
Laszlo Ast 已提交
675
        memcpy(&outbuf[16], "QEMU HARDDISK   ", 16);
676
    }
L
Laszlo Ast 已提交
677
    memcpy(&outbuf[8], "QEMU    ", 8);
G
Gerd Hoffmann 已提交
678
    memset(&outbuf[32], 0, 4);
679
    memcpy(&outbuf[32], s->version, MIN(4, strlen(s->version)));
680 681 682 683 684 685
    /*
     * We claim conformance to SPC-3, which is required for guests
     * to ask for modern features like READ CAPACITY(16) or the
     * block characteristics VPD page by default.  Not all of SPC-3
     * is actually implemented, but we're good enough.
     */
C
Christoph Hellwig 已提交
686
    outbuf[2] = 5;
687
    outbuf[3] = 2; /* Format 2 */
688 689 690 691 692 693 694 695 696

    if (buflen > 36) {
        outbuf[4] = buflen - 5; /* Additional Length = (Len - 1) - 4 */
    } else {
        /* If the allocation length of CDB is too small,
               the additional length is not adjusted */
        outbuf[4] = 36 - 5;
    }

697
    /* Sync data transfer and TCQ.  */
698
    outbuf[7] = 0x10 | (req->bus->info->tcq ? 0x02 : 0);
699 700 701
    return buflen;
}

702 703 704 705 706 707
static inline bool media_is_dvd(SCSIDiskState *s)
{
    uint64_t nb_sectors;
    if (s->qdev.type != TYPE_ROM) {
        return false;
    }
708
    if (!bdrv_is_inserted(s->qdev.conf.bs)) {
709 710
        return false;
    }
711
    bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
712 713 714
    return nb_sectors > CD_MAX_SECTORS;
}

715 716 717 718 719 720
static inline bool media_is_cd(SCSIDiskState *s)
{
    uint64_t nb_sectors;
    if (s->qdev.type != TYPE_ROM) {
        return false;
    }
721
    if (!bdrv_is_inserted(s->qdev.conf.bs)) {
722 723
        return false;
    }
724
    bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
725 726 727
    return nb_sectors <= CD_MAX_SECTORS;
}

728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
static int scsi_read_disc_information(SCSIDiskState *s, SCSIDiskReq *r,
                                      uint8_t *outbuf)
{
    uint8_t type = r->req.cmd.buf[1] & 7;

    if (s->qdev.type != TYPE_ROM) {
        return -1;
    }

    /* Types 1/2 are only defined for Blu-Ray.  */
    if (type != 0) {
        scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
        return -1;
    }

    memset(outbuf, 0, 34);
    outbuf[1] = 32;
    outbuf[2] = 0xe; /* last session complete, disc finalized */
    outbuf[3] = 1;   /* first track on disc */
    outbuf[4] = 1;   /* # of sessions */
    outbuf[5] = 1;   /* first track of last session */
    outbuf[6] = 1;   /* last track of last session */
    outbuf[7] = 0x20; /* unrestricted use */
    outbuf[8] = 0x00; /* CD-ROM or DVD-ROM */
    /* 9-10-11: most significant byte corresponding bytes 4-5-6 */
    /* 12-23: not meaningful for CD-ROM or DVD-ROM */
    /* 24-31: disc bar code */
    /* 32: disc application code */
    /* 33: number of OPC tables */

    return 34;
}

761 762 763
static int scsi_read_dvd_structure(SCSIDiskState *s, SCSIDiskReq *r,
                                   uint8_t *outbuf)
{
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
    static const int rds_caps_size[5] = {
        [0] = 2048 + 4,
        [1] = 4 + 4,
        [3] = 188 + 4,
        [4] = 2048 + 4,
    };

    uint8_t media = r->req.cmd.buf[1];
    uint8_t layer = r->req.cmd.buf[6];
    uint8_t format = r->req.cmd.buf[7];
    int size = -1;

    if (s->qdev.type != TYPE_ROM) {
        return -1;
    }
    if (media != 0) {
        scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
        return -1;
    }

    if (format != 0xff) {
785
        if (s->tray_open || !bdrv_is_inserted(s->qdev.conf.bs)) {
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
            scsi_check_condition(r, SENSE_CODE(NO_MEDIUM));
            return -1;
        }
        if (media_is_cd(s)) {
            scsi_check_condition(r, SENSE_CODE(INCOMPATIBLE_FORMAT));
            return -1;
        }
        if (format >= ARRAY_SIZE(rds_caps_size)) {
            return -1;
        }
        size = rds_caps_size[format];
        memset(outbuf, 0, size);
    }

    switch (format) {
    case 0x00: {
        /* Physical format information */
        uint64_t nb_sectors;
        if (layer != 0) {
            goto fail;
        }
807
        bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851

        outbuf[4] = 1;   /* DVD-ROM, part version 1 */
        outbuf[5] = 0xf; /* 120mm disc, minimum rate unspecified */
        outbuf[6] = 1;   /* one layer, read-only (per MMC-2 spec) */
        outbuf[7] = 0;   /* default densities */

        stl_be_p(&outbuf[12], (nb_sectors >> 2) - 1); /* end sector */
        stl_be_p(&outbuf[16], (nb_sectors >> 2) - 1); /* l0 end sector */
        break;
    }

    case 0x01: /* DVD copyright information, all zeros */
        break;

    case 0x03: /* BCA information - invalid field for no BCA info */
        return -1;

    case 0x04: /* DVD disc manufacturing information, all zeros */
        break;

    case 0xff: { /* List capabilities */
        int i;
        size = 4;
        for (i = 0; i < ARRAY_SIZE(rds_caps_size); i++) {
            if (!rds_caps_size[i]) {
                continue;
            }
            outbuf[size] = i;
            outbuf[size + 1] = 0x40; /* Not writable, readable */
            stw_be_p(&outbuf[size + 2], rds_caps_size[i]);
            size += 4;
        }
        break;
     }

    default:
        return -1;
    }

    /* Size of buffer, not including 2 byte size field */
    stw_be_p(outbuf, size - 2);
    return size;

fail:
852 853 854
    return -1;
}

855
static int scsi_event_status_media(SCSIDiskState *s, uint8_t *outbuf)
856
{
857 858 859 860 861
    uint8_t event_code, media_status;

    media_status = 0;
    if (s->tray_open) {
        media_status = MS_TRAY_OPEN;
862
    } else if (bdrv_is_inserted(s->qdev.conf.bs)) {
863 864 865 866 867
        media_status = MS_MEDIA_PRESENT;
    }

    /* Event notification descriptor */
    event_code = MEC_NO_CHANGE;
868 869 870 871 872 873 874 875
    if (media_status != MS_TRAY_OPEN) {
        if (s->media_event) {
            event_code = MEC_NEW_MEDIA;
            s->media_event = false;
        } else if (s->eject_request) {
            event_code = MEC_EJECT_REQUESTED;
            s->eject_request = false;
        }
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911
    }

    outbuf[0] = event_code;
    outbuf[1] = media_status;

    /* These fields are reserved, just clear them. */
    outbuf[2] = 0;
    outbuf[3] = 0;
    return 4;
}

static int scsi_get_event_status_notification(SCSIDiskState *s, SCSIDiskReq *r,
                                              uint8_t *outbuf)
{
    int size;
    uint8_t *buf = r->req.cmd.buf;
    uint8_t notification_class_request = buf[4];
    if (s->qdev.type != TYPE_ROM) {
        return -1;
    }
    if ((buf[1] & 1) == 0) {
        /* asynchronous */
        return -1;
    }

    size = 4;
    outbuf[0] = outbuf[1] = 0;
    outbuf[3] = 1 << GESN_MEDIA; /* supported events */
    if (notification_class_request & (1 << GESN_MEDIA)) {
        outbuf[2] = GESN_MEDIA;
        size += scsi_event_status_media(s, &outbuf[size]);
    } else {
        outbuf[2] = 0x80;
    }
    stw_be_p(outbuf, size - 4);
    return size;
912 913
}

914
static int scsi_get_configuration(SCSIDiskState *s, uint8_t *outbuf)
915
{
916 917
    int current;

918 919 920
    if (s->qdev.type != TYPE_ROM) {
        return -1;
    }
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
    current = media_is_dvd(s) ? MMC_PROFILE_DVD_ROM : MMC_PROFILE_CD_ROM;
    memset(outbuf, 0, 40);
    stl_be_p(&outbuf[0], 36); /* Bytes after the data length field */
    stw_be_p(&outbuf[6], current);
    /* outbuf[8] - outbuf[19]: Feature 0 - Profile list */
    outbuf[10] = 0x03; /* persistent, current */
    outbuf[11] = 8; /* two profiles */
    stw_be_p(&outbuf[12], MMC_PROFILE_DVD_ROM);
    outbuf[14] = (current == MMC_PROFILE_DVD_ROM);
    stw_be_p(&outbuf[16], MMC_PROFILE_CD_ROM);
    outbuf[18] = (current == MMC_PROFILE_CD_ROM);
    /* outbuf[20] - outbuf[31]: Feature 1 - Core feature */
    stw_be_p(&outbuf[20], 1);
    outbuf[22] = 0x08 | 0x03; /* version 2, persistent, current */
    outbuf[23] = 8;
    stl_be_p(&outbuf[24], 1); /* SCSI */
    outbuf[28] = 1; /* DBE = 1, mandatory */
    /* outbuf[32] - outbuf[39]: Feature 3 - Removable media feature */
    stw_be_p(&outbuf[32], 3);
    outbuf[34] = 0x08 | 0x03; /* version 2, persistent, current */
    outbuf[35] = 4;
    outbuf[36] = 0x39; /* tray, load=1, eject=1, unlocked at powerup, lock=1 */
    /* TODO: Random readable, CD read, DVD read, drive serial number,
       power management */
    return 40;
946 947 948 949 950 951 952 953 954 955 956 957
}

static int scsi_emulate_mechanism_status(SCSIDiskState *s, uint8_t *outbuf)
{
    if (s->qdev.type != TYPE_ROM) {
        return -1;
    }
    memset(outbuf, 0, 8);
    outbuf[5] = 1; /* CD-ROM */
    return 8;
}

958
static int mode_sense_page(SCSIDiskState *s, int page, uint8_t **p_outbuf,
959
                           int page_control)
960
{
961 962 963 964
    static const int mode_sense_valid[0x3f] = {
        [MODE_PAGE_HD_GEOMETRY]            = (1 << TYPE_DISK),
        [MODE_PAGE_FLEXIBLE_DISK_GEOMETRY] = (1 << TYPE_DISK),
        [MODE_PAGE_CACHING]                = (1 << TYPE_DISK) | (1 << TYPE_ROM),
965 966
        [MODE_PAGE_R_W_ERROR]              = (1 << TYPE_DISK) | (1 << TYPE_ROM),
        [MODE_PAGE_AUDIO_CTL]              = (1 << TYPE_ROM),
967 968 969
        [MODE_PAGE_CAPABILITIES]           = (1 << TYPE_ROM),
    };

970
    BlockDriverState *bdrv = s->qdev.conf.bs;
971
    uint32_t cylinders, heads, secs;
972
    uint8_t *p = *p_outbuf;
973

974 975 976 977 978 979
    if ((mode_sense_valid[page] & (1 << s->qdev.type)) == 0) {
        return -1;
    }

    p[0] = page;

980 981 982 983 984 985
    /*
     * If Changeable Values are requested, a mask denoting those mode parameters
     * that are changeable shall be returned. As we currently don't support
     * parameter changes via MODE_SELECT all bits are returned set to zero.
     * The buffer was already menset to zero by the caller of this function.
     */
986
    switch (page) {
987
    case MODE_PAGE_HD_GEOMETRY:
988
        p[1] = 0x16;
989
        if (page_control == 1) { /* Changeable Values */
990
            break;
991
        }
992
        /* if a geometry hint is available, use it */
993
        hd_geometry_guess(bdrv, &cylinders, &heads, &secs, NULL);
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
        p[2] = (cylinders >> 16) & 0xff;
        p[3] = (cylinders >> 8) & 0xff;
        p[4] = cylinders & 0xff;
        p[5] = heads & 0xff;
        /* Write precomp start cylinder, disabled */
        p[6] = (cylinders >> 16) & 0xff;
        p[7] = (cylinders >> 8) & 0xff;
        p[8] = cylinders & 0xff;
        /* Reduced current start cylinder, disabled */
        p[9] = (cylinders >> 16) & 0xff;
        p[10] = (cylinders >> 8) & 0xff;
        p[11] = cylinders & 0xff;
        /* Device step rate [ns], 200ns */
        p[12] = 0;
        p[13] = 200;
        /* Landing zone cylinder */
        p[14] = 0xff;
        p[15] =  0xff;
        p[16] = 0xff;
        /* Medium rotation rate [rpm], 5400 rpm */
        p[20] = (5400 >> 8) & 0xff;
        p[21] = 5400 & 0xff;
1016
        break;
1017

1018
    case MODE_PAGE_FLEXIBLE_DISK_GEOMETRY:
1019
        p[1] = 0x1e;
1020
        if (page_control == 1) { /* Changeable Values */
1021
            break;
1022
        }
1023 1024 1025 1026
        /* Transfer rate [kbit/s], 5Mbit/s */
        p[2] = 5000 >> 8;
        p[3] = 5000 & 0xff;
        /* if a geometry hint is available, use it */
1027
        hd_geometry_guess(bdrv, &cylinders, &heads, &secs, NULL);
1028 1029
        p[4] = heads & 0xff;
        p[5] = secs & 0xff;
P
Paolo Bonzini 已提交
1030
        p[6] = s->qdev.blocksize >> 8;
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
        p[8] = (cylinders >> 8) & 0xff;
        p[9] = cylinders & 0xff;
        /* Write precomp start cylinder, disabled */
        p[10] = (cylinders >> 8) & 0xff;
        p[11] = cylinders & 0xff;
        /* Reduced current start cylinder, disabled */
        p[12] = (cylinders >> 8) & 0xff;
        p[13] = cylinders & 0xff;
        /* Device step rate [100us], 100us */
        p[14] = 0;
        p[15] = 1;
        /* Device step pulse width [us], 1us */
        p[16] = 1;
        /* Device head settle delay [100us], 100us */
        p[17] = 0;
        p[18] = 1;
        /* Motor on delay [0.1s], 0.1s */
        p[19] = 1;
        /* Motor off delay [0.1s], 0.1s */
        p[20] = 1;
        /* Medium rotation rate [rpm], 5400 rpm */
        p[28] = (5400 >> 8) & 0xff;
        p[29] = 5400 & 0xff;
1054
        break;
1055

1056
    case MODE_PAGE_CACHING:
1057 1058
        p[0] = 8;
        p[1] = 0x12;
1059
        if (page_control == 1) { /* Changeable Values */
1060
            break;
1061
        }
1062
        if (bdrv_enable_write_cache(s->qdev.conf.bs)) {
1063 1064
            p[2] = 4; /* WCE */
        }
1065
        break;
1066

1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
    case MODE_PAGE_R_W_ERROR:
        p[1] = 10;
        p[2] = 0x80; /* Automatic Write Reallocation Enabled */
        if (s->qdev.type == TYPE_ROM) {
            p[3] = 0x20; /* Read Retry Count */
        }
        break;

    case MODE_PAGE_AUDIO_CTL:
        p[1] = 14;
        break;

1079
    case MODE_PAGE_CAPABILITIES:
1080
        p[1] = 0x14;
1081
        if (page_control == 1) { /* Changeable Values */
1082
            break;
1083
        }
1084 1085 1086

        p[2] = 0x3b; /* CD-R & CD-RW read */
        p[3] = 0; /* Writing not supported */
1087 1088 1089 1090 1091
        p[4] = 0x7f; /* Audio, composite, digital out,
                        mode 2 form 1&2, multi session */
        p[5] = 0xff; /* CD DA, DA accurate, RW supported,
                        RW corrected, C2 errors, ISRC,
                        UPC, Bar code */
1092
        p[6] = 0x2d | (s->tray_locked ? 2 : 0);
1093 1094 1095
        /* Locking supported, jumper present, eject, tray */
        p[7] = 0; /* no volume & mute control, no
                     changer */
1096
        p[8] = (50 * 176) >> 8; /* 50x read speed */
1097
        p[9] = (50 * 176) & 0xff;
1098 1099 1100
        p[10] = 2 >> 8; /* Two volume levels */
        p[11] = 2 & 0xff;
        p[12] = 2048 >> 8; /* 2M buffer */
1101
        p[13] = 2048 & 0xff;
1102
        p[14] = (16 * 176) >> 8; /* 16x read speed current */
1103
        p[15] = (16 * 176) & 0xff;
1104
        p[18] = (16 * 176) >> 8; /* 16x write speed */
1105
        p[19] = (16 * 176) & 0xff;
1106
        p[20] = (16 * 176) >> 8; /* 16x write speed current */
1107
        p[21] = (16 * 176) & 0xff;
1108
        break;
1109 1110

    default:
1111
        return -1;
1112
    }
1113 1114 1115

    *p_outbuf += p[1] + 2;
    return p[1] + 2;
1116 1117
}

1118
static int scsi_disk_emulate_mode_sense(SCSIDiskReq *r, uint8_t *outbuf)
1119
{
1120
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
1121
    uint64_t nb_sectors;
1122 1123
    bool dbd;
    int page, buflen, ret, page_control;
1124
    uint8_t *p;
1125
    uint8_t dev_specific_param;
1126

1127
    dbd = (r->req.cmd.buf[1] & 0x8) != 0;
1128 1129
    page = r->req.cmd.buf[2] & 0x3f;
    page_control = (r->req.cmd.buf[2] & 0xc0) >> 6;
1130
    DPRINTF("Mode Sense(%d) (page %d, xfer %zd, page_control %d)\n",
1131 1132
        (r->req.cmd.buf[0] == MODE_SENSE) ? 6 : 10, page, r->req.cmd.xfer, page_control);
    memset(outbuf, 0, r->req.cmd.xfer);
1133 1134
    p = outbuf;

1135
    if (s->qdev.type == TYPE_DISK) {
P
Paolo Bonzini 已提交
1136
        dev_specific_param = s->features & (1 << SCSI_DISK_F_DPOFUA) ? 0x10 : 0;
1137 1138 1139
        if (bdrv_is_read_only(s->qdev.conf.bs)) {
            dev_specific_param |= 0x80; /* Readonly.  */
        }
1140
    } else {
1141 1142
        /* MMC prescribes that CD/DVD drives have no block descriptors,
         * and defines no device-specific parameter.  */
P
Paolo Bonzini 已提交
1143
        dev_specific_param = 0x00;
1144
        dbd = true;
1145 1146
    }

1147
    if (r->req.cmd.buf[0] == MODE_SENSE) {
1148 1149 1150 1151 1152 1153 1154 1155 1156
        p[1] = 0; /* Default media type.  */
        p[2] = dev_specific_param;
        p[3] = 0; /* Block descriptor length.  */
        p += 4;
    } else { /* MODE_SENSE_10 */
        p[2] = 0; /* Default media type.  */
        p[3] = dev_specific_param;
        p[6] = p[7] = 0; /* Block descriptor length.  */
        p += 8;
1157 1158
    }

1159
    bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
1160
    if (!dbd && nb_sectors) {
1161
        if (r->req.cmd.buf[0] == MODE_SENSE) {
1162 1163 1164 1165
            outbuf[3] = 8; /* Block descriptor length  */
        } else { /* MODE_SENSE_10 */
            outbuf[7] = 8; /* Block descriptor length  */
        }
P
Paolo Bonzini 已提交
1166
        nb_sectors /= (s->qdev.blocksize / 512);
1167
        if (nb_sectors > 0xffffff) {
1168
            nb_sectors = 0;
1169
        }
1170 1171 1172 1173 1174 1175
        p[0] = 0; /* media density code */
        p[1] = (nb_sectors >> 16) & 0xff;
        p[2] = (nb_sectors >> 8) & 0xff;
        p[3] = nb_sectors & 0xff;
        p[4] = 0; /* reserved */
        p[5] = 0; /* bytes 5-7 are the sector size in bytes */
P
Paolo Bonzini 已提交
1176
        p[6] = s->qdev.blocksize >> 8;
1177 1178 1179 1180
        p[7] = 0;
        p += 8;
    }

1181 1182 1183 1184
    if (page_control == 3) {
        /* Saved Values */
        scsi_check_condition(r, SENSE_CODE(SAVING_PARAMS_NOT_SUPPORTED));
        return -1;
1185 1186
    }

1187 1188 1189 1190 1191 1192 1193 1194 1195
    if (page == 0x3f) {
        for (page = 0; page <= 0x3e; page++) {
            mode_sense_page(s, page, &p, page_control);
        }
    } else {
        ret = mode_sense_page(s, page, &p, page_control);
        if (ret == -1) {
            return -1;
        }
1196 1197 1198
    }

    buflen = p - outbuf;
1199 1200 1201 1202 1203
    /*
     * The mode data length field specifies the length in bytes of the
     * following data that is available to be transferred. The mode data
     * length does not include itself.
     */
1204
    if (r->req.cmd.buf[0] == MODE_SENSE) {
1205 1206 1207 1208 1209
        outbuf[0] = buflen - 1;
    } else { /* MODE_SENSE_10 */
        outbuf[0] = ((buflen - 2) >> 8) & 0xff;
        outbuf[1] = (buflen - 2) & 0xff;
    }
1210 1211 1212
    return buflen;
}

1213 1214 1215 1216 1217 1218 1219 1220 1221
static int scsi_disk_emulate_read_toc(SCSIRequest *req, uint8_t *outbuf)
{
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
    int start_track, format, msf, toclen;
    uint64_t nb_sectors;

    msf = req->cmd.buf[1] & 2;
    format = req->cmd.buf[2] & 0xf;
    start_track = req->cmd.buf[6];
1222
    bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
1223
    DPRINTF("Read TOC (track %d format %d msf %d)\n", start_track, format, msf >> 1);
P
Paolo Bonzini 已提交
1224
    nb_sectors /= s->qdev.blocksize / 512;
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
    switch (format) {
    case 0:
        toclen = cdrom_read_toc(nb_sectors, outbuf, msf, start_track);
        break;
    case 1:
        /* multi session : only a single session defined */
        toclen = 12;
        memset(outbuf, 0, 12);
        outbuf[1] = 0x0a;
        outbuf[2] = 0x01;
        outbuf[3] = 0x01;
        break;
    case 2:
        toclen = cdrom_read_toc_raw(nb_sectors, outbuf, msf, start_track);
        break;
    default:
        return -1;
    }
    return toclen;
}

1246
static int scsi_disk_emulate_start_stop(SCSIDiskReq *r)
1247 1248 1249 1250 1251 1252 1253
{
    SCSIRequest *req = &r->req;
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
    bool start = req->cmd.buf[4] & 1;
    bool loej = req->cmd.buf[4] & 2; /* load on start, eject on !start */

    if (s->qdev.type == TYPE_ROM && loej) {
1254 1255
        if (!start && !s->tray_open && s->tray_locked) {
            scsi_check_condition(r,
1256
                                 bdrv_is_inserted(s->qdev.conf.bs)
1257 1258 1259
                                 ? SENSE_CODE(ILLEGAL_REQ_REMOVAL_PREVENTED)
                                 : SENSE_CODE(NOT_READY_REMOVAL_PREVENTED));
            return -1;
1260
        }
1261 1262 1263 1264 1265

        if (s->tray_open != !start) {
            bdrv_eject(s->qdev.conf.bs, !start);
            s->tray_open = !start;
        }
1266
    }
1267
    return 0;
1268 1269
}

1270
static int scsi_disk_emulate_command(SCSIDiskReq *r)
1271
{
1272
    SCSIRequest *req = &r->req;
1273 1274
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
    uint64_t nb_sectors;
1275
    uint8_t *outbuf;
1276 1277
    int buflen = 0;

1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
    if (!r->iov.iov_base) {
        /*
         * FIXME: we shouldn't return anything bigger than 4k, but the code
         * requires the buffer to be as big as req->cmd.xfer in several
         * places.  So, do not allow CDBs with a very large ALLOCATION
         * LENGTH.  The real fix would be to modify scsi_read_data and
         * dma_buf_read, so that they return data beyond the buflen
         * as all zeros.
         */
        if (req->cmd.xfer > 65536) {
            goto illegal_request;
        }
        r->buflen = MAX(4096, req->cmd.xfer);
1291
        r->iov.iov_base = qemu_blockalign(s->qdev.conf.bs, r->buflen);
1292 1293 1294
    }

    outbuf = r->iov.iov_base;
1295 1296
    switch (req->cmd.buf[0]) {
    case TEST_UNIT_READY:
1297
        assert(!s->tray_open && bdrv_is_inserted(s->qdev.conf.bs));
H
Hannes Reinecke 已提交
1298
        break;
1299 1300
    case INQUIRY:
        buflen = scsi_disk_emulate_inquiry(req, outbuf);
1301
        if (buflen < 0) {
1302
            goto illegal_request;
1303
        }
H
Hannes Reinecke 已提交
1304
        break;
1305 1306
    case MODE_SENSE:
    case MODE_SENSE_10:
1307
        buflen = scsi_disk_emulate_mode_sense(r, outbuf);
1308
        if (buflen < 0) {
1309
            goto illegal_request;
1310
        }
1311
        break;
1312 1313
    case READ_TOC:
        buflen = scsi_disk_emulate_read_toc(req, outbuf);
1314
        if (buflen < 0) {
1315
            goto illegal_request;
1316
        }
1317
        break;
1318
    case RESERVE:
1319
        if (req->cmd.buf[1] & 1) {
1320
            goto illegal_request;
1321
        }
1322 1323
        break;
    case RESERVE_10:
1324
        if (req->cmd.buf[1] & 3) {
1325
            goto illegal_request;
1326
        }
1327 1328
        break;
    case RELEASE:
1329
        if (req->cmd.buf[1] & 1) {
1330
            goto illegal_request;
1331
        }
1332 1333
        break;
    case RELEASE_10:
1334
        if (req->cmd.buf[1] & 3) {
1335
            goto illegal_request;
1336
        }
1337
        break;
1338
    case START_STOP:
1339 1340 1341
        if (scsi_disk_emulate_start_stop(r) < 0) {
            return -1;
        }
H
Hannes Reinecke 已提交
1342
        break;
1343
    case ALLOW_MEDIUM_REMOVAL:
1344
        s->tray_locked = req->cmd.buf[4] & 1;
1345
        bdrv_lock_medium(s->qdev.conf.bs, req->cmd.buf[4] & 1);
H
Hannes Reinecke 已提交
1346
        break;
1347
    case READ_CAPACITY_10:
1348
        /* The normal LEN field for this command is zero.  */
H
Hannes Reinecke 已提交
1349
        memset(outbuf, 0, 8);
1350
        bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
1351
        if (!nb_sectors) {
1352 1353
            scsi_check_condition(r, SENSE_CODE(LUN_NOT_READY));
            return -1;
1354
        }
1355 1356 1357
        if ((req->cmd.buf[8] & 1) == 0 && req->cmd.lba) {
            goto illegal_request;
        }
P
Paolo Bonzini 已提交
1358
        nb_sectors /= s->qdev.blocksize / 512;
1359 1360 1361
        /* Returned value is the address of the last sector.  */
        nb_sectors--;
        /* Remember the new size for read/write sanity checking. */
P
Paolo Bonzini 已提交
1362
        s->qdev.max_lba = nb_sectors;
1363
        /* Clip to 2TB, instead of returning capacity modulo 2TB. */
1364
        if (nb_sectors > UINT32_MAX) {
1365
            nb_sectors = UINT32_MAX;
1366
        }
1367 1368 1369 1370 1371 1372
        outbuf[0] = (nb_sectors >> 24) & 0xff;
        outbuf[1] = (nb_sectors >> 16) & 0xff;
        outbuf[2] = (nb_sectors >> 8) & 0xff;
        outbuf[3] = nb_sectors & 0xff;
        outbuf[4] = 0;
        outbuf[5] = 0;
P
Paolo Bonzini 已提交
1373
        outbuf[6] = s->qdev.blocksize >> 8;
1374 1375
        outbuf[7] = 0;
        buflen = 8;
H
Hannes Reinecke 已提交
1376
        break;
1377 1378 1379 1380 1381
    case REQUEST_SENSE:
        /* Just return "NO SENSE".  */
        buflen = scsi_build_sense(NULL, 0, outbuf, r->buflen,
                                  (req->cmd.buf[1] & 1) == 0);
        break;
1382 1383 1384 1385 1386 1387
    case MECHANISM_STATUS:
        buflen = scsi_emulate_mechanism_status(s, outbuf);
        if (buflen < 0) {
            goto illegal_request;
        }
        break;
1388
    case GET_CONFIGURATION:
1389
        buflen = scsi_get_configuration(s, outbuf);
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399
        if (buflen < 0) {
            goto illegal_request;
        }
        break;
    case GET_EVENT_STATUS_NOTIFICATION:
        buflen = scsi_get_event_status_notification(s, r, outbuf);
        if (buflen < 0) {
            goto illegal_request;
        }
        break;
1400 1401 1402 1403 1404 1405
    case READ_DISC_INFORMATION:
        buflen = scsi_read_disc_information(s, r, outbuf);
        if (buflen < 0) {
            goto illegal_request;
        }
        break;
1406 1407 1408 1409 1410
    case READ_DVD_STRUCTURE:
        buflen = scsi_read_dvd_structure(s, r, outbuf);
        if (buflen < 0) {
            goto illegal_request;
        }
1411
        break;
1412
    case SERVICE_ACTION_IN_16:
1413
        /* Service Action In subcommands. */
1414
        if ((req->cmd.buf[1] & 31) == SAI_READ_CAPACITY_16) {
1415 1416
            DPRINTF("SAI READ CAPACITY(16)\n");
            memset(outbuf, 0, req->cmd.xfer);
1417
            bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
1418
            if (!nb_sectors) {
1419 1420
                scsi_check_condition(r, SENSE_CODE(LUN_NOT_READY));
                return -1;
1421
            }
1422 1423 1424
            if ((req->cmd.buf[14] & 1) == 0 && req->cmd.lba) {
                goto illegal_request;
            }
P
Paolo Bonzini 已提交
1425
            nb_sectors /= s->qdev.blocksize / 512;
1426 1427 1428
            /* Returned value is the address of the last sector.  */
            nb_sectors--;
            /* Remember the new size for read/write sanity checking. */
P
Paolo Bonzini 已提交
1429
            s->qdev.max_lba = nb_sectors;
1430 1431 1432 1433 1434 1435 1436 1437 1438 1439
            outbuf[0] = (nb_sectors >> 56) & 0xff;
            outbuf[1] = (nb_sectors >> 48) & 0xff;
            outbuf[2] = (nb_sectors >> 40) & 0xff;
            outbuf[3] = (nb_sectors >> 32) & 0xff;
            outbuf[4] = (nb_sectors >> 24) & 0xff;
            outbuf[5] = (nb_sectors >> 16) & 0xff;
            outbuf[6] = (nb_sectors >> 8) & 0xff;
            outbuf[7] = nb_sectors & 0xff;
            outbuf[8] = 0;
            outbuf[9] = 0;
P
Paolo Bonzini 已提交
1440
            outbuf[10] = s->qdev.blocksize >> 8;
1441
            outbuf[11] = 0;
C
Christoph Hellwig 已提交
1442 1443
            outbuf[12] = 0;
            outbuf[13] = get_physical_block_exp(&s->qdev.conf);
1444 1445 1446 1447 1448 1449

            /* set TPE bit if the format supports discard */
            if (s->qdev.conf.discard_granularity) {
                outbuf[14] = 0x80;
            }

1450 1451 1452 1453 1454 1455
            /* Protection, exponent and lowest lba field left blank. */
            buflen = req->cmd.xfer;
            break;
        }
        DPRINTF("Unsupported Service Action In\n");
        goto illegal_request;
1456
    default:
1457
        scsi_check_condition(r, SENSE_CODE(INVALID_OPCODE));
1458
        return -1;
1459
    }
1460
    buflen = MIN(buflen, req->cmd.xfer);
1461 1462 1463
    return buflen;

illegal_request:
1464 1465 1466
    if (r->req.status == -1) {
        scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
    }
1467
    return -1;
1468 1469
}

P
pbrook 已提交
1470 1471 1472 1473 1474
/* Execute a scsi command.  Returns the length of the data expected by the
   command.  This will be Positive for data transfers from the device
   (eg. disk reads), negative for transfers to the device (eg. disk writes),
   and zero if the command does not transfer any data.  */

1475
static int32_t scsi_send_command(SCSIRequest *req, uint8_t *buf)
P
pbrook 已提交
1476
{
1477 1478
    SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
P
Paolo Bonzini 已提交
1479
    int32_t len;
P
pbrook 已提交
1480
    uint8_t command;
1481
    int rc;
P
pbrook 已提交
1482 1483

    command = buf[0];
1484
    DPRINTF("Command: lun=%d tag=0x%x data=0x%02x", req->lun, req->tag, buf[0]);
1485

P
pbrook 已提交
1486 1487 1488
#ifdef DEBUG_SCSI
    {
        int i;
1489
        for (i = 1; i < r->req.cmd.len; i++) {
P
pbrook 已提交
1490 1491 1492 1493 1494
            printf(" 0x%02x", buf[i]);
        }
        printf("\n");
    }
#endif
1495

1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519
    switch (command) {
    case INQUIRY:
    case MODE_SENSE:
    case MODE_SENSE_10:
    case RESERVE:
    case RESERVE_10:
    case RELEASE:
    case RELEASE_10:
    case START_STOP:
    case ALLOW_MEDIUM_REMOVAL:
    case GET_CONFIGURATION:
    case GET_EVENT_STATUS_NOTIFICATION:
    case MECHANISM_STATUS:
    case REQUEST_SENSE:
        break;

    default:
        if (s->tray_open || !bdrv_is_inserted(s->qdev.conf.bs)) {
            scsi_check_condition(r, SENSE_CODE(NO_MEDIUM));
            return 0;
        }
        break;
    }

P
pbrook 已提交
1520
    switch (command) {
1521
    case TEST_UNIT_READY:
1522
    case INQUIRY:
1523 1524
    case MODE_SENSE:
    case MODE_SENSE_10:
1525 1526 1527 1528
    case RESERVE:
    case RESERVE_10:
    case RELEASE:
    case RELEASE_10:
1529
    case START_STOP:
1530
    case ALLOW_MEDIUM_REMOVAL:
1531
    case READ_CAPACITY_10:
1532
    case READ_TOC:
1533
    case READ_DISC_INFORMATION:
1534
    case READ_DVD_STRUCTURE:
1535
    case GET_CONFIGURATION:
1536 1537
    case GET_EVENT_STATUS_NOTIFICATION:
    case MECHANISM_STATUS:
1538
    case SERVICE_ACTION_IN_16:
1539
    case REQUEST_SENSE:
1540
        rc = scsi_disk_emulate_command(r);
1541
        if (rc < 0) {
1542
            return 0;
1543
        }
1544 1545

        r->iov.iov_len = rc;
1546
        break;
1547
    case SYNCHRONIZE_CACHE:
1548 1549
        /* The request is used as the AIO opaque value, so add a ref.  */
        scsi_req_ref(&r->req);
1550 1551
        bdrv_acct_start(s->qdev.conf.bs, &r->acct, 0, BDRV_ACCT_FLUSH);
        r->req.aiocb = bdrv_aio_flush(s->qdev.conf.bs, scsi_flush_complete, r);
1552
        return 0;
1553 1554
    case READ_6:
    case READ_10:
G
Gerd Hoffmann 已提交
1555 1556
    case READ_12:
    case READ_16:
1557
        len = r->req.cmd.xfer / s->qdev.blocksize;
1558
        DPRINTF("Read (sector %" PRId64 ", count %d)\n", r->req.cmd.lba, len);
P
Paolo Bonzini 已提交
1559
        if (r->req.cmd.lba > s->qdev.max_lba) {
1560
            goto illegal_lba;
1561
        }
P
Paolo Bonzini 已提交
1562 1563
        r->sector = r->req.cmd.lba * (s->qdev.blocksize / 512);
        r->sector_count = len * (s->qdev.blocksize / 512);
P
pbrook 已提交
1564
        break;
1565 1566 1567
    case VERIFY_10:
    case VERIFY_12:
    case VERIFY_16:
1568 1569
    case WRITE_6:
    case WRITE_10:
G
Gerd Hoffmann 已提交
1570 1571
    case WRITE_12:
    case WRITE_16:
1572
    case WRITE_VERIFY_10:
1573 1574
    case WRITE_VERIFY_12:
    case WRITE_VERIFY_16:
1575
        len = r->req.cmd.xfer / s->qdev.blocksize;
1576
        DPRINTF("Write %s(sector %" PRId64 ", count %d)\n",
1577 1578
                (command & 0xe) == 0xe ? "And Verify " : "",
                r->req.cmd.lba, len);
P
Paolo Bonzini 已提交
1579
        if (r->req.cmd.lba > s->qdev.max_lba) {
1580
            goto illegal_lba;
1581
        }
P
Paolo Bonzini 已提交
1582 1583
        r->sector = r->req.cmd.lba * (s->qdev.blocksize / 512);
        r->sector_count = len * (s->qdev.blocksize / 512);
P
pbrook 已提交
1584
        break;
1585
    case MODE_SELECT:
1586
        DPRINTF("Mode Select(6) (len %lu)\n", (long)r->req.cmd.xfer);
1587 1588
        /* We don't support mode parameter changes.
           Allow the mode parameter header + block descriptors only. */
1589
        if (r->req.cmd.xfer > 12) {
1590 1591 1592 1593
            goto fail;
        }
        break;
    case MODE_SELECT_10:
1594
        DPRINTF("Mode Select(10) (len %lu)\n", (long)r->req.cmd.xfer);
1595 1596
        /* We don't support mode parameter changes.
           Allow the mode parameter header + block descriptors only. */
1597
        if (r->req.cmd.xfer > 16) {
1598 1599 1600 1601
            goto fail;
        }
        break;
    case SEEK_10:
P
Paolo Bonzini 已提交
1602
        DPRINTF("Seek(10) (sector %" PRId64 ")\n", r->req.cmd.lba);
P
Paolo Bonzini 已提交
1603
        if (r->req.cmd.lba > s->qdev.max_lba) {
1604 1605
            goto illegal_lba;
        }
1606
        break;
1607
    case WRITE_SAME_10:
1608 1609
        len = lduw_be_p(&buf[7]);
        goto write_same;
1610
    case WRITE_SAME_16:
1611 1612
        len = ldl_be_p(&buf[10]) & 0xffffffffULL;
    write_same:
1613

1614
        DPRINTF("WRITE SAME() (sector %" PRId64 ", count %d)\n",
1615 1616
                r->req.cmd.lba, len);

P
Paolo Bonzini 已提交
1617
        if (r->req.cmd.lba > s->qdev.max_lba) {
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627
            goto illegal_lba;
        }

        /*
         * We only support WRITE SAME with the unmap bit set for now.
         */
        if (!(buf[1] & 0x8)) {
            goto fail;
        }

P
Paolo Bonzini 已提交
1628 1629 1630
        rc = bdrv_discard(s->qdev.conf.bs,
                          r->req.cmd.lba * (s->qdev.blocksize / 512),
                          len * (s->qdev.blocksize / 512));
1631 1632 1633 1634 1635
        if (rc < 0) {
            /* XXX: better error code ?*/
            goto fail;
        }

1636
        break;
P
pbrook 已提交
1637
    default:
1638
        DPRINTF("Unknown SCSI command (%2.2x)\n", buf[0]);
1639
        scsi_check_condition(r, SENSE_CODE(INVALID_OPCODE));
1640
        return 0;
P
pbrook 已提交
1641
    fail:
1642
        scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
1643
        return 0;
1644
    illegal_lba:
1645
        scsi_check_condition(r, SENSE_CODE(LBA_OUT_OF_RANGE));
1646
        return 0;
P
pbrook 已提交
1647
    }
1648
    if (r->sector_count == 0 && r->iov.iov_len == 0) {
1649
        scsi_req_complete(&r->req, GOOD);
P
pbrook 已提交
1650
    }
1651
    len = r->sector_count * 512 + r->iov.iov_len;
1652 1653
    if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
        return -len;
P
pbrook 已提交
1654
    } else {
1655
        if (!r->sector_count) {
P
pbrook 已提交
1656
            r->sector_count = -1;
1657
        }
1658
        return len;
P
pbrook 已提交
1659 1660 1661
    }
}

J
Jan Kiszka 已提交
1662 1663 1664 1665 1666
static void scsi_disk_reset(DeviceState *dev)
{
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev.qdev, dev);
    uint64_t nb_sectors;

1667
    scsi_device_purge_requests(&s->qdev, SENSE_CODE(RESET));
J
Jan Kiszka 已提交
1668

1669
    bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
P
Paolo Bonzini 已提交
1670
    nb_sectors /= s->qdev.blocksize / 512;
J
Jan Kiszka 已提交
1671 1672 1673
    if (nb_sectors) {
        nb_sectors--;
    }
P
Paolo Bonzini 已提交
1674
    s->qdev.max_lba = nb_sectors;
J
Jan Kiszka 已提交
1675 1676 1677 1678 1679 1680
}

static void scsi_destroy(SCSIDevice *dev)
{
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);

1681
    scsi_device_purge_requests(&s->qdev, SENSE_CODE(NO_SENSE));
1682
    blockdev_mark_auto_del(s->qdev.conf.bs);
G
Gerd Hoffmann 已提交
1683 1684
}

1685
static void scsi_cd_change_media_cb(void *opaque, bool load)
1686
{
1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701
    SCSIDiskState *s = opaque;

    /*
     * When a CD gets changed, we have to report an ejected state and
     * then a loaded state to guests so that they detect tray
     * open/close and media change events.  Guests that do not use
     * GET_EVENT_STATUS_NOTIFICATION to detect such tray open/close
     * states rely on this behavior.
     *
     * media_changed governs the state machine used for unit attention
     * report.  media_event is used by GET EVENT STATUS NOTIFICATION.
     */
    s->media_changed = load;
    s->tray_open = !load;
    s->qdev.unit_attention = SENSE_CODE(UNIT_ATTENTION_NO_MEDIUM);
1702
    s->media_event = true;
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713
    s->eject_request = false;
}

static void scsi_cd_eject_request_cb(void *opaque, bool force)
{
    SCSIDiskState *s = opaque;

    s->eject_request = true;
    if (force) {
        s->tray_locked = false;
    }
1714 1715
}

1716 1717 1718 1719 1720
static bool scsi_cd_is_tray_open(void *opaque)
{
    return ((SCSIDiskState *)opaque)->tray_open;
}

1721 1722 1723 1724 1725 1726
static bool scsi_cd_is_medium_locked(void *opaque)
{
    return ((SCSIDiskState *)opaque)->tray_locked;
}

static const BlockDevOps scsi_cd_block_ops = {
1727
    .change_media_cb = scsi_cd_change_media_cb,
1728
    .eject_request_cb = scsi_cd_eject_request_cb,
1729
    .is_tray_open = scsi_cd_is_tray_open,
1730 1731 1732
    .is_medium_locked = scsi_cd_is_medium_locked,
};

1733 1734 1735 1736 1737 1738 1739 1740 1741
static void scsi_disk_unit_attention_reported(SCSIDevice *dev)
{
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
    if (s->media_changed) {
        s->media_changed = false;
        s->qdev.unit_attention = SENSE_CODE(MEDIUM_CHANGED);
    }
}

1742
static int scsi_initfn(SCSIDevice *dev)
P
pbrook 已提交
1743
{
1744
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
1745
    DriveInfo *dinfo;
P
pbrook 已提交
1746

1747
    if (!s->qdev.conf.bs) {
1748
        error_report("drive property not set");
1749 1750 1751
        return -1;
    }

1752 1753
    if (!(s->features & (1 << SCSI_DISK_F_REMOVABLE)) &&
        !bdrv_is_inserted(s->qdev.conf.bs)) {
1754 1755 1756 1757
        error_report("Device needs media, but drive is empty");
        return -1;
    }

1758
    if (!s->serial) {
1759
        /* try to fall back to value set with legacy -drive serial=... */
1760
        dinfo = drive_get_by_blockdev(s->qdev.conf.bs);
1761
        if (*dinfo->serial) {
1762
            s->serial = g_strdup(dinfo->serial);
1763
        }
1764 1765
    }

1766
    if (!s->version) {
1767
        s->version = g_strdup(qemu_get_version());
1768 1769
    }

1770
    if (bdrv_is_sg(s->qdev.conf.bs)) {
1771
        error_report("unwanted /dev/sg*");
1772 1773 1774
        return -1;
    }

1775
    if (s->features & (1 << SCSI_DISK_F_REMOVABLE)) {
1776
        bdrv_set_dev_ops(s->qdev.conf.bs, &scsi_cd_block_ops, s);
P
pbrook 已提交
1777
    }
1778
    bdrv_set_buffer_alignment(s->qdev.conf.bs, s->qdev.blocksize);
1779

1780
    bdrv_iostatus_enable(s->qdev.conf.bs);
P
Paolo Bonzini 已提交
1781
    add_boot_device_path(s->qdev.conf.bootindex, &dev->qdev, NULL);
1782 1783 1784
    return 0;
}

1785 1786
static int scsi_hd_initfn(SCSIDevice *dev)
{
1787 1788 1789 1790
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
    s->qdev.blocksize = s->qdev.conf.logical_block_size;
    s->qdev.type = TYPE_DISK;
    return scsi_initfn(&s->qdev);
1791 1792 1793 1794
}

static int scsi_cd_initfn(SCSIDevice *dev)
{
1795 1796 1797
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
    s->qdev.blocksize = 2048;
    s->qdev.type = TYPE_ROM;
1798
    s->features |= 1 << SCSI_DISK_F_REMOVABLE;
1799
    return scsi_initfn(&s->qdev);
1800 1801 1802 1803
}

static int scsi_disk_initfn(SCSIDevice *dev)
{
1804
    DriveInfo *dinfo;
1805 1806

    if (!dev->conf.bs) {
1807
        return scsi_initfn(dev);  /* ... and die there */
1808 1809
    }

1810 1811 1812 1813 1814 1815
    dinfo = drive_get_by_blockdev(dev->conf.bs);
    if (dinfo->media_cd) {
        return scsi_cd_initfn(dev);
    } else {
        return scsi_hd_initfn(dev);
    }
1816 1817
}

P
Paolo Bonzini 已提交
1818
static const SCSIReqOps scsi_disk_reqops = {
P
Paolo Bonzini 已提交
1819
    .size         = sizeof(SCSIDiskReq),
1820 1821 1822 1823 1824 1825
    .free_req     = scsi_free_request,
    .send_command = scsi_send_command,
    .read_data    = scsi_read_data,
    .write_data   = scsi_write_data,
    .cancel_io    = scsi_cancel_io,
    .get_buf      = scsi_get_buf,
P
Paolo Bonzini 已提交
1826 1827
    .load_request = scsi_disk_load_request,
    .save_request = scsi_disk_save_request,
P
Paolo Bonzini 已提交
1828 1829
};

P
Paolo Bonzini 已提交
1830 1831
static SCSIRequest *scsi_new_request(SCSIDevice *d, uint32_t tag, uint32_t lun,
                                     uint8_t *buf, void *hba_private)
P
Paolo Bonzini 已提交
1832 1833 1834 1835 1836 1837 1838 1839
{
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, d);
    SCSIRequest *req;

    req = scsi_req_alloc(&scsi_disk_reqops, &s->qdev, tag, lun, hba_private);
    return req;
}

1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870
#ifdef __linux__
static int get_device_type(SCSIDiskState *s)
{
    BlockDriverState *bdrv = s->qdev.conf.bs;
    uint8_t cmd[16];
    uint8_t buf[36];
    uint8_t sensebuf[8];
    sg_io_hdr_t io_header;
    int ret;

    memset(cmd, 0, sizeof(cmd));
    memset(buf, 0, sizeof(buf));
    cmd[0] = INQUIRY;
    cmd[4] = sizeof(buf);

    memset(&io_header, 0, sizeof(io_header));
    io_header.interface_id = 'S';
    io_header.dxfer_direction = SG_DXFER_FROM_DEV;
    io_header.dxfer_len = sizeof(buf);
    io_header.dxferp = buf;
    io_header.cmdp = cmd;
    io_header.cmd_len = sizeof(cmd);
    io_header.mx_sb_len = sizeof(sensebuf);
    io_header.sbp = sensebuf;
    io_header.timeout = 6000; /* XXX */

    ret = bdrv_ioctl(bdrv, SG_IO, &io_header);
    if (ret < 0 || io_header.driver_status || io_header.host_status) {
        return -1;
    }
    s->qdev.type = buf[0];
1871 1872 1873
    if (buf[1] & 0x80) {
        s->features |= 1 << SCSI_DISK_F_REMOVABLE;
    }
1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924
    return 0;
}

static int scsi_block_initfn(SCSIDevice *dev)
{
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
    int sg_version;
    int rc;

    if (!s->qdev.conf.bs) {
        error_report("scsi-block: drive property not set");
        return -1;
    }

    /* check we are using a driver managing SG_IO (version 3 and after) */
    if (bdrv_ioctl(s->qdev.conf.bs, SG_GET_VERSION_NUM, &sg_version) < 0 ||
        sg_version < 30000) {
        error_report("scsi-block: scsi generic interface too old");
        return -1;
    }

    /* get device type from INQUIRY data */
    rc = get_device_type(s);
    if (rc < 0) {
        error_report("scsi-block: INQUIRY failed");
        return -1;
    }

    /* Make a guess for the block size, we'll fix it when the guest sends.
     * READ CAPACITY.  If they don't, they likely would assume these sizes
     * anyway. (TODO: check in /sys).
     */
    if (s->qdev.type == TYPE_ROM || s->qdev.type == TYPE_WORM) {
        s->qdev.blocksize = 2048;
    } else {
        s->qdev.blocksize = 512;
    }
    return scsi_initfn(&s->qdev);
}

static SCSIRequest *scsi_block_new_request(SCSIDevice *d, uint32_t tag,
                                           uint32_t lun, uint8_t *buf,
                                           void *hba_private)
{
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, d);

    switch (buf[0]) {
    case READ_6:
    case READ_10:
    case READ_12:
    case READ_16:
1925 1926 1927
    case VERIFY_10:
    case VERIFY_12:
    case VERIFY_16:
1928 1929 1930 1931 1932 1933 1934
    case WRITE_6:
    case WRITE_10:
    case WRITE_12:
    case WRITE_16:
    case WRITE_VERIFY_10:
    case WRITE_VERIFY_12:
    case WRITE_VERIFY_16:
1935 1936 1937 1938 1939
        /* If we are not using O_DIRECT, we might read stale data from the
	 * host cache if writes were made using other commands than these
	 * ones (such as WRITE SAME or EXTENDED COPY, etc.).  So, without
	 * O_DIRECT everything must go through SG_IO.
         */
1940
        if (bdrv_get_flags(s->qdev.conf.bs) & BDRV_O_NOCACHE) {
1941 1942 1943
            break;
        }

1944 1945 1946 1947 1948 1949 1950 1951 1952 1953
        /* MMC writing cannot be done via pread/pwrite, because it sometimes
         * involves writing beyond the maximum LBA or to negative LBA (lead-in).
         * And once you do these writes, reading from the block device is
         * unreliable, too.  It is even possible that reads deliver random data
         * from the host page cache (this is probably a Linux bug).
         *
         * We might use scsi_disk_reqops as long as no writing commands are
         * seen, but performance usually isn't paramount on optical media.  So,
         * just make scsi-block operate the same as scsi-generic for them.
         */
1954 1955 1956 1957 1958
        if (s->qdev.type == TYPE_ROM) {
            break;
	}
        return scsi_req_alloc(&scsi_disk_reqops, &s->qdev, tag, lun,
                              hba_private);
1959 1960 1961 1962 1963 1964 1965
    }

    return scsi_req_alloc(&scsi_generic_req_ops, &s->qdev, tag, lun,
                          hba_private);
}
#endif

1966 1967 1968 1969 1970
#define DEFINE_SCSI_DISK_PROPERTIES()                           \
    DEFINE_BLOCK_PROPERTIES(SCSIDiskState, qdev.conf),          \
    DEFINE_PROP_STRING("ver",  SCSIDiskState, version),         \
    DEFINE_PROP_STRING("serial",  SCSIDiskState, serial)

1971 1972
static Property scsi_hd_properties[] = {
    DEFINE_SCSI_DISK_PROPERTIES(),
1973 1974
    DEFINE_PROP_BIT("removable", SCSIDiskState, features,
                    SCSI_DISK_F_REMOVABLE, false),
P
Paolo Bonzini 已提交
1975 1976
    DEFINE_PROP_BIT("dpofua", SCSIDiskState, features,
                    SCSI_DISK_F_DPOFUA, false),
1977
    DEFINE_PROP_HEX64("wwn", SCSIDiskState, wwn, 0),
1978 1979 1980
    DEFINE_PROP_END_OF_LIST(),
};

P
Paolo Bonzini 已提交
1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996
static const VMStateDescription vmstate_scsi_disk_state = {
    .name = "scsi-disk",
    .version_id = 1,
    .minimum_version_id = 1,
    .minimum_version_id_old = 1,
    .fields = (VMStateField[]) {
        VMSTATE_SCSI_DEVICE(qdev, SCSIDiskState),
        VMSTATE_BOOL(media_changed, SCSIDiskState),
        VMSTATE_BOOL(media_event, SCSIDiskState),
        VMSTATE_BOOL(eject_request, SCSIDiskState),
        VMSTATE_BOOL(tray_open, SCSIDiskState),
        VMSTATE_BOOL(tray_locked, SCSIDiskState),
        VMSTATE_END_OF_LIST()
    }
};

1997 1998
static void scsi_hd_class_initfn(ObjectClass *klass, void *data)
{
1999
    DeviceClass *dc = DEVICE_CLASS(klass);
2000 2001 2002 2003 2004 2005
    SCSIDeviceClass *sc = SCSI_DEVICE_CLASS(klass);

    sc->init         = scsi_hd_initfn;
    sc->destroy      = scsi_destroy;
    sc->alloc_req    = scsi_new_request;
    sc->unit_attention_reported = scsi_disk_unit_attention_reported;
2006 2007 2008 2009
    dc->fw_name = "disk";
    dc->desc = "virtual SCSI disk";
    dc->reset = scsi_disk_reset;
    dc->props = scsi_hd_properties;
P
Paolo Bonzini 已提交
2010
    dc->vmsd  = &vmstate_scsi_disk_state;
2011 2012
}

2013 2014 2015 2016 2017 2018 2019 2020 2021
static TypeInfo scsi_hd_info = {
    .name          = "scsi-hd",
    .parent        = TYPE_SCSI_DEVICE,
    .instance_size = sizeof(SCSIDiskState),
    .class_init    = scsi_hd_class_initfn,
};

static Property scsi_cd_properties[] = {
    DEFINE_SCSI_DISK_PROPERTIES(),
2022
    DEFINE_PROP_HEX64("wwn", SCSIDiskState, wwn, 0),
2023
    DEFINE_PROP_END_OF_LIST(),
2024 2025 2026 2027
};

static void scsi_cd_class_initfn(ObjectClass *klass, void *data)
{
2028
    DeviceClass *dc = DEVICE_CLASS(klass);
2029 2030 2031 2032 2033 2034
    SCSIDeviceClass *sc = SCSI_DEVICE_CLASS(klass);

    sc->init         = scsi_cd_initfn;
    sc->destroy      = scsi_destroy;
    sc->alloc_req    = scsi_new_request;
    sc->unit_attention_reported = scsi_disk_unit_attention_reported;
2035 2036 2037 2038
    dc->fw_name = "disk";
    dc->desc = "virtual SCSI CD-ROM";
    dc->reset = scsi_disk_reset;
    dc->props = scsi_cd_properties;
P
Paolo Bonzini 已提交
2039
    dc->vmsd  = &vmstate_scsi_disk_state;
2040 2041
}

2042 2043 2044 2045 2046
static TypeInfo scsi_cd_info = {
    .name          = "scsi-cd",
    .parent        = TYPE_SCSI_DEVICE,
    .instance_size = sizeof(SCSIDiskState),
    .class_init    = scsi_cd_class_initfn,
2047 2048
};

2049
#ifdef __linux__
2050 2051 2052 2053 2054
static Property scsi_block_properties[] = {
    DEFINE_SCSI_DISK_PROPERTIES(),
    DEFINE_PROP_END_OF_LIST(),
};

2055 2056
static void scsi_block_class_initfn(ObjectClass *klass, void *data)
{
2057
    DeviceClass *dc = DEVICE_CLASS(klass);
2058 2059 2060 2061 2062
    SCSIDeviceClass *sc = SCSI_DEVICE_CLASS(klass);

    sc->init         = scsi_block_initfn;
    sc->destroy      = scsi_destroy;
    sc->alloc_req    = scsi_block_new_request;
2063 2064 2065 2066
    dc->fw_name = "disk";
    dc->desc = "SCSI block device passthrough";
    dc->reset = scsi_disk_reset;
    dc->props = scsi_block_properties;
P
Paolo Bonzini 已提交
2067
    dc->vmsd  = &vmstate_scsi_disk_state;
2068 2069
}

2070 2071 2072 2073 2074
static TypeInfo scsi_block_info = {
    .name          = "scsi-block",
    .parent        = TYPE_SCSI_DEVICE,
    .instance_size = sizeof(SCSIDiskState),
    .class_init    = scsi_block_class_initfn,
2075
};
2076
#endif
2077

2078 2079
static Property scsi_disk_properties[] = {
    DEFINE_SCSI_DISK_PROPERTIES(),
2080 2081
    DEFINE_PROP_BIT("removable", SCSIDiskState, features,
                    SCSI_DISK_F_REMOVABLE, false),
P
Paolo Bonzini 已提交
2082 2083
    DEFINE_PROP_BIT("dpofua", SCSIDiskState, features,
                    SCSI_DISK_F_DPOFUA, false),
2084
    DEFINE_PROP_HEX64("wwn", SCSIDiskState, wwn, 0),
2085 2086 2087
    DEFINE_PROP_END_OF_LIST(),
};

2088 2089
static void scsi_disk_class_initfn(ObjectClass *klass, void *data)
{
2090
    DeviceClass *dc = DEVICE_CLASS(klass);
2091 2092 2093 2094 2095 2096
    SCSIDeviceClass *sc = SCSI_DEVICE_CLASS(klass);

    sc->init         = scsi_disk_initfn;
    sc->destroy      = scsi_destroy;
    sc->alloc_req    = scsi_new_request;
    sc->unit_attention_reported = scsi_disk_unit_attention_reported;
2097 2098 2099 2100
    dc->fw_name = "disk";
    dc->desc = "virtual SCSI disk or CD-ROM (legacy)";
    dc->reset = scsi_disk_reset;
    dc->props = scsi_disk_properties;
P
Paolo Bonzini 已提交
2101
    dc->vmsd  = &vmstate_scsi_disk_state;
2102 2103
}

2104 2105 2106 2107 2108
static TypeInfo scsi_disk_info = {
    .name          = "scsi-disk",
    .parent        = TYPE_SCSI_DEVICE,
    .instance_size = sizeof(SCSIDiskState),
    .class_init    = scsi_disk_class_initfn,
2109 2110
};

A
Andreas Färber 已提交
2111
static void scsi_disk_register_types(void)
2112
{
2113 2114
    type_register_static(&scsi_hd_info);
    type_register_static(&scsi_cd_info);
2115
#ifdef __linux__
2116
    type_register_static(&scsi_block_info);
2117
#endif
2118
    type_register_static(&scsi_disk_info);
T
ths 已提交
2119
}
A
Andreas Färber 已提交
2120 2121

type_init(scsi_disk_register_types)