scsi-disk.c 66.4 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 76
    char *vendor;
    char *product;
77
    bool tray_open;
78
    bool tray_locked;
P
pbrook 已提交
79 80
};

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

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

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

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

/* Cancel a pending data transfer.  */
102
static void scsi_cancel_io(SCSIRequest *req)
P
pbrook 已提交
103
{
104 105 106 107 108
    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);
109 110 111 112 113

        /* 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 已提交
114
    }
115
    r->req.aiocb = NULL;
P
pbrook 已提交
116 117
}

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

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

P
Paolo Bonzini 已提交
131 132 133 134 135 136 137
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);
138 139 140 141 142 143 144 145
    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 已提交
146 147 148 149 150 151 152 153 154 155 156 157 158 159
    }
}

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);
160 161 162 163 164 165
        } 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 已提交
166 167 168 169 170 171
        }
    }

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

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

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

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

    scsi_req_complete(&r->req, GOOD);

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

193 194 195 196 197 198 199 200 201 202 203
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;

204 205 206
    case VERIFY_10:
    case VERIFY_12:
    case VERIFY_16:
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
    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);
225
        r->req.aiocb = bdrv_aio_flush(s->qdev.conf.bs, scsi_aio_complete, r);
226 227 228 229 230 231 232 233 234
        return;
    }

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

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

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

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

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

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

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

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

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

283 284 285 286 287 288
    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);
289 290 291 292 293

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

P
Paolo Bonzini 已提交
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
/* 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 已提交
314 315 316 317 318 319 320
    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 已提交
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
    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);
    }
}

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

P
pbrook 已提交
346 347
    DPRINTF("Read sector_count=%d\n", r->sector_count);
    if (r->sector_count == 0) {
348 349
        /* This also clears the sense buffer for REQUEST SENSE.  */
        scsi_req_complete(&r->req, GOOD);
P
pbrook 已提交
350
        return;
P
pbrook 已提交
351 352
    }

353 354 355
    /* No data transfer may already be in progress */
    assert(r->req.aiocb == NULL);

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

364 365
    if (s->tray_open) {
        scsi_read_complete(r, -ENOMEDIUM);
366
        return;
367
    }
368

P
Paolo Bonzini 已提交
369
    first = !r->started;
370
    r->started = true;
P
Paolo Bonzini 已提交
371 372 373
    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);
374
    } else {
P
Paolo Bonzini 已提交
375
        scsi_do_read(r, 0);
376
    }
P
pbrook 已提交
377 378
}

379 380 381 382 383 384 385
/*
 * 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.
 */
386
static int scsi_handle_rw_error(SCSIDiskReq *r, int error)
K
Kevin Wolf 已提交
387
{
388
    int is_read = (r->req.cmd.xfer == SCSI_XFER_FROM_DEV);
389
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
390
    BlockErrorAction action = bdrv_get_on_error(s->qdev.conf.bs, is_read);
391

392
    if (action == BLOCK_ERR_IGNORE) {
393
        bdrv_emit_qmp_error_event(s->qdev.conf.bs, BDRV_ACTION_IGNORE, is_read);
394
        return 0;
395
    }
396 397 398

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

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

P
pbrook 已提交
424 425
static void scsi_write_complete(void * opaque, int ret)
{
426
    SCSIDiskReq *r = (SCSIDiskReq *)opaque;
427
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
428 429
    uint32_t n;

P
Paolo Bonzini 已提交
430 431
    if (r->req.aiocb != NULL) {
        r->req.aiocb = NULL;
432
        bdrv_acct_done(s->qdev.conf.bs, &r->acct);
P
Paolo Bonzini 已提交
433
    }
434

435
    if (ret < 0) {
436
        if (scsi_handle_rw_error(r, -ret)) {
437
            goto done;
K
Kevin Wolf 已提交
438
        }
P
pbrook 已提交
439 440
    }

441
    n = r->qiov.size / 512;
442 443
    r->sector += n;
    r->sector_count -= n;
P
pbrook 已提交
444
    if (r->sector_count == 0) {
445 446
        scsi_write_do_fua(r);
        return;
P
pbrook 已提交
447
    } else {
P
Paolo Bonzini 已提交
448
        scsi_init_iovec(r, SCSI_DMA_BUF_SIZE);
449 450
        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 已提交
451
    }
452 453 454 455 456

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

459
static void scsi_write_data(SCSIRequest *req)
460
{
461
    SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
462
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, r->req.dev);
463 464
    uint32_t n;

465 466 467
    /* No data transfer may already be in progress */
    assert(r->req.aiocb == NULL);

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

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

487 488 489 490 491 492 493 494 495 496
    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;
    }

497 498 499 500 501 502 503
    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;
504 505
        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,
506
                                       scsi_write_complete, r);
507
    }
P
pbrook 已提交
508
}
P
pbrook 已提交
509

P
pbrook 已提交
510
/* Return a pointer to the data buffer.  */
511
static uint8_t *scsi_get_buf(SCSIRequest *req)
P
pbrook 已提交
512
{
513
    SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
P
pbrook 已提交
514

515
    return (uint8_t *)r->iov.iov_base;
P
pbrook 已提交
516 517
}

518 519
static int scsi_disk_emulate_inquiry(SCSIRequest *req, uint8_t *outbuf)
{
G
Gerd Hoffmann 已提交
520
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
521
    int buflen = 0;
522
    int start;
523 524 525 526 527

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

528
        outbuf[buflen++] = s->qdev.type & 0x1f;
529 530
        outbuf[buflen++] = page_code ; // this page
        outbuf[buflen++] = 0x00;
531 532
        outbuf[buflen++] = 0x00;
        start = buflen;
533 534 535

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

554 555 556 557 558 559
            if (!s->serial) {
                DPRINTF("Inquiry (EVPD[Serial number] not supported\n");
                return -1;
            }

            l = strlen(s->serial);
560
            if (l > 20) {
561
                l = 20;
562
            }
563 564 565

            DPRINTF("Inquiry EVPD[Serial number] "
                    "buffer size %zd\n", req->cmd.xfer);
566
            memcpy(outbuf+buflen, s->serial, l);
567 568 569 570 571 572
            buflen += l;
            break;
        }

        case 0x83: /* Device identification page, mandatory */
        {
573 574 575
            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);
576

577
            if (id_len > max_len) {
578
                id_len = max_len;
579
            }
580 581 582 583 584 585 586
            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
587
            memcpy(outbuf+buflen, str, id_len);
588
            buflen += id_len;
589 590 591 592 593 594 595 596 597

            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;
            }
