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