xref: /qemu/include/hw/virtio/virtio-scsi.h (revision 552260aeae26edebb1d660dae1e0c76fa234364b)
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  #include "qom/object.h"
17  
18  /* Override CDB/sense data size: they are dynamic (guest controlled) in QEMU */
19  #define VIRTIO_SCSI_CDB_SIZE 0
20  #define VIRTIO_SCSI_SENSE_SIZE 0
21  #include "standard-headers/linux/virtio_scsi.h"
22  #include "hw/virtio/virtio.h"
23  #include "hw/scsi/scsi.h"
24  #include "chardev/char-fe.h"
25  #include "system/iothread.h"
26  
27  #define TYPE_VIRTIO_SCSI_COMMON "virtio-scsi-common"
28  OBJECT_DECLARE_SIMPLE_TYPE(VirtIOSCSICommon, VIRTIO_SCSI_COMMON)
29  
30  #define TYPE_VIRTIO_SCSI "virtio-scsi-device"
31  OBJECT_DECLARE_SIMPLE_TYPE(VirtIOSCSI, VIRTIO_SCSI)
32  
33  #define VIRTIO_SCSI_MAX_CHANNEL 0
34  #define VIRTIO_SCSI_MAX_TARGET  255
35  #define VIRTIO_SCSI_MAX_LUN     16383
36  
37  /* Number of virtqueues that are always present */
38  #define VIRTIO_SCSI_VQ_NUM_FIXED    2
39  
40  #define VIRTIO_SCSI_AUTO_NUM_QUEUES UINT32_MAX
41  
42  typedef struct virtio_scsi_cmd_req VirtIOSCSICmdReq;
43  typedef struct virtio_scsi_cmd_resp VirtIOSCSICmdResp;
44  typedef struct virtio_scsi_ctrl_tmf_req VirtIOSCSICtrlTMFReq;
45  typedef struct virtio_scsi_ctrl_tmf_resp VirtIOSCSICtrlTMFResp;
46  typedef struct virtio_scsi_ctrl_an_req VirtIOSCSICtrlANReq;
47  typedef struct virtio_scsi_ctrl_an_resp VirtIOSCSICtrlANResp;
48  typedef struct virtio_scsi_event VirtIOSCSIEvent;
49  typedef struct virtio_scsi_config VirtIOSCSIConfig;
50  
51  struct VirtIOSCSIConf {
52      uint32_t num_queues;
53      uint32_t virtqueue_size;
54      bool worker_per_virtqueue;
55      bool seg_max_adjust;
56      uint32_t max_sectors;
57      uint32_t cmd_per_lun;
58      char *vhostfd;
59      char *wwpn;
60      CharBackend chardev;
61      uint32_t boot_tpgt;
62      IOThread *iothread;
63  };
64  
65  struct VirtIOSCSI;
66  
67  struct VirtIOSCSICommon {
68      VirtIODevice parent_obj;
69      VirtIOSCSIConf conf;
70  
71      uint32_t sense_size;
72      uint32_t cdb_size;
73      VirtQueue *ctrl_vq;
74      VirtQueue *event_vq;
75      VirtQueue **cmd_vqs;
76  };
77  
78  struct VirtIOSCSIReq;
79  
80  struct VirtIOSCSI {
81      VirtIOSCSICommon parent_obj;
82  
83      SCSIBus bus;
84      int resetting; /* written from main loop thread, read from any thread */
85      bool events_dropped;
86  
87      /*
88       * TMFs deferred to main loop BH. These fields are protected by
89       * tmf_bh_lock.
90       */
91      QemuMutex tmf_bh_lock;
92      QEMUBH *tmf_bh;
93      QTAILQ_HEAD(, VirtIOSCSIReq) tmf_bh_list;
94  
95      /* Fields for dataplane below */
96      AioContext *ctx; /* one iothread per virtio-scsi-pci for now */
97  
98      bool dataplane_started;
99      bool dataplane_starting;
100      bool dataplane_stopping;
101      bool dataplane_fenced;
102      uint32_t host_features;
103  };
104  
105  void virtio_scsi_common_realize(DeviceState *dev,
106                                  VirtIOHandleOutput ctrl,
107                                  VirtIOHandleOutput evt,
108                                  VirtIOHandleOutput cmd,
109                                  Error **errp);
110  
111  void virtio_scsi_common_unrealize(DeviceState *dev);
112  
113  void virtio_scsi_dataplane_setup(VirtIOSCSI *s, Error **errp);
114  int virtio_scsi_dataplane_start(VirtIODevice *s);
115  void virtio_scsi_dataplane_stop(VirtIODevice *s);
116  
117  #endif /* QEMU_VIRTIO_SCSI_H */
118