598 599
            break;
        }
600
        case 0xb0: /* block limits */
C
Christoph Hellwig 已提交
601
        {
602 603
            unsigned int unmap_sectors =
                    s->qdev.conf.discard_granularity / s->qdev.blocksize;
604 605 606 607
            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 已提交
608

H
Hannes Reinecke 已提交
609
            if (s->qdev.type == TYPE_ROM) {
H
Hannes Reinecke 已提交
610 611 612 613
                DPRINTF("Inquiry (EVPD[%02X] not supported for CDROM\n",
                        page_code);
                return -1;
            }
C
Christoph Hellwig 已提交
614
            /* required VPD size with unmap support */
615
            buflen = 0x40;
C
Christoph Hellwig 已提交
616 617 618 619 620 621 622 623 624 625 626
            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;
627 628 629 630 631 632 633 634 635 636

            /* 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 */
        {
637
            buflen = 8;
638
            outbuf[4] = 0;
639
            outbuf[5] = 0x60; /* write_same 10/16 supported */
640
            outbuf[6] = s->qdev.conf.discard_granularity ? 2 : 1;
641
            outbuf[7] = 0;
C
Christoph Hellwig 已提交
642 643
            break;
        }
644 645 646 647
        default:
            return -1;
        }
        /* done with EVPD */
648 649
        assert(buflen - start <= 255);
        outbuf[start - 1] = buflen - start;
650 651 652 653 654 655 656 657 658 659
        return buflen;
    }

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

    /* PAGE CODE == 0 */
    buflen = req->cmd.xfer;
660
    if (buflen > SCSI_MAX_INQUIRY_LEN) {
661
        buflen = SCSI_MAX_INQUIRY_LEN;
662
    }
663 664
    memset(outbuf, 0, buflen);

H
Hannes Reinecke 已提交
665
    outbuf[0] = s->qdev.type & 0x1f;
666
    outbuf[1] = (s->features & (1 << SCSI_DISK_F_REMOVABLE)) ? 0x80 : 0;
667 668 669 670

    strpadcpy((char *) &outbuf[16], 16, s->product, ' ');
    strpadcpy((char *) &outbuf[8], 8, s->vendor, ' ');

G
Gerd Hoffmann 已提交
671
    memset(&outbuf[32], 0, 4);
672
    memcpy(&outbuf[32], s->version, MIN(4, strlen(s->version)));
673 674 675 676 677 678
    /*
     * 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 已提交
679
    outbuf[2] = 5;
680
    outbuf[3] = 2; /* Format 2 */
681 682 683 684 685 686 687 688 689

    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;
    }

690
    /* Sync data transfer and TCQ.  */
691
    outbuf[7] = 0x10 | (req->bus->info->tcq ? 0x02 : 0);
692 693 694
    return buflen;
}

695 696 697 698 699 700
static inline bool media_is_dvd(SCSIDiskState *s)
{
    uint64_t nb_sectors;
    if (s->qdev.type != TYPE_ROM) {
        return false;
    }
701
    if (!bdrv_is_inserted(s->qdev.conf.bs)) {
702 703
        return false;
    }
704
    bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
705 706 707
    return nb_sectors > CD_MAX_SECTORS;
}

708 709 710 711 712 713
static inline bool media_is_cd(SCSIDiskState *s)
{
    uint64_t nb_sectors;
    if (s->qdev.type != TYPE_ROM) {
        return false;
    }
714
    if (!bdrv_is_inserted(s->qdev.conf.bs)) {
715 716
        return false;
    }
717
    bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
718 719 720
    return nb_sectors <= CD_MAX_SECTORS;
}

721 722 723 724 725 726 727 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
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;
}

754 755 756
static int scsi_read_dvd_structure(SCSIDiskState *s, SCSIDiskReq *r,
                                   uint8_t *outbuf)
{
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
    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) {
778
        if (s->tray_open || !bdrv_is_inserted(s->qdev.conf.bs)) {
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
            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;
        }
800
        bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
801 802 803 804 805 806 807 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

        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:
845 846 847
    return -1;
}

848
static int scsi_event_status_media(SCSIDiskState *s, uint8_t *outbuf)
849
{
850 851 852 853 854
    uint8_t event_code, media_status;

    media_status = 0;
    if (s->tray_open) {
        media_status = MS_TRAY_OPEN;
855
    } else if (bdrv_is_inserted(s->qdev.conf.bs)) {
856 857 858 859 860
        media_status = MS_MEDIA_PRESENT;
    }

    /* Event notification descriptor */
    event_code = MEC_NO_CHANGE;
861 862 863 864 865 866 867 868
    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;
        }
869 870 871 872 873 874 875 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
    }

    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;
905 906
}

907
static int scsi_get_configuration(SCSIDiskState *s, uint8_t *outbuf)
908
{
909 910
    int current;

911 912 913
    if (s->qdev.type != TYPE_ROM) {
        return -1;
    }
914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938
    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;
939 940 941 942 943 944 945 946 947 948 949 950
}

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;
}

951
static int mode_sense_page(SCSIDiskState *s, int page, uint8_t **p_outbuf,
952
                           int page_control)
953
{
954 955 956 957
    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),
958 959
        [MODE_PAGE_R_W_ERROR]              = (1 << TYPE_DISK) | (1 << TYPE_ROM),
        [MODE_PAGE_AUDIO_CTL]              = (1 << TYPE_ROM),
960 961
        [MODE_PAGE_CAPABILITIES]           = (1 << TYPE_ROM),
    };
962 963 964

    uint8_t *p = *p_outbuf + 2;
    int length;
965

966 967 968 969
    if ((mode_sense_valid[page] & (1 << s->qdev.type)) == 0) {
        return -1;
    }

970 971 972 973 974
    /*
     * 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.
975 976 977 978 979 980
     *
     * The offsets here are off by two compared to the descriptions in the
     * SCSI specs, because those include a 2-byte header.  This is unfortunate,
     * but it is done so that offsets are consistent within our implementation
     * of MODE SENSE and MODE SELECT.  MODE SELECT has to deal with both
     * 2-byte and 4-byte headers.
981
     */
