2 #include "qemu-error.h"
9 static char *scsibus_get_fw_dev_path(DeviceState
*dev
);
10 static int scsi_req_parse(SCSICommand
*cmd
, SCSIDevice
*dev
, uint8_t *buf
);
11 static void scsi_req_dequeue(SCSIRequest
*req
);
13 static struct BusInfo scsi_bus_info
= {
15 .size
= sizeof(SCSIBus
),
16 .get_fw_dev_path
= scsibus_get_fw_dev_path
,
17 .props
= (Property
[]) {
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 int next_scsi_bus
;
26 static int scsi_device_init(SCSIDevice
*s
)
28 SCSIDeviceClass
*sc
= SCSI_DEVICE_GET_CLASS(s
);
35 static void scsi_device_destroy(SCSIDevice
*s
)
37 SCSIDeviceClass
*sc
= SCSI_DEVICE_GET_CLASS(s
);
43 static SCSIRequest
*scsi_device_alloc_req(SCSIDevice
*s
, uint32_t tag
, uint32_t lun
,
44 uint8_t *buf
, void *hba_private
)
46 SCSIDeviceClass
*sc
= SCSI_DEVICE_GET_CLASS(s
);
48 return sc
->alloc_req(s
, tag
, lun
, buf
, hba_private
);
54 static void scsi_device_unit_attention_reported(SCSIDevice
*s
)
56 SCSIDeviceClass
*sc
= SCSI_DEVICE_GET_CLASS(s
);
57 if (sc
->unit_attention_reported
) {
58 sc
->unit_attention_reported(s
);
62 /* Create a scsi bus, and attach devices to it. */
63 void scsi_bus_new(SCSIBus
*bus
, DeviceState
*host
, const SCSIBusInfo
*info
)
65 qbus_create_inplace(&bus
->qbus
, &scsi_bus_info
, host
, NULL
);
66 bus
->busnr
= next_scsi_bus
++;
68 bus
->qbus
.allow_hotplug
= 1;
71 static void scsi_dma_restart_bh(void *opaque
)
73 SCSIDevice
*s
= opaque
;
74 SCSIRequest
*req
, *next
;
76 qemu_bh_delete(s
->bh
);
79 QTAILQ_FOREACH_SAFE(req
, &s
->requests
, next
, next
) {
83 switch (req
->cmd
.mode
) {
84 case SCSI_XFER_FROM_DEV
:
85 case SCSI_XFER_TO_DEV
:
86 scsi_req_continue(req
);
89 scsi_req_dequeue(req
);
90 scsi_req_enqueue(req
);
98 void scsi_req_retry(SCSIRequest
*req
)
100 /* No need to save a reference, because scsi_dma_restart_bh just
101 * looks at the request list. */
105 static void scsi_dma_restart_cb(void *opaque
, int running
, RunState state
)
107 SCSIDevice
*s
= opaque
;
113 s
->bh
= qemu_bh_new(scsi_dma_restart_bh
, s
);
114 qemu_bh_schedule(s
->bh
);
118 static int scsi_qdev_init(DeviceState
*qdev
, DeviceInfo
*base
)
120 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
121 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, dev
->qdev
.parent_bus
);
125 if (dev
->channel
> bus
->info
->max_channel
) {
126 error_report("bad scsi channel id: %d", dev
->channel
);
129 if (dev
->id
!= -1 && dev
->id
> bus
->info
->max_target
) {
130 error_report("bad scsi device id: %d", dev
->id
);
136 if (dev
->lun
== -1) {
140 d
= scsi_device_find(bus
, dev
->channel
, ++id
, dev
->lun
);
141 } while (d
&& d
->lun
== dev
->lun
&& id
<= bus
->info
->max_target
);
142 if (id
> bus
->info
->max_target
) {
143 error_report("no free target");
147 } else if (dev
->lun
== -1) {
150 d
= scsi_device_find(bus
, dev
->channel
, dev
->id
, ++lun
);
151 } while (d
&& d
->lun
== lun
&& lun
< bus
->info
->max_lun
);
152 if (lun
> bus
->info
->max_lun
) {
153 error_report("no free lun");
158 d
= scsi_device_find(bus
, dev
->channel
, dev
->id
, dev
->lun
);
159 if (dev
->lun
== d
->lun
&& dev
!= d
) {
164 QTAILQ_INIT(&dev
->requests
);
165 rc
= scsi_device_init(dev
);
167 dev
->vmsentry
= qemu_add_vm_change_state_handler(scsi_dma_restart_cb
,
175 static int scsi_qdev_exit(DeviceState
*qdev
)
177 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
180 qemu_del_vm_change_state_handler(dev
->vmsentry
);
182 scsi_device_destroy(dev
);
186 void scsi_qdev_register(DeviceInfo
*info
)
188 info
->bus_info
= &scsi_bus_info
;
189 info
->init
= scsi_qdev_init
;
190 info
->unplug
= qdev_simple_unplug_cb
;
191 info
->exit
= scsi_qdev_exit
;
192 qdev_register_subclass(info
, TYPE_SCSI_DEVICE
);
195 /* handle legacy '-drive if=scsi,...' cmd line args */
196 SCSIDevice
*scsi_bus_legacy_add_drive(SCSIBus
*bus
, BlockDriverState
*bdrv
,
197 int unit
, bool removable
, int bootindex
)
202 driver
= bdrv_is_sg(bdrv
) ? "scsi-generic" : "scsi-disk";
203 dev
= qdev_create(&bus
->qbus
, driver
);
204 qdev_prop_set_uint32(dev
, "scsi-id", unit
);
205 if (bootindex
>= 0) {
206 qdev_prop_set_int32(dev
, "bootindex", bootindex
);
208 if (qdev_prop_exists(dev
, "removable")) {
209 qdev_prop_set_bit(dev
, "removable", removable
);
211 if (qdev_prop_set_drive(dev
, "drive", bdrv
) < 0) {
215 if (qdev_init(dev
) < 0)
217 return SCSI_DEVICE(dev
);
220 int scsi_bus_legacy_handle_cmdline(SCSIBus
*bus
)
227 for (unit
= 0; unit
< bus
->info
->max_target
; unit
++) {
228 dinfo
= drive_get(IF_SCSI
, bus
->busnr
, unit
);
232 qemu_opts_loc_restore(dinfo
->opts
);
233 if (!scsi_bus_legacy_add_drive(bus
, dinfo
->bdrv
, unit
, false, -1)) {
242 /* SCSIReqOps implementation for invalid commands. */
244 static int32_t scsi_invalid_command(SCSIRequest
*req
, uint8_t *buf
)
246 scsi_req_build_sense(req
, SENSE_CODE(INVALID_OPCODE
));
247 scsi_req_complete(req
, CHECK_CONDITION
);
251 static const struct SCSIReqOps reqops_invalid_opcode
= {
252 .size
= sizeof(SCSIRequest
),
253 .send_command
= scsi_invalid_command
256 /* SCSIReqOps implementation for unit attention conditions. */
258 static int32_t scsi_unit_attention(SCSIRequest
*req
, uint8_t *buf
)
260 if (req
->dev
&& req
->dev
->unit_attention
.key
== UNIT_ATTENTION
) {
261 scsi_req_build_sense(req
, req
->dev
->unit_attention
);
262 } else if (req
->bus
->unit_attention
.key
== UNIT_ATTENTION
) {
263 scsi_req_build_sense(req
, req
->bus
->unit_attention
);
265 scsi_req_complete(req
, CHECK_CONDITION
);
269 static const struct SCSIReqOps reqops_unit_attention
= {
270 .size
= sizeof(SCSIRequest
),
271 .send_command
= scsi_unit_attention
274 /* SCSIReqOps implementation for REPORT LUNS and for commands sent to
277 typedef struct SCSITargetReq SCSITargetReq
;
279 struct SCSITargetReq
{
285 static void store_lun(uint8_t *outbuf
, int lun
)
291 outbuf
[1] = (lun
& 255);
292 outbuf
[0] = (lun
>> 8) | 0x40;
295 static bool scsi_target_emulate_report_luns(SCSITargetReq
*r
)
302 if (r
->req
.cmd
.xfer
< 16) {
305 if (r
->req
.cmd
.buf
[2] > 2) {
308 channel
= r
->req
.dev
->channel
;
312 QTAILQ_FOREACH(qdev
, &r
->req
.bus
->qbus
.children
, sibling
) {
313 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
315 if (dev
->channel
== channel
&& dev
->id
== id
) {
325 len
= MIN(n
+ 8, r
->req
.cmd
.xfer
& ~7);
326 if (len
> sizeof(r
->buf
)) {
327 /* TODO: > 256 LUNs? */
331 memset(r
->buf
, 0, len
);
332 stl_be_p(&r
->buf
, n
);
333 i
= found_lun0
? 8 : 16;
334 QTAILQ_FOREACH(qdev
, &r
->req
.bus
->qbus
.children
, sibling
) {
335 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
337 if (dev
->channel
== channel
&& dev
->id
== id
) {
338 store_lun(&r
->buf
[i
], dev
->lun
);
347 static bool scsi_target_emulate_inquiry(SCSITargetReq
*r
)
349 assert(r
->req
.dev
->lun
!= r
->req
.lun
);
350 if (r
->req
.cmd
.buf
[1] & 0x2) {
351 /* Command support data - optional, not implemented */
355 if (r
->req
.cmd
.buf
[1] & 0x1) {
356 /* Vital product data */
357 uint8_t page_code
= r
->req
.cmd
.buf
[2];
358 if (r
->req
.cmd
.xfer
< 4) {
362 r
->buf
[r
->len
++] = page_code
; /* this page */
363 r
->buf
[r
->len
++] = 0x00;
366 case 0x00: /* Supported page codes, mandatory */
370 r
->buf
[r
->len
++] = 0x00; /* list of supported pages (this page) */
371 r
->buf
[pages
] = r
->len
- pages
- 1; /* number of pages */
378 assert(r
->len
< sizeof(r
->buf
));
379 r
->len
= MIN(r
->req
.cmd
.xfer
, r
->len
);
383 /* Standard INQUIRY data */
384 if (r
->req
.cmd
.buf
[2] != 0) {
389 if (r
->req
.cmd
.xfer
< 5) {
393 r
->len
= MIN(r
->req
.cmd
.xfer
, 36);
394 memset(r
->buf
, 0, r
->len
);
395 if (r
->req
.lun
!= 0) {
396 r
->buf
[0] = TYPE_NO_LUN
;
398 r
->buf
[0] = TYPE_NOT_PRESENT
| TYPE_INACTIVE
;
399 r
->buf
[2] = 5; /* Version */
400 r
->buf
[3] = 2 | 0x10; /* HiSup, response data format */
401 r
->buf
[4] = r
->len
- 5; /* Additional Length = (Len - 1) - 4 */
402 r
->buf
[7] = 0x10 | (r
->req
.bus
->info
->tcq
? 0x02 : 0); /* Sync, TCQ. */
403 memcpy(&r
->buf
[8], "QEMU ", 8);
404 memcpy(&r
->buf
[16], "QEMU TARGET ", 16);
405 strncpy((char *) &r
->buf
[32], QEMU_VERSION
, 4);
410 static int32_t scsi_target_send_command(SCSIRequest
*req
, uint8_t *buf
)
412 SCSITargetReq
*r
= DO_UPCAST(SCSITargetReq
, req
, req
);
416 if (!scsi_target_emulate_report_luns(r
)) {
417 goto illegal_request
;
421 if (!scsi_target_emulate_inquiry(r
)) {
422 goto illegal_request
;
426 if (req
->cmd
.xfer
< 4) {
427 goto illegal_request
;
429 r
->len
= scsi_device_get_sense(r
->req
.dev
, r
->buf
,
430 MIN(req
->cmd
.xfer
, sizeof r
->buf
),
431 (req
->cmd
.buf
[1] & 1) == 0);
432 if (r
->req
.dev
->sense_is_ua
) {
433 scsi_device_unit_attention_reported(req
->dev
);
434 r
->req
.dev
->sense_len
= 0;
435 r
->req
.dev
->sense_is_ua
= false;
439 scsi_req_build_sense(req
, SENSE_CODE(LUN_NOT_SUPPORTED
));
440 scsi_req_complete(req
, CHECK_CONDITION
);
443 scsi_req_build_sense(req
, SENSE_CODE(INVALID_FIELD
));
444 scsi_req_complete(req
, CHECK_CONDITION
);
449 scsi_req_complete(req
, GOOD
);
454 static void scsi_target_read_data(SCSIRequest
*req
)
456 SCSITargetReq
*r
= DO_UPCAST(SCSITargetReq
, req
, req
);
462 scsi_req_data(&r
->req
, n
);
464 scsi_req_complete(&r
->req
, GOOD
);
468 static uint8_t *scsi_target_get_buf(SCSIRequest
*req
)
470 SCSITargetReq
*r
= DO_UPCAST(SCSITargetReq
, req
, req
);
475 static const struct SCSIReqOps reqops_target_command
= {
476 .size
= sizeof(SCSITargetReq
),
477 .send_command
= scsi_target_send_command
,
478 .read_data
= scsi_target_read_data
,
479 .get_buf
= scsi_target_get_buf
,
483 SCSIRequest
*scsi_req_alloc(const SCSIReqOps
*reqops
, SCSIDevice
*d
,
484 uint32_t tag
, uint32_t lun
, void *hba_private
)
488 req
= g_malloc0(reqops
->size
);
490 req
->bus
= scsi_bus_from_device(d
);
494 req
->hba_private
= hba_private
;
498 trace_scsi_req_alloc(req
->dev
->id
, req
->lun
, req
->tag
);
502 SCSIRequest
*scsi_req_new(SCSIDevice
*d
, uint32_t tag
, uint32_t lun
,
503 uint8_t *buf
, void *hba_private
)
505 SCSIBus
*bus
= DO_UPCAST(SCSIBus
, qbus
, d
->qdev
.parent_bus
);
509 if (scsi_req_parse(&cmd
, d
, buf
) != 0) {
510 trace_scsi_req_parse_bad(d
->id
, lun
, tag
, buf
[0]);
511 req
= scsi_req_alloc(&reqops_invalid_opcode
, d
, tag
, lun
, hba_private
);
513 trace_scsi_req_parsed(d
->id
, lun
, tag
, buf
[0],
516 trace_scsi_req_parsed_lba(d
->id
, lun
, tag
, buf
[0],
520 if ((d
->unit_attention
.key
== UNIT_ATTENTION
||
521 bus
->unit_attention
.key
== UNIT_ATTENTION
) &&
522 (buf
[0] != INQUIRY
&&
523 buf
[0] != REPORT_LUNS
&&
524 buf
[0] != GET_CONFIGURATION
&&
525 buf
[0] != GET_EVENT_STATUS_NOTIFICATION
&&
528 * If we already have a pending unit attention condition,
529 * report this one before triggering another one.
531 !(buf
[0] == REQUEST_SENSE
&& d
->sense_is_ua
))) {
532 req
= scsi_req_alloc(&reqops_unit_attention
, d
, tag
, lun
,
534 } else if (lun
!= d
->lun
||
535 buf
[0] == REPORT_LUNS
||
536 (buf
[0] == REQUEST_SENSE
&& (d
->sense_len
|| cmd
.xfer
< 4))) {
537 req
= scsi_req_alloc(&reqops_target_command
, d
, tag
, lun
,
540 req
= scsi_device_alloc_req(d
, tag
, lun
, buf
, hba_private
);
547 trace_scsi_inquiry(d
->id
, lun
, tag
, cmd
.buf
[1], cmd
.buf
[2]);
549 case TEST_UNIT_READY
:
550 trace_scsi_test_unit_ready(d
->id
, lun
, tag
);
553 trace_scsi_report_luns(d
->id
, lun
, tag
);
556 trace_scsi_request_sense(d
->id
, lun
, tag
);
565 uint8_t *scsi_req_get_buf(SCSIRequest
*req
)
567 return req
->ops
->get_buf(req
);
570 static void scsi_clear_unit_attention(SCSIRequest
*req
)
573 if (req
->dev
->unit_attention
.key
!= UNIT_ATTENTION
&&
574 req
->bus
->unit_attention
.key
!= UNIT_ATTENTION
) {
579 * If an INQUIRY command enters the enabled command state,
580 * the device server shall [not] clear any unit attention condition;
581 * See also MMC-6, paragraphs 6.5 and 6.6.2.
583 if (req
->cmd
.buf
[0] == INQUIRY
||
584 req
->cmd
.buf
[0] == GET_CONFIGURATION
||
585 req
->cmd
.buf
[0] == GET_EVENT_STATUS_NOTIFICATION
) {
589 if (req
->dev
->unit_attention
.key
== UNIT_ATTENTION
) {
590 ua
= &req
->dev
->unit_attention
;
592 ua
= &req
->bus
->unit_attention
;
596 * If a REPORT LUNS command enters the enabled command state, [...]
597 * the device server shall clear any pending unit attention condition
598 * with an additional sense code of REPORTED LUNS DATA HAS CHANGED.
600 if (req
->cmd
.buf
[0] == REPORT_LUNS
&&
601 !(ua
->asc
== SENSE_CODE(REPORTED_LUNS_CHANGED
).asc
&&
602 ua
->ascq
== SENSE_CODE(REPORTED_LUNS_CHANGED
).ascq
)) {
606 *ua
= SENSE_CODE(NO_SENSE
);
609 int scsi_req_get_sense(SCSIRequest
*req
, uint8_t *buf
, int len
)
614 if (!req
->sense_len
) {
618 ret
= scsi_build_sense(req
->sense
, req
->sense_len
, buf
, len
, true);
621 * FIXME: clearing unit attention conditions upon autosense should be done
622 * only if the UA_INTLCK_CTRL field in the Control mode page is set to 00b
625 * We assume UA_INTLCK_CTRL to be 00b for HBAs that support autosense, and
626 * 10b for HBAs that do not support it (do not call scsi_req_get_sense).
627 * Here we handle unit attention clearing for UA_INTLCK_CTRL == 00b.
629 if (req
->dev
->sense_is_ua
) {
630 scsi_device_unit_attention_reported(req
->dev
);
631 req
->dev
->sense_len
= 0;
632 req
->dev
->sense_is_ua
= false;
637 int scsi_device_get_sense(SCSIDevice
*dev
, uint8_t *buf
, int len
, bool fixed
)
639 return scsi_build_sense(dev
->sense
, dev
->sense_len
, buf
, len
, fixed
);
642 void scsi_req_build_sense(SCSIRequest
*req
, SCSISense sense
)
644 trace_scsi_req_build_sense(req
->dev
->id
, req
->lun
, req
->tag
,
645 sense
.key
, sense
.asc
, sense
.ascq
);
646 memset(req
->sense
, 0, 18);
647 req
->sense
[0] = 0xf0;
648 req
->sense
[2] = sense
.key
;
650 req
->sense
[12] = sense
.asc
;
651 req
->sense
[13] = sense
.ascq
;
655 int32_t scsi_req_enqueue(SCSIRequest
*req
)
659 assert(!req
->enqueued
);
661 req
->enqueued
= true;
662 QTAILQ_INSERT_TAIL(&req
->dev
->requests
, req
, next
);
665 rc
= req
->ops
->send_command(req
, req
->cmd
.buf
);
670 static void scsi_req_dequeue(SCSIRequest
*req
)
672 trace_scsi_req_dequeue(req
->dev
->id
, req
->lun
, req
->tag
);
675 QTAILQ_REMOVE(&req
->dev
->requests
, req
, next
);
676 req
->enqueued
= false;
681 static int scsi_get_performance_length(int num_desc
, int type
, int data_type
)
683 /* MMC-6, paragraph 6.7. */
686 if ((data_type
& 3) == 0) {
687 /* Each descriptor is as in Table 295 - Nominal performance. */
688 return 16 * num_desc
+ 8;
690 /* Each descriptor is as in Table 296 - Exceptions. */
691 return 6 * num_desc
+ 8;
696 return 8 * num_desc
+ 8;
698 return 2048 * num_desc
+ 8;
700 return 16 * num_desc
+ 8;
706 static int scsi_req_length(SCSICommand
*cmd
, SCSIDevice
*dev
, uint8_t *buf
)
708 switch (buf
[0] >> 5) {
712 /* length 0 means 256 blocks */
713 if (cmd
->xfer
== 0) {
719 cmd
->xfer
= lduw_be_p(&buf
[7]);
723 cmd
->xfer
= ldl_be_p(&buf
[10]) & 0xffffffffULL
;
727 cmd
->xfer
= ldl_be_p(&buf
[6]) & 0xffffffffULL
;
735 case TEST_UNIT_READY
:
739 case WRITE_FILEMARKS
:
740 case WRITE_FILEMARKS_16
:
745 case ALLOW_MEDIUM_REMOVAL
:
748 case SYNCHRONIZE_CACHE
:
749 case SYNCHRONIZE_CACHE_16
:
751 case LOCK_UNLOCK_CACHE
:
762 case ALLOW_OVERWRITE
:
770 case READ_CAPACITY_10
:
773 case READ_BLOCK_LIMITS
:
776 case SEND_VOLUME_TAG
:
777 /* GPCMD_SET_STREAMING from multimedia commands. */
778 if (dev
->type
== TYPE_ROM
) {
779 cmd
->xfer
= buf
[10] | (buf
[9] << 8);
781 cmd
->xfer
= buf
[9] | (buf
[8] << 8);
785 case WRITE_VERIFY_10
:
788 case WRITE_VERIFY_12
:
790 case WRITE_VERIFY_16
:
791 cmd
->xfer
*= dev
->blocksize
;
796 case RECOVER_BUFFERED_DATA
:
799 cmd
->xfer
*= dev
->blocksize
;
802 /* MMC mandates the parameter list to be 12-bytes long. Parameters
803 * for block devices are restricted to the header right now. */
804 if (dev
->type
== TYPE_ROM
&& (buf
[1] & 16)) {
807 cmd
->xfer
= (buf
[1] & 16) == 0 ? 0 : (buf
[1] & 32 ? 8 : 4);
811 case RECEIVE_DIAGNOSTIC
:
812 case SEND_DIAGNOSTIC
:
813 cmd
->xfer
= buf
[4] | (buf
[3] << 8);
819 cmd
->xfer
= buf
[8] | (buf
[7] << 8) | (buf
[6] << 16);
821 case PERSISTENT_RESERVE_OUT
:
822 cmd
->xfer
= ldl_be_p(&buf
[5]) & 0xffffffffULL
;
825 if (dev
->type
== TYPE_ROM
) {
826 /* MMC command GET PERFORMANCE. */
827 cmd
->xfer
= scsi_get_performance_length(buf
[9] | (buf
[8] << 8),
828 buf
[10], buf
[1] & 0x1f);
831 case MECHANISM_STATUS
:
832 case READ_DVD_STRUCTURE
:
833 case SEND_DVD_STRUCTURE
:
834 case MAINTENANCE_OUT
:
836 if (dev
->type
== TYPE_ROM
) {
837 /* GPCMD_REPORT_KEY and GPCMD_SEND_KEY from multi media commands */
838 cmd
->xfer
= buf
[9] | (buf
[8] << 8);
845 static int scsi_req_stream_length(SCSICommand
*cmd
, SCSIDevice
*dev
, uint8_t *buf
)
848 /* stream commands */
855 case RECOVER_BUFFERED_DATA
:
858 cmd
->xfer
= buf
[4] | (buf
[3] << 8) | (buf
[2] << 16);
859 if (buf
[1] & 0x01) { /* fixed */
860 cmd
->xfer
*= dev
->blocksize
;
869 cmd
->xfer
= buf
[13] | (buf
[12] << 8);
872 cmd
->xfer
= buf
[8] | (buf
[7] << 8);
875 cmd
->xfer
= buf
[4] | (buf
[3] << 8);
877 /* generic commands */
879 return scsi_req_length(cmd
, dev
, buf
);
884 static void scsi_cmd_xfer_mode(SCSICommand
*cmd
)
886 switch (cmd
->buf
[0]) {
889 case WRITE_VERIFY_10
:
891 case WRITE_VERIFY_12
:
893 case WRITE_VERIFY_16
:
897 case CHANGE_DEFINITION
:
901 case SEND_DIAGNOSTIC
:
904 case REASSIGN_BLOCKS
:
912 case SEARCH_EQUAL_12
:
915 case SEND_VOLUME_TAG
:
917 case SEND_DVD_STRUCTURE
:
918 case PERSISTENT_RESERVE_OUT
:
919 case MAINTENANCE_OUT
:
920 cmd
->mode
= SCSI_XFER_TO_DEV
;
924 cmd
->mode
= SCSI_XFER_FROM_DEV
;
926 cmd
->mode
= SCSI_XFER_NONE
;
932 static uint64_t scsi_cmd_lba(SCSICommand
*cmd
)
934 uint8_t *buf
= cmd
->buf
;
937 switch (buf
[0] >> 5) {
939 lba
= ldl_be_p(&buf
[0]) & 0x1fffff;
944 lba
= ldl_be_p(&buf
[2]) & 0xffffffffULL
;
947 lba
= ldq_be_p(&buf
[2]);
956 int scsi_req_parse(SCSICommand
*cmd
, SCSIDevice
*dev
, uint8_t *buf
)
960 if (dev
->type
== TYPE_TAPE
) {
961 rc
= scsi_req_stream_length(cmd
, dev
, buf
);
963 rc
= scsi_req_length(cmd
, dev
, buf
);
968 memcpy(cmd
->buf
, buf
, cmd
->len
);
969 scsi_cmd_xfer_mode(cmd
);
970 cmd
->lba
= scsi_cmd_lba(cmd
);
975 * Predefined sense codes
978 /* No sense data available */
979 const struct SCSISense sense_code_NO_SENSE
= {
980 .key
= NO_SENSE
, .asc
= 0x00 , .ascq
= 0x00
983 /* LUN not ready, Manual intervention required */
984 const struct SCSISense sense_code_LUN_NOT_READY
= {
985 .key
= NOT_READY
, .asc
= 0x04, .ascq
= 0x03
988 /* LUN not ready, Medium not present */
989 const struct SCSISense sense_code_NO_MEDIUM
= {
990 .key
= NOT_READY
, .asc
= 0x3a, .ascq
= 0x00
993 /* LUN not ready, medium removal prevented */
994 const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED
= {
995 .key
= NOT_READY
, .asc
= 0x53, .ascq
= 0x00
998 /* Hardware error, internal target failure */
999 const struct SCSISense sense_code_TARGET_FAILURE
= {
1000 .key
= HARDWARE_ERROR
, .asc
= 0x44, .ascq
= 0x00
1003 /* Illegal request, invalid command operation code */
1004 const struct SCSISense sense_code_INVALID_OPCODE
= {
1005 .key
= ILLEGAL_REQUEST
, .asc
= 0x20, .ascq
= 0x00
1008 /* Illegal request, LBA out of range */
1009 const struct SCSISense sense_code_LBA_OUT_OF_RANGE
= {
1010 .key
= ILLEGAL_REQUEST
, .asc
= 0x21, .ascq
= 0x00
1013 /* Illegal request, Invalid field in CDB */
1014 const struct SCSISense sense_code_INVALID_FIELD
= {
1015 .key
= ILLEGAL_REQUEST
, .asc
= 0x24, .ascq
= 0x00
1018 /* Illegal request, LUN not supported */
1019 const struct SCSISense sense_code_LUN_NOT_SUPPORTED
= {
1020 .key
= ILLEGAL_REQUEST
, .asc
= 0x25, .ascq
= 0x00
1023 /* Illegal request, Saving parameters not supported */
1024 const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED
= {
1025 .key
= ILLEGAL_REQUEST
, .asc
= 0x39, .ascq
= 0x00
1028 /* Illegal request, Incompatible medium installed */
1029 const struct SCSISense sense_code_INCOMPATIBLE_FORMAT
= {
1030 .key
= ILLEGAL_REQUEST
, .asc
= 0x30, .ascq
= 0x00
1033 /* Illegal request, medium removal prevented */
1034 const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED
= {
1035 .key
= ILLEGAL_REQUEST
, .asc
= 0x53, .ascq
= 0x00
1038 /* Command aborted, I/O process terminated */
1039 const struct SCSISense sense_code_IO_ERROR
= {
1040 .key
= ABORTED_COMMAND
, .asc
= 0x00, .ascq
= 0x06
1043 /* Command aborted, I_T Nexus loss occurred */
1044 const struct SCSISense sense_code_I_T_NEXUS_LOSS
= {
1045 .key
= ABORTED_COMMAND
, .asc
= 0x29, .ascq
= 0x07
1048 /* Command aborted, Logical Unit failure */
1049 const struct SCSISense sense_code_LUN_FAILURE
= {
1050 .key
= ABORTED_COMMAND
, .asc
= 0x3e, .ascq
= 0x01
1053 /* Unit attention, Power on, reset or bus device reset occurred */
1054 const struct SCSISense sense_code_RESET
= {
1055 .key
= UNIT_ATTENTION
, .asc
= 0x29, .ascq
= 0x00
1058 /* Unit attention, No medium */
1059 const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM
= {
1060 .key
= UNIT_ATTENTION
, .asc
= 0x3a, .ascq
= 0x00
1063 /* Unit attention, Medium may have changed */
1064 const struct SCSISense sense_code_MEDIUM_CHANGED
= {
1065 .key
= UNIT_ATTENTION
, .asc
= 0x28, .ascq
= 0x00
1068 /* Unit attention, Reported LUNs data has changed */
1069 const struct SCSISense sense_code_REPORTED_LUNS_CHANGED
= {
1070 .key
= UNIT_ATTENTION
, .asc
= 0x3f, .ascq
= 0x0e
1073 /* Unit attention, Device internal reset */
1074 const struct SCSISense sense_code_DEVICE_INTERNAL_RESET
= {
1075 .key
= UNIT_ATTENTION
, .asc
= 0x29, .ascq
= 0x04
1081 * Convert between fixed and descriptor sense buffers
1083 int scsi_build_sense(uint8_t *in_buf
, int in_len
,
1084 uint8_t *buf
, int len
, bool fixed
)
1088 if (!fixed
&& len
< 8) {
1093 sense
.key
= NO_SENSE
;
1097 fixed_in
= (in_buf
[0] & 2) == 0;
1099 if (fixed
== fixed_in
) {
1100 memcpy(buf
, in_buf
, MIN(len
, in_len
));
1101 return MIN(len
, in_len
);
1105 sense
.key
= in_buf
[2];
1106 sense
.asc
= in_buf
[12];
1107 sense
.ascq
= in_buf
[13];
1109 sense
.key
= in_buf
[1];
1110 sense
.asc
= in_buf
[2];
1111 sense
.ascq
= in_buf
[3];
1115 memset(buf
, 0, len
);
1117 /* Return fixed format sense buffer */
1121 buf
[12] = sense
.asc
;
1122 buf
[13] = sense
.ascq
;
1123 return MIN(len
, 18);
1125 /* Return descriptor format sense buffer */
1129 buf
[3] = sense
.ascq
;
1134 static const char *scsi_command_name(uint8_t cmd
)
1136 static const char *names
[] = {
1137 [ TEST_UNIT_READY
] = "TEST_UNIT_READY",
1138 [ REWIND
] = "REWIND",
1139 [ REQUEST_SENSE
] = "REQUEST_SENSE",
1140 [ FORMAT_UNIT
] = "FORMAT_UNIT",
1141 [ READ_BLOCK_LIMITS
] = "READ_BLOCK_LIMITS",
1142 [ REASSIGN_BLOCKS
] = "REASSIGN_BLOCKS",
1143 [ READ_6
] = "READ_6",
1144 [ WRITE_6
] = "WRITE_6",
1145 [ SET_CAPACITY
] = "SET_CAPACITY",
1146 [ READ_REVERSE
] = "READ_REVERSE",
1147 [ WRITE_FILEMARKS
] = "WRITE_FILEMARKS",
1148 [ SPACE
] = "SPACE",
1149 [ INQUIRY
] = "INQUIRY",
1150 [ RECOVER_BUFFERED_DATA
] = "RECOVER_BUFFERED_DATA",
1151 [ MAINTENANCE_IN
] = "MAINTENANCE_IN",
1152 [ MAINTENANCE_OUT
] = "MAINTENANCE_OUT",
1153 [ MODE_SELECT
] = "MODE_SELECT",
1154 [ RESERVE
] = "RESERVE",
1155 [ RELEASE
] = "RELEASE",
1157 [ ERASE
] = "ERASE",
1158 [ MODE_SENSE
] = "MODE_SENSE",
1159 [ START_STOP
] = "START_STOP",
1160 [ RECEIVE_DIAGNOSTIC
] = "RECEIVE_DIAGNOSTIC",
1161 [ SEND_DIAGNOSTIC
] = "SEND_DIAGNOSTIC",
1162 [ ALLOW_MEDIUM_REMOVAL
] = "ALLOW_MEDIUM_REMOVAL",
1163 [ READ_CAPACITY_10
] = "READ_CAPACITY_10",
1164 [ READ_10
] = "READ_10",
1165 [ WRITE_10
] = "WRITE_10",
1166 [ SEEK_10
] = "SEEK_10",
1167 [ WRITE_VERIFY_10
] = "WRITE_VERIFY_10",
1168 [ VERIFY_10
] = "VERIFY_10",
1169 [ SEARCH_HIGH
] = "SEARCH_HIGH",
1170 [ SEARCH_EQUAL
] = "SEARCH_EQUAL",
1171 [ SEARCH_LOW
] = "SEARCH_LOW",
1172 [ SET_LIMITS
] = "SET_LIMITS",
1173 [ PRE_FETCH
] = "PRE_FETCH/READ_POSITION",
1174 /* READ_POSITION and PRE_FETCH use the same operation code */
1175 [ SYNCHRONIZE_CACHE
] = "SYNCHRONIZE_CACHE",
1176 [ LOCK_UNLOCK_CACHE
] = "LOCK_UNLOCK_CACHE",
1177 [ READ_DEFECT_DATA
] = "READ_DEFECT_DATA",
1178 [ MEDIUM_SCAN
] = "MEDIUM_SCAN",
1179 [ COMPARE
] = "COMPARE",
1180 [ COPY_VERIFY
] = "COPY_VERIFY",
1181 [ WRITE_BUFFER
] = "WRITE_BUFFER",
1182 [ READ_BUFFER
] = "READ_BUFFER",
1183 [ UPDATE_BLOCK
] = "UPDATE_BLOCK",
1184 [ READ_LONG_10
] = "READ_LONG_10",
1185 [ WRITE_LONG_10
] = "WRITE_LONG_10",
1186 [ CHANGE_DEFINITION
] = "CHANGE_DEFINITION",
1187 [ WRITE_SAME_10
] = "WRITE_SAME_10",
1188 [ UNMAP
] = "UNMAP",
1189 [ READ_TOC
] = "READ_TOC",
1190 [ REPORT_DENSITY_SUPPORT
] = "REPORT_DENSITY_SUPPORT",
1191 [ GET_CONFIGURATION
] = "GET_CONFIGURATION",
1192 [ LOG_SELECT
] = "LOG_SELECT",
1193 [ LOG_SENSE
] = "LOG_SENSE",
1194 [ MODE_SELECT_10
] = "MODE_SELECT_10",
1195 [ RESERVE_10
] = "RESERVE_10",
1196 [ RELEASE_10
] = "RELEASE_10",
1197 [ MODE_SENSE_10
] = "MODE_SENSE_10",
1198 [ PERSISTENT_RESERVE_IN
] = "PERSISTENT_RESERVE_IN",
1199 [ PERSISTENT_RESERVE_OUT
] = "PERSISTENT_RESERVE_OUT",
1200 [ WRITE_FILEMARKS_16
] = "WRITE_FILEMARKS_16",
1201 [ EXTENDED_COPY
] = "EXTENDED_COPY",
1202 [ ATA_PASSTHROUGH
] = "ATA_PASSTHROUGH",
1203 [ ACCESS_CONTROL_IN
] = "ACCESS_CONTROL_IN",
1204 [ ACCESS_CONTROL_OUT
] = "ACCESS_CONTROL_OUT",
1205 [ READ_16
] = "READ_16",
1206 [ COMPARE_AND_WRITE
] = "COMPARE_AND_WRITE",
1207 [ WRITE_16
] = "WRITE_16",
1208 [ WRITE_VERIFY_16
] = "WRITE_VERIFY_16",
1209 [ VERIFY_16
] = "VERIFY_16",
1210 [ PRE_FETCH_16
] = "PRE_FETCH_16",
1211 [ SYNCHRONIZE_CACHE_16
] = "SPACE_16/SYNCHRONIZE_CACHE_16",
1212 /* SPACE_16 and SYNCHRONIZE_CACHE_16 use the same operation code */
1213 [ LOCATE_16
] = "LOCATE_16",
1214 [ WRITE_SAME_16
] = "ERASE_16/WRITE_SAME_16",
1215 /* ERASE_16 and WRITE_SAME_16 use the same operation code */
1216 [ SERVICE_ACTION_IN_16
] = "SERVICE_ACTION_IN_16",
1217 [ WRITE_LONG_16
] = "WRITE_LONG_16",
1218 [ REPORT_LUNS
] = "REPORT_LUNS",
1219 [ BLANK
] = "BLANK",
1220 [ MOVE_MEDIUM
] = "MOVE_MEDIUM",
1221 [ LOAD_UNLOAD
] = "LOAD_UNLOAD",
1222 [ READ_12
] = "READ_12",
1223 [ WRITE_12
] = "WRITE_12",
1224 [ ERASE_12
] = "ERASE_12/GET_PERFORMANCE",
1225 /* ERASE_12 and GET_PERFORMANCE use the same operation code */
1226 [ SERVICE_ACTION_IN_12
] = "SERVICE_ACTION_IN_12",
1227 [ WRITE_VERIFY_12
] = "WRITE_VERIFY_12",
1228 [ VERIFY_12
] = "VERIFY_12",
1229 [ SEARCH_HIGH_12
] = "SEARCH_HIGH_12",
1230 [ SEARCH_EQUAL_12
] = "SEARCH_EQUAL_12",
1231 [ SEARCH_LOW_12
] = "SEARCH_LOW_12",
1232 [ READ_ELEMENT_STATUS
] = "READ_ELEMENT_STATUS",
1233 [ SEND_VOLUME_TAG
] = "SEND_VOLUME_TAG/SET_STREAMING",
1234 /* SEND_VOLUME_TAG and SET_STREAMING use the same operation code */
1235 [ READ_CD
] = "READ_CD",
1236 [ READ_DEFECT_DATA_12
] = "READ_DEFECT_DATA_12",
1237 [ READ_DVD_STRUCTURE
] = "READ_DVD_STRUCTURE",
1238 [ RESERVE_TRACK
] = "RESERVE_TRACK",
1239 [ SEND_CUE_SHEET
] = "SEND_CUE_SHEET",
1240 [ SEND_DVD_STRUCTURE
] = "SEND_DVD_STRUCTURE",
1241 [ SET_CD_SPEED
] = "SET_CD_SPEED",
1242 [ SET_READ_AHEAD
] = "SET_READ_AHEAD",
1243 [ ALLOW_OVERWRITE
] = "ALLOW_OVERWRITE",
1244 [ MECHANISM_STATUS
] = "MECHANISM_STATUS",
1247 if (cmd
>= ARRAY_SIZE(names
) || names
[cmd
] == NULL
)
1252 SCSIRequest
*scsi_req_ref(SCSIRequest
*req
)
1258 void scsi_req_unref(SCSIRequest
*req
)
1260 if (--req
->refcount
== 0) {
1261 if (req
->ops
->free_req
) {
1262 req
->ops
->free_req(req
);
1268 /* Tell the device that we finished processing this chunk of I/O. It
1269 will start the next chunk or complete the command. */
1270 void scsi_req_continue(SCSIRequest
*req
)
1272 trace_scsi_req_continue(req
->dev
->id
, req
->lun
, req
->tag
);
1273 if (req
->cmd
.mode
== SCSI_XFER_TO_DEV
) {
1274 req
->ops
->write_data(req
);
1276 req
->ops
->read_data(req
);
1280 /* Called by the devices when data is ready for the HBA. The HBA should
1281 start a DMA operation to read or fill the device's data buffer.
1282 Once it completes, calling scsi_req_continue will restart I/O. */
1283 void scsi_req_data(SCSIRequest
*req
, int len
)
1285 if (req
->io_canceled
) {
1286 trace_scsi_req_data_canceled(req
->dev
->id
, req
->lun
, req
->tag
, len
);
1288 trace_scsi_req_data(req
->dev
->id
, req
->lun
, req
->tag
, len
);
1289 req
->bus
->info
->transfer_data(req
, len
);
1293 void scsi_req_print(SCSIRequest
*req
)
1298 fprintf(fp
, "[%s id=%d] %s",
1299 req
->dev
->qdev
.parent_bus
->name
,
1301 scsi_command_name(req
->cmd
.buf
[0]));
1302 for (i
= 1; i
< req
->cmd
.len
; i
++) {
1303 fprintf(fp
, " 0x%02x", req
->cmd
.buf
[i
]);
1305 switch (req
->cmd
.mode
) {
1306 case SCSI_XFER_NONE
:
1307 fprintf(fp
, " - none\n");
1309 case SCSI_XFER_FROM_DEV
:
1310 fprintf(fp
, " - from-dev len=%zd\n", req
->cmd
.xfer
);
1312 case SCSI_XFER_TO_DEV
:
1313 fprintf(fp
, " - to-dev len=%zd\n", req
->cmd
.xfer
);
1316 fprintf(fp
, " - Oops\n");
1321 void scsi_req_complete(SCSIRequest
*req
, int status
)
1323 assert(req
->status
== -1);
1324 req
->status
= status
;
1326 assert(req
->sense_len
< sizeof(req
->sense
));
1327 if (status
== GOOD
) {
1331 if (req
->sense_len
) {
1332 memcpy(req
->dev
->sense
, req
->sense
, req
->sense_len
);
1333 req
->dev
->sense_len
= req
->sense_len
;
1334 req
->dev
->sense_is_ua
= (req
->ops
== &reqops_unit_attention
);
1336 req
->dev
->sense_len
= 0;
1337 req
->dev
->sense_is_ua
= false;
1341 * Unit attention state is now stored in the device's sense buffer
1342 * if the HBA didn't do autosense. Clear the pending unit attention
1345 scsi_clear_unit_attention(req
);
1348 scsi_req_dequeue(req
);
1349 req
->bus
->info
->complete(req
, req
->status
);
1350 scsi_req_unref(req
);
1353 void scsi_req_cancel(SCSIRequest
*req
)
1355 if (!req
->enqueued
) {
1359 scsi_req_dequeue(req
);
1360 req
->io_canceled
= true;
1361 if (req
->ops
->cancel_io
) {
1362 req
->ops
->cancel_io(req
);
1364 if (req
->bus
->info
->cancel
) {
1365 req
->bus
->info
->cancel(req
);
1367 scsi_req_unref(req
);
1370 void scsi_req_abort(SCSIRequest
*req
, int status
)
1372 if (!req
->enqueued
) {
1376 scsi_req_dequeue(req
);
1377 req
->io_canceled
= true;
1378 if (req
->ops
->cancel_io
) {
1379 req
->ops
->cancel_io(req
);
1381 scsi_req_complete(req
, status
);
1382 scsi_req_unref(req
);
1385 void scsi_device_purge_requests(SCSIDevice
*sdev
, SCSISense sense
)
1389 while (!QTAILQ_EMPTY(&sdev
->requests
)) {
1390 req
= QTAILQ_FIRST(&sdev
->requests
);
1391 scsi_req_cancel(req
);
1393 sdev
->unit_attention
= sense
;
1396 static char *scsibus_get_fw_dev_path(DeviceState
*dev
)
1398 SCSIDevice
*d
= SCSI_DEVICE(dev
);
1401 snprintf(path
, sizeof(path
), "channel@%x/%s@%x,%x", d
->channel
,
1402 qdev_fw_name(dev
), d
->id
, d
->lun
);
1404 return strdup(path
);
1407 SCSIDevice
*scsi_device_find(SCSIBus
*bus
, int channel
, int id
, int lun
)
1410 SCSIDevice
*target_dev
= NULL
;
1412 QTAILQ_FOREACH_REVERSE(qdev
, &bus
->qbus
.children
, ChildrenHead
, sibling
) {
1413 SCSIDevice
*dev
= SCSI_DEVICE(qdev
);
1415 if (dev
->channel
== channel
&& dev
->id
== id
) {
1416 if (dev
->lun
== lun
) {
1425 static TypeInfo scsi_device_type_info
= {
1426 .name
= TYPE_SCSI_DEVICE
,
1427 .parent
= TYPE_DEVICE
,
1428 .instance_size
= sizeof(SCSIDevice
),
1430 .class_size
= sizeof(SCSIDeviceClass
),
1433 static void scsi_register_devices(void)
1435 type_register_static(&scsi_device_type_info
);
1438 device_init(scsi_register_devices
);