xref: /openbmc/qemu/include/hw/virtio/virtio-scsi.h (revision 35658f6e)
1 /*
2  * Virtio SCSI HBA
3  *
4  * Copyright IBM, Corp. 2010
5  *
6  * Authors:
7  *  Stefan Hajnoczi    <stefanha@linux.vnet.ibm.com>
8  *
9  * This work is licensed under the terms of the GNU GPL, version 2.  See
10  * the COPYING file in the top-level directory.
11  *
12  */
13 
14 #ifndef _QEMU_VIRTIO_SCSI_H
15 #define _QEMU_VIRTIO_SCSI_H
16 
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 
26 #define TYPE_VIRTIO_SCSI_COMMON "virtio-scsi-common"
27 #define VIRTIO_SCSI_COMMON(obj) \
28         OBJECT_CHECK(VirtIOSCSICommon, (obj), TYPE_VIRTIO_SCSI_COMMON)
29 
30 #define TYPE_VIRTIO_SCSI "virtio-scsi-device"
31 #define VIRTIO_SCSI(obj) \
32         OBJECT_CHECK(VirtIOSCSI, (obj), TYPE_VIRTIO_SCSI)
33 
34 #define VIRTIO_SCSI_VQ_SIZE     128
35 #define VIRTIO_SCSI_MAX_CHANNEL 0
36 #define VIRTIO_SCSI_MAX_TARGET  255
37 #define VIRTIO_SCSI_MAX_LUN     16383
38 
39 typedef struct virtio_scsi_cmd_req VirtIOSCSICmdReq;
40 typedef struct virtio_scsi_cmd_resp VirtIOSCSICmdResp;
41 typedef struct virtio_scsi_ctrl_tmf_req VirtIOSCSICtrlTMFReq;
42 typedef struct virtio_scsi_ctrl_tmf_resp VirtIOSCSICtrlTMFResp;
43 typedef struct virtio_scsi_ctrl_an_req VirtIOSCSICtrlANReq;
44 typedef struct virtio_scsi_ctrl_an_resp VirtIOSCSICtrlANResp;
45 typedef struct virtio_scsi_event VirtIOSCSIEvent;
46 typedef struct virtio_scsi_config VirtIOSCSIConfig;
47 
48 struct VirtIOSCSIConf {
49     uint32_t num_queues;
50     uint32_t max_sectors;
51     uint32_t cmd_per_lun;
52     char *vhostfd;
53     char *wwpn;
54     uint32_t boot_tpgt;
55     IOThread *iothread;
56 };
57 
58 struct VirtIOSCSI;
59 
60 typedef struct VirtIOSCSICommon {
61     VirtIODevice parent_obj;
62     VirtIOSCSIConf conf;
63 
64     uint32_t sense_size;
65     uint32_t cdb_size;
66     VirtQueue *ctrl_vq;
67     VirtQueue *event_vq;
68     VirtQueue **cmd_vqs;
69 } VirtIOSCSICommon;
70 
71 typedef struct VirtIOSCSI {
72     VirtIOSCSICommon parent_obj;
73 
74     SCSIBus bus;
75     int resetting;
76     bool events_dropped;
77 
78     /* Fields for dataplane below */
79     AioContext *ctx; /* one iothread per virtio-scsi-pci for now */
80 
81     bool dataplane_started;
82     bool dataplane_starting;
83     bool dataplane_stopping;
84     bool dataplane_fenced;
85     uint32_t host_features;
86 } VirtIOSCSI;
87 
88 typedef struct VirtIOSCSIReq {
89     /* Note:
90      * - fields up to resp_iov are initialized by virtio_scsi_init_req;
91      * - fields starting at vring are zeroed by virtio_scsi_init_req.
92      * */
93     VirtQueueElement elem;
94 
95     VirtIOSCSI *dev;
96     VirtQueue *vq;
97     QEMUSGList qsgl;
98     QEMUIOVector resp_iov;
99 
100     union {
101         /* Used for two-stage request submission */
102         QTAILQ_ENTRY(VirtIOSCSIReq) next;
103 
104         /* Used for cancellation of request during TMFs */
105         int remaining;
106     };
107 
108     SCSIRequest *sreq;
109     size_t resp_size;
110     enum SCSIXferMode mode;
111     union {
112         VirtIOSCSICmdResp     cmd;
113         VirtIOSCSICtrlTMFResp tmf;
114         VirtIOSCSICtrlANResp  an;
115         VirtIOSCSIEvent       event;
116     } resp;
117     union {
118         VirtIOSCSICmdReq      cmd;
119         VirtIOSCSICtrlTMFReq  tmf;
120         VirtIOSCSICtrlANReq   an;
121     } req;
122 } VirtIOSCSIReq;
123 
124 typedef void (*HandleOutput)(VirtIODevice *, VirtQueue *);
125 
126 void virtio_scsi_common_realize(DeviceState *dev, Error **errp,
127                                 HandleOutput ctrl, HandleOutput evt,
128                                 HandleOutput cmd);
129 
130 void virtio_scsi_common_unrealize(DeviceState *dev, Error **errp);
131 void virtio_scsi_handle_event_vq(VirtIOSCSI *s, VirtQueue *vq);
132 void virtio_scsi_handle_cmd_vq(VirtIOSCSI *s, VirtQueue *vq);
133 void virtio_scsi_handle_ctrl_vq(VirtIOSCSI *s, VirtQueue *vq);
134 void virtio_scsi_init_req(VirtIOSCSI *s, VirtQueue *vq, VirtIOSCSIReq *req);
135 void virtio_scsi_free_req(VirtIOSCSIReq *req);
136 void virtio_scsi_push_event(VirtIOSCSI *s, SCSIDevice *dev,
137                             uint32_t event, uint32_t reason);
138 
139 void virtio_scsi_set_iothread(VirtIOSCSI *s, IOThread *iothread);
140 void virtio_scsi_dataplane_start(VirtIOSCSI *s);
141 void virtio_scsi_dataplane_stop(VirtIOSCSI *s);
142 void virtio_scsi_dataplane_notify(VirtIODevice *vdev, VirtIOSCSIReq *req);
143 
144 #endif /* _QEMU_VIRTIO_SCSI_H */
145