scsi-bus.c 40.5 KB
Newer Older
1
#include "hw.h"
2
#include "qemu-error.h"
G
Gerd Hoffmann 已提交
3
#include "scsi.h"
4
#include "scsi-defs.h"
5
#include "qdev.h"
B
Blue Swirl 已提交
6
#include "blockdev.h"
7
#include "trace.h"
8

9
static char *scsibus_get_fw_dev_path(DeviceState *dev);
10
static int scsi_req_parse(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf);
11
static void scsi_req_dequeue(SCSIRequest *req);
12

13 14 15
static struct BusInfo scsi_bus_info = {
    .name  = "SCSI",
    .size  = sizeof(SCSIBus),
16
    .get_fw_dev_path = scsibus_get_fw_dev_path,
17
    .props = (Property[]) {
P
Paolo Bonzini 已提交
18
        DEFINE_PROP_UINT32("channel", SCSIDevice, channel, 0),
19
        DEFINE_PROP_UINT32("scsi-id", SCSIDevice, id, -1),
P
Paolo Bonzini 已提交
20
        DEFINE_PROP_UINT32("lun", SCSIDevice, lun, -1),
21 22 23 24 25
        DEFINE_PROP_END_OF_LIST(),
    },
};
static int next_scsi_bus;

26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
static int scsi_device_init(SCSIDevice *s)
{
    SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
    if (sc->init) {
        return sc->init(s);
    }
    return 0;
}

static void scsi_device_destroy(SCSIDevice *s)
{
    SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
    if (sc->destroy) {
        sc->destroy(s);
    }
}

static SCSIRequest *scsi_device_alloc_req(SCSIDevice *s, uint32_t tag, uint32_t lun,
                                          uint8_t *buf, void *hba_private)
{
    SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
    if (sc->alloc_req) {
        return sc->alloc_req(s, tag, lun, buf, hba_private);
    }

    return NULL;
}

static void scsi_device_unit_attention_reported(SCSIDevice *s)
{
    SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
    if (sc->unit_attention_reported) {
        sc->unit_attention_reported(s);
    }
}

62
/* Create a scsi bus, and attach devices to it.  */
63
void scsi_bus_new(SCSIBus *bus, DeviceState *host, const SCSIBusInfo *info)
64
{
65
    qbus_create_inplace(&bus->qbus, &scsi_bus_info, host, NULL);
66
    bus->busnr = next_scsi_bus++;
67
    bus->info = info;
G
Gerd Hoffmann 已提交
68
    bus->qbus.allow_hotplug = 1;
69 70
}

71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
static void scsi_dma_restart_bh(void *opaque)
{
    SCSIDevice *s = opaque;
    SCSIRequest *req, *next;

    qemu_bh_delete(s->bh);
    s->bh = NULL;

    QTAILQ_FOREACH_SAFE(req, &s->requests, next, next) {
        scsi_req_ref(req);
        if (req->retry) {
            req->retry = false;
            switch (req->cmd.mode) {
            case SCSI_XFER_FROM_DEV:
            case SCSI_XFER_TO_DEV:
                scsi_req_continue(req);
                break;
            case SCSI_XFER_NONE:
                scsi_req_dequeue(req);
                scsi_req_enqueue(req);
                break;
            }
        }
        scsi_req_unref(req);
    }
}

void scsi_req_retry(SCSIRequest *req)
{
    /* No need to save a reference, because scsi_dma_restart_bh just
     * looks at the request list.  */
    req->retry = true;
}

static void scsi_dma_restart_cb(void *opaque, int running, RunState state)
{
    SCSIDevice *s = opaque;

    if (!running) {
        return;
    }
    if (!s->bh) {
        s->bh = qemu_bh_new(scsi_dma_restart_bh, s);
        qemu_bh_schedule(s->bh);
    }
}

A
Anthony Liguori 已提交
118
static int scsi_qdev_init(DeviceState *qdev)
119
{
120
    SCSIDevice *dev = SCSI_DEVICE(qdev);
121
    SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
P
Paolo Bonzini 已提交
122
    SCSIDevice *d;
G
Gerd Hoffmann 已提交
123
    int rc = -1;
124

P
Paolo Bonzini 已提交
125 126 127 128
    if (dev->channel > bus->info->max_channel) {
        error_report("bad scsi channel id: %d", dev->channel);
        goto err;
    }
P
Paolo Bonzini 已提交
129
    if (dev->id != -1 && dev->id > bus->info->max_target) {
130
        error_report("bad scsi device id: %d", dev->id);
131 132 133
        goto err;
    }

P
Paolo Bonzini 已提交
134 135 136 137 138 139
    if (dev->id == -1) {
        int id = -1;
        if (dev->lun == -1) {
            dev->lun = 0;
        }
        do {
P
Paolo Bonzini 已提交
140
            d = scsi_device_find(bus, dev->channel, ++id, dev->lun);
P
Paolo Bonzini 已提交
141 142 143 144 145 146 147 148 149
        } while (d && d->lun == dev->lun && id <= bus->info->max_target);
        if (id > bus->info->max_target) {
            error_report("no free target");
            goto err;
        }
        dev->id = id;
    } else if (dev->lun == -1) {
        int lun = -1;
        do {
P
Paolo Bonzini 已提交
150
            d = scsi_device_find(bus, dev->channel, dev->id, ++lun);
P
Paolo Bonzini 已提交
151 152 153 154 155 156 157
        } while (d && d->lun == lun && lun < bus->info->max_lun);
        if (lun > bus->info->max_lun) {
            error_report("no free lun");
            goto err;
        }
        dev->lun = lun;
    } else {
P
Paolo Bonzini 已提交
158
        d = scsi_device_find(bus, dev->channel, dev->id, dev->lun);
P
Paolo Bonzini 已提交
159 160 161
        if (dev->lun == d->lun && dev != d) {
            qdev_free(&d->qdev);
        }
162 163
    }

164
    QTAILQ_INIT(&dev->requests);
165
    rc = scsi_device_init(dev);
166 167 168 169
    if (rc == 0) {
        dev->vmsentry = qemu_add_vm_change_state_handler(scsi_dma_restart_cb,
                                                         dev);
    }
170 171

err:
G
Gerd Hoffmann 已提交
172 173 174 175 176
    return rc;
}

static int scsi_qdev_exit(DeviceState *qdev)
{
177
    SCSIDevice *dev = SCSI_DEVICE(qdev);
G
Gerd Hoffmann 已提交
178

179 180 181
    if (dev->vmsentry) {
        qemu_del_vm_change_state_handler(dev->vmsentry);
    }
182
    scsi_device_destroy(dev);
G
Gerd Hoffmann 已提交
183
    return 0;
184 185 186
}

/* handle legacy '-drive if=scsi,...' cmd line args */
187
SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockDriverState *bdrv,
188
                                      int unit, bool removable, int bootindex)
189 190 191 192
{
    const char *driver;
    DeviceState *dev;

193
    driver = bdrv_is_sg(bdrv) ? "scsi-generic" : "scsi-disk";
194 195
    dev = qdev_create(&bus->qbus, driver);
    qdev_prop_set_uint32(dev, "scsi-id", unit);
196 197 198
    if (bootindex >= 0) {
        qdev_prop_set_int32(dev, "bootindex", bootindex);
    }
199 200 201
    if (qdev_prop_exists(dev, "removable")) {
        qdev_prop_set_bit(dev, "removable", removable);
    }
202 203 204 205
    if (qdev_prop_set_drive(dev, "drive", bdrv) < 0) {
        qdev_free(dev);
        return NULL;
    }
206 207
    if (qdev_init(dev) < 0)
        return NULL;
208
    return SCSI_DEVICE(dev);
209 210
}