982
    switch (page) {
983
    case MODE_PAGE_HD_GEOMETRY:
984
        length = 0x16;
985
        if (page_control == 1) { /* Changeable Values */
986
            break;
987
        }
988
        /* if a geometry hint is available, use it */
989 990 991 992
        p[0] = (s->qdev.conf.cyls >> 16) & 0xff;
        p[1] = (s->qdev.conf.cyls >> 8) & 0xff;
        p[2] = s->qdev.conf.cyls & 0xff;
        p[3] = s->qdev.conf.heads & 0xff;
993
        /* Write precomp start cylinder, disabled */
994 995 996
        p[4] = (s->qdev.conf.cyls >> 16) & 0xff;
        p[5] = (s->qdev.conf.cyls >> 8) & 0xff;
        p[6] = s->qdev.conf.cyls & 0xff;
997
        /* Reduced current start cylinder, disabled */
998 999 1000
        p[7] = (s->qdev.conf.cyls >> 16) & 0xff;
        p[8] = (s->qdev.conf.cyls >> 8) & 0xff;
        p[9] = s->qdev.conf.cyls & 0xff;
1001
        /* Device step rate [ns], 200ns */
1002 1003
        p[10] = 0;
        p[11] = 200;
1004
        /* Landing zone cylinder */
1005 1006
        p[12] = 0xff;
        p[13] =  0xff;
1007 1008
        p[14] = 0xff;
        /* Medium rotation rate [rpm], 5400 rpm */
1009 1010
        p[18] = (5400 >> 8) & 0xff;
        p[19] = 5400 & 0xff;
1011
        break;
1012

1013
    case MODE_PAGE_FLEXIBLE_DISK_GEOMETRY:
1014
        length = 0x1e;
1015
        if (page_control == 1) { /* Changeable Values */
1016
            break;
1017
        }
1018
        /* Transfer rate [kbit/s], 5Mbit/s */
1019 1020
        p[0] = 5000 >> 8;
        p[1] = 5000 & 0xff;
1021
        /* if a geometry hint is available, use it */
1022 1023 1024 1025 1026 1027
        p[2] = s->qdev.conf.heads & 0xff;
        p[3] = s->qdev.conf.secs & 0xff;
        p[4] = s->qdev.blocksize >> 8;
        p[6] = (s->qdev.conf.cyls >> 8) & 0xff;
        p[7] = s->qdev.conf.cyls & 0xff;
        /* Write precomp start cylinder, disabled */
1028 1029
        p[8] = (s->qdev.conf.cyls >> 8) & 0xff;
        p[9] = s->qdev.conf.cyls & 0xff;
1030
        /* Reduced current start cylinder, disabled */
1031 1032
        p[10] = (s->qdev.conf.cyls >> 8) & 0xff;
        p[11] = s->qdev.conf.cyls & 0xff;
1033
        /* Device step rate [100us], 100us */
1034 1035
        p[12] = 0;
        p[13] = 1;
1036
        /* Device step pulse width [us], 1us */
1037
        p[14] = 1;
1038
        /* Device head settle delay [100us], 100us */
1039 1040
        p[15] = 0;
        p[16] = 1;
1041
        /* Motor on delay [0.1s], 0.1s */
1042
        p[17] = 1;
1043
        /* Motor off delay [0.1s], 0.1s */
1044
        p[18] = 1;
1045
        /* Medium rotation rate [rpm], 5400 rpm */
1046 1047
        p[26] = (5400 >> 8) & 0xff;
        p[27] = 5400 & 0xff;
1048
        break;
1049

1050
    case MODE_PAGE_CACHING:
1051
        length = 0x12;
1052
        if (page_control == 1) { /* Changeable Values */
1053
            break;
1054
        }
1055
        if (bdrv_enable_write_cache(s->qdev.conf.bs)) {
1056
            p[0] = 4; /* WCE */
1057
        }
1058
        break;
1059

1060
    case MODE_PAGE_R_W_ERROR:
1061 1062
        length = 10;
        p[0] = 0x80; /* Automatic Write Reallocation Enabled */
1063
        if (s->qdev.type == TYPE_ROM) {
1064
            p[1] = 0x20; /* Read Retry Count */
1065 1066 1067 1068
        }
        break;

    case MODE_PAGE_AUDIO_CTL:
1069
        length = 14;
1070 1071
        break;

1072
    case MODE_PAGE_CAPABILITIES:
1073
        length = 0x14;
1074
        if (page_control == 1) { /* Changeable Values */
1075
            break;
1076
        }
1077

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

    default:
1104
        return -1;
1105
    }
1106

1107 1108 1109 1110 1111
    assert(length < 256);
    (*p_outbuf)[0] = page;
    (*p_outbuf)[1] = length;
    *p_outbuf += length + 2;
    return length + 2;
1112 1113
}

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

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

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

1143
    if (r->req.cmd.buf[0] == MODE_SENSE) {
1144 1145 1146 1147 1148 1149 1150 1151 1152
        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;
1153 1154
    }

1155
    bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
1156
    if (!dbd && nb_sectors) {
1157
        if (r->req.cmd.buf[0] == MODE_SENSE) {
1158 1159 1160 1161
            outbuf[3] = 8; /* Block descriptor length  */
        } else { /* MODE_SENSE_10 */
            outbuf[7] = 8; /* Block descriptor length  */
        }
P
Paolo Bonzini 已提交
1162
        nb_sectors /= (s->qdev.blocksize / 512);
1163
        if (nb_sectors > 0xffffff) {
1164
            nb_sectors = 0;
1165
        }
1166 1167 1168 1169 1170 1171
        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 已提交
1172
        p[6] = s->qdev.blocksize >> 8;
1173 1174 1175 1176
        p[7] = 0;
        p += 8;
    }

1177 1178 1179 1180
    if (page_control == 3) {
        /* Saved Values */
        scsi_check_condition(r, SENSE_CODE(SAVING_PARAMS_NOT_SUPPORTED));
        return -1;
1181 1182
    }

1183 1184 1185 1186 1187 1188 1189 1190 1191
    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;
        }
1192 1193 1194
    }

    buflen = p - outbuf;
1195 1196 1197 1198 1199
    /*
     * 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.
     */
1200
    if (r->req.cmd.buf[0] == MODE_SENSE) {
1201 1202 1203 1204 1205
        outbuf[0] = buflen - 1;
    } else { /* MODE_SENSE_10 */
        outbuf[0] = ((buflen - 2) >> 8) & 0xff;
        outbuf[1] = (buflen - 2) & 0xff;
    }
1206 1207 1208
    return buflen;
}

1209 1210 1211 1212 1213 1214 1215 1216 1217
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];
1218
    bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
1219
    DPRINTF("Read TOC (track %d format %d msf %d)\n", start_track, format, msf >> 1);
P
Paolo Bonzini 已提交
1220
    nb_sectors /= s->qdev.blocksize / 512;
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241
    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;
}

