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