211
int scsi_bus_legacy_handle_cmdline(SCSIBus *bus)
212
{
213
    Location loc;
214
    DriveInfo *dinfo;
215
    int res = 0, unit;
216

217
    loc_push_none(&loc);
P
Paolo Bonzini 已提交
218
    for (unit = 0; unit < bus->info->max_target; unit++) {
219 220 221 222
        dinfo = drive_get(IF_SCSI, bus->busnr, unit);
        if (dinfo == NULL) {
            continue;
        }
223
        qemu_opts_loc_restore(dinfo->opts);
224
        if (!scsi_bus_legacy_add_drive(bus, dinfo->bdrv, unit, false, -1)) {
225 226 227
            res = -1;
            break;
        }
228
    }
229
    loc_pop(&loc);
230
    return res;
231
}
232

233 234 235 236 237 238 239 240 241
/* SCSIReqOps implementation for invalid commands.  */

static int32_t scsi_invalid_command(SCSIRequest *req, uint8_t *buf)
{
    scsi_req_build_sense(req, SENSE_CODE(INVALID_OPCODE));
    scsi_req_complete(req, CHECK_CONDITION);
    return 0;
}

P
Paolo Bonzini 已提交
242
static const struct SCSIReqOps reqops_invalid_opcode = {
243 244 245 246
    .size         = sizeof(SCSIRequest),
    .send_command = scsi_invalid_command
};

247 248 249 250 251 252 253 254 255 256 257 258 259
/* SCSIReqOps implementation for unit attention conditions.  */

static int32_t scsi_unit_attention(SCSIRequest *req, uint8_t *buf)
{
    if (req->dev && req->dev->unit_attention.key == UNIT_ATTENTION) {
        scsi_req_build_sense(req, req->dev->unit_attention);
    } else if (req->bus->unit_attention.key == UNIT_ATTENTION) {
        scsi_req_build_sense(req, req->bus->unit_attention);
    }
    scsi_req_complete(req, CHECK_CONDITION);
    return 0;
}

P
Paolo Bonzini 已提交
260
static const struct SCSIReqOps reqops_unit_attention = {
261 262 263 264
    .size         = sizeof(SCSIRequest),
    .send_command = scsi_unit_attention
};

265 266 267 268 269 270 271 272
/* SCSIReqOps implementation for REPORT LUNS and for commands sent to
   an invalid LUN.  */

typedef struct SCSITargetReq SCSITargetReq;

struct SCSITargetReq {
    SCSIRequest req;
    int len;
273
    uint8_t buf[2056];
274 275 276 277 278 279 280 281 282 283 284 285 286 287
};

static void store_lun(uint8_t *outbuf, int lun)
{
    if (lun < 256) {
        outbuf[1] = lun;
        return;
    }
    outbuf[1] = (lun & 255);
    outbuf[0] = (lun >> 8) | 0x40;
}

static bool scsi_target_emulate_report_luns(SCSITargetReq *r)
{
288 289
    DeviceState *qdev;
    int i, len, n;
P
Paolo Bonzini 已提交
290
    int channel, id;
291 292
    bool found_lun0;

293 294 295 296 297 298
    if (r->req.cmd.xfer < 16) {
        return false;
    }
    if (r->req.cmd.buf[2] > 2) {
        return false;
    }
P
Paolo Bonzini 已提交
299
    channel = r->req.dev->channel;
300 301 302 303
    id = r->req.dev->id;
    found_lun0 = false;
    n = 0;
    QTAILQ_FOREACH(qdev, &r->req.bus->qbus.children, sibling) {
304
        SCSIDevice *dev = SCSI_DEVICE(qdev);
305

P
Paolo Bonzini 已提交
306
        if (dev->channel == channel && dev->id == id) {
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
            if (dev->lun == 0) {
                found_lun0 = true;
            }
            n += 8;
        }
    }
    if (!found_lun0) {
        n += 8;
    }
    len = MIN(n + 8, r->req.cmd.xfer & ~7);
    if (len > sizeof(r->buf)) {
        /* TODO: > 256 LUNs? */
        return false;
    }

322
    memset(r->buf, 0, len);
323 324 325
    stl_be_p(&r->buf, n);
    i = found_lun0 ? 8 : 16;
    QTAILQ_FOREACH(qdev, &r->req.bus->qbus.children, sibling) {
326
        SCSIDevice *dev = SCSI_DEVICE(qdev);
327

P
Paolo Bonzini 已提交
328
        if (dev->channel == channel && dev->id == id) {
329 330 331
            store_lun(&r->buf[i], dev->lun);
            i += 8;
        }
332
    }
333 334
    assert(i == n + 8);
    r->len = len;
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
    return true;
}

static bool scsi_target_emulate_inquiry(SCSITargetReq *r)
{
    assert(r->req.dev->lun != r->req.lun);
    if (r->req.cmd.buf[1] & 0x2) {
        /* Command support data - optional, not implemented */
        return false;
    }

    if (r->req.cmd.buf[1] & 0x1) {
        /* Vital product data */
        uint8_t page_code = r->req.cmd.buf[2];
        if (r->req.cmd.xfer < 4) {
            return false;
        }

        r->buf[r->len++] = page_code ; /* this page */
        r->buf[r->len++] = 0x00;

        switch (page_code) {
        case 0x00: /* Supported page codes, mandatory */
        {
            int pages;
            pages = r->len++;
            r->buf[r->len++] = 0x00; /* list of supported pages (this page) */
            r->buf[pages] = r->len - pages - 1; /* number of pages */
            break;
        }
        default:
            return false;
        }
        /* done with EVPD */
        assert(r->len < sizeof(r->buf));
        r->len = MIN(r->req.cmd.xfer, r->len);
        return true;
    }

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

    /* PAGE CODE == 0 */
    if (r->req.cmd.xfer < 5) {
        return -1;
    }

    r->len = MIN(r->req.cmd.xfer, 36);
    memset(r->buf, 0, r->len);
    if (r->req.lun != 0) {
        r->buf[0] = TYPE_NO_LUN;
    } else {
        r->buf[0] = TYPE_NOT_PRESENT | TYPE_INACTIVE;
        r->buf[2] = 5; /* Version */
        r->buf[3] = 2 | 0x10; /* HiSup, response data format */
        r->buf[4] = r->len - 5; /* Additional Length = (Len - 1) - 4 */
393
        r->buf[7] = 0x10 | (r->req.bus->info->tcq ? 0x02 : 0); /* Sync, TCQ.  */
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
        memcpy(&r->buf[8], "QEMU    ", 8);
        memcpy(&r->buf[16], "QEMU TARGET     ", 16);
        strncpy((char *) &r->buf[32], QEMU_VERSION, 4);
    }
    return true;
}

