hw/scsi-bus.c

   1 #include "hw.h"
   2 #include "qemu-error.h"
   3 #include "scsi.h"
   4 #include "scsi-defs.h"
   5 #include "qdev.h"
   6 #include "blockdev.h"
   7 #include "trace.h"
   8 #include "dma.h"
   9
  10 static char *scsibus_get_dev_path(DeviceState *dev);
  11 static char *scsibus_get_fw_dev_path(DeviceState *dev);
  12 static int scsi_req_parse(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf);
  13 static void scsi_req_dequeue(SCSIRequest *req);
  14
  15 static Property scsi_props[] = {
  16     DEFINE_PROP_UINT32("channel", SCSIDevice, channel, 0),
  17     DEFINE_PROP_UINT32("scsi-id", SCSIDevice, id, -1),
  18     DEFINE_PROP_UINT32("lun", SCSIDevice, lun, -1),
  19     DEFINE_PROP_END_OF_LIST(),
  20 };
  21
  22 static void scsi_bus_class_init(ObjectClass *klass, void *data)
  23 {
  24     BusClass *k = BUS_CLASS(klass);
  25
  26     k->get_dev_path = scsibus_get_dev_path;
  27     k->get_fw_dev_path = scsibus_get_fw_dev_path;
  28 }
  29
  30 static const TypeInfo scsi_bus_info = {
  31     .name = TYPE_SCSI_BUS,
  32     .parent = TYPE_BUS,
  33     .instance_size = sizeof(SCSIBus),
  34     .class_init = scsi_bus_class_init,
  35 };
  36 static int next_scsi_bus;
  37
  38 static int scsi_device_init(SCSIDevice *s)
  39 {
  40     SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
  41     if (sc->init) {
  42         return sc->init(s);
  43     }
  44     return 0;
  45 }
  46
  47 static void scsi_device_destroy(SCSIDevice *s)
  48 {
  49     SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
  50     if (sc->destroy) {
  51         sc->destroy(s);
  52     }
  53 }
  54
  55 static SCSIRequest *scsi_device_alloc_req(SCSIDevice *s, uint32_t tag, uint32_t lun,
  56                                           uint8_t *buf, void *hba_private)
  57 {
  58     SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
  59     if (sc->alloc_req) {
  60         return sc->alloc_req(s, tag, lun, buf, hba_private);
  61     }
  62
  63     return NULL;
  64 }
  65
  66 static void scsi_device_unit_attention_reported(SCSIDevice *s)
  67 {
  68     SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
  69     if (sc->unit_attention_reported) {
  70         sc->unit_attention_reported(s);
  71     }
  72 }
  73
  74 /* Create a scsi bus, and attach devices to it.  */
  75 void scsi_bus_new(SCSIBus *bus, DeviceState *host, const SCSIBusInfo *info)
  76 {
  77     qbus_create_inplace(&bus->qbus, TYPE_SCSI_BUS, host, NULL);
  78     bus->busnr = next_scsi_bus++;
  79     bus->info = info;
  80     bus->qbus.allow_hotplug = 1;
  81 }
  82
  83 static void scsi_dma_restart_bh(void *opaque)
  84 {
  85     SCSIDevice *s = opaque;
  86     SCSIRequest *req, *next;
  87
  88     qemu_bh_delete(s->bh);
  89     s->bh = NULL;
  90
  91     QTAILQ_FOREACH_SAFE(req, &s->requests, next, next) {
  92         scsi_req_ref(req);
  93         if (req->retry) {
  94             req->retry = false;
  95             switch (req->cmd.mode) {
  96             case SCSI_XFER_FROM_DEV:
  97             case SCSI_XFER_TO_DEV:
  98                 scsi_req_continue(req);
  99                 break;
 100             case SCSI_XFER_NONE:
 101                 assert(!req->sg);
 102                 scsi_req_dequeue(req);
 103                 scsi_req_enqueue(req);
 104                 break;
 105             }
 106         }
 107         scsi_req_unref(req);
 108     }
 109 }
 110
 111 void scsi_req_retry(SCSIRequest *req)
 112 {
 113     /* No need to save a reference, because scsi_dma_restart_bh just
 114      * looks at the request list.  */
 115     req->retry = true;
 116 }
 117
 118 static void scsi_dma_restart_cb(void *opaque, int running, RunState state)
 119 {
 120     SCSIDevice *s = opaque;
 121
 122     if (!running) {
 123         return;
 124     }
 125     if (!s->bh) {
 126         s->bh = qemu_bh_new(scsi_dma_restart_bh, s);
 127         qemu_bh_schedule(s->bh);
 128     }
 129 }
 130
 131 static int scsi_qdev_init(DeviceState *qdev)
 132 {
 133     SCSIDevice *dev = SCSI_DEVICE(qdev);
 134     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
 135     SCSIDevice *d;
 136     int rc = -1;
 137
 138     if (dev->channel > bus->info->max_channel) {
 139         error_report("bad scsi channel id: %d", dev->channel);
 140         goto err;
 141     }
 142     if (dev->id != -1 && dev->id > bus->info->max_target) {
 143         error_report("bad scsi device id: %d", dev->id);
 144         goto err;
 145     }
 146     if (dev->lun != -1 && dev->lun > bus->info->max_lun) {
 147         error_report("bad scsi device lun: %d", dev->lun);
 148         goto err;
 149     }
 150
 151     if (dev->id == -1) {
 152         int id = -1;
 153         if (dev->lun == -1) {
 154             dev->lun = 0;
 155         }
 156         do {
 157             d = scsi_device_find(bus, dev->channel, ++id, dev->lun);
 158         } while (d && d->lun == dev->lun && id < bus->info->max_target);
 159         if (d && d->lun == dev->lun) {
 160             error_report("no free target");
 161             goto err;
 162         }
 163         dev->id = id;
 164     } else if (dev->lun == -1) {
 165         int lun = -1;
 166         do {
 167             d = scsi_device_find(bus, dev->channel, dev->id, ++lun);
 168         } while (d && d->lun == lun && lun < bus->info->max_lun);
 169         if (d && d->lun == lun) {
 170             error_report("no free lun");
 171             goto err;
 172         }
 173         dev->lun = lun;
 174     } else {
 175         d = scsi_device_find(bus, dev->channel, dev->id, dev->lun);
 176         assert(d);
 177         if (d->lun == dev->lun && dev != d) {
 178             qdev_free(&d->qdev);
 179         }
 180     }
 181
 182     QTAILQ_INIT(&dev->requests);
 183     rc = scsi_device_init(dev);
 184     if (rc == 0) {
 185         dev->vmsentry = qemu_add_vm_change_state_handler(scsi_dma_restart_cb,
 186                                                          dev);
 187     }
 188
 189     if (bus->info->hotplug) {
 190         bus->info->hotplug(bus, dev);
 191     }
 192
 193 err:
 194     return rc;
 195 }
 196
 197 static int scsi_qdev_exit(DeviceState *qdev)
 198 {
 199     SCSIDevice *dev = SCSI_DEVICE(qdev);
 200
 201     if (dev->vmsentry) {
 202         qemu_del_vm_change_state_handler(dev->vmsentry);
 203     }
 204     scsi_device_destroy(dev);
 205     return 0;
 206 }
 207
 208 /* handle legacy '-drive if=scsi,...' cmd line args */
 209 SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockDriverState *bdrv,
 210                                       int unit, bool removable, int bootindex)
 211 {
 212     const char *driver;
 213     DeviceState *dev;
 214
 215     driver = bdrv_is_sg(bdrv) ? "scsi-generic" : "scsi-disk";
 216     dev = qdev_create(&bus->qbus, driver);
 217     qdev_prop_set_uint32(dev, "scsi-id", unit);
 218     if (bootindex >= 0) {
 219         qdev_prop_set_int32(dev, "bootindex", bootindex);
 220     }
 221     if (object_property_find(OBJECT(dev), "removable", NULL)) {
 222         qdev_prop_set_bit(dev, "removable", removable);
 223     }
 224     if (qdev_prop_set_drive(dev, "drive", bdrv) < 0) {
 225         qdev_free(dev);
 226         return NULL;
 227     }
 228     if (qdev_init(dev) < 0)
 229         return NULL;
 230     return SCSI_DEVICE(dev);
 231 }
 232
 233 int scsi_bus_legacy_handle_cmdline(SCSIBus *bus)
 234 {
 235     Location loc;
 236     DriveInfo *dinfo;
 237     int res = 0, unit;
 238
 239     loc_push_none(&loc);
 240     for (unit = 0; unit <= bus->info->max_target; unit++) {
 241         dinfo = drive_get(IF_SCSI, bus->busnr, unit);
 242         if (dinfo == NULL) {
 243             continue;
 244         }
 245         qemu_opts_loc_restore(dinfo->opts);
 246         if (!scsi_bus_legacy_add_drive(bus, dinfo->bdrv, unit, false, -1)) {
 247             res = -1;
 248             break;
 249         }
 250     }
 251     loc_pop(&loc);
 252     return res;
 253 }
 254
 255 static int32_t scsi_invalid_field(SCSIRequest *req, uint8_t *buf)
 256 {
 257     scsi_req_build_sense(req, SENSE_CODE(INVALID_FIELD));
 258     scsi_req_complete(req, CHECK_CONDITION);
 259     return 0;
 260 }
 261
 262 static const struct SCSIReqOps reqops_invalid_field = {
 263     .size         = sizeof(SCSIRequest),
 264     .send_command = scsi_invalid_field
 265 };
 266
 267 /* SCSIReqOps implementation for invalid commands.  */
 268
 269 static int32_t scsi_invalid_command(SCSIRequest *req, uint8_t *buf)
 270 {
 271     scsi_req_build_sense(req, SENSE_CODE(INVALID_OPCODE));
 272     scsi_req_complete(req, CHECK_CONDITION);
 273     return 0;
 274 }
 275
 276 static const struct SCSIReqOps reqops_invalid_opcode = {
 277     .size         = sizeof(SCSIRequest),
 278     .send_command = scsi_invalid_command
 279 };
 280
 281 /* SCSIReqOps implementation for unit attention conditions.  */
 282
 283 static int32_t scsi_unit_attention(SCSIRequest *req, uint8_t *buf)
 284 {
 285     if (req->dev && req->dev->unit_attention.key == UNIT_ATTENTION) {
 286         scsi_req_build_sense(req, req->dev->unit_attention);
 287     } else if (req->bus->unit_attention.key == UNIT_ATTENTION) {
 288         scsi_req_build_sense(req, req->bus->unit_attention);
 289     }
 290     scsi_req_complete(req, CHECK_CONDITION);
 291     return 0;
 292 }
 293
 294 static const struct SCSIReqOps reqops_unit_attention = {
 295     .size         = sizeof(SCSIRequest),
 296     .send_command = scsi_unit_attention
 297 };
 298
 299 /* SCSIReqOps implementation for REPORT LUNS and for commands sent to
 300    an invalid LUN.  */
 301
 302 typedef struct SCSITargetReq SCSITargetReq;
 303
 304 struct SCSITargetReq {
 305     SCSIRequest req;
 306     int len;
 307     uint8_t buf[2056];
 308 };
 309
 310 static void store_lun(uint8_t *outbuf, int lun)
 311 {
 312     if (lun < 256) {
 313         outbuf[1] = lun;
 314         return;
 315     }
 316     outbuf[1] = (lun & 255);
 317     outbuf[0] = (lun >> 8) | 0x40;
 318 }
 319
 320 static bool scsi_target_emulate_report_luns(SCSITargetReq *r)
 321 {
 322     BusChild *kid;
 323     int i, len, n;
 324     int channel, id;
 325     bool found_lun0;
 326
 327     if (r->req.cmd.xfer < 16) {
 328         return false;
 329     }
 330     if (r->req.cmd.buf[2] > 2) {
 331         return false;
 332     }
 333     channel = r->req.dev->channel;
 334     id = r->req.dev->id;
 335     found_lun0 = false;
 336     n = 0;
 337     QTAILQ_FOREACH(kid, &r->req.bus->qbus.children, sibling) {
 338         DeviceState *qdev = kid->child;
 339         SCSIDevice *dev = SCSI_DEVICE(qdev);
 340
 341         if (dev->channel == channel && dev->id == id) {
 342             if (dev->lun == 0) {
 343                 found_lun0 = true;
 344             }
 345             n += 8;
 346         }
 347     }
 348     if (!found_lun0) {
 349         n += 8;
 350     }
 351     len = MIN(n + 8, r->req.cmd.xfer & ~7);
 352     if (len > sizeof(r->buf)) {
 353         /* TODO: > 256 LUNs? */
 354         return false;
 355     }
 356
 357     memset(r->buf, 0, len);
 358     stl_be_p(&r->buf, n);
 359     i = found_lun0 ? 8 : 16;
 360     QTAILQ_FOREACH(kid, &r->req.bus->qbus.children, sibling) {
 361         DeviceState *qdev = kid->child;
 362         SCSIDevice *dev = SCSI_DEVICE(qdev);
 363
 364         if (dev->channel == channel && dev->id == id) {
 365             store_lun(&r->buf[i], dev->lun);
 366             i += 8;
 367         }
 368     }
 369     assert(i == n + 8);
 370     r->len = len;
 371     return true;
 372 }
 373
 374 static bool scsi_target_emulate_inquiry(SCSITargetReq *r)
 375 {
 376     assert(r->req.dev->lun != r->req.lun);
 377     if (r->req.cmd.buf[1] & 0x2) {
 378         /* Command support data - optional, not implemented */
 379         return false;
 380     }
 381
 382     if (r->req.cmd.buf[1] & 0x1) {
 383         /* Vital product data */
 384         uint8_t page_code = r->req.cmd.buf[2];
 385         r->buf[r->len++] = page_code ; /* this page */
 386         r->buf[r->len++] = 0x00;
 387
 388         switch (page_code) {
 389         case 0x00: /* Supported page codes, mandatory */
 390         {
 391             int pages;
 392             pages = r->len++;
 393             r->buf[r->len++] = 0x00; /* list of supported pages (this page) */
 394             r->buf[pages] = r->len - pages - 1; /* number of pages */
 395             break;
 396         }
 397         default:
 398             return false;
 399         }
 400         /* done with EVPD */
 401         assert(r->len < sizeof(r->buf));
 402         r->len = MIN(r->req.cmd.xfer, r->len);
 403         return true;
 404     }
 405
 406     /* Standard INQUIRY data */
 407     if (r->req.cmd.buf[2] != 0) {
 408         return false;
 409     }
 410
 411     /* PAGE CODE == 0 */
 412     r->len = MIN(r->req.cmd.xfer, 36);
 413     memset(r->buf, 0, r->len);
 414     if (r->req.lun != 0) {
 415         r->buf[0] = TYPE_NO_LUN;
 416     } else {
 417         r->buf[0] = TYPE_NOT_PRESENT | TYPE_INACTIVE;
 418         r->buf[2] = 5; /* Version */
 419         r->buf[3] = 2 | 0x10; /* HiSup, response data format */
 420         r->buf[4] = r->len - 5; /* Additional Length = (Len - 1) - 4 */
 421         r->buf[7] = 0x10 | (r->req.bus->info->tcq ? 0x02 : 0); /* Sync, TCQ.  */
 422         memcpy(&r->buf[8], "QEMU    ", 8);
 423         memcpy(&r->buf[16], "QEMU TARGET     ", 16);
 424         pstrcpy((char *) &r->buf[32], 4, qemu_get_version());
 425     }
 426     return true;
 427 }
 428
 429 static int32_t scsi_target_send_command(SCSIRequest *req, uint8_t *buf)
 430 {
 431     SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
 432
 433     switch (buf[0]) {
 434     case REPORT_LUNS:
 435         if (!scsi_target_emulate_report_luns(r)) {
 436             goto illegal_request;
 437         }
 438         break;
 439     case INQUIRY:
 440         if (!scsi_target_emulate_inquiry(r)) {
 441             goto illegal_request;
 442         }
 443         break;
 444     case REQUEST_SENSE:
 445         r->len = scsi_device_get_sense(r->req.dev, r->buf,
 446                                        MIN(req->cmd.xfer, sizeof r->buf),
 447                                        (req->cmd.buf[1] & 1) == 0);
 448         if (r->req.dev->sense_is_ua) {
 449             scsi_device_unit_attention_reported(req->dev);
 450             r->req.dev->sense_len = 0;
 451             r->req.dev->sense_is_ua = false;
 452         }
 453         break;
 454     default:
 455         scsi_req_build_sense(req, SENSE_CODE(LUN_NOT_SUPPORTED));
 456         scsi_req_complete(req, CHECK_CONDITION);
 457         return 0;
 458     illegal_request:
 459         scsi_req_build_sense(req, SENSE_CODE(INVALID_FIELD));
 460         scsi_req_complete(req, CHECK_CONDITION);
 461         return 0;
 462     }
 463
 464     if (!r->len) {
 465         scsi_req_complete(req, GOOD);
 466     }
 467     return r->len;
 468 }
 469
 470 static void scsi_target_read_data(SCSIRequest *req)
 471 {
 472     SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
 473     uint32_t n;
 474
 475     n = r->len;
 476     if (n > 0) {
 477         r->len = 0;
 478         scsi_req_data(&r->req, n);
 479     } else {
 480         scsi_req_complete(&r->req, GOOD);
 481     }
 482 }
 483
 484 static uint8_t *scsi_target_get_buf(SCSIRequest *req)
 485 {
 486     SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
 487
 488     return r->buf;
 489 }
 490
 491 static const struct SCSIReqOps reqops_target_command = {
 492     .size         = sizeof(SCSITargetReq),
 493     .send_command = scsi_target_send_command,
 494     .read_data    = scsi_target_read_data,
 495     .get_buf      = scsi_target_get_buf,
 496 };
 497
 498
 499 SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d,
 500                             uint32_t tag, uint32_t lun, void *hba_private)
 501 {
 502     SCSIRequest *req;
 503
 504     req = g_malloc0(reqops->size);
 505     req->refcount = 1;
 506     req->bus = scsi_bus_from_device(d);
 507     req->dev = d;
 508     req->tag = tag;
 509     req->lun = lun;
 510     req->hba_private = hba_private;
 511     req->status = -1;
 512     req->sense_len = 0;
 513     req->ops = reqops;
 514     trace_scsi_req_alloc(req->dev->id, req->lun, req->tag);
 515     return req;
 516 }
 517
 518 SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun,
 519                           uint8_t *buf, void *hba_private)
 520 {
 521     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
 522     SCSIRequest *req;
 523     SCSICommand cmd;
 524
 525     if (scsi_req_parse(&cmd, d, buf) != 0) {
 526         trace_scsi_req_parse_bad(d->id, lun, tag, buf[0]);
 527         req = scsi_req_alloc(&reqops_invalid_opcode, d, tag, lun, hba_private);
 528     } else {
 529         trace_scsi_req_parsed(d->id, lun, tag, buf[0],
 530                               cmd.mode, cmd.xfer);
 531         if (cmd.lba != -1) {
 532             trace_scsi_req_parsed_lba(d->id, lun, tag, buf[0],
 533                                       cmd.lba);
 534         }
 535
 536         if (cmd.xfer > INT32_MAX) {
 537             req = scsi_req_alloc(&reqops_invalid_field, d, tag, lun, hba_private);
 538         } else if ((d->unit_attention.key == UNIT_ATTENTION ||
 539                    bus->unit_attention.key == UNIT_ATTENTION) &&
 540                   (buf[0] != INQUIRY &&
 541                    buf[0] != REPORT_LUNS &&
 542                    buf[0] != GET_CONFIGURATION &&
 543                    buf[0] != GET_EVENT_STATUS_NOTIFICATION &&
 544
 545                    /*
 546                     * If we already have a pending unit attention condition,
 547                     * report this one before triggering another one.
 548                     */
 549                    !(buf[0] == REQUEST_SENSE && d->sense_is_ua))) {
 550             req = scsi_req_alloc(&reqops_unit_attention, d, tag, lun,
 551                                  hba_private);
 552         } else if (lun != d->lun ||
 553                    buf[0] == REPORT_LUNS ||
 554                    (buf[0] == REQUEST_SENSE && d->sense_len)) {
 555             req = scsi_req_alloc(&reqops_target_command, d, tag, lun,
 556                                  hba_private);
 557         } else {
 558             req = scsi_device_alloc_req(d, tag, lun, buf, hba_private);
 559         }
 560     }
 561
 562     req->cmd = cmd;
 563     req->resid = req->cmd.xfer;
 564
 565     switch (buf[0]) {
 566     case INQUIRY:
 567         trace_scsi_inquiry(d->id, lun, tag, cmd.buf[1], cmd.buf[2]);
 568         break;
 569     case TEST_UNIT_READY:
 570         trace_scsi_test_unit_ready(d->id, lun, tag);
 571         break;
 572     case REPORT_LUNS:
 573         trace_scsi_report_luns(d->id, lun, tag);
 574         break;
 575     case REQUEST_SENSE:
 576         trace_scsi_request_sense(d->id, lun, tag);
 577         break;
 578     default:
 579         break;
 580     }
 581
 582     return req;
 583 }
 584
 585 uint8_t *scsi_req_get_buf(SCSIRequest *req)
 586 {
 587     return req->ops->get_buf(req);
 588 }
 589
 590 static void scsi_clear_unit_attention(SCSIRequest *req)
 591 {
 592     SCSISense *ua;
 593     if (req->dev->unit_attention.key != UNIT_ATTENTION &&
 594         req->bus->unit_attention.key != UNIT_ATTENTION) {
 595         return;
 596     }
 597
 598     /*
 599      * If an INQUIRY command enters the enabled command state,
 600      * the device server shall [not] clear any unit attention condition;
 601      * See also MMC-6, paragraphs 6.5 and 6.6.2.
 602      */
 603     if (req->cmd.buf[0] == INQUIRY ||
 604         req->cmd.buf[0] == GET_CONFIGURATION ||
 605         req->cmd.buf[0] == GET_EVENT_STATUS_NOTIFICATION) {
 606         return;
 607     }
 608
 609     if (req->dev->unit_attention.key == UNIT_ATTENTION) {
 610         ua = &req->dev->unit_attention;
 611     } else {
 612         ua = &req->bus->unit_attention;
 613     }
 614
 615     /*
 616      * If a REPORT LUNS command enters the enabled command state, [...]
 617      * the device server shall clear any pending unit attention condition
 618      * with an additional sense code of REPORTED LUNS DATA HAS CHANGED.
 619      */
 620     if (req->cmd.buf[0] == REPORT_LUNS &&
 621         !(ua->asc == SENSE_CODE(REPORTED_LUNS_CHANGED).asc &&
 622           ua->ascq == SENSE_CODE(REPORTED_LUNS_CHANGED).ascq)) {
 623         return;
 624     }
 625
 626     *ua = SENSE_CODE(NO_SENSE);
 627 }
 628
 629 int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len)
 630 {
 631     int ret;
 632
 633     assert(len >= 14);
 634     if (!req->sense_len) {
 635         return 0;
 636     }
 637
 638     ret = scsi_build_sense(req->sense, req->sense_len, buf, len, true);
 639
 640     /*
 641      * FIXME: clearing unit attention conditions upon autosense should be done
 642      * only if the UA_INTLCK_CTRL field in the Control mode page is set to 00b
 643      * (SAM-5, 5.14).
 644      *
 645      * We assume UA_INTLCK_CTRL to be 00b for HBAs that support autosense, and
 646      * 10b for HBAs that do not support it (do not call scsi_req_get_sense).
 647      * Here we handle unit attention clearing for UA_INTLCK_CTRL == 00b.
 648      */
 649     if (req->dev->sense_is_ua) {
 650         scsi_device_unit_attention_reported(req->dev);
 651         req->dev->sense_len = 0;
 652         req->dev->sense_is_ua = false;
 653     }
 654     return ret;
 655 }
 656
 657 int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed)
 658 {
 659     return scsi_build_sense(dev->sense, dev->sense_len, buf, len, fixed);
 660 }
 661
 662 void scsi_req_build_sense(SCSIRequest *req, SCSISense sense)
 663 {
 664     trace_scsi_req_build_sense(req->dev->id, req->lun, req->tag,
 665                                sense.key, sense.asc, sense.ascq);
 666     memset(req->sense, 0, 18);
 667     req->sense[0] = 0x70;
 668     req->sense[2] = sense.key;
 669     req->sense[7] = 10;
 670     req->sense[12] = sense.asc;
 671     req->sense[13] = sense.ascq;
 672     req->sense_len = 18;
 673 }
 674
 675 static void scsi_req_enqueue_internal(SCSIRequest *req)
 676 {
 677     assert(!req->enqueued);
 678     scsi_req_ref(req);
 679     if (req->bus->info->get_sg_list) {
 680         req->sg = req->bus->info->get_sg_list(req);
 681     } else {
 682         req->sg = NULL;
 683     }
 684     req->enqueued = true;
 685     QTAILQ_INSERT_TAIL(&req->dev->requests, req, next);
 686 }
 687
 688 int32_t scsi_req_enqueue(SCSIRequest *req)
 689 {
 690     int32_t rc;
 691
 692     assert(!req->retry);
 693     scsi_req_enqueue_internal(req);
 694     scsi_req_ref(req);
 695     rc = req->ops->send_command(req, req->cmd.buf);
 696     scsi_req_unref(req);
 697     return rc;
 698 }
 699
 700 static void scsi_req_dequeue(SCSIRequest *req)
 701 {
 702     trace_scsi_req_dequeue(req->dev->id, req->lun, req->tag);
 703     req->retry = false;
 704     if (req->enqueued) {
 705         QTAILQ_REMOVE(&req->dev->requests, req, next);
 706         req->enqueued = false;
 707         scsi_req_unref(req);
 708     }
 709 }
 710
 711 static int scsi_get_performance_length(int num_desc, int type, int data_type)
 712 {
 713     /* MMC-6, paragraph 6.7.  */
 714     switch (type) {
 715     case 0:
 716         if ((data_type & 3) == 0) {
 717             /* Each descriptor is as in Table 295 - Nominal performance.  */
 718             return 16 * num_desc + 8;
 719         } else {
 720             /* Each descriptor is as in Table 296 - Exceptions.  */
 721             return 6 * num_desc + 8;
 722         }
 723     case 1:
 724     case 4:
 725     case 5:
 726         return 8 * num_desc + 8;
 727     case 2:
 728         return 2048 * num_desc + 8;
 729     case 3:
 730         return 16 * num_desc + 8;
 731     default:
 732         return 8;
 733     }
 734 }
 735
 736 static int scsi_req_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
 737 {
 738     switch (buf[0] >> 5) {
 739     case 0:
 740         cmd->xfer = buf[4];
 741         break;
 742     case 1:
 743     case 2:
 744         cmd->xfer = lduw_be_p(&buf[7]);
 745         break;
 746     case 4:
 747         cmd->xfer = ldl_be_p(&buf[10]) & 0xffffffffULL;
 748         break;
 749     case 5:
 750         cmd->xfer = ldl_be_p(&buf[6]) & 0xffffffffULL;
 751         break;
 752     default:
 753         return -1;
 754     }
 755
 756     switch (buf[0]) {
 757     case TEST_UNIT_READY:
 758     case REWIND:
 759     case START_STOP:
 760     case SET_CAPACITY:
 761     case WRITE_FILEMARKS:
 762     case WRITE_FILEMARKS_16:
 763     case SPACE:
 764     case RESERVE:
 765     case RELEASE:
 766     case ERASE:
 767     case ALLOW_MEDIUM_REMOVAL:
 768     case VERIFY_10:
 769     case SEEK_10:
 770     case SYNCHRONIZE_CACHE:
 771     case SYNCHRONIZE_CACHE_16:
 772     case LOCATE_16:
 773     case LOCK_UNLOCK_CACHE:
 774     case SET_CD_SPEED:
 775     case SET_LIMITS:
 776     case WRITE_LONG_10:
 777     case UPDATE_BLOCK:
 778     case RESERVE_TRACK:
 779     case SET_READ_AHEAD:
 780     case PRE_FETCH:
 781     case PRE_FETCH_16:
 782     case ALLOW_OVERWRITE:
 783         cmd->xfer = 0;
 784         break;
 785     case MODE_SENSE:
 786         break;
 787     case WRITE_SAME_10:
 788     case WRITE_SAME_16:
 789         cmd->xfer = dev->blocksize;
 790         break;
 791     case READ_CAPACITY_10:
 792         cmd->xfer = 8;
 793         break;
 794     case READ_BLOCK_LIMITS:
 795         cmd->xfer = 6;
 796         break;
 797     case SEND_VOLUME_TAG:
 798         /* GPCMD_SET_STREAMING from multimedia commands.  */
 799         if (dev->type == TYPE_ROM) {
 800             cmd->xfer = buf[10] | (buf[9] << 8);
 801         } else {
 802             cmd->xfer = buf[9] | (buf[8] << 8);
 803         }
 804         break;
 805     case WRITE_6:
 806         /* length 0 means 256 blocks */
 807         if (cmd->xfer == 0) {
 808             cmd->xfer = 256;
 809         }
 810     case WRITE_10:
 811     case WRITE_VERIFY_10:
 812     case WRITE_12:
 813     case WRITE_VERIFY_12:
 814     case WRITE_16:
 815     case WRITE_VERIFY_16:
 816         cmd->xfer *= dev->blocksize;
 817         break;
 818     case READ_6:
 819     case READ_REVERSE:
 820         /* length 0 means 256 blocks */
 821         if (cmd->xfer == 0) {
 822             cmd->xfer = 256;
 823         }
 824     case READ_10:
 825     case RECOVER_BUFFERED_DATA:
 826     case READ_12:
 827     case READ_16:
 828         cmd->xfer *= dev->blocksize;
 829         break;
 830     case FORMAT_UNIT:
 831         /* MMC mandates the parameter list to be 12-bytes long.  Parameters
 832          * for block devices are restricted to the header right now.  */
 833         if (dev->type == TYPE_ROM && (buf[1] & 16)) {
 834             cmd->xfer = 12;
 835         } else {
 836             cmd->xfer = (buf[1] & 16) == 0 ? 0 : (buf[1] & 32 ? 8 : 4);
 837         }
 838         break;
 839     case INQUIRY:
 840     case RECEIVE_DIAGNOSTIC:
 841     case SEND_DIAGNOSTIC:
 842         cmd->xfer = buf[4] | (buf[3] << 8);
 843         break;
 844     case READ_CD:
 845     case READ_BUFFER:
 846     case WRITE_BUFFER:
 847     case SEND_CUE_SHEET:
 848         cmd->xfer = buf[8] | (buf[7] << 8) | (buf[6] << 16);
 849         break;
 850     case PERSISTENT_RESERVE_OUT:
 851         cmd->xfer = ldl_be_p(&buf[5]) & 0xffffffffULL;
 852         break;
 853     case ERASE_12:
 854         if (dev->type == TYPE_ROM) {
 855             /* MMC command GET PERFORMANCE.  */
 856             cmd->xfer = scsi_get_performance_length(buf[9] | (buf[8] << 8),
 857                                                     buf[10], buf[1] & 0x1f);
 858         }
 859         break;
 860     case MECHANISM_STATUS:
 861     case READ_DVD_STRUCTURE:
 862     case SEND_DVD_STRUCTURE:
 863     case MAINTENANCE_OUT:
 864     case MAINTENANCE_IN:
 865         if (dev->type == TYPE_ROM) {
 866             /* GPCMD_REPORT_KEY and GPCMD_SEND_KEY from multi media commands */
 867             cmd->xfer = buf[9] | (buf[8] << 8);
 868         }
 869         break;
 870     }
 871     return 0;
 872 }
 873
 874 static int scsi_req_stream_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
 875 {
 876     switch (buf[0]) {
 877     /* stream commands */
 878     case ERASE_12:
 879     case ERASE_16:
 880         cmd->xfer = 0;
 881         break;
 882     case READ_6:
 883     case READ_REVERSE:
 884     case RECOVER_BUFFERED_DATA:
 885     case WRITE_6:
 886         cmd->xfer = buf[4] | (buf[3] << 8) | (buf[2] << 16);
 887         if (buf[1] & 0x01) { /* fixed */
 888             cmd->xfer *= dev->blocksize;
 889         }
 890         break;
 891     case READ_16:
 892     case READ_REVERSE_16:
 893     case VERIFY_16:
 894     case WRITE_16:
 895         cmd->xfer = buf[14] | (buf[13] << 8) | (buf[12] << 16);
 896         if (buf[1] & 0x01) { /* fixed */
 897             cmd->xfer *= dev->blocksize;
 898         }
 899         break;
 900     case REWIND:
 901     case LOAD_UNLOAD:
 902         cmd->xfer = 0;
 903         break;
 904     case SPACE_16:
 905         cmd->xfer = buf[13] | (buf[12] << 8);
 906         break;
 907     case READ_POSITION:
 908         switch (buf[1] & 0x1f) /* operation code */ {
 909         case SHORT_FORM_BLOCK_ID:
 910         case SHORT_FORM_VENDOR_SPECIFIC:
 911             cmd->xfer = 20;
 912             break;
 913         case LONG_FORM:
 914             cmd->xfer = 32;
 915             break;
 916         case EXTENDED_FORM:
 917             cmd->xfer = buf[8] | (buf[7] << 8);
 918             break;
 919         default:
 920             return -1;
 921         }
 922
 923         break;
 924     case FORMAT_UNIT:
 925         cmd->xfer = buf[4] | (buf[3] << 8);
 926         break;
 927     /* generic commands */
 928     default:
 929         return scsi_req_length(cmd, dev, buf);
 930     }
 931     return 0;
 932 }
 933
 934 static int scsi_req_medium_changer_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
 935 {
 936     switch (buf[0]) {
 937     /* medium changer commands */
 938     case EXCHANGE_MEDIUM:
 939     case INITIALIZE_ELEMENT_STATUS:
 940     case INITIALIZE_ELEMENT_STATUS_WITH_RANGE:
 941     case MOVE_MEDIUM:
 942     case POSITION_TO_ELEMENT:
 943         cmd->xfer = 0;
 944         break;
 945     case READ_ELEMENT_STATUS:
 946         cmd->xfer = buf[9] | (buf[8] << 8) | (buf[7] << 16);
 947         break;
 948
 949     /* generic commands */
 950     default:
 951         return scsi_req_length(cmd, dev, buf);
 952     }
 953     return 0;
 954 }
 955
 956
 957 static void scsi_cmd_xfer_mode(SCSICommand *cmd)
 958 {
 959     if (!cmd->xfer) {
 960         cmd->mode = SCSI_XFER_NONE;
 961         return;
 962     }
 963     switch (cmd->buf[0]) {
 964     case WRITE_6:
 965     case WRITE_10:
 966     case WRITE_VERIFY_10:
 967     case WRITE_12:
 968     case WRITE_VERIFY_12:
 969     case WRITE_16:
 970     case WRITE_VERIFY_16:
 971     case COPY:
 972     case COPY_VERIFY:
 973     case COMPARE:
 974     case CHANGE_DEFINITION:
 975     case LOG_SELECT:
 976     case MODE_SELECT:
 977     case MODE_SELECT_10:
 978     case SEND_DIAGNOSTIC:
 979     case WRITE_BUFFER:
 980     case FORMAT_UNIT:
 981     case REASSIGN_BLOCKS:
 982     case SEARCH_EQUAL:
 983     case SEARCH_HIGH:
 984     case SEARCH_LOW:
 985     case UPDATE_BLOCK:
 986     case WRITE_LONG_10:
 987     case WRITE_SAME_10:
 988     case WRITE_SAME_16:
 989     case UNMAP:
 990     case SEARCH_HIGH_12:
 991     case SEARCH_EQUAL_12:
 992     case SEARCH_LOW_12:
 993     case MEDIUM_SCAN:
 994     case SEND_VOLUME_TAG:
 995     case SEND_CUE_SHEET:
 996     case SEND_DVD_STRUCTURE:
 997     case PERSISTENT_RESERVE_OUT:
 998     case MAINTENANCE_OUT:
 999     case ATA_PASSTHROUGH:
1000         cmd->mode = SCSI_XFER_TO_DEV;
1001         break;
1002     default:
1003         cmd->mode = SCSI_XFER_FROM_DEV;
1004         break;
1005     }
1006 }
1007
1008 static uint64_t scsi_cmd_lba(SCSICommand *cmd)
1009 {
1010     uint8_t *buf = cmd->buf;
1011     uint64_t lba;
1012
1013     switch (buf[0] >> 5) {
1014     case 0:
1015         lba = ldl_be_p(&buf[0]) & 0x1fffff;
1016         break;
1017     case 1:
1018     case 2:
1019     case 5:
1020         lba = ldl_be_p(&buf[2]) & 0xffffffffULL;
1021         break;
1022     case 4:
1023         lba = ldq_be_p(&buf[2]);
1024         break;
1025     default:
1026         lba = -1;
1027
1028     }
1029     return lba;
1030 }
1031
1032 int scsi_req_parse(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
1033 {
1034     int rc;
1035
1036     switch (buf[0] >> 5) {
1037     case 0:
1038         cmd->len = 6;
1039         break;
1040     case 1:
1041     case 2:
1042         cmd->len = 10;
1043         break;
1044     case 4:
1045         cmd->len = 16;
1046         break;
1047     case 5:
1048         cmd->len = 12;
1049         break;
1050     default:
1051         return -1;
1052     }
1053
1054     switch (dev->type) {
1055     case TYPE_TAPE:
1056         rc = scsi_req_stream_length(cmd, dev, buf);
1057         break;
1058     case TYPE_MEDIUM_CHANGER:
1059         rc = scsi_req_medium_changer_length(cmd, dev, buf);
1060         break;
1061     default:
1062         rc = scsi_req_length(cmd, dev, buf);
1063         break;
1064     }
1065
1066     if (rc != 0)
1067         return rc;
1068
1069     memcpy(cmd->buf, buf, cmd->len);
1070     scsi_cmd_xfer_mode(cmd);
1071     cmd->lba = scsi_cmd_lba(cmd);
1072     return 0;
1073 }
1074
1075 /*
1076  * Predefined sense codes
1077  */
1078
1079 /* No sense data available */
1080 const struct SCSISense sense_code_NO_SENSE = {
1081     .key = NO_SENSE , .asc = 0x00 , .ascq = 0x00
1082 };
1083
1084 /* LUN not ready, Manual intervention required */
1085 const struct SCSISense sense_code_LUN_NOT_READY = {
1086     .key = NOT_READY, .asc = 0x04, .ascq = 0x03
1087 };
1088
1089 /* LUN not ready, Medium not present */
1090 const struct SCSISense sense_code_NO_MEDIUM = {
1091     .key = NOT_READY, .asc = 0x3a, .ascq = 0x00
1092 };
1093
1094 /* LUN not ready, medium removal prevented */
1095 const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED = {
1096     .key = NOT_READY, .asc = 0x53, .ascq = 0x00
1097 };
1098
1099 /* Hardware error, internal target failure */
1100 const struct SCSISense sense_code_TARGET_FAILURE = {
1101     .key = HARDWARE_ERROR, .asc = 0x44, .ascq = 0x00
1102 };
1103
1104 /* Illegal request, invalid command operation code */
1105 const struct SCSISense sense_code_INVALID_OPCODE = {
1106     .key = ILLEGAL_REQUEST, .asc = 0x20, .ascq = 0x00
1107 };
1108
1109 /* Illegal request, LBA out of range */
1110 const struct SCSISense sense_code_LBA_OUT_OF_RANGE = {
1111     .key = ILLEGAL_REQUEST, .asc = 0x21, .ascq = 0x00
1112 };
1113
1114 /* Illegal request, Invalid field in CDB */
1115 const struct SCSISense sense_code_INVALID_FIELD = {
1116     .key = ILLEGAL_REQUEST, .asc = 0x24, .ascq = 0x00
1117 };
1118
1119 /* Illegal request, Invalid field in parameter list */
1120 const struct SCSISense sense_code_INVALID_PARAM = {
1121     .key = ILLEGAL_REQUEST, .asc = 0x26, .ascq = 0x00
1122 };
1123
1124 /* Illegal request, Parameter list length error */
1125 const struct SCSISense sense_code_INVALID_PARAM_LEN = {
1126     .key = ILLEGAL_REQUEST, .asc = 0x1a, .ascq = 0x00
1127 };
1128
1129 /* Illegal request, LUN not supported */
1130 const struct SCSISense sense_code_LUN_NOT_SUPPORTED = {
1131     .key = ILLEGAL_REQUEST, .asc = 0x25, .ascq = 0x00
1132 };
1133
1134 /* Illegal request, Saving parameters not supported */
1135 const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED = {
1136     .key = ILLEGAL_REQUEST, .asc = 0x39, .ascq = 0x00
1137 };
1138
1139 /* Illegal request, Incompatible medium installed */
1140 const struct SCSISense sense_code_INCOMPATIBLE_FORMAT = {
1141     .key = ILLEGAL_REQUEST, .asc = 0x30, .ascq = 0x00
1142 };
1143
1144 /* Illegal request, medium removal prevented */
1145 const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED = {
1146     .key = ILLEGAL_REQUEST, .asc = 0x53, .ascq = 0x00
1147 };
1148
1149 /* Command aborted, I/O process terminated */
1150 const struct SCSISense sense_code_IO_ERROR = {
1151     .key = ABORTED_COMMAND, .asc = 0x00, .ascq = 0x06
1152 };
1153
1154 /* Command aborted, I_T Nexus loss occurred */
1155 const struct SCSISense sense_code_I_T_NEXUS_LOSS = {
1156     .key = ABORTED_COMMAND, .asc = 0x29, .ascq = 0x07
1157 };
1158
1159 /* Command aborted, Logical Unit failure */
1160 const struct SCSISense sense_code_LUN_FAILURE = {
1161     .key = ABORTED_COMMAND, .asc = 0x3e, .ascq = 0x01
1162 };
1163
1164 /* Unit attention, Capacity data has changed */
1165 const struct SCSISense sense_code_CAPACITY_CHANGED = {
1166     .key = UNIT_ATTENTION, .asc = 0x2a, .ascq = 0x09
1167 };
1168
1169 /* Unit attention, Power on, reset or bus device reset occurred */
1170 const struct SCSISense sense_code_RESET = {
1171     .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x00
1172 };
1173
1174 /* Unit attention, No medium */
1175 const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM = {
1176     .key = UNIT_ATTENTION, .asc = 0x3a, .ascq = 0x00
1177 };
1178
1179 /* Unit attention, Medium may have changed */
1180 const struct SCSISense sense_code_MEDIUM_CHANGED = {
1181     .key = UNIT_ATTENTION, .asc = 0x28, .ascq = 0x00
1182 };
1183
1184 /* Unit attention, Reported LUNs data has changed */
1185 const struct SCSISense sense_code_REPORTED_LUNS_CHANGED = {
1186     .key = UNIT_ATTENTION, .asc = 0x3f, .ascq = 0x0e
1187 };
1188
1189 /* Unit attention, Device internal reset */
1190 const struct SCSISense sense_code_DEVICE_INTERNAL_RESET = {
1191     .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x04
1192 };
1193
1194 /* Data Protection, Write Protected */
1195 const struct SCSISense sense_code_WRITE_PROTECTED = {
1196     .key = DATA_PROTECT, .asc = 0x27, .ascq = 0x00
1197 };
1198
1199 /*
1200  * scsi_build_sense
1201  *
1202  * Convert between fixed and descriptor sense buffers
1203  */
1204 int scsi_build_sense(uint8_t *in_buf, int in_len,
1205                      uint8_t *buf, int len, bool fixed)
1206 {
1207     bool fixed_in;
1208     SCSISense sense;
1209     if (!fixed && len < 8) {
1210         return 0;
1211     }
1212
1213     if (in_len == 0) {
1214         sense.key = NO_SENSE;
1215         sense.asc = 0;
1216         sense.ascq = 0;
1217     } else {
1218         fixed_in = (in_buf[0] & 2) == 0;
1219
1220         if (fixed == fixed_in) {
1221             memcpy(buf, in_buf, MIN(len, in_len));
1222             return MIN(len, in_len);
1223         }
1224
1225         if (fixed_in) {
1226             sense.key = in_buf[2];
1227             sense.asc = in_buf[12];
1228             sense.ascq = in_buf[13];
1229         } else {
1230             sense.key = in_buf[1];
1231             sense.asc = in_buf[2];
1232             sense.ascq = in_buf[3];
1233         }
1234     }
1235
1236     memset(buf, 0, len);
1237     if (fixed) {
1238         /* Return fixed format sense buffer */
1239         buf[0] = 0x70;
1240         buf[2] = sense.key;
1241         buf[7] = 10;
1242         buf[12] = sense.asc;
1243         buf[13] = sense.ascq;
1244         return MIN(len, 18);
1245     } else {
1246         /* Return descriptor format sense buffer */
1247         buf[0] = 0x72;
1248         buf[1] = sense.key;
1249         buf[2] = sense.asc;
1250         buf[3] = sense.ascq;
1251         return 8;
1252     }
1253 }
1254
1255 static const char *scsi_command_name(uint8_t cmd)
1256 {
1257     static const char *names[] = {
1258         [ TEST_UNIT_READY          ] = "TEST_UNIT_READY",
1259         [ REWIND                   ] = "REWIND",
1260         [ REQUEST_SENSE            ] = "REQUEST_SENSE",
1261         [ FORMAT_UNIT              ] = "FORMAT_UNIT",
1262         [ READ_BLOCK_LIMITS        ] = "READ_BLOCK_LIMITS",
1263         [ REASSIGN_BLOCKS          ] = "REASSIGN_BLOCKS/INITIALIZE ELEMENT STATUS",
1264         /* LOAD_UNLOAD and INITIALIZE_ELEMENT_STATUS use the same operation code */
1265         [ READ_6                   ] = "READ_6",
1266         [ WRITE_6                  ] = "WRITE_6",
1267         [ SET_CAPACITY             ] = "SET_CAPACITY",
1268         [ READ_REVERSE             ] = "READ_REVERSE",
1269         [ WRITE_FILEMARKS          ] = "WRITE_FILEMARKS",
1270         [ SPACE                    ] = "SPACE",
1271         [ INQUIRY                  ] = "INQUIRY",
1272         [ RECOVER_BUFFERED_DATA    ] = "RECOVER_BUFFERED_DATA",
1273         [ MAINTENANCE_IN           ] = "MAINTENANCE_IN",
1274         [ MAINTENANCE_OUT          ] = "MAINTENANCE_OUT",
1275         [ MODE_SELECT              ] = "MODE_SELECT",
1276         [ RESERVE                  ] = "RESERVE",
1277         [ RELEASE                  ] = "RELEASE",
1278         [ COPY                     ] = "COPY",
1279         [ ERASE                    ] = "ERASE",
1280         [ MODE_SENSE               ] = "MODE_SENSE",
1281         [ START_STOP               ] = "START_STOP/LOAD_UNLOAD",
1282         /* LOAD_UNLOAD and START_STOP use the same operation code */
1283         [ RECEIVE_DIAGNOSTIC       ] = "RECEIVE_DIAGNOSTIC",
1284         [ SEND_DIAGNOSTIC          ] = "SEND_DIAGNOSTIC",
1285         [ ALLOW_MEDIUM_REMOVAL     ] = "ALLOW_MEDIUM_REMOVAL",
1286         [ READ_CAPACITY_10         ] = "READ_CAPACITY_10",
1287         [ READ_10                  ] = "READ_10",
1288         [ WRITE_10                 ] = "WRITE_10",
1289         [ SEEK_10                  ] = "SEEK_10/POSITION_TO_ELEMENT",
1290         /* SEEK_10 and POSITION_TO_ELEMENT use the same operation code */
1291         [ WRITE_VERIFY_10          ] = "WRITE_VERIFY_10",
1292         [ VERIFY_10                ] = "VERIFY_10",
1293         [ SEARCH_HIGH              ] = "SEARCH_HIGH",
1294         [ SEARCH_EQUAL             ] = "SEARCH_EQUAL",
1295         [ SEARCH_LOW               ] = "SEARCH_LOW",
1296         [ SET_LIMITS               ] = "SET_LIMITS",
1297         [ PRE_FETCH                ] = "PRE_FETCH/READ_POSITION",
1298         /* READ_POSITION and PRE_FETCH use the same operation code */
1299         [ SYNCHRONIZE_CACHE        ] = "SYNCHRONIZE_CACHE",
1300         [ LOCK_UNLOCK_CACHE        ] = "LOCK_UNLOCK_CACHE",
1301         [ READ_DEFECT_DATA         ] = "READ_DEFECT_DATA/INITIALIZE_ELEMENT_STATUS_WITH_RANGE",
1302         /* READ_DEFECT_DATA and INITIALIZE_ELEMENT_STATUS_WITH_RANGE use the same operation code */
1303         [ MEDIUM_SCAN              ] = "MEDIUM_SCAN",
1304         [ COMPARE                  ] = "COMPARE",
1305         [ COPY_VERIFY              ] = "COPY_VERIFY",
1306         [ WRITE_BUFFER             ] = "WRITE_BUFFER",
1307         [ READ_BUFFER              ] = "READ_BUFFER",
1308         [ UPDATE_BLOCK             ] = "UPDATE_BLOCK",
1309         [ READ_LONG_10             ] = "READ_LONG_10",
1310         [ WRITE_LONG_10            ] = "WRITE_LONG_10",
1311         [ CHANGE_DEFINITION        ] = "CHANGE_DEFINITION",
1312         [ WRITE_SAME_10            ] = "WRITE_SAME_10",
1313         [ UNMAP                    ] = "UNMAP",
1314         [ READ_TOC                 ] = "READ_TOC",
1315         [ REPORT_DENSITY_SUPPORT   ] = "REPORT_DENSITY_SUPPORT",
1316         [ SANITIZE                 ] = "SANITIZE",
1317         [ GET_CONFIGURATION        ] = "GET_CONFIGURATION",
1318         [ LOG_SELECT               ] = "LOG_SELECT",
1319         [ LOG_SENSE                ] = "LOG_SENSE",
1320         [ MODE_SELECT_10           ] = "MODE_SELECT_10",
1321         [ RESERVE_10               ] = "RESERVE_10",
1322         [ RELEASE_10               ] = "RELEASE_10",
1323         [ MODE_SENSE_10            ] = "MODE_SENSE_10",
1324         [ PERSISTENT_RESERVE_IN    ] = "PERSISTENT_RESERVE_IN",
1325         [ PERSISTENT_RESERVE_OUT   ] = "PERSISTENT_RESERVE_OUT",
1326         [ WRITE_FILEMARKS_16       ] = "WRITE_FILEMARKS_16",
1327         [ EXTENDED_COPY            ] = "EXTENDED_COPY",
1328         [ ATA_PASSTHROUGH          ] = "ATA_PASSTHROUGH",
1329         [ ACCESS_CONTROL_IN        ] = "ACCESS_CONTROL_IN",
1330         [ ACCESS_CONTROL_OUT       ] = "ACCESS_CONTROL_OUT",
1331         [ READ_16                  ] = "READ_16",
1332         [ COMPARE_AND_WRITE        ] = "COMPARE_AND_WRITE",
1333         [ WRITE_16                 ] = "WRITE_16",
1334         [ WRITE_VERIFY_16          ] = "WRITE_VERIFY_16",
1335         [ VERIFY_16                ] = "VERIFY_16",
1336         [ PRE_FETCH_16             ] = "PRE_FETCH_16",
1337         [ SYNCHRONIZE_CACHE_16     ] = "SPACE_16/SYNCHRONIZE_CACHE_16",
1338         /* SPACE_16 and SYNCHRONIZE_CACHE_16 use the same operation code */
1339         [ LOCATE_16                ] = "LOCATE_16",
1340         [ WRITE_SAME_16            ] = "ERASE_16/WRITE_SAME_16",
1341         /* ERASE_16 and WRITE_SAME_16 use the same operation code */
1342         [ SERVICE_ACTION_IN_16     ] = "SERVICE_ACTION_IN_16",
1343         [ WRITE_LONG_16            ] = "WRITE_LONG_16",
1344         [ REPORT_LUNS              ] = "REPORT_LUNS",
1345         [ BLANK                    ] = "BLANK",
1346         [ MOVE_MEDIUM              ] = "MOVE_MEDIUM",
1347         [ EXCHANGE_MEDIUM          ] = "EXCHANGE MEDIUM",
1348         [ LOAD_UNLOAD              ] = "LOAD_UNLOAD",
1349         [ READ_12                  ] = "READ_12",
1350         [ WRITE_12                 ] = "WRITE_12",
1351         [ ERASE_12                 ] = "ERASE_12/GET_PERFORMANCE",
1352         /* ERASE_12 and GET_PERFORMANCE use the same operation code */
1353         [ SERVICE_ACTION_IN_12     ] = "SERVICE_ACTION_IN_12",
1354         [ WRITE_VERIFY_12          ] = "WRITE_VERIFY_12",
1355         [ VERIFY_12                ] = "VERIFY_12",
1356         [ SEARCH_HIGH_12           ] = "SEARCH_HIGH_12",
1357         [ SEARCH_EQUAL_12          ] = "SEARCH_EQUAL_12",
1358         [ SEARCH_LOW_12            ] = "SEARCH_LOW_12",
1359         [ READ_ELEMENT_STATUS      ] = "READ_ELEMENT_STATUS",
1360         [ SEND_VOLUME_TAG          ] = "SEND_VOLUME_TAG/SET_STREAMING",
1361         /* SEND_VOLUME_TAG and SET_STREAMING use the same operation code */
1362         [ READ_CD                  ] = "READ_CD",
1363         [ READ_DEFECT_DATA_12      ] = "READ_DEFECT_DATA_12",
1364         [ READ_DVD_STRUCTURE       ] = "READ_DVD_STRUCTURE",
1365         [ RESERVE_TRACK            ] = "RESERVE_TRACK",
1366         [ SEND_CUE_SHEET           ] = "SEND_CUE_SHEET",
1367         [ SEND_DVD_STRUCTURE       ] = "SEND_DVD_STRUCTURE",
1368         [ SET_CD_SPEED             ] = "SET_CD_SPEED",
1369         [ SET_READ_AHEAD           ] = "SET_READ_AHEAD",
1370         [ ALLOW_OVERWRITE          ] = "ALLOW_OVERWRITE",
1371         [ MECHANISM_STATUS         ] = "MECHANISM_STATUS",
1372     };
1373
1374     if (cmd >= ARRAY_SIZE(names) || names[cmd] == NULL)
1375         return "*UNKNOWN*";
1376     return names[cmd];
1377 }
1378
1379 SCSIRequest *scsi_req_ref(SCSIRequest *req)
1380 {
1381     assert(req->refcount > 0);
1382     req->refcount++;
1383     return req;
1384 }
1385
1386 void scsi_req_unref(SCSIRequest *req)
1387 {
1388     assert(req->refcount > 0);
1389     if (--req->refcount == 0) {
1390         SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, req->dev->qdev.parent_bus);
1391         if (bus->info->free_request && req->hba_private) {
1392             bus->info->free_request(bus, req->hba_private);
1393         }
1394         if (req->ops->free_req) {
1395             req->ops->free_req(req);
1396         }
1397         g_free(req);
1398     }
1399 }
1400
1401 /* Tell the device that we finished processing this chunk of I/O.  It
1402    will start the next chunk or complete the command.  */
1403 void scsi_req_continue(SCSIRequest *req)
1404 {
1405     trace_scsi_req_continue(req->dev->id, req->lun, req->tag);
1406     if (req->cmd.mode == SCSI_XFER_TO_DEV) {
1407         req->ops->write_data(req);
1408     } else {
1409         req->ops->read_data(req);
1410     }
1411 }
1412
1413 /* Called by the devices when data is ready for the HBA.  The HBA should
1414    start a DMA operation to read or fill the device's data buffer.
1415    Once it completes, calling scsi_req_continue will restart I/O.  */
1416 void scsi_req_data(SCSIRequest *req, int len)
1417 {
1418     uint8_t *buf;
1419     if (req->io_canceled) {
1420         trace_scsi_req_data_canceled(req->dev->id, req->lun, req->tag, len);
1421         return;
1422     }
1423     trace_scsi_req_data(req->dev->id, req->lun, req->tag, len);
1424     assert(req->cmd.mode != SCSI_XFER_NONE);
1425     if (!req->sg) {
1426         req->resid -= len;
1427         req->bus->info->transfer_data(req, len);
1428         return;
1429     }
1430
1431     /* If the device calls scsi_req_data and the HBA specified a
1432      * scatter/gather list, the transfer has to happen in a single
1433      * step.  */
1434     assert(!req->dma_started);
1435     req->dma_started = true;
1436
1437     buf = scsi_req_get_buf(req);
1438     if (req->cmd.mode == SCSI_XFER_FROM_DEV) {
1439         req->resid = dma_buf_read(buf, len, req->sg);
1440     } else {
1441         req->resid = dma_buf_write(buf, len, req->sg);
1442     }
1443     scsi_req_continue(req);
1444 }
1445
1446 void scsi_req_print(SCSIRequest *req)
1447 {
1448     FILE *fp = stderr;
1449     int i;
1450
1451     fprintf(fp, "[%s id=%d] %s",
1452             req->dev->qdev.parent_bus->name,
1453             req->dev->id,
1454             scsi_command_name(req->cmd.buf[0]));
1455     for (i = 1; i < req->cmd.len; i++) {
1456         fprintf(fp, " 0x%02x", req->cmd.buf[i]);
1457     }
1458     switch (req->cmd.mode) {
1459     case SCSI_XFER_NONE:
1460         fprintf(fp, " - none\n");
1461         break;
1462     case SCSI_XFER_FROM_DEV:
1463         fprintf(fp, " - from-dev len=%zd\n", req->cmd.xfer);
1464         break;
1465     case SCSI_XFER_TO_DEV:
1466         fprintf(fp, " - to-dev len=%zd\n", req->cmd.xfer);
1467         break;
1468     default:
1469         fprintf(fp, " - Oops\n");
1470         break;
1471     }
1472 }
1473
1474 void scsi_req_complete(SCSIRequest *req, int status)
1475 {
1476     assert(req->status == -1);
1477     req->status = status;
1478
1479     assert(req->sense_len <= sizeof(req->sense));
1480     if (status == GOOD) {
1481         req->sense_len = 0;
1482     }
1483
1484     if (req->sense_len) {
1485         memcpy(req->dev->sense, req->sense, req->sense_len);
1486         req->dev->sense_len = req->sense_len;
1487         req->dev->sense_is_ua = (req->ops == &reqops_unit_attention);
1488     } else {
1489         req->dev->sense_len = 0;
1490         req->dev->sense_is_ua = false;
1491     }
1492
1493     /*
1494      * Unit attention state is now stored in the device's sense buffer
1495      * if the HBA didn't do autosense.  Clear the pending unit attention
1496      * flags.
1497      */
1498     scsi_clear_unit_attention(req);
1499
1500     scsi_req_ref(req);
1501     scsi_req_dequeue(req);
1502     req->bus->info->complete(req, req->status, req->resid);
1503     scsi_req_unref(req);
1504 }
1505
1506 void scsi_req_cancel(SCSIRequest *req)
1507 {
1508     trace_scsi_req_cancel(req->dev->id, req->lun, req->tag);
1509     if (!req->enqueued) {
1510         return;
1511     }
1512     scsi_req_ref(req);
1513     scsi_req_dequeue(req);
1514     req->io_canceled = true;
1515     if (req->ops->cancel_io) {
1516         req->ops->cancel_io(req);
1517     }
1518     if (req->bus->info->cancel) {
1519         req->bus->info->cancel(req);
1520     }
1521     scsi_req_unref(req);
1522 }
1523
1524 void scsi_req_abort(SCSIRequest *req, int status)
1525 {
1526     if (!req->enqueued) {
1527         return;
1528     }
1529     scsi_req_ref(req);
1530     scsi_req_dequeue(req);
1531     req->io_canceled = true;
1532     if (req->ops->cancel_io) {
1533         req->ops->cancel_io(req);
1534     }
1535     scsi_req_complete(req, status);
1536     scsi_req_unref(req);
1537 }
1538
1539 static int scsi_ua_precedence(SCSISense sense)
1540 {
1541     if (sense.key != UNIT_ATTENTION) {
1542         return INT_MAX;
1543     }
1544     if (sense.asc == 0x29 && sense.ascq == 0x04) {
1545         /* DEVICE INTERNAL RESET goes with POWER ON OCCURRED */
1546         return 1;
1547     } else if (sense.asc == 0x3F && sense.ascq == 0x01) {
1548         /* MICROCODE HAS BEEN CHANGED goes with SCSI BUS RESET OCCURRED */
1549         return 2;
1550     } else if (sense.asc == 0x29 && (sense.ascq == 0x05 || sense.ascq == 0x06)) {
1551         /* These two go with "all others". */
1552         ;
1553     } else if (sense.asc == 0x29 && sense.ascq <= 0x07) {
1554         /* POWER ON, RESET OR BUS DEVICE RESET OCCURRED = 0
1555          * POWER ON OCCURRED = 1
1556          * SCSI BUS RESET OCCURRED = 2
1557          * BUS DEVICE RESET FUNCTION OCCURRED = 3
1558          * I_T NEXUS LOSS OCCURRED = 7
1559          */
1560         return sense.ascq;
1561     } else if (sense.asc == 0x2F && sense.ascq == 0x01) {
1562         /* COMMANDS CLEARED BY POWER LOSS NOTIFICATION  */
1563         return 8;
1564     }
1565     return (sense.asc << 8) | sense.ascq;
1566 }
1567
1568 void scsi_device_set_ua(SCSIDevice *sdev, SCSISense sense)
1569 {
1570     int prec1, prec2;
1571     if (sense.key != UNIT_ATTENTION) {
1572         return;
1573     }
1574     trace_scsi_device_set_ua(sdev->id, sdev->lun, sense.key,
1575                              sense.asc, sense.ascq);
1576
1577     /*
1578      * Override a pre-existing unit attention condition, except for a more
1579      * important reset condition.
1580     */
1581     prec1 = scsi_ua_precedence(sdev->unit_attention);
1582     prec2 = scsi_ua_precedence(sense);
1583     if (prec2 < prec1) {
1584         sdev->unit_attention = sense;
1585     }
1586 }
1587
1588 void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense)
1589 {
1590     SCSIRequest *req;
1591
1592     while (!QTAILQ_EMPTY(&sdev->requests)) {
1593         req = QTAILQ_FIRST(&sdev->requests);
1594         scsi_req_cancel(req);
1595     }
1596
1597     scsi_device_set_ua(sdev, sense);
1598 }
1599
1600 static char *scsibus_get_dev_path(DeviceState *dev)
1601 {
1602     SCSIDevice *d = DO_UPCAST(SCSIDevice, qdev, dev);
1603     DeviceState *hba = dev->parent_bus->parent;
1604     char *id;
1605     char *path;
1606
1607     id = qdev_get_dev_path(hba);
1608     if (id) {
1609         path = g_strdup_printf("%s/%d:%d:%d", id, d->channel, d->id, d->lun);
1610     } else {
1611         path = g_strdup_printf("%d:%d:%d", d->channel, d->id, d->lun);
1612     }
1613     g_free(id);
1614     return path;
1615 }
1616
1617 static char *scsibus_get_fw_dev_path(DeviceState *dev)
1618 {
1619     SCSIDevice *d = SCSI_DEVICE(dev);
1620     char path[100];
1621
1622     snprintf(path, sizeof(path), "channel@%x/%s@%x,%x", d->channel,
1623              qdev_fw_name(dev), d->id, d->lun);
1624
1625     return strdup(path);
1626 }
1627
1628 SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int id, int lun)
1629 {
1630     BusChild *kid;
1631     SCSIDevice *target_dev = NULL;
1632
1633     QTAILQ_FOREACH_REVERSE(kid, &bus->qbus.children, ChildrenHead, sibling) {
1634         DeviceState *qdev = kid->child;
1635         SCSIDevice *dev = SCSI_DEVICE(qdev);
1636
1637         if (dev->channel == channel && dev->id == id) {
1638             if (dev->lun == lun) {
1639                 return dev;
1640             }
1641             target_dev = dev;
1642         }
1643     }
1644     return target_dev;
1645 }
1646
1647 /* SCSI request list.  For simplicity, pv points to the whole device */
1648
1649 static void put_scsi_requests(QEMUFile *f, void *pv, size_t size)
1650 {
1651     SCSIDevice *s = pv;
1652     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, s->qdev.parent_bus);
1653     SCSIRequest *req;
1654
1655     QTAILQ_FOREACH(req, &s->requests, next) {
1656         assert(!req->io_canceled);
1657         assert(req->status == -1);
1658         assert(req->enqueued);
1659
1660         qemu_put_sbyte(f, req->retry ? 1 : 2);
1661         qemu_put_buffer(f, req->cmd.buf, sizeof(req->cmd.buf));
1662         qemu_put_be32s(f, &req->tag);
1663         qemu_put_be32s(f, &req->lun);
1664         if (bus->info->save_request) {
1665             bus->info->save_request(f, req);
1666         }
1667         if (req->ops->save_request) {
1668             req->ops->save_request(f, req);
1669         }
1670     }
1671     qemu_put_sbyte(f, 0);
1672 }
1673
1674 static int get_scsi_requests(QEMUFile *f, void *pv, size_t size)
1675 {
1676     SCSIDevice *s = pv;
1677     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, s->qdev.parent_bus);
1678     int8_t sbyte;
1679
1680     while ((sbyte = qemu_get_sbyte(f)) > 0) {
1681         uint8_t buf[SCSI_CMD_BUF_SIZE];
1682         uint32_t tag;
1683         uint32_t lun;
1684         SCSIRequest *req;
1685
1686         qemu_get_buffer(f, buf, sizeof(buf));
1687         qemu_get_be32s(f, &tag);
1688         qemu_get_be32s(f, &lun);
1689         req = scsi_req_new(s, tag, lun, buf, NULL);
1690         req->retry = (sbyte == 1);
1691         if (bus->info->load_request) {
1692             req->hba_private = bus->info->load_request(f, req);
1693         }
1694         if (req->ops->load_request) {
1695             req->ops->load_request(f, req);
1696         }
1697
1698         /* Just restart it later.  */
1699         scsi_req_enqueue_internal(req);
1700
1701         /* At this point, the request will be kept alive by the reference
1702          * added by scsi_req_enqueue_internal, so we can release our reference.
1703          * The HBA of course will add its own reference in the load_request
1704          * callback if it needs to hold on the SCSIRequest.
1705          */
1706         scsi_req_unref(req);
1707     }
1708
1709     return 0;
1710 }
1711
1712 static int scsi_qdev_unplug(DeviceState *qdev)
1713 {
1714     SCSIDevice *dev = SCSI_DEVICE(qdev);
1715     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
1716
1717     if (bus->info->hot_unplug) {
1718         bus->info->hot_unplug(bus, dev);
1719     }
1720     return qdev_simple_unplug_cb(qdev);
1721 }
1722
1723 static const VMStateInfo vmstate_info_scsi_requests = {
1724     .name = "scsi-requests",
1725     .get  = get_scsi_requests,
1726     .put  = put_scsi_requests,
1727 };
1728
1729 const VMStateDescription vmstate_scsi_device = {
1730     .name = "SCSIDevice",
1731     .version_id = 1,
1732     .minimum_version_id = 1,
1733     .minimum_version_id_old = 1,
1734     .fields = (VMStateField[]) {
1735         VMSTATE_UINT8(unit_attention.key, SCSIDevice),
1736         VMSTATE_UINT8(unit_attention.asc, SCSIDevice),
1737         VMSTATE_UINT8(unit_attention.ascq, SCSIDevice),
1738         VMSTATE_BOOL(sense_is_ua, SCSIDevice),
1739         VMSTATE_UINT8_ARRAY(sense, SCSIDevice, SCSI_SENSE_BUF_SIZE),
1740         VMSTATE_UINT32(sense_len, SCSIDevice),
1741         {
1742             .name         = "requests",
1743             .version_id   = 0,
1744             .field_exists = NULL,
1745             .size         = 0,   /* ouch */
1746             .info         = &vmstate_info_scsi_requests,
1747             .flags        = VMS_SINGLE,
1748             .offset       = 0,
1749         },
1750         VMSTATE_END_OF_LIST()
1751     }
1752 };
1753
1754 static void scsi_device_class_init(ObjectClass *klass, void *data)
1755 {
1756     DeviceClass *k = DEVICE_CLASS(klass);
1757     k->bus_type = TYPE_SCSI_BUS;
1758     k->init     = scsi_qdev_init;
1759     k->unplug   = scsi_qdev_unplug;
1760     k->exit     = scsi_qdev_exit;
1761     k->props    = scsi_props;
1762 }
1763
1764 static TypeInfo scsi_device_type_info = {
1765     .name = TYPE_SCSI_DEVICE,
1766     .parent = TYPE_DEVICE,
1767     .instance_size = sizeof(SCSIDevice),
1768     .abstract = true,
1769     .class_size = sizeof(SCSIDeviceClass),
1770     .class_init = scsi_device_class_init,
1771 };
1772
1773 static void scsi_register_types(void)
1774 {
1775     type_register_static(&scsi_bus_info);
1776     type_register_static(&scsi_device_type_info);
1777 }
1778
1779 type_init(scsi_register_types)