xref: /openbmc/qemu/hw/s390x/virtio-ccw.h (revision 84a3a53c)
1 /*
2  * virtio ccw target definitions
3  *
4  * Copyright 2012,2015 IBM Corp.
5  * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com>
6  *            Pierre Morel <pmorel@linux.vnet.ibm.com>
7  *
8  * This work is licensed under the terms of the GNU GPL, version 2 or (at
9  * your option) any later version. See the COPYING file in the top-level
10  * directory.
11  */
12 
13 #ifndef HW_S390X_VIRTIO_CCW_H
14 #define HW_S390X_VIRTIO_CCW_H
15 
16 #include <hw/virtio/virtio-blk.h>
17 #include <hw/virtio/virtio-net.h>
18 #include <hw/virtio/virtio-serial.h>
19 #include <hw/virtio/virtio-scsi.h>
20 #ifdef CONFIG_VHOST_SCSI
21 #include <hw/virtio/vhost-scsi.h>
22 #endif
23 #include <hw/virtio/virtio-balloon.h>
24 #include <hw/virtio/virtio-rng.h>
25 #include <hw/virtio/virtio-bus.h>
26 #include <hw/s390x/s390_flic.h>
27 
28 #define VIRTUAL_CSSID 0xfe
29 
30 #define VIRTIO_CCW_CU_TYPE 0x3832
31 #define VIRTIO_CCW_CHPID_TYPE 0x32
32 
33 #define CCW_CMD_SET_VQ       0x13
34 #define CCW_CMD_VDEV_RESET   0x33
35 #define CCW_CMD_READ_FEAT    0x12
36 #define CCW_CMD_WRITE_FEAT   0x11
37 #define CCW_CMD_READ_CONF    0x22
38 #define CCW_CMD_WRITE_CONF   0x21
39 #define CCW_CMD_WRITE_STATUS 0x31
40 #define CCW_CMD_SET_IND      0x43
41 #define CCW_CMD_SET_CONF_IND 0x53
42 #define CCW_CMD_READ_VQ_CONF 0x32
43 #define CCW_CMD_SET_IND_ADAPTER 0x73
44 #define CCW_CMD_SET_VIRTIO_REV 0x83
45 
46 #define TYPE_VIRTIO_CCW_DEVICE "virtio-ccw-device"
47 #define VIRTIO_CCW_DEVICE(obj) \
48      OBJECT_CHECK(VirtioCcwDevice, (obj), TYPE_VIRTIO_CCW_DEVICE)
49 #define VIRTIO_CCW_DEVICE_CLASS(klass) \
50      OBJECT_CLASS_CHECK(VirtIOCCWDeviceClass, (klass), TYPE_VIRTIO_CCW_DEVICE)
51 #define VIRTIO_CCW_DEVICE_GET_CLASS(obj) \
52      OBJECT_GET_CLASS(VirtIOCCWDeviceClass, (obj), TYPE_VIRTIO_CCW_DEVICE)
53 
54 typedef struct VirtioBusState VirtioCcwBusState;
55 typedef struct VirtioBusClass VirtioCcwBusClass;
56 
57 #define TYPE_VIRTIO_CCW_BUS "virtio-ccw-bus"
58 #define VIRTIO_CCW_BUS(obj) \
59      OBJECT_CHECK(VirtioCcwBus, (obj), TYPE_VIRTIO_CCW_BUS)
60 #define VIRTIO_CCW_BUS_GET_CLASS(obj) \
61     OBJECT_CHECK(VirtioCcwBusState, (obj), TYPE_VIRTIO_CCW_BUS)
62 #define VIRTIO_CCW_BUS_CLASS(klass) \
63     OBJECT_CLASS_CHECK(VirtioCcwBusClass, klass, TYPE_VIRTIO_CCW_BUS)
64 
65 typedef struct VirtioCcwDevice VirtioCcwDevice;
66 
67 typedef struct VirtIOCCWDeviceClass {
68     DeviceClass parent_class;
69     void (*realize)(VirtioCcwDevice *dev, Error **errp);
70     int (*exit)(VirtioCcwDevice *dev);
71 } VirtIOCCWDeviceClass;
72 
73 /* Performance improves when virtqueue kick processing is decoupled from the
74  * vcpu thread using ioeventfd for some devices. */
75 #define VIRTIO_CCW_FLAG_USE_IOEVENTFD_BIT 1
76 #define VIRTIO_CCW_FLAG_USE_IOEVENTFD   (1 << VIRTIO_CCW_FLAG_USE_IOEVENTFD_BIT)
77 
78 typedef struct IndAddr {
79     hwaddr addr;
80     uint64_t map;
81     unsigned long refcnt;
82     int len;
83     QTAILQ_ENTRY(IndAddr) sibling;
84 } IndAddr;
85 
86 struct VirtioCcwDevice {
87     DeviceState parent_obj;
88     SubchDev *sch;
89     char *bus_id;
90     int revision;
91     uint32_t max_rev;
92     VirtioBusState bus;
93     bool ioeventfd_started;
94     bool ioeventfd_disabled;
95     uint32_t flags;
96     uint8_t thinint_isc;
97     AdapterRoutes routes;
98     /* Guest provided values: */
99     IndAddr *indicators;
100     IndAddr *indicators2;
101     IndAddr *summary_indicator;
102     uint64_t ind_bit;
103 };
104 
105 /* The maximum virtio revision we support. */
106 #define VIRTIO_CCW_MAX_REV 1
107 static inline int virtio_ccw_rev_max(VirtioCcwDevice *dev)
108 {
109     return dev->max_rev;
110 }
111 
112 /* virtual css bus type */
113 typedef struct VirtualCssBus {
114     BusState parent_obj;
115 } VirtualCssBus;
116 
117 #define TYPE_VIRTUAL_CSS_BUS "virtual-css-bus"
118 #define VIRTUAL_CSS_BUS(obj) \
119      OBJECT_CHECK(VirtualCssBus, (obj), TYPE_VIRTUAL_CSS_BUS)
120 
121 /* virtio-scsi-ccw */
122 
123 #define TYPE_VIRTIO_SCSI_CCW "virtio-scsi-ccw"
124 #define VIRTIO_SCSI_CCW(obj) \
125         OBJECT_CHECK(VirtIOSCSICcw, (obj), TYPE_VIRTIO_SCSI_CCW)
126 
127 typedef struct VirtIOSCSICcw {
128     VirtioCcwDevice parent_obj;
129     VirtIOSCSI vdev;
130 } VirtIOSCSICcw;
131 
132 #ifdef CONFIG_VHOST_SCSI
133 /* vhost-scsi-ccw */
134 
135 #define TYPE_VHOST_SCSI_CCW "vhost-scsi-ccw"
136 #define VHOST_SCSI_CCW(obj) \
137         OBJECT_CHECK(VHostSCSICcw, (obj), TYPE_VHOST_SCSI_CCW)
138 
139 typedef struct VHostSCSICcw {
140     VirtioCcwDevice parent_obj;
141     VHostSCSI vdev;
142 } VHostSCSICcw;
143 #endif
144 
145 /* virtio-blk-ccw */
146 
147 #define TYPE_VIRTIO_BLK_CCW "virtio-blk-ccw"
148 #define VIRTIO_BLK_CCW(obj) \
149         OBJECT_CHECK(VirtIOBlkCcw, (obj), TYPE_VIRTIO_BLK_CCW)
150 
151 typedef struct VirtIOBlkCcw {
152     VirtioCcwDevice parent_obj;
153     VirtIOBlock vdev;
154 } VirtIOBlkCcw;
155 
156 /* virtio-balloon-ccw */
157 
158 #define TYPE_VIRTIO_BALLOON_CCW "virtio-balloon-ccw"
159 #define VIRTIO_BALLOON_CCW(obj) \
160         OBJECT_CHECK(VirtIOBalloonCcw, (obj), TYPE_VIRTIO_BALLOON_CCW)
161 
162 typedef struct VirtIOBalloonCcw {
163     VirtioCcwDevice parent_obj;
164     VirtIOBalloon vdev;
165 } VirtIOBalloonCcw;
166 
167 /* virtio-serial-ccw */
168 
169 #define TYPE_VIRTIO_SERIAL_CCW "virtio-serial-ccw"
170 #define VIRTIO_SERIAL_CCW(obj) \
171         OBJECT_CHECK(VirtioSerialCcw, (obj), TYPE_VIRTIO_SERIAL_CCW)
172 
173 typedef struct VirtioSerialCcw {
174     VirtioCcwDevice parent_obj;
175     VirtIOSerial vdev;
176 } VirtioSerialCcw;
177 
178 /* virtio-net-ccw */
179 
180 #define TYPE_VIRTIO_NET_CCW "virtio-net-ccw"
181 #define VIRTIO_NET_CCW(obj) \
182         OBJECT_CHECK(VirtIONetCcw, (obj), TYPE_VIRTIO_NET_CCW)
183 
184 typedef struct VirtIONetCcw {
185     VirtioCcwDevice parent_obj;
186     VirtIONet vdev;
187 } VirtIONetCcw;
188 
189 /* virtio-rng-ccw */
190 
191 #define TYPE_VIRTIO_RNG_CCW "virtio-rng-ccw"
192 #define VIRTIO_RNG_CCW(obj) \
193         OBJECT_CHECK(VirtIORNGCcw, (obj), TYPE_VIRTIO_RNG_CCW)
194 
195 typedef struct VirtIORNGCcw {
196     VirtioCcwDevice parent_obj;
197     VirtIORNG vdev;
198 } VirtIORNGCcw;
199 
200 VirtualCssBus *virtual_css_bus_init(void);
201 void virtio_ccw_device_update_status(SubchDev *sch);
202 VirtIODevice *virtio_ccw_get_vdev(SubchDev *sch);
203 
204 #ifdef CONFIG_VIRTFS
205 #include "hw/9pfs/virtio-9p.h"
206 
207 #define TYPE_VIRTIO_9P_CCW "virtio-9p-ccw"
208 #define VIRTIO_9P_CCW(obj) \
209     OBJECT_CHECK(V9fsCCWState, (obj), TYPE_VIRTIO_9P_CCW)
210 
211 typedef struct V9fsCCWState {
212     VirtioCcwDevice parent_obj;
213     V9fsVirtioState vdev;
214 } V9fsCCWState;
215 
216 #endif /* CONFIG_VIRTFS */
217 
218 #endif
219