static int32_t scsi_target_send_command(SCSIRequest *req, uint8_t *buf)
{
    SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);

    switch (buf[0]) {
    case REPORT_LUNS:
        if (!scsi_target_emulate_report_luns(r)) {
            goto illegal_request;
        }
        break;
    case INQUIRY:
        if (!scsi_target_emulate_inquiry(r)) {
            goto illegal_request;
        }
        break;
416 417 418 419
    case REQUEST_SENSE:
        if (req->cmd.xfer < 4) {
            goto illegal_request;
        }
420 421
        r->len = scsi_device_get_sense(r->req.dev, r->buf,
                                       MIN(req->cmd.xfer, sizeof r->buf),
422
                                       (req->cmd.buf[1] & 1) == 0);
423
        if (r->req.dev->sense_is_ua) {
424
            scsi_device_unit_attention_reported(req->dev);
425 426 427
            r->req.dev->sense_len = 0;
            r->req.dev->sense_is_ua = false;
        }
428
        break;
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
    default:
        scsi_req_build_sense(req, SENSE_CODE(LUN_NOT_SUPPORTED));
        scsi_req_complete(req, CHECK_CONDITION);
        return 0;
    illegal_request:
        scsi_req_build_sense(req, SENSE_CODE(INVALID_FIELD));
        scsi_req_complete(req, CHECK_CONDITION);
        return 0;
    }

    if (!r->len) {
        scsi_req_complete(req, GOOD);
    }
    return r->len;
}

static void scsi_target_read_data(SCSIRequest *req)
{
    SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
    uint32_t n;

    n = r->len;
    if (n > 0) {
        r->len = 0;
        scsi_req_data(&r->req, n);
    } else {
        scsi_req_complete(&r->req, GOOD);
    }
}

static uint8_t *scsi_target_get_buf(SCSIRequest *req)
{
    SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);

    return r->buf;
}

P
Paolo Bonzini 已提交
466
static const struct SCSIReqOps reqops_target_command = {
467 468 469 470 471 472 473
    .size         = sizeof(SCSITargetReq),
    .send_command = scsi_target_send_command,
    .read_data    = scsi_target_read_data,
    .get_buf      = scsi_target_get_buf,
};


P
Paolo Bonzini 已提交
474 475
SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d,
                            uint32_t tag, uint32_t lun, void *hba_private)
476 477 478
{
    SCSIRequest *req;

479
    req = g_malloc0(reqops->size);
480
    req->refcount = 1;
481 482 483 484
    req->bus = scsi_bus_from_device(d);
    req->dev = d;
    req->tag = tag;
    req->lun = lun;
485
    req->hba_private = hba_private;
G
Gerd Hoffmann 已提交
486
    req->status = -1;
487
    req->sense_len = 0;
P
Paolo Bonzini 已提交
488
    req->ops = reqops;
489
    trace_scsi_req_alloc(req->dev->id, req->lun, req->tag);
490 491 492
    return req;
}

493
SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun,
494
                          uint8_t *buf, void *hba_private)
P
Paolo Bonzini 已提交
495
{
496
    SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
497
    SCSIRequest *req;
498 499 500 501 502 503 504 505
    SCSICommand cmd;

    if (scsi_req_parse(&cmd, d, buf) != 0) {
        trace_scsi_req_parse_bad(d->id, lun, tag, buf[0]);
        req = scsi_req_alloc(&reqops_invalid_opcode, d, tag, lun, hba_private);
    } else {
        trace_scsi_req_parsed(d->id, lun, tag, buf[0],
                              cmd.mode, cmd.xfer);
506
        if (cmd.lba != -1) {
507 508 509
            trace_scsi_req_parsed_lba(d->id, lun, tag, buf[0],
                                      cmd.lba);
        }
510

511 512 513 514 515
        if ((d->unit_attention.key == UNIT_ATTENTION ||
             bus->unit_attention.key == UNIT_ATTENTION) &&
            (buf[0] != INQUIRY &&
             buf[0] != REPORT_LUNS &&
             buf[0] != GET_CONFIGURATION &&
516 517 518 519 520 521 522
             buf[0] != GET_EVENT_STATUS_NOTIFICATION &&

             /*
              * If we already have a pending unit attention condition,
              * report this one before triggering another one.
              */
             !(buf[0] == REQUEST_SENSE && d->sense_is_ua))) {
523 524 525
            req = scsi_req_alloc(&reqops_unit_attention, d, tag, lun,
                                 hba_private);
        } else if (lun != d->lun ||
526
            buf[0] == REPORT_LUNS ||
527
            (buf[0] == REQUEST_SENSE && (d->sense_len || cmd.xfer < 4))) {
528 529 530
            req = scsi_req_alloc(&reqops_target_command, d, tag, lun,
                                 hba_private);
        } else {
531
            req = scsi_device_alloc_req(d, tag, lun, buf, hba_private);
532
        }
533 534 535
    }

    req->cmd = cmd;
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552
    switch (buf[0]) {
    case INQUIRY:
        trace_scsi_inquiry(d->id, lun, tag, cmd.buf[1], cmd.buf[2]);
        break;
    case TEST_UNIT_READY:
        trace_scsi_test_unit_ready(d->id, lun, tag);
        break;
    case REPORT_LUNS:
        trace_scsi_report_luns(d->id, lun, tag);
        break;
    case REQUEST_SENSE:
        trace_scsi_request_sense(d->id, lun, tag);
        break;
    default:
        break;
    }

553
    return req;
P
Paolo Bonzini 已提交
554 555
}

P
Paolo Bonzini 已提交
556 557
uint8_t *scsi_req_get_buf(SCSIRequest *req)
{
558
    return req->ops->get_buf(req);
P
Paolo Bonzini 已提交
559 560
}

561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
static void scsi_clear_unit_attention(SCSIRequest *req)
{
    SCSISense *ua;
    if (req->dev->unit_attention.key != UNIT_ATTENTION &&
        req->bus->unit_attention.key != UNIT_ATTENTION) {
        return;
    }

    /*
     * If an INQUIRY command enters the enabled command state,
     * the device server shall [not] clear any unit attention condition;
     * See also MMC-6, paragraphs 6.5 and 6.6.2.
     */
    if (req->cmd.buf[0] == INQUIRY ||
        req->cmd.buf[0] == GET_CONFIGURATION ||
        req->cmd.buf[0] == GET_EVENT_STATUS_NOTIFICATION) {
        return;
    }

    if (req->dev->unit_attention.key == UNIT_ATTENTION) {
        ua = &req->dev->unit_attention;
    } else {
        ua = &req->bus->unit_attention;
    }

    /*
     * If a REPORT LUNS command enters the enabled command state, [...]
     * the device server shall clear any pending unit attention condition
     * with an additional sense code of REPORTED LUNS DATA HAS CHANGED.
     */
    if (req->cmd.buf[0] == REPORT_LUNS &&
        !(ua->asc == SENSE_CODE(REPORTED_LUNS_CHANGED).asc &&
          ua->ascq == SENSE_CODE(REPORTED_LUNS_CHANGED).ascq)) {
        return;
    }

    *ua = SENSE_CODE(NO_SENSE);
}

600 601
int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len)
{
602 603
    int ret;

604 605
    assert(len >= 14);
    if (!req->sense_len) {
606 607
        return 0;
    }
608 609 610 611 612 613 614 615 616 617

    ret = scsi_build_sense(req->sense, req->sense_len, buf, len, true);

    /*
     * FIXME: clearing unit attention conditions upon autosense should be done
     * only if the UA_INTLCK_CTRL field in the Control mode page is set to 00b
     * (SAM-5, 5.14).
     *
     * We assume UA_INTLCK_CTRL to be 00b for HBAs that support autosense, and
     * 10b for HBAs that do not support it (do not call scsi_req_get_sense).
618
     * Here we handle unit attention clearing for UA_INTLCK_CTRL == 00b.
619
     */
620
    if (req->dev->sense_is_ua) {
621
        scsi_device_unit_attention_reported(req->dev);
622 623 624
        req->dev->sense_len = 0;
        req->dev->sense_is_ua = false;
    }
625
    return ret;
626 627 628 629 630 631 632 633 634 635 636 637 638 639
}