1242
static int scsi_disk_emulate_start_stop(SCSIDiskReq *r)
1243 1244 1245 1246 1247 1248 1249
{
    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) {
1250 1251
        if (!start && !s->tray_open && s->tray_locked) {
            scsi_check_condition(r,
1252
                                 bdrv_is_inserted(s->qdev.conf.bs)
1253 1254 1255
                                 ? SENSE_CODE(ILLEGAL_REQ_REMOVAL_PREVENTED)
                                 : SENSE_CODE(NOT_READY_REMOVAL_PREVENTED));
            return -1;
1256
        }
1257 1258 1259 1260 1261

        if (s->tray_open != !start) {
            bdrv_eject(s->qdev.conf.bs, !start);
            s->tray_open = !start;
        }
1262
    }
1263
    return 0;
1264 1265
}

1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
static void scsi_disk_emulate_read_data(SCSIRequest *req)
{
    SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
    int buflen = r->iov.iov_len;

    if (buflen) {
        DPRINTF("Read buf_len=%zd\n", buflen);
        r->iov.iov_len = 0;
        r->started = true;
        scsi_req_data(&r->req, buflen);
        return;
    }

    /* This also clears the sense buffer for REQUEST SENSE.  */
    scsi_req_complete(&r->req, GOOD);
}

static void scsi_disk_emulate_write_data(SCSIRequest *req)
{
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
    SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);

    if (r->iov.iov_len) {
        int buflen = r->iov.iov_len;
        DPRINTF("Write buf_len=%zd\n", buflen);
        r->iov.iov_len = 0;
        scsi_req_data(&r->req, buflen);
        return;
    }

    switch (req->cmd.buf[0]) {
    case MODE_SELECT:
    case MODE_SELECT_10:
        /* This also clears the sense buffer for REQUEST SENSE.  */
        scsi_req_complete(&r->req, GOOD);
        break;

    default:
        abort();
    }
1305 1306
}

1307
static int32_t scsi_disk_emulate_command(SCSIRequest *req, uint8_t *buf)
1308
{
1309
    SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
1310 1311
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
    uint64_t nb_sectors;
1312
    uint8_t *outbuf;
1313
    int buflen;
1314

1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338
    switch (req->cmd.buf[0]) {
    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;
    }

1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351
    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);
1352
        r->iov.iov_base = qemu_blockalign(s->qdev.conf.bs, r->buflen);
1353 1354
    }

1355
    buflen = req->cmd.xfer;
1356
    outbuf = r->iov.iov_base;
