2 #include "qemu/error-report.h"
3 #include "hw/scsi/scsi.h"
4 #include "block/scsi.h"
6 #include "sysemu/blockdev.h"
8 #include "sysemu/dma.h"
10 static char *scsibus_get_dev_path(DeviceState *dev);
11 static char *scsibus_get_fw_dev_path(DeviceState *dev);
12 static int scsi_req_parse(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf);
13 static void scsi_req_dequeue(SCSIRequest *req);
15 static Property scsi_props[] = {
16 DEFINE_PROP_UINT32("channel", SCSIDevice, channel, 0),
17 DEFINE_PROP_UINT32("scsi-id", SCSIDevice, id, -1),
18 DEFINE_PROP_UINT32("lun", SCSIDevice, lun, -1),
19 DEFINE_PROP_END_OF_LIST(),
22 static void scsi_bus_class_init(ObjectClass *klass, void *data)
24 BusClass *k = BUS_CLASS(klass);
26 k->get_dev_path = scsibus_get_dev_path;
27 k->get_fw_dev_path = scsibus_get_fw_dev_path;
30 static const TypeInfo scsi_bus_info = {
31 .name = TYPE_SCSI_BUS,
33 .instance_size = sizeof(SCSIBus),
34 .class_init = scsi_bus_class_init,
36 static int next_scsi_bus;
38 static int scsi_device_init(SCSIDevice *s)
40 SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
47 static void scsi_device_destroy(SCSIDevice *s)
49 SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
55 static SCSIRequest *scsi_device_alloc_req(SCSIDevice *s, uint32_t tag, uint32_t lun,
56 uint8_t *buf, void *hba_private)
58 SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
60 return sc->alloc_req(s, tag, lun, buf, hba_private);
66 static void scsi_device_unit_attention_reported(SCSIDevice *s)
68 SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
69 if (sc->unit_attention_reported) {
70 sc->unit_attention_reported(s);
74 /* Create a scsi bus, and attach devices to it. */
75 void scsi_bus_new(SCSIBus *bus, size_t bus_size, DeviceState *host,
76 const SCSIBusInfo *info, const char *bus_name)
78 qbus_create_inplace(bus, bus_size, TYPE_SCSI_BUS, host, bus_name);
79 bus->busnr = next_scsi_bus++;
81 bus->qbus.allow_hotplug = 1;
84 static void scsi_dma_restart_bh(void *opaque)
86 SCSIDevice *s = opaque;
87 SCSIRequest *req, *next;
89 qemu_bh_delete(s->bh);
92 QTAILQ_FOREACH_SAFE(req, &s->requests, next, next) {
96 switch (req->cmd.mode) {
97 case SCSI_XFER_FROM_DEV:
98 case SCSI_XFER_TO_DEV:
99 scsi_req_continue(req);
103 scsi_req_dequeue(req);
104 scsi_req_enqueue(req);
112 void scsi_req_retry(SCSIRequest *req)
114 /* No need to save a reference, because scsi_dma_restart_bh just
115 * looks at the request list. */
119 static void scsi_dma_restart_cb(void *opaque, int running, RunState state)
121 SCSIDevice *s = opaque;
127 s->bh = qemu_bh_new(scsi_dma_restart_bh, s);
128 qemu_bh_schedule(s->bh);
132 static int scsi_qdev_init(DeviceState *qdev)
134 SCSIDevice *dev = SCSI_DEVICE(qdev);
135 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
139 if (dev->channel > bus->info->max_channel) {
140 error_report("bad scsi channel id: %d", dev->channel);
143 if (dev->id != -1 && dev->id > bus->info->max_target) {
144 error_report("bad scsi device id: %d", dev->id);
147 if (dev->lun != -1 && dev->lun > bus->info->max_lun) {
148 error_report("bad scsi device lun: %d", dev->lun);
154 if (dev->lun == -1) {
158 d = scsi_device_find(bus, dev->channel, ++id, dev->lun);
159 } while (d && d->lun == dev->lun && id < bus->info->max_target);
160 if (d && d->lun == dev->lun) {
161 error_report("no free target");
165 } else if (dev->lun == -1) {
168 d = scsi_device_find(bus, dev->channel, dev->id, ++lun);
169 } while (d && d->lun == lun && lun < bus->info->max_lun);
170 if (d && d->lun == lun) {
171 error_report("no free lun");
176 d = scsi_device_find(bus, dev->channel, dev->id, dev->lun);
178 if (d->lun == dev->lun && dev != d) {
183 QTAILQ_INIT(&dev->requests);
184 rc = scsi_device_init(dev);
186 dev->vmsentry = qemu_add_vm_change_state_handler(scsi_dma_restart_cb,
190 if (bus->info->hotplug) {
191 bus->info->hotplug(bus, dev);
198 static int scsi_qdev_exit(DeviceState *qdev)
200 SCSIDevice *dev = SCSI_DEVICE(qdev);
203 qemu_del_vm_change_state_handler(dev->vmsentry);
205 scsi_device_destroy(dev);
209 /* handle legacy '-drive if=scsi,...' cmd line args */
210 SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockDriverState *bdrv,
211 int unit, bool removable, int bootindex,
212 const char *serial, Error **errp)
218 driver = bdrv_is_sg(bdrv) ? "scsi-generic" : "scsi-disk";
219 dev = qdev_create(&bus->qbus, driver);
220 qdev_prop_set_uint32(dev, "scsi-id", unit);
221 if (bootindex >= 0) {
222 qdev_prop_set_int32(dev, "bootindex", bootindex);
224 if (object_property_find(OBJECT(dev), "removable", NULL)) {
225 qdev_prop_set_bit(dev, "removable", removable);
227 if (serial && object_property_find(OBJECT(dev), "serial", NULL)) {
228 qdev_prop_set_string(dev, "serial", serial);
230 if (qdev_prop_set_drive(dev, "drive", bdrv) < 0) {
231 error_setg(errp, "Setting drive property failed");
235 object_property_set_bool(OBJECT(dev), true, "realized", &err);
237 error_propagate(errp, err);
241 return SCSI_DEVICE(dev);
244 void scsi_bus_legacy_handle_cmdline(SCSIBus *bus, Error **errp)
252 for (unit = 0; unit <= bus->info->max_target; unit++) {
253 dinfo = drive_get(IF_SCSI, bus->busnr, unit);
257 qemu_opts_loc_restore(dinfo->opts);
258 scsi_bus_legacy_add_drive(bus, dinfo->bdrv, unit, false, -1, NULL,
261 error_propagate(errp, err);
268 static int32_t scsi_invalid_field(SCSIRequest *req, uint8_t *buf)
270 scsi_req_build_sense(req, SENSE_CODE(INVALID_FIELD));
271 scsi_req_complete(req, CHECK_CONDITION);
275 static const struct SCSIReqOps reqops_invalid_field = {
276 .size = sizeof(SCSIRequest),
277 .send_command = scsi_invalid_field
280 /* SCSIReqOps implementation for invalid commands. */
282 static int32_t scsi_invalid_command(SCSIRequest *req, uint8_t *buf)
284 scsi_req_build_sense(req, SENSE_CODE(INVALID_OPCODE));
285 scsi_req_complete(req, CHECK_CONDITION);
289 static const struct SCSIReqOps reqops_invalid_opcode = {
290 .size = sizeof(SCSIRequest),
291 .send_command = scsi_invalid_command
294 /* SCSIReqOps implementation for unit attention conditions. */
296 static int32_t scsi_unit_attention(SCSIRequest *req, uint8_t *buf)
298 if (req->dev->unit_attention.key == UNIT_ATTENTION) {
299 scsi_req_build_sense(req, req->dev->unit_attention);
300 } else if (req->bus->unit_attention.key == UNIT_ATTENTION) {
301 scsi_req_build_sense(req, req->bus->unit_attention);
303 scsi_req_complete(req, CHECK_CONDITION);
307 static const struct SCSIReqOps reqops_unit_attention = {
308 .size = sizeof(SCSIRequest),
309 .send_command = scsi_unit_attention
312 /* SCSIReqOps implementation for REPORT LUNS and for commands sent to
315 typedef struct SCSITargetReq SCSITargetReq;
317 struct SCSITargetReq {
323 static void store_lun(uint8_t *outbuf, int lun)
329 outbuf[1] = (lun & 255);
330 outbuf[0] = (lun >> 8) | 0x40;
333 static bool scsi_target_emulate_report_luns(SCSITargetReq *r)
340 if (r->req.cmd.xfer < 16) {
343 if (r->req.cmd.buf[2] > 2) {
346 channel = r->req.dev->channel;
350 QTAILQ_FOREACH(kid, &r->req.bus->qbus.children, sibling) {
351 DeviceState *qdev = kid->child;
352 SCSIDevice *dev = SCSI_DEVICE(qdev);
354 if (dev->channel == channel && dev->id == id) {
364 len = MIN(n + 8, r->req.cmd.xfer & ~7);
365 if (len > sizeof(r->buf)) {
366 /* TODO: > 256 LUNs? */
370 memset(r->buf, 0, len);
371 stl_be_p(&r->buf, n);
372 i = found_lun0 ? 8 : 16;
373 QTAILQ_FOREACH(kid, &r->req.bus->qbus.children, sibling) {
374 DeviceState *qdev = kid->child;
375 SCSIDevice *dev = SCSI_DEVICE(qdev);
377 if (dev->channel == channel && dev->id == id) {
378 store_lun(&r->buf[i], dev->lun);
387 static bool scsi_target_emulate_inquiry(SCSITargetReq *r)
389 assert(r->req.dev->lun != r->req.lun);
390 if (r->req.cmd.buf[1] & 0x2) {
391 /* Command support data - optional, not implemented */
395 if (r->req.cmd.buf[1] & 0x1) {
396 /* Vital product data */
397 uint8_t page_code = r->req.cmd.buf[2];
398 r->buf[r->len++] = page_code ; /* this page */
399 r->buf[r->len++] = 0x00;
402 case 0x00: /* Supported page codes, mandatory */
406 r->buf[r->len++] = 0x00; /* list of supported pages (this page) */
407 r->buf[pages] = r->len - pages - 1; /* number of pages */
414 assert(r->len < sizeof(r->buf));
415 r->len = MIN(r->req.cmd.xfer, r->len);
419 /* Standard INQUIRY data */
420 if (r->req.cmd.buf[2] != 0) {
425 r->len = MIN(r->req.cmd.xfer, 36);
426 memset(r->buf, 0, r->len);
427 if (r->req.lun != 0) {
428 r->buf[0] = TYPE_NO_LUN;
430 r->buf[0] = TYPE_NOT_PRESENT | TYPE_INACTIVE;
431 r->buf[2] = 5; /* Version */
432 r->buf[3] = 2 | 0x10; /* HiSup, response data format */
433 r->buf[4] = r->len - 5; /* Additional Length = (Len - 1) - 4 */
434 r->buf[7] = 0x10 | (r->req.bus->info->tcq ? 0x02 : 0); /* Sync, TCQ. */
435 memcpy(&r->buf[8], "QEMU ", 8);
436 memcpy(&r->buf[16], "QEMU TARGET ", 16);
437 pstrcpy((char *) &r->buf[32], 4, qemu_get_version());
442 static int32_t scsi_target_send_command(SCSIRequest *req, uint8_t *buf)
444 SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
448 if (!scsi_target_emulate_report_luns(r)) {
449 goto illegal_request;
453 if (!scsi_target_emulate_inquiry(r)) {
454 goto illegal_request;
458 r->len = scsi_device_get_sense(r->req.dev, r->buf,
459 MIN(req->cmd.xfer, sizeof r->buf),
460 (req->cmd.buf[1] & 1) == 0);
461 if (r->req.dev->sense_is_ua) {
462 scsi_device_unit_attention_reported(req->dev);
463 r->req.dev->sense_len = 0;
464 r->req.dev->sense_is_ua = false;
468 scsi_req_build_sense(req, SENSE_CODE(LUN_NOT_SUPPORTED));
469 scsi_req_complete(req, CHECK_CONDITION);
472 scsi_req_build_sense(req, SENSE_CODE(INVALID_FIELD));
473 scsi_req_complete(req, CHECK_CONDITION);
478 scsi_req_complete(req, GOOD);
483 static void scsi_target_read_data(SCSIRequest *req)
485 SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
491 scsi_req_data(&r->req, n);
493 scsi_req_complete(&r->req, GOOD);
497 static uint8_t *scsi_target_get_buf(SCSIRequest *req)
499 SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
504 static const struct SCSIReqOps reqops_target_command = {
505 .size = sizeof(SCSITargetReq),
506 .send_command = scsi_target_send_command,
507 .read_data = scsi_target_read_data,
508 .get_buf = scsi_target_get_buf,
512 SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d,
513 uint32_t tag, uint32_t lun, void *hba_private)
516 SCSIBus *bus = scsi_bus_from_device(d);
517 BusState *qbus = BUS(bus);
519 req = g_malloc0(reqops->size);
525 req->hba_private = hba_private;
529 object_ref(OBJECT(d));
530 object_ref(OBJECT(qbus->parent));
531 trace_scsi_req_alloc(req->dev->id, req->lun, req->tag);
535 SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun,
536 uint8_t *buf, void *hba_private)
538 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
542 if (scsi_req_parse(&cmd, d, buf) != 0) {
543 trace_scsi_req_parse_bad(d->id, lun, tag, buf[0]);
544 req = scsi_req_alloc(&reqops_invalid_opcode, d, tag, lun, hba_private);
546 trace_scsi_req_parsed(d->id, lun, tag, buf[0],
549 trace_scsi_req_parsed_lba(d->id, lun, tag, buf[0],
553 if (cmd.xfer > INT32_MAX) {
554 req = scsi_req_alloc(&reqops_invalid_field, d, tag, lun, hba_private);
555 } else if ((d->unit_attention.key == UNIT_ATTENTION ||
556 bus->unit_attention.key == UNIT_ATTENTION) &&
557 (buf[0] != INQUIRY &&
558 buf[0] != REPORT_LUNS &&
559 buf[0] != GET_CONFIGURATION &&
560 buf[0] != GET_EVENT_STATUS_NOTIFICATION &&
563 * If we already have a pending unit attention condition,
564 * report this one before triggering another one.
566 !(buf[0] == REQUEST_SENSE && d->sense_is_ua))) {
567 req = scsi_req_alloc(&reqops_unit_attention, d, tag, lun,
569 } else if (lun != d->lun ||
570 buf[0] == REPORT_LUNS ||
571 (buf[0] == REQUEST_SENSE && d->sense_len)) {
572 req = scsi_req_alloc(&reqops_target_command, d, tag, lun,
575 req = scsi_device_alloc_req(d, tag, lun, buf, hba_private);
580 req->resid = req->cmd.xfer;
584 trace_scsi_inquiry(d->id, lun, tag, cmd.buf[1], cmd.buf[2]);
586 case TEST_UNIT_READY:
587 trace_scsi_test_unit_ready(d->id, lun, tag);
590 trace_scsi_report_luns(d->id, lun, tag);
593 trace_scsi_request_sense(d->id, lun, tag);
602 uint8_t *scsi_req_get_buf(SCSIRequest *req)
604 return req->ops->get_buf(req);
607 static void scsi_clear_unit_attention(SCSIRequest *req)
610 if (req->dev->unit_attention.key != UNIT_ATTENTION &&
611 req->bus->unit_attention.key != UNIT_ATTENTION) {
616 * If an INQUIRY command enters the enabled command state,
617 * the device server shall [not] clear any unit attention condition;
618 * See also MMC-6, paragraphs 6.5 and 6.6.2.
620 if (req->cmd.buf[0] == INQUIRY ||
621 req->cmd.buf[0] == GET_CONFIGURATION ||
622 req->cmd.buf[0] == GET_EVENT_STATUS_NOTIFICATION) {
626 if (req->dev->unit_attention.key == UNIT_ATTENTION) {
627 ua = &req->dev->unit_attention;
629 ua = &req->bus->unit_attention;
633 * If a REPORT LUNS command enters the enabled command state, [...]
634 * the device server shall clear any pending unit attention condition
635 * with an additional sense code of REPORTED LUNS DATA HAS CHANGED.
637 if (req->cmd.buf[0] == REPORT_LUNS &&
638 !(ua->asc == SENSE_CODE(REPORTED_LUNS_CHANGED).asc &&
639 ua->ascq == SENSE_CODE(REPORTED_LUNS_CHANGED).ascq)) {
643 *ua = SENSE_CODE(NO_SENSE);
646 int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len)
651 if (!req->sense_len) {
655 ret = scsi_build_sense(req->sense, req->sense_len, buf, len, true);
658 * FIXME: clearing unit attention conditions upon autosense should be done
659 * only if the UA_INTLCK_CTRL field in the Control mode page is set to 00b
662 * We assume UA_INTLCK_CTRL to be 00b for HBAs that support autosense, and
663 * 10b for HBAs that do not support it (do not call scsi_req_get_sense).
664 * Here we handle unit attention clearing for UA_INTLCK_CTRL == 00b.
666 if (req->dev->sense_is_ua) {
667 scsi_device_unit_attention_reported(req->dev);
668 req->dev->sense_len = 0;
669 req->dev->sense_is_ua = false;
674 int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed)
676 return scsi_build_sense(dev->sense, dev->sense_len, buf, len, fixed);
679 void scsi_req_build_sense(SCSIRequest *req, SCSISense sense)
681 trace_scsi_req_build_sense(req->dev->id, req->lun, req->tag,
682 sense.key, sense.asc, sense.ascq);
683 memset(req->sense, 0, 18);
684 req->sense[0] = 0x70;
685 req->sense[2] = sense.key;
687 req->sense[12] = sense.asc;
688 req->sense[13] = sense.ascq;
692 static void scsi_req_enqueue_internal(SCSIRequest *req)
694 assert(!req->enqueued);
696 if (req->bus->info->get_sg_list) {
697 req->sg = req->bus->info->get_sg_list(req);
701 req->enqueued = true;
702 QTAILQ_INSERT_TAIL(&req->dev->requests, req, next);
705 int32_t scsi_req_enqueue(SCSIRequest *req)
710 scsi_req_enqueue_internal(req);
712 rc = req->ops->send_command(req, req->cmd.buf);
717 static void scsi_req_dequeue(SCSIRequest *req)
719 trace_scsi_req_dequeue(req->dev->id, req->lun, req->tag);
722 QTAILQ_REMOVE(&req->dev->requests, req, next);
723 req->enqueued = false;
728 static int scsi_get_performance_length(int num_desc, int type, int data_type)
730 /* MMC-6, paragraph 6.7. */
733 if ((data_type & 3) == 0) {
734 /* Each descriptor is as in Table 295 - Nominal performance. */
735 return 16 * num_desc + 8;
737 /* Each descriptor is as in Table 296 - Exceptions. */
738 return 6 * num_desc + 8;
743 return 8 * num_desc + 8;
745 return 2048 * num_desc + 8;
747 return 16 * num_desc + 8;
753 static int ata_passthrough_xfer_unit(SCSIDevice *dev, uint8_t *buf)
755 int byte_block = (buf[2] >> 2) & 0x1;
756 int type = (buf[2] >> 4) & 0x1;
761 xfer_unit = dev->blocksize;
772 static int ata_passthrough_12_xfer_size(SCSIDevice *dev, uint8_t *buf)
774 int length = buf[2] & 0x3;
776 int unit = ata_passthrough_xfer_unit(dev, buf);
780 case 3: /* USB-specific. */
795 static int ata_passthrough_16_xfer_size(SCSIDevice *dev, uint8_t *buf)
797 int extend = buf[1] & 0x1;
798 int length = buf[2] & 0x3;
800 int unit = ata_passthrough_xfer_unit(dev, buf);
804 case 3: /* USB-specific. */
810 xfer |= (extend ? buf[3] << 8 : 0);
814 xfer |= (extend ? buf[5] << 8 : 0);
821 uint32_t scsi_data_cdb_length(uint8_t *buf)
823 if ((buf[0] >> 5) == 0 && buf[4] == 0) {
826 return scsi_cdb_length(buf);
830 uint32_t scsi_cdb_length(uint8_t *buf)
832 switch (buf[0] >> 5) {
838 return lduw_be_p(&buf[7]);
841 return ldl_be_p(&buf[10]) & 0xffffffffULL;
844 return ldl_be_p(&buf[6]) & 0xffffffffULL;
851 static int scsi_req_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
853 cmd->xfer = scsi_cdb_length(buf);
855 case TEST_UNIT_READY:
859 case WRITE_FILEMARKS:
860 case WRITE_FILEMARKS_16:
865 case ALLOW_MEDIUM_REMOVAL:
868 case SYNCHRONIZE_CACHE:
869 case SYNCHRONIZE_CACHE_16:
871 case LOCK_UNLOCK_CACHE:
880 case ALLOW_OVERWRITE:
887 cmd->xfer = dev->blocksize;
889 case READ_CAPACITY_10:
892 case READ_BLOCK_LIMITS:
895 case SEND_VOLUME_TAG:
896 /* GPCMD_SET_STREAMING from multimedia commands. */
897 if (dev->type == TYPE_ROM) {
898 cmd->xfer = buf[10] | (buf[9] << 8);
900 cmd->xfer = buf[9] | (buf[8] << 8);
904 /* length 0 means 256 blocks */
905 if (cmd->xfer == 0) {
909 case WRITE_VERIFY_10:
911 case WRITE_VERIFY_12:
913 case WRITE_VERIFY_16:
914 cmd->xfer *= dev->blocksize;
918 /* length 0 means 256 blocks */
919 if (cmd->xfer == 0) {
923 case RECOVER_BUFFERED_DATA:
926 cmd->xfer *= dev->blocksize;
929 /* MMC mandates the parameter list to be 12-bytes long. Parameters
930 * for block devices are restricted to the header right now. */
931 if (dev->type == TYPE_ROM && (buf[1] & 16)) {
934 cmd->xfer = (buf[1] & 16) == 0 ? 0 : (buf[1] & 32 ? 8 : 4);
938 case RECEIVE_DIAGNOSTIC:
939 case SEND_DIAGNOSTIC:
940 cmd->xfer = buf[4] | (buf[3] << 8);
946 cmd->xfer = buf[8] | (buf[7] << 8) | (buf[6] << 16);
948 case PERSISTENT_RESERVE_OUT:
949 cmd->xfer = ldl_be_p(&buf[5]) & 0xffffffffULL;
952 if (dev->type == TYPE_ROM) {
953 /* MMC command GET PERFORMANCE. */
954 cmd->xfer = scsi_get_performance_length(buf[9] | (buf[8] << 8),
955 buf[10], buf[1] & 0x1f);
958 case MECHANISM_STATUS:
959 case READ_DVD_STRUCTURE:
960 case SEND_DVD_STRUCTURE:
961 case MAINTENANCE_OUT:
963 if (dev->type == TYPE_ROM) {
964 /* GPCMD_REPORT_KEY and GPCMD_SEND_KEY from multi media commands */
965 cmd->xfer = buf[9] | (buf[8] << 8);
968 case ATA_PASSTHROUGH_12:
969 if (dev->type == TYPE_ROM) {
970 /* BLANK command of MMC */
973 cmd->xfer = ata_passthrough_12_xfer_size(dev, buf);
976 case ATA_PASSTHROUGH_16:
977 cmd->xfer = ata_passthrough_16_xfer_size(dev, buf);
983 static int scsi_req_stream_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
986 /* stream commands */
993 case RECOVER_BUFFERED_DATA:
995 cmd->xfer = buf[4] | (buf[3] << 8) | (buf[2] << 16);
996 if (buf[1] & 0x01) { /* fixed */
997 cmd->xfer *= dev->blocksize;
1001 case READ_REVERSE_16:
1004 cmd->xfer = buf[14] | (buf[13] << 8) | (buf[12] << 16);
1005 if (buf[1] & 0x01) { /* fixed */
1006 cmd->xfer *= dev->blocksize;
1014 cmd->xfer = buf[13] | (buf[12] << 8);
1017 switch (buf[1] & 0x1f) /* operation code */ {
1018 case SHORT_FORM_BLOCK_ID:
1019 case SHORT_FORM_VENDOR_SPECIFIC:
1026 cmd->xfer = buf[8] | (buf[7] << 8);
1034 cmd->xfer = buf[4] | (buf[3] << 8);
1036 /* generic commands */
1038 return scsi_req_length(cmd, dev, buf);
1043 static int scsi_req_medium_changer_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
1046 /* medium changer commands */
1047 case EXCHANGE_MEDIUM:
1048 case INITIALIZE_ELEMENT_STATUS:
1049 case INITIALIZE_ELEMENT_STATUS_WITH_RANGE:
1051 case POSITION_TO_ELEMENT:
1054 case READ_ELEMENT_STATUS:
1055 cmd->xfer = buf[9] | (buf[8] << 8) | (buf[7] << 16);
1058 /* generic commands */
1060 return scsi_req_length(cmd, dev, buf);
1066 static void scsi_cmd_xfer_mode(SCSICommand *cmd)
1069 cmd->mode = SCSI_XFER_NONE;
1072 switch (cmd->buf[0]) {
1075 case WRITE_VERIFY_10:
1077 case WRITE_VERIFY_12:
1079 case WRITE_VERIFY_16:
1083 case CHANGE_DEFINITION:
1086 case MODE_SELECT_10:
1087 case SEND_DIAGNOSTIC:
1090 case REASSIGN_BLOCKS:
1099 case SEARCH_HIGH_12:
1100 case SEARCH_EQUAL_12:
1103 case SEND_VOLUME_TAG:
1104 case SEND_CUE_SHEET:
1105 case SEND_DVD_STRUCTURE:
1106 case PERSISTENT_RESERVE_OUT:
1107 case MAINTENANCE_OUT:
1108 cmd->mode = SCSI_XFER_TO_DEV;
1110 case ATA_PASSTHROUGH_12:
1111 case ATA_PASSTHROUGH_16:
1113 cmd->mode = (cmd->buf[2] & 0x8) ?
1114 SCSI_XFER_FROM_DEV : SCSI_XFER_TO_DEV;
1117 cmd->mode = SCSI_XFER_FROM_DEV;
1122 static uint64_t scsi_cmd_lba(SCSICommand *cmd)
1124 uint8_t *buf = cmd->buf;
1127 switch (buf[0] >> 5) {
1129 lba = ldl_be_p(&buf[0]) & 0x1fffff;
1134 lba = ldl_be_p(&buf[2]) & 0xffffffffULL;
1137 lba = ldq_be_p(&buf[2]);
1146 int scsi_req_parse(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
1150 switch (buf[0] >> 5) {
1168 switch (dev->type) {
1170 rc = scsi_req_stream_length(cmd, dev, buf);
1172 case TYPE_MEDIUM_CHANGER:
1173 rc = scsi_req_medium_changer_length(cmd, dev, buf);
1176 rc = scsi_req_length(cmd, dev, buf);
1183 memcpy(cmd->buf, buf, cmd->len);
1184 scsi_cmd_xfer_mode(cmd);
1185 cmd->lba = scsi_cmd_lba(cmd);
1189 void scsi_device_report_change(SCSIDevice *dev, SCSISense sense)
1191 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
1193 scsi_device_set_ua(dev, sense);
1194 if (bus->info->change) {
1195 bus->info->change(bus, dev, sense);
1200 * Predefined sense codes
1203 /* No sense data available */
1204 const struct SCSISense sense_code_NO_SENSE = {
1205 .key = NO_SENSE , .asc = 0x00 , .ascq = 0x00
1208 /* LUN not ready, Manual intervention required */
1209 const struct SCSISense sense_code_LUN_NOT_READY = {
1210 .key = NOT_READY, .asc = 0x04, .ascq = 0x03
1213 /* LUN not ready, Medium not present */
1214 const struct SCSISense sense_code_NO_MEDIUM = {
1215 .key = NOT_READY, .asc = 0x3a, .ascq = 0x00
1218 /* LUN not ready, medium removal prevented */
1219 const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED = {
1220 .key = NOT_READY, .asc = 0x53, .ascq = 0x02
1223 /* Hardware error, internal target failure */
1224 const struct SCSISense sense_code_TARGET_FAILURE = {
1225 .key = HARDWARE_ERROR, .asc = 0x44, .ascq = 0x00
1228 /* Illegal request, invalid command operation code */
1229 const struct SCSISense sense_code_INVALID_OPCODE = {
1230 .key = ILLEGAL_REQUEST, .asc = 0x20, .ascq = 0x00
1233 /* Illegal request, LBA out of range */
1234 const struct SCSISense sense_code_LBA_OUT_OF_RANGE = {
1235 .key = ILLEGAL_REQUEST, .asc = 0x21, .ascq = 0x00
1238 /* Illegal request, Invalid field in CDB */
1239 const struct SCSISense sense_code_INVALID_FIELD = {
1240 .key = ILLEGAL_REQUEST, .asc = 0x24, .ascq = 0x00
1243 /* Illegal request, Invalid field in parameter list */
1244 const struct SCSISense sense_code_INVALID_PARAM = {
1245 .key = ILLEGAL_REQUEST, .asc = 0x26, .ascq = 0x00
1248 /* Illegal request, Parameter list length error */
1249 const struct SCSISense sense_code_INVALID_PARAM_LEN = {
1250 .key = ILLEGAL_REQUEST, .asc = 0x1a, .ascq = 0x00
1253 /* Illegal request, LUN not supported */
1254 const struct SCSISense sense_code_LUN_NOT_SUPPORTED = {
1255 .key = ILLEGAL_REQUEST, .asc = 0x25, .ascq = 0x00
1258 /* Illegal request, Saving parameters not supported */
1259 const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED = {
1260 .key = ILLEGAL_REQUEST, .asc = 0x39, .ascq = 0x00
1263 /* Illegal request, Incompatible medium installed */
1264 const struct SCSISense sense_code_INCOMPATIBLE_FORMAT = {
1265 .key = ILLEGAL_REQUEST, .asc = 0x30, .ascq = 0x00
1268 /* Illegal request, medium removal prevented */
1269 const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED = {
1270 .key = ILLEGAL_REQUEST, .asc = 0x53, .ascq = 0x02
1273 /* Command aborted, I/O process terminated */
1274 const struct SCSISense sense_code_IO_ERROR = {
1275 .key = ABORTED_COMMAND, .asc = 0x00, .ascq = 0x06
1278 /* Command aborted, I_T Nexus loss occurred */
1279 const struct SCSISense sense_code_I_T_NEXUS_LOSS = {
1280 .key = ABORTED_COMMAND, .asc = 0x29, .ascq = 0x07
1283 /* Command aborted, Logical Unit failure */
1284 const struct SCSISense sense_code_LUN_FAILURE = {
1285 .key = ABORTED_COMMAND, .asc = 0x3e, .ascq = 0x01
1288 /* Unit attention, Capacity data has changed */
1289 const struct SCSISense sense_code_CAPACITY_CHANGED = {
1290 .key = UNIT_ATTENTION, .asc = 0x2a, .ascq = 0x09
1293 /* Unit attention, Power on, reset or bus device reset occurred */
1294 const struct SCSISense sense_code_RESET = {
1295 .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x00
1298 /* Unit attention, No medium */
1299 const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM = {
1300 .key = UNIT_ATTENTION, .asc = 0x3a, .ascq = 0x00
1303 /* Unit attention, Medium may have changed */
1304 const struct SCSISense sense_code_MEDIUM_CHANGED = {
1305 .key = UNIT_ATTENTION, .asc = 0x28, .ascq = 0x00
1308 /* Unit attention, Reported LUNs data has changed */
1309 const struct SCSISense sense_code_REPORTED_LUNS_CHANGED = {
1310 .key = UNIT_ATTENTION, .asc = 0x3f, .ascq = 0x0e
1313 /* Unit attention, Device internal reset */
1314 const struct SCSISense sense_code_DEVICE_INTERNAL_RESET = {
1315 .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x04
1318 /* Data Protection, Write Protected */
1319 const struct SCSISense sense_code_WRITE_PROTECTED = {
1320 .key = DATA_PROTECT, .asc = 0x27, .ascq = 0x00
1326 * Convert between fixed and descriptor sense buffers
1328 int scsi_build_sense(uint8_t *in_buf, int in_len,
1329 uint8_t *buf, int len, bool fixed)
1333 if (!fixed && len < 8) {
1338 sense.key = NO_SENSE;
1342 fixed_in = (in_buf[0] & 2) == 0;
1344 if (fixed == fixed_in) {
1345 memcpy(buf, in_buf, MIN(len, in_len));
1346 return MIN(len, in_len);
1350 sense.key = in_buf[2];
1351 sense.asc = in_buf[12];
1352 sense.ascq = in_buf[13];
1354 sense.key = in_buf[1];
1355 sense.asc = in_buf[2];
1356 sense.ascq = in_buf[3];
1360 memset(buf, 0, len);
1362 /* Return fixed format sense buffer */
1366 buf[12] = sense.asc;
1367 buf[13] = sense.ascq;
1368 return MIN(len, 18);
1370 /* Return descriptor format sense buffer */
1374 buf[3] = sense.ascq;
1379 static const char *scsi_command_name(uint8_t cmd)
1381 static const char *names[] = {
1382 [ TEST_UNIT_READY ] = "TEST_UNIT_READY",
1383 [ REWIND ] = "REWIND",
1384 [ REQUEST_SENSE ] = "REQUEST_SENSE",
1385 [ FORMAT_UNIT ] = "FORMAT_UNIT",
1386 [ READ_BLOCK_LIMITS ] = "READ_BLOCK_LIMITS",
1387 [ REASSIGN_BLOCKS ] = "REASSIGN_BLOCKS/INITIALIZE ELEMENT STATUS",
1388 /* LOAD_UNLOAD and INITIALIZE_ELEMENT_STATUS use the same operation code */
1389 [ READ_6 ] = "READ_6",
1390 [ WRITE_6 ] = "WRITE_6",
1391 [ SET_CAPACITY ] = "SET_CAPACITY",
1392 [ READ_REVERSE ] = "READ_REVERSE",
1393 [ WRITE_FILEMARKS ] = "WRITE_FILEMARKS",
1394 [ SPACE ] = "SPACE",
1395 [ INQUIRY ] = "INQUIRY",
1396 [ RECOVER_BUFFERED_DATA ] = "RECOVER_BUFFERED_DATA",
1397 [ MAINTENANCE_IN ] = "MAINTENANCE_IN",
1398 [ MAINTENANCE_OUT ] = "MAINTENANCE_OUT",
1399 [ MODE_SELECT ] = "MODE_SELECT",
1400 [ RESERVE ] = "RESERVE",
1401 [ RELEASE ] = "RELEASE",
1403 [ ERASE ] = "ERASE",
1404 [ MODE_SENSE ] = "MODE_SENSE",
1405 [ START_STOP ] = "START_STOP/LOAD_UNLOAD",
1406 /* LOAD_UNLOAD and START_STOP use the same operation code */
1407 [ RECEIVE_DIAGNOSTIC ] = "RECEIVE_DIAGNOSTIC",
1408 [ SEND_DIAGNOSTIC ] = "SEND_DIAGNOSTIC",
1409 [ ALLOW_MEDIUM_REMOVAL ] = "ALLOW_MEDIUM_REMOVAL",
1410 [ READ_CAPACITY_10 ] = "READ_CAPACITY_10",
1411 [ READ_10 ] = "READ_10",
1412 [ WRITE_10 ] = "WRITE_10",
1413 [ SEEK_10 ] = "SEEK_10/POSITION_TO_ELEMENT",
1414 /* SEEK_10 and POSITION_TO_ELEMENT use the same operation code */
1415 [ WRITE_VERIFY_10 ] = "WRITE_VERIFY_10",
1416 [ VERIFY_10 ] = "VERIFY_10",
1417 [ SEARCH_HIGH ] = "SEARCH_HIGH",
1418 [ SEARCH_EQUAL ] = "SEARCH_EQUAL",
1419 [ SEARCH_LOW ] = "SEARCH_LOW",
1420 [ SET_LIMITS ] = "SET_LIMITS",
1421 [ PRE_FETCH ] = "PRE_FETCH/READ_POSITION",
1422 /* READ_POSITION and PRE_FETCH use the same operation code */
1423 [ SYNCHRONIZE_CACHE ] = "SYNCHRONIZE_CACHE",
1424 [ LOCK_UNLOCK_CACHE ] = "LOCK_UNLOCK_CACHE",
1425 [ READ_DEFECT_DATA ] = "READ_DEFECT_DATA/INITIALIZE_ELEMENT_STATUS_WITH_RANGE",
1426 /* READ_DEFECT_DATA and INITIALIZE_ELEMENT_STATUS_WITH_RANGE use the same operation code */
1427 [ MEDIUM_SCAN ] = "MEDIUM_SCAN",
1428 [ COMPARE ] = "COMPARE",
1429 [ COPY_VERIFY ] = "COPY_VERIFY",
1430 [ WRITE_BUFFER ] = "WRITE_BUFFER",
1431 [ READ_BUFFER ] = "READ_BUFFER",
1432 [ UPDATE_BLOCK ] = "UPDATE_BLOCK",
1433 [ READ_LONG_10 ] = "READ_LONG_10",
1434 [ WRITE_LONG_10 ] = "WRITE_LONG_10",
1435 [ CHANGE_DEFINITION ] = "CHANGE_DEFINITION",
1436 [ WRITE_SAME_10 ] = "WRITE_SAME_10",
1437 [ UNMAP ] = "UNMAP",
1438 [ READ_TOC ] = "READ_TOC",
1439 [ REPORT_DENSITY_SUPPORT ] = "REPORT_DENSITY_SUPPORT",
1440 [ SANITIZE ] = "SANITIZE",
1441 [ GET_CONFIGURATION ] = "GET_CONFIGURATION",
1442 [ LOG_SELECT ] = "LOG_SELECT",
1443 [ LOG_SENSE ] = "LOG_SENSE",
1444 [ MODE_SELECT_10 ] = "MODE_SELECT_10",
1445 [ RESERVE_10 ] = "RESERVE_10",
1446 [ RELEASE_10 ] = "RELEASE_10",
1447 [ MODE_SENSE_10 ] = "MODE_SENSE_10",
1448 [ PERSISTENT_RESERVE_IN ] = "PERSISTENT_RESERVE_IN",
1449 [ PERSISTENT_RESERVE_OUT ] = "PERSISTENT_RESERVE_OUT",
1450 [ WRITE_FILEMARKS_16 ] = "WRITE_FILEMARKS_16",
1451 [ EXTENDED_COPY ] = "EXTENDED_COPY",
1452 [ ATA_PASSTHROUGH_16 ] = "ATA_PASSTHROUGH_16",
1453 [ ACCESS_CONTROL_IN ] = "ACCESS_CONTROL_IN",
1454 [ ACCESS_CONTROL_OUT ] = "ACCESS_CONTROL_OUT",
1455 [ READ_16 ] = "READ_16",
1456 [ COMPARE_AND_WRITE ] = "COMPARE_AND_WRITE",
1457 [ WRITE_16 ] = "WRITE_16",
1458 [ WRITE_VERIFY_16 ] = "WRITE_VERIFY_16",
1459 [ VERIFY_16 ] = "VERIFY_16",
1460 [ PRE_FETCH_16 ] = "PRE_FETCH_16",
1461 [ SYNCHRONIZE_CACHE_16 ] = "SPACE_16/SYNCHRONIZE_CACHE_16",
1462 /* SPACE_16 and SYNCHRONIZE_CACHE_16 use the same operation code */
1463 [ LOCATE_16 ] = "LOCATE_16",
1464 [ WRITE_SAME_16 ] = "ERASE_16/WRITE_SAME_16",
1465 /* ERASE_16 and WRITE_SAME_16 use the same operation code */
1466 [ SERVICE_ACTION_IN_16 ] = "SERVICE_ACTION_IN_16",
1467 [ WRITE_LONG_16 ] = "WRITE_LONG_16",
1468 [ REPORT_LUNS ] = "REPORT_LUNS",
1469 [ ATA_PASSTHROUGH_12 ] = "BLANK/ATA_PASSTHROUGH_12",
1470 [ MOVE_MEDIUM ] = "MOVE_MEDIUM",
1471 [ EXCHANGE_MEDIUM ] = "EXCHANGE MEDIUM",
1472 [ READ_12 ] = "READ_12",
1473 [ WRITE_12 ] = "WRITE_12",
1474 [ ERASE_12 ] = "ERASE_12/GET_PERFORMANCE",
1475 /* ERASE_12 and GET_PERFORMANCE use the same operation code */
1476 [ SERVICE_ACTION_IN_12 ] = "SERVICE_ACTION_IN_12",
1477 [ WRITE_VERIFY_12 ] = "WRITE_VERIFY_12",
1478 [ VERIFY_12 ] = "VERIFY_12",
1479 [ SEARCH_HIGH_12 ] = "SEARCH_HIGH_12",
1480 [ SEARCH_EQUAL_12 ] = "SEARCH_EQUAL_12",
1481 [ SEARCH_LOW_12 ] = "SEARCH_LOW_12",
1482 [ READ_ELEMENT_STATUS ] = "READ_ELEMENT_STATUS",
1483 [ SEND_VOLUME_TAG ] = "SEND_VOLUME_TAG/SET_STREAMING",
1484 /* SEND_VOLUME_TAG and SET_STREAMING use the same operation code */
1485 [ READ_CD ] = "READ_CD",
1486 [ READ_DEFECT_DATA_12 ] = "READ_DEFECT_DATA_12",
1487 [ READ_DVD_STRUCTURE ] = "READ_DVD_STRUCTURE",
1488 [ RESERVE_TRACK ] = "RESERVE_TRACK",
1489 [ SEND_CUE_SHEET ] = "SEND_CUE_SHEET",
1490 [ SEND_DVD_STRUCTURE ] = "SEND_DVD_STRUCTURE",
1491 [ SET_CD_SPEED ] = "SET_CD_SPEED",
1492 [ SET_READ_AHEAD ] = "SET_READ_AHEAD",
1493 [ ALLOW_OVERWRITE ] = "ALLOW_OVERWRITE",
1494 [ MECHANISM_STATUS ] = "MECHANISM_STATUS",
1497 if (cmd >= ARRAY_SIZE(names) || names[cmd] == NULL)
1502 SCSIRequest *scsi_req_ref(SCSIRequest *req)
1504 assert(req->refcount > 0);
1509 void scsi_req_unref(SCSIRequest *req)
1511 assert(req->refcount > 0);
1512 if (--req->refcount == 0) {
1513 BusState *qbus = req->dev->qdev.parent_bus;
1514 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, qbus);
1516 if (bus->info->free_request && req->hba_private) {
1517 bus->info->free_request(bus, req->hba_private);
1519 if (req->ops->free_req) {
1520 req->ops->free_req(req);
1522 object_unref(OBJECT(req->dev));
1523 object_unref(OBJECT(qbus->parent));
1528 /* Tell the device that we finished processing this chunk of I/O. It
1529 will start the next chunk or complete the command. */
1530 void scsi_req_continue(SCSIRequest *req)
1532 if (req->io_canceled) {
1533 trace_scsi_req_continue_canceled(req->dev->id, req->lun, req->tag);
1536 trace_scsi_req_continue(req->dev->id, req->lun, req->tag);
1537 if (req->cmd.mode == SCSI_XFER_TO_DEV) {
1538 req->ops->write_data(req);
1540 req->ops->read_data(req);
1544 /* Called by the devices when data is ready for the HBA. The HBA should
1545 start a DMA operation to read or fill the device's data buffer.
1546 Once it completes, calling scsi_req_continue will restart I/O. */
1547 void scsi_req_data(SCSIRequest *req, int len)
1550 if (req->io_canceled) {
1551 trace_scsi_req_data_canceled(req->dev->id, req->lun, req->tag, len);
1554 trace_scsi_req_data(req->dev->id, req->lun, req->tag, len);
1555 assert(req->cmd.mode != SCSI_XFER_NONE);
1558 req->bus->info->transfer_data(req, len);
1562 /* If the device calls scsi_req_data and the HBA specified a
1563 * scatter/gather list, the transfer has to happen in a single
1565 assert(!req->dma_started);
1566 req->dma_started = true;
1568 buf = scsi_req_get_buf(req);
1569 if (req->cmd.mode == SCSI_XFER_FROM_DEV) {
1570 req->resid = dma_buf_read(buf, len, req->sg);
1572 req->resid = dma_buf_write(buf, len, req->sg);
1574 scsi_req_continue(req);
1577 void scsi_req_print(SCSIRequest *req)
1582 fprintf(fp, "[%s id=%d] %s",
1583 req->dev->qdev.parent_bus->name,
1585 scsi_command_name(req->cmd.buf[0]));
1586 for (i = 1; i < req->cmd.len; i++) {
1587 fprintf(fp, " 0x%02x", req->cmd.buf[i]);
1589 switch (req->cmd.mode) {
1590 case SCSI_XFER_NONE:
1591 fprintf(fp, " - none\n");
1593 case SCSI_XFER_FROM_DEV:
1594 fprintf(fp, " - from-dev len=%zd\n", req->cmd.xfer);
1596 case SCSI_XFER_TO_DEV:
1597 fprintf(fp, " - to-dev len=%zd\n", req->cmd.xfer);
1600 fprintf(fp, " - Oops\n");
1605 void scsi_req_complete(SCSIRequest *req, int status)
1607 assert(req->status == -1);
1608 req->status = status;
1610 assert(req->sense_len <= sizeof(req->sense));
1611 if (status == GOOD) {
1615 if (req->sense_len) {
1616 memcpy(req->dev->sense, req->sense, req->sense_len);
1617 req->dev->sense_len = req->sense_len;
1618 req->dev->sense_is_ua = (req->ops == &reqops_unit_attention);
1620 req->dev->sense_len = 0;
1621 req->dev->sense_is_ua = false;
1625 * Unit attention state is now stored in the device's sense buffer
1626 * if the HBA didn't do autosense. Clear the pending unit attention
1629 scsi_clear_unit_attention(req);
1632 scsi_req_dequeue(req);
1633 req->bus->info->complete(req, req->status, req->resid);
1634 scsi_req_unref(req);
1637 void scsi_req_cancel(SCSIRequest *req)
1639 trace_scsi_req_cancel(req->dev->id, req->lun, req->tag);
1640 if (!req->enqueued) {
1644 scsi_req_dequeue(req);
1645 req->io_canceled = true;
1646 if (req->ops->cancel_io) {
1647 req->ops->cancel_io(req);
1649 if (req->bus->info->cancel) {
1650 req->bus->info->cancel(req);
1652 scsi_req_unref(req);
1655 void scsi_req_abort(SCSIRequest *req, int status)
1657 if (!req->enqueued) {
1661 scsi_req_dequeue(req);
1662 req->io_canceled = true;
1663 if (req->ops->cancel_io) {
1664 req->ops->cancel_io(req);
1666 scsi_req_complete(req, status);
1667 scsi_req_unref(req);
1670 static int scsi_ua_precedence(SCSISense sense)
1672 if (sense.key != UNIT_ATTENTION) {
1675 if (sense.asc == 0x29 && sense.ascq == 0x04) {
1676 /* DEVICE INTERNAL RESET goes with POWER ON OCCURRED */
1678 } else if (sense.asc == 0x3F && sense.ascq == 0x01) {
1679 /* MICROCODE HAS BEEN CHANGED goes with SCSI BUS RESET OCCURRED */
1681 } else if (sense.asc == 0x29 && (sense.ascq == 0x05 || sense.ascq == 0x06)) {
1682 /* These two go with "all others". */
1684 } else if (sense.asc == 0x29 && sense.ascq <= 0x07) {
1685 /* POWER ON, RESET OR BUS DEVICE RESET OCCURRED = 0
1686 * POWER ON OCCURRED = 1
1687 * SCSI BUS RESET OCCURRED = 2
1688 * BUS DEVICE RESET FUNCTION OCCURRED = 3
1689 * I_T NEXUS LOSS OCCURRED = 7
1692 } else if (sense.asc == 0x2F && sense.ascq == 0x01) {
1693 /* COMMANDS CLEARED BY POWER LOSS NOTIFICATION */
1696 return (sense.asc << 8) | sense.ascq;
1699 void scsi_device_set_ua(SCSIDevice *sdev, SCSISense sense)
1702 if (sense.key != UNIT_ATTENTION) {
1705 trace_scsi_device_set_ua(sdev->id, sdev->lun, sense.key,
1706 sense.asc, sense.ascq);
1709 * Override a pre-existing unit attention condition, except for a more
1710 * important reset condition.
1712 prec1 = scsi_ua_precedence(sdev->unit_attention);
1713 prec2 = scsi_ua_precedence(sense);
1714 if (prec2 < prec1) {
1715 sdev->unit_attention = sense;
1719 void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense)
1723 while (!QTAILQ_EMPTY(&sdev->requests)) {
1724 req = QTAILQ_FIRST(&sdev->requests);
1725 scsi_req_cancel(req);
1728 scsi_device_set_ua(sdev, sense);
1731 static char *scsibus_get_dev_path(DeviceState *dev)
1733 SCSIDevice *d = DO_UPCAST(SCSIDevice, qdev, dev);
1734 DeviceState *hba = dev->parent_bus->parent;
1738 id = qdev_get_dev_path(hba);
1740 path = g_strdup_printf("%s/%d:%d:%d", id, d->channel, d->id, d->lun);
1742 path = g_strdup_printf("%d:%d:%d", d->channel, d->id, d->lun);
1748 static char *scsibus_get_fw_dev_path(DeviceState *dev)
1750 SCSIDevice *d = SCSI_DEVICE(dev);
1751 return g_strdup_printf("channel@%x/%s@%x,%x", d->channel,
1752 qdev_fw_name(dev), d->id, d->lun);
1755 SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int id, int lun)
1758 SCSIDevice *target_dev = NULL;
1760 QTAILQ_FOREACH_REVERSE(kid, &bus->qbus.children, ChildrenHead, sibling) {
1761 DeviceState *qdev = kid->child;
1762 SCSIDevice *dev = SCSI_DEVICE(qdev);
1764 if (dev->channel == channel && dev->id == id) {
1765 if (dev->lun == lun) {
1774 /* SCSI request list. For simplicity, pv points to the whole device */
1776 static void put_scsi_requests(QEMUFile *f, void *pv, size_t size)
1779 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, s->qdev.parent_bus);
1782 QTAILQ_FOREACH(req, &s->requests, next) {
1783 assert(!req->io_canceled);
1784 assert(req->status == -1);
1785 assert(req->enqueued);
1787 qemu_put_sbyte(f, req->retry ? 1 : 2);
1788 qemu_put_buffer(f, req->cmd.buf, sizeof(req->cmd.buf));
1789 qemu_put_be32s(f, &req->tag);
1790 qemu_put_be32s(f, &req->lun);
1791 if (bus->info->save_request) {
1792 bus->info->save_request(f, req);
1794 if (req->ops->save_request) {
1795 req->ops->save_request(f, req);
1798 qemu_put_sbyte(f, 0);
1801 static int get_scsi_requests(QEMUFile *f, void *pv, size_t size)
1804 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, s->qdev.parent_bus);
1807 while ((sbyte = qemu_get_sbyte(f)) > 0) {
1808 uint8_t buf[SCSI_CMD_BUF_SIZE];
1813 qemu_get_buffer(f, buf, sizeof(buf));
1814 qemu_get_be32s(f, &tag);
1815 qemu_get_be32s(f, &lun);
1816 req = scsi_req_new(s, tag, lun, buf, NULL);
1817 req->retry = (sbyte == 1);
1818 if (bus->info->load_request) {
1819 req->hba_private = bus->info->load_request(f, req);
1821 if (req->ops->load_request) {
1822 req->ops->load_request(f, req);
1825 /* Just restart it later. */
1826 scsi_req_enqueue_internal(req);
1828 /* At this point, the request will be kept alive by the reference
1829 * added by scsi_req_enqueue_internal, so we can release our reference.
1830 * The HBA of course will add its own reference in the load_request
1831 * callback if it needs to hold on the SCSIRequest.
1833 scsi_req_unref(req);
1839 static int scsi_qdev_unplug(DeviceState *qdev)
1841 SCSIDevice *dev = SCSI_DEVICE(qdev);
1842 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
1844 if (bus->info->hot_unplug) {
1845 bus->info->hot_unplug(bus, dev);
1847 return qdev_simple_unplug_cb(qdev);
1850 static const VMStateInfo vmstate_info_scsi_requests = {
1851 .name = "scsi-requests",
1852 .get = get_scsi_requests,
1853 .put = put_scsi_requests,
1856 const VMStateDescription vmstate_scsi_device = {
1857 .name = "SCSIDevice",
1859 .minimum_version_id = 1,
1860 .minimum_version_id_old = 1,
1861 .fields = (VMStateField[]) {
1862 VMSTATE_UINT8(unit_attention.key, SCSIDevice),
1863 VMSTATE_UINT8(unit_attention.asc, SCSIDevice),
1864 VMSTATE_UINT8(unit_attention.ascq, SCSIDevice),
1865 VMSTATE_BOOL(sense_is_ua, SCSIDevice),
1866 VMSTATE_UINT8_ARRAY(sense, SCSIDevice, SCSI_SENSE_BUF_SIZE),
1867 VMSTATE_UINT32(sense_len, SCSIDevice),
1871 .field_exists = NULL,
1872 .size = 0, /* ouch */
1873 .info = &vmstate_info_scsi_requests,
1874 .flags = VMS_SINGLE,
1877 VMSTATE_END_OF_LIST()
1881 static void scsi_device_class_init(ObjectClass *klass, void *data)
1883 DeviceClass *k = DEVICE_CLASS(klass);
1884 set_bit(DEVICE_CATEGORY_STORAGE, k->categories);
1885 k->bus_type = TYPE_SCSI_BUS;
1886 k->init = scsi_qdev_init;
1887 k->unplug = scsi_qdev_unplug;
1888 k->exit = scsi_qdev_exit;
1889 k->props = scsi_props;
1892 static const TypeInfo scsi_device_type_info = {
1893 .name = TYPE_SCSI_DEVICE,
1894 .parent = TYPE_DEVICE,
1895 .instance_size = sizeof(SCSIDevice),
1897 .class_size = sizeof(SCSIDeviceClass),
1898 .class_init = scsi_device_class_init,
1901 static void scsi_register_types(void)
1903 type_register_static(&scsi_bus_info);
1904 type_register_static(&scsi_device_type_info);
1907 type_init(scsi_register_types)