4 * Copyright IBM, Corp. 2010
7 * Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
14 #ifndef _QEMU_VIRTIO_SCSI_H
15 #define _QEMU_VIRTIO_SCSI_H
17 /* Override CDB/sense data size: they are dynamic (guest controlled) in QEMU */
18 #define VIRTIO_SCSI_CDB_SIZE 0
19 #define VIRTIO_SCSI_SENSE_SIZE 0
20 #include "standard-headers/linux/virtio_scsi.h"
21 #include "hw/virtio/virtio.h"
22 #include "hw/pci/pci.h"
23 #include "hw/scsi/scsi.h"
24 #include "sysemu/iothread.h"
25 #include "hw/virtio/dataplane/vring.h"
27 #define TYPE_VIRTIO_SCSI_COMMON "virtio-scsi-common"
28 #define VIRTIO_SCSI_COMMON(obj) \
29 OBJECT_CHECK(VirtIOSCSICommon, (obj), TYPE_VIRTIO_SCSI_COMMON)
31 #define TYPE_VIRTIO_SCSI "virtio-scsi-device"
32 #define VIRTIO_SCSI(obj) \
33 OBJECT_CHECK(VirtIOSCSI, (obj), TYPE_VIRTIO_SCSI)
35 #define VIRTIO_SCSI_VQ_SIZE 128
36 #define VIRTIO_SCSI_MAX_CHANNEL 0
37 #define VIRTIO_SCSI_MAX_TARGET 255
38 #define VIRTIO_SCSI_MAX_LUN 16383
40 typedef struct virtio_scsi_cmd_req VirtIOSCSICmdReq
;
41 typedef struct virtio_scsi_cmd_resp VirtIOSCSICmdResp
;
42 typedef struct virtio_scsi_ctrl_tmf_req VirtIOSCSICtrlTMFReq
;
43 typedef struct virtio_scsi_ctrl_tmf_resp VirtIOSCSICtrlTMFResp
;
44 typedef struct virtio_scsi_ctrl_an_req VirtIOSCSICtrlANReq
;
45 typedef struct virtio_scsi_ctrl_an_resp VirtIOSCSICtrlANResp
;
46 typedef struct virtio_scsi_event VirtIOSCSIEvent
;
47 typedef struct virtio_scsi_config VirtIOSCSIConfig
;
49 struct VirtIOSCSIConf
{
62 struct VirtIOSCSI
*parent
;
64 EventNotifier host_notifier
;
65 EventNotifier guest_notifier
;
68 typedef struct VirtIOSCSICommon
{
69 VirtIODevice parent_obj
;
79 typedef struct VirtIOSCSI
{
80 VirtIOSCSICommon parent_obj
;
86 /* Fields for dataplane below */
87 AioContext
*ctx
; /* one iothread per virtio-scsi-pci for now */
89 /* Vring is used instead of vq in dataplane code, because of the underlying
90 * memory layer thread safety */
91 VirtIOSCSIVring
*ctrl_vring
;
92 VirtIOSCSIVring
*event_vring
;
93 VirtIOSCSIVring
**cmd_vrings
;
94 bool dataplane_started
;
95 bool dataplane_starting
;
96 bool dataplane_stopping
;
97 bool dataplane_disabled
;
98 bool dataplane_fenced
;
100 Notifier migration_state_notifier
;
101 uint32_t host_features
;
104 typedef struct VirtIOSCSIReq
{
108 QEMUIOVector resp_iov
;
111 * - fields before elem are initialized by virtio_scsi_init_req;
112 * - elem is uninitialized at the time of allocation.
113 * - fields after elem are zeroed by virtio_scsi_init_req.
116 VirtQueueElement elem
;
117 /* Set by dataplane code. */
118 VirtIOSCSIVring
*vring
;
121 /* Used for two-stage request submission */
122 QTAILQ_ENTRY(VirtIOSCSIReq
) next
;
124 /* Used for cancellation of request during TMFs */
130 enum SCSIXferMode mode
;
132 VirtIOSCSICmdResp cmd
;
133 VirtIOSCSICtrlTMFResp tmf
;
134 VirtIOSCSICtrlANResp an
;
135 VirtIOSCSIEvent event
;
138 VirtIOSCSICmdReq cmd
;
139 VirtIOSCSICtrlTMFReq tmf
;
140 VirtIOSCSICtrlANReq an
;
144 typedef void (*HandleOutput
)(VirtIODevice
*, VirtQueue
*);
146 void virtio_scsi_common_realize(DeviceState
*dev
, Error
**errp
,
147 HandleOutput ctrl
, HandleOutput evt
,
150 void virtio_scsi_common_unrealize(DeviceState
*dev
, Error
**errp
);
151 void virtio_scsi_handle_ctrl_req(VirtIOSCSI
*s
, VirtIOSCSIReq
*req
);
152 bool virtio_scsi_handle_cmd_req_prepare(VirtIOSCSI
*s
, VirtIOSCSIReq
*req
);
153 void virtio_scsi_handle_cmd_req_submit(VirtIOSCSI
*s
, VirtIOSCSIReq
*req
);
154 VirtIOSCSIReq
*virtio_scsi_init_req(VirtIOSCSI
*s
, VirtQueue
*vq
);
155 void virtio_scsi_free_req(VirtIOSCSIReq
*req
);
156 void virtio_scsi_push_event(VirtIOSCSI
*s
, SCSIDevice
*dev
,
157 uint32_t event
, uint32_t reason
);
159 void virtio_scsi_set_iothread(VirtIOSCSI
*s
, IOThread
*iothread
);
160 void virtio_scsi_dataplane_start(VirtIOSCSI
*s
);
161 void virtio_scsi_dataplane_stop(VirtIOSCSI
*s
);
162 void virtio_scsi_vring_push_notify(VirtIOSCSIReq
*req
);
163 VirtIOSCSIReq
*virtio_scsi_pop_req_vring(VirtIOSCSI
*s
,
164 VirtIOSCSIVring
*vring
);
166 #endif /* _QEMU_VIRTIO_SCSI_H */