]> Git Repo - qemu.git/blob - hw/scsi-bus.c
net: reorganize headers
[qemu.git] / hw / scsi-bus.c
1 #include "hw.h"
2 #include "qemu-error.h"
3 #include "scsi.h"
4 #include "scsi-defs.h"
5 #include "qdev.h"
6 #include "blockdev.h"
7 #include "trace.h"
8 #include "dma.h"
9
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);
14
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(),
20 };
21
22 static void scsi_bus_class_init(ObjectClass *klass, void *data)
23 {
24     BusClass *k = BUS_CLASS(klass);
25
26     k->get_dev_path = scsibus_get_dev_path;
27     k->get_fw_dev_path = scsibus_get_fw_dev_path;
28 }
29
30 static const TypeInfo scsi_bus_info = {
31     .name = TYPE_SCSI_BUS,
32     .parent = TYPE_BUS,
33     .instance_size = sizeof(SCSIBus),
34     .class_init = scsi_bus_class_init,
35 };
36 static int next_scsi_bus;
37
38 static int scsi_device_init(SCSIDevice *s)
39 {
40     SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
41     if (sc->init) {
42         return sc->init(s);
43     }
44     return 0;
45 }
46
47 static void scsi_device_destroy(SCSIDevice *s)
48 {
49     SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
50     if (sc->destroy) {
51         sc->destroy(s);
52     }
53 }
54
55 static SCSIRequest *scsi_device_alloc_req(SCSIDevice *s, uint32_t tag, uint32_t lun,
56                                           uint8_t *buf, void *hba_private)
57 {
58     SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
59     if (sc->alloc_req) {
60         return sc->alloc_req(s, tag, lun, buf, hba_private);
61     }
62
63     return NULL;
64 }
65
66 static void scsi_device_unit_attention_reported(SCSIDevice *s)
67 {
68     SCSIDeviceClass *sc = SCSI_DEVICE_GET_CLASS(s);
69     if (sc->unit_attention_reported) {
70         sc->unit_attention_reported(s);
71     }
72 }
73
74 /* Create a scsi bus, and attach devices to it.  */
75 void scsi_bus_new(SCSIBus *bus, DeviceState *host, const SCSIBusInfo *info)
76 {
77     qbus_create_inplace(&bus->qbus, TYPE_SCSI_BUS, host, NULL);
78     bus->busnr = next_scsi_bus++;
79     bus->info = info;
80     bus->qbus.allow_hotplug = 1;
81 }
82
83 static void scsi_dma_restart_bh(void *opaque)
84 {
85     SCSIDevice *s = opaque;
86     SCSIRequest *req, *next;
87
88     qemu_bh_delete(s->bh);
89     s->bh = NULL;
90
91     QTAILQ_FOREACH_SAFE(req, &s->requests, next, next) {
92         scsi_req_ref(req);
93         if (req->retry) {
94             req->retry = false;
95             switch (req->cmd.mode) {
96             case SCSI_XFER_FROM_DEV:
97             case SCSI_XFER_TO_DEV:
98                 scsi_req_continue(req);
99                 break;
100             case SCSI_XFER_NONE:
101                 assert(!req->sg);
102                 scsi_req_dequeue(req);
103                 scsi_req_enqueue(req);
104                 break;
105             }
106         }
107         scsi_req_unref(req);
108     }
109 }
110
111 void scsi_req_retry(SCSIRequest *req)
112 {
113     /* No need to save a reference, because scsi_dma_restart_bh just
114      * looks at the request list.  */
115     req->retry = true;
116 }
117
118 static void scsi_dma_restart_cb(void *opaque, int running, RunState state)
119 {
120     SCSIDevice *s = opaque;
121
122     if (!running) {
123         return;
124     }
125     if (!s->bh) {
126         s->bh = qemu_bh_new(scsi_dma_restart_bh, s);
127         qemu_bh_schedule(s->bh);
128     }
129 }
130
131 static int scsi_qdev_init(DeviceState *qdev)
132 {
133     SCSIDevice *dev = SCSI_DEVICE(qdev);
134     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
135     SCSIDevice *d;
136     int rc = -1;
137
138     if (dev->channel > bus->info->max_channel) {
139         error_report("bad scsi channel id: %d", dev->channel);
140         goto err;
141     }
142     if (dev->id != -1 && dev->id > bus->info->max_target) {
143         error_report("bad scsi device id: %d", dev->id);
144         goto err;
145     }
146     if (dev->lun != -1 && dev->lun > bus->info->max_lun) {
147         error_report("bad scsi device lun: %d", dev->lun);
148         goto err;
149     }
150
151     if (dev->id == -1) {
152         int id = -1;
153         if (dev->lun == -1) {
154             dev->lun = 0;
155         }
156         do {
157             d = scsi_device_find(bus, dev->channel, ++id, dev->lun);
158         } while (d && d->lun == dev->lun && id < bus->info->max_target);
159         if (d && d->lun == dev->lun) {
160             error_report("no free target");
161             goto err;
162         }
163         dev->id = id;
164     } else if (dev->lun == -1) {
165         int lun = -1;
166         do {
167             d = scsi_device_find(bus, dev->channel, dev->id, ++lun);
168         } while (d && d->lun == lun && lun < bus->info->max_lun);
169         if (d && d->lun == lun) {
170             error_report("no free lun");
171             goto err;
172         }
173         dev->lun = lun;
174     } else {
175         d = scsi_device_find(bus, dev->channel, dev->id, dev->lun);
176         assert(d);
177         if (d->lun == dev->lun && dev != d) {
178             qdev_free(&d->qdev);
179         }
180     }
181
182     QTAILQ_INIT(&dev->requests);
183     rc = scsi_device_init(dev);
184     if (rc == 0) {
185         dev->vmsentry = qemu_add_vm_change_state_handler(scsi_dma_restart_cb,
186                                                          dev);
187     }
188
189     if (bus->info->hotplug) {
190         bus->info->hotplug(bus, dev);
191     }
192
193 err:
194     return rc;
195 }
196
197 static int scsi_qdev_exit(DeviceState *qdev)
198 {
199     SCSIDevice *dev = SCSI_DEVICE(qdev);
200
201     if (dev->vmsentry) {
202         qemu_del_vm_change_state_handler(dev->vmsentry);
203     }
204     scsi_device_destroy(dev);
205     return 0;
206 }
207
208 /* handle legacy '-drive if=scsi,...' cmd line args */
209 SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockDriverState *bdrv,
210                                       int unit, bool removable, int bootindex)
211 {
212     const char *driver;
213     DeviceState *dev;
214
215     driver = bdrv_is_sg(bdrv) ? "scsi-generic" : "scsi-disk";
216     dev = qdev_create(&bus->qbus, driver);
217     qdev_prop_set_uint32(dev, "scsi-id", unit);
218     if (bootindex >= 0) {
219         qdev_prop_set_int32(dev, "bootindex", bootindex);
220     }
221     if (object_property_find(OBJECT(dev), "removable", NULL)) {
222         qdev_prop_set_bit(dev, "removable", removable);
223     }
224     if (qdev_prop_set_drive(dev, "drive", bdrv) < 0) {
225         qdev_free(dev);
226         return NULL;
227     }
228     if (qdev_init(dev) < 0)
229         return NULL;
230     return SCSI_DEVICE(dev);
231 }
232
233 int scsi_bus_legacy_handle_cmdline(SCSIBus *bus)
234 {
235     Location loc;
236     DriveInfo *dinfo;
237     int res = 0, unit;
238
239     loc_push_none(&loc);
240     for (unit = 0; unit <= bus->info->max_target; unit++) {
241         dinfo = drive_get(IF_SCSI, bus->busnr, unit);
242         if (dinfo == NULL) {
243             continue;
244         }
245         qemu_opts_loc_restore(dinfo->opts);
246         if (!scsi_bus_legacy_add_drive(bus, dinfo->bdrv, unit, false, -1)) {
247             res = -1;
248             break;
249         }
250     }
251     loc_pop(&loc);
252     return res;
253 }
254
255 static int32_t scsi_invalid_field(SCSIRequest *req, uint8_t *buf)
256 {
257     scsi_req_build_sense(req, SENSE_CODE(INVALID_FIELD));
258     scsi_req_complete(req, CHECK_CONDITION);
259     return 0;
260 }
261
262 static const struct SCSIReqOps reqops_invalid_field = {
263     .size         = sizeof(SCSIRequest),
264     .send_command = scsi_invalid_field
265 };
266
267 /* SCSIReqOps implementation for invalid commands.  */
268
269 static int32_t scsi_invalid_command(SCSIRequest *req, uint8_t *buf)
270 {
271     scsi_req_build_sense(req, SENSE_CODE(INVALID_OPCODE));
272     scsi_req_complete(req, CHECK_CONDITION);
273     return 0;
274 }
275
276 static const struct SCSIReqOps reqops_invalid_opcode = {
277     .size         = sizeof(SCSIRequest),
278     .send_command = scsi_invalid_command
279 };
280
281 /* SCSIReqOps implementation for unit attention conditions.  */
282
283 static int32_t scsi_unit_attention(SCSIRequest *req, uint8_t *buf)
284 {
285     if (req->dev && req->dev->unit_attention.key == UNIT_ATTENTION) {
286         scsi_req_build_sense(req, req->dev->unit_attention);
287     } else if (req->bus->unit_attention.key == UNIT_ATTENTION) {
288         scsi_req_build_sense(req, req->bus->unit_attention);
289     }
290     scsi_req_complete(req, CHECK_CONDITION);
291     return 0;
292 }
293
294 static const struct SCSIReqOps reqops_unit_attention = {
295     .size         = sizeof(SCSIRequest),
296     .send_command = scsi_unit_attention
297 };
298
299 /* SCSIReqOps implementation for REPORT LUNS and for commands sent to
300    an invalid LUN.  */
301
302 typedef struct SCSITargetReq SCSITargetReq;
303
304 struct SCSITargetReq {
305     SCSIRequest req;
306     int len;
307     uint8_t buf[2056];
308 };
309
310 static void store_lun(uint8_t *outbuf, int lun)
311 {
312     if (lun < 256) {
313         outbuf[1] = lun;
314         return;
315     }
316     outbuf[1] = (lun & 255);
317     outbuf[0] = (lun >> 8) | 0x40;
318 }
319
320 static bool scsi_target_emulate_report_luns(SCSITargetReq *r)
321 {
322     BusChild *kid;
323     int i, len, n;
324     int channel, id;
325     bool found_lun0;
326
327     if (r->req.cmd.xfer < 16) {
328         return false;
329     }
330     if (r->req.cmd.buf[2] > 2) {
331         return false;
332     }
333     channel = r->req.dev->channel;
334     id = r->req.dev->id;
335     found_lun0 = false;
336     n = 0;
337     QTAILQ_FOREACH(kid, &r->req.bus->qbus.children, sibling) {
338         DeviceState *qdev = kid->child;
339         SCSIDevice *dev = SCSI_DEVICE(qdev);
340
341         if (dev->channel == channel && dev->id == id) {
342             if (dev->lun == 0) {
343                 found_lun0 = true;
344             }
345             n += 8;
346         }
347     }
348     if (!found_lun0) {
349         n += 8;
350     }
351     len = MIN(n + 8, r->req.cmd.xfer & ~7);
352     if (len > sizeof(r->buf)) {
353         /* TODO: > 256 LUNs? */
354         return false;
355     }
356
357     memset(r->buf, 0, len);
358     stl_be_p(&r->buf, n);
359     i = found_lun0 ? 8 : 16;
360     QTAILQ_FOREACH(kid, &r->req.bus->qbus.children, sibling) {
361         DeviceState *qdev = kid->child;
362         SCSIDevice *dev = SCSI_DEVICE(qdev);
363
364         if (dev->channel == channel && dev->id == id) {
365             store_lun(&r->buf[i], dev->lun);
366             i += 8;
367         }
368     }
369     assert(i == n + 8);
370     r->len = len;
371     return true;
372 }
373
374 static bool scsi_target_emulate_inquiry(SCSITargetReq *r)
375 {
376     assert(r->req.dev->lun != r->req.lun);
377     if (r->req.cmd.buf[1] & 0x2) {
378         /* Command support data - optional, not implemented */
379         return false;
380     }
381
382     if (r->req.cmd.buf[1] & 0x1) {
383         /* Vital product data */
384         uint8_t page_code = r->req.cmd.buf[2];
385         r->buf[r->len++] = page_code ; /* this page */
386         r->buf[r->len++] = 0x00;
387
388         switch (page_code) {
389         case 0x00: /* Supported page codes, mandatory */
390         {
391             int pages;
392             pages = r->len++;
393             r->buf[r->len++] = 0x00; /* list of supported pages (this page) */
394             r->buf[pages] = r->len - pages - 1; /* number of pages */
395             break;
396         }
397         default:
398             return false;
399         }
400         /* done with EVPD */
401         assert(r->len < sizeof(r->buf));
402         r->len = MIN(r->req.cmd.xfer, r->len);
403         return true;
404     }
405
406     /* Standard INQUIRY data */
407     if (r->req.cmd.buf[2] != 0) {
408         return false;
409     }
410
411     /* PAGE CODE == 0 */
412     r->len = MIN(r->req.cmd.xfer, 36);
413     memset(r->buf, 0, r->len);
414     if (r->req.lun != 0) {
415         r->buf[0] = TYPE_NO_LUN;
416     } else {
417         r->buf[0] = TYPE_NOT_PRESENT | TYPE_INACTIVE;
418         r->buf[2] = 5; /* Version */
419         r->buf[3] = 2 | 0x10; /* HiSup, response data format */
420         r->buf[4] = r->len - 5; /* Additional Length = (Len - 1) - 4 */
421         r->buf[7] = 0x10 | (r->req.bus->info->tcq ? 0x02 : 0); /* Sync, TCQ.  */
422         memcpy(&r->buf[8], "QEMU    ", 8);
423         memcpy(&r->buf[16], "QEMU TARGET     ", 16);
424         pstrcpy((char *) &r->buf[32], 4, qemu_get_version());
425     }
426     return true;
427 }
428
429 static int32_t scsi_target_send_command(SCSIRequest *req, uint8_t *buf)
430 {
431     SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
432
433     switch (buf[0]) {
434     case REPORT_LUNS:
435         if (!scsi_target_emulate_report_luns(r)) {
436             goto illegal_request;
437         }
438         break;
439     case INQUIRY:
440         if (!scsi_target_emulate_inquiry(r)) {
441             goto illegal_request;
442         }
443         break;
444     case REQUEST_SENSE:
445         r->len = scsi_device_get_sense(r->req.dev, r->buf,
446                                        MIN(req->cmd.xfer, sizeof r->buf),
447                                        (req->cmd.buf[1] & 1) == 0);
448         if (r->req.dev->sense_is_ua) {
449             scsi_device_unit_attention_reported(req->dev);
450             r->req.dev->sense_len = 0;
451             r->req.dev->sense_is_ua = false;
452         }
453         break;
454     default:
455         scsi_req_build_sense(req, SENSE_CODE(LUN_NOT_SUPPORTED));
456         scsi_req_complete(req, CHECK_CONDITION);
457         return 0;
458     illegal_request:
459         scsi_req_build_sense(req, SENSE_CODE(INVALID_FIELD));
460         scsi_req_complete(req, CHECK_CONDITION);
461         return 0;
462     }
463
464     if (!r->len) {
465         scsi_req_complete(req, GOOD);
466     }
467     return r->len;
468 }
469
470 static void scsi_target_read_data(SCSIRequest *req)
471 {
472     SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
473     uint32_t n;
474
475     n = r->len;
476     if (n > 0) {
477         r->len = 0;
478         scsi_req_data(&r->req, n);
479     } else {
480         scsi_req_complete(&r->req, GOOD);
481     }
482 }
483
484 static uint8_t *scsi_target_get_buf(SCSIRequest *req)
485 {
486     SCSITargetReq *r = DO_UPCAST(SCSITargetReq, req, req);
487
488     return r->buf;
489 }
490
491 static const struct SCSIReqOps reqops_target_command = {
492     .size         = sizeof(SCSITargetReq),
493     .send_command = scsi_target_send_command,
494     .read_data    = scsi_target_read_data,
495     .get_buf      = scsi_target_get_buf,
496 };
497
498
499 SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d,
500                             uint32_t tag, uint32_t lun, void *hba_private)
501 {
502     SCSIRequest *req;
503
504     req = g_malloc0(reqops->size);
505     req->refcount = 1;
506     req->bus = scsi_bus_from_device(d);
507     req->dev = d;
508     req->tag = tag;
509     req->lun = lun;
510     req->hba_private = hba_private;
511     req->status = -1;
512     req->sense_len = 0;
513     req->ops = reqops;
514     trace_scsi_req_alloc(req->dev->id, req->lun, req->tag);
515     return req;
516 }
517
518 SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun,
519                           uint8_t *buf, void *hba_private)
520 {
521     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
522     SCSIRequest *req;
523     SCSICommand cmd;
524
525     if (scsi_req_parse(&cmd, d, buf) != 0) {
526         trace_scsi_req_parse_bad(d->id, lun, tag, buf[0]);
527         req = scsi_req_alloc(&reqops_invalid_opcode, d, tag, lun, hba_private);
528     } else {
529         trace_scsi_req_parsed(d->id, lun, tag, buf[0],
530                               cmd.mode, cmd.xfer);
531         if (cmd.lba != -1) {
532             trace_scsi_req_parsed_lba(d->id, lun, tag, buf[0],
533                                       cmd.lba);
534         }
535
536         if (cmd.xfer > INT32_MAX) {
537             req = scsi_req_alloc(&reqops_invalid_field, d, tag, lun, hba_private);
538         } else if ((d->unit_attention.key == UNIT_ATTENTION ||
539                    bus->unit_attention.key == UNIT_ATTENTION) &&
540                   (buf[0] != INQUIRY &&
541                    buf[0] != REPORT_LUNS &&
542                    buf[0] != GET_CONFIGURATION &&
543                    buf[0] != GET_EVENT_STATUS_NOTIFICATION &&
544
545                    /*
546                     * If we already have a pending unit attention condition,
547                     * report this one before triggering another one.
548                     */
549                    !(buf[0] == REQUEST_SENSE && d->sense_is_ua))) {
550             req = scsi_req_alloc(&reqops_unit_attention, d, tag, lun,
551                                  hba_private);
552         } else if (lun != d->lun ||
553                    buf[0] == REPORT_LUNS ||
554                    (buf[0] == REQUEST_SENSE && d->sense_len)) {
555             req = scsi_req_alloc(&reqops_target_command, d, tag, lun,
556                                  hba_private);
557         } else {
558             req = scsi_device_alloc_req(d, tag, lun, buf, hba_private);
559         }
560     }
561
562     req->cmd = cmd;
563     req->resid = req->cmd.xfer;
564
565     switch (buf[0]) {
566     case INQUIRY:
567         trace_scsi_inquiry(d->id, lun, tag, cmd.buf[1], cmd.buf[2]);
568         break;
569     case TEST_UNIT_READY:
570         trace_scsi_test_unit_ready(d->id, lun, tag);
571         break;
572     case REPORT_LUNS:
573         trace_scsi_report_luns(d->id, lun, tag);
574         break;
575     case REQUEST_SENSE:
576         trace_scsi_request_sense(d->id, lun, tag);
577         break;
578     default:
579         break;
580     }
581
582     return req;
583 }
584
585 uint8_t *scsi_req_get_buf(SCSIRequest *req)
586 {
587     return req->ops->get_buf(req);
588 }
589
590 static void scsi_clear_unit_attention(SCSIRequest *req)
591 {
592     SCSISense *ua;
593     if (req->dev->unit_attention.key != UNIT_ATTENTION &&
594         req->bus->unit_attention.key != UNIT_ATTENTION) {
595         return;
596     }
597
598     /*
599      * If an INQUIRY command enters the enabled command state,
600      * the device server shall [not] clear any unit attention condition;
601      * See also MMC-6, paragraphs 6.5 and 6.6.2.
602      */
603     if (req->cmd.buf[0] == INQUIRY ||
604         req->cmd.buf[0] == GET_CONFIGURATION ||
605         req->cmd.buf[0] == GET_EVENT_STATUS_NOTIFICATION) {
606         return;
607     }
608
609     if (req->dev->unit_attention.key == UNIT_ATTENTION) {
610         ua = &req->dev->unit_attention;
611     } else {
612         ua = &req->bus->unit_attention;
613     }
614
615     /*
616      * If a REPORT LUNS command enters the enabled command state, [...]
617      * the device server shall clear any pending unit attention condition
618      * with an additional sense code of REPORTED LUNS DATA HAS CHANGED.
619      */
620     if (req->cmd.buf[0] == REPORT_LUNS &&
621         !(ua->asc == SENSE_CODE(REPORTED_LUNS_CHANGED).asc &&
622           ua->ascq == SENSE_CODE(REPORTED_LUNS_CHANGED).ascq)) {
623         return;
624     }
625
626     *ua = SENSE_CODE(NO_SENSE);
627 }
628
629 int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len)
630 {
631     int ret;
632
633     assert(len >= 14);
634     if (!req->sense_len) {
635         return 0;
636     }
637
638     ret = scsi_build_sense(req->sense, req->sense_len, buf, len, true);
639
640     /*
641      * FIXME: clearing unit attention conditions upon autosense should be done
642      * only if the UA_INTLCK_CTRL field in the Control mode page is set to 00b
643      * (SAM-5, 5.14).
644      *
645      * We assume UA_INTLCK_CTRL to be 00b for HBAs that support autosense, and
646      * 10b for HBAs that do not support it (do not call scsi_req_get_sense).
647      * Here we handle unit attention clearing for UA_INTLCK_CTRL == 00b.
648      */
649     if (req->dev->sense_is_ua) {
650         scsi_device_unit_attention_reported(req->dev);
651         req->dev->sense_len = 0;
652         req->dev->sense_is_ua = false;
653     }
654     return ret;
655 }
656
657 int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed)
658 {
659     return scsi_build_sense(dev->sense, dev->sense_len, buf, len, fixed);
660 }
661
662 void scsi_req_build_sense(SCSIRequest *req, SCSISense sense)
663 {
664     trace_scsi_req_build_sense(req->dev->id, req->lun, req->tag,
665                                sense.key, sense.asc, sense.ascq);
666     memset(req->sense, 0, 18);
667     req->sense[0] = 0x70;
668     req->sense[2] = sense.key;
669     req->sense[7] = 10;
670     req->sense[12] = sense.asc;
671     req->sense[13] = sense.ascq;
672     req->sense_len = 18;
673 }
674
675 static void scsi_req_enqueue_internal(SCSIRequest *req)
676 {
677     assert(!req->enqueued);
678     scsi_req_ref(req);
679     if (req->bus->info->get_sg_list) {
680         req->sg = req->bus->info->get_sg_list(req);
681     } else {
682         req->sg = NULL;
683     }
684     req->enqueued = true;
685     QTAILQ_INSERT_TAIL(&req->dev->requests, req, next);
686 }
687
688 int32_t scsi_req_enqueue(SCSIRequest *req)
689 {
690     int32_t rc;
691
692     assert(!req->retry);
693     scsi_req_enqueue_internal(req);
694     scsi_req_ref(req);
695     rc = req->ops->send_command(req, req->cmd.buf);
696     scsi_req_unref(req);
697     return rc;
698 }
699
700 static void scsi_req_dequeue(SCSIRequest *req)
701 {
702     trace_scsi_req_dequeue(req->dev->id, req->lun, req->tag);
703     req->retry = false;
704     if (req->enqueued) {
705         QTAILQ_REMOVE(&req->dev->requests, req, next);
706         req->enqueued = false;
707         scsi_req_unref(req);
708     }
709 }
710
711 static int scsi_get_performance_length(int num_desc, int type, int data_type)
712 {
713     /* MMC-6, paragraph 6.7.  */
714     switch (type) {
715     case 0:
716         if ((data_type & 3) == 0) {
717             /* Each descriptor is as in Table 295 - Nominal performance.  */
718             return 16 * num_desc + 8;
719         } else {
720             /* Each descriptor is as in Table 296 - Exceptions.  */
721             return 6 * num_desc + 8;
722         }
723     case 1:
724     case 4:
725     case 5:
726         return 8 * num_desc + 8;
727     case 2:
728         return 2048 * num_desc + 8;
729     case 3:
730         return 16 * num_desc + 8;
731     default:
732         return 8;
733     }
734 }
735
736 static int ata_passthrough_xfer_unit(SCSIDevice *dev, uint8_t *buf)
737 {
738     int byte_block = (buf[2] >> 2) & 0x1;
739     int type = (buf[2] >> 4) & 0x1;
740     int xfer_unit;
741
742     if (byte_block) {
743         if (type) {
744             xfer_unit = dev->blocksize;
745         } else {
746             xfer_unit = 512;
747         }
748     } else {
749         xfer_unit = 1;
750     }
751
752     return xfer_unit;
753 }
754
755 static int ata_passthrough_12_xfer_size(SCSIDevice *dev, uint8_t *buf)
756 {
757     int length = buf[2] & 0x3;
758     int xfer;
759     int unit = ata_passthrough_xfer_unit(dev, buf);
760
761     switch (length) {
762     case 0:
763     case 3: /* USB-specific.  */
764     default:
765         xfer = 0;
766         break;
767     case 1:
768         xfer = buf[3];
769         break;
770     case 2:
771         xfer = buf[4];
772         break;
773     }
774
775     return xfer * unit;
776 }
777
778 static int ata_passthrough_16_xfer_size(SCSIDevice *dev, uint8_t *buf)
779 {
780     int extend = buf[1] & 0x1;
781     int length = buf[2] & 0x3;
782     int xfer;
783     int unit = ata_passthrough_xfer_unit(dev, buf);
784
785     switch (length) {
786     case 0:
787     case 3: /* USB-specific.  */
788     default:
789         xfer = 0;
790         break;
791     case 1:
792         xfer = buf[4];
793         xfer |= (extend ? buf[3] << 8 : 0);
794         break;
795     case 2:
796         xfer = buf[6];
797         xfer |= (extend ? buf[5] << 8 : 0);
798         break;
799     }
800
801     return xfer * unit;
802 }
803
804 uint32_t scsi_data_cdb_length(uint8_t *buf)
805 {
806     if ((buf[0] >> 5) == 0 && buf[4] == 0) {
807         return 256;
808     } else {
809         return scsi_cdb_length(buf);
810     }
811 }
812
813 uint32_t scsi_cdb_length(uint8_t *buf)
814 {
815     switch (buf[0] >> 5) {
816     case 0:
817         return buf[4];
818         break;
819     case 1:
820     case 2:
821         return lduw_be_p(&buf[7]);
822         break;
823     case 4:
824         return ldl_be_p(&buf[10]) & 0xffffffffULL;
825         break;
826     case 5:
827         return ldl_be_p(&buf[6]) & 0xffffffffULL;
828         break;
829     default:
830         return -1;
831     }
832 }
833
834 static int scsi_req_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
835 {
836     cmd->xfer = scsi_cdb_length(buf);
837     switch (buf[0]) {
838     case TEST_UNIT_READY:
839     case REWIND:
840     case START_STOP:
841     case SET_CAPACITY:
842     case WRITE_FILEMARKS:
843     case WRITE_FILEMARKS_16:
844     case SPACE:
845     case RESERVE:
846     case RELEASE:
847     case ERASE:
848     case ALLOW_MEDIUM_REMOVAL:
849     case VERIFY_10:
850     case SEEK_10:
851     case SYNCHRONIZE_CACHE:
852     case SYNCHRONIZE_CACHE_16:
853     case LOCATE_16:
854     case LOCK_UNLOCK_CACHE:
855     case SET_CD_SPEED:
856     case SET_LIMITS:
857     case WRITE_LONG_10:
858     case UPDATE_BLOCK:
859     case RESERVE_TRACK:
860     case SET_READ_AHEAD:
861     case PRE_FETCH:
862     case PRE_FETCH_16:
863     case ALLOW_OVERWRITE:
864         cmd->xfer = 0;
865         break;
866     case MODE_SENSE:
867         break;
868     case WRITE_SAME_10:
869     case WRITE_SAME_16:
870         cmd->xfer = dev->blocksize;
871         break;
872     case READ_CAPACITY_10:
873         cmd->xfer = 8;
874         break;
875     case READ_BLOCK_LIMITS:
876         cmd->xfer = 6;
877         break;
878     case SEND_VOLUME_TAG:
879         /* GPCMD_SET_STREAMING from multimedia commands.  */
880         if (dev->type == TYPE_ROM) {
881             cmd->xfer = buf[10] | (buf[9] << 8);
882         } else {
883             cmd->xfer = buf[9] | (buf[8] << 8);
884         }
885         break;
886     case WRITE_6:
887         /* length 0 means 256 blocks */
888         if (cmd->xfer == 0) {
889             cmd->xfer = 256;
890         }
891     case WRITE_10:
892     case WRITE_VERIFY_10:
893     case WRITE_12:
894     case WRITE_VERIFY_12:
895     case WRITE_16:
896     case WRITE_VERIFY_16:
897         cmd->xfer *= dev->blocksize;
898         break;
899     case READ_6:
900     case READ_REVERSE:
901         /* length 0 means 256 blocks */
902         if (cmd->xfer == 0) {
903             cmd->xfer = 256;
904         }
905     case READ_10:
906     case RECOVER_BUFFERED_DATA:
907     case READ_12:
908     case READ_16:
909         cmd->xfer *= dev->blocksize;
910         break;
911     case FORMAT_UNIT:
912         /* MMC mandates the parameter list to be 12-bytes long.  Parameters
913          * for block devices are restricted to the header right now.  */
914         if (dev->type == TYPE_ROM && (buf[1] & 16)) {
915             cmd->xfer = 12;
916         } else {
917             cmd->xfer = (buf[1] & 16) == 0 ? 0 : (buf[1] & 32 ? 8 : 4);
918         }
919         break;
920     case INQUIRY:
921     case RECEIVE_DIAGNOSTIC:
922     case SEND_DIAGNOSTIC:
923         cmd->xfer = buf[4] | (buf[3] << 8);
924         break;
925     case READ_CD:
926     case READ_BUFFER:
927     case WRITE_BUFFER:
928     case SEND_CUE_SHEET:
929         cmd->xfer = buf[8] | (buf[7] << 8) | (buf[6] << 16);
930         break;
931     case PERSISTENT_RESERVE_OUT:
932         cmd->xfer = ldl_be_p(&buf[5]) & 0xffffffffULL;
933         break;
934     case ERASE_12:
935         if (dev->type == TYPE_ROM) {
936             /* MMC command GET PERFORMANCE.  */
937             cmd->xfer = scsi_get_performance_length(buf[9] | (buf[8] << 8),
938                                                     buf[10], buf[1] & 0x1f);
939         }
940         break;
941     case MECHANISM_STATUS:
942     case READ_DVD_STRUCTURE:
943     case SEND_DVD_STRUCTURE:
944     case MAINTENANCE_OUT:
945     case MAINTENANCE_IN:
946         if (dev->type == TYPE_ROM) {
947             /* GPCMD_REPORT_KEY and GPCMD_SEND_KEY from multi media commands */
948             cmd->xfer = buf[9] | (buf[8] << 8);
949         }
950         break;
951     case ATA_PASSTHROUGH_12:
952         if (dev->type == TYPE_ROM) {
953             /* BLANK command of MMC */
954             cmd->xfer = 0;
955         } else {
956             cmd->xfer = ata_passthrough_12_xfer_size(dev, buf);
957         }
958         break;
959     case ATA_PASSTHROUGH_16:
960         cmd->xfer = ata_passthrough_16_xfer_size(dev, buf);
961         break;
962     }
963     return 0;
964 }
965
966 static int scsi_req_stream_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
967 {
968     switch (buf[0]) {
969     /* stream commands */
970     case ERASE_12:
971     case ERASE_16:
972         cmd->xfer = 0;
973         break;
974     case READ_6:
975     case READ_REVERSE:
976     case RECOVER_BUFFERED_DATA:
977     case WRITE_6:
978         cmd->xfer = buf[4] | (buf[3] << 8) | (buf[2] << 16);
979         if (buf[1] & 0x01) { /* fixed */
980             cmd->xfer *= dev->blocksize;
981         }
982         break;
983     case READ_16:
984     case READ_REVERSE_16:
985     case VERIFY_16:
986     case WRITE_16:
987         cmd->xfer = buf[14] | (buf[13] << 8) | (buf[12] << 16);
988         if (buf[1] & 0x01) { /* fixed */
989             cmd->xfer *= dev->blocksize;
990         }
991         break;
992     case REWIND:
993     case LOAD_UNLOAD:
994         cmd->xfer = 0;
995         break;
996     case SPACE_16:
997         cmd->xfer = buf[13] | (buf[12] << 8);
998         break;
999     case READ_POSITION:
1000         switch (buf[1] & 0x1f) /* operation code */ {
1001         case SHORT_FORM_BLOCK_ID:
1002         case SHORT_FORM_VENDOR_SPECIFIC:
1003             cmd->xfer = 20;
1004             break;
1005         case LONG_FORM:
1006             cmd->xfer = 32;
1007             break;
1008         case EXTENDED_FORM:
1009             cmd->xfer = buf[8] | (buf[7] << 8);
1010             break;
1011         default:
1012             return -1;
1013         }
1014
1015         break;
1016     case FORMAT_UNIT:
1017         cmd->xfer = buf[4] | (buf[3] << 8);
1018         break;
1019     /* generic commands */
1020     default:
1021         return scsi_req_length(cmd, dev, buf);
1022     }
1023     return 0;
1024 }
1025
1026 static int scsi_req_medium_changer_length(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
1027 {
1028     switch (buf[0]) {
1029     /* medium changer commands */
1030     case EXCHANGE_MEDIUM:
1031     case INITIALIZE_ELEMENT_STATUS:
1032     case INITIALIZE_ELEMENT_STATUS_WITH_RANGE:
1033     case MOVE_MEDIUM:
1034     case POSITION_TO_ELEMENT:
1035         cmd->xfer = 0;
1036         break;
1037     case READ_ELEMENT_STATUS:
1038         cmd->xfer = buf[9] | (buf[8] << 8) | (buf[7] << 16);
1039         break;
1040
1041     /* generic commands */
1042     default:
1043         return scsi_req_length(cmd, dev, buf);
1044     }
1045     return 0;
1046 }
1047
1048
1049 static void scsi_cmd_xfer_mode(SCSICommand *cmd)
1050 {
1051     if (!cmd->xfer) {
1052         cmd->mode = SCSI_XFER_NONE;
1053         return;
1054     }
1055     switch (cmd->buf[0]) {
1056     case WRITE_6:
1057     case WRITE_10:
1058     case WRITE_VERIFY_10:
1059     case WRITE_12:
1060     case WRITE_VERIFY_12:
1061     case WRITE_16:
1062     case WRITE_VERIFY_16:
1063     case COPY:
1064     case COPY_VERIFY:
1065     case COMPARE:
1066     case CHANGE_DEFINITION:
1067     case LOG_SELECT:
1068     case MODE_SELECT:
1069     case MODE_SELECT_10:
1070     case SEND_DIAGNOSTIC:
1071     case WRITE_BUFFER:
1072     case FORMAT_UNIT:
1073     case REASSIGN_BLOCKS:
1074     case SEARCH_EQUAL:
1075     case SEARCH_HIGH:
1076     case SEARCH_LOW:
1077     case UPDATE_BLOCK:
1078     case WRITE_LONG_10:
1079     case WRITE_SAME_10:
1080     case WRITE_SAME_16:
1081     case UNMAP:
1082     case SEARCH_HIGH_12:
1083     case SEARCH_EQUAL_12:
1084     case SEARCH_LOW_12:
1085     case MEDIUM_SCAN:
1086     case SEND_VOLUME_TAG:
1087     case SEND_CUE_SHEET:
1088     case SEND_DVD_STRUCTURE:
1089     case PERSISTENT_RESERVE_OUT:
1090     case MAINTENANCE_OUT:
1091         cmd->mode = SCSI_XFER_TO_DEV;
1092         break;
1093     case ATA_PASSTHROUGH_12:
1094     case ATA_PASSTHROUGH_16:
1095         /* T_DIR */
1096         cmd->mode = (cmd->buf[2] & 0x8) ?
1097                    SCSI_XFER_FROM_DEV : SCSI_XFER_TO_DEV;
1098         break;
1099     default:
1100         cmd->mode = SCSI_XFER_FROM_DEV;
1101         break;
1102     }
1103 }
1104
1105 static uint64_t scsi_cmd_lba(SCSICommand *cmd)
1106 {
1107     uint8_t *buf = cmd->buf;
1108     uint64_t lba;
1109
1110     switch (buf[0] >> 5) {
1111     case 0:
1112         lba = ldl_be_p(&buf[0]) & 0x1fffff;
1113         break;
1114     case 1:
1115     case 2:
1116     case 5:
1117         lba = ldl_be_p(&buf[2]) & 0xffffffffULL;
1118         break;
1119     case 4:
1120         lba = ldq_be_p(&buf[2]);
1121         break;
1122     default:
1123         lba = -1;
1124
1125     }
1126     return lba;
1127 }
1128
1129 int scsi_req_parse(SCSICommand *cmd, SCSIDevice *dev, uint8_t *buf)
1130 {
1131     int rc;
1132
1133     switch (buf[0] >> 5) {
1134     case 0:
1135         cmd->len = 6;
1136         break;
1137     case 1:
1138     case 2:
1139         cmd->len = 10;
1140         break;
1141     case 4:
1142         cmd->len = 16;
1143         break;
1144     case 5:
1145         cmd->len = 12;
1146         break;
1147     default:
1148         return -1;
1149     }
1150
1151     switch (dev->type) {
1152     case TYPE_TAPE:
1153         rc = scsi_req_stream_length(cmd, dev, buf);
1154         break;
1155     case TYPE_MEDIUM_CHANGER:
1156         rc = scsi_req_medium_changer_length(cmd, dev, buf);
1157         break;
1158     default:
1159         rc = scsi_req_length(cmd, dev, buf);
1160         break;
1161     }
1162
1163     if (rc != 0)
1164         return rc;
1165
1166     memcpy(cmd->buf, buf, cmd->len);
1167     scsi_cmd_xfer_mode(cmd);
1168     cmd->lba = scsi_cmd_lba(cmd);
1169     return 0;
1170 }
1171
1172 void scsi_device_report_change(SCSIDevice *dev, SCSISense sense)
1173 {
1174     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
1175
1176     scsi_device_set_ua(dev, sense);
1177     if (bus->info->change) {
1178         bus->info->change(bus, dev, sense);
1179     }
1180 }
1181
1182 /*
1183  * Predefined sense codes
1184  */
1185
1186 /* No sense data available */
1187 const struct SCSISense sense_code_NO_SENSE = {
1188     .key = NO_SENSE , .asc = 0x00 , .ascq = 0x00
1189 };
1190
1191 /* LUN not ready, Manual intervention required */
1192 const struct SCSISense sense_code_LUN_NOT_READY = {
1193     .key = NOT_READY, .asc = 0x04, .ascq = 0x03
1194 };
1195
1196 /* LUN not ready, Medium not present */
1197 const struct SCSISense sense_code_NO_MEDIUM = {
1198     .key = NOT_READY, .asc = 0x3a, .ascq = 0x00
1199 };
1200
1201 /* LUN not ready, medium removal prevented */
1202 const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED = {
1203     .key = NOT_READY, .asc = 0x53, .ascq = 0x02
1204 };
1205
1206 /* Hardware error, internal target failure */
1207 const struct SCSISense sense_code_TARGET_FAILURE = {
1208     .key = HARDWARE_ERROR, .asc = 0x44, .ascq = 0x00
1209 };
1210
1211 /* Illegal request, invalid command operation code */
1212 const struct SCSISense sense_code_INVALID_OPCODE = {
1213     .key = ILLEGAL_REQUEST, .asc = 0x20, .ascq = 0x00
1214 };
1215
1216 /* Illegal request, LBA out of range */
1217 const struct SCSISense sense_code_LBA_OUT_OF_RANGE = {
1218     .key = ILLEGAL_REQUEST, .asc = 0x21, .ascq = 0x00
1219 };
1220
1221 /* Illegal request, Invalid field in CDB */
1222 const struct SCSISense sense_code_INVALID_FIELD = {
1223     .key = ILLEGAL_REQUEST, .asc = 0x24, .ascq = 0x00
1224 };
1225
1226 /* Illegal request, Invalid field in parameter list */
1227 const struct SCSISense sense_code_INVALID_PARAM = {
1228     .key = ILLEGAL_REQUEST, .asc = 0x26, .ascq = 0x00
1229 };
1230
1231 /* Illegal request, Parameter list length error */
1232 const struct SCSISense sense_code_INVALID_PARAM_LEN = {
1233     .key = ILLEGAL_REQUEST, .asc = 0x1a, .ascq = 0x00
1234 };
1235
1236 /* Illegal request, LUN not supported */
1237 const struct SCSISense sense_code_LUN_NOT_SUPPORTED = {
1238     .key = ILLEGAL_REQUEST, .asc = 0x25, .ascq = 0x00
1239 };
1240
1241 /* Illegal request, Saving parameters not supported */
1242 const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED = {
1243     .key = ILLEGAL_REQUEST, .asc = 0x39, .ascq = 0x00
1244 };
1245
1246 /* Illegal request, Incompatible medium installed */
1247 const struct SCSISense sense_code_INCOMPATIBLE_FORMAT = {
1248     .key = ILLEGAL_REQUEST, .asc = 0x30, .ascq = 0x00
1249 };
1250
1251 /* Illegal request, medium removal prevented */
1252 const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED = {
1253     .key = ILLEGAL_REQUEST, .asc = 0x53, .ascq = 0x02
1254 };
1255
1256 /* Command aborted, I/O process terminated */
1257 const struct SCSISense sense_code_IO_ERROR = {
1258     .key = ABORTED_COMMAND, .asc = 0x00, .ascq = 0x06
1259 };
1260
1261 /* Command aborted, I_T Nexus loss occurred */
1262 const struct SCSISense sense_code_I_T_NEXUS_LOSS = {
1263     .key = ABORTED_COMMAND, .asc = 0x29, .ascq = 0x07
1264 };
1265
1266 /* Command aborted, Logical Unit failure */
1267 const struct SCSISense sense_code_LUN_FAILURE = {
1268     .key = ABORTED_COMMAND, .asc = 0x3e, .ascq = 0x01
1269 };
1270
1271 /* Unit attention, Capacity data has changed */
1272 const struct SCSISense sense_code_CAPACITY_CHANGED = {
1273     .key = UNIT_ATTENTION, .asc = 0x2a, .ascq = 0x09
1274 };
1275
1276 /* Unit attention, Power on, reset or bus device reset occurred */
1277 const struct SCSISense sense_code_RESET = {
1278     .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x00
1279 };
1280
1281 /* Unit attention, No medium */
1282 const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM = {
1283     .key = UNIT_ATTENTION, .asc = 0x3a, .ascq = 0x00
1284 };
1285
1286 /* Unit attention, Medium may have changed */
1287 const struct SCSISense sense_code_MEDIUM_CHANGED = {
1288     .key = UNIT_ATTENTION, .asc = 0x28, .ascq = 0x00
1289 };
1290
1291 /* Unit attention, Reported LUNs data has changed */
1292 const struct SCSISense sense_code_REPORTED_LUNS_CHANGED = {
1293     .key = UNIT_ATTENTION, .asc = 0x3f, .ascq = 0x0e
1294 };
1295
1296 /* Unit attention, Device internal reset */
1297 const struct SCSISense sense_code_DEVICE_INTERNAL_RESET = {
1298     .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x04
1299 };
1300
1301 /* Data Protection, Write Protected */
1302 const struct SCSISense sense_code_WRITE_PROTECTED = {
1303     .key = DATA_PROTECT, .asc = 0x27, .ascq = 0x00
1304 };
1305
1306 /*
1307  * scsi_build_sense
1308  *
1309  * Convert between fixed and descriptor sense buffers
1310  */
1311 int scsi_build_sense(uint8_t *in_buf, int in_len,
1312                      uint8_t *buf, int len, bool fixed)
1313 {
1314     bool fixed_in;
1315     SCSISense sense;
1316     if (!fixed && len < 8) {
1317         return 0;
1318     }
1319
1320     if (in_len == 0) {
1321         sense.key = NO_SENSE;
1322         sense.asc = 0;
1323         sense.ascq = 0;
1324     } else {
1325         fixed_in = (in_buf[0] & 2) == 0;
1326
1327         if (fixed == fixed_in) {
1328             memcpy(buf, in_buf, MIN(len, in_len));
1329             return MIN(len, in_len);
1330         }
1331
1332         if (fixed_in) {
1333             sense.key = in_buf[2];
1334             sense.asc = in_buf[12];
1335             sense.ascq = in_buf[13];
1336         } else {
1337             sense.key = in_buf[1];
1338             sense.asc = in_buf[2];
1339             sense.ascq = in_buf[3];
1340         }
1341     }
1342
1343     memset(buf, 0, len);
1344     if (fixed) {
1345         /* Return fixed format sense buffer */
1346         buf[0] = 0x70;
1347         buf[2] = sense.key;
1348         buf[7] = 10;
1349         buf[12] = sense.asc;
1350         buf[13] = sense.ascq;
1351         return MIN(len, 18);
1352     } else {
1353         /* Return descriptor format sense buffer */
1354         buf[0] = 0x72;
1355         buf[1] = sense.key;
1356         buf[2] = sense.asc;
1357         buf[3] = sense.ascq;
1358         return 8;
1359     }
1360 }
1361
1362 static const char *scsi_command_name(uint8_t cmd)
1363 {
1364     static const char *names[] = {
1365         [ TEST_UNIT_READY          ] = "TEST_UNIT_READY",
1366         [ REWIND                   ] = "REWIND",
1367         [ REQUEST_SENSE            ] = "REQUEST_SENSE",
1368         [ FORMAT_UNIT              ] = "FORMAT_UNIT",
1369         [ READ_BLOCK_LIMITS        ] = "READ_BLOCK_LIMITS",
1370         [ REASSIGN_BLOCKS          ] = "REASSIGN_BLOCKS/INITIALIZE ELEMENT STATUS",
1371         /* LOAD_UNLOAD and INITIALIZE_ELEMENT_STATUS use the same operation code */
1372         [ READ_6                   ] = "READ_6",
1373         [ WRITE_6                  ] = "WRITE_6",
1374         [ SET_CAPACITY             ] = "SET_CAPACITY",
1375         [ READ_REVERSE             ] = "READ_REVERSE",
1376         [ WRITE_FILEMARKS          ] = "WRITE_FILEMARKS",
1377         [ SPACE                    ] = "SPACE",
1378         [ INQUIRY                  ] = "INQUIRY",
1379         [ RECOVER_BUFFERED_DATA    ] = "RECOVER_BUFFERED_DATA",
1380         [ MAINTENANCE_IN           ] = "MAINTENANCE_IN",
1381         [ MAINTENANCE_OUT          ] = "MAINTENANCE_OUT",
1382         [ MODE_SELECT              ] = "MODE_SELECT",
1383         [ RESERVE                  ] = "RESERVE",
1384         [ RELEASE                  ] = "RELEASE",
1385         [ COPY                     ] = "COPY",
1386         [ ERASE                    ] = "ERASE",
1387         [ MODE_SENSE               ] = "MODE_SENSE",
1388         [ START_STOP               ] = "START_STOP/LOAD_UNLOAD",
1389         /* LOAD_UNLOAD and START_STOP use the same operation code */
1390         [ RECEIVE_DIAGNOSTIC       ] = "RECEIVE_DIAGNOSTIC",
1391         [ SEND_DIAGNOSTIC          ] = "SEND_DIAGNOSTIC",
1392         [ ALLOW_MEDIUM_REMOVAL     ] = "ALLOW_MEDIUM_REMOVAL",
1393         [ READ_CAPACITY_10         ] = "READ_CAPACITY_10",
1394         [ READ_10                  ] = "READ_10",
1395         [ WRITE_10                 ] = "WRITE_10",
1396         [ SEEK_10                  ] = "SEEK_10/POSITION_TO_ELEMENT",
1397         /* SEEK_10 and POSITION_TO_ELEMENT use the same operation code */
1398         [ WRITE_VERIFY_10          ] = "WRITE_VERIFY_10",
1399         [ VERIFY_10                ] = "VERIFY_10",
1400         [ SEARCH_HIGH              ] = "SEARCH_HIGH",
1401         [ SEARCH_EQUAL             ] = "SEARCH_EQUAL",
1402         [ SEARCH_LOW               ] = "SEARCH_LOW",
1403         [ SET_LIMITS               ] = "SET_LIMITS",
1404         [ PRE_FETCH                ] = "PRE_FETCH/READ_POSITION",
1405         /* READ_POSITION and PRE_FETCH use the same operation code */
1406         [ SYNCHRONIZE_CACHE        ] = "SYNCHRONIZE_CACHE",
1407         [ LOCK_UNLOCK_CACHE        ] = "LOCK_UNLOCK_CACHE",
1408         [ READ_DEFECT_DATA         ] = "READ_DEFECT_DATA/INITIALIZE_ELEMENT_STATUS_WITH_RANGE",
1409         /* READ_DEFECT_DATA and INITIALIZE_ELEMENT_STATUS_WITH_RANGE use the same operation code */
1410         [ MEDIUM_SCAN              ] = "MEDIUM_SCAN",
1411         [ COMPARE                  ] = "COMPARE",
1412         [ COPY_VERIFY              ] = "COPY_VERIFY",
1413         [ WRITE_BUFFER             ] = "WRITE_BUFFER",
1414         [ READ_BUFFER              ] = "READ_BUFFER",
1415         [ UPDATE_BLOCK             ] = "UPDATE_BLOCK",
1416         [ READ_LONG_10             ] = "READ_LONG_10",
1417         [ WRITE_LONG_10            ] = "WRITE_LONG_10",
1418         [ CHANGE_DEFINITION        ] = "CHANGE_DEFINITION",
1419         [ WRITE_SAME_10            ] = "WRITE_SAME_10",
1420         [ UNMAP                    ] = "UNMAP",
1421         [ READ_TOC                 ] = "READ_TOC",
1422         [ REPORT_DENSITY_SUPPORT   ] = "REPORT_DENSITY_SUPPORT",
1423         [ SANITIZE                 ] = "SANITIZE",
1424         [ GET_CONFIGURATION        ] = "GET_CONFIGURATION",
1425         [ LOG_SELECT               ] = "LOG_SELECT",
1426         [ LOG_SENSE                ] = "LOG_SENSE",
1427         [ MODE_SELECT_10           ] = "MODE_SELECT_10",
1428         [ RESERVE_10               ] = "RESERVE_10",
1429         [ RELEASE_10               ] = "RELEASE_10",
1430         [ MODE_SENSE_10            ] = "MODE_SENSE_10",
1431         [ PERSISTENT_RESERVE_IN    ] = "PERSISTENT_RESERVE_IN",
1432         [ PERSISTENT_RESERVE_OUT   ] = "PERSISTENT_RESERVE_OUT",
1433         [ WRITE_FILEMARKS_16       ] = "WRITE_FILEMARKS_16",
1434         [ EXTENDED_COPY            ] = "EXTENDED_COPY",
1435         [ ATA_PASSTHROUGH_16       ] = "ATA_PASSTHROUGH_16",
1436         [ ACCESS_CONTROL_IN        ] = "ACCESS_CONTROL_IN",
1437         [ ACCESS_CONTROL_OUT       ] = "ACCESS_CONTROL_OUT",
1438         [ READ_16                  ] = "READ_16",
1439         [ COMPARE_AND_WRITE        ] = "COMPARE_AND_WRITE",
1440         [ WRITE_16                 ] = "WRITE_16",
1441         [ WRITE_VERIFY_16          ] = "WRITE_VERIFY_16",
1442         [ VERIFY_16                ] = "VERIFY_16",
1443         [ PRE_FETCH_16             ] = "PRE_FETCH_16",
1444         [ SYNCHRONIZE_CACHE_16     ] = "SPACE_16/SYNCHRONIZE_CACHE_16",
1445         /* SPACE_16 and SYNCHRONIZE_CACHE_16 use the same operation code */
1446         [ LOCATE_16                ] = "LOCATE_16",
1447         [ WRITE_SAME_16            ] = "ERASE_16/WRITE_SAME_16",
1448         /* ERASE_16 and WRITE_SAME_16 use the same operation code */
1449         [ SERVICE_ACTION_IN_16     ] = "SERVICE_ACTION_IN_16",
1450         [ WRITE_LONG_16            ] = "WRITE_LONG_16",
1451         [ REPORT_LUNS              ] = "REPORT_LUNS",
1452         [ ATA_PASSTHROUGH_12       ] = "BLANK/ATA_PASSTHROUGH_12",
1453         [ MOVE_MEDIUM              ] = "MOVE_MEDIUM",
1454         [ EXCHANGE_MEDIUM          ] = "EXCHANGE MEDIUM",
1455         [ READ_12                  ] = "READ_12",
1456         [ WRITE_12                 ] = "WRITE_12",
1457         [ ERASE_12                 ] = "ERASE_12/GET_PERFORMANCE",
1458         /* ERASE_12 and GET_PERFORMANCE use the same operation code */
1459         [ SERVICE_ACTION_IN_12     ] = "SERVICE_ACTION_IN_12",
1460         [ WRITE_VERIFY_12          ] = "WRITE_VERIFY_12",
1461         [ VERIFY_12                ] = "VERIFY_12",
1462         [ SEARCH_HIGH_12           ] = "SEARCH_HIGH_12",
1463         [ SEARCH_EQUAL_12          ] = "SEARCH_EQUAL_12",
1464         [ SEARCH_LOW_12            ] = "SEARCH_LOW_12",
1465         [ READ_ELEMENT_STATUS      ] = "READ_ELEMENT_STATUS",
1466         [ SEND_VOLUME_TAG          ] = "SEND_VOLUME_TAG/SET_STREAMING",
1467         /* SEND_VOLUME_TAG and SET_STREAMING use the same operation code */
1468         [ READ_CD                  ] = "READ_CD",
1469         [ READ_DEFECT_DATA_12      ] = "READ_DEFECT_DATA_12",
1470         [ READ_DVD_STRUCTURE       ] = "READ_DVD_STRUCTURE",
1471         [ RESERVE_TRACK            ] = "RESERVE_TRACK",
1472         [ SEND_CUE_SHEET           ] = "SEND_CUE_SHEET",
1473         [ SEND_DVD_STRUCTURE       ] = "SEND_DVD_STRUCTURE",
1474         [ SET_CD_SPEED             ] = "SET_CD_SPEED",
1475         [ SET_READ_AHEAD           ] = "SET_READ_AHEAD",
1476         [ ALLOW_OVERWRITE          ] = "ALLOW_OVERWRITE",
1477         [ MECHANISM_STATUS         ] = "MECHANISM_STATUS",
1478     };
1479
1480     if (cmd >= ARRAY_SIZE(names) || names[cmd] == NULL)
1481         return "*UNKNOWN*";
1482     return names[cmd];
1483 }
1484
1485 SCSIRequest *scsi_req_ref(SCSIRequest *req)
1486 {
1487     assert(req->refcount > 0);
1488     req->refcount++;
1489     return req;
1490 }
1491
1492 void scsi_req_unref(SCSIRequest *req)
1493 {
1494     assert(req->refcount > 0);
1495     if (--req->refcount == 0) {
1496         SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, req->dev->qdev.parent_bus);
1497         if (bus->info->free_request && req->hba_private) {
1498             bus->info->free_request(bus, req->hba_private);
1499         }
1500         if (req->ops->free_req) {
1501             req->ops->free_req(req);
1502         }
1503         g_free(req);
1504     }
1505 }
1506
1507 /* Tell the device that we finished processing this chunk of I/O.  It
1508    will start the next chunk or complete the command.  */
1509 void scsi_req_continue(SCSIRequest *req)
1510 {
1511     trace_scsi_req_continue(req->dev->id, req->lun, req->tag);
1512     if (req->cmd.mode == SCSI_XFER_TO_DEV) {
1513         req->ops->write_data(req);
1514     } else {
1515         req->ops->read_data(req);
1516     }
1517 }
1518
1519 /* Called by the devices when data is ready for the HBA.  The HBA should
1520    start a DMA operation to read or fill the device's data buffer.
1521    Once it completes, calling scsi_req_continue will restart I/O.  */
1522 void scsi_req_data(SCSIRequest *req, int len)
1523 {
1524     uint8_t *buf;
1525     if (req->io_canceled) {
1526         trace_scsi_req_data_canceled(req->dev->id, req->lun, req->tag, len);
1527         return;
1528     }
1529     trace_scsi_req_data(req->dev->id, req->lun, req->tag, len);
1530     assert(req->cmd.mode != SCSI_XFER_NONE);
1531     if (!req->sg) {
1532         req->resid -= len;
1533         req->bus->info->transfer_data(req, len);
1534         return;
1535     }
1536
1537     /* If the device calls scsi_req_data and the HBA specified a
1538      * scatter/gather list, the transfer has to happen in a single
1539      * step.  */
1540     assert(!req->dma_started);
1541     req->dma_started = true;
1542
1543     buf = scsi_req_get_buf(req);
1544     if (req->cmd.mode == SCSI_XFER_FROM_DEV) {
1545         req->resid = dma_buf_read(buf, len, req->sg);
1546     } else {
1547         req->resid = dma_buf_write(buf, len, req->sg);
1548     }
1549     scsi_req_continue(req);
1550 }
1551
1552 void scsi_req_print(SCSIRequest *req)
1553 {
1554     FILE *fp = stderr;
1555     int i;
1556
1557     fprintf(fp, "[%s id=%d] %s",
1558             req->dev->qdev.parent_bus->name,
1559             req->dev->id,
1560             scsi_command_name(req->cmd.buf[0]));
1561     for (i = 1; i < req->cmd.len; i++) {
1562         fprintf(fp, " 0x%02x", req->cmd.buf[i]);
1563     }
1564     switch (req->cmd.mode) {
1565     case SCSI_XFER_NONE:
1566         fprintf(fp, " - none\n");
1567         break;
1568     case SCSI_XFER_FROM_DEV:
1569         fprintf(fp, " - from-dev len=%zd\n", req->cmd.xfer);
1570         break;
1571     case SCSI_XFER_TO_DEV:
1572         fprintf(fp, " - to-dev len=%zd\n", req->cmd.xfer);
1573         break;
1574     default:
1575         fprintf(fp, " - Oops\n");
1576         break;
1577     }
1578 }
1579
1580 void scsi_req_complete(SCSIRequest *req, int status)
1581 {
1582     assert(req->status == -1);
1583     req->status = status;
1584
1585     assert(req->sense_len <= sizeof(req->sense));
1586     if (status == GOOD) {
1587         req->sense_len = 0;
1588     }
1589
1590     if (req->sense_len) {
1591         memcpy(req->dev->sense, req->sense, req->sense_len);
1592         req->dev->sense_len = req->sense_len;
1593         req->dev->sense_is_ua = (req->ops == &reqops_unit_attention);
1594     } else {
1595         req->dev->sense_len = 0;
1596         req->dev->sense_is_ua = false;
1597     }
1598
1599     /*
1600      * Unit attention state is now stored in the device's sense buffer
1601      * if the HBA didn't do autosense.  Clear the pending unit attention
1602      * flags.
1603      */
1604     scsi_clear_unit_attention(req);
1605
1606     scsi_req_ref(req);
1607     scsi_req_dequeue(req);
1608     req->bus->info->complete(req, req->status, req->resid);
1609     scsi_req_unref(req);
1610 }
1611
1612 void scsi_req_cancel(SCSIRequest *req)
1613 {
1614     trace_scsi_req_cancel(req->dev->id, req->lun, req->tag);
1615     if (!req->enqueued) {
1616         return;
1617     }
1618     scsi_req_ref(req);
1619     scsi_req_dequeue(req);
1620     req->io_canceled = true;
1621     if (req->ops->cancel_io) {
1622         req->ops->cancel_io(req);
1623     }
1624     if (req->bus->info->cancel) {
1625         req->bus->info->cancel(req);
1626     }
1627     scsi_req_unref(req);
1628 }
1629
1630 void scsi_req_abort(SCSIRequest *req, int status)
1631 {
1632     if (!req->enqueued) {
1633         return;
1634     }
1635     scsi_req_ref(req);
1636     scsi_req_dequeue(req);
1637     req->io_canceled = true;
1638     if (req->ops->cancel_io) {
1639         req->ops->cancel_io(req);
1640     }
1641     scsi_req_complete(req, status);
1642     scsi_req_unref(req);
1643 }
1644
1645 static int scsi_ua_precedence(SCSISense sense)
1646 {
1647     if (sense.key != UNIT_ATTENTION) {
1648         return INT_MAX;
1649     }
1650     if (sense.asc == 0x29 && sense.ascq == 0x04) {
1651         /* DEVICE INTERNAL RESET goes with POWER ON OCCURRED */
1652         return 1;
1653     } else if (sense.asc == 0x3F && sense.ascq == 0x01) {
1654         /* MICROCODE HAS BEEN CHANGED goes with SCSI BUS RESET OCCURRED */
1655         return 2;
1656     } else if (sense.asc == 0x29 && (sense.ascq == 0x05 || sense.ascq == 0x06)) {
1657         /* These two go with "all others". */
1658         ;
1659     } else if (sense.asc == 0x29 && sense.ascq <= 0x07) {
1660         /* POWER ON, RESET OR BUS DEVICE RESET OCCURRED = 0
1661          * POWER ON OCCURRED = 1
1662          * SCSI BUS RESET OCCURRED = 2
1663          * BUS DEVICE RESET FUNCTION OCCURRED = 3
1664          * I_T NEXUS LOSS OCCURRED = 7
1665          */
1666         return sense.ascq;
1667     } else if (sense.asc == 0x2F && sense.ascq == 0x01) {
1668         /* COMMANDS CLEARED BY POWER LOSS NOTIFICATION  */
1669         return 8;
1670     }
1671     return (sense.asc << 8) | sense.ascq;
1672 }
1673
1674 void scsi_device_set_ua(SCSIDevice *sdev, SCSISense sense)
1675 {
1676     int prec1, prec2;
1677     if (sense.key != UNIT_ATTENTION) {
1678         return;
1679     }
1680     trace_scsi_device_set_ua(sdev->id, sdev->lun, sense.key,
1681                              sense.asc, sense.ascq);
1682
1683     /*
1684      * Override a pre-existing unit attention condition, except for a more
1685      * important reset condition.
1686     */
1687     prec1 = scsi_ua_precedence(sdev->unit_attention);
1688     prec2 = scsi_ua_precedence(sense);
1689     if (prec2 < prec1) {
1690         sdev->unit_attention = sense;
1691     }
1692 }
1693
1694 void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense)
1695 {
1696     SCSIRequest *req;
1697
1698     while (!QTAILQ_EMPTY(&sdev->requests)) {
1699         req = QTAILQ_FIRST(&sdev->requests);
1700         scsi_req_cancel(req);
1701     }
1702
1703     scsi_device_set_ua(sdev, sense);
1704 }
1705
1706 static char *scsibus_get_dev_path(DeviceState *dev)
1707 {
1708     SCSIDevice *d = DO_UPCAST(SCSIDevice, qdev, dev);
1709     DeviceState *hba = dev->parent_bus->parent;
1710     char *id;
1711     char *path;
1712
1713     id = qdev_get_dev_path(hba);
1714     if (id) {
1715         path = g_strdup_printf("%s/%d:%d:%d", id, d->channel, d->id, d->lun);
1716     } else {
1717         path = g_strdup_printf("%d:%d:%d", d->channel, d->id, d->lun);
1718     }
1719     g_free(id);
1720     return path;
1721 }
1722
1723 static char *scsibus_get_fw_dev_path(DeviceState *dev)
1724 {
1725     SCSIDevice *d = SCSI_DEVICE(dev);
1726     return g_strdup_printf("channel@%x/%s@%x,%x", d->channel,
1727                            qdev_fw_name(dev), d->id, d->lun);
1728 }
1729
1730 SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int id, int lun)
1731 {
1732     BusChild *kid;
1733     SCSIDevice *target_dev = NULL;
1734
1735     QTAILQ_FOREACH_REVERSE(kid, &bus->qbus.children, ChildrenHead, sibling) {
1736         DeviceState *qdev = kid->child;
1737         SCSIDevice *dev = SCSI_DEVICE(qdev);
1738
1739         if (dev->channel == channel && dev->id == id) {
1740             if (dev->lun == lun) {
1741                 return dev;
1742             }
1743             target_dev = dev;
1744         }
1745     }
1746     return target_dev;
1747 }
1748
1749 /* SCSI request list.  For simplicity, pv points to the whole device */
1750
1751 static void put_scsi_requests(QEMUFile *f, void *pv, size_t size)
1752 {
1753     SCSIDevice *s = pv;
1754     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, s->qdev.parent_bus);
1755     SCSIRequest *req;
1756
1757     QTAILQ_FOREACH(req, &s->requests, next) {
1758         assert(!req->io_canceled);
1759         assert(req->status == -1);
1760         assert(req->enqueued);
1761
1762         qemu_put_sbyte(f, req->retry ? 1 : 2);
1763         qemu_put_buffer(f, req->cmd.buf, sizeof(req->cmd.buf));
1764         qemu_put_be32s(f, &req->tag);
1765         qemu_put_be32s(f, &req->lun);
1766         if (bus->info->save_request) {
1767             bus->info->save_request(f, req);
1768         }
1769         if (req->ops->save_request) {
1770             req->ops->save_request(f, req);
1771         }
1772     }
1773     qemu_put_sbyte(f, 0);
1774 }
1775
1776 static int get_scsi_requests(QEMUFile *f, void *pv, size_t size)
1777 {
1778     SCSIDevice *s = pv;
1779     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, s->qdev.parent_bus);
1780     int8_t sbyte;
1781
1782     while ((sbyte = qemu_get_sbyte(f)) > 0) {
1783         uint8_t buf[SCSI_CMD_BUF_SIZE];
1784         uint32_t tag;
1785         uint32_t lun;
1786         SCSIRequest *req;
1787
1788         qemu_get_buffer(f, buf, sizeof(buf));
1789         qemu_get_be32s(f, &tag);
1790         qemu_get_be32s(f, &lun);
1791         req = scsi_req_new(s, tag, lun, buf, NULL);
1792         req->retry = (sbyte == 1);
1793         if (bus->info->load_request) {
1794             req->hba_private = bus->info->load_request(f, req);
1795         }
1796         if (req->ops->load_request) {
1797             req->ops->load_request(f, req);
1798         }
1799
1800         /* Just restart it later.  */
1801         scsi_req_enqueue_internal(req);
1802
1803         /* At this point, the request will be kept alive by the reference
1804          * added by scsi_req_enqueue_internal, so we can release our reference.
1805          * The HBA of course will add its own reference in the load_request
1806          * callback if it needs to hold on the SCSIRequest.
1807          */
1808         scsi_req_unref(req);
1809     }
1810
1811     return 0;
1812 }
1813
1814 static int scsi_qdev_unplug(DeviceState *qdev)
1815 {
1816     SCSIDevice *dev = SCSI_DEVICE(qdev);
1817     SCSIBus *bus = DO_UPCAST(SCSIBus, qbus, dev->qdev.parent_bus);
1818
1819     if (bus->info->hot_unplug) {
1820         bus->info->hot_unplug(bus, dev);
1821     }
1822     return qdev_simple_unplug_cb(qdev);
1823 }
1824
1825 static const VMStateInfo vmstate_info_scsi_requests = {
1826     .name = "scsi-requests",
1827     .get  = get_scsi_requests,
1828     .put  = put_scsi_requests,
1829 };
1830
1831 const VMStateDescription vmstate_scsi_device = {
1832     .name = "SCSIDevice",
1833     .version_id = 1,
1834     .minimum_version_id = 1,
1835     .minimum_version_id_old = 1,
1836     .fields = (VMStateField[]) {
1837         VMSTATE_UINT8(unit_attention.key, SCSIDevice),
1838         VMSTATE_UINT8(unit_attention.asc, SCSIDevice),
1839         VMSTATE_UINT8(unit_attention.ascq, SCSIDevice),
1840         VMSTATE_BOOL(sense_is_ua, SCSIDevice),
1841         VMSTATE_UINT8_ARRAY(sense, SCSIDevice, SCSI_SENSE_BUF_SIZE),
1842         VMSTATE_UINT32(sense_len, SCSIDevice),
1843         {
1844             .name         = "requests",
1845             .version_id   = 0,
1846             .field_exists = NULL,
1847             .size         = 0,   /* ouch */
1848             .info         = &vmstate_info_scsi_requests,
1849             .flags        = VMS_SINGLE,
1850             .offset       = 0,
1851         },
1852         VMSTATE_END_OF_LIST()
1853     }
1854 };
1855
1856 static void scsi_device_class_init(ObjectClass *klass, void *data)
1857 {
1858     DeviceClass *k = DEVICE_CLASS(klass);
1859     k->bus_type = TYPE_SCSI_BUS;
1860     k->init     = scsi_qdev_init;
1861     k->unplug   = scsi_qdev_unplug;
1862     k->exit     = scsi_qdev_exit;
1863     k->props    = scsi_props;
1864 }
1865
1866 static TypeInfo scsi_device_type_info = {
1867     .name = TYPE_SCSI_DEVICE,
1868     .parent = TYPE_DEVICE,
1869     .instance_size = sizeof(SCSIDevice),
1870     .abstract = true,
1871     .class_size = sizeof(SCSIDeviceClass),
1872     .class_init = scsi_device_class_init,
1873 };
1874
1875 static void scsi_register_types(void)
1876 {
1877     type_register_static(&scsi_bus_info);
1878     type_register_static(&scsi_device_type_info);
1879 }
1880
1881 type_init(scsi_register_types)
This page took 0.125528 seconds and 4 git commands to generate.