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