1357 1358
    switch (req->cmd.buf[0]) {
    case TEST_UNIT_READY:
1359
        assert(!s->tray_open && bdrv_is_inserted(s->qdev.conf.bs));
H
Hannes Reinecke 已提交
1360
        break;
1361 1362
    case INQUIRY:
        buflen = scsi_disk_emulate_inquiry(req, outbuf);
1363
        if (buflen < 0) {
1364
            goto illegal_request;
1365
        }
H
Hannes Reinecke 已提交
1366
        break;
1367 1368
    case MODE_SENSE:
    case MODE_SENSE_10:
1369
        buflen = scsi_disk_emulate_mode_sense(r, outbuf);
1370
        if (buflen < 0) {
1371
            goto illegal_request;
1372
        }
1373
        break;
1374 1375
    case READ_TOC:
        buflen = scsi_disk_emulate_read_toc(req, outbuf);
1376
        if (buflen < 0) {
1377
            goto illegal_request;
1378
        }
1379
        break;
1380
    case RESERVE:
1381
        if (req->cmd.buf[1] & 1) {
1382
            goto illegal_request;
1383
        }
1384 1385
        break;
    case RESERVE_10:
1386
        if (req->cmd.buf[1] & 3) {
1387
            goto illegal_request;
1388
        }
1389 1390
        break;
    case RELEASE:
1391
        if (req->cmd.buf[1] & 1) {
1392
            goto illegal_request;
1393
        }
1394 1395
        break;
    case RELEASE_10:
1396
        if (req->cmd.buf[1] & 3) {
1397
            goto illegal_request;
1398
        }
1399
        break;
1400
    case START_STOP:
1401
        if (scsi_disk_emulate_start_stop(r) < 0) {
1402
            return 0;
1403
        }
H
Hannes Reinecke 已提交
1404
        break;
1405
    case ALLOW_MEDIUM_REMOVAL:
1406
        s->tray_locked = req->cmd.buf[4] & 1;
1407
        bdrv_lock_medium(s->qdev.conf.bs, req->cmd.buf[4] & 1);
H
Hannes Reinecke 已提交
1408
        break;
1409
    case READ_CAPACITY_10:
1410
        /* The normal LEN field for this command is zero.  */
H
Hannes Reinecke 已提交
1411
        memset(outbuf, 0, 8);
1412
        bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
1413
        if (!nb_sectors) {
1414 1415
            scsi_check_condition(r, SENSE_CODE(LUN_NOT_READY));
            return -1;
1416
        }
1417 1418 1419
        if ((req->cmd.buf[8] & 1) == 0 && req->cmd.lba) {
            goto illegal_request;
        }
P
Paolo Bonzini 已提交
1420
        nb_sectors /= s->qdev.blocksize / 512;
1421 1422 1423
        /* Returned value is the address of the last sector.  */
        nb_sectors--;
        /* Remember the new size for read/write sanity checking. */
P
Paolo Bonzini 已提交
1424
        s->qdev.max_lba = nb_sectors;
1425
        /* Clip to 2TB, instead of returning capacity modulo 2TB. */
1426
        if (nb_sectors > UINT32_MAX) {
1427
            nb_sectors = UINT32_MAX;
1428
        }
1429 1430 1431 1432 1433 1434
        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 已提交
1435
        outbuf[6] = s->qdev.blocksize >> 8;
1436 1437
        outbuf[7] = 0;
        buflen = 8;
H
Hannes Reinecke 已提交
1438
        break;
1439 1440 1441 1442 1443
    case REQUEST_SENSE:
        /* Just return "NO SENSE".  */
        buflen = scsi_build_sense(NULL, 0, outbuf, r->buflen,
                                  (req->cmd.buf[1] & 1) == 0);
        break;
1444 1445 1446 1447 1448 1449
    case MECHANISM_STATUS:
        buflen = scsi_emulate_mechanism_status(s, outbuf);
        if (buflen < 0) {
            goto illegal_request;
        }
        break;
1450
    case GET_CONFIGURATION:
1451
        buflen = scsi_get_configuration(s, outbuf);
1452 1453 1454 1455 1456 1457 1458 1459 1460 1461
        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;
1462 1463 1464 1465 1466 1467
    case READ_DISC_INFORMATION:
        buflen = scsi_read_disc_information(s, r, outbuf);
        if (buflen < 0) {
            goto illegal_request;
        }
        break;
1468 1469 1470 1471 1472
    case READ_DVD_STRUCTURE:
        buflen = scsi_read_dvd_structure(s, r, outbuf);
        if (buflen < 0) {
            goto illegal_request;
        }
1473
        break;
1474
    case SERVICE_ACTION_IN_16:
1475
        /* Service Action In subcommands. */
1476
        if ((req->cmd.buf[1] & 31) == SAI_READ_CAPACITY_16) {
1477 1478
            DPRINTF("SAI READ CAPACITY(16)\n");
            memset(outbuf, 0, req->cmd.xfer);
1479
            bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
1480
            if (!nb_sectors) {
1481 1482
                scsi_check_condition(r, SENSE_CODE(LUN_NOT_READY));
                return -1;
1483
            }
1484 1485 1486
            if ((req->cmd.buf[14] & 1) == 0 && req->cmd.lba) {
                goto illegal_request;
            }
P
Paolo Bonzini 已提交
1487
            nb_sectors /= s->qdev.blocksize / 512;
1488 1489 1490
            /* Returned value is the address of the last sector.  */
            nb_sectors--;
            /* Remember the new size for read/write sanity checking. */
P
Paolo Bonzini 已提交
1491
            s->qdev.max_lba = nb_sectors;
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
            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 已提交
1502
            outbuf[10] = s->qdev.blocksize >> 8;
1503
            outbuf[11] = 0;
C
Christoph Hellwig 已提交
1504 1505
            outbuf[12] = 0;
            outbuf[13] = get_physical_block_exp(&s->qdev.conf);
1506 1507 1508 1509 1510 1511

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

1512 1513 1514 1515 1516 1517
            /* Protection, exponent and lowest lba field left blank. */
            buflen = req->cmd.xfer;
            break;
        }
        DPRINTF("Unsupported Service Action In\n");
        goto illegal_request;
1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
    case SYNCHRONIZE_CACHE:
        /* The request is used as the AIO opaque value, so add a ref.  */
        scsi_req_ref(&r->req);
        bdrv_acct_start(s->qdev.conf.bs, &r->acct, 0, BDRV_ACCT_FLUSH);
        r->req.aiocb = bdrv_aio_flush(s->qdev.conf.bs, scsi_aio_complete, r);
        return 0;
    case SEEK_10:
        DPRINTF("Seek(10) (sector %" PRId64 ")\n", r->req.cmd.lba);
        if (r->req.cmd.lba > s->qdev.max_lba) {
            goto illegal_lba;
        }
        break;
    case MODE_SELECT:
        DPRINTF("Mode Select(6) (len %lu)\n", (long)r->req.cmd.xfer);
        /* We don't support mode parameter changes.
           Allow the mode parameter header + block descriptors only. */
        if (r->req.cmd.xfer > 12) {
            goto illegal_request;
        }
        break;
    case MODE_SELECT_10:
        DPRINTF("Mode Select(10) (len %lu)\n", (long)r->req.cmd.xfer);
        /* We don't support mode parameter changes.
           Allow the mode parameter header + block descriptors only. */
        if (r->req.cmd.xfer > 16) {
            goto illegal_request;
        }
        break;
    case WRITE_SAME_10:
        nb_sectors = lduw_be_p(&req->cmd.buf[7]);
        goto write_same;
    case WRITE_SAME_16:
        nb_sectors = ldl_be_p(&req->cmd.buf[10]) & 0xffffffffULL;
    write_same:
        if (r->req.cmd.lba > s->qdev.max_lba) {
            goto illegal_lba;
        }

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

        /* The request is used as the AIO opaque value, so add a ref.  */
        scsi_req_ref(&r->req);
        r->req.aiocb = bdrv_aio_discard(s->qdev.conf.bs,
                                        r->req.cmd.lba * (s->qdev.blocksize / 512),
                                        nb_sectors * (s->qdev.blocksize / 512),
                                        scsi_aio_complete, r);
        return 0;
1570
    default:
1571
        DPRINTF("Unknown SCSI command (%2.2x)\n", buf[0]);
1572
        scsi_check_condition(r, SENSE_CODE(INVALID_OPCODE));
1573
        return 0;
1574
    }
1575
    assert(!r->req.aiocb);
1576 1577 1578 1579
    r->iov.iov_len = MIN(buflen, req->cmd.xfer);
    if (r->iov.iov_len == 0) {
        scsi_req_complete(&r->req, GOOD);
    }
1580 1581 1582 1583 1584 1585
    if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
        assert(r->iov.iov_len == req->cmd.xfer);
        return -r->iov.iov_len;
    } else {
        return r->iov.iov_len;
    }
1586 1587

illegal_request:
1588 1589 1590
    if (r->req.status == -1) {
        scsi_check_condition(r, SENSE_CODE(INVALID_FIELD));
    }
1591
    return 0;
1592 1593 1594 1595

illegal_lba:
    scsi_check_condition(r, SENSE_CODE(LBA_OUT_OF_RANGE));
    return 0;
1596 1597
}

P
pbrook 已提交
1598 1599 1600 1601 1602
/* 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.  */

1603
static int32_t scsi_disk_dma_command(SCSIRequest *req, uint8_t *buf)
P
pbrook 已提交
1604
{
1605 1606
    SCSIDiskReq *r = DO_UPCAST(SCSIDiskReq, req, req);
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, req->dev);
P
Paolo Bonzini 已提交
1607
    int32_t len;
P
pbrook 已提交
1608 1609 1610
    uint8_t command;

    command = buf[0];
1611

1612 1613 1614
    if (s->tray_open || !bdrv_is_inserted(s->qdev.conf.bs)) {
        scsi_check_condition(r, SENSE_CODE(NO_MEDIUM));
        return 0;
1615 1616
    }

