xref: /openbmc/qemu/include/hw/s390x/css.h (revision 795c40b8)
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 "hw/s390x/adapter.h"
16 #include "hw/s390x/s390_flic.h"
17 #include "hw/s390x/ioinst.h"
18 
19 /* Channel subsystem constants. */
20 #define MAX_DEVNO 65535
21 #define MAX_SCHID 65535
22 #define MAX_SSID 3
23 #define MAX_CSSID 255
24 #define MAX_CHPID 255
25 
26 #define MAX_ISC 7
27 
28 #define MAX_CIWS 62
29 
30 #define VIRTUAL_CSSID 0xfe
31 #define VIRTIO_CCW_CHPID 0   /* used by convention */
32 
33 typedef struct CIW {
34     uint8_t type;
35     uint8_t command;
36     uint16_t count;
37 } QEMU_PACKED CIW;
38 
39 typedef struct SenseId {
40     /* common part */
41     uint8_t reserved;        /* always 0x'FF' */
42     uint16_t cu_type;        /* control unit type */
43     uint8_t cu_model;        /* control unit model */
44     uint16_t dev_type;       /* device type */
45     uint8_t dev_model;       /* device model */
46     uint8_t unused;          /* padding byte */
47     /* extended part */
48     CIW ciw[MAX_CIWS];       /* variable # of CIWs */
49 } QEMU_PACKED SenseId;
50 
51 /* Channel measurements, from linux/drivers/s390/cio/cmf.c. */
52 typedef struct CMB {
53     uint16_t ssch_rsch_count;
54     uint16_t sample_count;
55     uint32_t device_connect_time;
56     uint32_t function_pending_time;
57     uint32_t device_disconnect_time;
58     uint32_t control_unit_queuing_time;
59     uint32_t device_active_only_time;
60     uint32_t reserved[2];
61 } QEMU_PACKED CMB;
62 
63 typedef struct CMBE {
64     uint32_t ssch_rsch_count;
65     uint32_t sample_count;
66     uint32_t device_connect_time;
67     uint32_t function_pending_time;
68     uint32_t device_disconnect_time;
69     uint32_t control_unit_queuing_time;
70     uint32_t device_active_only_time;
71     uint32_t device_busy_time;
72     uint32_t initial_command_response_time;
73     uint32_t reserved[7];
74 } QEMU_PACKED CMBE;
75 
76 typedef struct SubchDev SubchDev;
77 struct SubchDev {
78     /* channel-subsystem related things: */
79     uint8_t cssid;
80     uint8_t ssid;
81     uint16_t schid;
82     uint16_t devno;
83     SCHIB curr_status;
84     uint8_t sense_data[32];
85     hwaddr channel_prog;
86     CCW1 last_cmd;
87     bool last_cmd_valid;
88     bool ccw_fmt_1;
89     bool thinint_active;
90     uint8_t ccw_no_data_cnt;
91     /* transport-provided data: */
92     int (*ccw_cb) (SubchDev *, CCW1);
93     void (*disable_cb)(SubchDev *);
94     SenseId id;
95     void *driver_data;
96 };
97 
98 typedef struct IndAddr {
99     hwaddr addr;
100     uint64_t map;
101     unsigned long refcnt;
102     int len;
103     QTAILQ_ENTRY(IndAddr) sibling;
104 } IndAddr;
105 
106 IndAddr *get_indicator(hwaddr ind_addr, int len);
107 void release_indicator(AdapterInfo *adapter, IndAddr *indicator);
108 int map_indicator(AdapterInfo *adapter, IndAddr *indicator);
109 
110 typedef SubchDev *(*css_subch_cb_func)(uint8_t m, uint8_t cssid, uint8_t ssid,
111                                        uint16_t schid);
112 void subch_device_save(SubchDev *s, QEMUFile *f);
113 int subch_device_load(SubchDev *s, QEMUFile *f);
114 int css_create_css_image(uint8_t cssid, bool default_image);
115 bool css_devno_used(uint8_t cssid, uint8_t ssid, uint16_t devno);
116 void css_subch_assign(uint8_t cssid, uint8_t ssid, uint16_t schid,
117                       uint16_t devno, SubchDev *sch);
118 void css_sch_build_virtual_schib(SubchDev *sch, uint8_t chpid, uint8_t type);
119 unsigned int css_find_free_chpid(uint8_t cssid);
120 uint16_t css_build_subchannel_id(SubchDev *sch);
121 void css_reset(void);
122 void css_reset_sch(SubchDev *sch);
123 void css_queue_crw(uint8_t rsc, uint8_t erc, int chain, uint16_t rsid);
124 void css_generate_sch_crws(uint8_t cssid, uint8_t ssid, uint16_t schid,
125                            int hotplugged, int add);
126 void css_generate_chp_crws(uint8_t cssid, uint8_t chpid);
127 void css_generate_css_crws(uint8_t cssid);
128 void css_clear_sei_pending(void);
129 void css_adapter_interrupt(uint8_t isc);
130 
131 typedef enum {
132     CSS_IO_ADAPTER_VIRTIO = 0,
133     CSS_IO_ADAPTER_PCI = 1,
134     CSS_IO_ADAPTER_TYPE_NUMS,
135 } CssIoAdapterType;
136 
137 uint32_t css_get_adapter_id(CssIoAdapterType type, uint8_t isc);
138 void css_register_io_adapters(CssIoAdapterType type, bool swap, bool maskable,
139                               Error **errp);
140 
141 #ifndef CONFIG_USER_ONLY
142 SubchDev *css_find_subch(uint8_t m, uint8_t cssid, uint8_t ssid,
143                          uint16_t schid);
144 bool css_subch_visible(SubchDev *sch);
145 void css_conditional_io_interrupt(SubchDev *sch);
146 int css_do_stsch(SubchDev *sch, SCHIB *schib);
147 bool css_schid_final(int m, uint8_t cssid, uint8_t ssid, uint16_t schid);
148 int css_do_msch(SubchDev *sch, const SCHIB *schib);
149 int css_do_xsch(SubchDev *sch);
150 int css_do_csch(SubchDev *sch);
151 int css_do_hsch(SubchDev *sch);
152 int css_do_ssch(SubchDev *sch, ORB *orb);
153 int css_do_tsch_get_irb(SubchDev *sch, IRB *irb, int *irb_len);
154 void css_do_tsch_update_subch(SubchDev *sch);
155 int css_do_stcrw(CRW *crw);
156 void css_undo_stcrw(CRW *crw);
157 int css_do_tpi(IOIntCode *int_code, int lowcore);
158 int css_collect_chp_desc(int m, uint8_t cssid, uint8_t f_chpid, uint8_t l_chpid,
159                          int rfmt, void *buf);
160 void css_do_schm(uint8_t mbk, int update, int dct, uint64_t mbo);
161 int css_enable_mcsse(void);
162 int css_enable_mss(void);
163 int css_do_rsch(SubchDev *sch);
164 int css_do_rchp(uint8_t cssid, uint8_t chpid);
165 bool css_present(uint8_t cssid);
166 #endif
167 /*
168  * Identify a device within the channel subsystem.
169  * Note that this can be used to identify either the subchannel or
170  * the attached I/O device, as there's always one I/O device per
171  * subchannel.
172  */
173 typedef struct CssDevId {
174     uint8_t cssid;
175     uint8_t ssid;
176     uint16_t devid;
177     bool valid;
178 } CssDevId;
179 
180 extern PropertyInfo css_devid_propinfo;
181 
182 #define DEFINE_PROP_CSS_DEV_ID(_n, _s, _f) \
183     DEFINE_PROP(_n, _s, _f, css_devid_propinfo, CssDevId)
184 
185 extern PropertyInfo css_devid_ro_propinfo;
186 
187 #define DEFINE_PROP_CSS_DEV_ID_RO(_n, _s, _f) \
188     DEFINE_PROP(_n, _s, _f, css_devid_ro_propinfo, CssDevId)
189 
190 /**
191  * Create a subchannel for the given bus id.
192  *
193  * If @p bus_id is valid, verify that it uses the virtual channel
194  * subsystem id and is not already in use, and find a free subchannel
195  * id for it. If @p bus_id is not valid, find a free subchannel id and
196  * device number across all subchannel sets. If either of the former
197  * actions succeed, allocate a subchannel structure, initialise it
198  * with the bus id, subchannel id and device number, register it with
199  * the CSS and return it. Otherwise return NULL.
200  *
201  * The caller becomes owner of the returned subchannel structure and
202  * is responsible for unregistering and freeing it.
203  */
204 SubchDev *css_create_virtual_sch(CssDevId bus_id, Error **errp);
205 #endif
206