1 #include "qemu/osdep.h"
3 #include "qemu/error-report.h"
4 #include "hw/scsi/scsi.h"
5 #include "block/scsi.h"
7 #include "sysemu/block-backend.h"
8 #include "sysemu/blockdev.h"
10 #include "sysemu/dma.h"
12 static char *scsibus_get_dev_path(DeviceState
*dev
);
13 static char *scsibus_get_fw_dev_path(DeviceState
*dev
);
14 static void scsi_req_dequeue(SCSIRequest
*req
);
15 static uint8_t *scsi_target_alloc_buf(SCSIRequest
*req
, size_t len
);
16 static void scsi_target_free_buf(SCSIRequest
*req
);
18 static Property scsi_props
[] = {
19 DEFINE_PROP_UINT32("channel", SCSIDevice
, channel
, 0),
20 DEFINE_PROP_UINT32("scsi-id", SCSIDevice
, id
, -1),
21 DEFINE_PROP_UINT32("lun", SCSIDevice
, lun
, -1),
22 DEFINE_PROP_END_OF_LIST(),
25 static void scsi_bus_class_init(ObjectClass
*klass
, void *data
)
27 BusClass
*k
= BUS_CLASS(klass
);
28 HotplugHandlerClass
*hc
= HOTPLUG_HANDLER_CLASS(klass
);
30 k
->get_dev_path
= scsibus_get_dev_path
;
31 k
->get_fw_dev_path
= scsibus_get_fw_dev_path
;
32 hc
->unplug
= qdev_simple_device_unplug_cb
;
35 static const TypeInfo scsi_bus_info
= {
36 .name
= TYPE_SCSI_BUS
,
38 .instance_size
= sizeof(SCSIBus
),
39 .class_init
= scsi_bus_class_init
,
40 .interfaces
= (InterfaceInfo
[]) {
41 { TYPE_HOTPLUG_HANDLER
},
45 static int next_scsi_bus
;
47 static void scsi_device_realize(SCSIDevice
*s
, Error
**errp
)
49 SCSIDeviceClass
*sc
= SCSI_DEVICE_GET_CLASS(s
);
55 int scsi_bus_parse_cdb(SCSIDevice
*dev
, SCSICommand
*cmd
, uint8_t *buf
,
58 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, dev
->qdev
.parent_bus
);
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
);
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
);
74 return sc
->alloc_req(s
, tag
, lun
, buf
, hba_private
);
80 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
++;
95 qbus_set_bus_hotplug_handler(BUS(bus
), &error_abort
);
98 static void scsi_dma_restart_bh(void *opaque
)
100 SCSIDevice
*s
= opaque
;
101 SCSIRequest
*req
, *next
;
103 qemu_bh_delete(s
->bh
);
106 QTAILQ_FOREACH_SAFE(req
, &s
->requests
, next
, next
) {
110 switch (req
->cmd
.mode
) {
111 case SCSI_XFER_FROM_DEV
:
112 case SCSI_XFER_TO_DEV
:
113 scsi_req_continue(req
);
116 scsi_req_dequeue(req
);
117 scsi_req_enqueue(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. */
132 static void scsi_dma_restart_cb(void *opaque
, int running
, RunState state
)
134 SCSIDevice
*s
= opaque
;
140 AioContext
*ctx
= blk_get_aio_context(s
->conf
.blk
);
141 s
->bh
= aio_bh_new(ctx
, scsi_dma_restart_bh
, s
);
142 qemu_bh_schedule(s
->bh
);
146 static void scsi_qdev_realize(DeviceState
*qdev
, Error
**errp
)
148 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
149 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, dev
->qdev
.parent_bus
);
151 Error
*local_err
= NULL
;
153 if (dev
->channel
> bus
->info
->max_channel
) {
154 error_setg(errp
, "bad scsi channel id: %d", dev
->channel
);
157 if (dev
->id
!= -1 && dev
->id
> bus
->info
->max_target
) {
158 error_setg(errp
, "bad scsi device id: %d", dev
->id
);
161 if (dev
->lun
!= -1 && dev
->lun
> bus
->info
->max_lun
) {
162 error_setg(errp
, "bad scsi device lun: %d", dev
->lun
);
168 if (dev
->lun
== -1) {
172 d
= scsi_device_find(bus
, dev
->channel
, ++id
, dev
->lun
);
173 } while (d
&& d
->lun
== dev
->lun
&& id
< bus
->info
->max_target
);
174 if (d
&& d
->lun
== dev
->lun
) {
175 error_setg(errp
, "no free target");
179 } else if (dev
->lun
== -1) {
182 d
= scsi_device_find(bus
, dev
->channel
, dev
->id
, ++lun
);
183 } while (d
&& d
->lun
== lun
&& lun
< bus
->info
->max_lun
);
184 if (d
&& d
->lun
== lun
) {
185 error_setg(errp
, "no free lun");
190 d
= scsi_device_find(bus
, dev
->channel
, dev
->id
, dev
->lun
);
192 if (d
->lun
== dev
->lun
&& dev
!= d
) {
193 error_setg(errp
, "lun already used by '%s'", d
->qdev
.id
);
198 QTAILQ_INIT(&dev
->requests
);
199 scsi_device_realize(dev
, &local_err
);
201 error_propagate(errp
, local_err
);
204 dev
->vmsentry
= qemu_add_vm_change_state_handler(scsi_dma_restart_cb
,
208 static void scsi_qdev_unrealize(DeviceState
*qdev
, Error
**errp
)
210 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
213 qemu_del_vm_change_state_handler(dev
->vmsentry
);
216 scsi_device_purge_requests(dev
, SENSE_CODE(NO_SENSE
));
217 blockdev_mark_auto_del(dev
->conf
.blk
);
220 /* handle legacy '-drive if=scsi,...' cmd line args */
221 SCSIDevice
*scsi_bus_legacy_add_drive(SCSIBus
*bus
, BlockBackend
*blk
,
222 int unit
, bool removable
, int bootindex
,
223 const char *serial
, Error
**errp
)
230 driver
= blk_is_sg(blk
) ? "scsi-generic" : "scsi-disk";
231 dev
= qdev_create(&bus
->qbus
, driver
);
232 name
= g_strdup_printf("legacy[%d]", unit
);
233 object_property_add_child(OBJECT(bus
), name
, OBJECT(dev
), NULL
);
236 qdev_prop_set_uint32(dev
, "scsi-id", unit
);
237 if (bootindex
>= 0) {
238 object_property_set_int(OBJECT(dev
), bootindex
, "bootindex",
241 if (object_property_find(OBJECT(dev
), "removable", NULL
)) {
242 qdev_prop_set_bit(dev
, "removable", removable
);
244 if (serial
&& object_property_find(OBJECT(dev
), "serial", NULL
)) {
245 qdev_prop_set_string(dev
, "serial", serial
);
247 qdev_prop_set_drive(dev
, "drive", blk
, &err
);
249 error_propagate(errp
, err
);
250 object_unparent(OBJECT(dev
));
253 object_property_set_bool(OBJECT(dev
), true, "realized", &err
);
255 error_propagate(errp
, err
);
256 object_unparent(OBJECT(dev
));
259 return SCSI_DEVICE(dev
);
262 void scsi_bus_legacy_handle_cmdline(SCSIBus
*bus
, Error
**errp
)
270 for (unit
= 0; unit
<= bus
->info
->max_target
; unit
++) {
271 dinfo
= drive_get(IF_SCSI
, bus
->busnr
, unit
);
275 qemu_opts_loc_restore(dinfo
->opts
);
276 scsi_bus_legacy_add_drive(bus
, blk_by_legacy_dinfo(dinfo
),
277 unit
, false, -1, NULL
, &err
);
279 error_propagate(errp
, err
);
286 static int32_t scsi_invalid_field(SCSIRequest
*req
, uint8_t *buf
)
288 scsi_req_build_sense(req
, SENSE_CODE(INVALID_FIELD
));
289 scsi_req_complete(req
, CHECK_CONDITION
);
293 static const struct SCSIReqOps reqops_invalid_field
= {
294 .size
= sizeof(SCSIRequest
),
295 .send_command
= scsi_invalid_field
298 /* SCSIReqOps implementation for invalid commands. */
300 static int32_t scsi_invalid_command(SCSIRequest
*req
, uint8_t *buf
)
302 scsi_req_build_sense(req
, SENSE_CODE(INVALID_OPCODE
));
303 scsi_req_complete(req
, CHECK_CONDITION
);
307 static const struct SCSIReqOps reqops_invalid_opcode
= {
308 .size
= sizeof(SCSIRequest
),
309 .send_command
= scsi_invalid_command
312 /* SCSIReqOps implementation for unit attention conditions. */
314 static int32_t scsi_unit_attention(SCSIRequest
*req
, uint8_t *buf
)
316 if (req
->dev
->unit_attention
.key
== UNIT_ATTENTION
) {
317 scsi_req_build_sense(req
, req
->dev
->unit_attention
);
318 } else if (req
->bus
->unit_attention
.key
== UNIT_ATTENTION
) {
319 scsi_req_build_sense(req
, req
->bus
->unit_attention
);
321 scsi_req_complete(req
, CHECK_CONDITION
);
325 static const struct SCSIReqOps reqops_unit_attention
= {
326 .size
= sizeof(SCSIRequest
),
327 .send_command
= scsi_unit_attention
330 /* SCSIReqOps implementation for REPORT LUNS and for commands sent to
333 typedef struct SCSITargetReq SCSITargetReq
;
335 struct SCSITargetReq
{
342 static void store_lun(uint8_t *outbuf
, int lun
)
348 outbuf
[1] = (lun
& 255);
349 outbuf
[0] = (lun
>> 8) | 0x40;
352 static bool scsi_target_emulate_report_luns(SCSITargetReq
*r
)
359 if (r
->req
.cmd
.xfer
< 16) {
362 if (r
->req
.cmd
.buf
[2] > 2) {
365 channel
= r
->req
.dev
->channel
;
369 QTAILQ_FOREACH(kid
, &r
->req
.bus
->qbus
.children
, sibling
) {
370 DeviceState
*qdev
= kid
->child
;
371 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
373 if (dev
->channel
== channel
&& dev
->id
== id
) {
384 scsi_target_alloc_buf(&r
->req
, n
+ 8);
386 len
= MIN(n
+ 8, r
->req
.cmd
.xfer
& ~7);
387 memset(r
->buf
, 0, len
);
388 stl_be_p(&r
->buf
[0], n
);
389 i
= found_lun0
? 8 : 16;
390 QTAILQ_FOREACH(kid
, &r
->req
.bus
->qbus
.children
, sibling
) {
391 DeviceState
*qdev
= kid
->child
;
392 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
394 if (dev
->channel
== channel
&& dev
->id
== id
) {
395 store_lun(&r
->buf
[i
], dev
->lun
);
404 static bool scsi_target_emulate_inquiry(SCSITargetReq
*r
)
406 assert(r
->req
.dev
->lun
!= r
->req
.lun
);
408 scsi_target_alloc_buf(&r
->req
, SCSI_INQUIRY_LEN
);
410 if (r
->req
.cmd
.buf
[1] & 0x2) {
411 /* Command support data - optional, not implemented */
415 if (r
->req
.cmd
.buf
[1] & 0x1) {
416 /* Vital product data */
417 uint8_t page_code
= r
->req
.cmd
.buf
[2];
418 r
->buf
[r
->len
++] = page_code
; /* this page */
419 r
->buf
[r
->len
++] = 0x00;
422 case 0x00: /* Supported page codes, mandatory */
426 r
->buf
[r
->len
++] = 0x00; /* list of supported pages (this page) */
427 r
->buf
[pages
] = r
->len
- pages
- 1; /* number of pages */
434 assert(r
->len
< r
->buf_len
);
435 r
->len
= MIN(r
->req
.cmd
.xfer
, r
->len
);
439 /* Standard INQUIRY data */
440 if (r
->req
.cmd
.buf
[2] != 0) {
445 r
->len
= MIN(r
->req
.cmd
.xfer
, SCSI_INQUIRY_LEN
);
446 memset(r
->buf
, 0, r
->len
);
447 if (r
->req
.lun
!= 0) {
448 r
->buf
[0] = TYPE_NO_LUN
;
450 r
->buf
[0] = TYPE_NOT_PRESENT
| TYPE_INACTIVE
;
451 r
->buf
[2] = 5; /* Version */
452 r
->buf
[3] = 2 | 0x10; /* HiSup, response data format */
453 r
->buf
[4] = r
->len
- 5; /* Additional Length = (Len - 1) - 4 */
454 r
->buf
[7] = 0x10 | (r
->req
.bus
->info
->tcq
? 0x02 : 0); /* Sync, TCQ. */
455 memcpy(&r
->buf
[8], "QEMU ", 8);
456 memcpy(&r
->buf
[16], "QEMU TARGET ", 16);
457 pstrcpy((char *) &r
->buf
[32], 4, qemu_hw_version());
462 static int32_t scsi_target_send_command(SCSIRequest
*req
, uint8_t *buf
)
464 SCSITargetReq
*r
= DO_UPCAST(SCSITargetReq
, req
, req
);
468 if (!scsi_target_emulate_report_luns(r
)) {
469 goto illegal_request
;
473 if (!scsi_target_emulate_inquiry(r
)) {
474 goto illegal_request
;
478 scsi_target_alloc_buf(&r
->req
, SCSI_SENSE_LEN
);
479 r
->len
= scsi_device_get_sense(r
->req
.dev
, r
->buf
,
480 MIN(req
->cmd
.xfer
, r
->buf_len
),
481 (req
->cmd
.buf
[1] & 1) == 0);
482 if (r
->req
.dev
->sense_is_ua
) {
483 scsi_device_unit_attention_reported(req
->dev
);
484 r
->req
.dev
->sense_len
= 0;
485 r
->req
.dev
->sense_is_ua
= false;
488 case TEST_UNIT_READY
:
491 scsi_req_build_sense(req
, SENSE_CODE(LUN_NOT_SUPPORTED
));
492 scsi_req_complete(req
, CHECK_CONDITION
);
495 scsi_req_build_sense(req
, SENSE_CODE(INVALID_FIELD
));
496 scsi_req_complete(req
, CHECK_CONDITION
);
501 scsi_req_complete(req
, GOOD
);
506 static void scsi_target_read_data(SCSIRequest
*req
)
508 SCSITargetReq
*r
= DO_UPCAST(SCSITargetReq
, req
, req
);
514 scsi_req_data(&r
->req
, n
);
516 scsi_req_complete(&r
->req
, GOOD
);
520 static uint8_t *scsi_target_get_buf(SCSIRequest
*req
)
522 SCSITargetReq
*r
= DO_UPCAST(SCSITargetReq
, req
, req
);
527 static uint8_t *scsi_target_alloc_buf(SCSIRequest
*req
, size_t len
)
529 SCSITargetReq
*r
= DO_UPCAST(SCSITargetReq
, req
, req
);
531 r
->buf
= g_malloc(len
);
537 static void scsi_target_free_buf(SCSIRequest
*req
)
539 SCSITargetReq
*r
= DO_UPCAST(SCSITargetReq
, req
, req
);
544 static const struct SCSIReqOps reqops_target_command
= {
545 .size
= sizeof(SCSITargetReq
),
546 .send_command
= scsi_target_send_command
,
547 .read_data
= scsi_target_read_data
,
548 .get_buf
= scsi_target_get_buf
,
549 .free_req
= scsi_target_free_buf
,
553 SCSIRequest
*scsi_req_alloc(const SCSIReqOps
*reqops
, SCSIDevice
*d
,
554 uint32_t tag
, uint32_t lun
, void *hba_private
)
557 SCSIBus
*bus
= scsi_bus_from_device(d
);
558 BusState
*qbus
= BUS(bus
);
559 const int memset_off
= offsetof(SCSIRequest
, sense
)
560 + sizeof(req
->sense
);
562 req
= g_malloc(reqops
->size
);
563 memset((uint8_t *)req
+ memset_off
, 0, reqops
->size
- memset_off
);
569 req
->hba_private
= hba_private
;
572 object_ref(OBJECT(d
));
573 object_ref(OBJECT(qbus
->parent
));
574 notifier_list_init(&req
->cancel_notifiers
);
575 trace_scsi_req_alloc(req
->dev
->id
, req
->lun
, req
->tag
);
579 SCSIRequest
*scsi_req_new(SCSIDevice
*d
, uint32_t tag
, uint32_t lun
,
580 uint8_t *buf
, void *hba_private
)
582 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, d
->qdev
.parent_bus
);
583 const SCSIReqOps
*ops
;
584 SCSIDeviceClass
*sc
= SCSI_DEVICE_GET_CLASS(d
);
586 SCSICommand cmd
= { .len
= 0 };
589 if ((d
->unit_attention
.key
== UNIT_ATTENTION
||
590 bus
->unit_attention
.key
== UNIT_ATTENTION
) &&
591 (buf
[0] != INQUIRY
&&
592 buf
[0] != REPORT_LUNS
&&
593 buf
[0] != GET_CONFIGURATION
&&
594 buf
[0] != GET_EVENT_STATUS_NOTIFICATION
&&
597 * If we already have a pending unit attention condition,
598 * report this one before triggering another one.
600 !(buf
[0] == REQUEST_SENSE
&& d
->sense_is_ua
))) {
601 ops
= &reqops_unit_attention
;
602 } else if (lun
!= d
->lun
||
603 buf
[0] == REPORT_LUNS
||
604 (buf
[0] == REQUEST_SENSE
&& d
->sense_len
)) {
605 ops
= &reqops_target_command
;
610 if (ops
!= NULL
|| !sc
->parse_cdb
) {
611 ret
= scsi_req_parse_cdb(d
, &cmd
, buf
);
613 ret
= sc
->parse_cdb(d
, &cmd
, buf
, hba_private
);
617 trace_scsi_req_parse_bad(d
->id
, lun
, tag
, buf
[0]);
618 req
= scsi_req_alloc(&reqops_invalid_opcode
, d
, tag
, lun
, hba_private
);
620 assert(cmd
.len
!= 0);
621 trace_scsi_req_parsed(d
->id
, lun
, tag
, buf
[0],
624 trace_scsi_req_parsed_lba(d
->id
, lun
, tag
, buf
[0],
628 if (cmd
.xfer
> INT32_MAX
) {
629 req
= scsi_req_alloc(&reqops_invalid_field
, d
, tag
, lun
, hba_private
);
631 req
= scsi_req_alloc(ops
, d
, tag
, lun
, hba_private
);
633 req
= scsi_device_alloc_req(d
, tag
, lun
, buf
, hba_private
);
638 req
->resid
= req
->cmd
.xfer
;
642 trace_scsi_inquiry(d
->id
, lun
, tag
, cmd
.buf
[1], cmd
.buf
[2]);
644 case TEST_UNIT_READY
:
645 trace_scsi_test_unit_ready(d
->id
, lun
, tag
);
648 trace_scsi_report_luns(d
->id
, lun
, tag
);
651 trace_scsi_request_sense(d
->id
, lun
, tag
);
660 uint8_t *scsi_req_get_buf(SCSIRequest
*req
)
662 return req
->ops
->get_buf(req
);
665 static void scsi_clear_unit_attention(SCSIRequest
*req
)
668 if (req
->dev
->unit_attention
.key
!= UNIT_ATTENTION
&&
669 req
->bus
->unit_attention
.key
!= UNIT_ATTENTION
) {
674 * If an INQUIRY command enters the enabled command state,
675 * the device server shall [not] clear any unit attention condition;
676 * See also MMC-6, paragraphs 6.5 and 6.6.2.
678 if (req
->cmd
.buf
[0] == INQUIRY
||
679 req
->cmd
.buf
[0] == GET_CONFIGURATION
||
680 req
->cmd
.buf
[0] == GET_EVENT_STATUS_NOTIFICATION
) {
684 if (req
->dev
->unit_attention
.key
== UNIT_ATTENTION
) {
685 ua
= &req
->dev
->unit_attention
;
687 ua
= &req
->bus
->unit_attention
;
691 * If a REPORT LUNS command enters the enabled command state, [...]
692 * the device server shall clear any pending unit attention condition
693 * with an additional sense code of REPORTED LUNS DATA HAS CHANGED.
695 if (req
->cmd
.buf
[0] == REPORT_LUNS
&&
696 !(ua
->asc
== SENSE_CODE(REPORTED_LUNS_CHANGED
).asc
&&
697 ua
->ascq
== SENSE_CODE(REPORTED_LUNS_CHANGED
).ascq
)) {
701 *ua
= SENSE_CODE(NO_SENSE
);
704 int scsi_req_get_sense(SCSIRequest
*req
, uint8_t *buf
, int len
)
709 if (!req
->sense_len
) {
713 ret
= scsi_build_sense(req
->sense
, req
->sense_len
, buf
, len
, true);
716 * FIXME: clearing unit attention conditions upon autosense should be done
717 * only if the UA_INTLCK_CTRL field in the Control mode page is set to 00b
720 * We assume UA_INTLCK_CTRL to be 00b for HBAs that support autosense, and
721 * 10b for HBAs that do not support it (do not call scsi_req_get_sense).
722 * Here we handle unit attention clearing for UA_INTLCK_CTRL == 00b.
724 if (req
->dev
->sense_is_ua
) {
725 scsi_device_unit_attention_reported(req
->dev
);
726 req
->dev
->sense_len
= 0;
727 req
->dev
->sense_is_ua
= false;
732 int scsi_device_get_sense(SCSIDevice
*dev
, uint8_t *buf
, int len
, bool fixed
)
734 return scsi_build_sense(dev
->sense
, dev
->sense_len
, buf
, len
, fixed
);
737 void scsi_req_build_sense(SCSIRequest
*req
, SCSISense sense
)
739 trace_scsi_req_build_sense(req
->dev
->id
, req
->lun
, req
->tag
,
740 sense
.key
, sense
.asc
, sense
.ascq
);
741 memset(req
->sense
, 0, 18);
742 req
->sense
[0] = 0x70;
743 req
->sense
[2] = sense
.key
;
745 req
->sense
[12] = sense
.asc
;
746 req
->sense
[13] = sense
.ascq
;
750 static void scsi_req_enqueue_internal(SCSIRequest
*req
)
752 assert(!req
->enqueued
);
754 if (req
->bus
->info
->get_sg_list
) {
755 req
->sg
= req
->bus
->info
->get_sg_list(req
);
759 req
->enqueued
= true;
760 QTAILQ_INSERT_TAIL(&req
->dev
->requests
, req
, next
);
763 int32_t scsi_req_enqueue(SCSIRequest
*req
)
768 scsi_req_enqueue_internal(req
);
770 rc
= req
->ops
->send_command(req
, req
->cmd
.buf
);
775 static void scsi_req_dequeue(SCSIRequest
*req
)
777 trace_scsi_req_dequeue(req
->dev
->id
, req
->lun
, req
->tag
);
780 QTAILQ_REMOVE(&req
->dev
->requests
, req
, next
);
781 req
->enqueued
= false;
786 static int scsi_get_performance_length(int num_desc
, int type
, int data_type
)
788 /* MMC-6, paragraph 6.7. */
791 if ((data_type
& 3) == 0) {
792 /* Each descriptor is as in Table 295 - Nominal performance. */
793 return 16 * num_desc
+ 8;
795 /* Each descriptor is as in Table 296 - Exceptions. */
796 return 6 * num_desc
+ 8;
801 return 8 * num_desc
+ 8;
803 return 2048 * num_desc
+ 8;
805 return 16 * num_desc
+ 8;
811 static int ata_passthrough_xfer_unit(SCSIDevice
*dev
, uint8_t *buf
)
813 int byte_block
= (buf
[2] >> 2) & 0x1;
814 int type
= (buf
[2] >> 4) & 0x1;
819 xfer_unit
= dev
->blocksize
;
830 static int ata_passthrough_12_xfer(SCSIDevice
*dev
, uint8_t *buf
)
832 int length
= buf
[2] & 0x3;
834 int unit
= ata_passthrough_xfer_unit(dev
, buf
);
838 case 3: /* USB-specific. */
853 static int ata_passthrough_16_xfer(SCSIDevice
*dev
, uint8_t *buf
)
855 int extend
= buf
[1] & 0x1;
856 int length
= buf
[2] & 0x3;
858 int unit
= ata_passthrough_xfer_unit(dev
, buf
);
862 case 3: /* USB-specific. */
868 xfer
|= (extend
? buf
[3] << 8 : 0);
872 xfer
|= (extend
? buf
[5] << 8 : 0);
879 uint32_t scsi_data_cdb_xfer(uint8_t *buf
)
881 if ((buf
[0] >> 5) == 0 && buf
[4] == 0) {
884 return scsi_cdb_xfer(buf
);
888 uint32_t scsi_cdb_xfer(uint8_t *buf
)
890 switch (buf
[0] >> 5) {
896 return lduw_be_p(&buf
[7]);
899 return ldl_be_p(&buf
[10]) & 0xffffffffULL
;
902 return ldl_be_p(&buf
[6]) & 0xffffffffULL
;
909 static int scsi_req_xfer(SCSICommand
*cmd
, SCSIDevice
*dev
, uint8_t *buf
)
911 cmd
->xfer
= scsi_cdb_xfer(buf
);
913 case TEST_UNIT_READY
:
917 case WRITE_FILEMARKS
:
918 case WRITE_FILEMARKS_16
:
923 case ALLOW_MEDIUM_REMOVAL
:
925 case SYNCHRONIZE_CACHE
:
926 case SYNCHRONIZE_CACHE_16
:
928 case LOCK_UNLOCK_CACHE
:
937 case ALLOW_OVERWRITE
:
943 if ((buf
[1] & 2) == 0) {
945 } else if ((buf
[1] & 4) != 0) {
948 cmd
->xfer
*= dev
->blocksize
;
954 cmd
->xfer
= dev
->blocksize
;
956 case READ_CAPACITY_10
:
959 case READ_BLOCK_LIMITS
:
962 case SEND_VOLUME_TAG
:
963 /* GPCMD_SET_STREAMING from multimedia commands. */
964 if (dev
->type
== TYPE_ROM
) {
965 cmd
->xfer
= buf
[10] | (buf
[9] << 8);
967 cmd
->xfer
= buf
[9] | (buf
[8] << 8);
971 /* length 0 means 256 blocks */
972 if (cmd
->xfer
== 0) {
977 case WRITE_VERIFY_10
:
979 case WRITE_VERIFY_12
:
981 case WRITE_VERIFY_16
:
982 cmd
->xfer
*= dev
->blocksize
;
986 /* length 0 means 256 blocks */
987 if (cmd
->xfer
== 0) {
992 case RECOVER_BUFFERED_DATA
:
995 cmd
->xfer
*= dev
->blocksize
;
998 /* MMC mandates the parameter list to be 12-bytes long. Parameters
999 * for block devices are restricted to the header right now. */
1000 if (dev
->type
== TYPE_ROM
&& (buf
[1] & 16)) {
1003 cmd
->xfer
= (buf
[1] & 16) == 0 ? 0 : (buf
[1] & 32 ? 8 : 4);
1007 case RECEIVE_DIAGNOSTIC
:
1008 case SEND_DIAGNOSTIC
:
1009 cmd
->xfer
= buf
[4] | (buf
[3] << 8);
1014 case SEND_CUE_SHEET
:
1015 cmd
->xfer
= buf
[8] | (buf
[7] << 8) | (buf
[6] << 16);
1017 case PERSISTENT_RESERVE_OUT
:
1018 cmd
->xfer
= ldl_be_p(&buf
[5]) & 0xffffffffULL
;
1021 if (dev
->type
== TYPE_ROM
) {
1022 /* MMC command GET PERFORMANCE. */
1023 cmd
->xfer
= scsi_get_performance_length(buf
[9] | (buf
[8] << 8),
1024 buf
[10], buf
[1] & 0x1f);
1027 case MECHANISM_STATUS
:
1028 case READ_DVD_STRUCTURE
:
1029 case SEND_DVD_STRUCTURE
:
1030 case MAINTENANCE_OUT
:
1031 case MAINTENANCE_IN
:
1032 if (dev
->type
== TYPE_ROM
) {
1033 /* GPCMD_REPORT_KEY and GPCMD_SEND_KEY from multi media commands */
1034 cmd
->xfer
= buf
[9] | (buf
[8] << 8);
1037 case ATA_PASSTHROUGH_12
:
1038 if (dev
->type
== TYPE_ROM
) {
1039 /* BLANK command of MMC */
1042 cmd
->xfer
= ata_passthrough_12_xfer(dev
, buf
);
1045 case ATA_PASSTHROUGH_16
:
1046 cmd
->xfer
= ata_passthrough_16_xfer(dev
, buf
);
1052 static int scsi_req_stream_xfer(SCSICommand
*cmd
, SCSIDevice
*dev
, uint8_t *buf
)
1055 /* stream commands */
1062 case RECOVER_BUFFERED_DATA
:
1064 cmd
->xfer
= buf
[4] | (buf
[3] << 8) | (buf
[2] << 16);
1065 if (buf
[1] & 0x01) { /* fixed */
1066 cmd
->xfer
*= dev
->blocksize
;
1070 case READ_REVERSE_16
:
1073 cmd
->xfer
= buf
[14] | (buf
[13] << 8) | (buf
[12] << 16);
1074 if (buf
[1] & 0x01) { /* fixed */
1075 cmd
->xfer
*= dev
->blocksize
;
1083 cmd
->xfer
= buf
[13] | (buf
[12] << 8);
1086 switch (buf
[1] & 0x1f) /* operation code */ {
1087 case SHORT_FORM_BLOCK_ID
:
1088 case SHORT_FORM_VENDOR_SPECIFIC
:
1095 cmd
->xfer
= buf
[8] | (buf
[7] << 8);
1103 cmd
->xfer
= buf
[4] | (buf
[3] << 8);
1105 /* generic commands */
1107 return scsi_req_xfer(cmd
, dev
, buf
);
1112 static int scsi_req_medium_changer_xfer(SCSICommand
*cmd
, SCSIDevice
*dev
, uint8_t *buf
)
1115 /* medium changer commands */
1116 case EXCHANGE_MEDIUM
:
1117 case INITIALIZE_ELEMENT_STATUS
:
1118 case INITIALIZE_ELEMENT_STATUS_WITH_RANGE
:
1120 case POSITION_TO_ELEMENT
:
1123 case READ_ELEMENT_STATUS
:
1124 cmd
->xfer
= buf
[9] | (buf
[8] << 8) | (buf
[7] << 16);
1127 /* generic commands */
1129 return scsi_req_xfer(cmd
, dev
, buf
);
1135 static void scsi_cmd_xfer_mode(SCSICommand
*cmd
)
1138 cmd
->mode
= SCSI_XFER_NONE
;
1141 switch (cmd
->buf
[0]) {
1144 case WRITE_VERIFY_10
:
1146 case WRITE_VERIFY_12
:
1148 case WRITE_VERIFY_16
:
1155 case CHANGE_DEFINITION
:
1158 case MODE_SELECT_10
:
1159 case SEND_DIAGNOSTIC
:
1162 case REASSIGN_BLOCKS
:
1171 case SEARCH_HIGH_12
:
1172 case SEARCH_EQUAL_12
:
1175 case SEND_VOLUME_TAG
:
1176 case SEND_CUE_SHEET
:
1177 case SEND_DVD_STRUCTURE
:
1178 case PERSISTENT_RESERVE_OUT
:
1179 case MAINTENANCE_OUT
:
1180 cmd
->mode
= SCSI_XFER_TO_DEV
;
1182 case ATA_PASSTHROUGH_12
:
1183 case ATA_PASSTHROUGH_16
:
1185 cmd
->mode
= (cmd
->buf
[2] & 0x8) ?
1186 SCSI_XFER_FROM_DEV
: SCSI_XFER_TO_DEV
;
1189 cmd
->mode
= SCSI_XFER_FROM_DEV
;
1194 static uint64_t scsi_cmd_lba(SCSICommand
*cmd
)
1196 uint8_t *buf
= cmd
->buf
;
1199 switch (buf
[0] >> 5) {
1201 lba
= ldl_be_p(&buf
[0]) & 0x1fffff;
1206 lba
= ldl_be_p(&buf
[2]) & 0xffffffffULL
;
1209 lba
= ldq_be_p(&buf
[2]);
1218 int scsi_cdb_length(uint8_t *buf
) {
1221 switch (buf
[0] >> 5) {
1241 int scsi_req_parse_cdb(SCSIDevice
*dev
, SCSICommand
*cmd
, uint8_t *buf
)
1247 len
= scsi_cdb_length(buf
);
1253 switch (dev
->type
) {
1255 rc
= scsi_req_stream_xfer(cmd
, dev
, buf
);
1257 case TYPE_MEDIUM_CHANGER
:
1258 rc
= scsi_req_medium_changer_xfer(cmd
, dev
, buf
);
1261 rc
= scsi_req_xfer(cmd
, dev
, buf
);
1268 memcpy(cmd
->buf
, buf
, cmd
->len
);
1269 scsi_cmd_xfer_mode(cmd
);
1270 cmd
->lba
= scsi_cmd_lba(cmd
);
1274 void scsi_device_report_change(SCSIDevice
*dev
, SCSISense sense
)
1276 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, dev
->qdev
.parent_bus
);
1278 scsi_device_set_ua(dev
, sense
);
1279 if (bus
->info
->change
) {
1280 bus
->info
->change(bus
, dev
, sense
);
1285 * Predefined sense codes
1288 /* No sense data available */
1289 const struct SCSISense sense_code_NO_SENSE
= {
1290 .key
= NO_SENSE
, .asc
= 0x00 , .ascq
= 0x00
1293 /* LUN not ready, Manual intervention required */
1294 const struct SCSISense sense_code_LUN_NOT_READY
= {
1295 .key
= NOT_READY
, .asc
= 0x04, .ascq
= 0x03
1298 /* LUN not ready, Medium not present */
1299 const struct SCSISense sense_code_NO_MEDIUM
= {
1300 .key
= NOT_READY
, .asc
= 0x3a, .ascq
= 0x00
1303 /* LUN not ready, medium removal prevented */
1304 const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED
= {
1305 .key
= NOT_READY
, .asc
= 0x53, .ascq
= 0x02
1308 /* Hardware error, internal target failure */
1309 const struct SCSISense sense_code_TARGET_FAILURE
= {
1310 .key
= HARDWARE_ERROR
, .asc
= 0x44, .ascq
= 0x00
1313 /* Illegal request, invalid command operation code */
1314 const struct SCSISense sense_code_INVALID_OPCODE
= {
1315 .key
= ILLEGAL_REQUEST
, .asc
= 0x20, .ascq
= 0x00
1318 /* Illegal request, LBA out of range */
1319 const struct SCSISense sense_code_LBA_OUT_OF_RANGE
= {
1320 .key
= ILLEGAL_REQUEST
, .asc
= 0x21, .ascq
= 0x00
1323 /* Illegal request, Invalid field in CDB */
1324 const struct SCSISense sense_code_INVALID_FIELD
= {
1325 .key
= ILLEGAL_REQUEST
, .asc
= 0x24, .ascq
= 0x00
1328 /* Illegal request, Invalid field in parameter list */
1329 const struct SCSISense sense_code_INVALID_PARAM
= {
1330 .key
= ILLEGAL_REQUEST
, .asc
= 0x26, .ascq
= 0x00
1333 /* Illegal request, Parameter list length error */
1334 const struct SCSISense sense_code_INVALID_PARAM_LEN
= {
1335 .key
= ILLEGAL_REQUEST
, .asc
= 0x1a, .ascq
= 0x00
1338 /* Illegal request, LUN not supported */
1339 const struct SCSISense sense_code_LUN_NOT_SUPPORTED
= {
1340 .key
= ILLEGAL_REQUEST
, .asc
= 0x25, .ascq
= 0x00
1343 /* Illegal request, Saving parameters not supported */
1344 const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED
= {
1345 .key
= ILLEGAL_REQUEST
, .asc
= 0x39, .ascq
= 0x00
1348 /* Illegal request, Incompatible medium installed */
1349 const struct SCSISense sense_code_INCOMPATIBLE_FORMAT
= {
1350 .key
= ILLEGAL_REQUEST
, .asc
= 0x30, .ascq
= 0x00
1353 /* Illegal request, medium removal prevented */
1354 const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED
= {
1355 .key
= ILLEGAL_REQUEST
, .asc
= 0x53, .ascq
= 0x02
1358 /* Illegal request, Invalid Transfer Tag */
1359 const struct SCSISense sense_code_INVALID_TAG
= {
1360 .key
= ILLEGAL_REQUEST
, .asc
= 0x4b, .ascq
= 0x01
1363 /* Command aborted, I/O process terminated */
1364 const struct SCSISense sense_code_IO_ERROR
= {
1365 .key
= ABORTED_COMMAND
, .asc
= 0x00, .ascq
= 0x06
1368 /* Command aborted, I_T Nexus loss occurred */
1369 const struct SCSISense sense_code_I_T_NEXUS_LOSS
= {
1370 .key
= ABORTED_COMMAND
, .asc
= 0x29, .ascq
= 0x07
1373 /* Command aborted, Logical Unit failure */
1374 const struct SCSISense sense_code_LUN_FAILURE
= {
1375 .key
= ABORTED_COMMAND
, .asc
= 0x3e, .ascq
= 0x01
1378 /* Command aborted, Overlapped Commands Attempted */
1379 const struct SCSISense sense_code_OVERLAPPED_COMMANDS
= {
1380 .key
= ABORTED_COMMAND
, .asc
= 0x4e, .ascq
= 0x00
1383 /* Unit attention, Capacity data has changed */
1384 const struct SCSISense sense_code_CAPACITY_CHANGED
= {
1385 .key
= UNIT_ATTENTION
, .asc
= 0x2a, .ascq
= 0x09
1388 /* Unit attention, Power on, reset or bus device reset occurred */
1389 const struct SCSISense sense_code_RESET
= {
1390 .key
= UNIT_ATTENTION
, .asc
= 0x29, .ascq
= 0x00
1393 /* Unit attention, No medium */
1394 const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM
= {
1395 .key
= UNIT_ATTENTION
, .asc
= 0x3a, .ascq
= 0x00
1398 /* Unit attention, Medium may have changed */
1399 const struct SCSISense sense_code_MEDIUM_CHANGED
= {
1400 .key
= UNIT_ATTENTION
, .asc
= 0x28, .ascq
= 0x00
1403 /* Unit attention, Reported LUNs data has changed */
1404 const struct SCSISense sense_code_REPORTED_LUNS_CHANGED
= {
1405 .key
= UNIT_ATTENTION
, .asc
= 0x3f, .ascq
= 0x0e
1408 /* Unit attention, Device internal reset */
1409 const struct SCSISense sense_code_DEVICE_INTERNAL_RESET
= {
1410 .key
= UNIT_ATTENTION
, .asc
= 0x29, .ascq
= 0x04
1413 /* Data Protection, Write Protected */
1414 const struct SCSISense sense_code_WRITE_PROTECTED
= {
1415 .key
= DATA_PROTECT
, .asc
= 0x27, .ascq
= 0x00
1418 /* Data Protection, Space Allocation Failed Write Protect */
1419 const struct SCSISense sense_code_SPACE_ALLOC_FAILED
= {
1420 .key
= DATA_PROTECT
, .asc
= 0x27, .ascq
= 0x07
1426 * Convert between fixed and descriptor sense buffers
1428 int scsi_build_sense(uint8_t *in_buf
, int in_len
,
1429 uint8_t *buf
, int len
, bool fixed
)
1433 if (!fixed
&& len
< 8) {
1438 sense
.key
= NO_SENSE
;
1442 fixed_in
= (in_buf
[0] & 2) == 0;
1444 if (fixed
== fixed_in
) {
1445 memcpy(buf
, in_buf
, MIN(len
, in_len
));
1446 return MIN(len
, in_len
);
1450 sense
.key
= in_buf
[2];
1451 sense
.asc
= in_buf
[12];
1452 sense
.ascq
= in_buf
[13];
1454 sense
.key
= in_buf
[1];
1455 sense
.asc
= in_buf
[2];
1456 sense
.ascq
= in_buf
[3];
1460 memset(buf
, 0, len
);
1462 /* Return fixed format sense buffer */
1466 buf
[12] = sense
.asc
;
1467 buf
[13] = sense
.ascq
;
1468 return MIN(len
, SCSI_SENSE_LEN
);
1470 /* Return descriptor format sense buffer */
1474 buf
[3] = sense
.ascq
;
1479 const char *scsi_command_name(uint8_t cmd
)
1481 static const char *names
[] = {
1482 [ TEST_UNIT_READY
] = "TEST_UNIT_READY",
1483 [ REWIND
] = "REWIND",
1484 [ REQUEST_SENSE
] = "REQUEST_SENSE",
1485 [ FORMAT_UNIT
] = "FORMAT_UNIT",
1486 [ READ_BLOCK_LIMITS
] = "READ_BLOCK_LIMITS",
1487 [ REASSIGN_BLOCKS
] = "REASSIGN_BLOCKS/INITIALIZE ELEMENT STATUS",
1488 /* LOAD_UNLOAD and INITIALIZE_ELEMENT_STATUS use the same operation code */
1489 [ READ_6
] = "READ_6",
1490 [ WRITE_6
] = "WRITE_6",
1491 [ SET_CAPACITY
] = "SET_CAPACITY",
1492 [ READ_REVERSE
] = "READ_REVERSE",
1493 [ WRITE_FILEMARKS
] = "WRITE_FILEMARKS",
1494 [ SPACE
] = "SPACE",
1495 [ INQUIRY
] = "INQUIRY",
1496 [ RECOVER_BUFFERED_DATA
] = "RECOVER_BUFFERED_DATA",
1497 [ MAINTENANCE_IN
] = "MAINTENANCE_IN",
1498 [ MAINTENANCE_OUT
] = "MAINTENANCE_OUT",
1499 [ MODE_SELECT
] = "MODE_SELECT",
1500 [ RESERVE
] = "RESERVE",
1501 [ RELEASE
] = "RELEASE",
1503 [ ERASE
] = "ERASE",
1504 [ MODE_SENSE
] = "MODE_SENSE",
1505 [ START_STOP
] = "START_STOP/LOAD_UNLOAD",
1506 /* LOAD_UNLOAD and START_STOP use the same operation code */
1507 [ RECEIVE_DIAGNOSTIC
] = "RECEIVE_DIAGNOSTIC",
1508 [ SEND_DIAGNOSTIC
] = "SEND_DIAGNOSTIC",
1509 [ ALLOW_MEDIUM_REMOVAL
] = "ALLOW_MEDIUM_REMOVAL",
1510 [ READ_CAPACITY_10
] = "READ_CAPACITY_10",
1511 [ READ_10
] = "READ_10",
1512 [ WRITE_10
] = "WRITE_10",
1513 [ SEEK_10
] = "SEEK_10/POSITION_TO_ELEMENT",
1514 /* SEEK_10 and POSITION_TO_ELEMENT use the same operation code */
1515 [ WRITE_VERIFY_10
] = "WRITE_VERIFY_10",
1516 [ VERIFY_10
] = "VERIFY_10",
1517 [ SEARCH_HIGH
] = "SEARCH_HIGH",
1518 [ SEARCH_EQUAL
] = "SEARCH_EQUAL",
1519 [ SEARCH_LOW
] = "SEARCH_LOW",
1520 [ SET_LIMITS
] = "SET_LIMITS",
1521 [ PRE_FETCH
] = "PRE_FETCH/READ_POSITION",
1522 /* READ_POSITION and PRE_FETCH use the same operation code */
1523 [ SYNCHRONIZE_CACHE
] = "SYNCHRONIZE_CACHE",
1524 [ LOCK_UNLOCK_CACHE
] = "LOCK_UNLOCK_CACHE",
1525 [ READ_DEFECT_DATA
] = "READ_DEFECT_DATA/INITIALIZE_ELEMENT_STATUS_WITH_RANGE",
1526 /* READ_DEFECT_DATA and INITIALIZE_ELEMENT_STATUS_WITH_RANGE use the same operation code */
1527 [ MEDIUM_SCAN
] = "MEDIUM_SCAN",
1528 [ COMPARE
] = "COMPARE",
1529 [ COPY_VERIFY
] = "COPY_VERIFY",
1530 [ WRITE_BUFFER
] = "WRITE_BUFFER",
1531 [ READ_BUFFER
] = "READ_BUFFER",
1532 [ UPDATE_BLOCK
] = "UPDATE_BLOCK",
1533 [ READ_LONG_10
] = "READ_LONG_10",
1534 [ WRITE_LONG_10
] = "WRITE_LONG_10",
1535 [ CHANGE_DEFINITION
] = "CHANGE_DEFINITION",
1536 [ WRITE_SAME_10
] = "WRITE_SAME_10",
1537 [ UNMAP
] = "UNMAP",
1538 [ READ_TOC
] = "READ_TOC",
1539 [ REPORT_DENSITY_SUPPORT
] = "REPORT_DENSITY_SUPPORT",
1540 [ SANITIZE
] = "SANITIZE",
1541 [ GET_CONFIGURATION
] = "GET_CONFIGURATION",
1542 [ LOG_SELECT
] = "LOG_SELECT",
1543 [ LOG_SENSE
] = "LOG_SENSE",
1544 [ MODE_SELECT_10
] = "MODE_SELECT_10",
1545 [ RESERVE_10
] = "RESERVE_10",
1546 [ RELEASE_10
] = "RELEASE_10",
1547 [ MODE_SENSE_10
] = "MODE_SENSE_10",
1548 [ PERSISTENT_RESERVE_IN
] = "PERSISTENT_RESERVE_IN",
1549 [ PERSISTENT_RESERVE_OUT
] = "PERSISTENT_RESERVE_OUT",
1550 [ WRITE_FILEMARKS_16
] = "WRITE_FILEMARKS_16",
1551 [ EXTENDED_COPY
] = "EXTENDED_COPY",
1552 [ ATA_PASSTHROUGH_16
] = "ATA_PASSTHROUGH_16",
1553 [ ACCESS_CONTROL_IN
] = "ACCESS_CONTROL_IN",
1554 [ ACCESS_CONTROL_OUT
] = "ACCESS_CONTROL_OUT",
1555 [ READ_16
] = "READ_16",
1556 [ COMPARE_AND_WRITE
] = "COMPARE_AND_WRITE",
1557 [ WRITE_16
] = "WRITE_16",
1558 [ WRITE_VERIFY_16
] = "WRITE_VERIFY_16",
1559 [ VERIFY_16
] = "VERIFY_16",
1560 [ PRE_FETCH_16
] = "PRE_FETCH_16",
1561 [ SYNCHRONIZE_CACHE_16
] = "SPACE_16/SYNCHRONIZE_CACHE_16",
1562 /* SPACE_16 and SYNCHRONIZE_CACHE_16 use the same operation code */
1563 [ LOCATE_16
] = "LOCATE_16",
1564 [ WRITE_SAME_16
] = "ERASE_16/WRITE_SAME_16",
1565 /* ERASE_16 and WRITE_SAME_16 use the same operation code */
1566 [ SERVICE_ACTION_IN_16
] = "SERVICE_ACTION_IN_16",
1567 [ WRITE_LONG_16
] = "WRITE_LONG_16",
1568 [ REPORT_LUNS
] = "REPORT_LUNS",
1569 [ ATA_PASSTHROUGH_12
] = "BLANK/ATA_PASSTHROUGH_12",
1570 [ MOVE_MEDIUM
] = "MOVE_MEDIUM",
1571 [ EXCHANGE_MEDIUM
] = "EXCHANGE MEDIUM",
1572 [ READ_12
] = "READ_12",
1573 [ WRITE_12
] = "WRITE_12",
1574 [ ERASE_12
] = "ERASE_12/GET_PERFORMANCE",
1575 /* ERASE_12 and GET_PERFORMANCE use the same operation code */
1576 [ SERVICE_ACTION_IN_12
] = "SERVICE_ACTION_IN_12",
1577 [ WRITE_VERIFY_12
] = "WRITE_VERIFY_12",
1578 [ VERIFY_12
] = "VERIFY_12",
1579 [ SEARCH_HIGH_12
] = "SEARCH_HIGH_12",
1580 [ SEARCH_EQUAL_12
] = "SEARCH_EQUAL_12",
1581 [ SEARCH_LOW_12
] = "SEARCH_LOW_12",
1582 [ READ_ELEMENT_STATUS
] = "READ_ELEMENT_STATUS",
1583 [ SEND_VOLUME_TAG
] = "SEND_VOLUME_TAG/SET_STREAMING",
1584 /* SEND_VOLUME_TAG and SET_STREAMING use the same operation code */
1585 [ READ_CD
] = "READ_CD",
1586 [ READ_DEFECT_DATA_12
] = "READ_DEFECT_DATA_12",
1587 [ READ_DVD_STRUCTURE
] = "READ_DVD_STRUCTURE",
1588 [ RESERVE_TRACK
] = "RESERVE_TRACK",
1589 [ SEND_CUE_SHEET
] = "SEND_CUE_SHEET",
1590 [ SEND_DVD_STRUCTURE
] = "SEND_DVD_STRUCTURE",
1591 [ SET_CD_SPEED
] = "SET_CD_SPEED",
1592 [ SET_READ_AHEAD
] = "SET_READ_AHEAD",
1593 [ ALLOW_OVERWRITE
] = "ALLOW_OVERWRITE",
1594 [ MECHANISM_STATUS
] = "MECHANISM_STATUS",
1595 [ GET_EVENT_STATUS_NOTIFICATION
] = "GET_EVENT_STATUS_NOTIFICATION",
1596 [ READ_DISC_INFORMATION
] = "READ_DISC_INFORMATION",
1599 if (cmd
>= ARRAY_SIZE(names
) || names
[cmd
] == NULL
)
1604 SCSIRequest
*scsi_req_ref(SCSIRequest
*req
)
1606 assert(req
->refcount
> 0);
1611 void scsi_req_unref(SCSIRequest
*req
)
1613 assert(req
->refcount
> 0);
1614 if (--req
->refcount
== 0) {
1615 BusState
*qbus
= req
->dev
->qdev
.parent_bus
;
1616 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, qbus
);
1618 if (bus
->info
->free_request
&& req
->hba_private
) {
1619 bus
->info
->free_request(bus
, req
->hba_private
);
1621 if (req
->ops
->free_req
) {
1622 req
->ops
->free_req(req
);
1624 object_unref(OBJECT(req
->dev
));
1625 object_unref(OBJECT(qbus
->parent
));
1630 /* Tell the device that we finished processing this chunk of I/O. It
1631 will start the next chunk or complete the command. */
1632 void scsi_req_continue(SCSIRequest
*req
)
1634 if (req
->io_canceled
) {
1635 trace_scsi_req_continue_canceled(req
->dev
->id
, req
->lun
, req
->tag
);
1638 trace_scsi_req_continue(req
->dev
->id
, req
->lun
, req
->tag
);
1639 if (req
->cmd
.mode
== SCSI_XFER_TO_DEV
) {
1640 req
->ops
->write_data(req
);
1642 req
->ops
->read_data(req
);
1646 /* Called by the devices when data is ready for the HBA. The HBA should
1647 start a DMA operation to read or fill the device's data buffer.
1648 Once it completes, calling scsi_req_continue will restart I/O. */
1649 void scsi_req_data(SCSIRequest
*req
, int len
)
1652 if (req
->io_canceled
) {
1653 trace_scsi_req_data_canceled(req
->dev
->id
, req
->lun
, req
->tag
, len
);
1656 trace_scsi_req_data(req
->dev
->id
, req
->lun
, req
->tag
, len
);
1657 assert(req
->cmd
.mode
!= SCSI_XFER_NONE
);
1660 req
->bus
->info
->transfer_data(req
, len
);
1664 /* If the device calls scsi_req_data and the HBA specified a
1665 * scatter/gather list, the transfer has to happen in a single
1667 assert(!req
->dma_started
);
1668 req
->dma_started
= true;
1670 buf
= scsi_req_get_buf(req
);
1671 if (req
->cmd
.mode
== SCSI_XFER_FROM_DEV
) {
1672 req
->resid
= dma_buf_read(buf
, len
, req
->sg
);
1674 req
->resid
= dma_buf_write(buf
, len
, req
->sg
);
1676 scsi_req_continue(req
);
1679 void scsi_req_print(SCSIRequest
*req
)
1684 fprintf(fp
, "[%s id=%d] %s",
1685 req
->dev
->qdev
.parent_bus
->name
,
1687 scsi_command_name(req
->cmd
.buf
[0]));
1688 for (i
= 1; i
< req
->cmd
.len
; i
++) {
1689 fprintf(fp
, " 0x%02x", req
->cmd
.buf
[i
]);
1691 switch (req
->cmd
.mode
) {
1692 case SCSI_XFER_NONE
:
1693 fprintf(fp
, " - none\n");
1695 case SCSI_XFER_FROM_DEV
:
1696 fprintf(fp
, " - from-dev len=%zd\n", req
->cmd
.xfer
);
1698 case SCSI_XFER_TO_DEV
:
1699 fprintf(fp
, " - to-dev len=%zd\n", req
->cmd
.xfer
);
1702 fprintf(fp
, " - Oops\n");
1707 void scsi_req_complete(SCSIRequest
*req
, int status
)
1709 assert(req
->status
== -1);
1710 req
->status
= status
;
1712 assert(req
->sense_len
<= sizeof(req
->sense
));
1713 if (status
== GOOD
) {
1717 if (req
->sense_len
) {
1718 memcpy(req
->dev
->sense
, req
->sense
, req
->sense_len
);
1719 req
->dev
->sense_len
= req
->sense_len
;
1720 req
->dev
->sense_is_ua
= (req
->ops
== &reqops_unit_attention
);
1722 req
->dev
->sense_len
= 0;
1723 req
->dev
->sense_is_ua
= false;
1727 * Unit attention state is now stored in the device's sense buffer
1728 * if the HBA didn't do autosense. Clear the pending unit attention
1731 scsi_clear_unit_attention(req
);
1734 scsi_req_dequeue(req
);
1735 req
->bus
->info
->complete(req
, req
->status
, req
->resid
);
1737 /* Cancelled requests might end up being completed instead of cancelled */
1738 notifier_list_notify(&req
->cancel_notifiers
, req
);
1739 scsi_req_unref(req
);
1742 /* Called by the devices when the request is canceled. */
1743 void scsi_req_cancel_complete(SCSIRequest
*req
)
1745 assert(req
->io_canceled
);
1746 if (req
->bus
->info
->cancel
) {
1747 req
->bus
->info
->cancel(req
);
1749 notifier_list_notify(&req
->cancel_notifiers
, req
);
1750 scsi_req_unref(req
);
1753 /* Cancel @req asynchronously. @notifier is added to @req's cancellation
1754 * notifier list, the bus will be notified the requests cancellation is
1757 void scsi_req_cancel_async(SCSIRequest
*req
, Notifier
*notifier
)
1759 trace_scsi_req_cancel(req
->dev
->id
, req
->lun
, req
->tag
);
1761 notifier_list_add(&req
->cancel_notifiers
, notifier
);
1763 if (req
->io_canceled
) {
1764 /* A blk_aio_cancel_async is pending; when it finishes,
1765 * scsi_req_cancel_complete will be called and will
1766 * call the notifier we just added. Just wait for that.
1771 /* Dropped in scsi_req_cancel_complete. */
1773 scsi_req_dequeue(req
);
1774 req
->io_canceled
= true;
1776 blk_aio_cancel_async(req
->aiocb
);
1778 scsi_req_cancel_complete(req
);
1782 void scsi_req_cancel(SCSIRequest
*req
)
1784 trace_scsi_req_cancel(req
->dev
->id
, req
->lun
, req
->tag
);
1785 if (!req
->enqueued
) {
1788 assert(!req
->io_canceled
);
1789 /* Dropped in scsi_req_cancel_complete. */
1791 scsi_req_dequeue(req
);
1792 req
->io_canceled
= true;
1794 blk_aio_cancel(req
->aiocb
);
1796 scsi_req_cancel_complete(req
);
1800 static int scsi_ua_precedence(SCSISense sense
)
1802 if (sense
.key
!= UNIT_ATTENTION
) {
1805 if (sense
.asc
== 0x29 && sense
.ascq
== 0x04) {
1806 /* DEVICE INTERNAL RESET goes with POWER ON OCCURRED */
1808 } else if (sense
.asc
== 0x3F && sense
.ascq
== 0x01) {
1809 /* MICROCODE HAS BEEN CHANGED goes with SCSI BUS RESET OCCURRED */
1811 } else if (sense
.asc
== 0x29 && (sense
.ascq
== 0x05 || sense
.ascq
== 0x06)) {
1812 /* These two go with "all others". */
1814 } else if (sense
.asc
== 0x29 && sense
.ascq
<= 0x07) {
1815 /* POWER ON, RESET OR BUS DEVICE RESET OCCURRED = 0
1816 * POWER ON OCCURRED = 1
1817 * SCSI BUS RESET OCCURRED = 2
1818 * BUS DEVICE RESET FUNCTION OCCURRED = 3
1819 * I_T NEXUS LOSS OCCURRED = 7
1822 } else if (sense
.asc
== 0x2F && sense
.ascq
== 0x01) {
1823 /* COMMANDS CLEARED BY POWER LOSS NOTIFICATION */
1826 return (sense
.asc
<< 8) | sense
.ascq
;
1829 void scsi_device_set_ua(SCSIDevice
*sdev
, SCSISense sense
)
1832 if (sense
.key
!= UNIT_ATTENTION
) {
1835 trace_scsi_device_set_ua(sdev
->id
, sdev
->lun
, sense
.key
,
1836 sense
.asc
, sense
.ascq
);
1839 * Override a pre-existing unit attention condition, except for a more
1840 * important reset condition.
1842 prec1
= scsi_ua_precedence(sdev
->unit_attention
);
1843 prec2
= scsi_ua_precedence(sense
);
1844 if (prec2
< prec1
) {
1845 sdev
->unit_attention
= sense
;
1849 void scsi_device_purge_requests(SCSIDevice
*sdev
, SCSISense sense
)
1853 aio_context_acquire(blk_get_aio_context(sdev
->conf
.blk
));
1854 while (!QTAILQ_EMPTY(&sdev
->requests
)) {
1855 req
= QTAILQ_FIRST(&sdev
->requests
);
1856 scsi_req_cancel_async(req
, NULL
);
1858 blk_drain(sdev
->conf
.blk
);
1859 aio_context_release(blk_get_aio_context(sdev
->conf
.blk
));
1860 scsi_device_set_ua(sdev
, sense
);
1863 static char *scsibus_get_dev_path(DeviceState
*dev
)
1865 SCSIDevice
*d
= SCSI_DEVICE(dev
);
1866 DeviceState
*hba
= dev
->parent_bus
->parent
;
1870 id
= qdev_get_dev_path(hba
);
1872 path
= g_strdup_printf("%s/%d:%d:%d", id
, d
->channel
, d
->id
, d
->lun
);
1874 path
= g_strdup_printf("%d:%d:%d", d
->channel
, d
->id
, d
->lun
);
1880 static char *scsibus_get_fw_dev_path(DeviceState
*dev
)
1882 SCSIDevice
*d
= SCSI_DEVICE(dev
);
1883 return g_strdup_printf("channel@%x/%s@%x,%x", d
->channel
,
1884 qdev_fw_name(dev
), d
->id
, d
->lun
);
1887 SCSIDevice
*scsi_device_find(SCSIBus
*bus
, int channel
, int id
, int lun
)
1890 SCSIDevice
*target_dev
= NULL
;
1892 QTAILQ_FOREACH_REVERSE(kid
, &bus
->qbus
.children
, ChildrenHead
, sibling
) {
1893 DeviceState
*qdev
= kid
->child
;
1894 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
1896 if (dev
->channel
== channel
&& dev
->id
== id
) {
1897 if (dev
->lun
== lun
) {
1906 /* SCSI request list. For simplicity, pv points to the whole device */
1908 static void put_scsi_requests(QEMUFile
*f
, void *pv
, size_t size
)
1911 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, s
->qdev
.parent_bus
);
1914 QTAILQ_FOREACH(req
, &s
->requests
, next
) {
1915 assert(!req
->io_canceled
);
1916 assert(req
->status
== -1);
1917 assert(req
->enqueued
);
1919 qemu_put_sbyte(f
, req
->retry
? 1 : 2);
1920 qemu_put_buffer(f
, req
->cmd
.buf
, sizeof(req
->cmd
.buf
));
1921 qemu_put_be32s(f
, &req
->tag
);
1922 qemu_put_be32s(f
, &req
->lun
);
1923 if (bus
->info
->save_request
) {
1924 bus
->info
->save_request(f
, req
);
1926 if (req
->ops
->save_request
) {
1927 req
->ops
->save_request(f
, req
);
1930 qemu_put_sbyte(f
, 0);
1933 static int get_scsi_requests(QEMUFile
*f
, void *pv
, size_t size
)
1936 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, s
->qdev
.parent_bus
);
1939 while ((sbyte
= qemu_get_sbyte(f
)) > 0) {
1940 uint8_t buf
[SCSI_CMD_BUF_SIZE
];
1945 qemu_get_buffer(f
, buf
, sizeof(buf
));
1946 qemu_get_be32s(f
, &tag
);
1947 qemu_get_be32s(f
, &lun
);
1948 req
= scsi_req_new(s
, tag
, lun
, buf
, NULL
);
1949 req
->retry
= (sbyte
== 1);
1950 if (bus
->info
->load_request
) {
1951 req
->hba_private
= bus
->info
->load_request(f
, req
);
1953 if (req
->ops
->load_request
) {
1954 req
->ops
->load_request(f
, req
);
1957 /* Just restart it later. */
1958 scsi_req_enqueue_internal(req
);
1960 /* At this point, the request will be kept alive by the reference
1961 * added by scsi_req_enqueue_internal, so we can release our reference.
1962 * The HBA of course will add its own reference in the load_request
1963 * callback if it needs to hold on the SCSIRequest.
1965 scsi_req_unref(req
);
1971 static const VMStateInfo vmstate_info_scsi_requests
= {
1972 .name
= "scsi-requests",
1973 .get
= get_scsi_requests
,
1974 .put
= put_scsi_requests
,
1977 static bool scsi_sense_state_needed(void *opaque
)
1979 SCSIDevice
*s
= opaque
;
1981 return s
->sense_len
> SCSI_SENSE_BUF_SIZE_OLD
;
1984 static const VMStateDescription vmstate_scsi_sense_state
= {
1985 .name
= "SCSIDevice/sense",
1987 .minimum_version_id
= 1,
1988 .needed
= scsi_sense_state_needed
,
1989 .fields
= (VMStateField
[]) {
1990 VMSTATE_UINT8_SUB_ARRAY(sense
, SCSIDevice
,
1991 SCSI_SENSE_BUF_SIZE_OLD
,
1992 SCSI_SENSE_BUF_SIZE
- SCSI_SENSE_BUF_SIZE_OLD
),
1993 VMSTATE_END_OF_LIST()
1997 const VMStateDescription vmstate_scsi_device
= {
1998 .name
= "SCSIDevice",
2000 .minimum_version_id
= 1,
2001 .fields
= (VMStateField
[]) {
2002 VMSTATE_UINT8(unit_attention
.key
, SCSIDevice
),
2003 VMSTATE_UINT8(unit_attention
.asc
, SCSIDevice
),
2004 VMSTATE_UINT8(unit_attention
.ascq
, SCSIDevice
),
2005 VMSTATE_BOOL(sense_is_ua
, SCSIDevice
),
2006 VMSTATE_UINT8_SUB_ARRAY(sense
, SCSIDevice
, 0, SCSI_SENSE_BUF_SIZE_OLD
),
2007 VMSTATE_UINT32(sense_len
, SCSIDevice
),
2011 .field_exists
= NULL
,
2012 .size
= 0, /* ouch */
2013 .info
= &vmstate_info_scsi_requests
,
2014 .flags
= VMS_SINGLE
,
2017 VMSTATE_END_OF_LIST()
2019 .subsections
= (const VMStateDescription
*[]) {
2020 &vmstate_scsi_sense_state
,
2025 static void scsi_device_class_init(ObjectClass
*klass
, void *data
)
2027 DeviceClass
*k
= DEVICE_CLASS(klass
);
2028 set_bit(DEVICE_CATEGORY_STORAGE
, k
->categories
);
2029 k
->bus_type
= TYPE_SCSI_BUS
;
2030 k
->realize
= scsi_qdev_realize
;
2031 k
->unrealize
= scsi_qdev_unrealize
;
2032 k
->props
= scsi_props
;
2035 static void scsi_dev_instance_init(Object
*obj
)
2037 DeviceState
*dev
= DEVICE(obj
);
2038 SCSIDevice
*s
= SCSI_DEVICE(dev
);
2040 device_add_bootindex_property(obj
, &s
->conf
.bootindex
,
2045 static const TypeInfo scsi_device_type_info
= {
2046 .name
= TYPE_SCSI_DEVICE
,
2047 .parent
= TYPE_DEVICE
,
2048 .instance_size
= sizeof(SCSIDevice
),
2050 .class_size
= sizeof(SCSIDeviceClass
),
2051 .class_init
= scsi_device_class_init
,
2052 .instance_init
= scsi_dev_instance_init
,
2055 static void scsi_register_types(void)
2057 type_register_static(&scsi_bus_info
);
2058 type_register_static(&scsi_device_type_info
);
2061 type_init(scsi_register_types
)