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 err:
 190     return rc;
 191 }
 192
 193 static int scsi_qdev_exit(DeviceState *qdev)
 194 {
 195     SCSIDevice *dev = SCSI_DEVICE(qdev);
 196
 197     if (dev->vmsentry) {
 198         qemu_del_vm_change_state_handler(dev->vmsentry);
 199     }
 200     scsi_device_destroy(dev);
 201     return 0;
 202 }
 203
 204 /* handle legacy '-drive if=scsi,...' cmd line args */
 205 SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockDriverState *bdrv,
 206                                       int unit, bool removable, int bootindex)
 207 {
 208     const char *driver;
 209     DeviceState *dev;
 210
 211     driver = bdrv_is_sg(bdrv) ? "scsi-generic" : "scsi-disk";
 212     dev = qdev_create(&bus->qbus, driver);
 213     qdev_prop_set_uint32(dev, "scsi-id", unit);
 214     if (bootindex >= 0) {
 215         qdev_prop_set_int32(dev, "bootindex", bootindex);
 216     }
 217     if (qdev_prop_exists(dev, "removable")) {
 218         qdev_prop_set_bit(dev, "removable", removable);
 219     }
 220     if (qdev_prop_set_drive(dev, "drive", bdrv) < 0) {
 221         qdev_free(dev);
 222         return NULL;
 223     }
 224     if (qdev_init(dev) < 0)
 225         return NULL;
 226     return SCSI_DEVICE(dev);
 227 }
 228
 229 int scsi_bus_legacy_handle_cmdline(SCSIBus *bus)
 230 {
 231     Location loc;
 232     DriveInfo *dinfo;
 233     int res = 0, unit;
 234
 235     loc_push_none(&loc);
 236     for (unit = 0; unit <= bus->info->max_target; unit++) {
 237         dinfo = drive_get(IF_SCSI, bus->busnr, unit);
 238         if (dinfo == NULL) {
 239             continue;
 240         }
 241         qemu_opts_loc_restore(dinfo->opts);
 242         if (!scsi_bus_legacy_add_drive(bus, dinfo->bdrv, unit, false, -1)) {
 243             res = -1;
 244             break;
 245         }
 246     }
 247     loc_pop(&loc);
 248     return res;
 249 }
 250
 251 static int32_t scsi_invalid_field(SCSIRequest *req, uint8_t *buf)
 252 {
 253     scsi_req_build_sense(req, SENSE_CODE(INVALID_FIELD));
 254     scsi_req_complete(req, CHECK_CONDITION);
 255     return 0;
 256 }
 257
 258 static const struct SCSIReqOps reqops_invalid_field = {
 259     .size         = sizeof(SCSIRequest),
 260     .send_command = scsi_invalid_field
 261 };
 262
 263 /* SCSIReqOps implementation for invalid commands.  */
 264
 265 static int32_t scsi_invalid_command(SCSIRequest *req, uint8_t *buf)
 266 {
 267     scsi_req_build_sense(req, SENSE_CODE(INVALID_OPCODE));
 268     scsi_req_complete(req, CHECK_CONDITION);
 269     return 0;
 270 }
 271
 272 static const struct SCSIReqOps reqops_invalid_opcode = {
 273     .size         = sizeof(SCSIRequest),
 274     .send_command = scsi_invalid_command
 275 };
 276
 277 /* SCSIReqOps implementation for unit attention conditions.  */
 278
 279 static int32_t scsi_unit_attention(SCSIRequest *req, uint8_t *buf)
 280 {
 281     if (req->dev && req->dev->unit_attention.key == UNIT_ATTENTION) {
 282         scsi_req_build_sense(req, req->dev->unit_attention);
 283     } else if (req->bus->unit_attention.key == UNIT_ATTENTION) {
 284         scsi_req_build_sense(req, req->bus->unit_attention);
 285     }
 286     scsi_req_complete(req, CHECK_CONDITION);
 287     return 0;
 288 }
 289
 290 static const struct SCSIReqOps reqops_unit_attention = {
 291     .size         = sizeof(SCSIRequest),
 292     .send_command = scsi_unit_attention
 293 };
 294
 295 /* SCSIReqOps implementation for REPORT LUNS and for commands sent to
 296    an invalid LUN.  */
 297
 298 typedef struct SCSITargetReq SCSITargetReq;
 299
 300 struct SCSITargetReq {
 301     SCSIRequest req;
 302     int len;
 303     uint8_t buf[2056];
 304 };
 305
 306 static void store_lun(uint8_t *outbuf, int lun)
 307 {
 308     if (lun < 256) {
 309         outbuf[1] = lun;
 310         return;
 311     }
 312     outbuf[1] = (lun & 255);
 313     outbuf[0] = (lun >> 8) | 0x40;
 314 }
 315
 316 static bool scsi_target_emulate_report_luns(SCSITargetReq *r)
 317 {
 318     DeviceState *qdev;
 319     int i, len, n;
 320     int channel, id;
 321     bool found_lun0;
 322
 323     if (r->req.cmd.xfer < 16) {
 324         return false;
 325     }
 326     if (r->req.cmd.buf[2] > 2) {
 327         return false;
 328     }
 329     channel = r->req.dev->channel;
 330     id = r->req.dev->id;
 331     found_lun0 = false;
 332     n = 0;
 333     QTAILQ_FOREACH(qdev, &r->req.bus->qbus.children, sibling) {
 334         SCSIDevice *dev = SCSI_DEVICE(qdev);
 335
 336         if (dev->channel == channel && dev->id == id) {
 337             if (dev->lun == 0) {
 338                 found_lun0 = true;
 339             }
 340             n += 8;
 341         }
 342     }
 343     if (!found_lun0) {
 344         n += 8;
 345     }
 346     len = MIN(n + 8, r->req.cmd.xfer & ~7);
 347     if (len > sizeof(r->buf)) {
 348         /* TODO: > 256 LUNs? */
 349         return false;
 350     }
 351
 352     memset(r->buf, 0, len);
 353     stl_be_p(&r->buf, n);
 354     i = found_lun0 ? 8 : 16;
 355     QTAILQ_FOREACH(qdev, &r->req.bus->qbus.children, sibling) {
 356         SCSIDevice *dev = SCSI_DEVICE(qdev);
 357
 358         if (dev->channel == channel && dev->id == id) {
 359             store_lun(&r->buf[i], dev->lun);
 360             i += 8;
 361         }
 362     }
 363     assert(i == n + 8);
 364     r->len = len;
 365     return true;
 366 }
 367
 368 static bool scsi_target_emulate_inquiry(SCSITargetReq *r)
 369 {
 370     assert(r->req.dev->lun != r->req.lun);
 371     if (r->req.cmd.buf[1] & 0x2) {
 372         /* Command support data - optional, not implemented */
 373         return false;
 374     }
 375
 376     if (r->req.cmd.buf[1] & 0x1) {
 377         /* Vital product data */
 378         uint8_t page_code = r->req.cmd.buf[2];
 379         r->buf[r->len++] = page_code ; /* this page */
 380         r->buf[r->len++] = 0x00;
 381
 382         switch (page_code) {
 383         case 0x00: /* Supported page codes, mandatory */
 384         {
 385             int pages;
 386             pages = r->len++;
 387             r->buf[r->len++] = 0x00; /* list of supported pages (this page) */
 388             r->buf[pages] = r->len - pages - 1; /* number of pages */
 389             break;
 390         }
 391         default:
 392             return false;
 393         }
 394         /* done with EVPD */
 395         assert(r->len < sizeof(r->buf));
 396         r->len = MIN(r->req.cmd.xfer, r->len);
 397         return true;
 398     }
 399
 400     /* Standard INQUIRY data */
 401     if (r->req.cmd.buf[2] != 0) {
 402         return false;
 403     }
 404
 405     /* PAGE CODE == 0 */
 406     r->len = MIN(r->req.cmd.xfer, 36);
 407     memset(r->buf, 0, r->len);
 408     if (r->req.lun != 0) {
 409         r->buf[0] = TYPE_NO_LUN;
 410     } else {
 411         r->buf[0] = TYPE_NOT_PRESENT | TYPE_INACTIVE;
 412         r->buf[2] = 5; /* Version */
 413         r->buf[3] = 2 | 0x10; /* HiSup, response data format */
 414         r->buf[4] = r->len - 5; /* Additional Length = (Len - 1) - 4 */
 415         r->buf[7] = 0x10 | (r->req.bus->info->tcq ? 0x02 : 0); /* Sync, TCQ.  */
 416         memcpy(&r->buf[8], "QEMU    ", 8);
 417         memcpy(&r->buf[16], "QEMU TARGET     ", 16);
 418         strncpy((char *) &r->buf[32], QEMU_VERSION, 4);
 419     }
 420     return true;
 421 }
 422
 423 static int32_t scsi_target_send_command(SCSIRequest *req, uint8_t *buf)
 424 {
 425     SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
 426
 427     switch (buf[0]) {
 428     case REPORT_LUNS:
 429         if (!scsi_target_emulate_report_luns(r)) {
 430             goto illegal_request;
 431         }
 432         break;
 433     case INQUIRY:
 434         if (!scsi_target_emulate_inquiry(r)) {
 435             goto illegal_request;
 436         }
 437         break;
 438     case REQUEST_SENSE:
 439         r->len = scsi_device_get_sense(r->req.dev, r->buf,
 440                                        MIN(req->cmd.xfer, sizeof r->buf),
 441                                        (req->cmd.buf[1] & 1) == 0);
 442         if (r->req.dev->sense_is_ua) {
 443             scsi_device_unit_attention_reported(req->dev);
 444             r->req.dev->sense_len = 0;
 445             r->req.dev->sense_is_ua = false;
 446         }
 447         break;
 448     default:
 449         scsi_req_build_sense(req, SENSE_CODE(LUN_NOT_SUPPORTED));
 450         scsi_req_complete(req, CHECK_CONDITION);
 451         return 0;
 452     illegal_request:
 453         scsi_req_build_sense(req, SENSE_CODE(INVALID_FIELD));
 454         scsi_req_complete(req, CHECK_CONDITION);
 455         return 0;
 456     }
 457
 458     if (!r->len) {
 459         scsi_req_complete(req, GOOD);
 460     }
 461     return r->len;
 462 }
 463
 464 static void scsi_target_read_data(SCSIRequest *req)
 465 {
 466     SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
 467     uint32_t n;
 468
 469     n = r->len;
 470     if (n > 0) {
 471         r->len = 0;
 472         scsi_req_data(&r->req, n);
 473     } else {
 474         scsi_req_complete(&r->req, GOOD);
 475     }
 476 }
 477
 478 static uint8_t *scsi_target_get_buf(SCSIRequest *req)
 479 {
 480     SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
 481
 482     return r->buf;
 483 }
 484
 485 static const struct SCSIReqOps reqops_target_command = {
 486     .size         = sizeof(SCSITargetReq),
 487     .send_command = scsi_target_send_command,
 488     .read_data    = scsi_target_read_data,
 489     .get_buf      = scsi_target_get_buf,
 490 };
 491
 492
 493 SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d,
 494                             uint32_t tag, uint32_t lun, void *hba_private)
 495 {
 496     SCSIRequest *req;
 497
 498     req = g_malloc0(reqops->size);
 499     req->refcount = 1;
 500     req->bus = scsi_bus_from_device(d);
 501     req->dev = d;
 502     req->tag = tag;
 503     req->lun = lun;
 504     req->hba_private = hba_private;
 505     req->status = -1;
 506     req->sense_len = 0;
 507     req->ops = reqops;
 508     trace_scsi_req_alloc(req->dev->id, req->lun, req->tag);
 509     return req;
 510 }
 511
 512 SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun,
 513                           uint8_t *buf, void *hba_private)
 514 {
 515     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
 516     SCSIRequest *req;
 517     SCSICommand cmd;
 518
 519     if (scsi_req_parse(&cmd, d, buf) != 0) {
 520         trace_scsi_req_parse_bad(d->id, lun, tag, buf[0]);
 521         req = scsi_req_alloc(&reqops_invalid_opcode, d, tag, lun, hba_private);
 522     } else {
 523         trace_scsi_req_parsed(d->id, lun, tag, buf[0],
 524                               cmd.mode, cmd.xfer);
 525         if (cmd.lba != -1) {
 526             trace_scsi_req_parsed_lba(d->id, lun, tag, buf[0],
 527                                       cmd.lba);
 528         }
 529
 530         if (cmd.xfer > INT32_MAX) {
 531             req = scsi_req_alloc(&reqops_invalid_field, d, tag, lun, hba_private);
 532         } else if ((d->unit_attention.key == UNIT_ATTENTION ||
 533                    bus->unit_attention.key == UNIT_ATTENTION) &&
 534                   (buf[0] != INQUIRY &&
 535                    buf[0] != REPORT_LUNS &&
 536                    buf[0] != GET_CONFIGURATION &&
 537                    buf[0] != GET_EVENT_STATUS_NOTIFICATION &&
 538
 539                    /*
 540                     * If we already have a pending unit attention condition,
 541                     * report this one before triggering another one.
 542                     */
 543                    !(buf[0] == REQUEST_SENSE && d->sense_is_ua))) {
 544             req = scsi_req_alloc(&reqops_unit_attention, d, tag, lun,
 545                                  hba_private);
 546         } else if (lun != d->lun ||
 547                    buf[0] == REPORT_LUNS ||
 548                    (buf[0] == REQUEST_SENSE && d->sense_len)) {
 549             req = scsi_req_alloc(&reqops_target_command, d, tag, lun,
 550                                  hba_private);
 551         } else {
 552             req = scsi_device_alloc_req(d, tag, lun, buf, hba_private);
 553         }
 554     }
 555
 556     req->cmd = cmd;
 557     req->resid = req->cmd.xfer;
 558
 559     switch (buf[0]) {
 560     case INQUIRY:
 561         trace_scsi_inquiry(d->id, lun, tag, cmd.buf[1], cmd.buf[2]);
 562         break;
 563     case TEST_UNIT_READY:
 564         trace_scsi_test_unit_ready(d->id, lun, tag);
 565         break;
 566     case REPORT_LUNS:
 567         trace_scsi_report_luns(d->id, lun, tag);
 568         break;
 569     case REQUEST_SENSE:
 570         trace_scsi_request_sense(d->id, lun, tag);
 571         break;
 572     default:
 573         break;
 574     }
 575
 576     return req;
 577 }
 578
 579 uint8_t *scsi_req_get_buf(SCSIRequest *req)
 580 {
 581     return req->ops->get_buf(req);
 582 }
 583
 584 static void scsi_clear_unit_attention(SCSIRequest *req)
 585 {
 586     SCSISense *ua;
 587     if (req->dev->unit_attention.key != UNIT_ATTENTION &&
 588         req->bus->unit_attention.key != UNIT_ATTENTION) {
 589         return;
 590     }
 591
 592     /*
 593      * If an INQUIRY command enters the enabled command state,
 594      * the device server shall [not] clear any unit attention condition;
 595      * See also MMC-6, paragraphs 6.5 and 6.6.2.
 596      */
 597     if (req->cmd.buf[0] == INQUIRY ||
 598         req->cmd.buf[0] == GET_CONFIGURATION ||
 599         req->cmd.buf[0] == GET_EVENT_STATUS_NOTIFICATION) {
 600         return;
 601     }
 602
 603     if (req->dev->unit_attention.key == UNIT_ATTENTION) {
 604         ua = &req->dev->unit_attention;
 605     } else {
 606         ua = &req->bus->unit_attention;
 607     }
 608
 609     /*
 610      * If a REPORT LUNS command enters the enabled command state, [...]
 611      * the device server shall clear any pending unit attention condition
 612      * with an additional sense code of REPORTED LUNS DATA HAS CHANGED.
 613      */
 614     if (req->cmd.buf[0] == REPORT_LUNS &&
 615         !(ua->asc == SENSE_CODE(REPORTED_LUNS_CHANGED).asc &&
 616           ua->ascq == SENSE_CODE(REPORTED_LUNS_CHANGED).ascq)) {
 617         return;
 618     }
 619
 620     *ua = SENSE_CODE(NO_SENSE);
 621 }
 622
 623 int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len)
 624 {
 625     int ret;
 626
 627     assert(len >= 14);
 628     if (!req->sense_len) {
 629         return 0;
 630     }
 631
 632     ret = scsi_build_sense(req->sense, req->sense_len, buf, len, true);
 633
 634     /*
 635      * FIXME: clearing unit attention conditions upon autosense should be done
 636      * only if the UA_INTLCK_CTRL field in the Control mode page is set to 00b
 637      * (SAM-5, 5.14).
 638      *
 639      * We assume UA_INTLCK_CTRL to be 00b for HBAs that support autosense, and
 640      * 10b for HBAs that do not support it (do not call scsi_req_get_sense).
 641      * Here we handle unit attention clearing for UA_INTLCK_CTRL == 00b.
 642      */
 643     if (req->dev->sense_is_ua) {
 644         scsi_device_unit_attention_reported(req->dev);
 645         req->dev->sense_len = 0;
 646         req->dev->sense_is_ua = false;
 647     }
 648     return ret;
 649 }
 650
 651 int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed)
 652 {
 653     return scsi_build_sense(dev->sense, dev->sense_len, buf, len, fixed);
 654 }
 655
 656 void scsi_req_build_sense(SCSIRequest *req, SCSISense sense)
 657 {
 658     trace_scsi_req_build_sense(req->dev->id, req->lun, req->tag,
 659                                sense.key, sense.asc, sense.ascq);
 660     memset(req->sense, 0, 18);
 661     req->sense[0] = 0x70;
 662     req->sense[2] = sense.key;
 663     req->sense[7] = 10;
 664     req->sense[12] = sense.asc;
 665     req->sense[13] = sense.ascq;
 666     req->sense_len = 18;
 667 }
 668
 669 static void scsi_req_enqueue_internal(SCSIRequest *req)
 670 {
 671     assert(!req->enqueued);
 672     scsi_req_ref(req);
 673     if (req->bus->info->get_sg_list) {
 674         req->sg = req->bus->info->get_sg_list(req);
 675     } else {
 676         req->sg = NULL;
 677     }
 678     req->enqueued = true;
 679     QTAILQ_INSERT_TAIL(&req->dev->requests, req, next);
 680 }
 681
 682 int32_t scsi_req_enqueue(SCSIRequest *req)
 683 {
 684     int32_t rc;
 685
 686     assert(!req->retry);
 687     scsi_req_enqueue_internal(req);
 688     scsi_req_ref(req);
 689     rc = req->ops->send_command(req, req->cmd.buf);
 690     scsi_req_unref(req);
 691     return rc;
 692 }
 693
 694 static void scsi_req_dequeue(SCSIRequest *req)
 695 {
 696     trace_scsi_req_dequeue(req->dev->id, req->lun, req->tag);
 697     req->retry = false;
 698     if (req->enqueued) {
 699         QTAILQ_REMOVE(&req->dev->requests, req, next);
 700         req->enqueued = false;
 701         scsi_req_unref(req);
 702     }
 703 }
 704
 705 static int scsi_get_performance_length(int num_desc, int type, int data_type)
 706 {
 707     /* MMC-6, paragraph 6.7.  */
 708     switch (type) {
 709     case 0:
 710         if ((data_type & 3) == 0) {
 711             /* Each descriptor is as in Table 295 - Nominal performance.  */
 712             return 16 * num_desc + 8;
 713         } else {
 714             /* Each descriptor is as in Table 296 - Exceptions.  */
 715             return 6 * num_desc + 8;
 716         }
 717     case 1:
 718     case 4:
 719     case 5:
 720         return 8 * num_desc + 8;
 721     case 2:
 722         return 2048 * num_desc + 8;
 723     case 3:
 724         return 16 * num_desc + 8;
 725     default:
 726         return 8;
 727     }
 728 }
 729
 730 static int scsi_req_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
 731 {
 732     switch (buf[0] >> 5) {
 733     case 0:
 734         cmd->xfer = buf[4];
 735         cmd->len = 6;
 736         break;
 737     case 1:
 738     case 2:
 739         cmd->xfer = lduw_be_p(&buf[7]);
 740         cmd->len = 10;
 741         break;
 742     case 4:
 743         cmd->xfer = ldl_be_p(&buf[10]) & 0xffffffffULL;
 744         cmd->len = 16;
 745         break;
 746     case 5:
 747         cmd->xfer = ldl_be_p(&buf[6]) & 0xffffffffULL;
 748         cmd->len = 12;
 749         break;
 750     default:
 751         return -1;
 752     }
 753
 754     switch (buf[0]) {
 755     case TEST_UNIT_READY:
 756     case REWIND:
 757     case START_STOP:
 758     case SET_CAPACITY:
 759     case WRITE_FILEMARKS:
 760     case WRITE_FILEMARKS_16:
 761     case SPACE:
 762     case RESERVE:
 763     case RELEASE:
 764     case ERASE:
 765     case ALLOW_MEDIUM_REMOVAL:
 766     case VERIFY_10:
 767     case SEEK_10:
 768     case SYNCHRONIZE_CACHE:
 769     case SYNCHRONIZE_CACHE_16:
 770     case LOCATE_16:
 771     case LOCK_UNLOCK_CACHE:
 772     case LOAD_UNLOAD:
 773     case SET_CD_SPEED:
 774     case SET_LIMITS:
 775     case WRITE_LONG_10:
 776     case MOVE_MEDIUM:
 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->len = 6;
 887         cmd->xfer = buf[4] | (buf[3] << 8) | (buf[2] << 16);
 888         if (buf[1] & 0x01) { /* fixed */
 889             cmd->xfer *= dev->blocksize;
 890         }
 891         break;
 892     case READ_16:
 893     case READ_REVERSE_16:
 894     case VERIFY_16:
 895     case WRITE_16:
 896         cmd->len = 16;
 897         cmd->xfer = buf[14] | (buf[13] << 8) | (buf[12] << 16);
 898         if (buf[1] & 0x01) { /* fixed */
 899             cmd->xfer *= dev->blocksize;
 900         }
 901         break;
 902     case REWIND:
 903     case START_STOP:
 904         cmd->len = 6;
 905         cmd->xfer = 0;
 906         break;
 907     case SPACE_16:
 908         cmd->xfer = buf[13] | (buf[12] << 8);
 909         break;
 910     case READ_POSITION:
 911         cmd->xfer = buf[8] | (buf[7] << 8);
 912         break;
 913     case FORMAT_UNIT:
 914         cmd->xfer = buf[4] | (buf[3] << 8);
 915         break;
 916     /* generic commands */
 917     default:
 918         return scsi_req_length(cmd, dev, buf);
 919     }
 920     return 0;
 921 }
 922
 923 static void scsi_cmd_xfer_mode(SCSICommand *cmd)
 924 {
 925     if (!cmd->xfer) {
 926         cmd->mode = SCSI_XFER_NONE;
 927         return;
 928     }
 929     switch (cmd->buf[0]) {
 930     case WRITE_6:
 931     case WRITE_10:
 932     case WRITE_VERIFY_10:
 933     case WRITE_12:
 934     case WRITE_VERIFY_12:
 935     case WRITE_16:
 936     case WRITE_VERIFY_16:
 937     case COPY:
 938     case COPY_VERIFY:
 939     case COMPARE:
 940     case CHANGE_DEFINITION:
 941     case LOG_SELECT:
 942     case MODE_SELECT:
 943     case MODE_SELECT_10:
 944     case SEND_DIAGNOSTIC:
 945     case WRITE_BUFFER:
 946     case FORMAT_UNIT:
 947     case REASSIGN_BLOCKS:
 948     case SEARCH_EQUAL:
 949     case SEARCH_HIGH:
 950     case SEARCH_LOW:
 951     case UPDATE_BLOCK:
 952     case WRITE_LONG_10:
 953     case WRITE_SAME_10:
 954     case WRITE_SAME_16:
 955     case UNMAP:
 956     case SEARCH_HIGH_12:
 957     case SEARCH_EQUAL_12:
 958     case SEARCH_LOW_12:
 959     case MEDIUM_SCAN:
 960     case SEND_VOLUME_TAG:
 961     case SEND_CUE_SHEET:
 962     case SEND_DVD_STRUCTURE:
 963     case PERSISTENT_RESERVE_OUT:
 964     case MAINTENANCE_OUT:
 965     case ATA_PASSTHROUGH:
 966         cmd->mode = SCSI_XFER_TO_DEV;
 967         break;
 968     default:
 969         cmd->mode = SCSI_XFER_FROM_DEV;
 970         break;
 971     }
 972 }
 973
 974 static uint64_t scsi_cmd_lba(SCSICommand *cmd)
 975 {
 976     uint8_t *buf = cmd->buf;
 977     uint64_t lba;
 978
 979     switch (buf[0] >> 5) {
 980     case 0:
 981         lba = ldl_be_p(&buf[0]) & 0x1fffff;
 982         break;
 983     case 1:
 984     case 2:
 985     case 5:
 986         lba = ldl_be_p(&buf[2]) & 0xffffffffULL;
 987         break;
 988     case 4:
 989         lba = ldq_be_p(&buf[2]);
 990         break;
 991     default:
 992         lba = -1;
 993
 994     }
 995     return lba;
 996 }
 997
 998 int scsi_req_parse(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
 999 {
1000     int rc;
1001
1002     if (dev->type == TYPE_TAPE) {
1003         rc = scsi_req_stream_length(cmd, dev, buf);
1004     } else {
1005         rc = scsi_req_length(cmd, dev, buf);
1006     }
1007     if (rc != 0)
1008         return rc;
1009
1010     memcpy(cmd->buf, buf, cmd->len);
1011     scsi_cmd_xfer_mode(cmd);
1012     cmd->lba = scsi_cmd_lba(cmd);
1013     return 0;
1014 }
1015
1016 /*
1017  * Predefined sense codes
1018  */
1019
1020 /* No sense data available */
1021 const struct SCSISense sense_code_NO_SENSE = {
1022     .key = NO_SENSE , .asc = 0x00 , .ascq = 0x00
1023 };
1024
1025 /* LUN not ready, Manual intervention required */
1026 const struct SCSISense sense_code_LUN_NOT_READY = {
1027     .key = NOT_READY, .asc = 0x04, .ascq = 0x03
1028 };
1029
1030 /* LUN not ready, Medium not present */
1031 const struct SCSISense sense_code_NO_MEDIUM = {
1032     .key = NOT_READY, .asc = 0x3a, .ascq = 0x00
1033 };
1034
1035 /* LUN not ready, medium removal prevented */
1036 const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED = {
1037     .key = NOT_READY, .asc = 0x53, .ascq = 0x00
1038 };
1039
1040 /* Hardware error, internal target failure */
1041 const struct SCSISense sense_code_TARGET_FAILURE = {
1042     .key = HARDWARE_ERROR, .asc = 0x44, .ascq = 0x00
1043 };
1044
1045 /* Illegal request, invalid command operation code */
1046 const struct SCSISense sense_code_INVALID_OPCODE = {
1047     .key = ILLEGAL_REQUEST, .asc = 0x20, .ascq = 0x00
1048 };
1049
1050 /* Illegal request, LBA out of range */
1051 const struct SCSISense sense_code_LBA_OUT_OF_RANGE = {
1052     .key = ILLEGAL_REQUEST, .asc = 0x21, .ascq = 0x00
1053 };
1054
1055 /* Illegal request, Invalid field in CDB */
1056 const struct SCSISense sense_code_INVALID_FIELD = {
1057     .key = ILLEGAL_REQUEST, .asc = 0x24, .ascq = 0x00
1058 };
1059
1060 /* Illegal request, LUN not supported */
1061 const struct SCSISense sense_code_LUN_NOT_SUPPORTED = {
1062     .key = ILLEGAL_REQUEST, .asc = 0x25, .ascq = 0x00
1063 };
1064
1065 /* Illegal request, Saving parameters not supported */
1066 const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED = {
1067     .key = ILLEGAL_REQUEST, .asc = 0x39, .ascq = 0x00
1068 };
1069
1070 /* Illegal request, Incompatible medium installed */
1071 const struct SCSISense sense_code_INCOMPATIBLE_FORMAT = {
1072     .key = ILLEGAL_REQUEST, .asc = 0x30, .ascq = 0x00
1073 };
1074
1075 /* Illegal request, medium removal prevented */
1076 const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED = {
1077     .key = ILLEGAL_REQUEST, .asc = 0x53, .ascq = 0x00
1078 };
1079
1080 /* Command aborted, I/O process terminated */
1081 const struct SCSISense sense_code_IO_ERROR = {
1082     .key = ABORTED_COMMAND, .asc = 0x00, .ascq = 0x06
1083 };
1084
1085 /* Command aborted, I_T Nexus loss occurred */
1086 const struct SCSISense sense_code_I_T_NEXUS_LOSS = {
1087     .key = ABORTED_COMMAND, .asc = 0x29, .ascq = 0x07
1088 };
1089
1090 /* Command aborted, Logical Unit failure */
1091 const struct SCSISense sense_code_LUN_FAILURE = {
1092     .key = ABORTED_COMMAND, .asc = 0x3e, .ascq = 0x01
1093 };
1094
1095 /* Unit attention, Power on, reset or bus device reset occurred */
1096 const struct SCSISense sense_code_RESET = {
1097     .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x00
1098 };
1099
1100 /* Unit attention, No medium */
1101 const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM = {
1102     .key = UNIT_ATTENTION, .asc = 0x3a, .ascq = 0x00
1103 };
1104
1105 /* Unit attention, Medium may have changed */
1106 const struct SCSISense sense_code_MEDIUM_CHANGED = {
1107     .key = UNIT_ATTENTION, .asc = 0x28, .ascq = 0x00
1108 };
1109
1110 /* Unit attention, Reported LUNs data has changed */
1111 const struct SCSISense sense_code_REPORTED_LUNS_CHANGED = {
1112     .key = UNIT_ATTENTION, .asc = 0x3f, .ascq = 0x0e
1113 };
1114
1115 /* Unit attention, Device internal reset */
1116 const struct SCSISense sense_code_DEVICE_INTERNAL_RESET = {
1117     .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x04
1118 };
1119
1120 /*
1121  * scsi_build_sense
1122  *
1123  * Convert between fixed and descriptor sense buffers
1124  */
1125 int scsi_build_sense(uint8_t *in_buf, int in_len,
1126                      uint8_t *buf, int len, bool fixed)
1127 {
1128     bool fixed_in;
1129     SCSISense sense;
1130     if (!fixed && len < 8) {
1131         return 0;
1132     }
1133
1134     if (in_len == 0) {
1135         sense.key = NO_SENSE;
1136         sense.asc = 0;
1137         sense.ascq = 0;
1138     } else {
1139         fixed_in = (in_buf[0] & 2) == 0;
1140
1141         if (fixed == fixed_in) {
1142             memcpy(buf, in_buf, MIN(len, in_len));
1143             return MIN(len, in_len);
1144         }
1145
1146         if (fixed_in) {
1147             sense.key = in_buf[2];
1148             sense.asc = in_buf[12];
1149             sense.ascq = in_buf[13];
1150         } else {
1151             sense.key = in_buf[1];
1152             sense.asc = in_buf[2];
1153             sense.ascq = in_buf[3];
1154         }
1155     }
1156
1157     memset(buf, 0, len);
1158     if (fixed) {
1159         /* Return fixed format sense buffer */
1160         buf[0] = 0x70;
1161         buf[2] = sense.key;
1162         buf[7] = 10;
1163         buf[12] = sense.asc;
1164         buf[13] = sense.ascq;
1165         return MIN(len, 18);
1166     } else {
1167         /* Return descriptor format sense buffer */
1168         buf[0] = 0x72;
1169         buf[1] = sense.key;
1170         buf[2] = sense.asc;
1171         buf[3] = sense.ascq;
1172         return 8;
1173     }
1174 }
1175
1176 static const char *scsi_command_name(uint8_t cmd)
1177 {
1178     static const char *names[] = {
1179         [ TEST_UNIT_READY          ] = "TEST_UNIT_READY",
1180         [ REWIND                   ] = "REWIND",
1181         [ REQUEST_SENSE            ] = "REQUEST_SENSE",
1182         [ FORMAT_UNIT              ] = "FORMAT_UNIT",
1183         [ READ_BLOCK_LIMITS        ] = "READ_BLOCK_LIMITS",
1184         [ REASSIGN_BLOCKS          ] = "REASSIGN_BLOCKS",
1185         [ READ_6                   ] = "READ_6",
1186         [ WRITE_6                  ] = "WRITE_6",
1187         [ SET_CAPACITY             ] = "SET_CAPACITY",
1188         [ READ_REVERSE             ] = "READ_REVERSE",
1189         [ WRITE_FILEMARKS          ] = "WRITE_FILEMARKS",
1190         [ SPACE                    ] = "SPACE",
1191         [ INQUIRY                  ] = "INQUIRY",
1192         [ RECOVER_BUFFERED_DATA    ] = "RECOVER_BUFFERED_DATA",
1193         [ MAINTENANCE_IN           ] = "MAINTENANCE_IN",
1194         [ MAINTENANCE_OUT          ] = "MAINTENANCE_OUT",
1195         [ MODE_SELECT              ] = "MODE_SELECT",
1196         [ RESERVE                  ] = "RESERVE",
1197         [ RELEASE                  ] = "RELEASE",
1198         [ COPY                     ] = "COPY",
1199         [ ERASE                    ] = "ERASE",
1200         [ MODE_SENSE               ] = "MODE_SENSE",
1201         [ START_STOP               ] = "START_STOP",
1202         [ RECEIVE_DIAGNOSTIC       ] = "RECEIVE_DIAGNOSTIC",
1203         [ SEND_DIAGNOSTIC          ] = "SEND_DIAGNOSTIC",
1204         [ ALLOW_MEDIUM_REMOVAL     ] = "ALLOW_MEDIUM_REMOVAL",
1205         [ READ_CAPACITY_10         ] = "READ_CAPACITY_10",
1206         [ READ_10                  ] = "READ_10",
1207         [ WRITE_10                 ] = "WRITE_10",
1208         [ SEEK_10                  ] = "SEEK_10",
1209         [ WRITE_VERIFY_10          ] = "WRITE_VERIFY_10",
1210         [ VERIFY_10                ] = "VERIFY_10",
1211         [ SEARCH_HIGH              ] = "SEARCH_HIGH",
1212         [ SEARCH_EQUAL             ] = "SEARCH_EQUAL",
1213         [ SEARCH_LOW               ] = "SEARCH_LOW",
1214         [ SET_LIMITS               ] = "SET_LIMITS",
1215         [ PRE_FETCH                ] = "PRE_FETCH/READ_POSITION",
1216         /* READ_POSITION and PRE_FETCH use the same operation code */
1217         [ SYNCHRONIZE_CACHE        ] = "SYNCHRONIZE_CACHE",
1218         [ LOCK_UNLOCK_CACHE        ] = "LOCK_UNLOCK_CACHE",
1219         [ READ_DEFECT_DATA         ] = "READ_DEFECT_DATA",
1220         [ MEDIUM_SCAN              ] = "MEDIUM_SCAN",
1221         [ COMPARE                  ] = "COMPARE",
1222         [ COPY_VERIFY              ] = "COPY_VERIFY",
1223         [ WRITE_BUFFER             ] = "WRITE_BUFFER",
1224         [ READ_BUFFER              ] = "READ_BUFFER",
1225         [ UPDATE_BLOCK             ] = "UPDATE_BLOCK",
1226         [ READ_LONG_10             ] = "READ_LONG_10",
1227         [ WRITE_LONG_10            ] = "WRITE_LONG_10",
1228         [ CHANGE_DEFINITION        ] = "CHANGE_DEFINITION",
1229         [ WRITE_SAME_10            ] = "WRITE_SAME_10",
1230         [ UNMAP                    ] = "UNMAP",
1231         [ READ_TOC                 ] = "READ_TOC",
1232         [ REPORT_DENSITY_SUPPORT   ] = "REPORT_DENSITY_SUPPORT",
1233         [ SANITIZE                 ] = "SANITIZE",
1234         [ GET_CONFIGURATION        ] = "GET_CONFIGURATION",
1235         [ LOG_SELECT               ] = "LOG_SELECT",
1236         [ LOG_SENSE                ] = "LOG_SENSE",
1237         [ MODE_SELECT_10           ] = "MODE_SELECT_10",
1238         [ RESERVE_10               ] = "RESERVE_10",
1239         [ RELEASE_10               ] = "RELEASE_10",
1240         [ MODE_SENSE_10            ] = "MODE_SENSE_10",
1241         [ PERSISTENT_RESERVE_IN    ] = "PERSISTENT_RESERVE_IN",
1242         [ PERSISTENT_RESERVE_OUT   ] = "PERSISTENT_RESERVE_OUT",
1243         [ WRITE_FILEMARKS_16       ] = "WRITE_FILEMARKS_16",
1244         [ EXTENDED_COPY            ] = "EXTENDED_COPY",
1245         [ ATA_PASSTHROUGH          ] = "ATA_PASSTHROUGH",
1246         [ ACCESS_CONTROL_IN        ] = "ACCESS_CONTROL_IN",
1247         [ ACCESS_CONTROL_OUT       ] = "ACCESS_CONTROL_OUT",
1248         [ READ_16                  ] = "READ_16",
1249         [ COMPARE_AND_WRITE        ] = "COMPARE_AND_WRITE",
1250         [ WRITE_16                 ] = "WRITE_16",
1251         [ WRITE_VERIFY_16          ] = "WRITE_VERIFY_16",
1252         [ VERIFY_16                ] = "VERIFY_16",
1253         [ PRE_FETCH_16             ] = "PRE_FETCH_16",
1254         [ SYNCHRONIZE_CACHE_16     ] = "SPACE_16/SYNCHRONIZE_CACHE_16",
1255         /* SPACE_16 and SYNCHRONIZE_CACHE_16 use the same operation code */
1256         [ LOCATE_16                ] = "LOCATE_16",
1257         [ WRITE_SAME_16            ] = "ERASE_16/WRITE_SAME_16",
1258         /* ERASE_16 and WRITE_SAME_16 use the same operation code */
1259         [ SERVICE_ACTION_IN_16     ] = "SERVICE_ACTION_IN_16",
1260         [ WRITE_LONG_16            ] = "WRITE_LONG_16",
1261         [ REPORT_LUNS              ] = "REPORT_LUNS",
1262         [ BLANK                    ] = "BLANK",
1263         [ MOVE_MEDIUM              ] = "MOVE_MEDIUM",
1264         [ LOAD_UNLOAD              ] = "LOAD_UNLOAD",
1265         [ READ_12                  ] = "READ_12",
1266         [ WRITE_12                 ] = "WRITE_12",
1267         [ ERASE_12                 ] = "ERASE_12/GET_PERFORMANCE",
1268         /* ERASE_12 and GET_PERFORMANCE use the same operation code */
1269         [ SERVICE_ACTION_IN_12     ] = "SERVICE_ACTION_IN_12",
1270         [ WRITE_VERIFY_12          ] = "WRITE_VERIFY_12",
1271         [ VERIFY_12                ] = "VERIFY_12",
1272         [ SEARCH_HIGH_12           ] = "SEARCH_HIGH_12",
1273         [ SEARCH_EQUAL_12          ] = "SEARCH_EQUAL_12",
1274         [ SEARCH_LOW_12            ] = "SEARCH_LOW_12",
1275         [ READ_ELEMENT_STATUS      ] = "READ_ELEMENT_STATUS",
1276         [ SEND_VOLUME_TAG          ] = "SEND_VOLUME_TAG/SET_STREAMING",
1277         /* SEND_VOLUME_TAG and SET_STREAMING use the same operation code */
1278         [ READ_CD                  ] = "READ_CD",
1279         [ READ_DEFECT_DATA_12      ] = "READ_DEFECT_DATA_12",
1280         [ READ_DVD_STRUCTURE       ] = "READ_DVD_STRUCTURE",
1281         [ RESERVE_TRACK            ] = "RESERVE_TRACK",
1282         [ SEND_CUE_SHEET           ] = "SEND_CUE_SHEET",
1283         [ SEND_DVD_STRUCTURE       ] = "SEND_DVD_STRUCTURE",
1284         [ SET_CD_SPEED             ] = "SET_CD_SPEED",
1285         [ SET_READ_AHEAD           ] = "SET_READ_AHEAD",
1286         [ ALLOW_OVERWRITE          ] = "ALLOW_OVERWRITE",
1287         [ MECHANISM_STATUS         ] = "MECHANISM_STATUS",
1288     };
1289
1290     if (cmd >= ARRAY_SIZE(names) || names[cmd] == NULL)
1291         return "*UNKNOWN*";
1292     return names[cmd];
1293 }
1294
1295 SCSIRequest *scsi_req_ref(SCSIRequest *req)
1296 {
1297     req->refcount++;
1298     return req;
1299 }
1300
1301 void scsi_req_unref(SCSIRequest *req)
1302 {
1303     assert(req->refcount > 0);
1304     if (--req->refcount == 0) {
1305         if (req->ops->free_req) {
1306             req->ops->free_req(req);
1307         }
1308         g_free(req);
1309     }
1310 }
1311
1312 /* Tell the device that we finished processing this chunk of I/O.  It
1313    will start the next chunk or complete the command.  */
1314 void scsi_req_continue(SCSIRequest *req)
1315 {
1316     trace_scsi_req_continue(req->dev->id, req->lun, req->tag);
1317     if (req->cmd.mode == SCSI_XFER_TO_DEV) {
1318         req->ops->write_data(req);
1319     } else {
1320         req->ops->read_data(req);
1321     }
1322 }
1323
1324 /* Called by the devices when data is ready for the HBA.  The HBA should
1325    start a DMA operation to read or fill the device's data buffer.
1326    Once it completes, calling scsi_req_continue will restart I/O.  */
1327 void scsi_req_data(SCSIRequest *req, int len)
1328 {
1329     uint8_t *buf;
1330     if (req->io_canceled) {
1331         trace_scsi_req_data_canceled(req->dev->id, req->lun, req->tag, len);
1332         return;
1333     }
1334     trace_scsi_req_data(req->dev->id, req->lun, req->tag, len);
1335     assert(req->cmd.mode != SCSI_XFER_NONE);
1336     if (!req->sg) {
1337         req->resid -= len;
1338         req->bus->info->transfer_data(req, len);
1339         return;
1340     }
1341
1342     /* If the device calls scsi_req_data and the HBA specified a
1343      * scatter/gather list, the transfer has to happen in a single
1344      * step.  */
1345     assert(!req->dma_started);
1346     req->dma_started = true;
1347
1348     buf = scsi_req_get_buf(req);
1349     if (req->cmd.mode == SCSI_XFER_FROM_DEV) {
1350         req->resid = dma_buf_read(buf, len, req->sg);
1351     } else {
1352         req->resid = dma_buf_write(buf, len, req->sg);
1353     }
1354     scsi_req_continue(req);
1355 }
1356
1357 void scsi_req_print(SCSIRequest *req)
1358 {
1359     FILE *fp = stderr;
1360     int i;
1361
1362     fprintf(fp, "[%s id=%d] %s",
1363             req->dev->qdev.parent_bus->name,
1364             req->dev->id,
1365             scsi_command_name(req->cmd.buf[0]));
1366     for (i = 1; i < req->cmd.len; i++) {
1367         fprintf(fp, " 0x%02x", req->cmd.buf[i]);
1368     }
1369     switch (req->cmd.mode) {
1370     case SCSI_XFER_NONE:
1371         fprintf(fp, " - none\n");
1372         break;
1373     case SCSI_XFER_FROM_DEV:
1374         fprintf(fp, " - from-dev len=%zd\n", req->cmd.xfer);
1375         break;
1376     case SCSI_XFER_TO_DEV:
1377         fprintf(fp, " - to-dev len=%zd\n", req->cmd.xfer);
1378         break;
1379     default:
1380         fprintf(fp, " - Oops\n");
1381         break;
1382     }
1383 }
1384
1385 void scsi_req_complete(SCSIRequest *req, int status)
1386 {
1387     assert(req->status == -1);
1388     req->status = status;
1389
1390     assert(req->sense_len < sizeof(req->sense));
1391     if (status == GOOD) {
1392         req->sense_len = 0;
1393     }
1394
1395     if (req->sense_len) {
1396         memcpy(req->dev->sense, req->sense, req->sense_len);
1397         req->dev->sense_len = req->sense_len;
1398         req->dev->sense_is_ua = (req->ops == &reqops_unit_attention);
1399     } else {
1400         req->dev->sense_len = 0;
1401         req->dev->sense_is_ua = false;
1402     }
1403
1404     /*
1405      * Unit attention state is now stored in the device's sense buffer
1406      * if the HBA didn't do autosense.  Clear the pending unit attention
1407      * flags.
1408      */
1409     scsi_clear_unit_attention(req);
1410
1411     scsi_req_ref(req);
1412     scsi_req_dequeue(req);
1413     req->bus->info->complete(req, req->status, req->resid);
1414     scsi_req_unref(req);
1415 }
1416
1417 void scsi_req_cancel(SCSIRequest *req)
1418 {
1419     if (!req->enqueued) {
1420         return;
1421     }
1422     scsi_req_ref(req);
1423     scsi_req_dequeue(req);
1424     req->io_canceled = true;
1425     if (req->ops->cancel_io) {
1426         req->ops->cancel_io(req);
1427     }
1428     if (req->bus->info->cancel) {
1429         req->bus->info->cancel(req);
1430     }
1431     scsi_req_unref(req);
1432 }
1433
1434 void scsi_req_abort(SCSIRequest *req, int status)
1435 {
1436     if (!req->enqueued) {
1437         return;
1438     }
1439     scsi_req_ref(req);
1440     scsi_req_dequeue(req);
1441     req->io_canceled = true;
1442     if (req->ops->cancel_io) {
1443         req->ops->cancel_io(req);
1444     }
1445     scsi_req_complete(req, status);
1446     scsi_req_unref(req);
1447 }
1448
1449 void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense)
1450 {
1451     SCSIRequest *req;
1452
1453     while (!QTAILQ_EMPTY(&sdev->requests)) {
1454         req = QTAILQ_FIRST(&sdev->requests);
1455         scsi_req_cancel(req);
1456     }
1457     sdev->unit_attention = sense;
1458 }
1459
1460 static char *scsibus_get_dev_path(DeviceState *dev)
1461 {
1462     SCSIDevice *d = DO_UPCAST(SCSIDevice, qdev, dev);
1463     DeviceState *hba = dev->parent_bus->parent;
1464     char *id;
1465     char *path;
1466
1467     id = qdev_get_dev_path(hba);
1468     if (id) {
1469         path = g_strdup_printf("%s/%d:%d:%d", id, d->channel, d->id, d->lun);
1470     } else {
1471         path = g_strdup_printf("%d:%d:%d", d->channel, d->id, d->lun);
1472     }
1473     g_free(id);
1474     return path;
1475 }
1476
1477 static char *scsibus_get_fw_dev_path(DeviceState *dev)
1478 {
1479     SCSIDevice *d = SCSI_DEVICE(dev);
1480     char path[100];
1481
1482     snprintf(path, sizeof(path), "channel@%x/%s@%x,%x", d->channel,
1483              qdev_fw_name(dev), d->id, d->lun);
1484
1485     return strdup(path);
1486 }
1487
1488 SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int id, int lun)
1489 {
1490     DeviceState *qdev;
1491     SCSIDevice *target_dev = NULL;
1492
1493     QTAILQ_FOREACH_REVERSE(qdev, &bus->qbus.children, ChildrenHead, sibling) {
1494         SCSIDevice *dev = SCSI_DEVICE(qdev);
1495
1496         if (dev->channel == channel && dev->id == id) {
1497             if (dev->lun == lun) {
1498                 return dev;
1499             }
1500             target_dev = dev;
1501         }
1502     }
1503     return target_dev;
1504 }
1505
1506 /* SCSI request list.  For simplicity, pv points to the whole device */
1507
1508 static void put_scsi_requests(QEMUFile *f, void *pv, size_t size)
1509 {
1510     SCSIDevice *s = pv;
1511     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, s->qdev.parent_bus);
1512     SCSIRequest *req;
1513
1514     QTAILQ_FOREACH(req, &s->requests, next) {
1515         assert(!req->io_canceled);
1516         assert(req->status == -1);
1517         assert(req->enqueued);
1518
1519         qemu_put_sbyte(f, req->retry ? 1 : 2);
1520         qemu_put_buffer(f, req->cmd.buf, sizeof(req->cmd.buf));
1521         qemu_put_be32s(f, &req->tag);
1522         qemu_put_be32s(f, &req->lun);
1523         if (bus->info->save_request) {
1524             bus->info->save_request(f, req);
1525         }
1526         if (req->ops->save_request) {
1527             req->ops->save_request(f, req);
1528         }
1529     }
1530     qemu_put_sbyte(f, 0);
1531 }
1532
1533 static int get_scsi_requests(QEMUFile *f, void *pv, size_t size)
1534 {
1535     SCSIDevice *s = pv;
1536     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, s->qdev.parent_bus);
1537     int8_t sbyte;
1538
1539     while ((sbyte = qemu_get_sbyte(f)) > 0) {
1540         uint8_t buf[SCSI_CMD_BUF_SIZE];
1541         uint32_t tag;
1542         uint32_t lun;
1543         SCSIRequest *req;
1544
1545         qemu_get_buffer(f, buf, sizeof(buf));
1546         qemu_get_be32s(f, &tag);
1547         qemu_get_be32s(f, &lun);
1548         req = scsi_req_new(s, tag, lun, buf, NULL);
1549         req->retry = (sbyte == 1);
1550         if (bus->info->load_request) {
1551             req->hba_private = bus->info->load_request(f, req);
1552         }
1553         if (req->ops->load_request) {
1554             req->ops->load_request(f, req);
1555         }
1556
1557         /* Just restart it later.  */
1558         scsi_req_enqueue_internal(req);
1559
1560         /* At this point, the request will be kept alive by the reference
1561          * added by scsi_req_enqueue_internal, so we can release our reference.
1562          * The HBA of course will add its own reference in the load_request
1563          * callback if it needs to hold on the SCSIRequest.
1564          */
1565         scsi_req_unref(req);
1566     }
1567
1568     return 0;
1569 }
1570
1571 static const VMStateInfo vmstate_info_scsi_requests = {
1572     .name = "scsi-requests",
1573     .get  = get_scsi_requests,
1574     .put  = put_scsi_requests,
1575 };
1576
1577 const VMStateDescription vmstate_scsi_device = {
1578     .name = "SCSIDevice",
1579     .version_id = 1,
1580     .minimum_version_id = 1,
1581     .minimum_version_id_old = 1,
1582     .fields = (VMStateField[]) {
1583         VMSTATE_UINT8(unit_attention.key, SCSIDevice),
1584         VMSTATE_UINT8(unit_attention.asc, SCSIDevice),
1585         VMSTATE_UINT8(unit_attention.ascq, SCSIDevice),
1586         VMSTATE_BOOL(sense_is_ua, SCSIDevice),
1587         VMSTATE_UINT8_ARRAY(sense, SCSIDevice, SCSI_SENSE_BUF_SIZE),
1588         VMSTATE_UINT32(sense_len, SCSIDevice),
1589         {
1590             .name         = "requests",
1591             .version_id   = 0,
1592             .field_exists = NULL,
1593             .size         = 0,   /* ouch */
1594             .info         = &vmstate_info_scsi_requests,
1595             .flags        = VMS_SINGLE,
1596             .offset       = 0,
1597         },
1598         VMSTATE_END_OF_LIST()
1599     }
1600 };
1601
1602 static void scsi_device_class_init(ObjectClass *klass, void *data)
1603 {
1604     DeviceClass *k = DEVICE_CLASS(klass);
1605     k->bus_type = TYPE_SCSI_BUS;
1606     k->init     = scsi_qdev_init;
1607     k->unplug   = qdev_simple_unplug_cb;
1608     k->exit     = scsi_qdev_exit;
1609     k->props    = scsi_props;
1610 }
1611
1612 static TypeInfo scsi_device_type_info = {
1613     .name = TYPE_SCSI_DEVICE,
1614     .parent = TYPE_DEVICE,
1615     .instance_size = sizeof(SCSIDevice),
1616     .abstract = true,
1617     .class_size = sizeof(SCSIDeviceClass),
1618     .class_init = scsi_device_class_init,
1619 };
1620
1621 static void scsi_register_types(void)
1622 {
1623     type_register_static(&scsi_bus_info);
1624     type_register_static(&scsi_device_type_info);
1625 }
1626
1627 type_init(scsi_register_types)