2 #include "qemu-error.h"
9 static char *scsibus_get_fw_dev_path(DeviceState *dev);
11 static struct BusInfo scsi_bus_info = {
13 .size = sizeof(SCSIBus),
14 .get_fw_dev_path = scsibus_get_fw_dev_path,
15 .props = (Property[]) {
16 DEFINE_PROP_UINT32("scsi-id", SCSIDevice, id, -1),
17 DEFINE_PROP_END_OF_LIST(),
20 static int next_scsi_bus;
22 /* Create a scsi bus, and attach devices to it. */
23 void scsi_bus_new(SCSIBus *bus, DeviceState *host, int tcq, int ndev,
24 const SCSIBusOps *ops)
26 qbus_create_inplace(&bus->qbus, &scsi_bus_info, host, NULL);
27 bus->busnr = next_scsi_bus++;
31 bus->qbus.allow_hotplug = 1;
34 static int scsi_qdev_init(DeviceState *qdev, DeviceInfo *base)
36 SCSIDevice *dev = DO_UPCAST(SCSIDevice, qdev, qdev);
37 SCSIDeviceInfo *info = DO_UPCAST(SCSIDeviceInfo, qdev, base);
38 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
42 for (dev->id = 0; dev->id < bus->ndev; dev->id++) {
43 if (bus->devs[dev->id] == NULL)
47 if (dev->id >= bus->ndev) {
48 error_report("bad scsi device id: %d", dev->id);
52 if (bus->devs[dev->id]) {
53 qdev_free(&bus->devs[dev->id]->qdev);
55 bus->devs[dev->id] = dev;
58 QTAILQ_INIT(&dev->requests);
59 rc = dev->info->init(dev);
61 bus->devs[dev->id] = NULL;
68 static int scsi_qdev_exit(DeviceState *qdev)
70 SCSIDevice *dev = DO_UPCAST(SCSIDevice, qdev, qdev);
71 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
73 assert(bus->devs[dev->id] != NULL);
74 if (bus->devs[dev->id]->info->destroy) {
75 bus->devs[dev->id]->info->destroy(bus->devs[dev->id]);
77 bus->devs[dev->id] = NULL;
81 void scsi_qdev_register(SCSIDeviceInfo *info)
83 info->qdev.bus_info = &scsi_bus_info;
84 info->qdev.init = scsi_qdev_init;
85 info->qdev.unplug = qdev_simple_unplug_cb;
86 info->qdev.exit = scsi_qdev_exit;
87 qdev_register(&info->qdev);
90 /* handle legacy '-drive if=scsi,...' cmd line args */
91 SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockDriverState *bdrv,
92 int unit, bool removable)
97 driver = bdrv_is_sg(bdrv) ? "scsi-generic" : "scsi-disk";
98 dev = qdev_create(&bus->qbus, driver);
99 qdev_prop_set_uint32(dev, "scsi-id", unit);
100 if (qdev_prop_exists(dev, "removable")) {
101 qdev_prop_set_bit(dev, "removable", removable);
103 if (qdev_prop_set_drive(dev, "drive", bdrv) < 0) {
107 if (qdev_init(dev) < 0)
109 return DO_UPCAST(SCSIDevice, qdev, dev);
112 int scsi_bus_legacy_handle_cmdline(SCSIBus *bus)
119 for (unit = 0; unit < bus->ndev; unit++) {
120 dinfo = drive_get(IF_SCSI, bus->busnr, unit);
124 qemu_opts_loc_restore(dinfo->opts);
125 if (!scsi_bus_legacy_add_drive(bus, dinfo->bdrv, unit, false)) {
134 SCSIRequest *scsi_req_alloc(size_t size, SCSIDevice *d, uint32_t tag, uint32_t lun)
138 req = qemu_mallocz(size);
140 req->bus = scsi_bus_from_device(d);
145 trace_scsi_req_alloc(req->dev->id, req->lun, req->tag);
149 SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun)
151 return d->info->alloc_req(d, tag, lun);
154 uint8_t *scsi_req_get_buf(SCSIRequest *req)
156 return req->dev->info->get_buf(req);
159 int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len)
161 if (req->dev->info->get_sense) {
162 return req->dev->info->get_sense(req, buf, len);
168 int32_t scsi_req_enqueue(SCSIRequest *req, uint8_t *buf)
172 assert(!req->enqueued);
174 req->enqueued = true;
175 QTAILQ_INSERT_TAIL(&req->dev->requests, req, next);
178 rc = req->dev->info->send_command(req, buf);
183 static void scsi_req_dequeue(SCSIRequest *req)
185 trace_scsi_req_dequeue(req->dev->id, req->lun, req->tag);
187 QTAILQ_REMOVE(&req->dev->requests, req, next);
188 req->enqueued = false;
193 static int scsi_req_length(SCSIRequest *req, uint8_t *cmd)
195 switch (cmd[0] >> 5) {
197 req->cmd.xfer = cmd[4];
199 /* length 0 means 256 blocks */
200 if (req->cmd.xfer == 0)
205 req->cmd.xfer = cmd[8] | (cmd[7] << 8);
209 req->cmd.xfer = cmd[13] | (cmd[12] << 8) | (cmd[11] << 16) | (cmd[10] << 24);
213 req->cmd.xfer = cmd[9] | (cmd[8] << 8) | (cmd[7] << 16) | (cmd[6] << 24);
217 trace_scsi_req_parse_bad(req->dev->id, req->lun, req->tag, cmd[0]);
222 case TEST_UNIT_READY:
226 case WRITE_FILEMARKS:
231 case ALLOW_MEDIUM_REMOVAL:
234 case SYNCHRONIZE_CACHE:
235 case LOCK_UNLOCK_CACHE:
252 case READ_BLOCK_LIMITS:
258 case SEND_VOLUME_TAG:
268 case WRITE_VERIFY_12:
270 case WRITE_VERIFY_16:
271 req->cmd.xfer *= req->dev->blocksize;
276 case RECOVER_BUFFERED_DATA:
279 req->cmd.xfer *= req->dev->blocksize;
282 req->cmd.xfer = cmd[4] | (cmd[3] << 8);
284 case MAINTENANCE_OUT:
286 if (req->dev->type == TYPE_ROM) {
287 /* GPCMD_REPORT_KEY and GPCMD_SEND_KEY from multi media commands */
288 req->cmd.xfer = cmd[9] | (cmd[8] << 8);
295 static int scsi_req_stream_length(SCSIRequest *req, uint8_t *cmd)
298 /* stream commands */
301 case RECOVER_BUFFERED_DATA:
304 req->cmd.xfer = cmd[4] | (cmd[3] << 8) | (cmd[2] << 16);
305 if (cmd[1] & 0x01) /* fixed */
306 req->cmd.xfer *= req->dev->blocksize;
313 /* generic commands */
315 return scsi_req_length(req, cmd);
320 static void scsi_req_xfer_mode(SCSIRequest *req)
322 switch (req->cmd.buf[0]) {
327 case WRITE_VERIFY_12:
329 case WRITE_VERIFY_16:
333 case CHANGE_DEFINITION:
337 case SEND_DIAGNOSTIC:
340 case REASSIGN_BLOCKS:
348 case SEARCH_EQUAL_12:
352 case SEND_VOLUME_TAG:
354 case PERSISTENT_RESERVE_OUT:
355 case MAINTENANCE_OUT:
356 req->cmd.mode = SCSI_XFER_TO_DEV;
360 req->cmd.mode = SCSI_XFER_FROM_DEV;
362 req->cmd.mode = SCSI_XFER_NONE;
368 static uint64_t scsi_req_lba(SCSIRequest *req)
370 uint8_t *buf = req->cmd.buf;
373 switch (buf[0] >> 5) {
375 lba = (uint64_t) buf[3] | ((uint64_t) buf[2] << 8) |
376 (((uint64_t) buf[1] & 0x1f) << 16);
380 lba = (uint64_t) buf[5] | ((uint64_t) buf[4] << 8) |
381 ((uint64_t) buf[3] << 16) | ((uint64_t) buf[2] << 24);
384 lba = (uint64_t) buf[9] | ((uint64_t) buf[8] << 8) |
385 ((uint64_t) buf[7] << 16) | ((uint64_t) buf[6] << 24) |
386 ((uint64_t) buf[5] << 32) | ((uint64_t) buf[4] << 40) |
387 ((uint64_t) buf[3] << 48) | ((uint64_t) buf[2] << 56);
390 lba = (uint64_t) buf[5] | ((uint64_t) buf[4] << 8) |
391 ((uint64_t) buf[3] << 16) | ((uint64_t) buf[2] << 24);
400 int scsi_req_parse(SCSIRequest *req, uint8_t *buf)
404 if (req->dev->type == TYPE_TAPE) {
405 rc = scsi_req_stream_length(req, buf);
407 rc = scsi_req_length(req, buf);
412 memcpy(req->cmd.buf, buf, req->cmd.len);
413 scsi_req_xfer_mode(req);
414 req->cmd.lba = scsi_req_lba(req);
415 trace_scsi_req_parsed(req->dev->id, req->lun, req->tag, buf[0],
416 req->cmd.mode, req->cmd.xfer);
417 if (req->cmd.lba != -1) {
418 trace_scsi_req_parsed_lba(req->dev->id, req->lun, req->tag, buf[0],
425 * Predefined sense codes
428 /* No sense data available */
429 const struct SCSISense sense_code_NO_SENSE = {
430 .key = NO_SENSE , .asc = 0x00 , .ascq = 0x00
433 /* LUN not ready, Manual intervention required */
434 const struct SCSISense sense_code_LUN_NOT_READY = {
435 .key = NOT_READY, .asc = 0x04, .ascq = 0x03
438 /* LUN not ready, Medium not present */
439 const struct SCSISense sense_code_NO_MEDIUM = {
440 .key = NOT_READY, .asc = 0x3a, .ascq = 0x00
443 /* Hardware error, internal target failure */
444 const struct SCSISense sense_code_TARGET_FAILURE = {
445 .key = HARDWARE_ERROR, .asc = 0x44, .ascq = 0x00
448 /* Illegal request, invalid command operation code */
449 const struct SCSISense sense_code_INVALID_OPCODE = {
450 .key = ILLEGAL_REQUEST, .asc = 0x20, .ascq = 0x00
453 /* Illegal request, LBA out of range */
454 const struct SCSISense sense_code_LBA_OUT_OF_RANGE = {
455 .key = ILLEGAL_REQUEST, .asc = 0x21, .ascq = 0x00
458 /* Illegal request, Invalid field in CDB */
459 const struct SCSISense sense_code_INVALID_FIELD = {
460 .key = ILLEGAL_REQUEST, .asc = 0x24, .ascq = 0x00
463 /* Illegal request, LUN not supported */
464 const struct SCSISense sense_code_LUN_NOT_SUPPORTED = {
465 .key = ILLEGAL_REQUEST, .asc = 0x25, .ascq = 0x00
468 /* Command aborted, I/O process terminated */
469 const struct SCSISense sense_code_IO_ERROR = {
470 .key = ABORTED_COMMAND, .asc = 0x00, .ascq = 0x06
473 /* Command aborted, I_T Nexus loss occurred */
474 const struct SCSISense sense_code_I_T_NEXUS_LOSS = {
475 .key = ABORTED_COMMAND, .asc = 0x29, .ascq = 0x07
478 /* Command aborted, Logical Unit failure */
479 const struct SCSISense sense_code_LUN_FAILURE = {
480 .key = ABORTED_COMMAND, .asc = 0x3e, .ascq = 0x01
486 * Build a sense buffer
488 int scsi_build_sense(SCSISense sense, uint8_t *buf, int len, int fixed)
490 if (!fixed && len < 8) {
496 /* Return fixed format sense buffer */
501 buf[13] = sense.ascq;
504 /* Return descriptor format sense buffer */
513 static const char *scsi_command_name(uint8_t cmd)
515 static const char *names[] = {
516 [ TEST_UNIT_READY ] = "TEST_UNIT_READY",
517 [ REZERO_UNIT ] = "REZERO_UNIT",
518 /* REWIND and REZERO_UNIT use the same operation code */
519 [ REQUEST_SENSE ] = "REQUEST_SENSE",
520 [ FORMAT_UNIT ] = "FORMAT_UNIT",
521 [ READ_BLOCK_LIMITS ] = "READ_BLOCK_LIMITS",
522 [ REASSIGN_BLOCKS ] = "REASSIGN_BLOCKS",
523 [ READ_6 ] = "READ_6",
524 [ WRITE_6 ] = "WRITE_6",
525 [ SEEK_6 ] = "SEEK_6",
526 [ READ_REVERSE ] = "READ_REVERSE",
527 [ WRITE_FILEMARKS ] = "WRITE_FILEMARKS",
529 [ INQUIRY ] = "INQUIRY",
530 [ RECOVER_BUFFERED_DATA ] = "RECOVER_BUFFERED_DATA",
531 [ MAINTENANCE_IN ] = "MAINTENANCE_IN",
532 [ MAINTENANCE_OUT ] = "MAINTENANCE_OUT",
533 [ MODE_SELECT ] = "MODE_SELECT",
534 [ RESERVE ] = "RESERVE",
535 [ RELEASE ] = "RELEASE",
538 [ MODE_SENSE ] = "MODE_SENSE",
539 [ START_STOP ] = "START_STOP",
540 [ RECEIVE_DIAGNOSTIC ] = "RECEIVE_DIAGNOSTIC",
541 [ SEND_DIAGNOSTIC ] = "SEND_DIAGNOSTIC",
542 [ ALLOW_MEDIUM_REMOVAL ] = "ALLOW_MEDIUM_REMOVAL",
544 [ SET_WINDOW ] = "SET_WINDOW",
545 [ READ_CAPACITY ] = "READ_CAPACITY",
546 [ READ_10 ] = "READ_10",
547 [ WRITE_10 ] = "WRITE_10",
548 [ SEEK_10 ] = "SEEK_10",
549 [ WRITE_VERIFY ] = "WRITE_VERIFY",
550 [ VERIFY ] = "VERIFY",
551 [ SEARCH_HIGH ] = "SEARCH_HIGH",
552 [ SEARCH_EQUAL ] = "SEARCH_EQUAL",
553 [ SEARCH_LOW ] = "SEARCH_LOW",
554 [ SET_LIMITS ] = "SET_LIMITS",
555 [ PRE_FETCH ] = "PRE_FETCH",
556 /* READ_POSITION and PRE_FETCH use the same operation code */
557 [ SYNCHRONIZE_CACHE ] = "SYNCHRONIZE_CACHE",
558 [ LOCK_UNLOCK_CACHE ] = "LOCK_UNLOCK_CACHE",
559 [ READ_DEFECT_DATA ] = "READ_DEFECT_DATA",
560 [ MEDIUM_SCAN ] = "MEDIUM_SCAN",
561 [ COMPARE ] = "COMPARE",
562 [ COPY_VERIFY ] = "COPY_VERIFY",
563 [ WRITE_BUFFER ] = "WRITE_BUFFER",
564 [ READ_BUFFER ] = "READ_BUFFER",
565 [ UPDATE_BLOCK ] = "UPDATE_BLOCK",
566 [ READ_LONG ] = "READ_LONG",
567 [ WRITE_LONG ] = "WRITE_LONG",
568 [ CHANGE_DEFINITION ] = "CHANGE_DEFINITION",
569 [ WRITE_SAME ] = "WRITE_SAME",
570 [ READ_TOC ] = "READ_TOC",
571 [ LOG_SELECT ] = "LOG_SELECT",
572 [ LOG_SENSE ] = "LOG_SENSE",
573 [ MODE_SELECT_10 ] = "MODE_SELECT_10",
574 [ RESERVE_10 ] = "RESERVE_10",
575 [ RELEASE_10 ] = "RELEASE_10",
576 [ MODE_SENSE_10 ] = "MODE_SENSE_10",
577 [ PERSISTENT_RESERVE_IN ] = "PERSISTENT_RESERVE_IN",
578 [ PERSISTENT_RESERVE_OUT ] = "PERSISTENT_RESERVE_OUT",
579 [ MOVE_MEDIUM ] = "MOVE_MEDIUM",
580 [ READ_12 ] = "READ_12",
581 [ WRITE_12 ] = "WRITE_12",
582 [ WRITE_VERIFY_12 ] = "WRITE_VERIFY_12",
583 [ SEARCH_HIGH_12 ] = "SEARCH_HIGH_12",
584 [ SEARCH_EQUAL_12 ] = "SEARCH_EQUAL_12",
585 [ SEARCH_LOW_12 ] = "SEARCH_LOW_12",
586 [ READ_ELEMENT_STATUS ] = "READ_ELEMENT_STATUS",
587 [ SEND_VOLUME_TAG ] = "SEND_VOLUME_TAG",
588 [ WRITE_LONG_2 ] = "WRITE_LONG_2",
590 [ REPORT_DENSITY_SUPPORT ] = "REPORT_DENSITY_SUPPORT",
591 [ GET_CONFIGURATION ] = "GET_CONFIGURATION",
592 [ READ_16 ] = "READ_16",
593 [ WRITE_16 ] = "WRITE_16",
594 [ WRITE_VERIFY_16 ] = "WRITE_VERIFY_16",
595 [ SERVICE_ACTION_IN ] = "SERVICE_ACTION_IN",
596 [ REPORT_LUNS ] = "REPORT_LUNS",
597 [ LOAD_UNLOAD ] = "LOAD_UNLOAD",
598 [ SET_CD_SPEED ] = "SET_CD_SPEED",
602 if (cmd >= ARRAY_SIZE(names) || names[cmd] == NULL)
607 SCSIRequest *scsi_req_ref(SCSIRequest *req)
613 void scsi_req_unref(SCSIRequest *req)
615 if (--req->refcount == 0) {
616 if (req->dev->info->free_req) {
617 req->dev->info->free_req(req);
623 /* Tell the device that we finished processing this chunk of I/O. It
624 will start the next chunk or complete the command. */
625 void scsi_req_continue(SCSIRequest *req)
627 trace_scsi_req_continue(req->dev->id, req->lun, req->tag);
628 if (req->cmd.mode == SCSI_XFER_TO_DEV) {
629 req->dev->info->write_data(req);
631 req->dev->info->read_data(req);
635 /* Called by the devices when data is ready for the HBA. The HBA should
636 start a DMA operation to read or fill the device's data buffer.
637 Once it completes, calling scsi_req_continue will restart I/O. */
638 void scsi_req_data(SCSIRequest *req, int len)
640 trace_scsi_req_data(req->dev->id, req->lun, req->tag, len);
641 req->bus->ops->transfer_data(req, len);
644 void scsi_req_print(SCSIRequest *req)
649 fprintf(fp, "[%s id=%d] %s",
650 req->dev->qdev.parent_bus->name,
652 scsi_command_name(req->cmd.buf[0]));
653 for (i = 1; i < req->cmd.len; i++) {
654 fprintf(fp, " 0x%02x", req->cmd.buf[i]);
656 switch (req->cmd.mode) {
658 fprintf(fp, " - none\n");
660 case SCSI_XFER_FROM_DEV:
661 fprintf(fp, " - from-dev len=%zd\n", req->cmd.xfer);
663 case SCSI_XFER_TO_DEV:
664 fprintf(fp, " - to-dev len=%zd\n", req->cmd.xfer);
667 fprintf(fp, " - Oops\n");
672 void scsi_req_complete(SCSIRequest *req)
674 assert(req->status != -1);
676 scsi_req_dequeue(req);
677 req->bus->ops->complete(req, req->status);
681 void scsi_req_cancel(SCSIRequest *req)
683 if (req->dev && req->dev->info->cancel_io) {
684 req->dev->info->cancel_io(req);
687 scsi_req_dequeue(req);
688 if (req->bus->ops->cancel) {
689 req->bus->ops->cancel(req);
694 void scsi_req_abort(SCSIRequest *req, int status)
696 req->status = status;
697 if (req->dev && req->dev->info->cancel_io) {
698 req->dev->info->cancel_io(req);
700 scsi_req_complete(req);
703 void scsi_device_purge_requests(SCSIDevice *sdev)
707 while (!QTAILQ_EMPTY(&sdev->requests)) {
708 req = QTAILQ_FIRST(&sdev->requests);
709 scsi_req_cancel(req);
713 static char *scsibus_get_fw_dev_path(DeviceState *dev)
715 SCSIDevice *d = (SCSIDevice*)dev;
716 SCSIBus *bus = scsi_bus_from_device(d);
720 for (i = 0; i < bus->ndev; i++) {
721 if (bus->devs[i] == d) {
726 assert(i != bus->ndev);
728 snprintf(path, sizeof(path), "%s@%x", qdev_fw_name(dev), i);