xref: /openbmc/qemu/include/hw/s390x/css.h (revision 61a67f71)
1 /*
2  * Channel subsystem structures and definitions.
3  *
4  * Copyright 2012 IBM Corp.
5  * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com>
6  *
7  * This work is licensed under the terms of the GNU GPL, version 2 or (at
8  * your option) any later version. See the COPYING file in the top-level
9  * directory.
10  */
11 
12 #ifndef CSS_H
13 #define CSS_H
14 
15 #include "cpu.h"
16 #include "hw/s390x/adapter.h"
17 #include "hw/s390x/s390_flic.h"
18 #include "hw/s390x/ioinst.h"
19 
20 /* Channel subsystem constants. */
21 #define MAX_DEVNO 65535
22 #define MAX_SCHID 65535
23 #define MAX_SSID 3
24 #define MAX_CSSID 255
25 #define MAX_CHPID 255
26 
27 #define MAX_ISC 7
28 
29 #define MAX_CIWS 62
30 
31 #define VIRTUAL_CSSID 0xfe
32 #define VIRTIO_CCW_CHPID 0   /* used by convention */
33 
34 typedef struct CIW {
35     uint8_t type;
36     uint8_t command;
37     uint16_t count;
38 } QEMU_PACKED CIW;
39 
40 typedef struct SenseId {
41     /* common part */
42     uint8_t reserved;        /* always 0x'FF' */
43     uint16_t cu_type;        /* control unit type */
44     uint8_t cu_model;        /* control unit model */
45     uint16_t dev_type;       /* device type */
46     uint8_t dev_model;       /* device model */
47     uint8_t unused;          /* padding byte */
48     /* extended part */
49     CIW ciw[MAX_CIWS];       /* variable # of CIWs */
50 } QEMU_PACKED SenseId;
51 
52 /* Channel measurements, from linux/drivers/s390/cio/cmf.c. */
53 typedef struct CMB {
54     uint16_t ssch_rsch_count;
55     uint16_t sample_count;
56     uint32_t device_connect_time;
57     uint32_t function_pending_time;
58     uint32_t device_disconnect_time;
59     uint32_t control_unit_queuing_time;
60     uint32_t device_active_only_time;
61     uint32_t reserved[2];
62 } QEMU_PACKED CMB;
63 
64 typedef struct CMBE {
65     uint32_t ssch_rsch_count;
66     uint32_t sample_count;
67     uint32_t device_connect_time;
68     uint32_t function_pending_time;
69     uint32_t device_disconnect_time;
70     uint32_t control_unit_queuing_time;
71     uint32_t device_active_only_time;
72     uint32_t device_busy_time;
73     uint32_t initial_command_response_time;
74     uint32_t reserved[7];
75 } QEMU_PACKED CMBE;
76 
77 typedef struct SubchDev SubchDev;
78 struct SubchDev {
79     /* channel-subsystem related things: */
80     uint8_t cssid;
81     uint8_t ssid;
82     uint16_t schid;
83     uint16_t devno;
84     SCHIB curr_status;
85     uint8_t sense_data[32];
86     hwaddr channel_prog;
87     CCW1 last_cmd;
88     bool last_cmd_valid;
89     bool ccw_fmt_1;
90     bool thinint_active;
91     uint8_t ccw_no_data_cnt;
92     uint16_t migrated_schid; /* used for missmatch detection */
93     ORB orb;
94     /* transport-provided data: */
95     int (*ccw_cb) (SubchDev *, CCW1);
96     void (*disable_cb)(SubchDev *);
97     int (*do_subchannel_work) (SubchDev *);
98     SenseId id;
99     void *driver_data;
100 };
101 
102 extern const VMStateDescription vmstate_subch_dev;
103 
104 /*
105  * Identify a device within the channel subsystem.
106  * Note that this can be used to identify either the subchannel or
107  * the attached I/O device, as there's always one I/O device per
108  * subchannel.
109  */
110 typedef struct CssDevId {
111     uint8_t cssid;
112     uint8_t ssid;
113     uint16_t devid;
114     bool valid;
115 } CssDevId;
116 
117 extern const PropertyInfo css_devid_propinfo;
118 
119 #define DEFINE_PROP_CSS_DEV_ID(_n, _s, _f) \
120     DEFINE_PROP(_n, _s, _f, css_devid_propinfo, CssDevId)
121 
122 typedef struct IndAddr {
123     hwaddr addr;
124     uint64_t map;
125     unsigned long refcnt;
126     int32_t len;
127     QTAILQ_ENTRY(IndAddr) sibling;
128 } IndAddr;
129 
130 extern const VMStateDescription vmstate_ind_addr;
131 
132 #define VMSTATE_PTR_TO_IND_ADDR(_f, _s)                                   \
133     VMSTATE_STRUCT(_f, _s, 1, vmstate_ind_addr, IndAddr*)
134 
135 IndAddr *get_indicator(hwaddr ind_addr, int len);
136 void release_indicator(AdapterInfo *adapter, IndAddr *indicator);
137 int map_indicator(AdapterInfo *adapter, IndAddr *indicator);
138 
139 typedef SubchDev *(*css_subch_cb_func)(uint8_t m, uint8_t cssid, uint8_t ssid,
140                                        uint16_t schid);
141 int css_create_css_image(uint8_t cssid, bool default_image);
142 bool css_devno_used(uint8_t cssid, uint8_t ssid, uint16_t devno);
143 void css_subch_assign(uint8_t cssid, uint8_t ssid, uint16_t schid,
144                       uint16_t devno, SubchDev *sch);
145 void css_sch_build_virtual_schib(SubchDev *sch, uint8_t chpid, uint8_t type);
146 int css_sch_build_schib(SubchDev *sch, CssDevId *dev_id);
147 unsigned int css_find_free_chpid(uint8_t cssid);
148 uint16_t css_build_subchannel_id(SubchDev *sch);
149 void copy_scsw_to_guest(SCSW *dest, const SCSW *src);
150 void css_inject_io_interrupt(SubchDev *sch);
151 void css_reset(void);
152 void css_reset_sch(SubchDev *sch);
153 void css_queue_crw(uint8_t rsc, uint8_t erc, int chain, uint16_t rsid);
154 void css_generate_sch_crws(uint8_t cssid, uint8_t ssid, uint16_t schid,
155                            int hotplugged, int add);
156 void css_generate_chp_crws(uint8_t cssid, uint8_t chpid);
157 void css_generate_css_crws(uint8_t cssid);
158 void css_clear_sei_pending(void);
159 int s390_ccw_cmd_request(ORB *orb, SCSW *scsw, void *data);
160 int do_subchannel_work_virtual(SubchDev *sub);
161 int do_subchannel_work_passthrough(SubchDev *sub);
162 
163 typedef enum {
164     CSS_IO_ADAPTER_VIRTIO = 0,
165     CSS_IO_ADAPTER_PCI = 1,
166     CSS_IO_ADAPTER_TYPE_NUMS,
167 } CssIoAdapterType;
168 
169 void css_adapter_interrupt(CssIoAdapterType type, uint8_t isc);
170 int css_do_sic(CPUS390XState *env, uint8_t isc, uint16_t mode);
171 uint32_t css_get_adapter_id(CssIoAdapterType type, uint8_t isc);
172 void css_register_io_adapters(CssIoAdapterType type, bool swap, bool maskable,
173                               uint8_t flags, Error **errp);
174 
175 #ifndef CONFIG_KVM
176 #define S390_ADAPTER_SUPPRESSIBLE 0x01
177 #else
178 #define S390_ADAPTER_SUPPRESSIBLE KVM_S390_ADAPTER_SUPPRESSIBLE
179 #endif
180 
181 #ifndef CONFIG_USER_ONLY
182 SubchDev *css_find_subch(uint8_t m, uint8_t cssid, uint8_t ssid,
183                          uint16_t schid);
184 bool css_subch_visible(SubchDev *sch);
185 void css_conditional_io_interrupt(SubchDev *sch);
186 int css_do_stsch(SubchDev *sch, SCHIB *schib);
187 bool css_schid_final(int m, uint8_t cssid, uint8_t ssid, uint16_t schid);
188 int css_do_msch(SubchDev *sch, const SCHIB *schib);
189 int css_do_xsch(SubchDev *sch);
190 int css_do_csch(SubchDev *sch);
191 int css_do_hsch(SubchDev *sch);
192 int css_do_ssch(SubchDev *sch, ORB *orb);
193 int css_do_tsch_get_irb(SubchDev *sch, IRB *irb, int *irb_len);
194 void css_do_tsch_update_subch(SubchDev *sch);
195 int css_do_stcrw(CRW *crw);
196 void css_undo_stcrw(CRW *crw);
197 int css_do_tpi(IOIntCode *int_code, int lowcore);
198 int css_collect_chp_desc(int m, uint8_t cssid, uint8_t f_chpid, uint8_t l_chpid,
199                          int rfmt, void *buf);
200 void css_do_schm(uint8_t mbk, int update, int dct, uint64_t mbo);
201 int css_enable_mcsse(void);
202 int css_enable_mss(void);
203 int css_do_rsch(SubchDev *sch);
204 int css_do_rchp(uint8_t cssid, uint8_t chpid);
205 bool css_present(uint8_t cssid);
206 #endif
207 
208 extern const PropertyInfo css_devid_ro_propinfo;
209 
210 #define DEFINE_PROP_CSS_DEV_ID_RO(_n, _s, _f) \
211     DEFINE_PROP(_n, _s, _f, css_devid_ro_propinfo, CssDevId)
212 
213 /**
214  * Create a subchannel for the given bus id.
215  *
216  * If @p bus_id is valid, and @p squash_mcss is true, verify that it is
217  * not already in use in the default css, and find a free devno from the
218  * default css image for it.
219  * If @p bus_id is valid, and @p squash_mcss is false, verify that it is
220  * not already in use, and find a free devno for it.
221  * If @p bus_id is not valid, and if either @p squash_mcss or @p is_virtual
222  * is true, find a free subchannel id and device number across all
223  * subchannel sets from the default css image.
224  * If @p bus_id is not valid, and if both @p squash_mcss and @p is_virtual
225  * are false, find a non-full css image and find a free subchannel id and
226  * device number across all subchannel sets from it.
227  *
228  * If either of the former actions succeed, allocate a subchannel structure,
229  * initialise it with the bus id, subchannel id and device number, register
230  * it with the CSS and return it. Otherwise return NULL.
231  *
232  * The caller becomes owner of the returned subchannel structure and
233  * is responsible for unregistering and freeing it.
234  */
235 SubchDev *css_create_sch(CssDevId bus_id, bool is_virtual, bool squash_mcss,
236                          Error **errp);
237 
238 /** Turn on css migration */
239 void css_register_vmstate(void);
240 
241 #endif
242