P
pbrook 已提交
1617
    switch (command) {
1618 1619
    case READ_6:
    case READ_10:
G
Gerd Hoffmann 已提交
1620 1621
    case READ_12:
    case READ_16:
1622
        len = r->req.cmd.xfer / s->qdev.blocksize;
1623
        DPRINTF("Read (sector %" PRId64 ", count %d)\n", r->req.cmd.lba, len);
P
Paolo Bonzini 已提交
1624
        if (r->req.cmd.lba > s->qdev.max_lba) {
1625
            goto illegal_lba;
1626
        }
P
Paolo Bonzini 已提交
1627 1628
        r->sector = r->req.cmd.lba * (s->qdev.blocksize / 512);
        r->sector_count = len * (s->qdev.blocksize / 512);
P
pbrook 已提交
1629
        break;
1630 1631 1632
    case VERIFY_10:
    case VERIFY_12:
    case VERIFY_16:
1633 1634
    case WRITE_6:
    case WRITE_10:
G
Gerd Hoffmann 已提交
1635 1636
    case WRITE_12:
    case WRITE_16:
1637
    case WRITE_VERIFY_10:
1638 1639
    case WRITE_VERIFY_12:
    case WRITE_VERIFY_16:
1640
        len = r->req.cmd.xfer / s->qdev.blocksize;
1641
        DPRINTF("Write %s(sector %" PRId64 ", count %d)\n",
1642 1643
                (command & 0xe) == 0xe ? "And Verify " : "",
                r->req.cmd.lba, len);
P
Paolo Bonzini 已提交
1644
        if (r->req.cmd.lba > s->qdev.max_lba) {
1645
            goto illegal_lba;
1646
        }
P
Paolo Bonzini 已提交
1647 1648
        r->sector = r->req.cmd.lba * (s->qdev.blocksize / 512);
        r->sector_count = len * (s->qdev.blocksize / 512);
P
pbrook 已提交
1649
        break;
1650
    default:
1651
        abort();
1652
    illegal_lba:
1653
        scsi_check_condition(r, SENSE_CODE(LBA_OUT_OF_RANGE));
1654
        return 0;
P
pbrook 已提交
1655
    }
1656
    if (r->sector_count == 0) {
1657
        scsi_req_complete(&r->req, GOOD);
P
pbrook 已提交
1658
    }
1659
    assert(r->iov.iov_len == 0);
1660
    if (r->req.cmd.mode == SCSI_XFER_TO_DEV) {
1661
        return -r->sector_count * 512;
P
pbrook 已提交
1662
    } else {
1663
        return r->sector_count * 512;
P
pbrook 已提交
1664 1665 1666
    }
}

J
Jan Kiszka 已提交
1667 1668 1669 1670 1671
static void scsi_disk_reset(DeviceState *dev)
{
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev.qdev, dev);
    uint64_t nb_sectors;

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

1674
    bdrv_get_geometry(s->qdev.conf.bs, &nb_sectors);
P
Paolo Bonzini 已提交
1675
    nb_sectors /= s->qdev.blocksize / 512;
J
Jan Kiszka 已提交
1676 1677 1678
    if (nb_sectors) {
        nb_sectors--;
    }
P
Paolo Bonzini 已提交
1679
    s->qdev.max_lba = nb_sectors;
J
Jan Kiszka 已提交
1680 1681 1682 1683 1684 1685
}

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

1686
    scsi_device_purge_requests(&s->qdev, SENSE_CODE(NO_SENSE));
1687
    blockdev_mark_auto_del(s->qdev.conf.bs);
G
Gerd Hoffmann 已提交
1688 1689
}

1690
static void scsi_cd_change_media_cb(void *opaque, bool load)
1691
{
1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706
    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);
1707
    s->media_event = true;
1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718
    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;
    }
1719 1720
}

1721 1722 1723 1724 1725
static bool scsi_cd_is_tray_open(void *opaque)
{
    return ((SCSIDiskState *)opaque)->tray_open;
}

1726 1727 1728 1729 1730 1731
static bool scsi_cd_is_medium_locked(void *opaque)
{
    return ((SCSIDiskState *)opaque)->tray_locked;
}

static const BlockDevOps scsi_cd_block_ops = {
1732
    .change_media_cb = scsi_cd_change_media_cb,
1733
    .eject_request_cb = scsi_cd_eject_request_cb,
1734
    .is_tray_open = scsi_cd_is_tray_open,
1735 1736 1737
    .is_medium_locked = scsi_cd_is_medium_locked,
};

1738 1739 1740 1741 1742 1743 1744 1745 1746
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);
    }
}

1747
static int scsi_initfn(SCSIDevice *dev)
P
pbrook 已提交
1748
{
1749
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
P
pbrook 已提交
1750

1751
    if (!s->qdev.conf.bs) {
1752
        error_report("drive property not set");
1753 1754 1755
        return -1;
    }

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

1762
    blkconf_serial(&s->qdev.conf, &s->serial);
1763 1764 1765
    if (blkconf_geometry(&dev->conf, NULL, 65535, 255, 255) < 0) {
        return -1;
    }
1766

1767
    if (!s->version) {
1768
        s->version = g_strdup(qemu_get_version());
1769
    }
1770 1771 1772
    if (!s->vendor) {
        s->vendor = g_strdup("QEMU");
    }
1773

1774
    if (bdrv_is_sg(s->qdev.conf.bs)) {
1775
        error_report("unwanted /dev/sg*");
1776 1777 1778
        return -1;
    }

1779
    if (s->features & (1 << SCSI_DISK_F_REMOVABLE)) {
1780
        bdrv_set_dev_ops(s->qdev.conf.bs, &scsi_cd_block_ops, s);
P
pbrook 已提交
1781
    }
1782
    bdrv_set_buffer_alignment(s->qdev.conf.bs, s->qdev.blocksize);
1783

1784
    bdrv_iostatus_enable(s->qdev.conf.bs);
P
Paolo Bonzini 已提交
1785
    add_boot_device_path(s->qdev.conf.bootindex, &dev->qdev, NULL);
1786 1787 1788
    return 0;
}

1789 1790
static int scsi_hd_initfn(SCSIDevice *dev)
{
1791 1792 1793
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
    s->qdev.blocksize = s->qdev.conf.logical_block_size;
    s->qdev.type = TYPE_DISK;
1794 1795 1796
    if (!s->product) {
        s->product = g_strdup("QEMU HARDDISK");
    }
1797
    return scsi_initfn(&s->qdev);
1798 1799 1800 1801
}

static int scsi_cd_initfn(SCSIDevice *dev)
{
1802 1803 1804
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, dev);
    s->qdev.blocksize = 2048;
    s->qdev.type = TYPE_ROM;
1805
    s->features |= 1 << SCSI_DISK_F_REMOVABLE;
1806 1807 1808
    if (!s->product) {
        s->product = g_strdup("QEMU CD-ROM");
    }
1809
    return scsi_initfn(&s->qdev);
1810 1811 1812 1813
}