int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed)
{
    return scsi_build_sense(dev->sense, dev->sense_len, buf, len, fixed);
}

void scsi_req_build_sense(SCSIRequest *req, SCSISense sense)
{
    trace_scsi_req_build_sense(req->dev->id, req->lun, req->tag,
                               sense.key, sense.asc, sense.ascq);
    memset(req->sense, 0, 18);
    req->sense[0] = 0xf0;
    req->sense[2] = sense.key;
640
    req->sense[7] = 10;
641 642 643
    req->sense[12] = sense.asc;
    req->sense[13] = sense.ascq;
    req->sense_len = 18;
644 645
}

646
int32_t scsi_req_enqueue(SCSIRequest *req)
647
{
648 649
    int32_t rc;

650 651 652 653
    assert(!req->enqueued);
    scsi_req_ref(req);
    req->enqueued = true;
    QTAILQ_INSERT_TAIL(&req->dev->requests, req, next);
654 655

    scsi_req_ref(req);
656
    rc = req->ops->send_command(req, req->cmd.buf);
657 658
    scsi_req_unref(req);
    return rc;
659 660
}

661
static void scsi_req_dequeue(SCSIRequest *req)
662
{
663
    trace_scsi_req_dequeue(req->dev->id, req->lun, req->tag);
664
    req->retry = false;
665 666 667
    if (req->enqueued) {
        QTAILQ_REMOVE(&req->dev->requests, req, next);
        req->enqueued = false;
P
Paolo Bonzini 已提交
668
        scsi_req_unref(req);
669 670 671
    }
}

672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
static int scsi_get_performance_length(int num_desc, int type, int data_type)
{
    /* MMC-6, paragraph 6.7.  */
    switch (type) {
    case 0:
        if ((data_type & 3) == 0) {
            /* Each descriptor is as in Table 295 - Nominal performance.  */
            return 16 * num_desc + 8;
        } else {
            /* Each descriptor is as in Table 296 - Exceptions.  */
            return 6 * num_desc + 8;
        }
    case 1:
    case 4:
    case 5:
        return 8 * num_desc + 8;
    case 2:
        return 2048 * num_desc + 8;
    case 3:
        return 16 * num_desc + 8;
    default:
        return 8;
    }
}

P
Paolo Bonzini 已提交
697
static int scsi_req_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
698
{
P
Paolo Bonzini 已提交
699
    switch (buf[0] >> 5) {
700
    case 0:
P
Paolo Bonzini 已提交
701 702
        cmd->xfer = buf[4];
        cmd->len = 6;
703
        /* length 0 means 256 blocks */
P
Paolo Bonzini 已提交
704 705 706
        if (cmd->xfer == 0) {
            cmd->xfer = 256;
        }
707 708 709
        break;
    case 1:
    case 2:
710
        cmd->xfer = lduw_be_p(&buf[7]);
P
Paolo Bonzini 已提交
711
        cmd->len = 10;
712 713
        break;
    case 4:
714
        cmd->xfer = ldl_be_p(&buf[10]) & 0xffffffffULL;
P
Paolo Bonzini 已提交
715
        cmd->len = 16;
716 717
        break;
    case 5:
718
        cmd->xfer = ldl_be_p(&buf[6]) & 0xffffffffULL;
P
Paolo Bonzini 已提交
719
        cmd->len = 12;
720 721 722 723 724
        break;
    default:
        return -1;
    }

P
Paolo Bonzini 已提交
725
    switch (buf[0]) {
726
    case TEST_UNIT_READY:
727
    case REWIND:
728
    case START_STOP:
P
Paolo Bonzini 已提交
729
    case SET_CAPACITY:
730
    case WRITE_FILEMARKS:
731
    case WRITE_FILEMARKS_16:
732
    case SPACE:
733 734
    case RESERVE:
    case RELEASE:
735 736
    case ERASE:
    case ALLOW_MEDIUM_REMOVAL:
737
    case VERIFY_10:
738 739
    case SEEK_10:
    case SYNCHRONIZE_CACHE:
740 741
    case SYNCHRONIZE_CACHE_16:
    case LOCATE_16:
742 743 744 745
    case LOCK_UNLOCK_CACHE:
    case LOAD_UNLOAD:
    case SET_CD_SPEED:
    case SET_LIMITS:
746
    case WRITE_LONG_10:
747 748
    case MOVE_MEDIUM:
    case UPDATE_BLOCK:
749 750 751 752 753
    case RESERVE_TRACK:
    case SET_READ_AHEAD:
    case PRE_FETCH:
    case PRE_FETCH_16:
    case ALLOW_OVERWRITE:
P
Paolo Bonzini 已提交
754
        cmd->xfer = 0;
755 756 757
        break;
    case MODE_SENSE:
        break;
758
    case WRITE_SAME_10:
P
Paolo Bonzini 已提交
759
        cmd->xfer = 1;
760
        break;
761
    case READ_CAPACITY_10:
P
Paolo Bonzini 已提交
762
        cmd->xfer = 8;
763 764
        break;
    case READ_BLOCK_LIMITS:
P
Paolo Bonzini 已提交
765
        cmd->xfer = 6;
766 767
        break;
    case SEND_VOLUME_TAG:
768 769 770 771 772 773
        /* GPCMD_SET_STREAMING from multimedia commands.  */
        if (dev->type == TYPE_ROM) {
            cmd->xfer = buf[10] | (buf[9] << 8);
        } else {
            cmd->xfer = buf[9] | (buf[8] << 8);
        }
774 775
        break;
    case WRITE_10:
776
    case WRITE_VERIFY_10:
777 778 779
    case WRITE_6:
    case WRITE_12:
    case WRITE_VERIFY_12:
G
Gerd Hoffmann 已提交
780 781
    case WRITE_16:
    case WRITE_VERIFY_16:
P
Paolo Bonzini 已提交
782
        cmd->xfer *= dev->blocksize;
783 784 785 786 787 788
        break;
    case READ_10:
    case READ_6:
    case READ_REVERSE:
    case RECOVER_BUFFERED_DATA:
    case READ_12:
G
Gerd Hoffmann 已提交
789
    case READ_16:
P
Paolo Bonzini 已提交
790
        cmd->xfer *= dev->blocksize;
791
        break;
792 793 794 795 796 797 798 799 800
    case FORMAT_UNIT:
        /* MMC mandates the parameter list to be 12-bytes long.  Parameters
         * for block devices are restricted to the header right now.  */
        if (dev->type == TYPE_ROM && (buf[1] & 16)) {
            cmd->xfer = 12;
        } else {
            cmd->xfer = (buf[1] & 16) == 0 ? 0 : (buf[1] & 32 ? 8 : 4);
        }
        break;
801
    case INQUIRY:
802 803
    case RECEIVE_DIAGNOSTIC:
    case SEND_DIAGNOSTIC:
P
Paolo Bonzini 已提交
804
        cmd->xfer = buf[4] | (buf[3] << 8);
805
        break;
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
    case READ_CD:
    case READ_BUFFER:
    case WRITE_BUFFER:
    case SEND_CUE_SHEET:
        cmd->xfer = buf[8] | (buf[7] << 8) | (buf[6] << 16);
        break;
    case PERSISTENT_RESERVE_OUT:
        cmd->xfer = ldl_be_p(&buf[5]) & 0xffffffffULL;
        break;
    case ERASE_12:
        if (dev->type == TYPE_ROM) {
            /* MMC command GET PERFORMANCE.  */
            cmd->xfer = scsi_get_performance_length(buf[9] | (buf[8] << 8),
                                                    buf[10], buf[1] & 0x1f);
        }
        break;
    case MECHANISM_STATUS:
    case READ_DVD_STRUCTURE:
    case SEND_DVD_STRUCTURE:
825 826
    case MAINTENANCE_OUT:
    case MAINTENANCE_IN:
P
Paolo Bonzini 已提交
827
        if (dev->type == TYPE_ROM) {
828
            /* GPCMD_REPORT_KEY and GPCMD_SEND_KEY from multi media commands */
P
Paolo Bonzini 已提交
829
            cmd->xfer = buf[9] | (buf[8] << 8);
830 831
        }
        break;
832 833 834 835
    }
    return 0;
}

