2 #include "qemu/error-report.h"
3 #include "hw/scsi/scsi.h"
4 #include "block/scsi.h"
6 #include "sysemu/block-backend.h"
7 #include "sysemu/blockdev.h"
9 #include "sysemu/dma.h"
11 static char *scsibus_get_dev_path(DeviceState
*dev
);
12 static char *scsibus_get_fw_dev_path(DeviceState
*dev
);
13 static void scsi_req_dequeue(SCSIRequest
*req
);
14 static uint8_t *scsi_target_alloc_buf(SCSIRequest
*req
, size_t len
);
15 static void scsi_target_free_buf(SCSIRequest
*req
);
17 static Property scsi_props
[] = {
18 DEFINE_PROP_UINT32("channel", SCSIDevice
, channel
, 0),
19 DEFINE_PROP_UINT32("scsi-id", SCSIDevice
, id
, -1),
20 DEFINE_PROP_UINT32("lun", SCSIDevice
, lun
, -1),
21 DEFINE_PROP_END_OF_LIST(),
24 static void scsi_bus_class_init(ObjectClass
*klass
, void *data
)
26 BusClass
*k
= BUS_CLASS(klass
);
27 HotplugHandlerClass
*hc
= HOTPLUG_HANDLER_CLASS(klass
);
29 k
->get_dev_path
= scsibus_get_dev_path
;
30 k
->get_fw_dev_path
= scsibus_get_fw_dev_path
;
31 hc
->unplug
= qdev_simple_device_unplug_cb
;
34 static const TypeInfo scsi_bus_info
= {
35 .name
= TYPE_SCSI_BUS
,
37 .instance_size
= sizeof(SCSIBus
),
38 .class_init
= scsi_bus_class_init
,
39 .interfaces
= (InterfaceInfo
[]) {
40 { TYPE_HOTPLUG_HANDLER
},
44 static int next_scsi_bus
;
46 static void scsi_device_realize(SCSIDevice
*s
, Error
**errp
)
48 SCSIDeviceClass
*sc
= SCSI_DEVICE_GET_CLASS(s
);
54 int scsi_bus_parse_cdb(SCSIDevice
*dev
, SCSICommand
*cmd
, uint8_t *buf
,
57 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, dev
->qdev
.parent_bus
);
60 assert(cmd
->len
== 0);
61 rc
= scsi_req_parse_cdb(dev
, cmd
, buf
);
62 if (bus
->info
->parse_cdb
) {
63 rc
= bus
->info
->parse_cdb(dev
, cmd
, buf
, hba_private
);
68 static SCSIRequest
*scsi_device_alloc_req(SCSIDevice
*s
, uint32_t tag
, uint32_t lun
,
69 uint8_t *buf
, void *hba_private
)
71 SCSIDeviceClass
*sc
= SCSI_DEVICE_GET_CLASS(s
);
73 return sc
->alloc_req(s
, tag
, lun
, buf
, hba_private
);
79 void scsi_device_unit_attention_reported(SCSIDevice
*s
)
81 SCSIDeviceClass
*sc
= SCSI_DEVICE_GET_CLASS(s
);
82 if (sc
->unit_attention_reported
) {
83 sc
->unit_attention_reported(s
);
87 /* Create a scsi bus, and attach devices to it. */
88 void scsi_bus_new(SCSIBus
*bus
, size_t bus_size
, DeviceState
*host
,
89 const SCSIBusInfo
*info
, const char *bus_name
)
91 qbus_create_inplace(bus
, bus_size
, TYPE_SCSI_BUS
, host
, bus_name
);
92 bus
->busnr
= next_scsi_bus
++;
94 qbus_set_bus_hotplug_handler(BUS(bus
), &error_abort
);
97 static void scsi_dma_restart_bh(void *opaque
)
99 SCSIDevice
*s
= opaque
;
100 SCSIRequest
*req
, *next
;
102 qemu_bh_delete(s
->bh
);
105 QTAILQ_FOREACH_SAFE(req
, &s
->requests
, next
, next
) {
109 switch (req
->cmd
.mode
) {
110 case SCSI_XFER_FROM_DEV
:
111 case SCSI_XFER_TO_DEV
:
112 scsi_req_continue(req
);
115 scsi_req_dequeue(req
);
116 scsi_req_enqueue(req
);
124 void scsi_req_retry(SCSIRequest
*req
)
126 /* No need to save a reference, because scsi_dma_restart_bh just
127 * looks at the request list. */
131 static void scsi_dma_restart_cb(void *opaque
, int running
, RunState state
)
133 SCSIDevice
*s
= opaque
;
139 AioContext
*ctx
= blk_get_aio_context(s
->conf
.blk
);
140 s
->bh
= aio_bh_new(ctx
, scsi_dma_restart_bh
, s
);
141 qemu_bh_schedule(s
->bh
);
145 static void scsi_qdev_realize(DeviceState
*qdev
, Error
**errp
)
147 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
148 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, dev
->qdev
.parent_bus
);
150 Error
*local_err
= NULL
;
152 if (dev
->channel
> bus
->info
->max_channel
) {
153 error_setg(errp
, "bad scsi channel id: %d", dev
->channel
);
156 if (dev
->id
!= -1 && dev
->id
> bus
->info
->max_target
) {
157 error_setg(errp
, "bad scsi device id: %d", dev
->id
);
160 if (dev
->lun
!= -1 && dev
->lun
> bus
->info
->max_lun
) {
161 error_setg(errp
, "bad scsi device lun: %d", dev
->lun
);
167 if (dev
->lun
== -1) {
171 d
= scsi_device_find(bus
, dev
->channel
, ++id
, dev
->lun
);
172 } while (d
&& d
->lun
== dev
->lun
&& id
< bus
->info
->max_target
);
173 if (d
&& d
->lun
== dev
->lun
) {
174 error_setg(errp
, "no free target");
178 } else if (dev
->lun
== -1) {
181 d
= scsi_device_find(bus
, dev
->channel
, dev
->id
, ++lun
);
182 } while (d
&& d
->lun
== lun
&& lun
< bus
->info
->max_lun
);
183 if (d
&& d
->lun
== lun
) {
184 error_setg(errp
, "no free lun");
189 d
= scsi_device_find(bus
, dev
->channel
, dev
->id
, dev
->lun
);
191 if (d
->lun
== dev
->lun
&& dev
!= d
) {
192 error_setg(errp
, "lun already used by '%s'", d
->qdev
.id
);
197 QTAILQ_INIT(&dev
->requests
);
198 scsi_device_realize(dev
, &local_err
);
200 error_propagate(errp
, local_err
);
203 dev
->vmsentry
= qemu_add_vm_change_state_handler(scsi_dma_restart_cb
,
207 static void scsi_qdev_unrealize(DeviceState
*qdev
, Error
**errp
)
209 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
212 qemu_del_vm_change_state_handler(dev
->vmsentry
);
215 scsi_device_purge_requests(dev
, SENSE_CODE(NO_SENSE
));
216 blockdev_mark_auto_del(dev
->conf
.blk
);
219 /* handle legacy '-drive if=scsi,...' cmd line args */
220 SCSIDevice
*scsi_bus_legacy_add_drive(SCSIBus
*bus
, BlockBackend
*blk
,
221 int unit
, bool removable
, int bootindex
,
222 const char *serial
, Error
**errp
)
229 driver
= blk_is_sg(blk
) ? "scsi-generic" : "scsi-disk";
230 dev
= qdev_create(&bus
->qbus
, driver
);
231 name
= g_strdup_printf("legacy[%d]", unit
);
232 object_property_add_child(OBJECT(bus
), name
, OBJECT(dev
), NULL
);
235 qdev_prop_set_uint32(dev
, "scsi-id", unit
);
236 if (bootindex
>= 0) {
237 object_property_set_int(OBJECT(dev
), bootindex
, "bootindex",
240 if (object_property_find(OBJECT(dev
), "removable", NULL
)) {
241 qdev_prop_set_bit(dev
, "removable", removable
);
243 if (serial
&& object_property_find(OBJECT(dev
), "serial", NULL
)) {
244 qdev_prop_set_string(dev
, "serial", serial
);
246 qdev_prop_set_drive(dev
, "drive", blk
, &err
);
248 error_propagate(errp
, err
);
249 object_unparent(OBJECT(dev
));
252 object_property_set_bool(OBJECT(dev
), true, "realized", &err
);
254 error_propagate(errp
, err
);
255 object_unparent(OBJECT(dev
));
258 return SCSI_DEVICE(dev
);
261 void scsi_bus_legacy_handle_cmdline(SCSIBus
*bus
, Error
**errp
)
269 for (unit
= 0; unit
<= bus
->info
->max_target
; unit
++) {
270 dinfo
= drive_get(IF_SCSI
, bus
->busnr
, unit
);
274 qemu_opts_loc_restore(dinfo
->opts
);
275 scsi_bus_legacy_add_drive(bus
, blk_by_legacy_dinfo(dinfo
),
276 unit
, false, -1, NULL
, &err
);
278 error_propagate(errp
, err
);
285 static int32_t scsi_invalid_field(SCSIRequest
*req
, uint8_t *buf
)
287 scsi_req_build_sense(req
, SENSE_CODE(INVALID_FIELD
));
288 scsi_req_complete(req
, CHECK_CONDITION
);
292 static const struct SCSIReqOps reqops_invalid_field
= {
293 .size
= sizeof(SCSIRequest
),
294 .send_command
= scsi_invalid_field
297 /* SCSIReqOps implementation for invalid commands. */
299 static int32_t scsi_invalid_command(SCSIRequest
*req
, uint8_t *buf
)
301 scsi_req_build_sense(req
, SENSE_CODE(INVALID_OPCODE
));
302 scsi_req_complete(req
, CHECK_CONDITION
);
306 static const struct SCSIReqOps reqops_invalid_opcode
= {
307 .size
= sizeof(SCSIRequest
),
308 .send_command
= scsi_invalid_command
311 /* SCSIReqOps implementation for unit attention conditions. */
313 static int32_t scsi_unit_attention(SCSIRequest
*req
, uint8_t *buf
)
315 if (req
->dev
->unit_attention
.key
== UNIT_ATTENTION
) {
316 scsi_req_build_sense(req
, req
->dev
->unit_attention
);
317 } else if (req
->bus
->unit_attention
.key
== UNIT_ATTENTION
) {
318 scsi_req_build_sense(req
, req
->bus
->unit_attention
);
320 scsi_req_complete(req
, CHECK_CONDITION
);
324 static const struct SCSIReqOps reqops_unit_attention
= {
325 .size
= sizeof(SCSIRequest
),
326 .send_command
= scsi_unit_attention
329 /* SCSIReqOps implementation for REPORT LUNS and for commands sent to
332 typedef struct SCSITargetReq SCSITargetReq
;
334 struct SCSITargetReq
{
341 static void store_lun(uint8_t *outbuf
, int lun
)
347 outbuf
[1] = (lun
& 255);
348 outbuf
[0] = (lun
>> 8) | 0x40;
351 static bool scsi_target_emulate_report_luns(SCSITargetReq
*r
)
358 if (r
->req
.cmd
.xfer
< 16) {
361 if (r
->req
.cmd
.buf
[2] > 2) {
364 channel
= r
->req
.dev
->channel
;
368 QTAILQ_FOREACH(kid
, &r
->req
.bus
->qbus
.children
, sibling
) {
369 DeviceState
*qdev
= kid
->child
;
370 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
372 if (dev
->channel
== channel
&& dev
->id
== id
) {
383 scsi_target_alloc_buf(&r
->req
, n
+ 8);
385 len
= MIN(n
+ 8, r
->req
.cmd
.xfer
& ~7);
386 memset(r
->buf
, 0, len
);
387 stl_be_p(&r
->buf
[0], n
);
388 i
= found_lun0
? 8 : 16;
389 QTAILQ_FOREACH(kid
, &r
->req
.bus
->qbus
.children
, sibling
) {
390 DeviceState
*qdev
= kid
->child
;
391 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
393 if (dev
->channel
== channel
&& dev
->id
== id
) {
394 store_lun(&r
->buf
[i
], dev
->lun
);
403 static bool scsi_target_emulate_inquiry(SCSITargetReq
*r
)
405 assert(r
->req
.dev
->lun
!= r
->req
.lun
);
407 scsi_target_alloc_buf(&r
->req
, SCSI_INQUIRY_LEN
);
409 if (r
->req
.cmd
.buf
[1] & 0x2) {
410 /* Command support data - optional, not implemented */
414 if (r
->req
.cmd
.buf
[1] & 0x1) {
415 /* Vital product data */
416 uint8_t page_code
= r
->req
.cmd
.buf
[2];
417 r
->buf
[r
->len
++] = page_code
; /* this page */
418 r
->buf
[r
->len
++] = 0x00;
421 case 0x00: /* Supported page codes, mandatory */
425 r
->buf
[r
->len
++] = 0x00; /* list of supported pages (this page) */
426 r
->buf
[pages
] = r
->len
- pages
- 1; /* number of pages */
433 assert(r
->len
< r
->buf_len
);
434 r
->len
= MIN(r
->req
.cmd
.xfer
, r
->len
);
438 /* Standard INQUIRY data */
439 if (r
->req
.cmd
.buf
[2] != 0) {
444 r
->len
= MIN(r
->req
.cmd
.xfer
, SCSI_INQUIRY_LEN
);
445 memset(r
->buf
, 0, r
->len
);
446 if (r
->req
.lun
!= 0) {
447 r
->buf
[0] = TYPE_NO_LUN
;
449 r
->buf
[0] = TYPE_NOT_PRESENT
| TYPE_INACTIVE
;
450 r
->buf
[2] = 5; /* Version */
451 r
->buf
[3] = 2 | 0x10; /* HiSup, response data format */
452 r
->buf
[4] = r
->len
- 5; /* Additional Length = (Len - 1) - 4 */
453 r
->buf
[7] = 0x10 | (r
->req
.bus
->info
->tcq
? 0x02 : 0); /* Sync, TCQ. */
454 memcpy(&r
->buf
[8], "QEMU ", 8);
455 memcpy(&r
->buf
[16], "QEMU TARGET ", 16);
456 pstrcpy((char *) &r
->buf
[32], 4, qemu_hw_version());
461 static int32_t scsi_target_send_command(SCSIRequest
*req
, uint8_t *buf
)
463 SCSITargetReq
*r
= DO_UPCAST(SCSITargetReq
, req
, req
);
467 if (!scsi_target_emulate_report_luns(r
)) {
468 goto illegal_request
;
472 if (!scsi_target_emulate_inquiry(r
)) {
473 goto illegal_request
;
477 scsi_target_alloc_buf(&r
->req
, SCSI_SENSE_LEN
);
478 r
->len
= scsi_device_get_sense(r
->req
.dev
, r
->buf
,
479 MIN(req
->cmd
.xfer
, r
->buf_len
),
480 (req
->cmd
.buf
[1] & 1) == 0);
481 if (r
->req
.dev
->sense_is_ua
) {
482 scsi_device_unit_attention_reported(req
->dev
);
483 r
->req
.dev
->sense_len
= 0;
484 r
->req
.dev
->sense_is_ua
= false;
487 case TEST_UNIT_READY
:
490 scsi_req_build_sense(req
, SENSE_CODE(LUN_NOT_SUPPORTED
));
491 scsi_req_complete(req
, CHECK_CONDITION
);
494 scsi_req_build_sense(req
, SENSE_CODE(INVALID_FIELD
));
495 scsi_req_complete(req
, CHECK_CONDITION
);
500 scsi_req_complete(req
, GOOD
);
505 static void scsi_target_read_data(SCSIRequest
*req
)
507 SCSITargetReq
*r
= DO_UPCAST(SCSITargetReq
, req
, req
);
513 scsi_req_data(&r
->req
, n
);
515 scsi_req_complete(&r
->req
, GOOD
);
519 static uint8_t *scsi_target_get_buf(SCSIRequest
*req
)
521 SCSITargetReq
*r
= DO_UPCAST(SCSITargetReq
, req
, req
);
526 static uint8_t *scsi_target_alloc_buf(SCSIRequest
*req
, size_t len
)
528 SCSITargetReq
*r
= DO_UPCAST(SCSITargetReq
, req
, req
);
530 r
->buf
= g_malloc(len
);
536 static void scsi_target_free_buf(SCSIRequest
*req
)
538 SCSITargetReq
*r
= DO_UPCAST(SCSITargetReq
, req
, req
);
543 static const struct SCSIReqOps reqops_target_command
= {
544 .size
= sizeof(SCSITargetReq
),
545 .send_command
= scsi_target_send_command
,
546 .read_data
= scsi_target_read_data
,
547 .get_buf
= scsi_target_get_buf
,
548 .free_req
= scsi_target_free_buf
,
552 SCSIRequest
*scsi_req_alloc(const SCSIReqOps
*reqops
, SCSIDevice
*d
,
553 uint32_t tag
, uint32_t lun
, void *hba_private
)
556 SCSIBus
*bus
= scsi_bus_from_device(d
);
557 BusState
*qbus
= BUS(bus
);
558 const int memset_off
= offsetof(SCSIRequest
, sense
)
559 + sizeof(req
->sense
);
561 req
= g_malloc(reqops
->size
);
562 memset((uint8_t *)req
+ memset_off
, 0, reqops
->size
- memset_off
);
568 req
->hba_private
= hba_private
;
571 object_ref(OBJECT(d
));
572 object_ref(OBJECT(qbus
->parent
));
573 notifier_list_init(&req
->cancel_notifiers
);
574 trace_scsi_req_alloc(req
->dev
->id
, req
->lun
, req
->tag
);
578 SCSIRequest
*scsi_req_new(SCSIDevice
*d
, uint32_t tag
, uint32_t lun
,
579 uint8_t *buf
, void *hba_private
)
581 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, d
->qdev
.parent_bus
);
582 const SCSIReqOps
*ops
;
583 SCSIDeviceClass
*sc
= SCSI_DEVICE_GET_CLASS(d
);
585 SCSICommand cmd
= { .len
= 0 };
588 if ((d
->unit_attention
.key
== UNIT_ATTENTION
||
589 bus
->unit_attention
.key
== UNIT_ATTENTION
) &&
590 (buf
[0] != INQUIRY
&&
591 buf
[0] != REPORT_LUNS
&&
592 buf
[0] != GET_CONFIGURATION
&&
593 buf
[0] != GET_EVENT_STATUS_NOTIFICATION
&&
596 * If we already have a pending unit attention condition,
597 * report this one before triggering another one.
599 !(buf
[0] == REQUEST_SENSE
&& d
->sense_is_ua
))) {
600 ops
= &reqops_unit_attention
;
601 } else if (lun
!= d
->lun
||
602 buf
[0] == REPORT_LUNS
||
603 (buf
[0] == REQUEST_SENSE
&& d
->sense_len
)) {
604 ops
= &reqops_target_command
;
609 if (ops
!= NULL
|| !sc
->parse_cdb
) {
610 ret
= scsi_req_parse_cdb(d
, &cmd
, buf
);
612 ret
= sc
->parse_cdb(d
, &cmd
, buf
, hba_private
);
616 trace_scsi_req_parse_bad(d
->id
, lun
, tag
, buf
[0]);
617 req
= scsi_req_alloc(&reqops_invalid_opcode
, d
, tag
, lun
, hba_private
);
619 assert(cmd
.len
!= 0);
620 trace_scsi_req_parsed(d
->id
, lun
, tag
, buf
[0],
623 trace_scsi_req_parsed_lba(d
->id
, lun
, tag
, buf
[0],
627 if (cmd
.xfer
> INT32_MAX
) {
628 req
= scsi_req_alloc(&reqops_invalid_field
, d
, tag
, lun
, hba_private
);
630 req
= scsi_req_alloc(ops
, d
, tag
, lun
, hba_private
);
632 req
= scsi_device_alloc_req(d
, tag
, lun
, buf
, hba_private
);
637 req
->resid
= req
->cmd
.xfer
;
641 trace_scsi_inquiry(d
->id
, lun
, tag
, cmd
.buf
[1], cmd
.buf
[2]);
643 case TEST_UNIT_READY
:
644 trace_scsi_test_unit_ready(d
->id
, lun
, tag
);
647 trace_scsi_report_luns(d
->id
, lun
, tag
);
650 trace_scsi_request_sense(d
->id
, lun
, tag
);
659 uint8_t *scsi_req_get_buf(SCSIRequest
*req
)
661 return req
->ops
->get_buf(req
);
664 static void scsi_clear_unit_attention(SCSIRequest
*req
)
667 if (req
->dev
->unit_attention
.key
!= UNIT_ATTENTION
&&
668 req
->bus
->unit_attention
.key
!= UNIT_ATTENTION
) {
673 * If an INQUIRY command enters the enabled command state,
674 * the device server shall [not] clear any unit attention condition;
675 * See also MMC-6, paragraphs 6.5 and 6.6.2.
677 if (req
->cmd
.buf
[0] == INQUIRY
||
678 req
->cmd
.buf
[0] == GET_CONFIGURATION
||
679 req
->cmd
.buf
[0] == GET_EVENT_STATUS_NOTIFICATION
) {
683 if (req
->dev
->unit_attention
.key
== UNIT_ATTENTION
) {
684 ua
= &req
->dev
->unit_attention
;
686 ua
= &req
->bus
->unit_attention
;
690 * If a REPORT LUNS command enters the enabled command state, [...]
691 * the device server shall clear any pending unit attention condition
692 * with an additional sense code of REPORTED LUNS DATA HAS CHANGED.
694 if (req
->cmd
.buf
[0] == REPORT_LUNS
&&
695 !(ua
->asc
== SENSE_CODE(REPORTED_LUNS_CHANGED
).asc
&&
696 ua
->ascq
== SENSE_CODE(REPORTED_LUNS_CHANGED
).ascq
)) {
700 *ua
= SENSE_CODE(NO_SENSE
);
703 int scsi_req_get_sense(SCSIRequest
*req
, uint8_t *buf
, int len
)
708 if (!req
->sense_len
) {
712 ret
= scsi_build_sense(req
->sense
, req
->sense_len
, buf
, len
, true);
715 * FIXME: clearing unit attention conditions upon autosense should be done
716 * only if the UA_INTLCK_CTRL field in the Control mode page is set to 00b
719 * We assume UA_INTLCK_CTRL to be 00b for HBAs that support autosense, and
720 * 10b for HBAs that do not support it (do not call scsi_req_get_sense).
721 * Here we handle unit attention clearing for UA_INTLCK_CTRL == 00b.
723 if (req
->dev
->sense_is_ua
) {
724 scsi_device_unit_attention_reported(req
->dev
);
725 req
->dev
->sense_len
= 0;
726 req
->dev
->sense_is_ua
= false;
731 int scsi_device_get_sense(SCSIDevice
*dev
, uint8_t *buf
, int len
, bool fixed
)
733 return scsi_build_sense(dev
->sense
, dev
->sense_len
, buf
, len
, fixed
);
736 void scsi_req_build_sense(SCSIRequest
*req
, SCSISense sense
)
738 trace_scsi_req_build_sense(req
->dev
->id
, req
->lun
, req
->tag
,
739 sense
.key
, sense
.asc
, sense
.ascq
);
740 memset(req
->sense
, 0, 18);
741 req
->sense
[0] = 0x70;
742 req
->sense
[2] = sense
.key
;
744 req
->sense
[12] = sense
.asc
;
745 req
->sense
[13] = sense
.ascq
;
749 static void scsi_req_enqueue_internal(SCSIRequest
*req
)
751 assert(!req
->enqueued
);
753 if (req
->bus
->info
->get_sg_list
) {
754 req
->sg
= req
->bus
->info
->get_sg_list(req
);
758 req
->enqueued
= true;
759 QTAILQ_INSERT_TAIL(&req
->dev
->requests
, req
, next
);
762 int32_t scsi_req_enqueue(SCSIRequest
*req
)
767 scsi_req_enqueue_internal(req
);
769 rc
= req
->ops
->send_command(req
, req
->cmd
.buf
);
774 static void scsi_req_dequeue(SCSIRequest
*req
)
776 trace_scsi_req_dequeue(req
->dev
->id
, req
->lun
, req
->tag
);
779 QTAILQ_REMOVE(&req
->dev
->requests
, req
, next
);
780 req
->enqueued
= false;
785 static int scsi_get_performance_length(int num_desc
, int type
, int data_type
)
787 /* MMC-6, paragraph 6.7. */
790 if ((data_type
& 3) == 0) {
791 /* Each descriptor is as in Table 295 - Nominal performance. */
792 return 16 * num_desc
+ 8;
794 /* Each descriptor is as in Table 296 - Exceptions. */
795 return 6 * num_desc
+ 8;
800 return 8 * num_desc
+ 8;
802 return 2048 * num_desc
+ 8;
804 return 16 * num_desc
+ 8;
810 static int ata_passthrough_xfer_unit(SCSIDevice
*dev
, uint8_t *buf
)
812 int byte_block
= (buf
[2] >> 2) & 0x1;
813 int type
= (buf
[2] >> 4) & 0x1;
818 xfer_unit
= dev
->blocksize
;
829 static int ata_passthrough_12_xfer(SCSIDevice
*dev
, uint8_t *buf
)
831 int length
= buf
[2] & 0x3;
833 int unit
= ata_passthrough_xfer_unit(dev
, buf
);
837 case 3: /* USB-specific. */
852 static int ata_passthrough_16_xfer(SCSIDevice
*dev
, uint8_t *buf
)
854 int extend
= buf
[1] & 0x1;
855 int length
= buf
[2] & 0x3;
857 int unit
= ata_passthrough_xfer_unit(dev
, buf
);
861 case 3: /* USB-specific. */
867 xfer
|= (extend
? buf
[3] << 8 : 0);
871 xfer
|= (extend
? buf
[5] << 8 : 0);
878 uint32_t scsi_data_cdb_xfer(uint8_t *buf
)
880 if ((buf
[0] >> 5) == 0 && buf
[4] == 0) {
883 return scsi_cdb_xfer(buf
);
887 uint32_t scsi_cdb_xfer(uint8_t *buf
)
889 switch (buf
[0] >> 5) {
895 return lduw_be_p(&buf
[7]);
898 return ldl_be_p(&buf
[10]) & 0xffffffffULL
;
901 return ldl_be_p(&buf
[6]) & 0xffffffffULL
;
908 static int scsi_req_xfer(SCSICommand
*cmd
, SCSIDevice
*dev
, uint8_t *buf
)
910 cmd
->xfer
= scsi_cdb_xfer(buf
);
912 case TEST_UNIT_READY
:
916 case WRITE_FILEMARKS
:
917 case WRITE_FILEMARKS_16
:
922 case ALLOW_MEDIUM_REMOVAL
:
924 case SYNCHRONIZE_CACHE
:
925 case SYNCHRONIZE_CACHE_16
:
927 case LOCK_UNLOCK_CACHE
:
936 case ALLOW_OVERWRITE
:
942 if ((buf
[1] & 2) == 0) {
944 } else if ((buf
[1] & 4) != 0) {
947 cmd
->xfer
*= dev
->blocksize
;
953 cmd
->xfer
= dev
->blocksize
;
955 case READ_CAPACITY_10
:
958 case READ_BLOCK_LIMITS
:
961 case SEND_VOLUME_TAG
:
962 /* GPCMD_SET_STREAMING from multimedia commands. */
963 if (dev
->type
== TYPE_ROM
) {
964 cmd
->xfer
= buf
[10] | (buf
[9] << 8);
966 cmd
->xfer
= buf
[9] | (buf
[8] << 8);
970 /* length 0 means 256 blocks */
971 if (cmd
->xfer
== 0) {
976 case WRITE_VERIFY_10
:
978 case WRITE_VERIFY_12
:
980 case WRITE_VERIFY_16
:
981 cmd
->xfer
*= dev
->blocksize
;
985 /* length 0 means 256 blocks */
986 if (cmd
->xfer
== 0) {
991 case RECOVER_BUFFERED_DATA
:
994 cmd
->xfer
*= dev
->blocksize
;
997 /* MMC mandates the parameter list to be 12-bytes long. Parameters
998 * for block devices are restricted to the header right now. */
999 if (dev
->type
== TYPE_ROM
&& (buf
[1] & 16)) {
1002 cmd
->xfer
= (buf
[1] & 16) == 0 ? 0 : (buf
[1] & 32 ? 8 : 4);
1006 case RECEIVE_DIAGNOSTIC
:
1007 case SEND_DIAGNOSTIC
:
1008 cmd
->xfer
= buf
[4] | (buf
[3] << 8);
1013 case SEND_CUE_SHEET
:
1014 cmd
->xfer
= buf
[8] | (buf
[7] << 8) | (buf
[6] << 16);
1016 case PERSISTENT_RESERVE_OUT
:
1017 cmd
->xfer
= ldl_be_p(&buf
[5]) & 0xffffffffULL
;
1020 if (dev
->type
== TYPE_ROM
) {
1021 /* MMC command GET PERFORMANCE. */
1022 cmd
->xfer
= scsi_get_performance_length(buf
[9] | (buf
[8] << 8),
1023 buf
[10], buf
[1] & 0x1f);
1026 case MECHANISM_STATUS
:
1027 case READ_DVD_STRUCTURE
:
1028 case SEND_DVD_STRUCTURE
:
1029 case MAINTENANCE_OUT
:
1030 case MAINTENANCE_IN
:
1031 if (dev
->type
== TYPE_ROM
) {
1032 /* GPCMD_REPORT_KEY and GPCMD_SEND_KEY from multi media commands */
1033 cmd
->xfer
= buf
[9] | (buf
[8] << 8);
1036 case ATA_PASSTHROUGH_12
:
1037 if (dev
->type
== TYPE_ROM
) {
1038 /* BLANK command of MMC */
1041 cmd
->xfer
= ata_passthrough_12_xfer(dev
, buf
);
1044 case ATA_PASSTHROUGH_16
:
1045 cmd
->xfer
= ata_passthrough_16_xfer(dev
, buf
);
1051 static int scsi_req_stream_xfer(SCSICommand
*cmd
, SCSIDevice
*dev
, uint8_t *buf
)
1054 /* stream commands */
1061 case RECOVER_BUFFERED_DATA
:
1063 cmd
->xfer
= buf
[4] | (buf
[3] << 8) | (buf
[2] << 16);
1064 if (buf
[1] & 0x01) { /* fixed */
1065 cmd
->xfer
*= dev
->blocksize
;
1069 case READ_REVERSE_16
:
1072 cmd
->xfer
= buf
[14] | (buf
[13] << 8) | (buf
[12] << 16);
1073 if (buf
[1] & 0x01) { /* fixed */
1074 cmd
->xfer
*= dev
->blocksize
;
1082 cmd
->xfer
= buf
[13] | (buf
[12] << 8);
1085 switch (buf
[1] & 0x1f) /* operation code */ {
1086 case SHORT_FORM_BLOCK_ID
:
1087 case SHORT_FORM_VENDOR_SPECIFIC
:
1094 cmd
->xfer
= buf
[8] | (buf
[7] << 8);
1102 cmd
->xfer
= buf
[4] | (buf
[3] << 8);
1104 /* generic commands */
1106 return scsi_req_xfer(cmd
, dev
, buf
);
1111 static int scsi_req_medium_changer_xfer(SCSICommand
*cmd
, SCSIDevice
*dev
, uint8_t *buf
)
1114 /* medium changer commands */
1115 case EXCHANGE_MEDIUM
:
1116 case INITIALIZE_ELEMENT_STATUS
:
1117 case INITIALIZE_ELEMENT_STATUS_WITH_RANGE
:
1119 case POSITION_TO_ELEMENT
:
1122 case READ_ELEMENT_STATUS
:
1123 cmd
->xfer
= buf
[9] | (buf
[8] << 8) | (buf
[7] << 16);
1126 /* generic commands */
1128 return scsi_req_xfer(cmd
, dev
, buf
);
1134 static void scsi_cmd_xfer_mode(SCSICommand
*cmd
)
1137 cmd
->mode
= SCSI_XFER_NONE
;
1140 switch (cmd
->buf
[0]) {
1143 case WRITE_VERIFY_10
:
1145 case WRITE_VERIFY_12
:
1147 case WRITE_VERIFY_16
:
1154 case CHANGE_DEFINITION
:
1157 case MODE_SELECT_10
:
1158 case SEND_DIAGNOSTIC
:
1161 case REASSIGN_BLOCKS
:
1170 case SEARCH_HIGH_12
:
1171 case SEARCH_EQUAL_12
:
1174 case SEND_VOLUME_TAG
:
1175 case SEND_CUE_SHEET
:
1176 case SEND_DVD_STRUCTURE
:
1177 case PERSISTENT_RESERVE_OUT
:
1178 case MAINTENANCE_OUT
:
1179 cmd
->mode
= SCSI_XFER_TO_DEV
;
1181 case ATA_PASSTHROUGH_12
:
1182 case ATA_PASSTHROUGH_16
:
1184 cmd
->mode
= (cmd
->buf
[2] & 0x8) ?
1185 SCSI_XFER_FROM_DEV
: SCSI_XFER_TO_DEV
;
1188 cmd
->mode
= SCSI_XFER_FROM_DEV
;
1193 static uint64_t scsi_cmd_lba(SCSICommand
*cmd
)
1195 uint8_t *buf
= cmd
->buf
;
1198 switch (buf
[0] >> 5) {
1200 lba
= ldl_be_p(&buf
[0]) & 0x1fffff;
1205 lba
= ldl_be_p(&buf
[2]) & 0xffffffffULL
;
1208 lba
= ldq_be_p(&buf
[2]);
1217 int scsi_cdb_length(uint8_t *buf
) {
1220 switch (buf
[0] >> 5) {
1240 int scsi_req_parse_cdb(SCSIDevice
*dev
, SCSICommand
*cmd
, uint8_t *buf
)
1246 len
= scsi_cdb_length(buf
);
1252 switch (dev
->type
) {
1254 rc
= scsi_req_stream_xfer(cmd
, dev
, buf
);
1256 case TYPE_MEDIUM_CHANGER
:
1257 rc
= scsi_req_medium_changer_xfer(cmd
, dev
, buf
);
1260 rc
= scsi_req_xfer(cmd
, dev
, buf
);
1267 memcpy(cmd
->buf
, buf
, cmd
->len
);
1268 scsi_cmd_xfer_mode(cmd
);
1269 cmd
->lba
= scsi_cmd_lba(cmd
);
1273 void scsi_device_report_change(SCSIDevice
*dev
, SCSISense sense
)
1275 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, dev
->qdev
.parent_bus
);
1277 scsi_device_set_ua(dev
, sense
);
1278 if (bus
->info
->change
) {
1279 bus
->info
->change(bus
, dev
, sense
);
1284 * Predefined sense codes
1287 /* No sense data available */
1288 const struct SCSISense sense_code_NO_SENSE
= {
1289 .key
= NO_SENSE
, .asc
= 0x00 , .ascq
= 0x00
1292 /* LUN not ready, Manual intervention required */
1293 const struct SCSISense sense_code_LUN_NOT_READY
= {
1294 .key
= NOT_READY
, .asc
= 0x04, .ascq
= 0x03
1297 /* LUN not ready, Medium not present */
1298 const struct SCSISense sense_code_NO_MEDIUM
= {
1299 .key
= NOT_READY
, .asc
= 0x3a, .ascq
= 0x00
1302 /* LUN not ready, medium removal prevented */
1303 const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED
= {
1304 .key
= NOT_READY
, .asc
= 0x53, .ascq
= 0x02
1307 /* Hardware error, internal target failure */
1308 const struct SCSISense sense_code_TARGET_FAILURE
= {
1309 .key
= HARDWARE_ERROR
, .asc
= 0x44, .ascq
= 0x00
1312 /* Illegal request, invalid command operation code */
1313 const struct SCSISense sense_code_INVALID_OPCODE
= {
1314 .key
= ILLEGAL_REQUEST
, .asc
= 0x20, .ascq
= 0x00
1317 /* Illegal request, LBA out of range */
1318 const struct SCSISense sense_code_LBA_OUT_OF_RANGE
= {
1319 .key
= ILLEGAL_REQUEST
, .asc
= 0x21, .ascq
= 0x00
1322 /* Illegal request, Invalid field in CDB */
1323 const struct SCSISense sense_code_INVALID_FIELD
= {
1324 .key
= ILLEGAL_REQUEST
, .asc
= 0x24, .ascq
= 0x00
1327 /* Illegal request, Invalid field in parameter list */
1328 const struct SCSISense sense_code_INVALID_PARAM
= {
1329 .key
= ILLEGAL_REQUEST
, .asc
= 0x26, .ascq
= 0x00
1332 /* Illegal request, Parameter list length error */
1333 const struct SCSISense sense_code_INVALID_PARAM_LEN
= {
1334 .key
= ILLEGAL_REQUEST
, .asc
= 0x1a, .ascq
= 0x00
1337 /* Illegal request, LUN not supported */
1338 const struct SCSISense sense_code_LUN_NOT_SUPPORTED
= {
1339 .key
= ILLEGAL_REQUEST
, .asc
= 0x25, .ascq
= 0x00
1342 /* Illegal request, Saving parameters not supported */
1343 const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED
= {
1344 .key
= ILLEGAL_REQUEST
, .asc
= 0x39, .ascq
= 0x00
1347 /* Illegal request, Incompatible medium installed */
1348 const struct SCSISense sense_code_INCOMPATIBLE_FORMAT
= {
1349 .key
= ILLEGAL_REQUEST
, .asc
= 0x30, .ascq
= 0x00
1352 /* Illegal request, medium removal prevented */
1353 const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED
= {
1354 .key
= ILLEGAL_REQUEST
, .asc
= 0x53, .ascq
= 0x02
1357 /* Illegal request, Invalid Transfer Tag */
1358 const struct SCSISense sense_code_INVALID_TAG
= {
1359 .key
= ILLEGAL_REQUEST
, .asc
= 0x4b, .ascq
= 0x01
1362 /* Command aborted, I/O process terminated */
1363 const struct SCSISense sense_code_IO_ERROR
= {
1364 .key
= ABORTED_COMMAND
, .asc
= 0x00, .ascq
= 0x06
1367 /* Command aborted, I_T Nexus loss occurred */
1368 const struct SCSISense sense_code_I_T_NEXUS_LOSS
= {
1369 .key
= ABORTED_COMMAND
, .asc
= 0x29, .ascq
= 0x07
1372 /* Command aborted, Logical Unit failure */
1373 const struct SCSISense sense_code_LUN_FAILURE
= {
1374 .key
= ABORTED_COMMAND
, .asc
= 0x3e, .ascq
= 0x01
1377 /* Command aborted, Overlapped Commands Attempted */
1378 const struct SCSISense sense_code_OVERLAPPED_COMMANDS
= {
1379 .key
= ABORTED_COMMAND
, .asc
= 0x4e, .ascq
= 0x00
1382 /* Unit attention, Capacity data has changed */
1383 const struct SCSISense sense_code_CAPACITY_CHANGED
= {
1384 .key
= UNIT_ATTENTION
, .asc
= 0x2a, .ascq
= 0x09
1387 /* Unit attention, Power on, reset or bus device reset occurred */
1388 const struct SCSISense sense_code_RESET
= {
1389 .key
= UNIT_ATTENTION
, .asc
= 0x29, .ascq
= 0x00
1392 /* Unit attention, No medium */
1393 const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM
= {
1394 .key
= UNIT_ATTENTION
, .asc
= 0x3a, .ascq
= 0x00
1397 /* Unit attention, Medium may have changed */
1398 const struct SCSISense sense_code_MEDIUM_CHANGED
= {
1399 .key
= UNIT_ATTENTION
, .asc
= 0x28, .ascq
= 0x00
1402 /* Unit attention, Reported LUNs data has changed */
1403 const struct SCSISense sense_code_REPORTED_LUNS_CHANGED
= {
1404 .key
= UNIT_ATTENTION
, .asc
= 0x3f, .ascq
= 0x0e
1407 /* Unit attention, Device internal reset */
1408 const struct SCSISense sense_code_DEVICE_INTERNAL_RESET
= {
1409 .key
= UNIT_ATTENTION
, .asc
= 0x29, .ascq
= 0x04
1412 /* Data Protection, Write Protected */
1413 const struct SCSISense sense_code_WRITE_PROTECTED
= {
1414 .key
= DATA_PROTECT
, .asc
= 0x27, .ascq
= 0x00
1417 /* Data Protection, Space Allocation Failed Write Protect */
1418 const struct SCSISense sense_code_SPACE_ALLOC_FAILED
= {
1419 .key
= DATA_PROTECT
, .asc
= 0x27, .ascq
= 0x07
1425 * Convert between fixed and descriptor sense buffers
1427 int scsi_build_sense(uint8_t *in_buf
, int in_len
,
1428 uint8_t *buf
, int len
, bool fixed
)
1432 if (!fixed
&& len
< 8) {
1437 sense
.key
= NO_SENSE
;
1441 fixed_in
= (in_buf
[0] & 2) == 0;
1443 if (fixed
== fixed_in
) {
1444 memcpy(buf
, in_buf
, MIN(len
, in_len
));
1445 return MIN(len
, in_len
);
1449 sense
.key
= in_buf
[2];
1450 sense
.asc
= in_buf
[12];
1451 sense
.ascq
= in_buf
[13];
1453 sense
.key
= in_buf
[1];
1454 sense
.asc
= in_buf
[2];
1455 sense
.ascq
= in_buf
[3];
1459 memset(buf
, 0, len
);
1461 /* Return fixed format sense buffer */
1465 buf
[12] = sense
.asc
;
1466 buf
[13] = sense
.ascq
;
1467 return MIN(len
, SCSI_SENSE_LEN
);
1469 /* Return descriptor format sense buffer */
1473 buf
[3] = sense
.ascq
;
1478 const char *scsi_command_name(uint8_t cmd
)
1480 static const char *names
[] = {
1481 [ TEST_UNIT_READY
] = "TEST_UNIT_READY",
1482 [ REWIND
] = "REWIND",
1483 [ REQUEST_SENSE
] = "REQUEST_SENSE",
1484 [ FORMAT_UNIT
] = "FORMAT_UNIT",
1485 [ READ_BLOCK_LIMITS
] = "READ_BLOCK_LIMITS",
1486 [ REASSIGN_BLOCKS
] = "REASSIGN_BLOCKS/INITIALIZE ELEMENT STATUS",
1487 /* LOAD_UNLOAD and INITIALIZE_ELEMENT_STATUS use the same operation code */
1488 [ READ_6
] = "READ_6",
1489 [ WRITE_6
] = "WRITE_6",
1490 [ SET_CAPACITY
] = "SET_CAPACITY",
1491 [ READ_REVERSE
] = "READ_REVERSE",
1492 [ WRITE_FILEMARKS
] = "WRITE_FILEMARKS",
1493 [ SPACE
] = "SPACE",
1494 [ INQUIRY
] = "INQUIRY",
1495 [ RECOVER_BUFFERED_DATA
] = "RECOVER_BUFFERED_DATA",
1496 [ MAINTENANCE_IN
] = "MAINTENANCE_IN",
1497 [ MAINTENANCE_OUT
] = "MAINTENANCE_OUT",
1498 [ MODE_SELECT
] = "MODE_SELECT",
1499 [ RESERVE
] = "RESERVE",
1500 [ RELEASE
] = "RELEASE",
1502 [ ERASE
] = "ERASE",
1503 [ MODE_SENSE
] = "MODE_SENSE",
1504 [ START_STOP
] = "START_STOP/LOAD_UNLOAD",
1505 /* LOAD_UNLOAD and START_STOP use the same operation code */
1506 [ RECEIVE_DIAGNOSTIC
] = "RECEIVE_DIAGNOSTIC",
1507 [ SEND_DIAGNOSTIC
] = "SEND_DIAGNOSTIC",
1508 [ ALLOW_MEDIUM_REMOVAL
] = "ALLOW_MEDIUM_REMOVAL",
1509 [ READ_CAPACITY_10
] = "READ_CAPACITY_10",
1510 [ READ_10
] = "READ_10",
1511 [ WRITE_10
] = "WRITE_10",
1512 [ SEEK_10
] = "SEEK_10/POSITION_TO_ELEMENT",
1513 /* SEEK_10 and POSITION_TO_ELEMENT use the same operation code */
1514 [ WRITE_VERIFY_10
] = "WRITE_VERIFY_10",
1515 [ VERIFY_10
] = "VERIFY_10",
1516 [ SEARCH_HIGH
] = "SEARCH_HIGH",
1517 [ SEARCH_EQUAL
] = "SEARCH_EQUAL",
1518 [ SEARCH_LOW
] = "SEARCH_LOW",
1519 [ SET_LIMITS
] = "SET_LIMITS",
1520 [ PRE_FETCH
] = "PRE_FETCH/READ_POSITION",
1521 /* READ_POSITION and PRE_FETCH use the same operation code */
1522 [ SYNCHRONIZE_CACHE
] = "SYNCHRONIZE_CACHE",
1523 [ LOCK_UNLOCK_CACHE
] = "LOCK_UNLOCK_CACHE",
1524 [ READ_DEFECT_DATA
] = "READ_DEFECT_DATA/INITIALIZE_ELEMENT_STATUS_WITH_RANGE",
1525 /* READ_DEFECT_DATA and INITIALIZE_ELEMENT_STATUS_WITH_RANGE use the same operation code */
1526 [ MEDIUM_SCAN
] = "MEDIUM_SCAN",
1527 [ COMPARE
] = "COMPARE",
1528 [ COPY_VERIFY
] = "COPY_VERIFY",
1529 [ WRITE_BUFFER
] = "WRITE_BUFFER",
1530 [ READ_BUFFER
] = "READ_BUFFER",
1531 [ UPDATE_BLOCK
] = "UPDATE_BLOCK",
1532 [ READ_LONG_10
] = "READ_LONG_10",
1533 [ WRITE_LONG_10
] = "WRITE_LONG_10",
1534 [ CHANGE_DEFINITION
] = "CHANGE_DEFINITION",
1535 [ WRITE_SAME_10
] = "WRITE_SAME_10",
1536 [ UNMAP
] = "UNMAP",
1537 [ READ_TOC
] = "READ_TOC",
1538 [ REPORT_DENSITY_SUPPORT
] = "REPORT_DENSITY_SUPPORT",
1539 [ SANITIZE
] = "SANITIZE",
1540 [ GET_CONFIGURATION
] = "GET_CONFIGURATION",
1541 [ LOG_SELECT
] = "LOG_SELECT",
1542 [ LOG_SENSE
] = "LOG_SENSE",
1543 [ MODE_SELECT_10
] = "MODE_SELECT_10",
1544 [ RESERVE_10
] = "RESERVE_10",
1545 [ RELEASE_10
] = "RELEASE_10",
1546 [ MODE_SENSE_10
] = "MODE_SENSE_10",
1547 [ PERSISTENT_RESERVE_IN
] = "PERSISTENT_RESERVE_IN",
1548 [ PERSISTENT_RESERVE_OUT
] = "PERSISTENT_RESERVE_OUT",
1549 [ WRITE_FILEMARKS_16
] = "WRITE_FILEMARKS_16",
1550 [ EXTENDED_COPY
] = "EXTENDED_COPY",
1551 [ ATA_PASSTHROUGH_16
] = "ATA_PASSTHROUGH_16",
1552 [ ACCESS_CONTROL_IN
] = "ACCESS_CONTROL_IN",
1553 [ ACCESS_CONTROL_OUT
] = "ACCESS_CONTROL_OUT",
1554 [ READ_16
] = "READ_16",
1555 [ COMPARE_AND_WRITE
] = "COMPARE_AND_WRITE",
1556 [ WRITE_16
] = "WRITE_16",
1557 [ WRITE_VERIFY_16
] = "WRITE_VERIFY_16",
1558 [ VERIFY_16
] = "VERIFY_16",
1559 [ PRE_FETCH_16
] = "PRE_FETCH_16",
1560 [ SYNCHRONIZE_CACHE_16
] = "SPACE_16/SYNCHRONIZE_CACHE_16",
1561 /* SPACE_16 and SYNCHRONIZE_CACHE_16 use the same operation code */
1562 [ LOCATE_16
] = "LOCATE_16",
1563 [ WRITE_SAME_16
] = "ERASE_16/WRITE_SAME_16",
1564 /* ERASE_16 and WRITE_SAME_16 use the same operation code */
1565 [ SERVICE_ACTION_IN_16
] = "SERVICE_ACTION_IN_16",
1566 [ WRITE_LONG_16
] = "WRITE_LONG_16",
1567 [ REPORT_LUNS
] = "REPORT_LUNS",
1568 [ ATA_PASSTHROUGH_12
] = "BLANK/ATA_PASSTHROUGH_12",
1569 [ MOVE_MEDIUM
] = "MOVE_MEDIUM",
1570 [ EXCHANGE_MEDIUM
] = "EXCHANGE MEDIUM",
1571 [ READ_12
] = "READ_12",
1572 [ WRITE_12
] = "WRITE_12",
1573 [ ERASE_12
] = "ERASE_12/GET_PERFORMANCE",
1574 /* ERASE_12 and GET_PERFORMANCE use the same operation code */
1575 [ SERVICE_ACTION_IN_12
] = "SERVICE_ACTION_IN_12",
1576 [ WRITE_VERIFY_12
] = "WRITE_VERIFY_12",
1577 [ VERIFY_12
] = "VERIFY_12",
1578 [ SEARCH_HIGH_12
] = "SEARCH_HIGH_12",
1579 [ SEARCH_EQUAL_12
] = "SEARCH_EQUAL_12",
1580 [ SEARCH_LOW_12
] = "SEARCH_LOW_12",
1581 [ READ_ELEMENT_STATUS
] = "READ_ELEMENT_STATUS",
1582 [ SEND_VOLUME_TAG
] = "SEND_VOLUME_TAG/SET_STREAMING",
1583 /* SEND_VOLUME_TAG and SET_STREAMING use the same operation code */
1584 [ READ_CD
] = "READ_CD",
1585 [ READ_DEFECT_DATA_12
] = "READ_DEFECT_DATA_12",
1586 [ READ_DVD_STRUCTURE
] = "READ_DVD_STRUCTURE",
1587 [ RESERVE_TRACK
] = "RESERVE_TRACK",
1588 [ SEND_CUE_SHEET
] = "SEND_CUE_SHEET",
1589 [ SEND_DVD_STRUCTURE
] = "SEND_DVD_STRUCTURE",
1590 [ SET_CD_SPEED
] = "SET_CD_SPEED",
1591 [ SET_READ_AHEAD
] = "SET_READ_AHEAD",
1592 [ ALLOW_OVERWRITE
] = "ALLOW_OVERWRITE",
1593 [ MECHANISM_STATUS
] = "MECHANISM_STATUS",
1594 [ GET_EVENT_STATUS_NOTIFICATION
] = "GET_EVENT_STATUS_NOTIFICATION",
1595 [ READ_DISC_INFORMATION
] = "READ_DISC_INFORMATION",
1598 if (cmd
>= ARRAY_SIZE(names
) || names
[cmd
] == NULL
)
1603 SCSIRequest
*scsi_req_ref(SCSIRequest
*req
)
1605 assert(req
->refcount
> 0);
1610 void scsi_req_unref(SCSIRequest
*req
)
1612 assert(req
->refcount
> 0);
1613 if (--req
->refcount
== 0) {
1614 BusState
*qbus
= req
->dev
->qdev
.parent_bus
;
1615 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, qbus
);
1617 if (bus
->info
->free_request
&& req
->hba_private
) {
1618 bus
->info
->free_request(bus
, req
->hba_private
);
1620 if (req
->ops
->free_req
) {
1621 req
->ops
->free_req(req
);
1623 object_unref(OBJECT(req
->dev
));
1624 object_unref(OBJECT(qbus
->parent
));
1629 /* Tell the device that we finished processing this chunk of I/O. It
1630 will start the next chunk or complete the command. */
1631 void scsi_req_continue(SCSIRequest
*req
)
1633 if (req
->io_canceled
) {
1634 trace_scsi_req_continue_canceled(req
->dev
->id
, req
->lun
, req
->tag
);
1637 trace_scsi_req_continue(req
->dev
->id
, req
->lun
, req
->tag
);
1638 if (req
->cmd
.mode
== SCSI_XFER_TO_DEV
) {
1639 req
->ops
->write_data(req
);
1641 req
->ops
->read_data(req
);
1645 /* Called by the devices when data is ready for the HBA. The HBA should
1646 start a DMA operation to read or fill the device's data buffer.
1647 Once it completes, calling scsi_req_continue will restart I/O. */
1648 void scsi_req_data(SCSIRequest
*req
, int len
)
1651 if (req
->io_canceled
) {
1652 trace_scsi_req_data_canceled(req
->dev
->id
, req
->lun
, req
->tag
, len
);
1655 trace_scsi_req_data(req
->dev
->id
, req
->lun
, req
->tag
, len
);
1656 assert(req
->cmd
.mode
!= SCSI_XFER_NONE
);
1659 req
->bus
->info
->transfer_data(req
, len
);
1663 /* If the device calls scsi_req_data and the HBA specified a
1664 * scatter/gather list, the transfer has to happen in a single
1666 assert(!req
->dma_started
);
1667 req
->dma_started
= true;
1669 buf
= scsi_req_get_buf(req
);
1670 if (req
->cmd
.mode
== SCSI_XFER_FROM_DEV
) {
1671 req
->resid
= dma_buf_read(buf
, len
, req
->sg
);
1673 req
->resid
= dma_buf_write(buf
, len
, req
->sg
);
1675 scsi_req_continue(req
);
1678 void scsi_req_print(SCSIRequest
*req
)
1683 fprintf(fp
, "[%s id=%d] %s",
1684 req
->dev
->qdev
.parent_bus
->name
,
1686 scsi_command_name(req
->cmd
.buf
[0]));
1687 for (i
= 1; i
< req
->cmd
.len
; i
++) {
1688 fprintf(fp
, " 0x%02x", req
->cmd
.buf
[i
]);
1690 switch (req
->cmd
.mode
) {
1691 case SCSI_XFER_NONE
:
1692 fprintf(fp
, " - none\n");
1694 case SCSI_XFER_FROM_DEV
:
1695 fprintf(fp
, " - from-dev len=%zd\n", req
->cmd
.xfer
);
1697 case SCSI_XFER_TO_DEV
:
1698 fprintf(fp
, " - to-dev len=%zd\n", req
->cmd
.xfer
);
1701 fprintf(fp
, " - Oops\n");
1706 void scsi_req_complete(SCSIRequest
*req
, int status
)
1708 assert(req
->status
== -1);
1709 req
->status
= status
;
1711 assert(req
->sense_len
<= sizeof(req
->sense
));
1712 if (status
== GOOD
) {
1716 if (req
->sense_len
) {
1717 memcpy(req
->dev
->sense
, req
->sense
, req
->sense_len
);
1718 req
->dev
->sense_len
= req
->sense_len
;
1719 req
->dev
->sense_is_ua
= (req
->ops
== &reqops_unit_attention
);
1721 req
->dev
->sense_len
= 0;
1722 req
->dev
->sense_is_ua
= false;
1726 * Unit attention state is now stored in the device's sense buffer
1727 * if the HBA didn't do autosense. Clear the pending unit attention
1730 scsi_clear_unit_attention(req
);
1733 scsi_req_dequeue(req
);
1734 req
->bus
->info
->complete(req
, req
->status
, req
->resid
);
1736 /* Cancelled requests might end up being completed instead of cancelled */
1737 notifier_list_notify(&req
->cancel_notifiers
, req
);
1738 scsi_req_unref(req
);
1741 /* Called by the devices when the request is canceled. */
1742 void scsi_req_cancel_complete(SCSIRequest
*req
)
1744 assert(req
->io_canceled
);
1745 if (req
->bus
->info
->cancel
) {
1746 req
->bus
->info
->cancel(req
);
1748 notifier_list_notify(&req
->cancel_notifiers
, req
);
1749 scsi_req_unref(req
);
1752 /* Cancel @req asynchronously. @notifier is added to @req's cancellation
1753 * notifier list, the bus will be notified the requests cancellation is
1756 void scsi_req_cancel_async(SCSIRequest
*req
, Notifier
*notifier
)
1758 trace_scsi_req_cancel(req
->dev
->id
, req
->lun
, req
->tag
);
1760 notifier_list_add(&req
->cancel_notifiers
, notifier
);
1762 if (req
->io_canceled
) {
1766 scsi_req_dequeue(req
);
1767 req
->io_canceled
= true;
1769 blk_aio_cancel_async(req
->aiocb
);
1771 scsi_req_cancel_complete(req
);
1775 void scsi_req_cancel(SCSIRequest
*req
)
1777 trace_scsi_req_cancel(req
->dev
->id
, req
->lun
, req
->tag
);
1778 if (!req
->enqueued
) {
1782 scsi_req_dequeue(req
);
1783 req
->io_canceled
= true;
1785 blk_aio_cancel(req
->aiocb
);
1787 scsi_req_cancel_complete(req
);
1791 static int scsi_ua_precedence(SCSISense sense
)
1793 if (sense
.key
!= UNIT_ATTENTION
) {
1796 if (sense
.asc
== 0x29 && sense
.ascq
== 0x04) {
1797 /* DEVICE INTERNAL RESET goes with POWER ON OCCURRED */
1799 } else if (sense
.asc
== 0x3F && sense
.ascq
== 0x01) {
1800 /* MICROCODE HAS BEEN CHANGED goes with SCSI BUS RESET OCCURRED */
1802 } else if (sense
.asc
== 0x29 && (sense
.ascq
== 0x05 || sense
.ascq
== 0x06)) {
1803 /* These two go with "all others". */
1805 } else if (sense
.asc
== 0x29 && sense
.ascq
<= 0x07) {
1806 /* POWER ON, RESET OR BUS DEVICE RESET OCCURRED = 0
1807 * POWER ON OCCURRED = 1
1808 * SCSI BUS RESET OCCURRED = 2
1809 * BUS DEVICE RESET FUNCTION OCCURRED = 3
1810 * I_T NEXUS LOSS OCCURRED = 7
1813 } else if (sense
.asc
== 0x2F && sense
.ascq
== 0x01) {
1814 /* COMMANDS CLEARED BY POWER LOSS NOTIFICATION */
1817 return (sense
.asc
<< 8) | sense
.ascq
;
1820 void scsi_device_set_ua(SCSIDevice
*sdev
, SCSISense sense
)
1823 if (sense
.key
!= UNIT_ATTENTION
) {
1826 trace_scsi_device_set_ua(sdev
->id
, sdev
->lun
, sense
.key
,
1827 sense
.asc
, sense
.ascq
);
1830 * Override a pre-existing unit attention condition, except for a more
1831 * important reset condition.
1833 prec1
= scsi_ua_precedence(sdev
->unit_attention
);
1834 prec2
= scsi_ua_precedence(sense
);
1835 if (prec2
< prec1
) {
1836 sdev
->unit_attention
= sense
;
1840 void scsi_device_purge_requests(SCSIDevice
*sdev
, SCSISense sense
)
1844 while (!QTAILQ_EMPTY(&sdev
->requests
)) {
1845 req
= QTAILQ_FIRST(&sdev
->requests
);
1846 scsi_req_cancel(req
);
1849 scsi_device_set_ua(sdev
, sense
);
1852 static char *scsibus_get_dev_path(DeviceState
*dev
)
1854 SCSIDevice
*d
= DO_UPCAST(SCSIDevice
, qdev
, dev
);
1855 DeviceState
*hba
= dev
->parent_bus
->parent
;
1859 id
= qdev_get_dev_path(hba
);
1861 path
= g_strdup_printf("%s/%d:%d:%d", id
, d
->channel
, d
->id
, d
->lun
);
1863 path
= g_strdup_printf("%d:%d:%d", d
->channel
, d
->id
, d
->lun
);
1869 static char *scsibus_get_fw_dev_path(DeviceState
*dev
)
1871 SCSIDevice
*d
= SCSI_DEVICE(dev
);
1872 return g_strdup_printf("channel@%x/%s@%x,%x", d
->channel
,
1873 qdev_fw_name(dev
), d
->id
, d
->lun
);
1876 SCSIDevice
*scsi_device_find(SCSIBus
*bus
, int channel
, int id
, int lun
)
1879 SCSIDevice
*target_dev
= NULL
;
1881 QTAILQ_FOREACH_REVERSE(kid
, &bus
->qbus
.children
, ChildrenHead
, sibling
) {
1882 DeviceState
*qdev
= kid
->child
;
1883 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
1885 if (dev
->channel
== channel
&& dev
->id
== id
) {
1886 if (dev
->lun
== lun
) {
1895 /* SCSI request list. For simplicity, pv points to the whole device */
1897 static void put_scsi_requests(QEMUFile
*f
, void *pv
, size_t size
)
1900 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, s
->qdev
.parent_bus
);
1903 QTAILQ_FOREACH(req
, &s
->requests
, next
) {
1904 assert(!req
->io_canceled
);
1905 assert(req
->status
== -1);
1906 assert(req
->enqueued
);
1908 qemu_put_sbyte(f
, req
->retry
? 1 : 2);
1909 qemu_put_buffer(f
, req
->cmd
.buf
, sizeof(req
->cmd
.buf
));
1910 qemu_put_be32s(f
, &req
->tag
);
1911 qemu_put_be32s(f
, &req
->lun
);
1912 if (bus
->info
->save_request
) {
1913 bus
->info
->save_request(f
, req
);
1915 if (req
->ops
->save_request
) {
1916 req
->ops
->save_request(f
, req
);
1919 qemu_put_sbyte(f
, 0);
1922 static int get_scsi_requests(QEMUFile
*f
, void *pv
, size_t size
)
1925 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, s
->qdev
.parent_bus
);
1928 while ((sbyte
= qemu_get_sbyte(f
)) > 0) {
1929 uint8_t buf
[SCSI_CMD_BUF_SIZE
];
1934 qemu_get_buffer(f
, buf
, sizeof(buf
));
1935 qemu_get_be32s(f
, &tag
);
1936 qemu_get_be32s(f
, &lun
);
1937 req
= scsi_req_new(s
, tag
, lun
, buf
, NULL
);
1938 req
->retry
= (sbyte
== 1);
1939 if (bus
->info
->load_request
) {
1940 req
->hba_private
= bus
->info
->load_request(f
, req
);
1942 if (req
->ops
->load_request
) {
1943 req
->ops
->load_request(f
, req
);
1946 /* Just restart it later. */
1947 scsi_req_enqueue_internal(req
);
1949 /* At this point, the request will be kept alive by the reference
1950 * added by scsi_req_enqueue_internal, so we can release our reference.
1951 * The HBA of course will add its own reference in the load_request
1952 * callback if it needs to hold on the SCSIRequest.
1954 scsi_req_unref(req
);
1960 static const VMStateInfo vmstate_info_scsi_requests
= {
1961 .name
= "scsi-requests",
1962 .get
= get_scsi_requests
,
1963 .put
= put_scsi_requests
,
1966 static bool scsi_sense_state_needed(void *opaque
)
1968 SCSIDevice
*s
= opaque
;
1970 return s
->sense_len
> SCSI_SENSE_BUF_SIZE_OLD
;
1973 static const VMStateDescription vmstate_scsi_sense_state
= {
1974 .name
= "SCSIDevice/sense",
1976 .minimum_version_id
= 1,
1977 .needed
= scsi_sense_state_needed
,
1978 .fields
= (VMStateField
[]) {
1979 VMSTATE_UINT8_SUB_ARRAY(sense
, SCSIDevice
,
1980 SCSI_SENSE_BUF_SIZE_OLD
,
1981 SCSI_SENSE_BUF_SIZE
- SCSI_SENSE_BUF_SIZE_OLD
),
1982 VMSTATE_END_OF_LIST()
1986 const VMStateDescription vmstate_scsi_device
= {
1987 .name
= "SCSIDevice",
1989 .minimum_version_id
= 1,
1990 .fields
= (VMStateField
[]) {
1991 VMSTATE_UINT8(unit_attention
.key
, SCSIDevice
),
1992 VMSTATE_UINT8(unit_attention
.asc
, SCSIDevice
),
1993 VMSTATE_UINT8(unit_attention
.ascq
, SCSIDevice
),
1994 VMSTATE_BOOL(sense_is_ua
, SCSIDevice
),
1995 VMSTATE_UINT8_SUB_ARRAY(sense
, SCSIDevice
, 0, SCSI_SENSE_BUF_SIZE_OLD
),
1996 VMSTATE_UINT32(sense_len
, SCSIDevice
),
2000 .field_exists
= NULL
,
2001 .size
= 0, /* ouch */
2002 .info
= &vmstate_info_scsi_requests
,
2003 .flags
= VMS_SINGLE
,
2006 VMSTATE_END_OF_LIST()
2008 .subsections
= (const VMStateDescription
*[]) {
2009 &vmstate_scsi_sense_state
,
2014 static void scsi_device_class_init(ObjectClass
*klass
, void *data
)
2016 DeviceClass
*k
= DEVICE_CLASS(klass
);
2017 set_bit(DEVICE_CATEGORY_STORAGE
, k
->categories
);
2018 k
->bus_type
= TYPE_SCSI_BUS
;
2019 k
->realize
= scsi_qdev_realize
;
2020 k
->unrealize
= scsi_qdev_unrealize
;
2021 k
->props
= scsi_props
;
2024 static void scsi_dev_instance_init(Object
*obj
)
2026 DeviceState
*dev
= DEVICE(obj
);
2027 SCSIDevice
*s
= DO_UPCAST(SCSIDevice
, qdev
, dev
);
2029 device_add_bootindex_property(obj
, &s
->conf
.bootindex
,
2034 static const TypeInfo scsi_device_type_info
= {
2035 .name
= TYPE_SCSI_DEVICE
,
2036 .parent
= TYPE_DEVICE
,
2037 .instance_size
= sizeof(SCSIDevice
),
2039 .class_size
= sizeof(SCSIDeviceClass
),
2040 .class_init
= scsi_device_class_init
,
2041 .instance_init
= scsi_dev_instance_init
,
2044 static void scsi_register_types(void)
2046 type_register_static(&scsi_bus_info
);
2047 type_register_static(&scsi_device_type_info
);
2050 type_init(scsi_register_types
)