2 * Generic SCSI Device support
4 * Copyright (c) 2007 Bull S.A.S.
5 * Based on code by Paul Brook
6 * Based on code by Fabrice Bellard
8 * Written by Laurent Vivier <Laurent.Vivier@bull.net>
10 * This code is licensed under the LGPL.
14 #include "qemu/osdep.h"
15 #include "qapi/error.h"
16 #include "qemu-common.h"
17 #include "qemu/error-report.h"
18 #include "hw/scsi/scsi.h"
19 #include "sysemu/block-backend.h"
20 #include "sysemu/blockdev.h"
27 #define DPRINTF(fmt, ...) \
28 do { printf("scsi-generic: " fmt , ## __VA_ARGS__); } while (0)
30 #define DPRINTF(fmt, ...) do {} while(0)
33 #define BADF(fmt, ...) \
34 do { fprintf(stderr, "scsi-generic: " fmt , ## __VA_ARGS__); } while (0)
37 #include "block/scsi.h"
39 #define SG_ERR_DRIVER_TIMEOUT 0x06
40 #define SG_ERR_DRIVER_SENSE 0x08
42 #define SG_ERR_DID_OK 0x00
43 #define SG_ERR_DID_NO_CONNECT 0x01
44 #define SG_ERR_DID_BUS_BUSY 0x02
45 #define SG_ERR_DID_TIME_OUT 0x03
48 #define MAX_UINT ((unsigned int)-1)
51 typedef struct SCSIGenericReq
{
56 sg_io_hdr_t io_header
;
59 static void scsi_generic_save_request(QEMUFile
*f
, SCSIRequest
*req
)
61 SCSIGenericReq
*r
= DO_UPCAST(SCSIGenericReq
, req
, req
);
63 qemu_put_sbe32s(f
, &r
->buflen
);
64 if (r
->buflen
&& r
->req
.cmd
.mode
== SCSI_XFER_TO_DEV
) {
66 qemu_put_buffer(f
, r
->buf
, r
->req
.cmd
.xfer
);
70 static void scsi_generic_load_request(QEMUFile
*f
, SCSIRequest
*req
)
72 SCSIGenericReq
*r
= DO_UPCAST(SCSIGenericReq
, req
, req
);
74 qemu_get_sbe32s(f
, &r
->buflen
);
75 if (r
->buflen
&& r
->req
.cmd
.mode
== SCSI_XFER_TO_DEV
) {
77 qemu_get_buffer(f
, r
->buf
, r
->req
.cmd
.xfer
);
81 static void scsi_free_request(SCSIRequest
*req
)
83 SCSIGenericReq
*r
= DO_UPCAST(SCSIGenericReq
, req
, req
);
88 /* Helper function for command completion. */
89 static void scsi_command_complete_noio(SCSIGenericReq
*r
, int ret
)
93 assert(r
->req
.aiocb
== NULL
);
95 if (r
->req
.io_canceled
) {
96 scsi_req_cancel_complete(&r
->req
);
99 if (r
->io_header
.driver_status
& SG_ERR_DRIVER_SENSE
) {
100 r
->req
.sense_len
= r
->io_header
.sb_len_wr
;
106 status
= TASK_SET_FULL
;
109 status
= CHECK_CONDITION
;
110 scsi_req_build_sense(&r
->req
, SENSE_CODE(TARGET_FAILURE
));
113 status
= CHECK_CONDITION
;
114 scsi_req_build_sense(&r
->req
, SENSE_CODE(IO_ERROR
));
118 if (r
->io_header
.host_status
== SG_ERR_DID_NO_CONNECT
||
119 r
->io_header
.host_status
== SG_ERR_DID_BUS_BUSY
||
120 r
->io_header
.host_status
== SG_ERR_DID_TIME_OUT
||
121 (r
->io_header
.driver_status
& SG_ERR_DRIVER_TIMEOUT
)) {
123 BADF("Driver Timeout\n");
124 } else if (r
->io_header
.host_status
) {
125 status
= CHECK_CONDITION
;
126 scsi_req_build_sense(&r
->req
, SENSE_CODE(I_T_NEXUS_LOSS
));
127 } else if (r
->io_header
.status
) {
128 status
= r
->io_header
.status
;
129 } else if (r
->io_header
.driver_status
& SG_ERR_DRIVER_SENSE
) {
130 status
= CHECK_CONDITION
;
135 DPRINTF("Command complete 0x%p tag=0x%x status=%d\n",
136 r
, r
->req
.tag
, status
);
138 scsi_req_complete(&r
->req
, status
);
140 scsi_req_unref(&r
->req
);
143 static void scsi_command_complete(void *opaque
, int ret
)
145 SCSIGenericReq
*r
= (SCSIGenericReq
*)opaque
;
146 SCSIDevice
*s
= r
->req
.dev
;
148 assert(r
->req
.aiocb
!= NULL
);
151 aio_context_acquire(blk_get_aio_context(s
->conf
.blk
));
152 scsi_command_complete_noio(r
, ret
);
153 aio_context_release(blk_get_aio_context(s
->conf
.blk
));
156 static int execute_command(BlockBackend
*blk
,
157 SCSIGenericReq
*r
, int direction
,
158 BlockCompletionFunc
*complete
)
160 r
->io_header
.interface_id
= 'S';
161 r
->io_header
.dxfer_direction
= direction
;
162 r
->io_header
.dxferp
= r
->buf
;
163 r
->io_header
.dxfer_len
= r
->buflen
;
164 r
->io_header
.cmdp
= r
->req
.cmd
.buf
;
165 r
->io_header
.cmd_len
= r
->req
.cmd
.len
;
166 r
->io_header
.mx_sb_len
= sizeof(r
->req
.sense
);
167 r
->io_header
.sbp
= r
->req
.sense
;
168 r
->io_header
.timeout
= MAX_UINT
;
169 r
->io_header
.usr_ptr
= r
;
170 r
->io_header
.flags
|= SG_FLAG_DIRECT_IO
;
172 r
->req
.aiocb
= blk_aio_ioctl(blk
, SG_IO
, &r
->io_header
, complete
, r
);
173 if (r
->req
.aiocb
== NULL
) {
180 static void scsi_read_complete(void * opaque
, int ret
)
182 SCSIGenericReq
*r
= (SCSIGenericReq
*)opaque
;
183 SCSIDevice
*s
= r
->req
.dev
;
186 assert(r
->req
.aiocb
!= NULL
);
189 aio_context_acquire(blk_get_aio_context(s
->conf
.blk
));
191 if (ret
|| r
->req
.io_canceled
) {
192 scsi_command_complete_noio(r
, ret
);
196 len
= r
->io_header
.dxfer_len
- r
->io_header
.resid
;
197 DPRINTF("Data ready tag=0x%x len=%d\n", r
->req
.tag
, len
);
201 scsi_command_complete_noio(r
, 0);
205 /* Snoop READ CAPACITY output to set the blocksize. */
206 if (r
->req
.cmd
.buf
[0] == READ_CAPACITY_10
&&
207 (ldl_be_p(&r
->buf
[0]) != 0xffffffffU
|| s
->max_lba
== 0)) {
208 s
->blocksize
= ldl_be_p(&r
->buf
[4]);
209 s
->max_lba
= ldl_be_p(&r
->buf
[0]) & 0xffffffffULL
;
210 } else if (r
->req
.cmd
.buf
[0] == SERVICE_ACTION_IN_16
&&
211 (r
->req
.cmd
.buf
[1] & 31) == SAI_READ_CAPACITY_16
) {
212 s
->blocksize
= ldl_be_p(&r
->buf
[8]);
213 s
->max_lba
= ldq_be_p(&r
->buf
[0]);
215 blk_set_guest_block_size(s
->conf
.blk
, s
->blocksize
);
217 /* Patch MODE SENSE device specific parameters if the BDS is opened
220 if ((s
->type
== TYPE_DISK
|| s
->type
== TYPE_TAPE
) &&
221 blk_is_read_only(s
->conf
.blk
) &&
222 (r
->req
.cmd
.buf
[0] == MODE_SENSE
||
223 r
->req
.cmd
.buf
[0] == MODE_SENSE_10
) &&
224 (r
->req
.cmd
.buf
[1] & 0x8) == 0) {
225 if (r
->req
.cmd
.buf
[0] == MODE_SENSE
) {
231 if (s
->type
== TYPE_DISK
&&
232 r
->req
.cmd
.buf
[0] == INQUIRY
&&
233 r
->req
.cmd
.buf
[2] == 0xb0) {
234 uint32_t max_transfer
=
235 blk_get_max_transfer(s
->conf
.blk
) / s
->blocksize
;
237 assert(max_transfer
);
238 stl_be_p(&r
->buf
[8], max_transfer
);
239 /* Also take care of the opt xfer len. */
240 stl_be_p(&r
->buf
[12],
241 MIN_NON_ZERO(max_transfer
, ldl_be_p(&r
->buf
[12])));
243 scsi_req_data(&r
->req
, len
);
244 scsi_req_unref(&r
->req
);
247 aio_context_release(blk_get_aio_context(s
->conf
.blk
));
250 /* Read more data from scsi device into buffer. */
251 static void scsi_read_data(SCSIRequest
*req
)
253 SCSIGenericReq
*r
= DO_UPCAST(SCSIGenericReq
, req
, req
);
254 SCSIDevice
*s
= r
->req
.dev
;
257 DPRINTF("scsi_read_data tag=0x%x\n", req
->tag
);
259 /* The request is used as the AIO opaque value, so add a ref. */
260 scsi_req_ref(&r
->req
);
262 scsi_command_complete_noio(r
, 0);
266 ret
= execute_command(s
->conf
.blk
, r
, SG_DXFER_FROM_DEV
,
269 scsi_command_complete_noio(r
, ret
);
273 static void scsi_write_complete(void * opaque
, int ret
)
275 SCSIGenericReq
*r
= (SCSIGenericReq
*)opaque
;
276 SCSIDevice
*s
= r
->req
.dev
;
278 DPRINTF("scsi_write_complete() ret = %d\n", ret
);
280 assert(r
->req
.aiocb
!= NULL
);
283 aio_context_acquire(blk_get_aio_context(s
->conf
.blk
));
285 if (ret
|| r
->req
.io_canceled
) {
286 scsi_command_complete_noio(r
, ret
);
290 if (r
->req
.cmd
.buf
[0] == MODE_SELECT
&& r
->req
.cmd
.buf
[4] == 12 &&
291 s
->type
== TYPE_TAPE
) {
292 s
->blocksize
= (r
->buf
[9] << 16) | (r
->buf
[10] << 8) | r
->buf
[11];
293 DPRINTF("block size %d\n", s
->blocksize
);
296 scsi_command_complete_noio(r
, ret
);
299 aio_context_release(blk_get_aio_context(s
->conf
.blk
));
302 /* Write data to a scsi device. Returns nonzero on failure.
303 The transfer may complete asynchronously. */
304 static void scsi_write_data(SCSIRequest
*req
)
306 SCSIGenericReq
*r
= DO_UPCAST(SCSIGenericReq
, req
, req
);
307 SCSIDevice
*s
= r
->req
.dev
;
310 DPRINTF("scsi_write_data tag=0x%x\n", req
->tag
);
313 scsi_req_data(&r
->req
, r
->len
);
317 /* The request is used as the AIO opaque value, so add a ref. */
318 scsi_req_ref(&r
->req
);
319 ret
= execute_command(s
->conf
.blk
, r
, SG_DXFER_TO_DEV
, scsi_write_complete
);
321 scsi_command_complete_noio(r
, ret
);
325 /* Return a pointer to the data buffer. */
326 static uint8_t *scsi_get_buf(SCSIRequest
*req
)
328 SCSIGenericReq
*r
= DO_UPCAST(SCSIGenericReq
, req
, req
);
333 /* Execute a scsi command. Returns the length of the data expected by the
334 command. This will be Positive for data transfers from the device
335 (eg. disk reads), negative for transfers to the device (eg. disk writes),
336 and zero if the command does not transfer any data. */
338 static int32_t scsi_send_command(SCSIRequest
*req
, uint8_t *cmd
)
340 SCSIGenericReq
*r
= DO_UPCAST(SCSIGenericReq
, req
, req
);
341 SCSIDevice
*s
= r
->req
.dev
;
345 DPRINTF("Command: data=0x%02x", cmd
[0]);
348 for (i
= 1; i
< r
->req
.cmd
.len
; i
++) {
349 printf(" 0x%02x", cmd
[i
]);
355 if (r
->req
.cmd
.xfer
== 0) {
359 /* The request is used as the AIO opaque value, so add a ref. */
360 scsi_req_ref(&r
->req
);
361 ret
= execute_command(s
->conf
.blk
, r
, SG_DXFER_NONE
,
362 scsi_command_complete
);
364 scsi_command_complete_noio(r
, ret
);
370 if (r
->buflen
!= r
->req
.cmd
.xfer
) {
372 r
->buf
= g_malloc(r
->req
.cmd
.xfer
);
373 r
->buflen
= r
->req
.cmd
.xfer
;
376 memset(r
->buf
, 0, r
->buflen
);
377 r
->len
= r
->req
.cmd
.xfer
;
378 if (r
->req
.cmd
.mode
== SCSI_XFER_TO_DEV
) {
380 return -r
->req
.cmd
.xfer
;
382 return r
->req
.cmd
.xfer
;
386 static int read_naa_id(const uint8_t *p
, uint64_t *p_wwn
)
390 if ((p
[1] & 0xF) == 3) {
391 /* NAA designator type */
395 *p_wwn
= ldq_be_p(p
+ 4);
399 if ((p
[1] & 0xF) == 8) {
400 /* SCSI name string designator type */
401 if (p
[3] < 20 || memcmp(&p
[4], "naa.", 4)) {
404 if (p
[3] > 20 && p
[24] != ',') {
408 for (i
= 8; i
< 24; i
++) {
409 char c
= toupper(p
[i
]);
410 c
-= (c
>= '0' && c
<= '9' ? '0' : 'A' - 10);
411 *p_wwn
= (*p_wwn
<< 4) | c
;
419 void scsi_generic_read_device_identification(SCSIDevice
*s
)
424 sg_io_hdr_t io_header
;
428 memset(cmd
, 0, sizeof(cmd
));
429 memset(buf
, 0, sizeof(buf
));
433 cmd
[4] = sizeof(buf
);
435 memset(&io_header
, 0, sizeof(io_header
));
436 io_header
.interface_id
= 'S';
437 io_header
.dxfer_direction
= SG_DXFER_FROM_DEV
;
438 io_header
.dxfer_len
= sizeof(buf
);
439 io_header
.dxferp
= buf
;
440 io_header
.cmdp
= cmd
;
441 io_header
.cmd_len
= sizeof(cmd
);
442 io_header
.mx_sb_len
= sizeof(sensebuf
);
443 io_header
.sbp
= sensebuf
;
444 io_header
.timeout
= 6000; /* XXX */
446 ret
= blk_ioctl(s
->conf
.blk
, SG_IO
, &io_header
);
447 if (ret
< 0 || io_header
.driver_status
|| io_header
.host_status
) {
451 len
= MIN((buf
[2] << 8) | buf
[3], sizeof(buf
) - 4);
452 for (i
= 0; i
+ 3 <= len
; ) {
453 const uint8_t *p
= &buf
[i
+ 4];
456 if (i
+ (p
[3] + 4) > len
) {
460 if ((p
[1] & 0x10) == 0) {
461 /* Associated with the logical unit */
462 if (read_naa_id(p
, &wwn
) == 0) {
465 } else if ((p
[1] & 0x10) == 0x10) {
466 /* Associated with the target port */
467 if (read_naa_id(p
, &wwn
) == 0) {
476 static int get_stream_blocksize(BlockBackend
*blk
)
481 sg_io_hdr_t io_header
;
484 memset(cmd
, 0, sizeof(cmd
));
485 memset(buf
, 0, sizeof(buf
));
487 cmd
[4] = sizeof(buf
);
489 memset(&io_header
, 0, sizeof(io_header
));
490 io_header
.interface_id
= 'S';
491 io_header
.dxfer_direction
= SG_DXFER_FROM_DEV
;
492 io_header
.dxfer_len
= sizeof(buf
);
493 io_header
.dxferp
= buf
;
494 io_header
.cmdp
= cmd
;
495 io_header
.cmd_len
= sizeof(cmd
);
496 io_header
.mx_sb_len
= sizeof(sensebuf
);
497 io_header
.sbp
= sensebuf
;
498 io_header
.timeout
= 6000; /* XXX */
500 ret
= blk_ioctl(blk
, SG_IO
, &io_header
);
501 if (ret
< 0 || io_header
.driver_status
|| io_header
.host_status
) {
504 return (buf
[9] << 16) | (buf
[10] << 8) | buf
[11];
507 static void scsi_generic_reset(DeviceState
*dev
)
509 SCSIDevice
*s
= SCSI_DEVICE(dev
);
511 scsi_device_purge_requests(s
, SENSE_CODE(RESET
));
514 static void scsi_generic_realize(SCSIDevice
*s
, Error
**errp
)
518 struct sg_scsi_id scsiid
;
521 error_setg(errp
, "drive property not set");
525 if (blk_get_on_error(s
->conf
.blk
, 0) != BLOCKDEV_ON_ERROR_ENOSPC
) {
526 error_setg(errp
, "Device doesn't support drive option werror");
529 if (blk_get_on_error(s
->conf
.blk
, 1) != BLOCKDEV_ON_ERROR_REPORT
) {
530 error_setg(errp
, "Device doesn't support drive option rerror");
534 /* check we are using a driver managing SG_IO (version 3 and after */
535 rc
= blk_ioctl(s
->conf
.blk
, SG_GET_VERSION_NUM
, &sg_version
);
537 error_setg(errp
, "cannot get SG_IO version number: %s. "
538 "Is this a SCSI device?",
542 if (sg_version
< 30000) {
543 error_setg(errp
, "scsi generic interface too old");
547 /* get LUN of the /dev/sg? */
548 if (blk_ioctl(s
->conf
.blk
, SG_GET_SCSI_ID
, &scsiid
)) {
549 error_setg(errp
, "SG_GET_SCSI_ID ioctl failed");
553 /* define device state */
554 s
->type
= scsiid
.scsi_type
;
555 DPRINTF("device type %d\n", s
->type
);
559 s
->blocksize
= get_stream_blocksize(s
->conf
.blk
);
560 if (s
->blocksize
== -1) {
565 /* Make a guess for block devices, we'll fix it when the guest sends.
566 * READ CAPACITY. If they don't, they likely would assume these sizes
567 * anyway. (TODO: they could also send MODE SENSE).
578 DPRINTF("block size %d\n", s
->blocksize
);
580 scsi_generic_read_device_identification(s
);
583 const SCSIReqOps scsi_generic_req_ops
= {
584 .size
= sizeof(SCSIGenericReq
),
585 .free_req
= scsi_free_request
,
586 .send_command
= scsi_send_command
,
587 .read_data
= scsi_read_data
,
588 .write_data
= scsi_write_data
,
589 .get_buf
= scsi_get_buf
,
590 .load_request
= scsi_generic_load_request
,
591 .save_request
= scsi_generic_save_request
,
594 static SCSIRequest
*scsi_new_request(SCSIDevice
*d
, uint32_t tag
, uint32_t lun
,
595 uint8_t *buf
, void *hba_private
)
597 return scsi_req_alloc(&scsi_generic_req_ops
, d
, tag
, lun
, hba_private
);
600 static Property scsi_generic_properties
[] = {
601 DEFINE_PROP_DRIVE("drive", SCSIDevice
, conf
.blk
),
602 DEFINE_PROP_END_OF_LIST(),
605 static int scsi_generic_parse_cdb(SCSIDevice
*dev
, SCSICommand
*cmd
,
606 uint8_t *buf
, void *hba_private
)
608 return scsi_bus_parse_cdb(dev
, cmd
, buf
, hba_private
);
611 static void scsi_generic_class_initfn(ObjectClass
*klass
, void *data
)
613 DeviceClass
*dc
= DEVICE_CLASS(klass
);
614 SCSIDeviceClass
*sc
= SCSI_DEVICE_CLASS(klass
);
616 sc
->realize
= scsi_generic_realize
;
617 sc
->alloc_req
= scsi_new_request
;
618 sc
->parse_cdb
= scsi_generic_parse_cdb
;
619 dc
->fw_name
= "disk";
620 dc
->desc
= "pass through generic scsi device (/dev/sg*)";
621 dc
->reset
= scsi_generic_reset
;
622 dc
->props
= scsi_generic_properties
;
623 dc
->vmsd
= &vmstate_scsi_device
;
626 static const TypeInfo scsi_generic_info
= {
627 .name
= "scsi-generic",
628 .parent
= TYPE_SCSI_DEVICE
,
629 .instance_size
= sizeof(SCSIDevice
),
630 .class_init
= scsi_generic_class_initfn
,
633 static void scsi_generic_register_types(void)
635 type_register_static(&scsi_generic_info
);
638 type_init(scsi_generic_register_types
)
640 #endif /* __linux__ */