P
Paolo Bonzini 已提交
836
static int scsi_req_stream_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
837
{
P
Paolo Bonzini 已提交
838
    switch (buf[0]) {
839
    /* stream commands */
840 841 842 843
    case ERASE_12:
    case ERASE_16:
        cmd->xfer = 0;
        break;
844 845 846 847
    case READ_6:
    case READ_REVERSE:
    case RECOVER_BUFFERED_DATA:
    case WRITE_6:
P
Paolo Bonzini 已提交
848 849 850 851 852
        cmd->len = 6;
        cmd->xfer = buf[4] | (buf[3] << 8) | (buf[2] << 16);
        if (buf[1] & 0x01) { /* fixed */
            cmd->xfer *= dev->blocksize;
        }
853 854 855
        break;
    case REWIND:
    case START_STOP:
P
Paolo Bonzini 已提交
856 857
        cmd->len = 6;
        cmd->xfer = 0;
858
        break;
859 860 861 862 863 864 865 866 867
    case SPACE_16:
        cmd->xfer = buf[13] | (buf[12] << 8);
        break;
    case READ_POSITION:
        cmd->xfer = buf[8] | (buf[7] << 8);
        break;
    case FORMAT_UNIT:
        cmd->xfer = buf[4] | (buf[3] << 8);
        break;
868 869
    /* generic commands */
    default:
P
Paolo Bonzini 已提交
870
        return scsi_req_length(cmd, dev, buf);
871 872 873 874
    }
    return 0;
}

P
Paolo Bonzini 已提交
875
static void scsi_cmd_xfer_mode(SCSICommand *cmd)
G
Gerd Hoffmann 已提交
876
{
P
Paolo Bonzini 已提交
877
    switch (cmd->buf[0]) {
G
Gerd Hoffmann 已提交
878 879
    case WRITE_6:
    case WRITE_10:
880
    case WRITE_VERIFY_10:
G
Gerd Hoffmann 已提交
881 882
    case WRITE_12:
    case WRITE_VERIFY_12:
G
Gerd Hoffmann 已提交
883 884
    case WRITE_16:
    case WRITE_VERIFY_16:
G
Gerd Hoffmann 已提交
885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
    case COPY:
    case COPY_VERIFY:
    case COMPARE:
    case CHANGE_DEFINITION:
    case LOG_SELECT:
    case MODE_SELECT:
    case MODE_SELECT_10:
    case SEND_DIAGNOSTIC:
    case WRITE_BUFFER:
    case FORMAT_UNIT:
    case REASSIGN_BLOCKS:
    case SEARCH_EQUAL:
    case SEARCH_HIGH:
    case SEARCH_LOW:
    case UPDATE_BLOCK:
900 901
    case WRITE_LONG_10:
    case WRITE_SAME_10:
G
Gerd Hoffmann 已提交
902 903 904 905 906
    case SEARCH_HIGH_12:
    case SEARCH_EQUAL_12:
    case SEARCH_LOW_12:
    case MEDIUM_SCAN:
    case SEND_VOLUME_TAG:
907 908
    case SEND_CUE_SHEET:
    case SEND_DVD_STRUCTURE:
909
    case PERSISTENT_RESERVE_OUT:
910
    case MAINTENANCE_OUT:
P
Paolo Bonzini 已提交
911
        cmd->mode = SCSI_XFER_TO_DEV;
G
Gerd Hoffmann 已提交
912 913
        break;
    default:
P
Paolo Bonzini 已提交
914 915
        if (cmd->xfer)
            cmd->mode = SCSI_XFER_FROM_DEV;
G
Gerd Hoffmann 已提交
916
        else {
P
Paolo Bonzini 已提交
917
            cmd->mode = SCSI_XFER_NONE;
G
Gerd Hoffmann 已提交
918 919 920 921 922
        }
        break;
    }
}

P
Paolo Bonzini 已提交
923
static uint64_t scsi_cmd_lba(SCSICommand *cmd)
924
{
P
Paolo Bonzini 已提交
925
    uint8_t *buf = cmd->buf;
926 927 928 929
    uint64_t lba;

    switch (buf[0] >> 5) {
    case 0:
930
        lba = ldl_be_p(&buf[0]) & 0x1fffff;
931 932 933
        break;
    case 1:
    case 2:
934
    case 5:
935
        lba = ldl_be_p(&buf[2]) & 0xffffffffULL;
936 937
        break;
    case 4:
938
        lba = ldq_be_p(&buf[2]);
939 940 941 942 943 944 945 946
        break;
    default:
        lba = -1;

    }
    return lba;
}

