2 #include "qemu/error-report.h"
6 #include "sysemu/blockdev.h"
8 #include "sysemu/dma.h"
10 static char *scsibus_get_dev_path(DeviceState
*dev
);
11 static char *scsibus_get_fw_dev_path(DeviceState
*dev
);
12 static int scsi_req_parse(SCSICommand
*cmd
, SCSIDevice
*dev
, uint8_t *buf
);
13 static void scsi_req_dequeue(SCSIRequest
*req
);
15 static Property scsi_props
[] = {
16 DEFINE_PROP_UINT32("channel", SCSIDevice
, channel
, 0),
17 DEFINE_PROP_UINT32("scsi-id", SCSIDevice
, id
, -1),
18 DEFINE_PROP_UINT32("lun", SCSIDevice
, lun
, -1),
19 DEFINE_PROP_END_OF_LIST(),
22 static void scsi_bus_class_init(ObjectClass
*klass
, void *data
)
24 BusClass
*k
= BUS_CLASS(klass
);
26 k
->get_dev_path
= scsibus_get_dev_path
;
27 k
->get_fw_dev_path
= scsibus_get_fw_dev_path
;
30 static const TypeInfo scsi_bus_info
= {
31 .name
= TYPE_SCSI_BUS
,
33 .instance_size
= sizeof(SCSIBus
),
34 .class_init
= scsi_bus_class_init
,
36 static int next_scsi_bus
;
38 static int scsi_device_init(SCSIDevice
*s
)
40 SCSIDeviceClass
*sc
= SCSI_DEVICE_GET_CLASS(s
);
47 static void scsi_device_destroy(SCSIDevice
*s
)
49 SCSIDeviceClass
*sc
= SCSI_DEVICE_GET_CLASS(s
);
55 static SCSIRequest
*scsi_device_alloc_req(SCSIDevice
*s
, uint32_t tag
, uint32_t lun
,
56 uint8_t *buf
, void *hba_private
)
58 SCSIDeviceClass
*sc
= SCSI_DEVICE_GET_CLASS(s
);
60 return sc
->alloc_req(s
, tag
, lun
, buf
, hba_private
);
66 static void scsi_device_unit_attention_reported(SCSIDevice
*s
)
68 SCSIDeviceClass
*sc
= SCSI_DEVICE_GET_CLASS(s
);
69 if (sc
->unit_attention_reported
) {
70 sc
->unit_attention_reported(s
);
74 /* Create a scsi bus, and attach devices to it. */
75 void scsi_bus_new(SCSIBus
*bus
, DeviceState
*host
, const SCSIBusInfo
*info
)
77 qbus_create_inplace(&bus
->qbus
, TYPE_SCSI_BUS
, host
, NULL
);
78 bus
->busnr
= next_scsi_bus
++;
80 bus
->qbus
.allow_hotplug
= 1;
83 static void scsi_dma_restart_bh(void *opaque
)
85 SCSIDevice
*s
= opaque
;
86 SCSIRequest
*req
, *next
;
88 qemu_bh_delete(s
->bh
);
91 QTAILQ_FOREACH_SAFE(req
, &s
->requests
, next
, next
) {
95 switch (req
->cmd
.mode
) {
96 case SCSI_XFER_FROM_DEV
:
97 case SCSI_XFER_TO_DEV
:
98 scsi_req_continue(req
);
102 scsi_req_dequeue(req
);
103 scsi_req_enqueue(req
);
111 void scsi_req_retry(SCSIRequest
*req
)
113 /* No need to save a reference, because scsi_dma_restart_bh just
114 * looks at the request list. */
118 static void scsi_dma_restart_cb(void *opaque
, int running
, RunState state
)
120 SCSIDevice
*s
= opaque
;
126 s
->bh
= qemu_bh_new(scsi_dma_restart_bh
, s
);
127 qemu_bh_schedule(s
->bh
);
131 static int scsi_qdev_init(DeviceState
*qdev
)
133 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
134 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, dev
->qdev
.parent_bus
);
138 if (dev
->channel
> bus
->info
->max_channel
) {
139 error_report("bad scsi channel id: %d", dev
->channel
);
142 if (dev
->id
!= -1 && dev
->id
> bus
->info
->max_target
) {
143 error_report("bad scsi device id: %d", dev
->id
);
146 if (dev
->lun
!= -1 && dev
->lun
> bus
->info
->max_lun
) {
147 error_report("bad scsi device lun: %d", dev
->lun
);
153 if (dev
->lun
== -1) {
157 d
= scsi_device_find(bus
, dev
->channel
, ++id
, dev
->lun
);
158 } while (d
&& d
->lun
== dev
->lun
&& id
< bus
->info
->max_target
);
159 if (d
&& d
->lun
== dev
->lun
) {
160 error_report("no free target");
164 } else if (dev
->lun
== -1) {
167 d
= scsi_device_find(bus
, dev
->channel
, dev
->id
, ++lun
);
168 } while (d
&& d
->lun
== lun
&& lun
< bus
->info
->max_lun
);
169 if (d
&& d
->lun
== lun
) {
170 error_report("no free lun");
175 d
= scsi_device_find(bus
, dev
->channel
, dev
->id
, dev
->lun
);
177 if (d
->lun
== dev
->lun
&& dev
!= d
) {
182 QTAILQ_INIT(&dev
->requests
);
183 rc
= scsi_device_init(dev
);
185 dev
->vmsentry
= qemu_add_vm_change_state_handler(scsi_dma_restart_cb
,
189 if (bus
->info
->hotplug
) {
190 bus
->info
->hotplug(bus
, dev
);
197 static int scsi_qdev_exit(DeviceState
*qdev
)
199 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
202 qemu_del_vm_change_state_handler(dev
->vmsentry
);
204 scsi_device_destroy(dev
);
208 /* handle legacy '-drive if=scsi,...' cmd line args */
209 SCSIDevice
*scsi_bus_legacy_add_drive(SCSIBus
*bus
, BlockDriverState
*bdrv
,
210 int unit
, bool removable
, int bootindex
)
215 driver
= bdrv_is_sg(bdrv
) ? "scsi-generic" : "scsi-disk";
216 dev
= qdev_create(&bus
->qbus
, driver
);
217 qdev_prop_set_uint32(dev
, "scsi-id", unit
);
218 if (bootindex
>= 0) {
219 qdev_prop_set_int32(dev
, "bootindex", bootindex
);
221 if (object_property_find(OBJECT(dev
), "removable", NULL
)) {
222 qdev_prop_set_bit(dev
, "removable", removable
);
224 if (qdev_prop_set_drive(dev
, "drive", bdrv
) < 0) {
228 if (qdev_init(dev
) < 0)
230 return SCSI_DEVICE(dev
);
233 int scsi_bus_legacy_handle_cmdline(SCSIBus
*bus
)
240 for (unit
= 0; unit
<= bus
->info
->max_target
; unit
++) {
241 dinfo
= drive_get(IF_SCSI
, bus
->busnr
, unit
);
245 qemu_opts_loc_restore(dinfo
->opts
);
246 if (!scsi_bus_legacy_add_drive(bus
, dinfo
->bdrv
, unit
, false, -1)) {
255 static int32_t scsi_invalid_field(SCSIRequest
*req
, uint8_t *buf
)
257 scsi_req_build_sense(req
, SENSE_CODE(INVALID_FIELD
));
258 scsi_req_complete(req
, CHECK_CONDITION
);
262 static const struct SCSIReqOps reqops_invalid_field
= {
263 .size
= sizeof(SCSIRequest
),
264 .send_command
= scsi_invalid_field
267 /* SCSIReqOps implementation for invalid commands. */
269 static int32_t scsi_invalid_command(SCSIRequest
*req
, uint8_t *buf
)
271 scsi_req_build_sense(req
, SENSE_CODE(INVALID_OPCODE
));
272 scsi_req_complete(req
, CHECK_CONDITION
);
276 static const struct SCSIReqOps reqops_invalid_opcode
= {
277 .size
= sizeof(SCSIRequest
),
278 .send_command
= scsi_invalid_command
281 /* SCSIReqOps implementation for unit attention conditions. */
283 static int32_t scsi_unit_attention(SCSIRequest
*req
, uint8_t *buf
)
285 if (req
->dev
&& req
->dev
->unit_attention
.key
== UNIT_ATTENTION
) {
286 scsi_req_build_sense(req
, req
->dev
->unit_attention
);
287 } else if (req
->bus
->unit_attention
.key
== UNIT_ATTENTION
) {
288 scsi_req_build_sense(req
, req
->bus
->unit_attention
);
290 scsi_req_complete(req
, CHECK_CONDITION
);
294 static const struct SCSIReqOps reqops_unit_attention
= {
295 .size
= sizeof(SCSIRequest
),
296 .send_command
= scsi_unit_attention
299 /* SCSIReqOps implementation for REPORT LUNS and for commands sent to
302 typedef struct SCSITargetReq SCSITargetReq
;
304 struct SCSITargetReq
{
310 static void store_lun(uint8_t *outbuf
, int lun
)
316 outbuf
[1] = (lun
& 255);
317 outbuf
[0] = (lun
>> 8) | 0x40;
320 static bool scsi_target_emulate_report_luns(SCSITargetReq
*r
)
327 if (r
->req
.cmd
.xfer
< 16) {
330 if (r
->req
.cmd
.buf
[2] > 2) {
333 channel
= r
->req
.dev
->channel
;
337 QTAILQ_FOREACH(kid
, &r
->req
.bus
->qbus
.children
, sibling
) {
338 DeviceState
*qdev
= kid
->child
;
339 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
341 if (dev
->channel
== channel
&& dev
->id
== id
) {
351 len
= MIN(n
+ 8, r
->req
.cmd
.xfer
& ~7);
352 if (len
> sizeof(r
->buf
)) {
353 /* TODO: > 256 LUNs? */
357 memset(r
->buf
, 0, len
);
358 stl_be_p(&r
->buf
, n
);
359 i
= found_lun0
? 8 : 16;
360 QTAILQ_FOREACH(kid
, &r
->req
.bus
->qbus
.children
, sibling
) {
361 DeviceState
*qdev
= kid
->child
;
362 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
364 if (dev
->channel
== channel
&& dev
->id
== id
) {
365 store_lun(&r
->buf
[i
], dev
->lun
);
374 static bool scsi_target_emulate_inquiry(SCSITargetReq
*r
)
376 assert(r
->req
.dev
->lun
!= r
->req
.lun
);
377 if (r
->req
.cmd
.buf
[1] & 0x2) {
378 /* Command support data - optional, not implemented */
382 if (r
->req
.cmd
.buf
[1] & 0x1) {
383 /* Vital product data */
384 uint8_t page_code
= r
->req
.cmd
.buf
[2];
385 r
->buf
[r
->len
++] = page_code
; /* this page */
386 r
->buf
[r
->len
++] = 0x00;
389 case 0x00: /* Supported page codes, mandatory */
393 r
->buf
[r
->len
++] = 0x00; /* list of supported pages (this page) */
394 r
->buf
[pages
] = r
->len
- pages
- 1; /* number of pages */
401 assert(r
->len
< sizeof(r
->buf
));
402 r
->len
= MIN(r
->req
.cmd
.xfer
, r
->len
);
406 /* Standard INQUIRY data */
407 if (r
->req
.cmd
.buf
[2] != 0) {
412 r
->len
= MIN(r
->req
.cmd
.xfer
, 36);
413 memset(r
->buf
, 0, r
->len
);
414 if (r
->req
.lun
!= 0) {
415 r
->buf
[0] = TYPE_NO_LUN
;
417 r
->buf
[0] = TYPE_NOT_PRESENT
| TYPE_INACTIVE
;
418 r
->buf
[2] = 5; /* Version */
419 r
->buf
[3] = 2 | 0x10; /* HiSup, response data format */
420 r
->buf
[4] = r
->len
- 5; /* Additional Length = (Len - 1) - 4 */
421 r
->buf
[7] = 0x10 | (r
->req
.bus
->info
->tcq
? 0x02 : 0); /* Sync, TCQ. */
422 memcpy(&r
->buf
[8], "QEMU ", 8);
423 memcpy(&r
->buf
[16], "QEMU TARGET ", 16);
424 pstrcpy((char *) &r
->buf
[32], 4, qemu_get_version());
429 static int32_t scsi_target_send_command(SCSIRequest
*req
, uint8_t *buf
)
431 SCSITargetReq
*r
= DO_UPCAST(SCSITargetReq
, req
, req
);
435 if (!scsi_target_emulate_report_luns(r
)) {
436 goto illegal_request
;
440 if (!scsi_target_emulate_inquiry(r
)) {
441 goto illegal_request
;
445 r
->len
= scsi_device_get_sense(r
->req
.dev
, r
->buf
,
446 MIN(req
->cmd
.xfer
, sizeof r
->buf
),
447 (req
->cmd
.buf
[1] & 1) == 0);
448 if (r
->req
.dev
->sense_is_ua
) {
449 scsi_device_unit_attention_reported(req
->dev
);
450 r
->req
.dev
->sense_len
= 0;
451 r
->req
.dev
->sense_is_ua
= false;
455 scsi_req_build_sense(req
, SENSE_CODE(LUN_NOT_SUPPORTED
));
456 scsi_req_complete(req
, CHECK_CONDITION
);
459 scsi_req_build_sense(req
, SENSE_CODE(INVALID_FIELD
));
460 scsi_req_complete(req
, CHECK_CONDITION
);
465 scsi_req_complete(req
, GOOD
);
470 static void scsi_target_read_data(SCSIRequest
*req
)
472 SCSITargetReq
*r
= DO_UPCAST(SCSITargetReq
, req
, req
);
478 scsi_req_data(&r
->req
, n
);
480 scsi_req_complete(&r
->req
, GOOD
);
484 static uint8_t *scsi_target_get_buf(SCSIRequest
*req
)
486 SCSITargetReq
*r
= DO_UPCAST(SCSITargetReq
, req
, req
);
491 static const struct SCSIReqOps reqops_target_command
= {
492 .size
= sizeof(SCSITargetReq
),
493 .send_command
= scsi_target_send_command
,
494 .read_data
= scsi_target_read_data
,
495 .get_buf
= scsi_target_get_buf
,
499 SCSIRequest
*scsi_req_alloc(const SCSIReqOps
*reqops
, SCSIDevice
*d
,
500 uint32_t tag
, uint32_t lun
, void *hba_private
)
504 req
= g_malloc0(reqops
->size
);
506 req
->bus
= scsi_bus_from_device(d
);
510 req
->hba_private
= hba_private
;
514 trace_scsi_req_alloc(req
->dev
->id
, req
->lun
, req
->tag
);
518 SCSIRequest
*scsi_req_new(SCSIDevice
*d
, uint32_t tag
, uint32_t lun
,
519 uint8_t *buf
, void *hba_private
)
521 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, d
->qdev
.parent_bus
);
525 if (scsi_req_parse(&cmd
, d
, buf
) != 0) {
526 trace_scsi_req_parse_bad(d
->id
, lun
, tag
, buf
[0]);
527 req
= scsi_req_alloc(&reqops_invalid_opcode
, d
, tag
, lun
, hba_private
);
529 trace_scsi_req_parsed(d
->id
, lun
, tag
, buf
[0],
532 trace_scsi_req_parsed_lba(d
->id
, lun
, tag
, buf
[0],
536 if (cmd
.xfer
> INT32_MAX
) {
537 req
= scsi_req_alloc(&reqops_invalid_field
, d
, tag
, lun
, hba_private
);
538 } else if ((d
->unit_attention
.key
== UNIT_ATTENTION
||
539 bus
->unit_attention
.key
== UNIT_ATTENTION
) &&
540 (buf
[0] != INQUIRY
&&
541 buf
[0] != REPORT_LUNS
&&
542 buf
[0] != GET_CONFIGURATION
&&
543 buf
[0] != GET_EVENT_STATUS_NOTIFICATION
&&
546 * If we already have a pending unit attention condition,
547 * report this one before triggering another one.
549 !(buf
[0] == REQUEST_SENSE
&& d
->sense_is_ua
))) {
550 req
= scsi_req_alloc(&reqops_unit_attention
, d
, tag
, lun
,
552 } else if (lun
!= d
->lun
||
553 buf
[0] == REPORT_LUNS
||
554 (buf
[0] == REQUEST_SENSE
&& d
->sense_len
)) {
555 req
= scsi_req_alloc(&reqops_target_command
, d
, tag
, lun
,
558 req
= scsi_device_alloc_req(d
, tag
, lun
, buf
, hba_private
);
563 req
->resid
= req
->cmd
.xfer
;
567 trace_scsi_inquiry(d
->id
, lun
, tag
, cmd
.buf
[1], cmd
.buf
[2]);
569 case TEST_UNIT_READY
:
570 trace_scsi_test_unit_ready(d
->id
, lun
, tag
);
573 trace_scsi_report_luns(d
->id
, lun
, tag
);
576 trace_scsi_request_sense(d
->id
, lun
, tag
);
585 uint8_t *scsi_req_get_buf(SCSIRequest
*req
)
587 return req
->ops
->get_buf(req
);
590 static void scsi_clear_unit_attention(SCSIRequest
*req
)
593 if (req
->dev
->unit_attention
.key
!= UNIT_ATTENTION
&&
594 req
->bus
->unit_attention
.key
!= UNIT_ATTENTION
) {
599 * If an INQUIRY command enters the enabled command state,
600 * the device server shall [not] clear any unit attention condition;
601 * See also MMC-6, paragraphs 6.5 and 6.6.2.
603 if (req
->cmd
.buf
[0] == INQUIRY
||
604 req
->cmd
.buf
[0] == GET_CONFIGURATION
||
605 req
->cmd
.buf
[0] == GET_EVENT_STATUS_NOTIFICATION
) {
609 if (req
->dev
->unit_attention
.key
== UNIT_ATTENTION
) {
610 ua
= &req
->dev
->unit_attention
;
612 ua
= &req
->bus
->unit_attention
;
616 * If a REPORT LUNS command enters the enabled command state, [...]
617 * the device server shall clear any pending unit attention condition
618 * with an additional sense code of REPORTED LUNS DATA HAS CHANGED.
620 if (req
->cmd
.buf
[0] == REPORT_LUNS
&&
621 !(ua
->asc
== SENSE_CODE(REPORTED_LUNS_CHANGED
).asc
&&
622 ua
->ascq
== SENSE_CODE(REPORTED_LUNS_CHANGED
).ascq
)) {
626 *ua
= SENSE_CODE(NO_SENSE
);
629 int scsi_req_get_sense(SCSIRequest
*req
, uint8_t *buf
, int len
)
634 if (!req
->sense_len
) {
638 ret
= scsi_build_sense(req
->sense
, req
->sense_len
, buf
, len
, true);
641 * FIXME: clearing unit attention conditions upon autosense should be done
642 * only if the UA_INTLCK_CTRL field in the Control mode page is set to 00b
645 * We assume UA_INTLCK_CTRL to be 00b for HBAs that support autosense, and
646 * 10b for HBAs that do not support it (do not call scsi_req_get_sense).
647 * Here we handle unit attention clearing for UA_INTLCK_CTRL == 00b.
649 if (req
->dev
->sense_is_ua
) {
650 scsi_device_unit_attention_reported(req
->dev
);
651 req
->dev
->sense_len
= 0;
652 req
->dev
->sense_is_ua
= false;
657 int scsi_device_get_sense(SCSIDevice
*dev
, uint8_t *buf
, int len
, bool fixed
)
659 return scsi_build_sense(dev
->sense
, dev
->sense_len
, buf
, len
, fixed
);
662 void scsi_req_build_sense(SCSIRequest
*req
, SCSISense sense
)
664 trace_scsi_req_build_sense(req
->dev
->id
, req
->lun
, req
->tag
,
665 sense
.key
, sense
.asc
, sense
.ascq
);
666 memset(req
->sense
, 0, 18);
667 req
->sense
[0] = 0x70;
668 req
->sense
[2] = sense
.key
;
670 req
->sense
[12] = sense
.asc
;
671 req
->sense
[13] = sense
.ascq
;
675 static void scsi_req_enqueue_internal(SCSIRequest
*req
)
677 assert(!req
->enqueued
);
679 if (req
->bus
->info
->get_sg_list
) {
680 req
->sg
= req
->bus
->info
->get_sg_list(req
);
684 req
->enqueued
= true;
685 QTAILQ_INSERT_TAIL(&req
->dev
->requests
, req
, next
);
688 int32_t scsi_req_enqueue(SCSIRequest
*req
)
693 scsi_req_enqueue_internal(req
);
695 rc
= req
->ops
->send_command(req
, req
->cmd
.buf
);
700 static void scsi_req_dequeue(SCSIRequest
*req
)
702 trace_scsi_req_dequeue(req
->dev
->id
, req
->lun
, req
->tag
);
705 QTAILQ_REMOVE(&req
->dev
->requests
, req
, next
);
706 req
->enqueued
= false;
711 static int scsi_get_performance_length(int num_desc
, int type
, int data_type
)
713 /* MMC-6, paragraph 6.7. */
716 if ((data_type
& 3) == 0) {
717 /* Each descriptor is as in Table 295 - Nominal performance. */
718 return 16 * num_desc
+ 8;
720 /* Each descriptor is as in Table 296 - Exceptions. */
721 return 6 * num_desc
+ 8;
726 return 8 * num_desc
+ 8;
728 return 2048 * num_desc
+ 8;
730 return 16 * num_desc
+ 8;
736 static int ata_passthrough_xfer_unit(SCSIDevice
*dev
, uint8_t *buf
)
738 int byte_block
= (buf
[2] >> 2) & 0x1;
739 int type
= (buf
[2] >> 4) & 0x1;
744 xfer_unit
= dev
->blocksize
;
755 static int ata_passthrough_12_xfer_size(SCSIDevice
*dev
, uint8_t *buf
)
757 int length
= buf
[2] & 0x3;
759 int unit
= ata_passthrough_xfer_unit(dev
, buf
);
763 case 3: /* USB-specific. */
778 static int ata_passthrough_16_xfer_size(SCSIDevice
*dev
, uint8_t *buf
)
780 int extend
= buf
[1] & 0x1;
781 int length
= buf
[2] & 0x3;
783 int unit
= ata_passthrough_xfer_unit(dev
, buf
);
787 case 3: /* USB-specific. */
793 xfer
|= (extend
? buf
[3] << 8 : 0);
797 xfer
|= (extend
? buf
[5] << 8 : 0);
804 uint32_t scsi_data_cdb_length(uint8_t *buf
)
806 if ((buf
[0] >> 5) == 0 && buf
[4] == 0) {
809 return scsi_cdb_length(buf
);
813 uint32_t scsi_cdb_length(uint8_t *buf
)
815 switch (buf
[0] >> 5) {
821 return lduw_be_p(&buf
[7]);
824 return ldl_be_p(&buf
[10]) & 0xffffffffULL
;
827 return ldl_be_p(&buf
[6]) & 0xffffffffULL
;
834 static int scsi_req_length(SCSICommand
*cmd
, SCSIDevice
*dev
, uint8_t *buf
)
836 cmd
->xfer
= scsi_cdb_length(buf
);
838 case TEST_UNIT_READY
:
842 case WRITE_FILEMARKS
:
843 case WRITE_FILEMARKS_16
:
848 case ALLOW_MEDIUM_REMOVAL
:
851 case SYNCHRONIZE_CACHE
:
852 case SYNCHRONIZE_CACHE_16
:
854 case LOCK_UNLOCK_CACHE
:
863 case ALLOW_OVERWRITE
:
870 cmd
->xfer
= dev
->blocksize
;
872 case READ_CAPACITY_10
:
875 case READ_BLOCK_LIMITS
:
878 case SEND_VOLUME_TAG
:
879 /* GPCMD_SET_STREAMING from multimedia commands. */
880 if (dev
->type
== TYPE_ROM
) {
881 cmd
->xfer
= buf
[10] | (buf
[9] << 8);
883 cmd
->xfer
= buf
[9] | (buf
[8] << 8);
887 /* length 0 means 256 blocks */
888 if (cmd
->xfer
== 0) {
892 case WRITE_VERIFY_10
:
894 case WRITE_VERIFY_12
:
896 case WRITE_VERIFY_16
:
897 cmd
->xfer
*= dev
->blocksize
;
901 /* length 0 means 256 blocks */
902 if (cmd
->xfer
== 0) {
906 case RECOVER_BUFFERED_DATA
:
909 cmd
->xfer
*= dev
->blocksize
;
912 /* MMC mandates the parameter list to be 12-bytes long. Parameters
913 * for block devices are restricted to the header right now. */
914 if (dev
->type
== TYPE_ROM
&& (buf
[1] & 16)) {
917 cmd
->xfer
= (buf
[1] & 16) == 0 ? 0 : (buf
[1] & 32 ? 8 : 4);
921 case RECEIVE_DIAGNOSTIC
:
922 case SEND_DIAGNOSTIC
:
923 cmd
->xfer
= buf
[4] | (buf
[3] << 8);
929 cmd
->xfer
= buf
[8] | (buf
[7] << 8) | (buf
[6] << 16);
931 case PERSISTENT_RESERVE_OUT
:
932 cmd
->xfer
= ldl_be_p(&buf
[5]) & 0xffffffffULL
;
935 if (dev
->type
== TYPE_ROM
) {
936 /* MMC command GET PERFORMANCE. */
937 cmd
->xfer
= scsi_get_performance_length(buf
[9] | (buf
[8] << 8),
938 buf
[10], buf
[1] & 0x1f);
941 case MECHANISM_STATUS
:
942 case READ_DVD_STRUCTURE
:
943 case SEND_DVD_STRUCTURE
:
944 case MAINTENANCE_OUT
:
946 if (dev
->type
== TYPE_ROM
) {
947 /* GPCMD_REPORT_KEY and GPCMD_SEND_KEY from multi media commands */
948 cmd
->xfer
= buf
[9] | (buf
[8] << 8);
951 case ATA_PASSTHROUGH_12
:
952 if (dev
->type
== TYPE_ROM
) {
953 /* BLANK command of MMC */
956 cmd
->xfer
= ata_passthrough_12_xfer_size(dev
, buf
);
959 case ATA_PASSTHROUGH_16
:
960 cmd
->xfer
= ata_passthrough_16_xfer_size(dev
, buf
);
966 static int scsi_req_stream_length(SCSICommand
*cmd
, SCSIDevice
*dev
, uint8_t *buf
)
969 /* stream commands */
976 case RECOVER_BUFFERED_DATA
:
978 cmd
->xfer
= buf
[4] | (buf
[3] << 8) | (buf
[2] << 16);
979 if (buf
[1] & 0x01) { /* fixed */
980 cmd
->xfer
*= dev
->blocksize
;
984 case READ_REVERSE_16
:
987 cmd
->xfer
= buf
[14] | (buf
[13] << 8) | (buf
[12] << 16);
988 if (buf
[1] & 0x01) { /* fixed */
989 cmd
->xfer
*= dev
->blocksize
;
997 cmd
->xfer
= buf
[13] | (buf
[12] << 8);
1000 switch (buf
[1] & 0x1f) /* operation code */ {
1001 case SHORT_FORM_BLOCK_ID
:
1002 case SHORT_FORM_VENDOR_SPECIFIC
:
1009 cmd
->xfer
= buf
[8] | (buf
[7] << 8);
1017 cmd
->xfer
= buf
[4] | (buf
[3] << 8);
1019 /* generic commands */
1021 return scsi_req_length(cmd
, dev
, buf
);
1026 static int scsi_req_medium_changer_length(SCSICommand
*cmd
, SCSIDevice
*dev
, uint8_t *buf
)
1029 /* medium changer commands */
1030 case EXCHANGE_MEDIUM
:
1031 case INITIALIZE_ELEMENT_STATUS
:
1032 case INITIALIZE_ELEMENT_STATUS_WITH_RANGE
:
1034 case POSITION_TO_ELEMENT
:
1037 case READ_ELEMENT_STATUS
:
1038 cmd
->xfer
= buf
[9] | (buf
[8] << 8) | (buf
[7] << 16);
1041 /* generic commands */
1043 return scsi_req_length(cmd
, dev
, buf
);
1049 static void scsi_cmd_xfer_mode(SCSICommand
*cmd
)
1052 cmd
->mode
= SCSI_XFER_NONE
;
1055 switch (cmd
->buf
[0]) {
1058 case WRITE_VERIFY_10
:
1060 case WRITE_VERIFY_12
:
1062 case WRITE_VERIFY_16
:
1066 case CHANGE_DEFINITION
:
1069 case MODE_SELECT_10
:
1070 case SEND_DIAGNOSTIC
:
1073 case REASSIGN_BLOCKS
:
1082 case SEARCH_HIGH_12
:
1083 case SEARCH_EQUAL_12
:
1086 case SEND_VOLUME_TAG
:
1087 case SEND_CUE_SHEET
:
1088 case SEND_DVD_STRUCTURE
:
1089 case PERSISTENT_RESERVE_OUT
:
1090 case MAINTENANCE_OUT
:
1091 cmd
->mode
= SCSI_XFER_TO_DEV
;
1093 case ATA_PASSTHROUGH_12
:
1094 case ATA_PASSTHROUGH_16
:
1096 cmd
->mode
= (cmd
->buf
[2] & 0x8) ?
1097 SCSI_XFER_FROM_DEV
: SCSI_XFER_TO_DEV
;
1100 cmd
->mode
= SCSI_XFER_FROM_DEV
;
1105 static uint64_t scsi_cmd_lba(SCSICommand
*cmd
)
1107 uint8_t *buf
= cmd
->buf
;
1110 switch (buf
[0] >> 5) {
1112 lba
= ldl_be_p(&buf
[0]) & 0x1fffff;
1117 lba
= ldl_be_p(&buf
[2]) & 0xffffffffULL
;
1120 lba
= ldq_be_p(&buf
[2]);
1129 int scsi_req_parse(SCSICommand
*cmd
, SCSIDevice
*dev
, uint8_t *buf
)
1133 switch (buf
[0] >> 5) {
1151 switch (dev
->type
) {
1153 rc
= scsi_req_stream_length(cmd
, dev
, buf
);
1155 case TYPE_MEDIUM_CHANGER
:
1156 rc
= scsi_req_medium_changer_length(cmd
, dev
, buf
);
1159 rc
= scsi_req_length(cmd
, dev
, buf
);
1166 memcpy(cmd
->buf
, buf
, cmd
->len
);
1167 scsi_cmd_xfer_mode(cmd
);
1168 cmd
->lba
= scsi_cmd_lba(cmd
);
1172 void scsi_device_report_change(SCSIDevice
*dev
, SCSISense sense
)
1174 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, dev
->qdev
.parent_bus
);
1176 scsi_device_set_ua(dev
, sense
);
1177 if (bus
->info
->change
) {
1178 bus
->info
->change(bus
, dev
, sense
);
1183 * Predefined sense codes
1186 /* No sense data available */
1187 const struct SCSISense sense_code_NO_SENSE
= {
1188 .key
= NO_SENSE
, .asc
= 0x00 , .ascq
= 0x00
1191 /* LUN not ready, Manual intervention required */
1192 const struct SCSISense sense_code_LUN_NOT_READY
= {
1193 .key
= NOT_READY
, .asc
= 0x04, .ascq
= 0x03
1196 /* LUN not ready, Medium not present */
1197 const struct SCSISense sense_code_NO_MEDIUM
= {
1198 .key
= NOT_READY
, .asc
= 0x3a, .ascq
= 0x00
1201 /* LUN not ready, medium removal prevented */
1202 const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED
= {
1203 .key
= NOT_READY
, .asc
= 0x53, .ascq
= 0x02
1206 /* Hardware error, internal target failure */
1207 const struct SCSISense sense_code_TARGET_FAILURE
= {
1208 .key
= HARDWARE_ERROR
, .asc
= 0x44, .ascq
= 0x00
1211 /* Illegal request, invalid command operation code */
1212 const struct SCSISense sense_code_INVALID_OPCODE
= {
1213 .key
= ILLEGAL_REQUEST
, .asc
= 0x20, .ascq
= 0x00
1216 /* Illegal request, LBA out of range */
1217 const struct SCSISense sense_code_LBA_OUT_OF_RANGE
= {
1218 .key
= ILLEGAL_REQUEST
, .asc
= 0x21, .ascq
= 0x00
1221 /* Illegal request, Invalid field in CDB */
1222 const struct SCSISense sense_code_INVALID_FIELD
= {
1223 .key
= ILLEGAL_REQUEST
, .asc
= 0x24, .ascq
= 0x00
1226 /* Illegal request, Invalid field in parameter list */
1227 const struct SCSISense sense_code_INVALID_PARAM
= {
1228 .key
= ILLEGAL_REQUEST
, .asc
= 0x26, .ascq
= 0x00
1231 /* Illegal request, Parameter list length error */
1232 const struct SCSISense sense_code_INVALID_PARAM_LEN
= {
1233 .key
= ILLEGAL_REQUEST
, .asc
= 0x1a, .ascq
= 0x00
1236 /* Illegal request, LUN not supported */
1237 const struct SCSISense sense_code_LUN_NOT_SUPPORTED
= {
1238 .key
= ILLEGAL_REQUEST
, .asc
= 0x25, .ascq
= 0x00
1241 /* Illegal request, Saving parameters not supported */
1242 const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED
= {
1243 .key
= ILLEGAL_REQUEST
, .asc
= 0x39, .ascq
= 0x00
1246 /* Illegal request, Incompatible medium installed */
1247 const struct SCSISense sense_code_INCOMPATIBLE_FORMAT
= {
1248 .key
= ILLEGAL_REQUEST
, .asc
= 0x30, .ascq
= 0x00
1251 /* Illegal request, medium removal prevented */
1252 const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED
= {
1253 .key
= ILLEGAL_REQUEST
, .asc
= 0x53, .ascq
= 0x02
1256 /* Command aborted, I/O process terminated */
1257 const struct SCSISense sense_code_IO_ERROR
= {
1258 .key
= ABORTED_COMMAND
, .asc
= 0x00, .ascq
= 0x06
1261 /* Command aborted, I_T Nexus loss occurred */
1262 const struct SCSISense sense_code_I_T_NEXUS_LOSS
= {
1263 .key
= ABORTED_COMMAND
, .asc
= 0x29, .ascq
= 0x07
1266 /* Command aborted, Logical Unit failure */
1267 const struct SCSISense sense_code_LUN_FAILURE
= {
1268 .key
= ABORTED_COMMAND
, .asc
= 0x3e, .ascq
= 0x01
1271 /* Unit attention, Capacity data has changed */
1272 const struct SCSISense sense_code_CAPACITY_CHANGED
= {
1273 .key
= UNIT_ATTENTION
, .asc
= 0x2a, .ascq
= 0x09
1276 /* Unit attention, Power on, reset or bus device reset occurred */
1277 const struct SCSISense sense_code_RESET
= {
1278 .key
= UNIT_ATTENTION
, .asc
= 0x29, .ascq
= 0x00
1281 /* Unit attention, No medium */
1282 const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM
= {
1283 .key
= UNIT_ATTENTION
, .asc
= 0x3a, .ascq
= 0x00
1286 /* Unit attention, Medium may have changed */
1287 const struct SCSISense sense_code_MEDIUM_CHANGED
= {
1288 .key
= UNIT_ATTENTION
, .asc
= 0x28, .ascq
= 0x00
1291 /* Unit attention, Reported LUNs data has changed */
1292 const struct SCSISense sense_code_REPORTED_LUNS_CHANGED
= {
1293 .key
= UNIT_ATTENTION
, .asc
= 0x3f, .ascq
= 0x0e
1296 /* Unit attention, Device internal reset */
1297 const struct SCSISense sense_code_DEVICE_INTERNAL_RESET
= {
1298 .key
= UNIT_ATTENTION
, .asc
= 0x29, .ascq
= 0x04
1301 /* Data Protection, Write Protected */
1302 const struct SCSISense sense_code_WRITE_PROTECTED
= {
1303 .key
= DATA_PROTECT
, .asc
= 0x27, .ascq
= 0x00
1309 * Convert between fixed and descriptor sense buffers
1311 int scsi_build_sense(uint8_t *in_buf
, int in_len
,
1312 uint8_t *buf
, int len
, bool fixed
)
1316 if (!fixed
&& len
< 8) {
1321 sense
.key
= NO_SENSE
;
1325 fixed_in
= (in_buf
[0] & 2) == 0;
1327 if (fixed
== fixed_in
) {
1328 memcpy(buf
, in_buf
, MIN(len
, in_len
));
1329 return MIN(len
, in_len
);
1333 sense
.key
= in_buf
[2];
1334 sense
.asc
= in_buf
[12];
1335 sense
.ascq
= in_buf
[13];
1337 sense
.key
= in_buf
[1];
1338 sense
.asc
= in_buf
[2];
1339 sense
.ascq
= in_buf
[3];
1343 memset(buf
, 0, len
);
1345 /* Return fixed format sense buffer */
1349 buf
[12] = sense
.asc
;
1350 buf
[13] = sense
.ascq
;
1351 return MIN(len
, 18);
1353 /* Return descriptor format sense buffer */
1357 buf
[3] = sense
.ascq
;
1362 static const char *scsi_command_name(uint8_t cmd
)
1364 static const char *names
[] = {
1365 [ TEST_UNIT_READY
] = "TEST_UNIT_READY",
1366 [ REWIND
] = "REWIND",
1367 [ REQUEST_SENSE
] = "REQUEST_SENSE",
1368 [ FORMAT_UNIT
] = "FORMAT_UNIT",
1369 [ READ_BLOCK_LIMITS
] = "READ_BLOCK_LIMITS",
1370 [ REASSIGN_BLOCKS
] = "REASSIGN_BLOCKS/INITIALIZE ELEMENT STATUS",
1371 /* LOAD_UNLOAD and INITIALIZE_ELEMENT_STATUS use the same operation code */
1372 [ READ_6
] = "READ_6",
1373 [ WRITE_6
] = "WRITE_6",
1374 [ SET_CAPACITY
] = "SET_CAPACITY",
1375 [ READ_REVERSE
] = "READ_REVERSE",
1376 [ WRITE_FILEMARKS
] = "WRITE_FILEMARKS",
1377 [ SPACE
] = "SPACE",
1378 [ INQUIRY
] = "INQUIRY",
1379 [ RECOVER_BUFFERED_DATA
] = "RECOVER_BUFFERED_DATA",
1380 [ MAINTENANCE_IN
] = "MAINTENANCE_IN",
1381 [ MAINTENANCE_OUT
] = "MAINTENANCE_OUT",
1382 [ MODE_SELECT
] = "MODE_SELECT",
1383 [ RESERVE
] = "RESERVE",
1384 [ RELEASE
] = "RELEASE",
1386 [ ERASE
] = "ERASE",
1387 [ MODE_SENSE
] = "MODE_SENSE",
1388 [ START_STOP
] = "START_STOP/LOAD_UNLOAD",
1389 /* LOAD_UNLOAD and START_STOP use the same operation code */
1390 [ RECEIVE_DIAGNOSTIC
] = "RECEIVE_DIAGNOSTIC",
1391 [ SEND_DIAGNOSTIC
] = "SEND_DIAGNOSTIC",
1392 [ ALLOW_MEDIUM_REMOVAL
] = "ALLOW_MEDIUM_REMOVAL",
1393 [ READ_CAPACITY_10
] = "READ_CAPACITY_10",
1394 [ READ_10
] = "READ_10",
1395 [ WRITE_10
] = "WRITE_10",
1396 [ SEEK_10
] = "SEEK_10/POSITION_TO_ELEMENT",
1397 /* SEEK_10 and POSITION_TO_ELEMENT use the same operation code */
1398 [ WRITE_VERIFY_10
] = "WRITE_VERIFY_10",
1399 [ VERIFY_10
] = "VERIFY_10",
1400 [ SEARCH_HIGH
] = "SEARCH_HIGH",
1401 [ SEARCH_EQUAL
] = "SEARCH_EQUAL",
1402 [ SEARCH_LOW
] = "SEARCH_LOW",
1403 [ SET_LIMITS
] = "SET_LIMITS",
1404 [ PRE_FETCH
] = "PRE_FETCH/READ_POSITION",
1405 /* READ_POSITION and PRE_FETCH use the same operation code */
1406 [ SYNCHRONIZE_CACHE
] = "SYNCHRONIZE_CACHE",
1407 [ LOCK_UNLOCK_CACHE
] = "LOCK_UNLOCK_CACHE",
1408 [ READ_DEFECT_DATA
] = "READ_DEFECT_DATA/INITIALIZE_ELEMENT_STATUS_WITH_RANGE",
1409 /* READ_DEFECT_DATA and INITIALIZE_ELEMENT_STATUS_WITH_RANGE use the same operation code */
1410 [ MEDIUM_SCAN
] = "MEDIUM_SCAN",
1411 [ COMPARE
] = "COMPARE",
1412 [ COPY_VERIFY
] = "COPY_VERIFY",
1413 [ WRITE_BUFFER
] = "WRITE_BUFFER",
1414 [ READ_BUFFER
] = "READ_BUFFER",
1415 [ UPDATE_BLOCK
] = "UPDATE_BLOCK",
1416 [ READ_LONG_10
] = "READ_LONG_10",
1417 [ WRITE_LONG_10
] = "WRITE_LONG_10",
1418 [ CHANGE_DEFINITION
] = "CHANGE_DEFINITION",
1419 [ WRITE_SAME_10
] = "WRITE_SAME_10",
1420 [ UNMAP
] = "UNMAP",
1421 [ READ_TOC
] = "READ_TOC",
1422 [ REPORT_DENSITY_SUPPORT
] = "REPORT_DENSITY_SUPPORT",
1423 [ SANITIZE
] = "SANITIZE",
1424 [ GET_CONFIGURATION
] = "GET_CONFIGURATION",
1425 [ LOG_SELECT
] = "LOG_SELECT",
1426 [ LOG_SENSE
] = "LOG_SENSE",
1427 [ MODE_SELECT_10
] = "MODE_SELECT_10",
1428 [ RESERVE_10
] = "RESERVE_10",
1429 [ RELEASE_10
] = "RELEASE_10",
1430 [ MODE_SENSE_10
] = "MODE_SENSE_10",
1431 [ PERSISTENT_RESERVE_IN
] = "PERSISTENT_RESERVE_IN",
1432 [ PERSISTENT_RESERVE_OUT
] = "PERSISTENT_RESERVE_OUT",
1433 [ WRITE_FILEMARKS_16
] = "WRITE_FILEMARKS_16",
1434 [ EXTENDED_COPY
] = "EXTENDED_COPY",
1435 [ ATA_PASSTHROUGH_16
] = "ATA_PASSTHROUGH_16",
1436 [ ACCESS_CONTROL_IN
] = "ACCESS_CONTROL_IN",
1437 [ ACCESS_CONTROL_OUT
] = "ACCESS_CONTROL_OUT",
1438 [ READ_16
] = "READ_16",
1439 [ COMPARE_AND_WRITE
] = "COMPARE_AND_WRITE",
1440 [ WRITE_16
] = "WRITE_16",
1441 [ WRITE_VERIFY_16
] = "WRITE_VERIFY_16",
1442 [ VERIFY_16
] = "VERIFY_16",
1443 [ PRE_FETCH_16
] = "PRE_FETCH_16",
1444 [ SYNCHRONIZE_CACHE_16
] = "SPACE_16/SYNCHRONIZE_CACHE_16",
1445 /* SPACE_16 and SYNCHRONIZE_CACHE_16 use the same operation code */
1446 [ LOCATE_16
] = "LOCATE_16",
1447 [ WRITE_SAME_16
] = "ERASE_16/WRITE_SAME_16",
1448 /* ERASE_16 and WRITE_SAME_16 use the same operation code */
1449 [ SERVICE_ACTION_IN_16
] = "SERVICE_ACTION_IN_16",
1450 [ WRITE_LONG_16
] = "WRITE_LONG_16",
1451 [ REPORT_LUNS
] = "REPORT_LUNS",
1452 [ ATA_PASSTHROUGH_12
] = "BLANK/ATA_PASSTHROUGH_12",
1453 [ MOVE_MEDIUM
] = "MOVE_MEDIUM",
1454 [ EXCHANGE_MEDIUM
] = "EXCHANGE MEDIUM",
1455 [ READ_12
] = "READ_12",
1456 [ WRITE_12
] = "WRITE_12",
1457 [ ERASE_12
] = "ERASE_12/GET_PERFORMANCE",
1458 /* ERASE_12 and GET_PERFORMANCE use the same operation code */
1459 [ SERVICE_ACTION_IN_12
] = "SERVICE_ACTION_IN_12",
1460 [ WRITE_VERIFY_12
] = "WRITE_VERIFY_12",
1461 [ VERIFY_12
] = "VERIFY_12",
1462 [ SEARCH_HIGH_12
] = "SEARCH_HIGH_12",
1463 [ SEARCH_EQUAL_12
] = "SEARCH_EQUAL_12",
1464 [ SEARCH_LOW_12
] = "SEARCH_LOW_12",
1465 [ READ_ELEMENT_STATUS
] = "READ_ELEMENT_STATUS",
1466 [ SEND_VOLUME_TAG
] = "SEND_VOLUME_TAG/SET_STREAMING",
1467 /* SEND_VOLUME_TAG and SET_STREAMING use the same operation code */
1468 [ READ_CD
] = "READ_CD",
1469 [ READ_DEFECT_DATA_12
] = "READ_DEFECT_DATA_12",
1470 [ READ_DVD_STRUCTURE
] = "READ_DVD_STRUCTURE",
1471 [ RESERVE_TRACK
] = "RESERVE_TRACK",
1472 [ SEND_CUE_SHEET
] = "SEND_CUE_SHEET",
1473 [ SEND_DVD_STRUCTURE
] = "SEND_DVD_STRUCTURE",
1474 [ SET_CD_SPEED
] = "SET_CD_SPEED",
1475 [ SET_READ_AHEAD
] = "SET_READ_AHEAD",
1476 [ ALLOW_OVERWRITE
] = "ALLOW_OVERWRITE",
1477 [ MECHANISM_STATUS
] = "MECHANISM_STATUS",
1480 if (cmd
>= ARRAY_SIZE(names
) || names
[cmd
] == NULL
)
1485 SCSIRequest
*scsi_req_ref(SCSIRequest
*req
)
1487 assert(req
->refcount
> 0);
1492 void scsi_req_unref(SCSIRequest
*req
)
1494 assert(req
->refcount
> 0);
1495 if (--req
->refcount
== 0) {
1496 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, req
->dev
->qdev
.parent_bus
);
1497 if (bus
->info
->free_request
&& req
->hba_private
) {
1498 bus
->info
->free_request(bus
, req
->hba_private
);
1500 if (req
->ops
->free_req
) {
1501 req
->ops
->free_req(req
);
1507 /* Tell the device that we finished processing this chunk of I/O. It
1508 will start the next chunk or complete the command. */
1509 void scsi_req_continue(SCSIRequest
*req
)
1511 trace_scsi_req_continue(req
->dev
->id
, req
->lun
, req
->tag
);
1512 if (req
->cmd
.mode
== SCSI_XFER_TO_DEV
) {
1513 req
->ops
->write_data(req
);
1515 req
->ops
->read_data(req
);
1519 /* Called by the devices when data is ready for the HBA. The HBA should
1520 start a DMA operation to read or fill the device's data buffer.
1521 Once it completes, calling scsi_req_continue will restart I/O. */
1522 void scsi_req_data(SCSIRequest
*req
, int len
)
1525 if (req
->io_canceled
) {
1526 trace_scsi_req_data_canceled(req
->dev
->id
, req
->lun
, req
->tag
, len
);
1529 trace_scsi_req_data(req
->dev
->id
, req
->lun
, req
->tag
, len
);
1530 assert(req
->cmd
.mode
!= SCSI_XFER_NONE
);
1533 req
->bus
->info
->transfer_data(req
, len
);
1537 /* If the device calls scsi_req_data and the HBA specified a
1538 * scatter/gather list, the transfer has to happen in a single
1540 assert(!req
->dma_started
);
1541 req
->dma_started
= true;
1543 buf
= scsi_req_get_buf(req
);
1544 if (req
->cmd
.mode
== SCSI_XFER_FROM_DEV
) {
1545 req
->resid
= dma_buf_read(buf
, len
, req
->sg
);
1547 req
->resid
= dma_buf_write(buf
, len
, req
->sg
);
1549 scsi_req_continue(req
);
1552 void scsi_req_print(SCSIRequest
*req
)
1557 fprintf(fp
, "[%s id=%d] %s",
1558 req
->dev
->qdev
.parent_bus
->name
,
1560 scsi_command_name(req
->cmd
.buf
[0]));
1561 for (i
= 1; i
< req
->cmd
.len
; i
++) {
1562 fprintf(fp
, " 0x%02x", req
->cmd
.buf
[i
]);
1564 switch (req
->cmd
.mode
) {
1565 case SCSI_XFER_NONE
:
1566 fprintf(fp
, " - none\n");
1568 case SCSI_XFER_FROM_DEV
:
1569 fprintf(fp
, " - from-dev len=%zd\n", req
->cmd
.xfer
);
1571 case SCSI_XFER_TO_DEV
:
1572 fprintf(fp
, " - to-dev len=%zd\n", req
->cmd
.xfer
);
1575 fprintf(fp
, " - Oops\n");
1580 void scsi_req_complete(SCSIRequest
*req
, int status
)
1582 assert(req
->status
== -1);
1583 req
->status
= status
;
1585 assert(req
->sense_len
<= sizeof(req
->sense
));
1586 if (status
== GOOD
) {
1590 if (req
->sense_len
) {
1591 memcpy(req
->dev
->sense
, req
->sense
, req
->sense_len
);
1592 req
->dev
->sense_len
= req
->sense_len
;
1593 req
->dev
->sense_is_ua
= (req
->ops
== &reqops_unit_attention
);
1595 req
->dev
->sense_len
= 0;
1596 req
->dev
->sense_is_ua
= false;
1600 * Unit attention state is now stored in the device's sense buffer
1601 * if the HBA didn't do autosense. Clear the pending unit attention
1604 scsi_clear_unit_attention(req
);
1607 scsi_req_dequeue(req
);
1608 req
->bus
->info
->complete(req
, req
->status
, req
->resid
);
1609 scsi_req_unref(req
);
1612 void scsi_req_cancel(SCSIRequest
*req
)
1614 trace_scsi_req_cancel(req
->dev
->id
, req
->lun
, req
->tag
);
1615 if (!req
->enqueued
) {
1619 scsi_req_dequeue(req
);
1620 req
->io_canceled
= true;
1621 if (req
->ops
->cancel_io
) {
1622 req
->ops
->cancel_io(req
);
1624 if (req
->bus
->info
->cancel
) {
1625 req
->bus
->info
->cancel(req
);
1627 scsi_req_unref(req
);
1630 void scsi_req_abort(SCSIRequest
*req
, int status
)
1632 if (!req
->enqueued
) {
1636 scsi_req_dequeue(req
);
1637 req
->io_canceled
= true;
1638 if (req
->ops
->cancel_io
) {
1639 req
->ops
->cancel_io(req
);
1641 scsi_req_complete(req
, status
);
1642 scsi_req_unref(req
);
1645 static int scsi_ua_precedence(SCSISense sense
)
1647 if (sense
.key
!= UNIT_ATTENTION
) {
1650 if (sense
.asc
== 0x29 && sense
.ascq
== 0x04) {
1651 /* DEVICE INTERNAL RESET goes with POWER ON OCCURRED */
1653 } else if (sense
.asc
== 0x3F && sense
.ascq
== 0x01) {
1654 /* MICROCODE HAS BEEN CHANGED goes with SCSI BUS RESET OCCURRED */
1656 } else if (sense
.asc
== 0x29 && (sense
.ascq
== 0x05 || sense
.ascq
== 0x06)) {
1657 /* These two go with "all others". */
1659 } else if (sense
.asc
== 0x29 && sense
.ascq
<= 0x07) {
1660 /* POWER ON, RESET OR BUS DEVICE RESET OCCURRED = 0
1661 * POWER ON OCCURRED = 1
1662 * SCSI BUS RESET OCCURRED = 2
1663 * BUS DEVICE RESET FUNCTION OCCURRED = 3
1664 * I_T NEXUS LOSS OCCURRED = 7
1667 } else if (sense
.asc
== 0x2F && sense
.ascq
== 0x01) {
1668 /* COMMANDS CLEARED BY POWER LOSS NOTIFICATION */
1671 return (sense
.asc
<< 8) | sense
.ascq
;
1674 void scsi_device_set_ua(SCSIDevice
*sdev
, SCSISense sense
)
1677 if (sense
.key
!= UNIT_ATTENTION
) {
1680 trace_scsi_device_set_ua(sdev
->id
, sdev
->lun
, sense
.key
,
1681 sense
.asc
, sense
.ascq
);
1684 * Override a pre-existing unit attention condition, except for a more
1685 * important reset condition.
1687 prec1
= scsi_ua_precedence(sdev
->unit_attention
);
1688 prec2
= scsi_ua_precedence(sense
);
1689 if (prec2
< prec1
) {
1690 sdev
->unit_attention
= sense
;
1694 void scsi_device_purge_requests(SCSIDevice
*sdev
, SCSISense sense
)
1698 while (!QTAILQ_EMPTY(&sdev
->requests
)) {
1699 req
= QTAILQ_FIRST(&sdev
->requests
);
1700 scsi_req_cancel(req
);
1703 scsi_device_set_ua(sdev
, sense
);
1706 static char *scsibus_get_dev_path(DeviceState
*dev
)
1708 SCSIDevice
*d
= DO_UPCAST(SCSIDevice
, qdev
, dev
);
1709 DeviceState
*hba
= dev
->parent_bus
->parent
;
1713 id
= qdev_get_dev_path(hba
);
1715 path
= g_strdup_printf("%s/%d:%d:%d", id
, d
->channel
, d
->id
, d
->lun
);
1717 path
= g_strdup_printf("%d:%d:%d", d
->channel
, d
->id
, d
->lun
);
1723 static char *scsibus_get_fw_dev_path(DeviceState
*dev
)
1725 SCSIDevice
*d
= SCSI_DEVICE(dev
);
1726 return g_strdup_printf("channel@%x/%s@%x,%x", d
->channel
,
1727 qdev_fw_name(dev
), d
->id
, d
->lun
);
1730 SCSIDevice
*scsi_device_find(SCSIBus
*bus
, int channel
, int id
, int lun
)
1733 SCSIDevice
*target_dev
= NULL
;
1735 QTAILQ_FOREACH_REVERSE(kid
, &bus
->qbus
.children
, ChildrenHead
, sibling
) {
1736 DeviceState
*qdev
= kid
->child
;
1737 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
1739 if (dev
->channel
== channel
&& dev
->id
== id
) {
1740 if (dev
->lun
== lun
) {
1749 /* SCSI request list. For simplicity, pv points to the whole device */
1751 static void put_scsi_requests(QEMUFile
*f
, void *pv
, size_t size
)
1754 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, s
->qdev
.parent_bus
);
1757 QTAILQ_FOREACH(req
, &s
->requests
, next
) {
1758 assert(!req
->io_canceled
);
1759 assert(req
->status
== -1);
1760 assert(req
->enqueued
);
1762 qemu_put_sbyte(f
, req
->retry
? 1 : 2);
1763 qemu_put_buffer(f
, req
->cmd
.buf
, sizeof(req
->cmd
.buf
));
1764 qemu_put_be32s(f
, &req
->tag
);
1765 qemu_put_be32s(f
, &req
->lun
);
1766 if (bus
->info
->save_request
) {
1767 bus
->info
->save_request(f
, req
);
1769 if (req
->ops
->save_request
) {
1770 req
->ops
->save_request(f
, req
);
1773 qemu_put_sbyte(f
, 0);
1776 static int get_scsi_requests(QEMUFile
*f
, void *pv
, size_t size
)
1779 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, s
->qdev
.parent_bus
);
1782 while ((sbyte
= qemu_get_sbyte(f
)) > 0) {
1783 uint8_t buf
[SCSI_CMD_BUF_SIZE
];
1788 qemu_get_buffer(f
, buf
, sizeof(buf
));
1789 qemu_get_be32s(f
, &tag
);
1790 qemu_get_be32s(f
, &lun
);
1791 req
= scsi_req_new(s
, tag
, lun
, buf
, NULL
);
1792 req
->retry
= (sbyte
== 1);
1793 if (bus
->info
->load_request
) {
1794 req
->hba_private
= bus
->info
->load_request(f
, req
);
1796 if (req
->ops
->load_request
) {
1797 req
->ops
->load_request(f
, req
);
1800 /* Just restart it later. */
1801 scsi_req_enqueue_internal(req
);
1803 /* At this point, the request will be kept alive by the reference
1804 * added by scsi_req_enqueue_internal, so we can release our reference.
1805 * The HBA of course will add its own reference in the load_request
1806 * callback if it needs to hold on the SCSIRequest.
1808 scsi_req_unref(req
);
1814 static int scsi_qdev_unplug(DeviceState
*qdev
)
1816 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
1817 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, dev
->qdev
.parent_bus
);
1819 if (bus
->info
->hot_unplug
) {
1820 bus
->info
->hot_unplug(bus
, dev
);
1822 return qdev_simple_unplug_cb(qdev
);
1825 static const VMStateInfo vmstate_info_scsi_requests
= {
1826 .name
= "scsi-requests",
1827 .get
= get_scsi_requests
,
1828 .put
= put_scsi_requests
,
1831 const VMStateDescription vmstate_scsi_device
= {
1832 .name
= "SCSIDevice",
1834 .minimum_version_id
= 1,
1835 .minimum_version_id_old
= 1,
1836 .fields
= (VMStateField
[]) {
1837 VMSTATE_UINT8(unit_attention
.key
, SCSIDevice
),
1838 VMSTATE_UINT8(unit_attention
.asc
, SCSIDevice
),
1839 VMSTATE_UINT8(unit_attention
.ascq
, SCSIDevice
),
1840 VMSTATE_BOOL(sense_is_ua
, SCSIDevice
),
1841 VMSTATE_UINT8_ARRAY(sense
, SCSIDevice
, SCSI_SENSE_BUF_SIZE
),
1842 VMSTATE_UINT32(sense_len
, SCSIDevice
),
1846 .field_exists
= NULL
,
1847 .size
= 0, /* ouch */
1848 .info
= &vmstate_info_scsi_requests
,
1849 .flags
= VMS_SINGLE
,
1852 VMSTATE_END_OF_LIST()
1856 static void scsi_device_class_init(ObjectClass
*klass
, void *data
)
1858 DeviceClass
*k
= DEVICE_CLASS(klass
);
1859 k
->bus_type
= TYPE_SCSI_BUS
;
1860 k
->init
= scsi_qdev_init
;
1861 k
->unplug
= scsi_qdev_unplug
;
1862 k
->exit
= scsi_qdev_exit
;
1863 k
->props
= scsi_props
;
1866 static const TypeInfo scsi_device_type_info
= {
1867 .name
= TYPE_SCSI_DEVICE
,
1868 .parent
= TYPE_DEVICE
,
1869 .instance_size
= sizeof(SCSIDevice
),
1871 .class_size
= sizeof(SCSIDeviceClass
),
1872 .class_init
= scsi_device_class_init
,
1875 static void scsi_register_types(void)
1877 type_register_static(&scsi_bus_info
);
1878 type_register_static(&scsi_device_type_info
);
1881 type_init(scsi_register_types
)