static int scsi_disk_initfn(SCSIDevice *dev)
{
1814
    DriveInfo *dinfo;
1815 1816

    if (!dev->conf.bs) {
1817
        return scsi_initfn(dev);  /* ... and die there */
1818 1819
    }

1820 1821 1822 1823 1824 1825
    dinfo = drive_get_by_blockdev(dev->conf.bs);
    if (dinfo->media_cd) {
        return scsi_cd_initfn(dev);
    } else {
        return scsi_hd_initfn(dev);
    }
1826 1827
}

1828
static const SCSIReqOps scsi_disk_emulate_reqops = {
P
Paolo Bonzini 已提交
1829
    .size         = sizeof(SCSIDiskReq),
1830
    .free_req     = scsi_free_request,
1831
    .send_command = scsi_disk_emulate_command,
1832 1833
    .read_data    = scsi_disk_emulate_read_data,
    .write_data   = scsi_disk_emulate_write_data,
1834 1835 1836 1837 1838 1839 1840
    .get_buf      = scsi_get_buf,
};

static const SCSIReqOps scsi_disk_dma_reqops = {
    .size         = sizeof(SCSIDiskReq),
    .free_req     = scsi_free_request,
    .send_command = scsi_disk_dma_command,
1841 1842 1843 1844
    .read_data    = scsi_read_data,
    .write_data   = scsi_write_data,
    .cancel_io    = scsi_cancel_io,
    .get_buf      = scsi_get_buf,
P
Paolo Bonzini 已提交
1845 1846
    .load_request = scsi_disk_load_request,
    .save_request = scsi_disk_save_request,
P
Paolo Bonzini 已提交
1847 1848
};

1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887
static const SCSIReqOps *const scsi_disk_reqops_dispatch[256] = {
    [TEST_UNIT_READY]                 = &scsi_disk_emulate_reqops,
    [INQUIRY]                         = &scsi_disk_emulate_reqops,
    [MODE_SENSE]                      = &scsi_disk_emulate_reqops,
    [MODE_SENSE_10]                   = &scsi_disk_emulate_reqops,
    [START_STOP]                      = &scsi_disk_emulate_reqops,
    [ALLOW_MEDIUM_REMOVAL]            = &scsi_disk_emulate_reqops,
    [READ_CAPACITY_10]                = &scsi_disk_emulate_reqops,
    [READ_TOC]                        = &scsi_disk_emulate_reqops,
    [READ_DVD_STRUCTURE]              = &scsi_disk_emulate_reqops,
    [READ_DISC_INFORMATION]           = &scsi_disk_emulate_reqops,
    [GET_CONFIGURATION]               = &scsi_disk_emulate_reqops,
    [GET_EVENT_STATUS_NOTIFICATION]   = &scsi_disk_emulate_reqops,
    [MECHANISM_STATUS]                = &scsi_disk_emulate_reqops,
    [SERVICE_ACTION_IN_16]            = &scsi_disk_emulate_reqops,
    [REQUEST_SENSE]                   = &scsi_disk_emulate_reqops,
    [SYNCHRONIZE_CACHE]               = &scsi_disk_emulate_reqops,
    [SEEK_10]                         = &scsi_disk_emulate_reqops,
    [MODE_SELECT]                     = &scsi_disk_emulate_reqops,
    [MODE_SELECT_10]                  = &scsi_disk_emulate_reqops,
    [WRITE_SAME_10]                   = &scsi_disk_emulate_reqops,
    [WRITE_SAME_16]                   = &scsi_disk_emulate_reqops,

    [READ_6]                          = &scsi_disk_dma_reqops,
    [READ_10]                         = &scsi_disk_dma_reqops,
    [READ_12]                         = &scsi_disk_dma_reqops,
    [READ_16]                         = &scsi_disk_dma_reqops,
    [VERIFY_10]                       = &scsi_disk_dma_reqops,
    [VERIFY_12]                       = &scsi_disk_dma_reqops,
    [VERIFY_16]                       = &scsi_disk_dma_reqops,
    [WRITE_6]                         = &scsi_disk_dma_reqops,
    [WRITE_10]                        = &scsi_disk_dma_reqops,
    [WRITE_12]                        = &scsi_disk_dma_reqops,
    [WRITE_16]                        = &scsi_disk_dma_reqops,
    [WRITE_VERIFY_10]                 = &scsi_disk_dma_reqops,
    [WRITE_VERIFY_12]                 = &scsi_disk_dma_reqops,
    [WRITE_VERIFY_16]                 = &scsi_disk_dma_reqops,
};

P
Paolo Bonzini 已提交
1888 1889
static SCSIRequest *scsi_new_request(SCSIDevice *d, uint32_t tag, uint32_t lun,
                                     uint8_t *buf, void *hba_private)
P
Paolo Bonzini 已提交
1890 1891 1892
{
    SCSIDiskState *s = DO_UPCAST(SCSIDiskState, qdev, d);
    SCSIRequest *req;
1893 1894
    const SCSIReqOps *ops;
    uint8_t command;
P
Paolo Bonzini 已提交
1895

1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912
#ifdef DEBUG_SCSI
    DPRINTF("Command: lun=%d tag=0x%x data=0x%02x", lun, buf[0]);
    {
        int i;
        for (i = 1; i < r->req.cmd.len; i++) {
            printf(" 0x%02x", buf[i]);
        }
        printf("\n");
    }
#endif

    command = buf[0];
    ops = scsi_disk_reqops_dispatch[command];
    if (!ops) {
        ops = &scsi_disk_emulate_reqops;
    }
    req = scsi_req_alloc(ops, &s->qdev, tag, lun, hba_private);
P
Paolo Bonzini 已提交
1913 1914 1915
    return req;
}

1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946
#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];
1947 1948 1949
    if (buf[1] & 0x80) {
        s->features |= 1 << SCSI_DISK_F_REMOVABLE;
    }
1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000
    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:
2001 2002 2003
    case VERIFY_10:
    case VERIFY_12:
    case VERIFY_16:
2004 2005 2006 2007 2008 2009 2010
    case WRITE_6:
    case WRITE_10:
    case WRITE_12:
    case WRITE_16:
    case WRITE_VERIFY_10:
    case WRITE_VERIFY_12:
    case WRITE_VERIFY_16:
2011 2012 2013 2014 2015
        /* 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.
         */
2016
        if (bdrv_get_flags(s->qdev.conf.bs) & BDRV_O_NOCACHE) {
2017 2018 2019
            break;
        }

2020 2021 2022 2023 2024 2025
        /* 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).
         *
2026
         * We might use scsi_disk_dma_reqops as long as no writing commands are
2027 2028 2029
         * seen, but performance usually isn't paramount on optical media.  So,
         * just make scsi-block operate the same as scsi-generic for them.
         */