947
int scsi_req_parse(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
948 949 950
{
    int rc;

951 952
    if (dev->type == TYPE_TAPE) {
        rc = scsi_req_stream_length(cmd, dev, buf);
953
    } else {
954
        rc = scsi_req_length(cmd, dev, buf);
955 956 957 958
    }
    if (rc != 0)
        return rc;

959 960 961
    memcpy(cmd->buf, buf, cmd->len);
    scsi_cmd_xfer_mode(cmd);
    cmd->lba = scsi_cmd_lba(cmd);
962 963
    return 0;
}
G
Gerd Hoffmann 已提交
964

965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
/*
 * Predefined sense codes
 */

/* No sense data available */
const struct SCSISense sense_code_NO_SENSE = {
    .key = NO_SENSE , .asc = 0x00 , .ascq = 0x00
};

/* LUN not ready, Manual intervention required */
const struct SCSISense sense_code_LUN_NOT_READY = {
    .key = NOT_READY, .asc = 0x04, .ascq = 0x03
};

/* LUN not ready, Medium not present */
const struct SCSISense sense_code_NO_MEDIUM = {
    .key = NOT_READY, .asc = 0x3a, .ascq = 0x00
};

984 985 986 987 988
/* LUN not ready, medium removal prevented */
const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED = {
    .key = NOT_READY, .asc = 0x53, .ascq = 0x00
};

989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
/* Hardware error, internal target failure */
const struct SCSISense sense_code_TARGET_FAILURE = {
    .key = HARDWARE_ERROR, .asc = 0x44, .ascq = 0x00
};

/* Illegal request, invalid command operation code */
const struct SCSISense sense_code_INVALID_OPCODE = {
    .key = ILLEGAL_REQUEST, .asc = 0x20, .ascq = 0x00
};

/* Illegal request, LBA out of range */
const struct SCSISense sense_code_LBA_OUT_OF_RANGE = {
    .key = ILLEGAL_REQUEST, .asc = 0x21, .ascq = 0x00
};

/* Illegal request, Invalid field in CDB */
const struct SCSISense sense_code_INVALID_FIELD = {
    .key = ILLEGAL_REQUEST, .asc = 0x24, .ascq = 0x00
};

/* Illegal request, LUN not supported */
const struct SCSISense sense_code_LUN_NOT_SUPPORTED = {
    .key = ILLEGAL_REQUEST, .asc = 0x25, .ascq = 0x00
};

1014 1015 1016 1017 1018 1019
/* Illegal request, Saving parameters not supported */
const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED = {
    .key = ILLEGAL_REQUEST, .asc = 0x39, .ascq = 0x00
};

/* Illegal request, Incompatible medium installed */
1020
const struct SCSISense sense_code_INCOMPATIBLE_FORMAT = {
1021 1022 1023
    .key = ILLEGAL_REQUEST, .asc = 0x30, .ascq = 0x00
};

1024 1025 1026 1027 1028
/* Illegal request, medium removal prevented */
const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED = {
    .key = ILLEGAL_REQUEST, .asc = 0x53, .ascq = 0x00
};

1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
/* Command aborted, I/O process terminated */
const struct SCSISense sense_code_IO_ERROR = {
    .key = ABORTED_COMMAND, .asc = 0x00, .ascq = 0x06
};

/* Command aborted, I_T Nexus loss occurred */
const struct SCSISense sense_code_I_T_NEXUS_LOSS = {
    .key = ABORTED_COMMAND, .asc = 0x29, .ascq = 0x07
};

/* Command aborted, Logical Unit failure */
const struct SCSISense sense_code_LUN_FAILURE = {
    .key = ABORTED_COMMAND, .asc = 0x3e, .ascq = 0x01
};

1044 1045 1046 1047 1048
/* Unit attention, Power on, reset or bus device reset occurred */
const struct SCSISense sense_code_RESET = {
    .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x00
};

1049 1050 1051 1052 1053
/* Unit attention, No medium */
const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM = {
    .key = UNIT_ATTENTION, .asc = 0x3a, .ascq = 0x00
};

1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
/* Unit attention, Medium may have changed */
const struct SCSISense sense_code_MEDIUM_CHANGED = {
    .key = UNIT_ATTENTION, .asc = 0x28, .ascq = 0x00
};

/* Unit attention, Reported LUNs data has changed */
const struct SCSISense sense_code_REPORTED_LUNS_CHANGED = {
    .key = UNIT_ATTENTION, .asc = 0x3f, .ascq = 0x0e
};

/* Unit attention, Device internal reset */
const struct SCSISense sense_code_DEVICE_INTERNAL_RESET = {
    .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x04
};

1069 1070 1071
/*
 * scsi_build_sense
 *
1072
 * Convert between fixed and descriptor sense buffers
1073
 */
1074 1075
int scsi_build_sense(uint8_t *in_buf, int in_len,
                     uint8_t *buf, int len, bool fixed)
1076
{
1077 1078
    bool fixed_in;
    SCSISense sense;
1079 1080 1081 1082
    if (!fixed && len < 8) {
        return 0;
    }

1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
    if (in_len == 0) {
        sense.key = NO_SENSE;
        sense.asc = 0;
        sense.ascq = 0;
    } else {
        fixed_in = (in_buf[0] & 2) == 0;

        if (fixed == fixed_in) {
            memcpy(buf, in_buf, MIN(len, in_len));
            return MIN(len, in_len);
        }

        if (fixed_in) {
            sense.key = in_buf[2];
            sense.asc = in_buf[12];
            sense.ascq = in_buf[13];
        } else {
            sense.key = in_buf[1];
            sense.asc = in_buf[2];
            sense.ascq = in_buf[3];
        }
    }

1106 1107 1108 1109 1110
    memset(buf, 0, len);
    if (fixed) {
        /* Return fixed format sense buffer */
        buf[0] = 0xf0;
        buf[2] = sense.key;
1111
        buf[7] = 10;
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
        buf[12] = sense.asc;
        buf[13] = sense.ascq;
        return MIN(len, 18);
    } else {
        /* Return descriptor format sense buffer */
        buf[0] = 0x72;
        buf[1] = sense.key;
        buf[2] = sense.asc;
        buf[3] = sense.ascq;
        return 8;
    }
}

G
Gerd Hoffmann 已提交
1125 1126 1127 1128
static const char *scsi_command_name(uint8_t cmd)
{
    static const char *names[] = {
        [ TEST_UNIT_READY          ] = "TEST_UNIT_READY",
1129
        [ REWIND                   ] = "REWIND",
G
Gerd Hoffmann 已提交
1130 1131 1132 1133 1134 1135
        [ REQUEST_SENSE            ] = "REQUEST_SENSE",
        [ FORMAT_UNIT              ] = "FORMAT_UNIT",
        [ READ_BLOCK_LIMITS        ] = "READ_BLOCK_LIMITS",
        [ REASSIGN_BLOCKS          ] = "REASSIGN_BLOCKS",
        [ READ_6                   ] = "READ_6",
        [ WRITE_6                  ] = "WRITE_6",
P
Paolo Bonzini 已提交
1136
        [ SET_CAPACITY             ] = "SET_CAPACITY",
G
Gerd Hoffmann 已提交
1137 1138 1139 1140 1141
        [ READ_REVERSE             ] = "READ_REVERSE",
        [ WRITE_FILEMARKS          ] = "WRITE_FILEMARKS",
        [ SPACE                    ] = "SPACE",
        [ INQUIRY                  ] = "INQUIRY",
        [ RECOVER_BUFFERED_DATA    ] = "RECOVER_BUFFERED_DATA",
1142 1143
        [ MAINTENANCE_IN           ] = "MAINTENANCE_IN",
        [ MAINTENANCE_OUT          ] = "MAINTENANCE_OUT",
G
Gerd Hoffmann 已提交
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
        [ MODE_SELECT              ] = "MODE_SELECT",
        [ RESERVE                  ] = "RESERVE",
        [ RELEASE                  ] = "RELEASE",
        [ COPY                     ] = "COPY",
        [ ERASE                    ] = "ERASE",
        [ MODE_SENSE               ] = "MODE_SENSE",
        [ START_STOP               ] = "START_STOP",
        [ RECEIVE_DIAGNOSTIC       ] = "RECEIVE_DIAGNOSTIC",
        [ SEND_DIAGNOSTIC          ] = "SEND_DIAGNOSTIC",
        [ ALLOW_MEDIUM_REMOVAL     ] = "ALLOW_MEDIUM_REMOVAL",
1154
        [ READ_CAPACITY_10         ] = "READ_CAPACITY_10",
G
Gerd Hoffmann 已提交
1155 1156 1157
        [ READ_10                  ] = "READ_10",
        [ WRITE_10                 ] = "WRITE_10",
        [ SEEK_10                  ] = "SEEK_10",
1158 1159
        [ WRITE_VERIFY_10          ] = "WRITE_VERIFY_10",
        [ VERIFY_10                ] = "VERIFY_10",
G
Gerd Hoffmann 已提交
1160 1161 1162 1163
        [ SEARCH_HIGH              ] = "SEARCH_HIGH",
        [ SEARCH_EQUAL             ] = "SEARCH_EQUAL",
        [ SEARCH_LOW               ] = "SEARCH_LOW",
        [ SET_LIMITS               ] = "SET_LIMITS",
P
Paolo Bonzini 已提交
1164
        [ PRE_FETCH                ] = "PRE_FETCH/READ_POSITION",
1165
        /* READ_POSITION and PRE_FETCH use the same operation code */
G
Gerd Hoffmann 已提交
1166 1167 1168 1169 1170 1171 1172 1173 1174
        [ SYNCHRONIZE_CACHE        ] = "SYNCHRONIZE_CACHE",
        [ LOCK_UNLOCK_CACHE        ] = "LOCK_UNLOCK_CACHE",
        [ READ_DEFECT_DATA         ] = "READ_DEFECT_DATA",
        [ MEDIUM_SCAN              ] = "MEDIUM_SCAN",
        [ COMPARE                  ] = "COMPARE",
        [ COPY_VERIFY              ] = "COPY_VERIFY",
        [ WRITE_BUFFER             ] = "WRITE_BUFFER",
        [ READ_BUFFER              ] = "READ_BUFFER",
        [ UPDATE_BLOCK             ] = "UPDATE_BLOCK",
1175 1176
        [ READ_LONG_10             ] = "READ_LONG_10",
        [ WRITE_LONG_10            ] = "WRITE_LONG_10",
G
Gerd Hoffmann 已提交
1177
        [ CHANGE_DEFINITION        ] = "CHANGE_DEFINITION",
1178 1179
        [ WRITE_SAME_10            ] = "WRITE_SAME_10",
        [ UNMAP                    ] = "UNMAP",
G
Gerd Hoffmann 已提交
1180
        [ READ_TOC                 ] = "READ_TOC",
1181 1182
        [ REPORT_DENSITY_SUPPORT   ] = "REPORT_DENSITY_SUPPORT",
        [ GET_CONFIGURATION        ] = "GET_CONFIGURATION",
G
Gerd Hoffmann 已提交
1183 1184 1185 1186 1187 1188 1189 1190
        [ LOG_SELECT               ] = "LOG_SELECT",
        [ LOG_SENSE                ] = "LOG_SENSE",
        [ MODE_SELECT_10           ] = "MODE_SELECT_10",
        [ RESERVE_10               ] = "RESERVE_10",
        [ RELEASE_10               ] = "RELEASE_10",
        [ MODE_SENSE_10            ] = "MODE_SENSE_10",
        [ PERSISTENT_RESERVE_IN    ] = "PERSISTENT_RESERVE_IN",
        [ PERSISTENT_RESERVE_OUT   ] = "PERSISTENT_RESERVE_OUT",
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
        [ WRITE_FILEMARKS_16       ] = "WRITE_FILEMARKS_16",
        [ EXTENDED_COPY            ] = "EXTENDED_COPY",
        [ ATA_PASSTHROUGH          ] = "ATA_PASSTHROUGH",
        [ ACCESS_CONTROL_IN        ] = "ACCESS_CONTROL_IN",
        [ ACCESS_CONTROL_OUT       ] = "ACCESS_CONTROL_OUT",
        [ READ_16                  ] = "READ_16",
        [ COMPARE_AND_WRITE        ] = "COMPARE_AND_WRITE",
        [ WRITE_16                 ] = "WRITE_16",
        [ WRITE_VERIFY_16          ] = "WRITE_VERIFY_16",
        [ VERIFY_16                ] = "VERIFY_16",
P
Paolo Bonzini 已提交
1201 1202 1203
        [ PRE_FETCH_16             ] = "PRE_FETCH_16",
        [ SYNCHRONIZE_CACHE_16     ] = "SPACE_16/SYNCHRONIZE_CACHE_16",
        /* SPACE_16 and SYNCHRONIZE_CACHE_16 use the same operation code */
1204
        [ LOCATE_16                ] = "LOCATE_16",
P
Paolo Bonzini 已提交
1205
        [ WRITE_SAME_16            ] = "ERASE_16/WRITE_SAME_16",
1206
        /* ERASE_16 and WRITE_SAME_16 use the same operation code */
1207
        [ SERVICE_ACTION_IN_16     ] = "SERVICE_ACTION_IN_16",
1208 1209 1210
        [ WRITE_LONG_16            ] = "WRITE_LONG_16",
        [ REPORT_LUNS              ] = "REPORT_LUNS",
        [ BLANK                    ] = "BLANK",
G
Gerd Hoffmann 已提交
1211
        [ MOVE_MEDIUM              ] = "MOVE_MEDIUM",
1212
        [ LOAD_UNLOAD              ] = "LOAD_UNLOAD",
G
Gerd Hoffmann 已提交
1213 1214
        [ READ_12                  ] = "READ_12",
        [ WRITE_12                 ] = "WRITE_12",
P
Paolo Bonzini 已提交
1215 1216
        [ ERASE_12                 ] = "ERASE_12/GET_PERFORMANCE",
        /* ERASE_12 and GET_PERFORMANCE use the same operation code */
1217
        [ SERVICE_ACTION_IN_12     ] = "SERVICE_ACTION_IN_12",
G
Gerd Hoffmann 已提交
1218
        [ WRITE_VERIFY_12          ] = "WRITE_VERIFY_12",
1219
        [ VERIFY_12                ] = "VERIFY_12",
G
Gerd Hoffmann 已提交
1220 1221 1222 1223
        [ SEARCH_HIGH_12           ] = "SEARCH_HIGH_12",
        [ SEARCH_EQUAL_12          ] = "SEARCH_EQUAL_12",
        [ SEARCH_LOW_12            ] = "SEARCH_LOW_12",
        [ READ_ELEMENT_STATUS      ] = "READ_ELEMENT_STATUS",
P
Paolo Bonzini 已提交
1224 1225 1226
        [ SEND_VOLUME_TAG          ] = "SEND_VOLUME_TAG/SET_STREAMING",
        /* SEND_VOLUME_TAG and SET_STREAMING use the same operation code */
        [ READ_CD                  ] = "READ_CD",
1227
        [ READ_DEFECT_DATA_12      ] = "READ_DEFECT_DATA_12",
P
Paolo Bonzini 已提交
1228 1229 1230 1231
        [ READ_DVD_STRUCTURE       ] = "READ_DVD_STRUCTURE",
        [ RESERVE_TRACK            ] = "RESERVE_TRACK",
        [ SEND_CUE_SHEET           ] = "SEND_CUE_SHEET",
        [ SEND_DVD_STRUCTURE       ] = "SEND_DVD_STRUCTURE",
G
Gerd Hoffmann 已提交
1232
        [ SET_CD_SPEED             ] = "SET_CD_SPEED",
P
Paolo Bonzini 已提交
1233 1234 1235
        [ SET_READ_AHEAD           ] = "SET_READ_AHEAD",
        [ ALLOW_OVERWRITE          ] = "ALLOW_OVERWRITE",
        [ MECHANISM_STATUS         ] = "MECHANISM_STATUS",
G
Gerd Hoffmann 已提交
1236 1237 1238 1239 1240 1241 1242
    };

    if (cmd >= ARRAY_SIZE(names) || names[cmd] == NULL)
        return "*UNKNOWN*";
    return names[cmd];
}

P
Paolo Bonzini 已提交
1243 1244 1245 1246 1247 1248 1249 1250 1251
SCSIRequest *scsi_req_ref(SCSIRequest *req)
{
    req->refcount++;
    return req;
}

void scsi_req_unref(SCSIRequest *req)
{
    if (--req->refcount == 0) {
1252 1253
        if (req->ops->free_req) {
            req->ops->free_req(req);
P
Paolo Bonzini 已提交
1254
        }
1255
        g_free(req);
P
Paolo Bonzini 已提交
1256 1257 1258
    }
}

1259 1260 1261 1262 1263 1264
/* Tell the device that we finished processing this chunk of I/O.  It
   will start the next chunk or complete the command.  */
void scsi_req_continue(SCSIRequest *req)
{
    trace_scsi_req_continue(req->dev->id, req->lun, req->tag);
    if (req->cmd.mode == SCSI_XFER_TO_DEV) {
1265
        req->ops->write_data(req);
1266
    } else {
1267
        req->ops->read_data(req);
1268 1269 1270
    }
}

P
Paolo Bonzini 已提交
1271 1272
/* Called by the devices when data is ready for the HBA.  The HBA should
   start a DMA operation to read or fill the device's data buffer.
1273
   Once it completes, calling scsi_req_continue will restart I/O.  */
P
Paolo Bonzini 已提交
1274 1275
void scsi_req_data(SCSIRequest *req, int len)
{
1276 1277 1278 1279 1280 1281
    if (req->io_canceled) {
        trace_scsi_req_data_canceled(req->dev->id, req->lun, req->tag, len);
    } else {
        trace_scsi_req_data(req->dev->id, req->lun, req->tag, len);
        req->bus->info->transfer_data(req, len);
    }
P
Paolo Bonzini 已提交
1282 1283
}

G
Gerd Hoffmann 已提交
1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311
void scsi_req_print(SCSIRequest *req)
{
    FILE *fp = stderr;
    int i;

    fprintf(fp, "[%s id=%d] %s",
            req->dev->qdev.parent_bus->name,
            req->dev->id,
            scsi_command_name(req->cmd.buf[0]));
    for (i = 1; i < req->cmd.len; i++) {
        fprintf(fp, " 0x%02x", req->cmd.buf[i]);
    }
    switch (req->cmd.mode) {
    case SCSI_XFER_NONE:
        fprintf(fp, " - none\n");
        break;
    case SCSI_XFER_FROM_DEV:
        fprintf(fp, " - from-dev len=%zd\n", req->cmd.xfer);
        break;
    case SCSI_XFER_TO_DEV:
        fprintf(fp, " - to-dev len=%zd\n", req->cmd.xfer);
        break;
    default:
        fprintf(fp, " - Oops\n");
        break;
    }
}

1312
void scsi_req_complete(SCSIRequest *req, int status)
G
Gerd Hoffmann 已提交
1313
{
1314 1315
    assert(req->status == -1);
    req->status = status;
1316 1317 1318 1319 1320 1321 1322 1323

    assert(req->sense_len < sizeof(req->sense));
    if (status == GOOD) {
        req->sense_len = 0;
    }

    if (req->sense_len) {
        memcpy(req->dev->sense, req->sense, req->sense_len);
1324 1325 1326 1327 1328
        req->dev->sense_len = req->sense_len;
        req->dev->sense_is_ua = (req->ops == &reqops_unit_attention);
    } else {
        req->dev->sense_len = 0;
        req->dev->sense_is_ua = false;
1329 1330
    }

1331 1332 1333 1334 1335 1336 1337
    /*
     * Unit attention state is now stored in the device's sense buffer
     * if the HBA didn't do autosense.  Clear the pending unit attention
     * flags.
     */
    scsi_clear_unit_attention(req);

P
Paolo Bonzini 已提交
1338
    scsi_req_ref(req);
1339
    scsi_req_dequeue(req);
1340
    req->bus->info->complete(req, req->status);
P
Paolo Bonzini 已提交
1341
    scsi_req_unref(req);
G
Gerd Hoffmann 已提交
1342
}
1343

P
Paolo Bonzini 已提交
1344 1345
void scsi_req_cancel(SCSIRequest *req)
{
1346 1347
    if (!req->enqueued) {
        return;
P
Paolo Bonzini 已提交
1348 1349 1350
    }
    scsi_req_ref(req);
    scsi_req_dequeue(req);
1351 1352 1353 1354
    req->io_canceled = true;
    if (req->ops->cancel_io) {
        req->ops->cancel_io(req);
    }
1355 1356
    if (req->bus->info->cancel) {
        req->bus->info->cancel(req);
P
Paolo Bonzini 已提交
1357 1358 1359 1360
    }
    scsi_req_unref(req);
}

P
Paolo Bonzini 已提交
1361 1362
void scsi_req_abort(SCSIRequest *req, int status)
{
1363 1364 1365 1366 1367 1368
    if (!req->enqueued) {
        return;
    }
    scsi_req_ref(req);
    scsi_req_dequeue(req);
    req->io_canceled = true;
1369 1370
    if (req->ops->cancel_io) {
        req->ops->cancel_io(req);
P
Paolo Bonzini 已提交
1371
    }
1372
    scsi_req_complete(req, status);
1373
    scsi_req_unref(req);
P
Paolo Bonzini 已提交
1374 1375
}

1376
void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense)
P
Paolo Bonzini 已提交
1377 1378 1379 1380 1381
{
    SCSIRequest *req;

    while (!QTAILQ_EMPTY(&sdev->requests)) {
        req = QTAILQ_FIRST(&sdev->requests);
P
Paolo Bonzini 已提交
1382
        scsi_req_cancel(req);
P
Paolo Bonzini 已提交
1383
    }
1384
    sdev->unit_attention = sense;
P
Paolo Bonzini 已提交
1385 1386
}

