scsi: Drop SCSIReqOps.cancel_io
[qemu/kevin.git] / hw / scsi / scsi-bus.c
blob764f6cf3b56b343ef3c7e8d63742e8eddcea4af1
1 #include "hw/hw.h"
2 #include "qemu/error-report.h"
3 #include "hw/scsi/scsi.h"
4 #include "block/scsi.h"
5 #include "hw/qdev.h"
6 #include "sysemu/blockdev.h"
7 #include "trace.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 void scsi_req_dequeue(SCSIRequest *req);
13 static uint8_t *scsi_target_alloc_buf(SCSIRequest *req, size_t len);
14 static void scsi_target_free_buf(SCSIRequest *req);
16 static Property scsi_props[] = {
17 DEFINE_PROP_UINT32("channel", SCSIDevice, channel, 0),
18 DEFINE_PROP_UINT32("scsi-id", SCSIDevice, id, -1),
19 DEFINE_PROP_UINT32("lun", SCSIDevice, lun, -1),
20 DEFINE_PROP_END_OF_LIST(),
23 static void scsi_bus_class_init(ObjectClass *klass, void *data)
25 BusClass *k = BUS_CLASS(klass);
27 k->get_dev_path = scsibus_get_dev_path;
28 k->get_fw_dev_path = scsibus_get_fw_dev_path;
31 static const TypeInfo scsi_bus_info = {
32 .name = TYPE_SCSI_BUS,
33 .parent = TYPE_BUS,
34 .instance_size = sizeof(SCSIBus),
35 .class_init = scsi_bus_class_init,
37 static int next_scsi_bus;
39 static void scsi_device_realize(SCSIDevice *s, Error **errp)
41 SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
42 if (sc->realize) {
43 sc->realize(s, errp);
47 static void scsi_device_unrealize(SCSIDevice *s, Error **errp)
49 SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
50 if (sc->unrealize) {
51 sc->unrealize(s, errp);
55 int scsi_bus_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
56 void *hba_private)
58 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
59 int rc;
61 assert(cmd->len == 0);
62 rc = scsi_req_parse_cdb(dev, cmd, buf);
63 if (bus->info->parse_cdb) {
64 rc = bus->info->parse_cdb(dev, cmd, buf, hba_private);
66 return rc;
69 static SCSIRequest *scsi_device_alloc_req(SCSIDevice *s, uint32_t tag, uint32_t lun,
70 uint8_t *buf, void *hba_private)
72 SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
73 if (sc->alloc_req) {
74 return sc->alloc_req(s, tag, lun, buf, hba_private);
77 return NULL;
80 static void scsi_device_unit_attention_reported(SCSIDevice *s)
82 SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
83 if (sc->unit_attention_reported) {
84 sc->unit_attention_reported(s);
88 /* Create a scsi bus, and attach devices to it. */
89 void scsi_bus_new(SCSIBus *bus, size_t bus_size, DeviceState *host,
90 const SCSIBusInfo *info, const char *bus_name)
92 qbus_create_inplace(bus, bus_size, TYPE_SCSI_BUS, host, bus_name);
93 bus->busnr = next_scsi_bus++;
94 bus->info = info;
95 bus->qbus.allow_hotplug = 1;
98 static void scsi_dma_restart_bh(void *opaque)
100 SCSIDevice *s = opaque;
101 SCSIRequest *req, *next;
103 qemu_bh_delete(s->bh);
104 s->bh = NULL;
106 QTAILQ_FOREACH_SAFE(req, &s->requests, next, next) {
107 scsi_req_ref(req);
108 if (req->retry) {
109 req->retry = false;
110 switch (req->cmd.mode) {
111 case SCSI_XFER_FROM_DEV:
112 case SCSI_XFER_TO_DEV:
113 scsi_req_continue(req);
114 break;
115 case SCSI_XFER_NONE:
116 scsi_req_dequeue(req);
117 scsi_req_enqueue(req);
118 break;
121 scsi_req_unref(req);
125 void scsi_req_retry(SCSIRequest *req)
127 /* No need to save a reference, because scsi_dma_restart_bh just
128 * looks at the request list. */
129 req->retry = true;
132 static void scsi_dma_restart_cb(void *opaque, int running, RunState state)
134 SCSIDevice *s = opaque;
136 if (!running) {
137 return;
139 if (!s->bh) {
140 s->bh = qemu_bh_new(scsi_dma_restart_bh, s);
141 qemu_bh_schedule(s->bh);
145 static void scsi_qdev_realize(DeviceState *qdev, Error **errp)
147 SCSIDevice *dev = SCSI_DEVICE(qdev);
148 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
149 SCSIDevice *d;
150 Error *local_err = NULL;
152 if (dev->channel > bus->info->max_channel) {
153 error_setg(errp, "bad scsi channel id: %d", dev->channel);
154 return;
156 if (dev->id != -1 && dev->id > bus->info->max_target) {
157 error_setg(errp, "bad scsi device id: %d", dev->id);
158 return;
160 if (dev->lun != -1 && dev->lun > bus->info->max_lun) {
161 error_setg(errp, "bad scsi device lun: %d", dev->lun);
162 return;
165 if (dev->id == -1) {
166 int id = -1;
167 if (dev->lun == -1) {
168 dev->lun = 0;
170 do {
171 d = scsi_device_find(bus, dev->channel, ++id, dev->lun);
172 } while (d && d->lun == dev->lun && id < bus->info->max_target);
173 if (d && d->lun == dev->lun) {
174 error_setg(errp, "no free target");
175 return;
177 dev->id = id;
178 } else if (dev->lun == -1) {
179 int lun = -1;
180 do {
181 d = scsi_device_find(bus, dev->channel, dev->id, ++lun);
182 } while (d && d->lun == lun && lun < bus->info->max_lun);
183 if (d && d->lun == lun) {
184 error_setg(errp, "no free lun");
185 return;
187 dev->lun = lun;
188 } else {
189 d = scsi_device_find(bus, dev->channel, dev->id, dev->lun);
190 assert(d);
191 if (d->lun == dev->lun && dev != d) {
192 error_setg(errp, "lun already used by '%s'", d->qdev.id);
193 return;
197 QTAILQ_INIT(&dev->requests);
198 scsi_device_realize(dev, &local_err);
199 if (local_err) {
200 error_propagate(errp, local_err);
201 return;
203 dev->vmsentry = qemu_add_vm_change_state_handler(scsi_dma_restart_cb,
204 dev);
206 if (bus->info->hotplug) {
207 bus->info->hotplug(bus, dev);
211 static void scsi_qdev_unrealize(DeviceState *qdev, Error **errp)
213 SCSIDevice *dev = SCSI_DEVICE(qdev);
215 if (dev->vmsentry) {
216 qemu_del_vm_change_state_handler(dev->vmsentry);
218 scsi_device_unrealize(dev, errp);
221 /* handle legacy '-drive if=scsi,...' cmd line args */
222 SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockDriverState *bdrv,
223 int unit, bool removable, int bootindex,
224 const char *serial, Error **errp)
226 const char *driver;
227 DeviceState *dev;
228 Error *err = NULL;
230 driver = bdrv_is_sg(bdrv) ? "scsi-generic" : "scsi-disk";
231 dev = qdev_create(&bus->qbus, driver);
232 qdev_prop_set_uint32(dev, "scsi-id", unit);
233 if (bootindex >= 0) {
234 qdev_prop_set_int32(dev, "bootindex", bootindex);
236 if (object_property_find(OBJECT(dev), "removable", NULL)) {
237 qdev_prop_set_bit(dev, "removable", removable);
239 if (serial && object_property_find(OBJECT(dev), "serial", NULL)) {
240 qdev_prop_set_string(dev, "serial", serial);
242 if (qdev_prop_set_drive(dev, "drive", bdrv) < 0) {
243 error_setg(errp, "Setting drive property failed");
244 object_unparent(OBJECT(dev));
245 return NULL;
247 object_property_set_bool(OBJECT(dev), true, "realized", &err);
248 if (err != NULL) {
249 error_propagate(errp, err);
250 object_unparent(OBJECT(dev));
251 return NULL;
253 return SCSI_DEVICE(dev);
256 void scsi_bus_legacy_handle_cmdline(SCSIBus *bus, Error **errp)
258 Location loc;
259 DriveInfo *dinfo;
260 int unit;
261 Error *err = NULL;
263 loc_push_none(&loc);
264 for (unit = 0; unit <= bus->info->max_target; unit++) {
265 dinfo = drive_get(IF_SCSI, bus->busnr, unit);
266 if (dinfo == NULL) {
267 continue;
269 qemu_opts_loc_restore(dinfo->opts);
270 scsi_bus_legacy_add_drive(bus, dinfo->bdrv, unit, false, -1, NULL,
271 &err);
272 if (err != NULL) {
273 error_report("%s", error_get_pretty(err));
274 error_propagate(errp, err);
275 break;
278 loc_pop(&loc);
281 static int32_t scsi_invalid_field(SCSIRequest *req, uint8_t *buf)
283 scsi_req_build_sense(req, SENSE_CODE(INVALID_FIELD));
284 scsi_req_complete(req, CHECK_CONDITION);
285 return 0;
288 static const struct SCSIReqOps reqops_invalid_field = {
289 .size = sizeof(SCSIRequest),
290 .send_command = scsi_invalid_field
293 /* SCSIReqOps implementation for invalid commands. */
295 static int32_t scsi_invalid_command(SCSIRequest *req, uint8_t *buf)
297 scsi_req_build_sense(req, SENSE_CODE(INVALID_OPCODE));
298 scsi_req_complete(req, CHECK_CONDITION);
299 return 0;
302 static const struct SCSIReqOps reqops_invalid_opcode = {
303 .size = sizeof(SCSIRequest),
304 .send_command = scsi_invalid_command
307 /* SCSIReqOps implementation for unit attention conditions. */
309 static int32_t scsi_unit_attention(SCSIRequest *req, uint8_t *buf)
311 if (req->dev->unit_attention.key == UNIT_ATTENTION) {
312 scsi_req_build_sense(req, req->dev->unit_attention);
313 } else if (req->bus->unit_attention.key == UNIT_ATTENTION) {
314 scsi_req_build_sense(req, req->bus->unit_attention);
316 scsi_req_complete(req, CHECK_CONDITION);
317 return 0;
320 static const struct SCSIReqOps reqops_unit_attention = {
321 .size = sizeof(SCSIRequest),
322 .send_command = scsi_unit_attention
325 /* SCSIReqOps implementation for REPORT LUNS and for commands sent to
326 an invalid LUN. */
328 typedef struct SCSITargetReq SCSITargetReq;
330 struct SCSITargetReq {
331 SCSIRequest req;
332 int len;
333 uint8_t *buf;
334 int buf_len;
337 static void store_lun(uint8_t *outbuf, int lun)
339 if (lun < 256) {
340 outbuf[1] = lun;
341 return;
343 outbuf[1] = (lun & 255);
344 outbuf[0] = (lun >> 8) | 0x40;
347 static bool scsi_target_emulate_report_luns(SCSITargetReq *r)
349 BusChild *kid;
350 int i, len, n;
351 int channel, id;
352 bool found_lun0;
354 if (r->req.cmd.xfer < 16) {
355 return false;
357 if (r->req.cmd.buf[2] > 2) {
358 return false;
360 channel = r->req.dev->channel;
361 id = r->req.dev->id;
362 found_lun0 = false;
363 n = 0;
364 QTAILQ_FOREACH(kid, &r->req.bus->qbus.children, sibling) {
365 DeviceState *qdev = kid->child;
366 SCSIDevice *dev = SCSI_DEVICE(qdev);
368 if (dev->channel == channel && dev->id == id) {
369 if (dev->lun == 0) {
370 found_lun0 = true;
372 n += 8;
375 if (!found_lun0) {
376 n += 8;
379 scsi_target_alloc_buf(&r->req, n + 8);
381 len = MIN(n + 8, r->req.cmd.xfer & ~7);
382 memset(r->buf, 0, len);
383 stl_be_p(&r->buf[0], n);
384 i = found_lun0 ? 8 : 16;
385 QTAILQ_FOREACH(kid, &r->req.bus->qbus.children, sibling) {
386 DeviceState *qdev = kid->child;
387 SCSIDevice *dev = SCSI_DEVICE(qdev);
389 if (dev->channel == channel && dev->id == id) {
390 store_lun(&r->buf[i], dev->lun);
391 i += 8;
394 assert(i == n + 8);
395 r->len = len;
396 return true;
399 static bool scsi_target_emulate_inquiry(SCSITargetReq *r)
401 assert(r->req.dev->lun != r->req.lun);
403 scsi_target_alloc_buf(&r->req, SCSI_INQUIRY_LEN);
405 if (r->req.cmd.buf[1] & 0x2) {
406 /* Command support data - optional, not implemented */
407 return false;
410 if (r->req.cmd.buf[1] & 0x1) {
411 /* Vital product data */
412 uint8_t page_code = r->req.cmd.buf[2];
413 r->buf[r->len++] = page_code ; /* this page */
414 r->buf[r->len++] = 0x00;
416 switch (page_code) {
417 case 0x00: /* Supported page codes, mandatory */
419 int pages;
420 pages = r->len++;
421 r->buf[r->len++] = 0x00; /* list of supported pages (this page) */
422 r->buf[pages] = r->len - pages - 1; /* number of pages */
423 break;
425 default:
426 return false;
428 /* done with EVPD */
429 assert(r->len < r->buf_len);
430 r->len = MIN(r->req.cmd.xfer, r->len);
431 return true;
434 /* Standard INQUIRY data */
435 if (r->req.cmd.buf[2] != 0) {
436 return false;
439 /* PAGE CODE == 0 */
440 r->len = MIN(r->req.cmd.xfer, SCSI_INQUIRY_LEN);
441 memset(r->buf, 0, r->len);
442 if (r->req.lun != 0) {
443 r->buf[0] = TYPE_NO_LUN;
444 } else {
445 r->buf[0] = TYPE_NOT_PRESENT | TYPE_INACTIVE;
446 r->buf[2] = 5; /* Version */
447 r->buf[3] = 2 | 0x10; /* HiSup, response data format */
448 r->buf[4] = r->len - 5; /* Additional Length = (Len - 1) - 4 */
449 r->buf[7] = 0x10 | (r->req.bus->info->tcq ? 0x02 : 0); /* Sync, TCQ. */
450 memcpy(&r->buf[8], "QEMU ", 8);
451 memcpy(&r->buf[16], "QEMU TARGET ", 16);
452 pstrcpy((char *) &r->buf[32], 4, qemu_get_version());
454 return true;
457 static int32_t scsi_target_send_command(SCSIRequest *req, uint8_t *buf)
459 SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
461 switch (buf[0]) {
462 case REPORT_LUNS:
463 if (!scsi_target_emulate_report_luns(r)) {
464 goto illegal_request;
466 break;
467 case INQUIRY:
468 if (!scsi_target_emulate_inquiry(r)) {
469 goto illegal_request;
471 break;
472 case REQUEST_SENSE:
473 scsi_target_alloc_buf(&r->req, SCSI_SENSE_LEN);
474 r->len = scsi_device_get_sense(r->req.dev, r->buf,
475 MIN(req->cmd.xfer, r->buf_len),
476 (req->cmd.buf[1] & 1) == 0);
477 if (r->req.dev->sense_is_ua) {
478 scsi_device_unit_attention_reported(req->dev);
479 r->req.dev->sense_len = 0;
480 r->req.dev->sense_is_ua = false;
482 break;
483 case TEST_UNIT_READY:
484 break;
485 default:
486 scsi_req_build_sense(req, SENSE_CODE(LUN_NOT_SUPPORTED));
487 scsi_req_complete(req, CHECK_CONDITION);
488 return 0;
489 illegal_request:
490 scsi_req_build_sense(req, SENSE_CODE(INVALID_FIELD));
491 scsi_req_complete(req, CHECK_CONDITION);
492 return 0;
495 if (!r->len) {
496 scsi_req_complete(req, GOOD);
498 return r->len;
501 static void scsi_target_read_data(SCSIRequest *req)
503 SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
504 uint32_t n;
506 n = r->len;
507 if (n > 0) {
508 r->len = 0;
509 scsi_req_data(&r->req, n);
510 } else {
511 scsi_req_complete(&r->req, GOOD);
515 static uint8_t *scsi_target_get_buf(SCSIRequest *req)
517 SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
519 return r->buf;
522 static uint8_t *scsi_target_alloc_buf(SCSIRequest *req, size_t len)
524 SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
526 r->buf = g_malloc(len);
527 r->buf_len = len;
529 return r->buf;
532 static void scsi_target_free_buf(SCSIRequest *req)
534 SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
536 g_free(r->buf);
539 static const struct SCSIReqOps reqops_target_command = {
540 .size = sizeof(SCSITargetReq),
541 .send_command = scsi_target_send_command,
542 .read_data = scsi_target_read_data,
543 .get_buf = scsi_target_get_buf,
544 .free_req = scsi_target_free_buf,
548 SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d,
549 uint32_t tag, uint32_t lun, void *hba_private)
551 SCSIRequest *req;
552 SCSIBus *bus = scsi_bus_from_device(d);
553 BusState *qbus = BUS(bus);
554 const int memset_off = offsetof(SCSIRequest, sense)
555 + sizeof(req->sense);
557 req = g_slice_alloc(reqops->size);
558 memset((uint8_t *)req + memset_off, 0, reqops->size - memset_off);
559 req->refcount = 1;
560 req->bus = bus;
561 req->dev = d;
562 req->tag = tag;
563 req->lun = lun;
564 req->hba_private = hba_private;
565 req->status = -1;
566 req->ops = reqops;
567 object_ref(OBJECT(d));
568 object_ref(OBJECT(qbus->parent));
569 trace_scsi_req_alloc(req->dev->id, req->lun, req->tag);
570 return req;
573 SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun,
574 uint8_t *buf, void *hba_private)
576 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
577 const SCSIReqOps *ops;
578 SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(d);
579 SCSIRequest *req;
580 SCSICommand cmd = { .len = 0 };
581 int ret;
583 if ((d->unit_attention.key == UNIT_ATTENTION ||
584 bus->unit_attention.key == UNIT_ATTENTION) &&
585 (buf[0] != INQUIRY &&
586 buf[0] != REPORT_LUNS &&
587 buf[0] != GET_CONFIGURATION &&
588 buf[0] != GET_EVENT_STATUS_NOTIFICATION &&
591 * If we already have a pending unit attention condition,
592 * report this one before triggering another one.
594 !(buf[0] == REQUEST_SENSE && d->sense_is_ua))) {
595 ops = &reqops_unit_attention;
596 } else if (lun != d->lun ||
597 buf[0] == REPORT_LUNS ||
598 (buf[0] == REQUEST_SENSE && d->sense_len)) {
599 ops = &reqops_target_command;
600 } else {
601 ops = NULL;
604 if (ops != NULL || !sc->parse_cdb) {
605 ret = scsi_req_parse_cdb(d, &cmd, buf);
606 } else {
607 ret = sc->parse_cdb(d, &cmd, buf, hba_private);
610 if (ret != 0) {
611 trace_scsi_req_parse_bad(d->id, lun, tag, buf[0]);
612 req = scsi_req_alloc(&reqops_invalid_opcode, d, tag, lun, hba_private);
613 } else {
614 assert(cmd.len != 0);
615 trace_scsi_req_parsed(d->id, lun, tag, buf[0],
616 cmd.mode, cmd.xfer);
617 if (cmd.lba != -1) {
618 trace_scsi_req_parsed_lba(d->id, lun, tag, buf[0],
619 cmd.lba);
622 if (cmd.xfer > INT32_MAX) {
623 req = scsi_req_alloc(&reqops_invalid_field, d, tag, lun, hba_private);
624 } else if (ops) {
625 req = scsi_req_alloc(ops, d, tag, lun, hba_private);
626 } else {
627 req = scsi_device_alloc_req(d, tag, lun, buf, hba_private);
631 req->cmd = cmd;
632 req->resid = req->cmd.xfer;
634 switch (buf[0]) {
635 case INQUIRY:
636 trace_scsi_inquiry(d->id, lun, tag, cmd.buf[1], cmd.buf[2]);
637 break;
638 case TEST_UNIT_READY:
639 trace_scsi_test_unit_ready(d->id, lun, tag);
640 break;
641 case REPORT_LUNS:
642 trace_scsi_report_luns(d->id, lun, tag);
643 break;
644 case REQUEST_SENSE:
645 trace_scsi_request_sense(d->id, lun, tag);
646 break;
647 default:
648 break;
651 return req;
654 uint8_t *scsi_req_get_buf(SCSIRequest *req)
656 return req->ops->get_buf(req);
659 static void scsi_clear_unit_attention(SCSIRequest *req)
661 SCSISense *ua;
662 if (req->dev->unit_attention.key != UNIT_ATTENTION &&
663 req->bus->unit_attention.key != UNIT_ATTENTION) {
664 return;
668 * If an INQUIRY command enters the enabled command state,
669 * the device server shall [not] clear any unit attention condition;
670 * See also MMC-6, paragraphs 6.5 and 6.6.2.
672 if (req->cmd.buf[0] == INQUIRY ||
673 req->cmd.buf[0] == GET_CONFIGURATION ||
674 req->cmd.buf[0] == GET_EVENT_STATUS_NOTIFICATION) {
675 return;
678 if (req->dev->unit_attention.key == UNIT_ATTENTION) {
679 ua = &req->dev->unit_attention;
680 } else {
681 ua = &req->bus->unit_attention;
685 * If a REPORT LUNS command enters the enabled command state, [...]
686 * the device server shall clear any pending unit attention condition
687 * with an additional sense code of REPORTED LUNS DATA HAS CHANGED.
689 if (req->cmd.buf[0] == REPORT_LUNS &&
690 !(ua->asc == SENSE_CODE(REPORTED_LUNS_CHANGED).asc &&
691 ua->ascq == SENSE_CODE(REPORTED_LUNS_CHANGED).ascq)) {
692 return;
695 *ua = SENSE_CODE(NO_SENSE);
698 int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len)
700 int ret;
702 assert(len >= 14);
703 if (!req->sense_len) {
704 return 0;
707 ret = scsi_build_sense(req->sense, req->sense_len, buf, len, true);
710 * FIXME: clearing unit attention conditions upon autosense should be done
711 * only if the UA_INTLCK_CTRL field in the Control mode page is set to 00b
712 * (SAM-5, 5.14).
714 * We assume UA_INTLCK_CTRL to be 00b for HBAs that support autosense, and
715 * 10b for HBAs that do not support it (do not call scsi_req_get_sense).
716 * Here we handle unit attention clearing for UA_INTLCK_CTRL == 00b.
718 if (req->dev->sense_is_ua) {
719 scsi_device_unit_attention_reported(req->dev);
720 req->dev->sense_len = 0;
721 req->dev->sense_is_ua = false;
723 return ret;
726 int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed)
728 return scsi_build_sense(dev->sense, dev->sense_len, buf, len, fixed);
731 void scsi_req_build_sense(SCSIRequest *req, SCSISense sense)
733 trace_scsi_req_build_sense(req->dev->id, req->lun, req->tag,
734 sense.key, sense.asc, sense.ascq);
735 memset(req->sense, 0, 18);
736 req->sense[0] = 0x70;
737 req->sense[2] = sense.key;
738 req->sense[7] = 10;
739 req->sense[12] = sense.asc;
740 req->sense[13] = sense.ascq;
741 req->sense_len = 18;
744 static void scsi_req_enqueue_internal(SCSIRequest *req)
746 assert(!req->enqueued);
747 scsi_req_ref(req);
748 if (req->bus->info->get_sg_list) {
749 req->sg = req->bus->info->get_sg_list(req);
750 } else {
751 req->sg = NULL;
753 req->enqueued = true;
754 QTAILQ_INSERT_TAIL(&req->dev->requests, req, next);
757 int32_t scsi_req_enqueue(SCSIRequest *req)
759 int32_t rc;
761 assert(!req->retry);
762 scsi_req_enqueue_internal(req);
763 scsi_req_ref(req);
764 rc = req->ops->send_command(req, req->cmd.buf);
765 scsi_req_unref(req);
766 return rc;
769 static void scsi_req_dequeue(SCSIRequest *req)
771 trace_scsi_req_dequeue(req->dev->id, req->lun, req->tag);
772 req->retry = false;
773 if (req->enqueued) {
774 QTAILQ_REMOVE(&req->dev->requests, req, next);
775 req->enqueued = false;
776 scsi_req_unref(req);
780 static int scsi_get_performance_length(int num_desc, int type, int data_type)
782 /* MMC-6, paragraph 6.7. */
783 switch (type) {
784 case 0:
785 if ((data_type & 3) == 0) {
786 /* Each descriptor is as in Table 295 - Nominal performance. */
787 return 16 * num_desc + 8;
788 } else {
789 /* Each descriptor is as in Table 296 - Exceptions. */
790 return 6 * num_desc + 8;
792 case 1:
793 case 4:
794 case 5:
795 return 8 * num_desc + 8;
796 case 2:
797 return 2048 * num_desc + 8;
798 case 3:
799 return 16 * num_desc + 8;
800 default:
801 return 8;
805 static int ata_passthrough_xfer_unit(SCSIDevice *dev, uint8_t *buf)
807 int byte_block = (buf[2] >> 2) & 0x1;
808 int type = (buf[2] >> 4) & 0x1;
809 int xfer_unit;
811 if (byte_block) {
812 if (type) {
813 xfer_unit = dev->blocksize;
814 } else {
815 xfer_unit = 512;
817 } else {
818 xfer_unit = 1;
821 return xfer_unit;
824 static int ata_passthrough_12_xfer_size(SCSIDevice *dev, uint8_t *buf)
826 int length = buf[2] & 0x3;
827 int xfer;
828 int unit = ata_passthrough_xfer_unit(dev, buf);
830 switch (length) {
831 case 0:
832 case 3: /* USB-specific. */
833 default:
834 xfer = 0;
835 break;
836 case 1:
837 xfer = buf[3];
838 break;
839 case 2:
840 xfer = buf[4];
841 break;
844 return xfer * unit;
847 static int ata_passthrough_16_xfer_size(SCSIDevice *dev, uint8_t *buf)
849 int extend = buf[1] & 0x1;
850 int length = buf[2] & 0x3;
851 int xfer;
852 int unit = ata_passthrough_xfer_unit(dev, buf);
854 switch (length) {
855 case 0:
856 case 3: /* USB-specific. */
857 default:
858 xfer = 0;
859 break;
860 case 1:
861 xfer = buf[4];
862 xfer |= (extend ? buf[3] << 8 : 0);
863 break;
864 case 2:
865 xfer = buf[6];
866 xfer |= (extend ? buf[5] << 8 : 0);
867 break;
870 return xfer * unit;
873 uint32_t scsi_data_cdb_length(uint8_t *buf)
875 if ((buf[0] >> 5) == 0 && buf[4] == 0) {
876 return 256;
877 } else {
878 return scsi_cdb_length(buf);
882 uint32_t scsi_cdb_length(uint8_t *buf)
884 switch (buf[0] >> 5) {
885 case 0:
886 return buf[4];
887 break;
888 case 1:
889 case 2:
890 return lduw_be_p(&buf[7]);
891 break;
892 case 4:
893 return ldl_be_p(&buf[10]) & 0xffffffffULL;
894 break;
895 case 5:
896 return ldl_be_p(&buf[6]) & 0xffffffffULL;
897 break;
898 default:
899 return -1;
903 static int scsi_req_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
905 cmd->xfer = scsi_cdb_length(buf);
906 switch (buf[0]) {
907 case TEST_UNIT_READY:
908 case REWIND:
909 case START_STOP:
910 case SET_CAPACITY:
911 case WRITE_FILEMARKS:
912 case WRITE_FILEMARKS_16:
913 case SPACE:
914 case RESERVE:
915 case RELEASE:
916 case ERASE:
917 case ALLOW_MEDIUM_REMOVAL:
918 case SEEK_10:
919 case SYNCHRONIZE_CACHE:
920 case SYNCHRONIZE_CACHE_16:
921 case LOCATE_16:
922 case LOCK_UNLOCK_CACHE:
923 case SET_CD_SPEED:
924 case SET_LIMITS:
925 case WRITE_LONG_10:
926 case UPDATE_BLOCK:
927 case RESERVE_TRACK:
928 case SET_READ_AHEAD:
929 case PRE_FETCH:
930 case PRE_FETCH_16:
931 case ALLOW_OVERWRITE:
932 cmd->xfer = 0;
933 break;
934 case VERIFY_10:
935 case VERIFY_12:
936 case VERIFY_16:
937 if ((buf[1] & 2) == 0) {
938 cmd->xfer = 0;
939 } else if ((buf[1] & 4) != 0) {
940 cmd->xfer = 1;
942 cmd->xfer *= dev->blocksize;
943 break;
944 case MODE_SENSE:
945 break;
946 case WRITE_SAME_10:
947 case WRITE_SAME_16:
948 cmd->xfer = dev->blocksize;
949 break;
950 case READ_CAPACITY_10:
951 cmd->xfer = 8;
952 break;
953 case READ_BLOCK_LIMITS:
954 cmd->xfer = 6;
955 break;
956 case SEND_VOLUME_TAG:
957 /* GPCMD_SET_STREAMING from multimedia commands. */
958 if (dev->type == TYPE_ROM) {
959 cmd->xfer = buf[10] | (buf[9] << 8);
960 } else {
961 cmd->xfer = buf[9] | (buf[8] << 8);
963 break;
964 case WRITE_6:
965 /* length 0 means 256 blocks */
966 if (cmd->xfer == 0) {
967 cmd->xfer = 256;
969 /* fall through */
970 case WRITE_10:
971 case WRITE_VERIFY_10:
972 case WRITE_12:
973 case WRITE_VERIFY_12:
974 case WRITE_16:
975 case WRITE_VERIFY_16:
976 cmd->xfer *= dev->blocksize;
977 break;
978 case READ_6:
979 case READ_REVERSE:
980 /* length 0 means 256 blocks */
981 if (cmd->xfer == 0) {
982 cmd->xfer = 256;
984 /* fall through */
985 case READ_10:
986 case RECOVER_BUFFERED_DATA:
987 case READ_12:
988 case READ_16:
989 cmd->xfer *= dev->blocksize;
990 break;
991 case FORMAT_UNIT:
992 /* MMC mandates the parameter list to be 12-bytes long. Parameters
993 * for block devices are restricted to the header right now. */
994 if (dev->type == TYPE_ROM && (buf[1] & 16)) {
995 cmd->xfer = 12;
996 } else {
997 cmd->xfer = (buf[1] & 16) == 0 ? 0 : (buf[1] & 32 ? 8 : 4);
999 break;
1000 case INQUIRY:
1001 case RECEIVE_DIAGNOSTIC:
1002 case SEND_DIAGNOSTIC:
1003 cmd->xfer = buf[4] | (buf[3] << 8);
1004 break;
1005 case READ_CD:
1006 case READ_BUFFER:
1007 case WRITE_BUFFER:
1008 case SEND_CUE_SHEET:
1009 cmd->xfer = buf[8] | (buf[7] << 8) | (buf[6] << 16);
1010 break;
1011 case PERSISTENT_RESERVE_OUT:
1012 cmd->xfer = ldl_be_p(&buf[5]) & 0xffffffffULL;
1013 break;
1014 case ERASE_12:
1015 if (dev->type == TYPE_ROM) {
1016 /* MMC command GET PERFORMANCE. */
1017 cmd->xfer = scsi_get_performance_length(buf[9] | (buf[8] << 8),
1018 buf[10], buf[1] & 0x1f);
1020 break;
1021 case MECHANISM_STATUS:
1022 case READ_DVD_STRUCTURE:
1023 case SEND_DVD_STRUCTURE:
1024 case MAINTENANCE_OUT:
1025 case MAINTENANCE_IN:
1026 if (dev->type == TYPE_ROM) {
1027 /* GPCMD_REPORT_KEY and GPCMD_SEND_KEY from multi media commands */
1028 cmd->xfer = buf[9] | (buf[8] << 8);
1030 break;
1031 case ATA_PASSTHROUGH_12:
1032 if (dev->type == TYPE_ROM) {
1033 /* BLANK command of MMC */
1034 cmd->xfer = 0;
1035 } else {
1036 cmd->xfer = ata_passthrough_12_xfer_size(dev, buf);
1038 break;
1039 case ATA_PASSTHROUGH_16:
1040 cmd->xfer = ata_passthrough_16_xfer_size(dev, buf);
1041 break;
1043 return 0;
1046 static int scsi_req_stream_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
1048 switch (buf[0]) {
1049 /* stream commands */
1050 case ERASE_12:
1051 case ERASE_16:
1052 cmd->xfer = 0;
1053 break;
1054 case READ_6:
1055 case READ_REVERSE:
1056 case RECOVER_BUFFERED_DATA:
1057 case WRITE_6:
1058 cmd->xfer = buf[4] | (buf[3] << 8) | (buf[2] << 16);
1059 if (buf[1] & 0x01) { /* fixed */
1060 cmd->xfer *= dev->blocksize;
1062 break;
1063 case READ_16:
1064 case READ_REVERSE_16:
1065 case VERIFY_16:
1066 case WRITE_16:
1067 cmd->xfer = buf[14] | (buf[13] << 8) | (buf[12] << 16);
1068 if (buf[1] & 0x01) { /* fixed */
1069 cmd->xfer *= dev->blocksize;
1071 break;
1072 case REWIND:
1073 case LOAD_UNLOAD:
1074 cmd->xfer = 0;
1075 break;
1076 case SPACE_16:
1077 cmd->xfer = buf[13] | (buf[12] << 8);
1078 break;
1079 case READ_POSITION:
1080 switch (buf[1] & 0x1f) /* operation code */ {
1081 case SHORT_FORM_BLOCK_ID:
1082 case SHORT_FORM_VENDOR_SPECIFIC:
1083 cmd->xfer = 20;
1084 break;
1085 case LONG_FORM:
1086 cmd->xfer = 32;
1087 break;
1088 case EXTENDED_FORM:
1089 cmd->xfer = buf[8] | (buf[7] << 8);
1090 break;
1091 default:
1092 return -1;
1095 break;
1096 case FORMAT_UNIT:
1097 cmd->xfer = buf[4] | (buf[3] << 8);
1098 break;
1099 /* generic commands */
1100 default:
1101 return scsi_req_length(cmd, dev, buf);
1103 return 0;
1106 static int scsi_req_medium_changer_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
1108 switch (buf[0]) {
1109 /* medium changer commands */
1110 case EXCHANGE_MEDIUM:
1111 case INITIALIZE_ELEMENT_STATUS:
1112 case INITIALIZE_ELEMENT_STATUS_WITH_RANGE:
1113 case MOVE_MEDIUM:
1114 case POSITION_TO_ELEMENT:
1115 cmd->xfer = 0;
1116 break;
1117 case READ_ELEMENT_STATUS:
1118 cmd->xfer = buf[9] | (buf[8] << 8) | (buf[7] << 16);
1119 break;
1121 /* generic commands */
1122 default:
1123 return scsi_req_length(cmd, dev, buf);
1125 return 0;
1129 static void scsi_cmd_xfer_mode(SCSICommand *cmd)
1131 if (!cmd->xfer) {
1132 cmd->mode = SCSI_XFER_NONE;
1133 return;
1135 switch (cmd->buf[0]) {
1136 case WRITE_6:
1137 case WRITE_10:
1138 case WRITE_VERIFY_10:
1139 case WRITE_12:
1140 case WRITE_VERIFY_12:
1141 case WRITE_16:
1142 case WRITE_VERIFY_16:
1143 case VERIFY_10:
1144 case VERIFY_12:
1145 case VERIFY_16:
1146 case COPY:
1147 case COPY_VERIFY:
1148 case COMPARE:
1149 case CHANGE_DEFINITION:
1150 case LOG_SELECT:
1151 case MODE_SELECT:
1152 case MODE_SELECT_10:
1153 case SEND_DIAGNOSTIC:
1154 case WRITE_BUFFER:
1155 case FORMAT_UNIT:
1156 case REASSIGN_BLOCKS:
1157 case SEARCH_EQUAL:
1158 case SEARCH_HIGH:
1159 case SEARCH_LOW:
1160 case UPDATE_BLOCK:
1161 case WRITE_LONG_10:
1162 case WRITE_SAME_10:
1163 case WRITE_SAME_16:
1164 case UNMAP:
1165 case SEARCH_HIGH_12:
1166 case SEARCH_EQUAL_12:
1167 case SEARCH_LOW_12:
1168 case MEDIUM_SCAN:
1169 case SEND_VOLUME_TAG:
1170 case SEND_CUE_SHEET:
1171 case SEND_DVD_STRUCTURE:
1172 case PERSISTENT_RESERVE_OUT:
1173 case MAINTENANCE_OUT:
1174 cmd->mode = SCSI_XFER_TO_DEV;
1175 break;
1176 case ATA_PASSTHROUGH_12:
1177 case ATA_PASSTHROUGH_16:
1178 /* T_DIR */
1179 cmd->mode = (cmd->buf[2] & 0x8) ?
1180 SCSI_XFER_FROM_DEV : SCSI_XFER_TO_DEV;
1181 break;
1182 default:
1183 cmd->mode = SCSI_XFER_FROM_DEV;
1184 break;
1188 static uint64_t scsi_cmd_lba(SCSICommand *cmd)
1190 uint8_t *buf = cmd->buf;
1191 uint64_t lba;
1193 switch (buf[0] >> 5) {
1194 case 0:
1195 lba = ldl_be_p(&buf[0]) & 0x1fffff;
1196 break;
1197 case 1:
1198 case 2:
1199 case 5:
1200 lba = ldl_be_p(&buf[2]) & 0xffffffffULL;
1201 break;
1202 case 4:
1203 lba = ldq_be_p(&buf[2]);
1204 break;
1205 default:
1206 lba = -1;
1209 return lba;
1212 int scsi_req_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf)
1214 int rc;
1216 cmd->lba = -1;
1217 switch (buf[0] >> 5) {
1218 case 0:
1219 cmd->len = 6;
1220 break;
1221 case 1:
1222 case 2:
1223 cmd->len = 10;
1224 break;
1225 case 4:
1226 cmd->len = 16;
1227 break;
1228 case 5:
1229 cmd->len = 12;
1230 break;
1231 default:
1232 return -1;
1235 switch (dev->type) {
1236 case TYPE_TAPE:
1237 rc = scsi_req_stream_length(cmd, dev, buf);
1238 break;
1239 case TYPE_MEDIUM_CHANGER:
1240 rc = scsi_req_medium_changer_length(cmd, dev, buf);
1241 break;
1242 default:
1243 rc = scsi_req_length(cmd, dev, buf);
1244 break;
1247 if (rc != 0)
1248 return rc;
1250 memcpy(cmd->buf, buf, cmd->len);
1251 scsi_cmd_xfer_mode(cmd);
1252 cmd->lba = scsi_cmd_lba(cmd);
1253 return 0;
1256 void scsi_device_report_change(SCSIDevice *dev, SCSISense sense)
1258 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
1260 scsi_device_set_ua(dev, sense);
1261 if (bus->info->change) {
1262 bus->info->change(bus, dev, sense);
1267 * Predefined sense codes
1270 /* No sense data available */
1271 const struct SCSISense sense_code_NO_SENSE = {
1272 .key = NO_SENSE , .asc = 0x00 , .ascq = 0x00
1275 /* LUN not ready, Manual intervention required */
1276 const struct SCSISense sense_code_LUN_NOT_READY = {
1277 .key = NOT_READY, .asc = 0x04, .ascq = 0x03
1280 /* LUN not ready, Medium not present */
1281 const struct SCSISense sense_code_NO_MEDIUM = {
1282 .key = NOT_READY, .asc = 0x3a, .ascq = 0x00
1285 /* LUN not ready, medium removal prevented */
1286 const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED = {
1287 .key = NOT_READY, .asc = 0x53, .ascq = 0x02
1290 /* Hardware error, internal target failure */
1291 const struct SCSISense sense_code_TARGET_FAILURE = {
1292 .key = HARDWARE_ERROR, .asc = 0x44, .ascq = 0x00
1295 /* Illegal request, invalid command operation code */
1296 const struct SCSISense sense_code_INVALID_OPCODE = {
1297 .key = ILLEGAL_REQUEST, .asc = 0x20, .ascq = 0x00
1300 /* Illegal request, LBA out of range */
1301 const struct SCSISense sense_code_LBA_OUT_OF_RANGE = {
1302 .key = ILLEGAL_REQUEST, .asc = 0x21, .ascq = 0x00
1305 /* Illegal request, Invalid field in CDB */
1306 const struct SCSISense sense_code_INVALID_FIELD = {
1307 .key = ILLEGAL_REQUEST, .asc = 0x24, .ascq = 0x00
1310 /* Illegal request, Invalid field in parameter list */
1311 const struct SCSISense sense_code_INVALID_PARAM = {
1312 .key = ILLEGAL_REQUEST, .asc = 0x26, .ascq = 0x00
1315 /* Illegal request, Parameter list length error */
1316 const struct SCSISense sense_code_INVALID_PARAM_LEN = {
1317 .key = ILLEGAL_REQUEST, .asc = 0x1a, .ascq = 0x00
1320 /* Illegal request, LUN not supported */
1321 const struct SCSISense sense_code_LUN_NOT_SUPPORTED = {
1322 .key = ILLEGAL_REQUEST, .asc = 0x25, .ascq = 0x00
1325 /* Illegal request, Saving parameters not supported */
1326 const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED = {
1327 .key = ILLEGAL_REQUEST, .asc = 0x39, .ascq = 0x00
1330 /* Illegal request, Incompatible medium installed */
1331 const struct SCSISense sense_code_INCOMPATIBLE_FORMAT = {
1332 .key = ILLEGAL_REQUEST, .asc = 0x30, .ascq = 0x00
1335 /* Illegal request, medium removal prevented */
1336 const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED = {
1337 .key = ILLEGAL_REQUEST, .asc = 0x53, .ascq = 0x02
1340 /* Illegal request, Invalid Transfer Tag */
1341 const struct SCSISense sense_code_INVALID_TAG = {
1342 .key = ILLEGAL_REQUEST, .asc = 0x4b, .ascq = 0x01
1345 /* Command aborted, I/O process terminated */
1346 const struct SCSISense sense_code_IO_ERROR = {
1347 .key = ABORTED_COMMAND, .asc = 0x00, .ascq = 0x06
1350 /* Command aborted, I_T Nexus loss occurred */
1351 const struct SCSISense sense_code_I_T_NEXUS_LOSS = {
1352 .key = ABORTED_COMMAND, .asc = 0x29, .ascq = 0x07
1355 /* Command aborted, Logical Unit failure */
1356 const struct SCSISense sense_code_LUN_FAILURE = {
1357 .key = ABORTED_COMMAND, .asc = 0x3e, .ascq = 0x01
1360 /* Command aborted, Overlapped Commands Attempted */
1361 const struct SCSISense sense_code_OVERLAPPED_COMMANDS = {
1362 .key = ABORTED_COMMAND, .asc = 0x4e, .ascq = 0x00
1365 /* Unit attention, Capacity data has changed */
1366 const struct SCSISense sense_code_CAPACITY_CHANGED = {
1367 .key = UNIT_ATTENTION, .asc = 0x2a, .ascq = 0x09
1370 /* Unit attention, Power on, reset or bus device reset occurred */
1371 const struct SCSISense sense_code_RESET = {
1372 .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x00
1375 /* Unit attention, No medium */
1376 const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM = {
1377 .key = UNIT_ATTENTION, .asc = 0x3a, .ascq = 0x00
1380 /* Unit attention, Medium may have changed */
1381 const struct SCSISense sense_code_MEDIUM_CHANGED = {
1382 .key = UNIT_ATTENTION, .asc = 0x28, .ascq = 0x00
1385 /* Unit attention, Reported LUNs data has changed */
1386 const struct SCSISense sense_code_REPORTED_LUNS_CHANGED = {
1387 .key = UNIT_ATTENTION, .asc = 0x3f, .ascq = 0x0e
1390 /* Unit attention, Device internal reset */
1391 const struct SCSISense sense_code_DEVICE_INTERNAL_RESET = {
1392 .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x04
1395 /* Data Protection, Write Protected */
1396 const struct SCSISense sense_code_WRITE_PROTECTED = {
1397 .key = DATA_PROTECT, .asc = 0x27, .ascq = 0x00
1400 /* Data Protection, Space Allocation Failed Write Protect */
1401 const struct SCSISense sense_code_SPACE_ALLOC_FAILED = {
1402 .key = DATA_PROTECT, .asc = 0x27, .ascq = 0x07
1406 * scsi_build_sense
1408 * Convert between fixed and descriptor sense buffers
1410 int scsi_build_sense(uint8_t *in_buf, int in_len,
1411 uint8_t *buf, int len, bool fixed)
1413 bool fixed_in;
1414 SCSISense sense;
1415 if (!fixed && len < 8) {
1416 return 0;
1419 if (in_len == 0) {
1420 sense.key = NO_SENSE;
1421 sense.asc = 0;
1422 sense.ascq = 0;
1423 } else {
1424 fixed_in = (in_buf[0] & 2) == 0;
1426 if (fixed == fixed_in) {
1427 memcpy(buf, in_buf, MIN(len, in_len));
1428 return MIN(len, in_len);
1431 if (fixed_in) {
1432 sense.key = in_buf[2];
1433 sense.asc = in_buf[12];
1434 sense.ascq = in_buf[13];
1435 } else {
1436 sense.key = in_buf[1];
1437 sense.asc = in_buf[2];
1438 sense.ascq = in_buf[3];
1442 memset(buf, 0, len);
1443 if (fixed) {
1444 /* Return fixed format sense buffer */
1445 buf[0] = 0x70;
1446 buf[2] = sense.key;
1447 buf[7] = 10;
1448 buf[12] = sense.asc;
1449 buf[13] = sense.ascq;
1450 return MIN(len, SCSI_SENSE_LEN);
1451 } else {
1452 /* Return descriptor format sense buffer */
1453 buf[0] = 0x72;
1454 buf[1] = sense.key;
1455 buf[2] = sense.asc;
1456 buf[3] = sense.ascq;
1457 return 8;
1461 const char *scsi_command_name(uint8_t cmd)
1463 static const char *names[] = {
1464 [ TEST_UNIT_READY ] = "TEST_UNIT_READY",
1465 [ REWIND ] = "REWIND",
1466 [ REQUEST_SENSE ] = "REQUEST_SENSE",
1467 [ FORMAT_UNIT ] = "FORMAT_UNIT",
1468 [ READ_BLOCK_LIMITS ] = "READ_BLOCK_LIMITS",
1469 [ REASSIGN_BLOCKS ] = "REASSIGN_BLOCKS/INITIALIZE ELEMENT STATUS",
1470 /* LOAD_UNLOAD and INITIALIZE_ELEMENT_STATUS use the same operation code */
1471 [ READ_6 ] = "READ_6",
1472 [ WRITE_6 ] = "WRITE_6",
1473 [ SET_CAPACITY ] = "SET_CAPACITY",
1474 [ READ_REVERSE ] = "READ_REVERSE",
1475 [ WRITE_FILEMARKS ] = "WRITE_FILEMARKS",
1476 [ SPACE ] = "SPACE",
1477 [ INQUIRY ] = "INQUIRY",
1478 [ RECOVER_BUFFERED_DATA ] = "RECOVER_BUFFERED_DATA",
1479 [ MAINTENANCE_IN ] = "MAINTENANCE_IN",
1480 [ MAINTENANCE_OUT ] = "MAINTENANCE_OUT",
1481 [ MODE_SELECT ] = "MODE_SELECT",
1482 [ RESERVE ] = "RESERVE",
1483 [ RELEASE ] = "RELEASE",
1484 [ COPY ] = "COPY",
1485 [ ERASE ] = "ERASE",
1486 [ MODE_SENSE ] = "MODE_SENSE",
1487 [ START_STOP ] = "START_STOP/LOAD_UNLOAD",
1488 /* LOAD_UNLOAD and START_STOP use the same operation code */
1489 [ RECEIVE_DIAGNOSTIC ] = "RECEIVE_DIAGNOSTIC",
1490 [ SEND_DIAGNOSTIC ] = "SEND_DIAGNOSTIC",
1491 [ ALLOW_MEDIUM_REMOVAL ] = "ALLOW_MEDIUM_REMOVAL",
1492 [ READ_CAPACITY_10 ] = "READ_CAPACITY_10",
1493 [ READ_10 ] = "READ_10",
1494 [ WRITE_10 ] = "WRITE_10",
1495 [ SEEK_10 ] = "SEEK_10/POSITION_TO_ELEMENT",
1496 /* SEEK_10 and POSITION_TO_ELEMENT use the same operation code */
1497 [ WRITE_VERIFY_10 ] = "WRITE_VERIFY_10",
1498 [ VERIFY_10 ] = "VERIFY_10",
1499 [ SEARCH_HIGH ] = "SEARCH_HIGH",
1500 [ SEARCH_EQUAL ] = "SEARCH_EQUAL",
1501 [ SEARCH_LOW ] = "SEARCH_LOW",
1502 [ SET_LIMITS ] = "SET_LIMITS",
1503 [ PRE_FETCH ] = "PRE_FETCH/READ_POSITION",
1504 /* READ_POSITION and PRE_FETCH use the same operation code */
1505 [ SYNCHRONIZE_CACHE ] = "SYNCHRONIZE_CACHE",
1506 [ LOCK_UNLOCK_CACHE ] = "LOCK_UNLOCK_CACHE",
1507 [ READ_DEFECT_DATA ] = "READ_DEFECT_DATA/INITIALIZE_ELEMENT_STATUS_WITH_RANGE",
1508 /* READ_DEFECT_DATA and INITIALIZE_ELEMENT_STATUS_WITH_RANGE use the same operation code */
1509 [ MEDIUM_SCAN ] = "MEDIUM_SCAN",
1510 [ COMPARE ] = "COMPARE",
1511 [ COPY_VERIFY ] = "COPY_VERIFY",
1512 [ WRITE_BUFFER ] = "WRITE_BUFFER",
1513 [ READ_BUFFER ] = "READ_BUFFER",
1514 [ UPDATE_BLOCK ] = "UPDATE_BLOCK",
1515 [ READ_LONG_10 ] = "READ_LONG_10",
1516 [ WRITE_LONG_10 ] = "WRITE_LONG_10",
1517 [ CHANGE_DEFINITION ] = "CHANGE_DEFINITION",
1518 [ WRITE_SAME_10 ] = "WRITE_SAME_10",
1519 [ UNMAP ] = "UNMAP",
1520 [ READ_TOC ] = "READ_TOC",
1521 [ REPORT_DENSITY_SUPPORT ] = "REPORT_DENSITY_SUPPORT",
1522 [ SANITIZE ] = "SANITIZE",
1523 [ GET_CONFIGURATION ] = "GET_CONFIGURATION",
1524 [ LOG_SELECT ] = "LOG_SELECT",
1525 [ LOG_SENSE ] = "LOG_SENSE",
1526 [ MODE_SELECT_10 ] = "MODE_SELECT_10",
1527 [ RESERVE_10 ] = "RESERVE_10",
1528 [ RELEASE_10 ] = "RELEASE_10",
1529 [ MODE_SENSE_10 ] = "MODE_SENSE_10",
1530 [ PERSISTENT_RESERVE_IN ] = "PERSISTENT_RESERVE_IN",
1531 [ PERSISTENT_RESERVE_OUT ] = "PERSISTENT_RESERVE_OUT",
1532 [ WRITE_FILEMARKS_16 ] = "WRITE_FILEMARKS_16",
1533 [ EXTENDED_COPY ] = "EXTENDED_COPY",
1534 [ ATA_PASSTHROUGH_16 ] = "ATA_PASSTHROUGH_16",
1535 [ ACCESS_CONTROL_IN ] = "ACCESS_CONTROL_IN",
1536 [ ACCESS_CONTROL_OUT ] = "ACCESS_CONTROL_OUT",
1537 [ READ_16 ] = "READ_16",
1538 [ COMPARE_AND_WRITE ] = "COMPARE_AND_WRITE",
1539 [ WRITE_16 ] = "WRITE_16",
1540 [ WRITE_VERIFY_16 ] = "WRITE_VERIFY_16",
1541 [ VERIFY_16 ] = "VERIFY_16",
1542 [ PRE_FETCH_16 ] = "PRE_FETCH_16",
1543 [ SYNCHRONIZE_CACHE_16 ] = "SPACE_16/SYNCHRONIZE_CACHE_16",
1544 /* SPACE_16 and SYNCHRONIZE_CACHE_16 use the same operation code */
1545 [ LOCATE_16 ] = "LOCATE_16",
1546 [ WRITE_SAME_16 ] = "ERASE_16/WRITE_SAME_16",
1547 /* ERASE_16 and WRITE_SAME_16 use the same operation code */
1548 [ SERVICE_ACTION_IN_16 ] = "SERVICE_ACTION_IN_16",
1549 [ WRITE_LONG_16 ] = "WRITE_LONG_16",
1550 [ REPORT_LUNS ] = "REPORT_LUNS",
1551 [ ATA_PASSTHROUGH_12 ] = "BLANK/ATA_PASSTHROUGH_12",
1552 [ MOVE_MEDIUM ] = "MOVE_MEDIUM",
1553 [ EXCHANGE_MEDIUM ] = "EXCHANGE MEDIUM",
1554 [ READ_12 ] = "READ_12",
1555 [ WRITE_12 ] = "WRITE_12",
1556 [ ERASE_12 ] = "ERASE_12/GET_PERFORMANCE",
1557 /* ERASE_12 and GET_PERFORMANCE use the same operation code */
1558 [ SERVICE_ACTION_IN_12 ] = "SERVICE_ACTION_IN_12",
1559 [ WRITE_VERIFY_12 ] = "WRITE_VERIFY_12",
1560 [ VERIFY_12 ] = "VERIFY_12",
1561 [ SEARCH_HIGH_12 ] = "SEARCH_HIGH_12",
1562 [ SEARCH_EQUAL_12 ] = "SEARCH_EQUAL_12",
1563 [ SEARCH_LOW_12 ] = "SEARCH_LOW_12",
1564 [ READ_ELEMENT_STATUS ] = "READ_ELEMENT_STATUS",
1565 [ SEND_VOLUME_TAG ] = "SEND_VOLUME_TAG/SET_STREAMING",
1566 /* SEND_VOLUME_TAG and SET_STREAMING use the same operation code */
1567 [ READ_CD ] = "READ_CD",
1568 [ READ_DEFECT_DATA_12 ] = "READ_DEFECT_DATA_12",
1569 [ READ_DVD_STRUCTURE ] = "READ_DVD_STRUCTURE",
1570 [ RESERVE_TRACK ] = "RESERVE_TRACK",
1571 [ SEND_CUE_SHEET ] = "SEND_CUE_SHEET",
1572 [ SEND_DVD_STRUCTURE ] = "SEND_DVD_STRUCTURE",
1573 [ SET_CD_SPEED ] = "SET_CD_SPEED",
1574 [ SET_READ_AHEAD ] = "SET_READ_AHEAD",
1575 [ ALLOW_OVERWRITE ] = "ALLOW_OVERWRITE",
1576 [ MECHANISM_STATUS ] = "MECHANISM_STATUS",
1577 [ GET_EVENT_STATUS_NOTIFICATION ] = "GET_EVENT_STATUS_NOTIFICATION",
1578 [ READ_DISC_INFORMATION ] = "READ_DISC_INFORMATION",
1581 if (cmd >= ARRAY_SIZE(names) || names[cmd] == NULL)
1582 return "*UNKNOWN*";
1583 return names[cmd];
1586 SCSIRequest *scsi_req_ref(SCSIRequest *req)
1588 assert(req->refcount > 0);
1589 req->refcount++;
1590 return req;
1593 void scsi_req_unref(SCSIRequest *req)
1595 assert(req->refcount > 0);
1596 if (--req->refcount == 0) {
1597 BusState *qbus = req->dev->qdev.parent_bus;
1598 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, qbus);
1600 if (bus->info->free_request && req->hba_private) {
1601 bus->info->free_request(bus, req->hba_private);
1603 if (req->ops->free_req) {
1604 req->ops->free_req(req);
1606 object_unref(OBJECT(req->dev));
1607 object_unref(OBJECT(qbus->parent));
1608 g_slice_free1(req->ops->size, req);
1612 /* Tell the device that we finished processing this chunk of I/O. It
1613 will start the next chunk or complete the command. */
1614 void scsi_req_continue(SCSIRequest *req)
1616 if (req->io_canceled) {
1617 trace_scsi_req_continue_canceled(req->dev->id, req->lun, req->tag);
1618 return;
1620 trace_scsi_req_continue(req->dev->id, req->lun, req->tag);
1621 if (req->cmd.mode == SCSI_XFER_TO_DEV) {
1622 req->ops->write_data(req);
1623 } else {
1624 req->ops->read_data(req);
1628 /* Called by the devices when data is ready for the HBA. The HBA should
1629 start a DMA operation to read or fill the device's data buffer.
1630 Once it completes, calling scsi_req_continue will restart I/O. */
1631 void scsi_req_data(SCSIRequest *req, int len)
1633 uint8_t *buf;
1634 if (req->io_canceled) {
1635 trace_scsi_req_data_canceled(req->dev->id, req->lun, req->tag, len);
1636 return;
1638 trace_scsi_req_data(req->dev->id, req->lun, req->tag, len);
1639 assert(req->cmd.mode != SCSI_XFER_NONE);
1640 if (!req->sg) {
1641 req->resid -= len;
1642 req->bus->info->transfer_data(req, len);
1643 return;
1646 /* If the device calls scsi_req_data and the HBA specified a
1647 * scatter/gather list, the transfer has to happen in a single
1648 * step. */
1649 assert(!req->dma_started);
1650 req->dma_started = true;
1652 buf = scsi_req_get_buf(req);
1653 if (req->cmd.mode == SCSI_XFER_FROM_DEV) {
1654 req->resid = dma_buf_read(buf, len, req->sg);
1655 } else {
1656 req->resid = dma_buf_write(buf, len, req->sg);
1658 scsi_req_continue(req);
1661 void scsi_req_print(SCSIRequest *req)
1663 FILE *fp = stderr;
1664 int i;
1666 fprintf(fp, "[%s id=%d] %s",
1667 req->dev->qdev.parent_bus->name,
1668 req->dev->id,
1669 scsi_command_name(req->cmd.buf[0]));
1670 for (i = 1; i < req->cmd.len; i++) {
1671 fprintf(fp, " 0x%02x", req->cmd.buf[i]);
1673 switch (req->cmd.mode) {
1674 case SCSI_XFER_NONE:
1675 fprintf(fp, " - none\n");
1676 break;
1677 case SCSI_XFER_FROM_DEV:
1678 fprintf(fp, " - from-dev len=%zd\n", req->cmd.xfer);
1679 break;
1680 case SCSI_XFER_TO_DEV:
1681 fprintf(fp, " - to-dev len=%zd\n", req->cmd.xfer);
1682 break;
1683 default:
1684 fprintf(fp, " - Oops\n");
1685 break;
1689 void scsi_req_complete(SCSIRequest *req, int status)
1691 assert(req->status == -1);
1692 req->status = status;
1694 assert(req->sense_len <= sizeof(req->sense));
1695 if (status == GOOD) {
1696 req->sense_len = 0;
1699 if (req->sense_len) {
1700 memcpy(req->dev->sense, req->sense, req->sense_len);
1701 req->dev->sense_len = req->sense_len;
1702 req->dev->sense_is_ua = (req->ops == &reqops_unit_attention);
1703 } else {
1704 req->dev->sense_len = 0;
1705 req->dev->sense_is_ua = false;
1709 * Unit attention state is now stored in the device's sense buffer
1710 * if the HBA didn't do autosense. Clear the pending unit attention
1711 * flags.
1713 scsi_clear_unit_attention(req);
1715 scsi_req_ref(req);
1716 scsi_req_dequeue(req);
1717 req->bus->info->complete(req, req->status, req->resid);
1718 scsi_req_unref(req);
1721 void scsi_req_cancel(SCSIRequest *req)
1723 trace_scsi_req_cancel(req->dev->id, req->lun, req->tag);
1724 if (!req->enqueued) {
1725 return;
1727 scsi_req_ref(req);
1728 scsi_req_dequeue(req);
1729 req->io_canceled = true;
1730 if (req->aiocb) {
1731 bdrv_aio_cancel(req->aiocb);
1733 if (req->bus->info->cancel) {
1734 req->bus->info->cancel(req);
1736 scsi_req_unref(req);
1739 static int scsi_ua_precedence(SCSISense sense)
1741 if (sense.key != UNIT_ATTENTION) {
1742 return INT_MAX;
1744 if (sense.asc == 0x29 && sense.ascq == 0x04) {
1745 /* DEVICE INTERNAL RESET goes with POWER ON OCCURRED */
1746 return 1;
1747 } else if (sense.asc == 0x3F && sense.ascq == 0x01) {
1748 /* MICROCODE HAS BEEN CHANGED goes with SCSI BUS RESET OCCURRED */
1749 return 2;
1750 } else if (sense.asc == 0x29 && (sense.ascq == 0x05 || sense.ascq == 0x06)) {
1751 /* These two go with "all others". */
1753 } else if (sense.asc == 0x29 && sense.ascq <= 0x07) {
1754 /* POWER ON, RESET OR BUS DEVICE RESET OCCURRED = 0
1755 * POWER ON OCCURRED = 1
1756 * SCSI BUS RESET OCCURRED = 2
1757 * BUS DEVICE RESET FUNCTION OCCURRED = 3
1758 * I_T NEXUS LOSS OCCURRED = 7
1760 return sense.ascq;
1761 } else if (sense.asc == 0x2F && sense.ascq == 0x01) {
1762 /* COMMANDS CLEARED BY POWER LOSS NOTIFICATION */
1763 return 8;
1765 return (sense.asc << 8) | sense.ascq;
1768 void scsi_device_set_ua(SCSIDevice *sdev, SCSISense sense)
1770 int prec1, prec2;
1771 if (sense.key != UNIT_ATTENTION) {
1772 return;
1774 trace_scsi_device_set_ua(sdev->id, sdev->lun, sense.key,
1775 sense.asc, sense.ascq);
1778 * Override a pre-existing unit attention condition, except for a more
1779 * important reset condition.
1781 prec1 = scsi_ua_precedence(sdev->unit_attention);
1782 prec2 = scsi_ua_precedence(sense);
1783 if (prec2 < prec1) {
1784 sdev->unit_attention = sense;
1788 void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense)
1790 SCSIRequest *req;
1792 while (!QTAILQ_EMPTY(&sdev->requests)) {
1793 req = QTAILQ_FIRST(&sdev->requests);
1794 scsi_req_cancel(req);
1797 scsi_device_set_ua(sdev, sense);
1800 static char *scsibus_get_dev_path(DeviceState *dev)
1802 SCSIDevice *d = DO_UPCAST(SCSIDevice, qdev, dev);
1803 DeviceState *hba = dev->parent_bus->parent;
1804 char *id;
1805 char *path;
1807 id = qdev_get_dev_path(hba);
1808 if (id) {
1809 path = g_strdup_printf("%s/%d:%d:%d", id, d->channel, d->id, d->lun);
1810 } else {
1811 path = g_strdup_printf("%d:%d:%d", d->channel, d->id, d->lun);
1813 g_free(id);
1814 return path;
1817 static char *scsibus_get_fw_dev_path(DeviceState *dev)
1819 SCSIDevice *d = SCSI_DEVICE(dev);
1820 return g_strdup_printf("channel@%x/%s@%x,%x", d->channel,
1821 qdev_fw_name(dev), d->id, d->lun);
1824 SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int id, int lun)
1826 BusChild *kid;
1827 SCSIDevice *target_dev = NULL;
1829 QTAILQ_FOREACH_REVERSE(kid, &bus->qbus.children, ChildrenHead, sibling) {
1830 DeviceState *qdev = kid->child;
1831 SCSIDevice *dev = SCSI_DEVICE(qdev);
1833 if (dev->channel == channel && dev->id == id) {
1834 if (dev->lun == lun) {
1835 return dev;
1837 target_dev = dev;
1840 return target_dev;
1843 /* SCSI request list. For simplicity, pv points to the whole device */
1845 static void put_scsi_requests(QEMUFile *f, void *pv, size_t size)
1847 SCSIDevice *s = pv;
1848 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, s->qdev.parent_bus);
1849 SCSIRequest *req;
1851 QTAILQ_FOREACH(req, &s->requests, next) {
1852 assert(!req->io_canceled);
1853 assert(req->status == -1);
1854 assert(req->enqueued);
1856 qemu_put_sbyte(f, req->retry ? 1 : 2);
1857 qemu_put_buffer(f, req->cmd.buf, sizeof(req->cmd.buf));
1858 qemu_put_be32s(f, &req->tag);
1859 qemu_put_be32s(f, &req->lun);
1860 if (bus->info->save_request) {
1861 bus->info->save_request(f, req);
1863 if (req->ops->save_request) {
1864 req->ops->save_request(f, req);
1867 qemu_put_sbyte(f, 0);
1870 static int get_scsi_requests(QEMUFile *f, void *pv, size_t size)
1872 SCSIDevice *s = pv;
1873 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, s->qdev.parent_bus);
1874 int8_t sbyte;
1876 while ((sbyte = qemu_get_sbyte(f)) > 0) {
1877 uint8_t buf[SCSI_CMD_BUF_SIZE];
1878 uint32_t tag;
1879 uint32_t lun;
1880 SCSIRequest *req;
1882 qemu_get_buffer(f, buf, sizeof(buf));
1883 qemu_get_be32s(f, &tag);
1884 qemu_get_be32s(f, &lun);
1885 req = scsi_req_new(s, tag, lun, buf, NULL);
1886 req->retry = (sbyte == 1);
1887 if (bus->info->load_request) {
1888 req->hba_private = bus->info->load_request(f, req);
1890 if (req->ops->load_request) {
1891 req->ops->load_request(f, req);
1894 /* Just restart it later. */
1895 scsi_req_enqueue_internal(req);
1897 /* At this point, the request will be kept alive by the reference
1898 * added by scsi_req_enqueue_internal, so we can release our reference.
1899 * The HBA of course will add its own reference in the load_request
1900 * callback if it needs to hold on the SCSIRequest.
1902 scsi_req_unref(req);
1905 return 0;
1908 static int scsi_qdev_unplug(DeviceState *qdev)
1910 SCSIDevice *dev = SCSI_DEVICE(qdev);
1911 SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
1913 if (bus->info->hot_unplug) {
1914 bus->info->hot_unplug(bus, dev);
1916 return qdev_simple_unplug_cb(qdev);
1919 static const VMStateInfo vmstate_info_scsi_requests = {
1920 .name = "scsi-requests",
1921 .get = get_scsi_requests,
1922 .put = put_scsi_requests,
1925 static bool scsi_sense_state_needed(void *opaque)
1927 SCSIDevice *s = opaque;
1929 return s->sense_len > SCSI_SENSE_BUF_SIZE_OLD;
1932 static const VMStateDescription vmstate_scsi_sense_state = {
1933 .name = "SCSIDevice/sense",
1934 .version_id = 1,
1935 .minimum_version_id = 1,
1936 .fields = (VMStateField[]) {
1937 VMSTATE_UINT8_SUB_ARRAY(sense, SCSIDevice,
1938 SCSI_SENSE_BUF_SIZE_OLD,
1939 SCSI_SENSE_BUF_SIZE - SCSI_SENSE_BUF_SIZE_OLD),
1940 VMSTATE_END_OF_LIST()
1944 const VMStateDescription vmstate_scsi_device = {
1945 .name = "SCSIDevice",
1946 .version_id = 1,
1947 .minimum_version_id = 1,
1948 .fields = (VMStateField[]) {
1949 VMSTATE_UINT8(unit_attention.key, SCSIDevice),
1950 VMSTATE_UINT8(unit_attention.asc, SCSIDevice),
1951 VMSTATE_UINT8(unit_attention.ascq, SCSIDevice),
1952 VMSTATE_BOOL(sense_is_ua, SCSIDevice),
1953 VMSTATE_UINT8_SUB_ARRAY(sense, SCSIDevice, 0, SCSI_SENSE_BUF_SIZE_OLD),
1954 VMSTATE_UINT32(sense_len, SCSIDevice),
1956 .name = "requests",
1957 .version_id = 0,
1958 .field_exists = NULL,
1959 .size = 0, /* ouch */
1960 .info = &vmstate_info_scsi_requests,
1961 .flags = VMS_SINGLE,
1962 .offset = 0,
1964 VMSTATE_END_OF_LIST()
1966 .subsections = (VMStateSubsection []) {
1968 .vmsd = &vmstate_scsi_sense_state,
1969 .needed = scsi_sense_state_needed,
1970 }, {
1971 /* empty */
1976 static void scsi_device_class_init(ObjectClass *klass, void *data)
1978 DeviceClass *k = DEVICE_CLASS(klass);
1979 set_bit(DEVICE_CATEGORY_STORAGE, k->categories);
1980 k->bus_type = TYPE_SCSI_BUS;
1981 k->realize = scsi_qdev_realize;
1982 k->unplug = scsi_qdev_unplug;
1983 k->unrealize = scsi_qdev_unrealize;
1984 k->props = scsi_props;
1987 static const TypeInfo scsi_device_type_info = {
1988 .name = TYPE_SCSI_DEVICE,
1989 .parent = TYPE_DEVICE,
1990 .instance_size = sizeof(SCSIDevice),
1991 .abstract = true,
1992 .class_size = sizeof(SCSIDeviceClass),
1993 .class_init = scsi_device_class_init,
1996 static void scsi_register_types(void)
1998 type_register_static(&scsi_bus_info);
1999 type_register_static(&scsi_device_type_info);
2002 type_init(scsi_register_types)