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
   9 static char *scsibus_get_fw_dev_path(DeviceState *dev);
  10 static int scsi_build_sense(uint8_t *in_buf, int in_len,
  11                             uint8_t *buf, int len, bool fixed);
  12
  13 static struct BusInfo scsi_bus_info = {
  14     .name  = "SCSI",
  15     .size  = sizeof(SCSIBus),
  16     .get_fw_dev_path = scsibus_get_fw_dev_path,
  17     .props = (Property[]) {
  18         DEFINE_PROP_UINT32("scsi-id", SCSIDevice, id, -1),
  19         DEFINE_PROP_UINT32("lun", SCSIDevice, lun, 0),
  20         DEFINE_PROP_END_OF_LIST(),
  21     },
  22 };
  23 static int next_scsi_bus;
  24
  25 /* Create a scsi bus, and attach devices to it.  */
  26 void scsi_bus_new(SCSIBus *bus, DeviceState *host, int tcq, int ndev,
  27                   const SCSIBusOps *ops)
  28 {
  29     qbus_create_inplace(&bus->qbus, &scsi_bus_info, host, NULL);
  30     bus->busnr = next_scsi_bus++;
  31     bus->tcq = tcq;
  32     bus->ndev = ndev;
  33     bus->ops = ops;
  34     bus->qbus.allow_hotplug = 1;
  35 }
  36
  37 static int scsi_qdev_init(DeviceState *qdev, DeviceInfo *base)
  38 {
  39     SCSIDevice *dev = DO_UPCAST(SCSIDevice, qdev, qdev);
  40     SCSIDeviceInfo *info = DO_UPCAST(SCSIDeviceInfo, qdev, base);
  41     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
  42     int rc = -1;
  43
  44     if (dev->id == -1) {
  45         for (dev->id = 0; dev->id < bus->ndev; dev->id++) {
  46             if (bus->devs[dev->id] == NULL)
  47                 break;
  48         }
  49     }
  50     if (dev->id >= bus->ndev) {
  51         error_report("bad scsi device id: %d", dev->id);
  52         goto err;
  53     }
  54
  55     if (bus->devs[dev->id]) {
  56         qdev_free(&bus->devs[dev->id]->qdev);
  57     }
  58     bus->devs[dev->id] = dev;
  59
  60     dev->info = info;
  61     QTAILQ_INIT(&dev->requests);
  62     rc = dev->info->init(dev);
  63     if (rc != 0) {
  64         bus->devs[dev->id] = NULL;
  65     }
  66
  67 err:
  68     return rc;
  69 }
  70
  71 static int scsi_qdev_exit(DeviceState *qdev)
  72 {
  73     SCSIDevice *dev = DO_UPCAST(SCSIDevice, qdev, qdev);
  74     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
  75
  76     assert(bus->devs[dev->id] != NULL);
  77     if (bus->devs[dev->id]->info->destroy) {
  78         bus->devs[dev->id]->info->destroy(bus->devs[dev->id]);
  79     }
  80     bus->devs[dev->id] = NULL;
  81     return 0;
  82 }
  83
  84 void scsi_qdev_register(SCSIDeviceInfo *info)
  85 {
  86     info->qdev.bus_info = &scsi_bus_info;
  87     info->qdev.init     = scsi_qdev_init;
  88     info->qdev.unplug   = qdev_simple_unplug_cb;
  89     info->qdev.exit     = scsi_qdev_exit;
  90     qdev_register(&info->qdev);
  91 }
  92
  93 /* handle legacy '-drive if=scsi,...' cmd line args */
  94 SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockDriverState *bdrv,
  95                                       int unit, bool removable)
  96 {
  97     const char *driver;
  98     DeviceState *dev;
  99
 100     driver = bdrv_is_sg(bdrv) ? "scsi-generic" : "scsi-disk";
 101     dev = qdev_create(&bus->qbus, driver);
 102     qdev_prop_set_uint32(dev, "scsi-id", unit);
 103     if (qdev_prop_exists(dev, "removable")) {
 104         qdev_prop_set_bit(dev, "removable", removable);
 105     }
 106     if (qdev_prop_set_drive(dev, "drive", bdrv) < 0) {
 107         qdev_free(dev);
 108         return NULL;
 109     }
 110     if (qdev_init(dev) < 0)
 111         return NULL;
 112     return DO_UPCAST(SCSIDevice, qdev, dev);
 113 }
 114
 115 int scsi_bus_legacy_handle_cmdline(SCSIBus *bus)
 116 {
 117     Location loc;
 118     DriveInfo *dinfo;
 119     int res = 0, unit;
 120
 121     loc_push_none(&loc);
 122     for (unit = 0; unit < bus->ndev; unit++) {
 123         dinfo = drive_get(IF_SCSI, bus->busnr, unit);
 124         if (dinfo == NULL) {
 125             continue;
 126         }
 127         qemu_opts_loc_restore(dinfo->opts);
 128         if (!scsi_bus_legacy_add_drive(bus, dinfo->bdrv, unit, false)) {
 129             res = -1;
 130             break;
 131         }
 132     }
 133     loc_pop(&loc);
 134     return res;
 135 }
 136
 137 SCSIRequest *scsi_req_alloc(SCSIReqOps *reqops, SCSIDevice *d, uint32_t tag,
 138                             uint32_t lun, void *hba_private)
 139 {
 140     SCSIRequest *req;
 141
 142     req = qemu_mallocz(reqops->size);
 143     req->refcount = 1;
 144     req->bus = scsi_bus_from_device(d);
 145     req->dev = d;
 146     req->tag = tag;
 147     req->lun = lun;
 148     req->hba_private = hba_private;
 149     req->status = -1;
 150     req->sense_len = 0;
 151     req->ops = reqops;
 152     trace_scsi_req_alloc(req->dev->id, req->lun, req->tag);
 153     return req;
 154 }
 155
 156 SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun,
 157                           uint8_t *buf, void *hba_private)
 158 {
 159     SCSIRequest *req;
 160     req = d->info->alloc_req(d, tag, lun, hba_private);
 161     memcpy(req->cmd.buf, buf, 16);
 162     return req;
 163 }
 164
 165 uint8_t *scsi_req_get_buf(SCSIRequest *req)
 166 {
 167     return req->ops->get_buf(req);
 168 }
 169
 170 int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len)
 171 {
 172     assert(len >= 14);
 173     if (!req->sense_len) {
 174         return 0;
 175     }
 176     return scsi_build_sense(req->sense, req->sense_len, buf, len, true);
 177 }
 178
 179 int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed)
 180 {
 181     return scsi_build_sense(dev->sense, dev->sense_len, buf, len, fixed);
 182 }
 183
 184 void scsi_req_build_sense(SCSIRequest *req, SCSISense sense)
 185 {
 186     trace_scsi_req_build_sense(req->dev->id, req->lun, req->tag,
 187                                sense.key, sense.asc, sense.ascq);
 188     memset(req->sense, 0, 18);
 189     req->sense[0] = 0xf0;
 190     req->sense[2] = sense.key;
 191     req->sense[12] = sense.asc;
 192     req->sense[13] = sense.ascq;
 193     req->sense_len = 18;
 194 }
 195
 196 int32_t scsi_req_enqueue(SCSIRequest *req)
 197 {
 198     int32_t rc;
 199
 200     assert(!req->enqueued);
 201     scsi_req_ref(req);
 202     req->enqueued = true;
 203     QTAILQ_INSERT_TAIL(&req->dev->requests, req, next);
 204
 205     scsi_req_ref(req);
 206     rc = req->ops->send_command(req, req->cmd.buf);
 207     scsi_req_unref(req);
 208     return rc;
 209 }
 210
 211 static void scsi_req_dequeue(SCSIRequest *req)
 212 {
 213     trace_scsi_req_dequeue(req->dev->id, req->lun, req->tag);
 214     if (req->enqueued) {
 215         QTAILQ_REMOVE(&req->dev->requests, req, next);
 216         req->enqueued = false;
 217         scsi_req_unref(req);
 218     }
 219 }
 220
 221 static int scsi_req_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
 222 {
 223     switch (buf[0] >> 5) {
 224     case 0:
 225         cmd->xfer = buf[4];
 226         cmd->len = 6;
 227         /* length 0 means 256 blocks */
 228         if (cmd->xfer == 0) {
 229             cmd->xfer = 256;
 230         }
 231         break;
 232     case 1:
 233     case 2:
 234         cmd->xfer = buf[8] | (buf[7] << 8);
 235         cmd->len = 10;
 236         break;
 237     case 4:
 238         cmd->xfer = buf[13] | (buf[12] << 8) | (buf[11] << 16) | (buf[10] << 24);
 239         cmd->len = 16;
 240         break;
 241     case 5:
 242         cmd->xfer = buf[9] | (buf[8] << 8) | (buf[7] << 16) | (buf[6] << 24);
 243         cmd->len = 12;
 244         break;
 245     default:
 246         return -1;
 247     }
 248
 249     switch (buf[0]) {
 250     case TEST_UNIT_READY:
 251     case REWIND:
 252     case START_STOP:
 253     case SEEK_6:
 254     case WRITE_FILEMARKS:
 255     case SPACE:
 256     case RESERVE:
 257     case RELEASE:
 258     case ERASE:
 259     case ALLOW_MEDIUM_REMOVAL:
 260     case VERIFY_10:
 261     case SEEK_10:
 262     case SYNCHRONIZE_CACHE:
 263     case LOCK_UNLOCK_CACHE:
 264     case LOAD_UNLOAD:
 265     case SET_CD_SPEED:
 266     case SET_LIMITS:
 267     case WRITE_LONG_10:
 268     case MOVE_MEDIUM:
 269     case UPDATE_BLOCK:
 270         cmd->xfer = 0;
 271         break;
 272     case MODE_SENSE:
 273         break;
 274     case WRITE_SAME_10:
 275         cmd->xfer = 1;
 276         break;
 277     case READ_CAPACITY_10:
 278         cmd->xfer = 8;
 279         break;
 280     case READ_BLOCK_LIMITS:
 281         cmd->xfer = 6;
 282         break;
 283     case READ_POSITION:
 284         cmd->xfer = 20;
 285         break;
 286     case SEND_VOLUME_TAG:
 287         cmd->xfer *= 40;
 288         break;
 289     case MEDIUM_SCAN:
 290         cmd->xfer *= 8;
 291         break;
 292     case WRITE_10:
 293     case WRITE_VERIFY_10:
 294     case WRITE_6:
 295     case WRITE_12:
 296     case WRITE_VERIFY_12:
 297     case WRITE_16:
 298     case WRITE_VERIFY_16:
 299         cmd->xfer *= dev->blocksize;
 300         break;
 301     case READ_10:
 302     case READ_6:
 303     case READ_REVERSE:
 304     case RECOVER_BUFFERED_DATA:
 305     case READ_12:
 306     case READ_16:
 307         cmd->xfer *= dev->blocksize;
 308         break;
 309     case INQUIRY:
 310         cmd->xfer = buf[4] | (buf[3] << 8);
 311         break;
 312     case MAINTENANCE_OUT:
 313     case MAINTENANCE_IN:
 314         if (dev->type == TYPE_ROM) {
 315             /* GPCMD_REPORT_KEY and GPCMD_SEND_KEY from multi media commands */
 316             cmd->xfer = buf[9] | (buf[8] << 8);
 317         }
 318         break;
 319     }
 320     return 0;
 321 }
 322
 323 static int scsi_req_stream_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
 324 {
 325     switch (buf[0]) {
 326     /* stream commands */
 327     case READ_6:
 328     case READ_REVERSE:
 329     case RECOVER_BUFFERED_DATA:
 330     case WRITE_6:
 331         cmd->len = 6;
 332         cmd->xfer = buf[4] | (buf[3] << 8) | (buf[2] << 16);
 333         if (buf[1] & 0x01) { /* fixed */
 334             cmd->xfer *= dev->blocksize;
 335         }
 336         break;
 337     case REWIND:
 338     case START_STOP:
 339         cmd->len = 6;
 340         cmd->xfer = 0;
 341         break;
 342     /* generic commands */
 343     default:
 344         return scsi_req_length(cmd, dev, buf);
 345     }
 346     return 0;
 347 }
 348
 349 static void scsi_cmd_xfer_mode(SCSICommand *cmd)
 350 {
 351     switch (cmd->buf[0]) {
 352     case WRITE_6:
 353     case WRITE_10:
 354     case WRITE_VERIFY_10:
 355     case WRITE_12:
 356     case WRITE_VERIFY_12:
 357     case WRITE_16:
 358     case WRITE_VERIFY_16:
 359     case COPY:
 360     case COPY_VERIFY:
 361     case COMPARE:
 362     case CHANGE_DEFINITION:
 363     case LOG_SELECT:
 364     case MODE_SELECT:
 365     case MODE_SELECT_10:
 366     case SEND_DIAGNOSTIC:
 367     case WRITE_BUFFER:
 368     case FORMAT_UNIT:
 369     case REASSIGN_BLOCKS:
 370     case SEARCH_EQUAL:
 371     case SEARCH_HIGH:
 372     case SEARCH_LOW:
 373     case UPDATE_BLOCK:
 374     case WRITE_LONG_10:
 375     case WRITE_SAME_10:
 376     case SEARCH_HIGH_12:
 377     case SEARCH_EQUAL_12:
 378     case SEARCH_LOW_12:
 379     case MEDIUM_SCAN:
 380     case SEND_VOLUME_TAG:
 381     case PERSISTENT_RESERVE_OUT:
 382     case MAINTENANCE_OUT:
 383         cmd->mode = SCSI_XFER_TO_DEV;
 384         break;
 385     default:
 386         if (cmd->xfer)
 387             cmd->mode = SCSI_XFER_FROM_DEV;
 388         else {
 389             cmd->mode = SCSI_XFER_NONE;
 390         }
 391         break;
 392     }
 393 }
 394
 395 static uint64_t scsi_cmd_lba(SCSICommand *cmd)
 396 {
 397     uint8_t *buf = cmd->buf;
 398     uint64_t lba;
 399
 400     switch (buf[0] >> 5) {
 401     case 0:
 402         lba = (uint64_t) buf[3] | ((uint64_t) buf[2] << 8) |
 403               (((uint64_t) buf[1] & 0x1f) << 16);
 404         break;
 405     case 1:
 406     case 2:
 407         lba = (uint64_t) buf[5] | ((uint64_t) buf[4] << 8) |
 408               ((uint64_t) buf[3] << 16) | ((uint64_t) buf[2] << 24);
 409         break;
 410     case 4:
 411         lba = (uint64_t) buf[9] | ((uint64_t) buf[8] << 8) |
 412               ((uint64_t) buf[7] << 16) | ((uint64_t) buf[6] << 24) |
 413               ((uint64_t) buf[5] << 32) | ((uint64_t) buf[4] << 40) |
 414               ((uint64_t) buf[3] << 48) | ((uint64_t) buf[2] << 56);
 415         break;
 416     case 5:
 417         lba = (uint64_t) buf[5] | ((uint64_t) buf[4] << 8) |
 418               ((uint64_t) buf[3] << 16) | ((uint64_t) buf[2] << 24);
 419         break;
 420     default:
 421         lba = -1;
 422
 423     }
 424     return lba;
 425 }
 426
 427 int scsi_req_parse(SCSIRequest *req, uint8_t *buf)
 428 {
 429     int rc;
 430
 431     if (req->dev->type == TYPE_TAPE) {
 432         rc = scsi_req_stream_length(&req->cmd, req->dev, buf);
 433     } else {
 434         rc = scsi_req_length(&req->cmd, req->dev, buf);
 435     }
 436     if (rc != 0)
 437         return rc;
 438
 439     assert(buf == req->cmd.buf);
 440     scsi_cmd_xfer_mode(&req->cmd);
 441     req->cmd.lba = scsi_cmd_lba(&req->cmd);
 442     trace_scsi_req_parsed(req->dev->id, req->lun, req->tag, buf[0],
 443                           req->cmd.mode, req->cmd.xfer);
 444     if (req->cmd.lba != -1) {
 445         trace_scsi_req_parsed_lba(req->dev->id, req->lun, req->tag, buf[0],
 446                               req->cmd.lba);
 447     }
 448     return 0;
 449 }
 450
 451 /*
 452  * Predefined sense codes
 453  */
 454
 455 /* No sense data available */
 456 const struct SCSISense sense_code_NO_SENSE = {
 457     .key = NO_SENSE , .asc = 0x00 , .ascq = 0x00
 458 };
 459
 460 /* LUN not ready, Manual intervention required */
 461 const struct SCSISense sense_code_LUN_NOT_READY = {
 462     .key = NOT_READY, .asc = 0x04, .ascq = 0x03
 463 };
 464
 465 /* LUN not ready, Medium not present */
 466 const struct SCSISense sense_code_NO_MEDIUM = {
 467     .key = NOT_READY, .asc = 0x3a, .ascq = 0x00
 468 };
 469
 470 /* Hardware error, internal target failure */
 471 const struct SCSISense sense_code_TARGET_FAILURE = {
 472     .key = HARDWARE_ERROR, .asc = 0x44, .ascq = 0x00
 473 };
 474
 475 /* Illegal request, invalid command operation code */
 476 const struct SCSISense sense_code_INVALID_OPCODE = {
 477     .key = ILLEGAL_REQUEST, .asc = 0x20, .ascq = 0x00
 478 };
 479
 480 /* Illegal request, LBA out of range */
 481 const struct SCSISense sense_code_LBA_OUT_OF_RANGE = {
 482     .key = ILLEGAL_REQUEST, .asc = 0x21, .ascq = 0x00
 483 };
 484
 485 /* Illegal request, Invalid field in CDB */
 486 const struct SCSISense sense_code_INVALID_FIELD = {
 487     .key = ILLEGAL_REQUEST, .asc = 0x24, .ascq = 0x00
 488 };
 489
 490 /* Illegal request, LUN not supported */
 491 const struct SCSISense sense_code_LUN_NOT_SUPPORTED = {
 492     .key = ILLEGAL_REQUEST, .asc = 0x25, .ascq = 0x00
 493 };
 494
 495 /* Command aborted, I/O process terminated */
 496 const struct SCSISense sense_code_IO_ERROR = {
 497     .key = ABORTED_COMMAND, .asc = 0x00, .ascq = 0x06
 498 };
 499
 500 /* Command aborted, I_T Nexus loss occurred */
 501 const struct SCSISense sense_code_I_T_NEXUS_LOSS = {
 502     .key = ABORTED_COMMAND, .asc = 0x29, .ascq = 0x07
 503 };
 504
 505 /* Command aborted, Logical Unit failure */
 506 const struct SCSISense sense_code_LUN_FAILURE = {
 507     .key = ABORTED_COMMAND, .asc = 0x3e, .ascq = 0x01
 508 };
 509
 510 /*
 511  * scsi_build_sense
 512  *
 513  * Convert between fixed and descriptor sense buffers
 514  */
 515 int scsi_build_sense(uint8_t *in_buf, int in_len,
 516                      uint8_t *buf, int len, bool fixed)
 517 {
 518     bool fixed_in;
 519     SCSISense sense;
 520     if (!fixed && len < 8) {
 521         return 0;
 522     }
 523
 524     if (in_len == 0) {
 525         sense.key = NO_SENSE;
 526         sense.asc = 0;
 527         sense.ascq = 0;
 528     } else {
 529         fixed_in = (in_buf[0] & 2) == 0;
 530
 531         if (fixed == fixed_in) {
 532             memcpy(buf, in_buf, MIN(len, in_len));
 533             return MIN(len, in_len);
 534         }
 535
 536         if (fixed_in) {
 537             sense.key = in_buf[2];
 538             sense.asc = in_buf[12];
 539             sense.ascq = in_buf[13];
 540         } else {
 541             sense.key = in_buf[1];
 542             sense.asc = in_buf[2];
 543             sense.ascq = in_buf[3];
 544         }
 545     }
 546
 547     memset(buf, 0, len);
 548     if (fixed) {
 549         /* Return fixed format sense buffer */
 550         buf[0] = 0xf0;
 551         buf[2] = sense.key;
 552         buf[7] = 7;
 553         buf[12] = sense.asc;
 554         buf[13] = sense.ascq;
 555         return MIN(len, 18);
 556     } else {
 557         /* Return descriptor format sense buffer */
 558         buf[0] = 0x72;
 559         buf[1] = sense.key;
 560         buf[2] = sense.asc;
 561         buf[3] = sense.ascq;
 562         return 8;
 563     }
 564 }
 565
 566 static const char *scsi_command_name(uint8_t cmd)
 567 {
 568     static const char *names[] = {
 569         [ TEST_UNIT_READY          ] = "TEST_UNIT_READY",
 570         [ REWIND                   ] = "REWIND",
 571         [ REQUEST_SENSE            ] = "REQUEST_SENSE",
 572         [ FORMAT_UNIT              ] = "FORMAT_UNIT",
 573         [ READ_BLOCK_LIMITS        ] = "READ_BLOCK_LIMITS",
 574         [ REASSIGN_BLOCKS          ] = "REASSIGN_BLOCKS",
 575         [ READ_6                   ] = "READ_6",
 576         [ WRITE_6                  ] = "WRITE_6",
 577         [ SEEK_6                   ] = "SEEK_6",
 578         [ READ_REVERSE             ] = "READ_REVERSE",
 579         [ WRITE_FILEMARKS          ] = "WRITE_FILEMARKS",
 580         [ SPACE                    ] = "SPACE",
 581         [ INQUIRY                  ] = "INQUIRY",
 582         [ RECOVER_BUFFERED_DATA    ] = "RECOVER_BUFFERED_DATA",
 583         [ MAINTENANCE_IN           ] = "MAINTENANCE_IN",
 584         [ MAINTENANCE_OUT          ] = "MAINTENANCE_OUT",
 585         [ MODE_SELECT              ] = "MODE_SELECT",
 586         [ RESERVE                  ] = "RESERVE",
 587         [ RELEASE                  ] = "RELEASE",
 588         [ COPY                     ] = "COPY",
 589         [ ERASE                    ] = "ERASE",
 590         [ MODE_SENSE               ] = "MODE_SENSE",
 591         [ START_STOP               ] = "START_STOP",
 592         [ RECEIVE_DIAGNOSTIC       ] = "RECEIVE_DIAGNOSTIC",
 593         [ SEND_DIAGNOSTIC          ] = "SEND_DIAGNOSTIC",
 594         [ ALLOW_MEDIUM_REMOVAL     ] = "ALLOW_MEDIUM_REMOVAL",
 595         [ READ_CAPACITY_10         ] = "READ_CAPACITY_10",
 596         [ READ_10                  ] = "READ_10",
 597         [ WRITE_10                 ] = "WRITE_10",
 598         [ SEEK_10                  ] = "SEEK_10",
 599         [ WRITE_VERIFY_10          ] = "WRITE_VERIFY_10",
 600         [ VERIFY_10                ] = "VERIFY_10",
 601         [ SEARCH_HIGH              ] = "SEARCH_HIGH",
 602         [ SEARCH_EQUAL             ] = "SEARCH_EQUAL",
 603         [ SEARCH_LOW               ] = "SEARCH_LOW",
 604         [ SET_LIMITS               ] = "SET_LIMITS",
 605         [ PRE_FETCH                ] = "PRE_FETCH",
 606         /* READ_POSITION and PRE_FETCH use the same operation code */
 607         [ SYNCHRONIZE_CACHE        ] = "SYNCHRONIZE_CACHE",
 608         [ LOCK_UNLOCK_CACHE        ] = "LOCK_UNLOCK_CACHE",
 609         [ READ_DEFECT_DATA         ] = "READ_DEFECT_DATA",
 610         [ MEDIUM_SCAN              ] = "MEDIUM_SCAN",
 611         [ COMPARE                  ] = "COMPARE",
 612         [ COPY_VERIFY              ] = "COPY_VERIFY",
 613         [ WRITE_BUFFER             ] = "WRITE_BUFFER",
 614         [ READ_BUFFER              ] = "READ_BUFFER",
 615         [ UPDATE_BLOCK             ] = "UPDATE_BLOCK",
 616         [ READ_LONG_10             ] = "READ_LONG_10",
 617         [ WRITE_LONG_10            ] = "WRITE_LONG_10",
 618         [ CHANGE_DEFINITION        ] = "CHANGE_DEFINITION",
 619         [ WRITE_SAME_10            ] = "WRITE_SAME_10",
 620         [ UNMAP                    ] = "UNMAP",
 621         [ READ_TOC                 ] = "READ_TOC",
 622         [ REPORT_DENSITY_SUPPORT   ] = "REPORT_DENSITY_SUPPORT",
 623         [ GET_CONFIGURATION        ] = "GET_CONFIGURATION",
 624         [ LOG_SELECT               ] = "LOG_SELECT",
 625         [ LOG_SENSE                ] = "LOG_SENSE",
 626         [ MODE_SELECT_10           ] = "MODE_SELECT_10",
 627         [ RESERVE_10               ] = "RESERVE_10",
 628         [ RELEASE_10               ] = "RELEASE_10",
 629         [ MODE_SENSE_10            ] = "MODE_SENSE_10",
 630         [ PERSISTENT_RESERVE_IN    ] = "PERSISTENT_RESERVE_IN",
 631         [ PERSISTENT_RESERVE_OUT   ] = "PERSISTENT_RESERVE_OUT",
 632         [ WRITE_FILEMARKS_16       ] = "WRITE_FILEMARKS_16",
 633         [ EXTENDED_COPY            ] = "EXTENDED_COPY",
 634         [ ATA_PASSTHROUGH          ] = "ATA_PASSTHROUGH",
 635         [ ACCESS_CONTROL_IN        ] = "ACCESS_CONTROL_IN",
 636         [ ACCESS_CONTROL_OUT       ] = "ACCESS_CONTROL_OUT",
 637         [ READ_16                  ] = "READ_16",
 638         [ COMPARE_AND_WRITE        ] = "COMPARE_AND_WRITE",
 639         [ WRITE_16                 ] = "WRITE_16",
 640         [ WRITE_VERIFY_16          ] = "WRITE_VERIFY_16",
 641         [ VERIFY_16                ] = "VERIFY_16",
 642         [ SYNCHRONIZE_CACHE_16     ] = "SYNCHRONIZE_CACHE_16",
 643         [ LOCATE_16                ] = "LOCATE_16",
 644         [ WRITE_SAME_16            ] = "WRITE_SAME_16",
 645         [ ERASE_16                 ] = "ERASE_16",
 646         [ SERVICE_ACTION_IN        ] = "SERVICE_ACTION_IN",
 647         [ WRITE_LONG_16            ] = "WRITE_LONG_16",
 648         [ REPORT_LUNS              ] = "REPORT_LUNS",
 649         [ BLANK                    ] = "BLANK",
 650         [ MAINTENANCE_IN           ] = "MAINTENANCE_IN",
 651         [ MAINTENANCE_OUT          ] = "MAINTENANCE_OUT",
 652         [ MOVE_MEDIUM              ] = "MOVE_MEDIUM",
 653         [ LOAD_UNLOAD              ] = "LOAD_UNLOAD",
 654         [ READ_12                  ] = "READ_12",
 655         [ WRITE_12                 ] = "WRITE_12",
 656         [ WRITE_VERIFY_12          ] = "WRITE_VERIFY_12",
 657         [ VERIFY_12                ] = "VERIFY_12",
 658         [ SEARCH_HIGH_12           ] = "SEARCH_HIGH_12",
 659         [ SEARCH_EQUAL_12          ] = "SEARCH_EQUAL_12",
 660         [ SEARCH_LOW_12            ] = "SEARCH_LOW_12",
 661         [ READ_ELEMENT_STATUS      ] = "READ_ELEMENT_STATUS",
 662         [ SEND_VOLUME_TAG          ] = "SEND_VOLUME_TAG",
 663         [ READ_DEFECT_DATA_12      ] = "READ_DEFECT_DATA_12",
 664         [ SET_CD_SPEED             ] = "SET_CD_SPEED",
 665     };
 666
 667     if (cmd >= ARRAY_SIZE(names) || names[cmd] == NULL)
 668         return "*UNKNOWN*";
 669     return names[cmd];
 670 }
 671
 672 SCSIRequest *scsi_req_ref(SCSIRequest *req)
 673 {
 674     req->refcount++;
 675     return req;
 676 }
 677
 678 void scsi_req_unref(SCSIRequest *req)
 679 {
 680     if (--req->refcount == 0) {
 681         if (req->ops->free_req) {
 682             req->ops->free_req(req);
 683         }
 684         qemu_free(req);
 685     }
 686 }
 687
 688 /* Tell the device that we finished processing this chunk of I/O.  It
 689    will start the next chunk or complete the command.  */
 690 void scsi_req_continue(SCSIRequest *req)
 691 {
 692     trace_scsi_req_continue(req->dev->id, req->lun, req->tag);
 693     if (req->cmd.mode == SCSI_XFER_TO_DEV) {
 694         req->ops->write_data(req);
 695     } else {
 696         req->ops->read_data(req);
 697     }
 698 }
 699
 700 /* Called by the devices when data is ready for the HBA.  The HBA should
 701    start a DMA operation to read or fill the device's data buffer.
 702    Once it completes, calling scsi_req_continue will restart I/O.  */
 703 void scsi_req_data(SCSIRequest *req, int len)
 704 {
 705     trace_scsi_req_data(req->dev->id, req->lun, req->tag, len);
 706     req->bus->ops->transfer_data(req, len);
 707 }
 708
 709 void scsi_req_print(SCSIRequest *req)
 710 {
 711     FILE *fp = stderr;
 712     int i;
 713
 714     fprintf(fp, "[%s id=%d] %s",
 715             req->dev->qdev.parent_bus->name,
 716             req->dev->id,
 717             scsi_command_name(req->cmd.buf[0]));
 718     for (i = 1; i < req->cmd.len; i++) {
 719         fprintf(fp, " 0x%02x", req->cmd.buf[i]);
 720     }
 721     switch (req->cmd.mode) {
 722     case SCSI_XFER_NONE:
 723         fprintf(fp, " - none\n");
 724         break;
 725     case SCSI_XFER_FROM_DEV:
 726         fprintf(fp, " - from-dev len=%zd\n", req->cmd.xfer);
 727         break;
 728     case SCSI_XFER_TO_DEV:
 729         fprintf(fp, " - to-dev len=%zd\n", req->cmd.xfer);
 730         break;
 731     default:
 732         fprintf(fp, " - Oops\n");
 733         break;
 734     }
 735 }
 736
 737 void scsi_req_complete(SCSIRequest *req, int status)
 738 {
 739     assert(req->status == -1);
 740     req->status = status;
 741
 742     assert(req->sense_len < sizeof(req->sense));
 743     if (status == GOOD) {
 744         req->sense_len = 0;
 745     }
 746
 747     if (req->sense_len) {
 748         memcpy(req->dev->sense, req->sense, req->sense_len);
 749     }
 750     req->dev->sense_len = req->sense_len;
 751
 752     scsi_req_ref(req);
 753     scsi_req_dequeue(req);
 754     req->bus->ops->complete(req, req->status);
 755     scsi_req_unref(req);
 756 }
 757
 758 void scsi_req_cancel(SCSIRequest *req)
 759 {
 760     if (req->ops->cancel_io) {
 761         req->ops->cancel_io(req);
 762     }
 763     scsi_req_ref(req);
 764     scsi_req_dequeue(req);
 765     if (req->bus->ops->cancel) {
 766         req->bus->ops->cancel(req);
 767     }
 768     scsi_req_unref(req);
 769 }
 770
 771 void scsi_req_abort(SCSIRequest *req, int status)
 772 {
 773     if (req->ops->cancel_io) {
 774         req->ops->cancel_io(req);
 775     }
 776     scsi_req_complete(req, status);
 777 }
 778
 779 void scsi_device_purge_requests(SCSIDevice *sdev)
 780 {
 781     SCSIRequest *req;
 782
 783     while (!QTAILQ_EMPTY(&sdev->requests)) {
 784         req = QTAILQ_FIRST(&sdev->requests);
 785         scsi_req_cancel(req);
 786     }
 787 }
 788
 789 static char *scsibus_get_fw_dev_path(DeviceState *dev)
 790 {
 791     SCSIDevice *d = DO_UPCAST(SCSIDevice, qdev, dev);
 792     SCSIBus *bus = scsi_bus_from_device(d);
 793     char path[100];
 794     int i;
 795
 796     for (i = 0; i < bus->ndev; i++) {
 797         if (bus->devs[i] == d) {
 798             break;
 799         }
 800     }
 801
 802     assert(i != bus->ndev);
 803
 804     snprintf(path, sizeof(path), "%s@%x", qdev_fw_name(dev), i);
 805
 806     return strdup(path);
 807 }