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, const SCSIBusInfo *info)
  28 {
  29     qbus_create_inplace(&bus->qbus, &scsi_bus_info, host, NULL);
  30     bus->busnr = next_scsi_bus++;
  31     bus->info = info;
  32     bus->qbus.allow_hotplug = 1;
  33 }
  34
  35 static int scsi_qdev_init(DeviceState *qdev, DeviceInfo *base)
  36 {
  37     SCSIDevice *dev = DO_UPCAST(SCSIDevice, qdev, qdev);
  38     SCSIDeviceInfo *info = DO_UPCAST(SCSIDeviceInfo, qdev, base);
  39     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
  40     SCSIDevice *olddev;
  41     int rc = -1;
  42
  43     if (dev->id == -1) {
  44         int id;
  45         for (id = 0; id < bus->info->ndev; id++) {
  46             if (!scsi_device_find(bus, id, 0)) {
  47                 dev->id = id;
  48                 break;
  49             }
  50         }
  51     }
  52     if (dev->id >= bus->info->ndev) {
  53         error_report("bad scsi device id: %d", dev->id);
  54         goto err;
  55     }
  56
  57     olddev = scsi_device_find(bus, dev->id, dev->lun);
  58     if (olddev && dev->lun == olddev->lun) {
  59         qdev_free(&olddev->qdev);
  60     }
  61
  62     dev->info = info;
  63     QTAILQ_INIT(&dev->requests);
  64     rc = dev->info->init(dev);
  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
  74     if (dev->info->destroy) {
  75         dev->info->destroy(dev);
  76     }
  77     return 0;
  78 }
  79
  80 void scsi_qdev_register(SCSIDeviceInfo *info)
  81 {
  82     info->qdev.bus_info = &scsi_bus_info;
  83     info->qdev.init     = scsi_qdev_init;
  84     info->qdev.unplug   = qdev_simple_unplug_cb;
  85     info->qdev.exit     = scsi_qdev_exit;
  86     qdev_register(&info->qdev);
  87 }
  88
  89 /* handle legacy '-drive if=scsi,...' cmd line args */
  90 SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockDriverState *bdrv,
  91                                       int unit, bool removable)
  92 {
  93     const char *driver;
  94     DeviceState *dev;
  95
  96     driver = bdrv_is_sg(bdrv) ? "scsi-generic" : "scsi-disk";
  97     dev = qdev_create(&bus->qbus, driver);
  98     qdev_prop_set_uint32(dev, "scsi-id", unit);
  99     if (qdev_prop_exists(dev, "removable")) {
 100         qdev_prop_set_bit(dev, "removable", removable);
 101     }
 102     if (qdev_prop_set_drive(dev, "drive", bdrv) < 0) {
 103         qdev_free(dev);
 104         return NULL;
 105     }
 106     if (qdev_init(dev) < 0)
 107         return NULL;
 108     return DO_UPCAST(SCSIDevice, qdev, dev);
 109 }
 110
 111 int scsi_bus_legacy_handle_cmdline(SCSIBus *bus)
 112 {
 113     Location loc;
 114     DriveInfo *dinfo;
 115     int res = 0, unit;
 116
 117     loc_push_none(&loc);
 118     for (unit = 0; unit < bus->info->ndev; unit++) {
 119         dinfo = drive_get(IF_SCSI, bus->busnr, unit);
 120         if (dinfo == NULL) {
 121             continue;
 122         }
 123         qemu_opts_loc_restore(dinfo->opts);
 124         if (!scsi_bus_legacy_add_drive(bus, dinfo->bdrv, unit, false)) {
 125             res = -1;
 126             break;
 127         }
 128     }
 129     loc_pop(&loc);
 130     return res;
 131 }
 132
 133 /* SCSIReqOps implementation for invalid commands.  */
 134
 135 static int32_t scsi_invalid_command(SCSIRequest *req, uint8_t *buf)
 136 {
 137     scsi_req_build_sense(req, SENSE_CODE(INVALID_OPCODE));
 138     scsi_req_complete(req, CHECK_CONDITION);
 139     return 0;
 140 }
 141
 142 struct SCSIReqOps reqops_invalid_opcode = {
 143     .size         = sizeof(SCSIRequest),
 144     .send_command = scsi_invalid_command
 145 };
 146
 147 /* SCSIReqOps implementation for unit attention conditions.  */
 148
 149 static int32_t scsi_unit_attention(SCSIRequest *req, uint8_t *buf)
 150 {
 151     if (req->dev && req->dev->unit_attention.key == UNIT_ATTENTION) {
 152         scsi_req_build_sense(req, req->dev->unit_attention);
 153     } else if (req->bus->unit_attention.key == UNIT_ATTENTION) {
 154         scsi_req_build_sense(req, req->bus->unit_attention);
 155     }
 156     scsi_req_complete(req, CHECK_CONDITION);
 157     return 0;
 158 }
 159
 160 struct SCSIReqOps reqops_unit_attention = {
 161     .size         = sizeof(SCSIRequest),
 162     .send_command = scsi_unit_attention
 163 };
 164
 165 /* SCSIReqOps implementation for REPORT LUNS and for commands sent to
 166    an invalid LUN.  */
 167
 168 typedef struct SCSITargetReq SCSITargetReq;
 169
 170 struct SCSITargetReq {
 171     SCSIRequest req;
 172     int len;
 173     uint8_t buf[2056];
 174 };
 175
 176 static void store_lun(uint8_t *outbuf, int lun)
 177 {
 178     if (lun < 256) {
 179         outbuf[1] = lun;
 180         return;
 181     }
 182     outbuf[1] = (lun & 255);
 183     outbuf[0] = (lun >> 8) | 0x40;
 184 }
 185
 186 static bool scsi_target_emulate_report_luns(SCSITargetReq *r)
 187 {
 188     DeviceState *qdev;
 189     int i, len, n;
 190     int id;
 191     bool found_lun0;
 192
 193     if (r->req.cmd.xfer < 16) {
 194         return false;
 195     }
 196     if (r->req.cmd.buf[2] > 2) {
 197         return false;
 198     }
 199     id = r->req.dev->id;
 200     found_lun0 = false;
 201     n = 0;
 202     QTAILQ_FOREACH(qdev, &r->req.bus->qbus.children, sibling) {
 203         SCSIDevice *dev = DO_UPCAST(SCSIDevice, qdev, qdev);
 204
 205         if (dev->id == id) {
 206             if (dev->lun == 0) {
 207                 found_lun0 = true;
 208             }
 209             n += 8;
 210         }
 211     }
 212     if (!found_lun0) {
 213         n += 8;
 214     }
 215     len = MIN(n + 8, r->req.cmd.xfer & ~7);
 216     if (len > sizeof(r->buf)) {
 217         /* TODO: > 256 LUNs? */
 218         return false;
 219     }
 220
 221     memset(r->buf, 0, len);
 222     stl_be_p(&r->buf, n);
 223     i = found_lun0 ? 8 : 16;
 224     QTAILQ_FOREACH(qdev, &r->req.bus->qbus.children, sibling) {
 225         SCSIDevice *dev = DO_UPCAST(SCSIDevice, qdev, qdev);
 226
 227         if (dev->id == id) {
 228             store_lun(&r->buf[i], dev->lun);
 229             i += 8;
 230         }
 231     }
 232     assert(i == n + 8);
 233     r->len = len;
 234     return true;
 235 }
 236
 237 static bool scsi_target_emulate_inquiry(SCSITargetReq *r)
 238 {
 239     assert(r->req.dev->lun != r->req.lun);
 240     if (r->req.cmd.buf[1] & 0x2) {
 241         /* Command support data - optional, not implemented */
 242         return false;
 243     }
 244
 245     if (r->req.cmd.buf[1] & 0x1) {
 246         /* Vital product data */
 247         uint8_t page_code = r->req.cmd.buf[2];
 248         if (r->req.cmd.xfer < 4) {
 249             return false;
 250         }
 251
 252         r->buf[r->len++] = page_code ; /* this page */
 253         r->buf[r->len++] = 0x00;
 254
 255         switch (page_code) {
 256         case 0x00: /* Supported page codes, mandatory */
 257         {
 258             int pages;
 259             pages = r->len++;
 260             r->buf[r->len++] = 0x00; /* list of supported pages (this page) */
 261             r->buf[pages] = r->len - pages - 1; /* number of pages */
 262             break;
 263         }
 264         default:
 265             return false;
 266         }
 267         /* done with EVPD */
 268         assert(r->len < sizeof(r->buf));
 269         r->len = MIN(r->req.cmd.xfer, r->len);
 270         return true;
 271     }
 272
 273     /* Standard INQUIRY data */
 274     if (r->req.cmd.buf[2] != 0) {
 275         return false;
 276     }
 277
 278     /* PAGE CODE == 0 */
 279     if (r->req.cmd.xfer < 5) {
 280         return -1;
 281     }
 282
 283     r->len = MIN(r->req.cmd.xfer, 36);
 284     memset(r->buf, 0, r->len);
 285     if (r->req.lun != 0) {
 286         r->buf[0] = TYPE_NO_LUN;
 287     } else {
 288         r->buf[0] = TYPE_NOT_PRESENT | TYPE_INACTIVE;
 289         r->buf[2] = 5; /* Version */
 290         r->buf[3] = 2 | 0x10; /* HiSup, response data format */
 291         r->buf[4] = r->len - 5; /* Additional Length = (Len - 1) - 4 */
 292         r->buf[7] = 0x10 | (r->req.bus->info->tcq ? 0x02 : 0); /* Sync, TCQ.  */
 293         memcpy(&r->buf[8], "QEMU    ", 8);
 294         memcpy(&r->buf[16], "QEMU TARGET     ", 16);
 295         strncpy((char *) &r->buf[32], QEMU_VERSION, 4);
 296     }
 297     return true;
 298 }
 299
 300 static int32_t scsi_target_send_command(SCSIRequest *req, uint8_t *buf)
 301 {
 302     SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
 303
 304     switch (buf[0]) {
 305     case REPORT_LUNS:
 306         if (!scsi_target_emulate_report_luns(r)) {
 307             goto illegal_request;
 308         }
 309         break;
 310     case INQUIRY:
 311         if (!scsi_target_emulate_inquiry(r)) {
 312             goto illegal_request;
 313         }
 314         break;
 315     case REQUEST_SENSE:
 316         if (req->cmd.xfer < 4) {
 317             goto illegal_request;
 318         }
 319         r->len = scsi_device_get_sense(r->req.dev, r->buf,
 320                                        MIN(req->cmd.xfer, sizeof r->buf),
 321                                        (req->cmd.buf[1] & 1) == 0);
 322         if (r->req.dev->sense_is_ua) {
 323             if (r->req.dev->info->unit_attention_reported) {
 324                 r->req.dev->info->unit_attention_reported(req->dev);
 325             }
 326             r->req.dev->sense_len = 0;
 327             r->req.dev->sense_is_ua = false;
 328         }
 329         break;
 330     default:
 331         scsi_req_build_sense(req, SENSE_CODE(LUN_NOT_SUPPORTED));
 332         scsi_req_complete(req, CHECK_CONDITION);
 333         return 0;
 334     illegal_request:
 335         scsi_req_build_sense(req, SENSE_CODE(INVALID_FIELD));
 336         scsi_req_complete(req, CHECK_CONDITION);
 337         return 0;
 338     }
 339
 340     if (!r->len) {
 341         scsi_req_complete(req, GOOD);
 342     }
 343     return r->len;
 344 }
 345
 346 static void scsi_target_read_data(SCSIRequest *req)
 347 {
 348     SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
 349     uint32_t n;
 350
 351     n = r->len;
 352     if (n > 0) {
 353         r->len = 0;
 354         scsi_req_data(&r->req, n);
 355     } else {
 356         scsi_req_complete(&r->req, GOOD);
 357     }
 358 }
 359
 360 static uint8_t *scsi_target_get_buf(SCSIRequest *req)
 361 {
 362     SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
 363
 364     return r->buf;
 365 }
 366
 367 struct SCSIReqOps reqops_target_command = {
 368     .size         = sizeof(SCSITargetReq),
 369     .send_command = scsi_target_send_command,
 370     .read_data    = scsi_target_read_data,
 371     .get_buf      = scsi_target_get_buf,
 372 };
 373
 374
 375 SCSIRequest *scsi_req_alloc(SCSIReqOps *reqops, SCSIDevice *d, uint32_t tag,
 376                             uint32_t lun, void *hba_private)
 377 {
 378     SCSIRequest *req;
 379
 380     req = g_malloc0(reqops->size);
 381     req->refcount = 1;
 382     req->bus = scsi_bus_from_device(d);
 383     req->dev = d;
 384     req->tag = tag;
 385     req->lun = lun;
 386     req->hba_private = hba_private;
 387     req->status = -1;
 388     req->sense_len = 0;
 389     req->ops = reqops;
 390     trace_scsi_req_alloc(req->dev->id, req->lun, req->tag);
 391     return req;
 392 }
 393
 394 SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun,
 395                           uint8_t *buf, void *hba_private)
 396 {
 397     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
 398     SCSIRequest *req;
 399     SCSICommand cmd;
 400
 401     if (scsi_req_parse(&cmd, d, buf) != 0) {
 402         trace_scsi_req_parse_bad(d->id, lun, tag, buf[0]);
 403         req = scsi_req_alloc(&reqops_invalid_opcode, d, tag, lun, hba_private);
 404     } else {
 405         trace_scsi_req_parsed(d->id, lun, tag, buf[0],
 406                               cmd.mode, cmd.xfer);
 407         if (cmd.lba != -1) {
 408             trace_scsi_req_parsed_lba(d->id, lun, tag, buf[0],
 409                                       cmd.lba);
 410         }
 411
 412         if ((d->unit_attention.key == UNIT_ATTENTION ||
 413              bus->unit_attention.key == UNIT_ATTENTION) &&
 414             (buf[0] != INQUIRY &&
 415              buf[0] != REPORT_LUNS &&
 416              buf[0] != GET_CONFIGURATION &&
 417              buf[0] != GET_EVENT_STATUS_NOTIFICATION &&
 418
 419              /*
 420               * If we already have a pending unit attention condition,
 421               * report this one before triggering another one.
 422               */
 423              !(buf[0] == REQUEST_SENSE && d->sense_is_ua))) {
 424             req = scsi_req_alloc(&reqops_unit_attention, d, tag, lun,
 425                                  hba_private);
 426         } else if (lun != d->lun ||
 427             buf[0] == REPORT_LUNS ||
 428             buf[0] == REQUEST_SENSE) {
 429             req = scsi_req_alloc(&reqops_target_command, d, tag, lun,
 430                                  hba_private);
 431         } else {
 432             req = d->info->alloc_req(d, tag, lun, hba_private);
 433         }
 434     }
 435
 436     req->cmd = cmd;
 437     switch (buf[0]) {
 438     case INQUIRY:
 439         trace_scsi_inquiry(d->id, lun, tag, cmd.buf[1], cmd.buf[2]);
 440         break;
 441     case TEST_UNIT_READY:
 442         trace_scsi_test_unit_ready(d->id, lun, tag);
 443         break;
 444     case REPORT_LUNS:
 445         trace_scsi_report_luns(d->id, lun, tag);
 446         break;
 447     case REQUEST_SENSE:
 448         trace_scsi_request_sense(d->id, lun, tag);
 449         break;
 450     default:
 451         break;
 452     }
 453
 454     return req;
 455 }
 456
 457 uint8_t *scsi_req_get_buf(SCSIRequest *req)
 458 {
 459     return req->ops->get_buf(req);
 460 }
 461
 462 static void scsi_clear_unit_attention(SCSIRequest *req)
 463 {
 464     SCSISense *ua;
 465     if (req->dev->unit_attention.key != UNIT_ATTENTION &&
 466         req->bus->unit_attention.key != UNIT_ATTENTION) {
 467         return;
 468     }
 469
 470     /*
 471      * If an INQUIRY command enters the enabled command state,
 472      * the device server shall [not] clear any unit attention condition;
 473      * See also MMC-6, paragraphs 6.5 and 6.6.2.
 474      */
 475     if (req->cmd.buf[0] == INQUIRY ||
 476         req->cmd.buf[0] == GET_CONFIGURATION ||
 477         req->cmd.buf[0] == GET_EVENT_STATUS_NOTIFICATION) {
 478         return;
 479     }
 480
 481     if (req->dev->unit_attention.key == UNIT_ATTENTION) {
 482         ua = &req->dev->unit_attention;
 483     } else {
 484         ua = &req->bus->unit_attention;
 485     }
 486
 487     /*
 488      * If a REPORT LUNS command enters the enabled command state, [...]
 489      * the device server shall clear any pending unit attention condition
 490      * with an additional sense code of REPORTED LUNS DATA HAS CHANGED.
 491      */
 492     if (req->cmd.buf[0] == REPORT_LUNS &&
 493         !(ua->asc == SENSE_CODE(REPORTED_LUNS_CHANGED).asc &&
 494           ua->ascq == SENSE_CODE(REPORTED_LUNS_CHANGED).ascq)) {
 495         return;
 496     }
 497
 498     *ua = SENSE_CODE(NO_SENSE);
 499 }
 500
 501 int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len)
 502 {
 503     int ret;
 504
 505     assert(len >= 14);
 506     if (!req->sense_len) {
 507         return 0;
 508     }
 509
 510     ret = scsi_build_sense(req->sense, req->sense_len, buf, len, true);
 511
 512     /*
 513      * FIXME: clearing unit attention conditions upon autosense should be done
 514      * only if the UA_INTLCK_CTRL field in the Control mode page is set to 00b
 515      * (SAM-5, 5.14).
 516      *
 517      * We assume UA_INTLCK_CTRL to be 00b for HBAs that support autosense, and
 518      * 10b for HBAs that do not support it (do not call scsi_req_get_sense).
 519      * Here we handle unit attention clearing for UA_INTLCK_CTRL == 00b.
 520      */
 521     if (req->dev->sense_is_ua) {
 522         if (req->dev->info->unit_attention_reported) {
 523             req->dev->info->unit_attention_reported(req->dev);
 524         }
 525         req->dev->sense_len = 0;
 526         req->dev->sense_is_ua = false;
 527     }
 528     return ret;
 529 }
 530
 531 int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed)
 532 {
 533     return scsi_build_sense(dev->sense, dev->sense_len, buf, len, fixed);
 534 }
 535
 536 void scsi_req_build_sense(SCSIRequest *req, SCSISense sense)
 537 {
 538     trace_scsi_req_build_sense(req->dev->id, req->lun, req->tag,
 539                                sense.key, sense.asc, sense.ascq);
 540     memset(req->sense, 0, 18);
 541     req->sense[0] = 0xf0;
 542     req->sense[2] = sense.key;
 543     req->sense[7] = 10;
 544     req->sense[12] = sense.asc;
 545     req->sense[13] = sense.ascq;
 546     req->sense_len = 18;
 547 }
 548
 549 int32_t scsi_req_enqueue(SCSIRequest *req)
 550 {
 551     int32_t rc;
 552
 553     assert(!req->enqueued);
 554     scsi_req_ref(req);
 555     req->enqueued = true;
 556     QTAILQ_INSERT_TAIL(&req->dev->requests, req, next);
 557
 558     scsi_req_ref(req);
 559     rc = req->ops->send_command(req, req->cmd.buf);
 560     scsi_req_unref(req);
 561     return rc;
 562 }
 563
 564 static void scsi_req_dequeue(SCSIRequest *req)
 565 {
 566     trace_scsi_req_dequeue(req->dev->id, req->lun, req->tag);
 567     if (req->enqueued) {
 568         QTAILQ_REMOVE(&req->dev->requests, req, next);
 569         req->enqueued = false;
 570         scsi_req_unref(req);
 571     }
 572 }
 573
 574 static int scsi_req_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
 575 {
 576     switch (buf[0] >> 5) {
 577     case 0:
 578         cmd->xfer = buf[4];
 579         cmd->len = 6;
 580         /* length 0 means 256 blocks */
 581         if (cmd->xfer == 0) {
 582             cmd->xfer = 256;
 583         }
 584         break;
 585     case 1:
 586     case 2:
 587         cmd->xfer = lduw_be_p(&buf[7]);
 588         cmd->len = 10;
 589         break;
 590     case 4:
 591         cmd->xfer = ldl_be_p(&buf[10]);
 592         cmd->len = 16;
 593         break;
 594     case 5:
 595         cmd->xfer = ldl_be_p(&buf[6]);
 596         cmd->len = 12;
 597         break;
 598     default:
 599         return -1;
 600     }
 601
 602     switch (buf[0]) {
 603     case TEST_UNIT_READY:
 604     case REWIND:
 605     case START_STOP:
 606     case SEEK_6:
 607     case WRITE_FILEMARKS:
 608     case SPACE:
 609     case RESERVE:
 610     case RELEASE:
 611     case ERASE:
 612     case ALLOW_MEDIUM_REMOVAL:
 613     case VERIFY_10:
 614     case SEEK_10:
 615     case SYNCHRONIZE_CACHE:
 616     case LOCK_UNLOCK_CACHE:
 617     case LOAD_UNLOAD:
 618     case SET_CD_SPEED:
 619     case SET_LIMITS:
 620     case WRITE_LONG_10:
 621     case MOVE_MEDIUM:
 622     case UPDATE_BLOCK:
 623         cmd->xfer = 0;
 624         break;
 625     case MODE_SENSE:
 626         break;
 627     case WRITE_SAME_10:
 628         cmd->xfer = 1;
 629         break;
 630     case READ_CAPACITY_10:
 631         cmd->xfer = 8;
 632         break;
 633     case READ_BLOCK_LIMITS:
 634         cmd->xfer = 6;
 635         break;
 636     case READ_POSITION:
 637         cmd->xfer = 20;
 638         break;
 639     case SEND_VOLUME_TAG:
 640         cmd->xfer *= 40;
 641         break;
 642     case MEDIUM_SCAN:
 643         cmd->xfer *= 8;
 644         break;
 645     case WRITE_10:
 646     case WRITE_VERIFY_10:
 647     case WRITE_6:
 648     case WRITE_12:
 649     case WRITE_VERIFY_12:
 650     case WRITE_16:
 651     case WRITE_VERIFY_16:
 652         cmd->xfer *= dev->blocksize;
 653         break;
 654     case READ_10:
 655     case READ_6:
 656     case READ_REVERSE:
 657     case RECOVER_BUFFERED_DATA:
 658     case READ_12:
 659     case READ_16:
 660         cmd->xfer *= dev->blocksize;
 661         break;
 662     case INQUIRY:
 663         cmd->xfer = buf[4] | (buf[3] << 8);
 664         break;
 665     case MAINTENANCE_OUT:
 666     case MAINTENANCE_IN:
 667         if (dev->type == TYPE_ROM) {
 668             /* GPCMD_REPORT_KEY and GPCMD_SEND_KEY from multi media commands */
 669             cmd->xfer = buf[9] | (buf[8] << 8);
 670         }
 671         break;
 672     }
 673     return 0;
 674 }
 675
 676 static int scsi_req_stream_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
 677 {
 678     switch (buf[0]) {
 679     /* stream commands */
 680     case READ_6:
 681     case READ_REVERSE:
 682     case RECOVER_BUFFERED_DATA:
 683     case WRITE_6:
 684         cmd->len = 6;
 685         cmd->xfer = buf[4] | (buf[3] << 8) | (buf[2] << 16);
 686         if (buf[1] & 0x01) { /* fixed */
 687             cmd->xfer *= dev->blocksize;
 688         }
 689         break;
 690     case REWIND:
 691     case START_STOP:
 692         cmd->len = 6;
 693         cmd->xfer = 0;
 694         break;
 695     /* generic commands */
 696     default:
 697         return scsi_req_length(cmd, dev, buf);
 698     }
 699     return 0;
 700 }
 701
 702 static void scsi_cmd_xfer_mode(SCSICommand *cmd)
 703 {
 704     switch (cmd->buf[0]) {
 705     case WRITE_6:
 706     case WRITE_10:
 707     case WRITE_VERIFY_10:
 708     case WRITE_12:
 709     case WRITE_VERIFY_12:
 710     case WRITE_16:
 711     case WRITE_VERIFY_16:
 712     case COPY:
 713     case COPY_VERIFY:
 714     case COMPARE:
 715     case CHANGE_DEFINITION:
 716     case LOG_SELECT:
 717     case MODE_SELECT:
 718     case MODE_SELECT_10:
 719     case SEND_DIAGNOSTIC:
 720     case WRITE_BUFFER:
 721     case FORMAT_UNIT:
 722     case REASSIGN_BLOCKS:
 723     case SEARCH_EQUAL:
 724     case SEARCH_HIGH:
 725     case SEARCH_LOW:
 726     case UPDATE_BLOCK:
 727     case WRITE_LONG_10:
 728     case WRITE_SAME_10:
 729     case SEARCH_HIGH_12:
 730     case SEARCH_EQUAL_12:
 731     case SEARCH_LOW_12:
 732     case MEDIUM_SCAN:
 733     case SEND_VOLUME_TAG:
 734     case PERSISTENT_RESERVE_OUT:
 735     case MAINTENANCE_OUT:
 736         cmd->mode = SCSI_XFER_TO_DEV;
 737         break;
 738     default:
 739         if (cmd->xfer)
 740             cmd->mode = SCSI_XFER_FROM_DEV;
 741         else {
 742             cmd->mode = SCSI_XFER_NONE;
 743         }
 744         break;
 745     }
 746 }
 747
 748 static uint64_t scsi_cmd_lba(SCSICommand *cmd)
 749 {
 750     uint8_t *buf = cmd->buf;
 751     uint64_t lba;
 752
 753     switch (buf[0] >> 5) {
 754     case 0:
 755         lba = ldl_be_p(&buf[0]) & 0x1fffff;
 756         break;
 757     case 1:
 758     case 2:
 759     case 5:
 760         lba = ldl_be_p(&buf[2]);
 761         break;
 762     case 4:
 763         lba = ldq_be_p(&buf[2]);
 764         break;
 765     default:
 766         lba = -1;
 767
 768     }
 769     return lba;
 770 }
 771
 772 int scsi_req_parse(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
 773 {
 774     int rc;
 775
 776     if (dev->type == TYPE_TAPE) {
 777         rc = scsi_req_stream_length(cmd, dev, buf);
 778     } else {
 779         rc = scsi_req_length(cmd, dev, buf);
 780     }
 781     if (rc != 0)
 782         return rc;
 783
 784     memcpy(cmd->buf, buf, cmd->len);
 785     scsi_cmd_xfer_mode(cmd);
 786     cmd->lba = scsi_cmd_lba(cmd);
 787     return 0;
 788 }
 789
 790 /*
 791  * Predefined sense codes
 792  */
 793
 794 /* No sense data available */
 795 const struct SCSISense sense_code_NO_SENSE = {
 796     .key = NO_SENSE , .asc = 0x00 , .ascq = 0x00
 797 };
 798
 799 /* LUN not ready, Manual intervention required */
 800 const struct SCSISense sense_code_LUN_NOT_READY = {
 801     .key = NOT_READY, .asc = 0x04, .ascq = 0x03
 802 };
 803
 804 /* LUN not ready, Medium not present */
 805 const struct SCSISense sense_code_NO_MEDIUM = {
 806     .key = NOT_READY, .asc = 0x3a, .ascq = 0x00
 807 };
 808
 809 /* LUN not ready, medium removal prevented */
 810 const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED = {
 811     .key = NOT_READY, .asc = 0x53, .ascq = 0x00
 812 };
 813
 814 /* Hardware error, internal target failure */
 815 const struct SCSISense sense_code_TARGET_FAILURE = {
 816     .key = HARDWARE_ERROR, .asc = 0x44, .ascq = 0x00
 817 };
 818
 819 /* Illegal request, invalid command operation code */
 820 const struct SCSISense sense_code_INVALID_OPCODE = {
 821     .key = ILLEGAL_REQUEST, .asc = 0x20, .ascq = 0x00
 822 };
 823
 824 /* Illegal request, LBA out of range */
 825 const struct SCSISense sense_code_LBA_OUT_OF_RANGE = {
 826     .key = ILLEGAL_REQUEST, .asc = 0x21, .ascq = 0x00
 827 };
 828
 829 /* Illegal request, Invalid field in CDB */
 830 const struct SCSISense sense_code_INVALID_FIELD = {
 831     .key = ILLEGAL_REQUEST, .asc = 0x24, .ascq = 0x00
 832 };
 833
 834 /* Illegal request, LUN not supported */
 835 const struct SCSISense sense_code_LUN_NOT_SUPPORTED = {
 836     .key = ILLEGAL_REQUEST, .asc = 0x25, .ascq = 0x00
 837 };
 838
 839 /* Illegal request, Saving parameters not supported */
 840 const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED = {
 841     .key = ILLEGAL_REQUEST, .asc = 0x39, .ascq = 0x00
 842 };
 843
 844 /* Illegal request, Incompatible medium installed */
 845 const struct SCSISense sense_code_INCOMPATIBLE_FORMAT = {
 846     .key = ILLEGAL_REQUEST, .asc = 0x30, .ascq = 0x00
 847 };
 848
 849 /* Illegal request, medium removal prevented */
 850 const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED = {
 851     .key = ILLEGAL_REQUEST, .asc = 0x53, .ascq = 0x00
 852 };
 853
 854 /* Command aborted, I/O process terminated */
 855 const struct SCSISense sense_code_IO_ERROR = {
 856     .key = ABORTED_COMMAND, .asc = 0x00, .ascq = 0x06
 857 };
 858
 859 /* Command aborted, I_T Nexus loss occurred */
 860 const struct SCSISense sense_code_I_T_NEXUS_LOSS = {
 861     .key = ABORTED_COMMAND, .asc = 0x29, .ascq = 0x07
 862 };
 863
 864 /* Command aborted, Logical Unit failure */
 865 const struct SCSISense sense_code_LUN_FAILURE = {
 866     .key = ABORTED_COMMAND, .asc = 0x3e, .ascq = 0x01
 867 };
 868
 869 /* Unit attention, Power on, reset or bus device reset occurred */
 870 const struct SCSISense sense_code_RESET = {
 871     .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x00
 872 };
 873
 874 /* Unit attention, No medium */
 875 const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM = {
 876     .key = UNIT_ATTENTION, .asc = 0x3a, .ascq = 0x00
 877 };
 878
 879 /* Unit attention, Medium may have changed */
 880 const struct SCSISense sense_code_MEDIUM_CHANGED = {
 881     .key = UNIT_ATTENTION, .asc = 0x28, .ascq = 0x00
 882 };
 883
 884 /* Unit attention, Reported LUNs data has changed */
 885 const struct SCSISense sense_code_REPORTED_LUNS_CHANGED = {
 886     .key = UNIT_ATTENTION, .asc = 0x3f, .ascq = 0x0e
 887 };
 888
 889 /* Unit attention, Device internal reset */
 890 const struct SCSISense sense_code_DEVICE_INTERNAL_RESET = {
 891     .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x04
 892 };
 893
 894 /*
 895  * scsi_build_sense
 896  *
 897  * Convert between fixed and descriptor sense buffers
 898  */
 899 int scsi_build_sense(uint8_t *in_buf, int in_len,
 900                      uint8_t *buf, int len, bool fixed)
 901 {
 902     bool fixed_in;
 903     SCSISense sense;
 904     if (!fixed && len < 8) {
 905         return 0;
 906     }
 907
 908     if (in_len == 0) {
 909         sense.key = NO_SENSE;
 910         sense.asc = 0;
 911         sense.ascq = 0;
 912     } else {
 913         fixed_in = (in_buf[0] & 2) == 0;
 914
 915         if (fixed == fixed_in) {
 916             memcpy(buf, in_buf, MIN(len, in_len));
 917             return MIN(len, in_len);
 918         }
 919
 920         if (fixed_in) {
 921             sense.key = in_buf[2];
 922             sense.asc = in_buf[12];
 923             sense.ascq = in_buf[13];
 924         } else {
 925             sense.key = in_buf[1];
 926             sense.asc = in_buf[2];
 927             sense.ascq = in_buf[3];
 928         }
 929     }
 930
 931     memset(buf, 0, len);
 932     if (fixed) {
 933         /* Return fixed format sense buffer */
 934         buf[0] = 0xf0;
 935         buf[2] = sense.key;
 936         buf[7] = 10;
 937         buf[12] = sense.asc;
 938         buf[13] = sense.ascq;
 939         return MIN(len, 18);
 940     } else {
 941         /* Return descriptor format sense buffer */
 942         buf[0] = 0x72;
 943         buf[1] = sense.key;
 944         buf[2] = sense.asc;
 945         buf[3] = sense.ascq;
 946         return 8;
 947     }
 948 }
 949
 950 static const char *scsi_command_name(uint8_t cmd)
 951 {
 952     static const char *names[] = {
 953         [ TEST_UNIT_READY          ] = "TEST_UNIT_READY",
 954         [ REWIND                   ] = "REWIND",
 955         [ REQUEST_SENSE            ] = "REQUEST_SENSE",
 956         [ FORMAT_UNIT              ] = "FORMAT_UNIT",
 957         [ READ_BLOCK_LIMITS        ] = "READ_BLOCK_LIMITS",
 958         [ REASSIGN_BLOCKS          ] = "REASSIGN_BLOCKS",
 959         [ READ_6                   ] = "READ_6",
 960         [ WRITE_6                  ] = "WRITE_6",
 961         [ SEEK_6                   ] = "SEEK_6",
 962         [ READ_REVERSE             ] = "READ_REVERSE",
 963         [ WRITE_FILEMARKS          ] = "WRITE_FILEMARKS",
 964         [ SPACE                    ] = "SPACE",
 965         [ INQUIRY                  ] = "INQUIRY",
 966         [ RECOVER_BUFFERED_DATA    ] = "RECOVER_BUFFERED_DATA",
 967         [ MAINTENANCE_IN           ] = "MAINTENANCE_IN",
 968         [ MAINTENANCE_OUT          ] = "MAINTENANCE_OUT",
 969         [ MODE_SELECT              ] = "MODE_SELECT",
 970         [ RESERVE                  ] = "RESERVE",
 971         [ RELEASE                  ] = "RELEASE",
 972         [ COPY                     ] = "COPY",
 973         [ ERASE                    ] = "ERASE",
 974         [ MODE_SENSE               ] = "MODE_SENSE",
 975         [ START_STOP               ] = "START_STOP",
 976         [ RECEIVE_DIAGNOSTIC       ] = "RECEIVE_DIAGNOSTIC",
 977         [ SEND_DIAGNOSTIC          ] = "SEND_DIAGNOSTIC",
 978         [ ALLOW_MEDIUM_REMOVAL     ] = "ALLOW_MEDIUM_REMOVAL",
 979         [ READ_CAPACITY_10         ] = "READ_CAPACITY_10",
 980         [ READ_10                  ] = "READ_10",
 981         [ WRITE_10                 ] = "WRITE_10",
 982         [ SEEK_10                  ] = "SEEK_10",
 983         [ WRITE_VERIFY_10          ] = "WRITE_VERIFY_10",
 984         [ VERIFY_10                ] = "VERIFY_10",
 985         [ SEARCH_HIGH              ] = "SEARCH_HIGH",
 986         [ SEARCH_EQUAL             ] = "SEARCH_EQUAL",
 987         [ SEARCH_LOW               ] = "SEARCH_LOW",
 988         [ SET_LIMITS               ] = "SET_LIMITS",
 989         [ PRE_FETCH                ] = "PRE_FETCH",
 990         /* READ_POSITION and PRE_FETCH use the same operation code */
 991         [ SYNCHRONIZE_CACHE        ] = "SYNCHRONIZE_CACHE",
 992         [ LOCK_UNLOCK_CACHE        ] = "LOCK_UNLOCK_CACHE",
 993         [ READ_DEFECT_DATA         ] = "READ_DEFECT_DATA",
 994         [ MEDIUM_SCAN              ] = "MEDIUM_SCAN",
 995         [ COMPARE                  ] = "COMPARE",
 996         [ COPY_VERIFY              ] = "COPY_VERIFY",
 997         [ WRITE_BUFFER             ] = "WRITE_BUFFER",
 998         [ READ_BUFFER              ] = "READ_BUFFER",
 999         [ UPDATE_BLOCK             ] = "UPDATE_BLOCK",
1000         [ READ_LONG_10             ] = "READ_LONG_10",
1001         [ WRITE_LONG_10            ] = "WRITE_LONG_10",
1002         [ CHANGE_DEFINITION        ] = "CHANGE_DEFINITION",
1003         [ WRITE_SAME_10            ] = "WRITE_SAME_10",
1004         [ UNMAP                    ] = "UNMAP",
1005         [ READ_TOC                 ] = "READ_TOC",
1006         [ REPORT_DENSITY_SUPPORT   ] = "REPORT_DENSITY_SUPPORT",
1007         [ GET_CONFIGURATION        ] = "GET_CONFIGURATION",
1008         [ LOG_SELECT               ] = "LOG_SELECT",
1009         [ LOG_SENSE                ] = "LOG_SENSE",
1010         [ MODE_SELECT_10           ] = "MODE_SELECT_10",
1011         [ RESERVE_10               ] = "RESERVE_10",
1012         [ RELEASE_10               ] = "RELEASE_10",
1013         [ MODE_SENSE_10            ] = "MODE_SENSE_10",
1014         [ PERSISTENT_RESERVE_IN    ] = "PERSISTENT_RESERVE_IN",
1015         [ PERSISTENT_RESERVE_OUT   ] = "PERSISTENT_RESERVE_OUT",
1016         [ WRITE_FILEMARKS_16       ] = "WRITE_FILEMARKS_16",
1017         [ EXTENDED_COPY            ] = "EXTENDED_COPY",
1018         [ ATA_PASSTHROUGH          ] = "ATA_PASSTHROUGH",
1019         [ ACCESS_CONTROL_IN        ] = "ACCESS_CONTROL_IN",
1020         [ ACCESS_CONTROL_OUT       ] = "ACCESS_CONTROL_OUT",
1021         [ READ_16                  ] = "READ_16",
1022         [ COMPARE_AND_WRITE        ] = "COMPARE_AND_WRITE",
1023         [ WRITE_16                 ] = "WRITE_16",
1024         [ WRITE_VERIFY_16          ] = "WRITE_VERIFY_16",
1025         [ VERIFY_16                ] = "VERIFY_16",
1026         [ SYNCHRONIZE_CACHE_16     ] = "SYNCHRONIZE_CACHE_16",
1027         [ LOCATE_16                ] = "LOCATE_16",
1028         [ WRITE_SAME_16            ] = "WRITE_SAME_16",
1029         /* ERASE_16 and WRITE_SAME_16 use the same operation code */
1030         [ SERVICE_ACTION_IN_16     ] = "SERVICE_ACTION_IN_16",
1031         [ WRITE_LONG_16            ] = "WRITE_LONG_16",
1032         [ REPORT_LUNS              ] = "REPORT_LUNS",
1033         [ BLANK                    ] = "BLANK",
1034         [ MOVE_MEDIUM              ] = "MOVE_MEDIUM",
1035         [ LOAD_UNLOAD              ] = "LOAD_UNLOAD",
1036         [ READ_12                  ] = "READ_12",
1037         [ WRITE_12                 ] = "WRITE_12",
1038         [ SERVICE_ACTION_IN_12     ] = "SERVICE_ACTION_IN_12",
1039         [ WRITE_VERIFY_12          ] = "WRITE_VERIFY_12",
1040         [ VERIFY_12                ] = "VERIFY_12",
1041         [ SEARCH_HIGH_12           ] = "SEARCH_HIGH_12",
1042         [ SEARCH_EQUAL_12          ] = "SEARCH_EQUAL_12",
1043         [ SEARCH_LOW_12            ] = "SEARCH_LOW_12",
1044         [ READ_ELEMENT_STATUS      ] = "READ_ELEMENT_STATUS",
1045         [ SEND_VOLUME_TAG          ] = "SEND_VOLUME_TAG",
1046         [ READ_DEFECT_DATA_12      ] = "READ_DEFECT_DATA_12",
1047         [ SET_CD_SPEED             ] = "SET_CD_SPEED",
1048     };
1049
1050     if (cmd >= ARRAY_SIZE(names) || names[cmd] == NULL)
1051         return "*UNKNOWN*";
1052     return names[cmd];
1053 }
1054
1055 SCSIRequest *scsi_req_ref(SCSIRequest *req)
1056 {
1057     req->refcount++;
1058     return req;
1059 }
1060
1061 void scsi_req_unref(SCSIRequest *req)
1062 {
1063     if (--req->refcount == 0) {
1064         if (req->ops->free_req) {
1065             req->ops->free_req(req);
1066         }
1067         g_free(req);
1068     }
1069 }
1070
1071 /* Tell the device that we finished processing this chunk of I/O.  It
1072    will start the next chunk or complete the command.  */
1073 void scsi_req_continue(SCSIRequest *req)
1074 {
1075     trace_scsi_req_continue(req->dev->id, req->lun, req->tag);
1076     if (req->cmd.mode == SCSI_XFER_TO_DEV) {
1077         req->ops->write_data(req);
1078     } else {
1079         req->ops->read_data(req);
1080     }
1081 }
1082
1083 /* Called by the devices when data is ready for the HBA.  The HBA should
1084    start a DMA operation to read or fill the device's data buffer.
1085    Once it completes, calling scsi_req_continue will restart I/O.  */
1086 void scsi_req_data(SCSIRequest *req, int len)
1087 {
1088     trace_scsi_req_data(req->dev->id, req->lun, req->tag, len);
1089     req->bus->info->transfer_data(req, len);
1090 }
1091
1092 void scsi_req_print(SCSIRequest *req)
1093 {
1094     FILE *fp = stderr;
1095     int i;
1096
1097     fprintf(fp, "[%s id=%d] %s",
1098             req->dev->qdev.parent_bus->name,
1099             req->dev->id,
1100             scsi_command_name(req->cmd.buf[0]));
1101     for (i = 1; i < req->cmd.len; i++) {
1102         fprintf(fp, " 0x%02x", req->cmd.buf[i]);
1103     }
1104     switch (req->cmd.mode) {
1105     case SCSI_XFER_NONE:
1106         fprintf(fp, " - none\n");
1107         break;
1108     case SCSI_XFER_FROM_DEV:
1109         fprintf(fp, " - from-dev len=%zd\n", req->cmd.xfer);
1110         break;
1111     case SCSI_XFER_TO_DEV:
1112         fprintf(fp, " - to-dev len=%zd\n", req->cmd.xfer);
1113         break;
1114     default:
1115         fprintf(fp, " - Oops\n");
1116         break;
1117     }
1118 }
1119
1120 void scsi_req_complete(SCSIRequest *req, int status)
1121 {
1122     assert(req->status == -1);
1123     req->status = status;
1124
1125     assert(req->sense_len < sizeof(req->sense));
1126     if (status == GOOD) {
1127         req->sense_len = 0;
1128     }
1129
1130     if (req->sense_len) {
1131         memcpy(req->dev->sense, req->sense, req->sense_len);
1132         req->dev->sense_len = req->sense_len;
1133         req->dev->sense_is_ua = (req->ops == &reqops_unit_attention);
1134     } else {
1135         req->dev->sense_len = 0;
1136         req->dev->sense_is_ua = false;
1137     }
1138
1139     /*
1140      * Unit attention state is now stored in the device's sense buffer
1141      * if the HBA didn't do autosense.  Clear the pending unit attention
1142      * flags.
1143      */
1144     scsi_clear_unit_attention(req);
1145
1146     scsi_req_ref(req);
1147     scsi_req_dequeue(req);
1148     req->bus->info->complete(req, req->status);
1149     scsi_req_unref(req);
1150 }
1151
1152 void scsi_req_cancel(SCSIRequest *req)
1153 {
1154     if (req->ops->cancel_io) {
1155         req->ops->cancel_io(req);
1156     }
1157     scsi_req_ref(req);
1158     scsi_req_dequeue(req);
1159     if (req->bus->info->cancel) {
1160         req->bus->info->cancel(req);
1161     }
1162     scsi_req_unref(req);
1163 }
1164
1165 void scsi_req_abort(SCSIRequest *req, int status)
1166 {
1167     if (req->ops->cancel_io) {
1168         req->ops->cancel_io(req);
1169     }
1170     scsi_req_complete(req, status);
1171 }
1172
1173 void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense)
1174 {
1175     SCSIRequest *req;
1176
1177     while (!QTAILQ_EMPTY(&sdev->requests)) {
1178         req = QTAILQ_FIRST(&sdev->requests);
1179         scsi_req_cancel(req);
1180     }
1181     sdev->unit_attention = sense;
1182 }
1183
1184 static char *scsibus_get_fw_dev_path(DeviceState *dev)
1185 {
1186     SCSIDevice *d = DO_UPCAST(SCSIDevice, qdev, dev);
1187     char path[100];
1188
1189     snprintf(path, sizeof(path), "%s@%d:%d:%d", qdev_fw_name(dev),
1190              0, d->id, d->lun);
1191
1192     return strdup(path);
1193 }
1194
1195 SCSIDevice *scsi_device_find(SCSIBus *bus, int id, int lun)
1196 {
1197     DeviceState *qdev;
1198     SCSIDevice *target_dev = NULL;
1199
1200     QTAILQ_FOREACH_REVERSE(qdev, &bus->qbus.children, ChildrenHead, sibling) {
1201         SCSIDevice *dev = DO_UPCAST(SCSIDevice, qdev, qdev);
1202
1203         if (dev->id == id) {
1204             if (dev->lun == lun) {
1205                 return dev;
1206             }
1207             target_dev = dev;
1208         }
1209     }
1210     return target_dev;
1211 }