2030 2031 2032 2033
        if (s->qdev.type != TYPE_ROM) {
            return scsi_req_alloc(&scsi_disk_dma_reqops, &s->qdev, tag, lun,
                                  hba_private);
        }
2034 2035 2036 2037 2038 2039 2040
    }

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

2041 2042 2043 2044 2045 2046
#define DEFINE_SCSI_DISK_PROPERTIES()                                \
    DEFINE_BLOCK_PROPERTIES(SCSIDiskState, qdev.conf),               \
    DEFINE_PROP_STRING("ver", SCSIDiskState, version),               \
    DEFINE_PROP_STRING("serial", SCSIDiskState, serial),             \
    DEFINE_PROP_STRING("vendor", SCSIDiskState, vendor),             \
    DEFINE_PROP_STRING("product", SCSIDiskState, product)
2047

2048 2049
static Property scsi_hd_properties[] = {
    DEFINE_SCSI_DISK_PROPERTIES(),
2050 2051
    DEFINE_PROP_BIT("removable", SCSIDiskState, features,
                    SCSI_DISK_F_REMOVABLE, false),
P
Paolo Bonzini 已提交
2052 2053
    DEFINE_PROP_BIT("dpofua", SCSIDiskState, features,
                    SCSI_DISK_F_DPOFUA, false),
2054
    DEFINE_PROP_HEX64("wwn", SCSIDiskState, wwn, 0),
2055
    DEFINE_BLOCK_CHS_PROPERTIES(SCSIDiskState, qdev.conf),
2056 2057 2058
    DEFINE_PROP_END_OF_LIST(),
};

P
Paolo Bonzini 已提交
2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074
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()
    }
};

2075 2076
static void scsi_hd_class_initfn(ObjectClass *klass, void *data)
{
2077
    DeviceClass *dc = DEVICE_CLASS(klass);
2078 2079 2080 2081 2082 2083
    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;
2084 2085 2086 2087
    dc->fw_name = "disk";
    dc->desc = "virtual SCSI disk";
    dc->reset = scsi_disk_reset;
    dc->props = scsi_hd_properties;
P
Paolo Bonzini 已提交
2088
    dc->vmsd  = &vmstate_scsi_disk_state;
2089 2090
}

2091 2092 2093 2094 2095 2096 2097 2098 2099
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(),
2100
    DEFINE_PROP_HEX64("wwn", SCSIDiskState, wwn, 0),
2101
    DEFINE_PROP_END_OF_LIST(),
2102 2103 2104 2105
};

static void scsi_cd_class_initfn(ObjectClass *klass, void *data)
{
2106
    DeviceClass *dc = DEVICE_CLASS(klass);
2107 2108 2109 2110 2111 2112
    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;
2113 2114 2115 2116
    dc->fw_name = "disk";
    dc->desc = "virtual SCSI CD-ROM";
    dc->reset = scsi_disk_reset;
    dc->props = scsi_cd_properties;
P
Paolo Bonzini 已提交
2117
    dc->vmsd  = &vmstate_scsi_disk_state;
2118 2119
}

2120 2121 2122 2123 2124
static TypeInfo scsi_cd_info = {
    .name          = "scsi-cd",
    .parent        = TYPE_SCSI_DEVICE,
    .instance_size = sizeof(SCSIDiskState),
    .class_init    = scsi_cd_class_initfn,
2125 2126
};

2127
#ifdef __linux__
2128
static Property scsi_block_properties[] = {
2129
    DEFINE_PROP_DRIVE("drive", SCSIDiskState, qdev.conf.bs),
2130 2131 2132
    DEFINE_PROP_END_OF_LIST(),
};

2133 2134
static void scsi_block_class_initfn(ObjectClass *klass, void *data)
{
2135
    DeviceClass *dc = DEVICE_CLASS(klass);
2136 2137 2138 2139 2140
    SCSIDeviceClass *sc = SCSI_DEVICE_CLASS(klass);

    sc->init         = scsi_block_initfn;
    sc->destroy      = scsi_destroy;
    sc->alloc_req    = scsi_block_new_request;
2141 2142 2143 2144
    dc->fw_name = "disk";
    dc->desc = "SCSI block device passthrough";
    dc->reset = scsi_disk_reset;
    dc->props = scsi_block_properties;
P
Paolo Bonzini 已提交
2145
    dc->vmsd  = &vmstate_scsi_disk_state;
2146 2147
}

2148 2149 2150 2151 2152
static TypeInfo scsi_block_info = {
    .name          = "scsi-block",
    .parent        = TYPE_SCSI_DEVICE,
    .instance_size = sizeof(SCSIDiskState),
    .class_init    = scsi_block_class_initfn,
2153
};
2154
#endif
2155

2156 2157
static Property scsi_disk_properties[] = {
    DEFINE_SCSI_DISK_PROPERTIES(),
2158 2159
    DEFINE_PROP_BIT("removable", SCSIDiskState, features,
                    SCSI_DISK_F_REMOVABLE, false),
P
Paolo Bonzini 已提交
2160 2161
    DEFINE_PROP_BIT("dpofua", SCSIDiskState, features,
                    SCSI_DISK_F_DPOFUA, false),
2162
    DEFINE_PROP_HEX64("wwn", SCSIDiskState, wwn, 0),
2163 2164 2165
    DEFINE_PROP_END_OF_LIST(),
};

2166 2167
static void scsi_disk_class_initfn(ObjectClass *klass, void *data)
{
2168
    DeviceClass *dc = DEVICE_CLASS(klass);
2169 2170 2171 2172 2173 2174
    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;
2175 2176 2177 2178
    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 已提交
2179
    dc->vmsd  = &vmstate_scsi_disk_state;
2180 2181
}

2182 2183 2184 2185 2186
static TypeInfo scsi_disk_info = {
    .name          = "scsi-disk",
    .parent        = TYPE_SCSI_DEVICE,
    .instance_size = sizeof(SCSIDiskState),
    .class_init    = scsi_disk_class_initfn,
2187 2188
};

A
Andreas Färber 已提交
2189
static void scsi_disk_register_types(void)
2190
{
2191 2192
    type_register_static(&scsi_hd_info);
    type_register_static(&scsi_cd_info);
2193
#ifdef __linux__
2194
    type_register_static(&scsi_block_info);
2195
#endif
2196
    type_register_static(&scsi_disk_info);
T
ths 已提交
2197
}
A
Andreas Färber 已提交
2198 2199

type_init(scsi_disk_register_types)