1387 1388
static char *scsibus_get_fw_dev_path(DeviceState *dev)
{
1389
    SCSIDevice *d = SCSI_DEVICE(dev);
1390 1391
    char path[100];

P
Paolo Bonzini 已提交
1392 1393
    snprintf(path, sizeof(path), "channel@%x/%s@%x,%x", d->channel,
             qdev_fw_name(dev), d->id, d->lun);
1394

1395 1396 1397
    return strdup(path);
}

P
Paolo Bonzini 已提交
1398
SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int id, int lun)
1399 1400 1401
{
    DeviceState *qdev;
    SCSIDevice *target_dev = NULL;
1402

1403
    QTAILQ_FOREACH_REVERSE(qdev, &bus->qbus.children, ChildrenHead, sibling) {
1404
        SCSIDevice *dev = SCSI_DEVICE(qdev);
1405

P
Paolo Bonzini 已提交
1406
        if (dev->channel == channel && dev->id == id) {
1407 1408 1409 1410 1411 1412 1413
            if (dev->lun == lun) {
                return dev;
            }
            target_dev = dev;
        }
    }
    return target_dev;
1414
}
1415

1416 1417 1418 1419 1420 1421 1422 1423 1424
static void scsi_device_class_init(ObjectClass *klass, void *data)
{
    DeviceClass *k = DEVICE_CLASS(klass);
    k->bus_info = &scsi_bus_info;
    k->init     = scsi_qdev_init;
    k->unplug   = qdev_simple_unplug_cb;
    k->exit     = scsi_qdev_exit;
}

1425 1426 1427 1428 1429 1430
static TypeInfo scsi_device_type_info = {
    .name = TYPE_SCSI_DEVICE,
    .parent = TYPE_DEVICE,
    .instance_size = sizeof(SCSIDevice),
    .abstract = true,
    .class_size = sizeof(SCSIDeviceClass),
1431
    .class_init = scsi_device_class_init,
1432 1433 1434 1435 1436 1437 1438 1439
};

static void scsi_register_devices(void)
{
    type_register_static(&scsi_device_type_info);
}

device_init(scsi_register_devices);