xref: /qemu/include/hw/s390x/s390_flic.h (revision db1015e92e04835c9eb50c29625fe566d1202dbd)
1 /*
2  * QEMU S390x floating interrupt controller (flic)
3  *
4  * Copyright 2014 IBM Corp.
5  * Author(s): Jens Freimann <jfrei@linux.vnet.ibm.com>
6  *            Cornelia Huck <cornelia.huck@de.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_S390_FLIC_H
14 #define HW_S390_FLIC_H
15 
16 #include "hw/sysbus.h"
17 #include "hw/s390x/adapter.h"
18 #include "hw/virtio/virtio.h"
19 #include "qemu/queue.h"
20 #include "qom/object.h"
21 
22 /*
23  * Reserve enough gsis to accommodate all virtio devices.
24  * If any other user of adapter routes needs more of these,
25  * we need to bump the value; but virtio looks like the
26  * maximum right now.
27  */
28 #define ADAPTER_ROUTES_MAX_GSI VIRTIO_QUEUE_MAX
29 
30 typedef struct AdapterRoutes {
31     AdapterInfo adapter;
32     int num_routes;
33     int gsi[ADAPTER_ROUTES_MAX_GSI];
34 } AdapterRoutes;
35 
36 extern const VMStateDescription vmstate_adapter_routes;
37 
38 #define VMSTATE_ADAPTER_ROUTES(_f, _s) \
39     VMSTATE_STRUCT(_f, _s, 1, vmstate_adapter_routes, AdapterRoutes)
40 
41 #define TYPE_S390_FLIC_COMMON "s390-flic"
42 typedef struct S390FLICState S390FLICState;
43 typedef struct S390FLICStateClass S390FLICStateClass;
44 #define S390_FLIC_COMMON(obj) \
45     OBJECT_CHECK(S390FLICState, (obj), TYPE_S390_FLIC_COMMON)
46 
47 struct S390FLICState {
48     SysBusDevice parent_obj;
49     /* to limit AdapterRoutes.num_routes for compat */
50     uint32_t adapter_routes_max_batch;
51     bool ais_supported;
52 };
53 
54 #define S390_FLIC_COMMON_CLASS(klass) \
55     OBJECT_CLASS_CHECK(S390FLICStateClass, (klass), TYPE_S390_FLIC_COMMON)
56 #define S390_FLIC_COMMON_GET_CLASS(obj) \
57     OBJECT_GET_CLASS(S390FLICStateClass, (obj), TYPE_S390_FLIC_COMMON)
58 
59 struct S390FLICStateClass {
60     DeviceClass parent_class;
61 
62     int (*register_io_adapter)(S390FLICState *fs, uint32_t id, uint8_t isc,
63                                bool swap, bool maskable, uint8_t flags);
64     int (*io_adapter_map)(S390FLICState *fs, uint32_t id, uint64_t map_addr,
65                           bool do_map);
66     int (*add_adapter_routes)(S390FLICState *fs, AdapterRoutes *routes);
67     void (*release_adapter_routes)(S390FLICState *fs, AdapterRoutes *routes);
68     int (*clear_io_irq)(S390FLICState *fs, uint16_t subchannel_id,
69                         uint16_t subchannel_nr);
70     int (*modify_ais_mode)(S390FLICState *fs, uint8_t isc, uint16_t mode);
71     int (*inject_airq)(S390FLICState *fs, uint8_t type, uint8_t isc,
72                        uint8_t flags);
73     void (*inject_service)(S390FLICState *fs, uint32_t parm);
74     void (*inject_io)(S390FLICState *fs, uint16_t subchannel_id,
75                       uint16_t subchannel_nr, uint32_t io_int_parm,
76                       uint32_t io_int_word);
77     void (*inject_crw_mchk)(S390FLICState *fs);
78 };
79 
80 #define TYPE_KVM_S390_FLIC "s390-flic-kvm"
81 typedef struct KVMS390FLICState KVMS390FLICState;
82 #define KVM_S390_FLIC(obj) \
83     OBJECT_CHECK(KVMS390FLICState, (obj), TYPE_KVM_S390_FLIC)
84 
85 #define TYPE_QEMU_S390_FLIC "s390-flic-qemu"
86 typedef struct QEMUS390FLICState QEMUS390FLICState;
87 #define QEMU_S390_FLIC(obj) \
88     OBJECT_CHECK(QEMUS390FLICState, (obj), TYPE_QEMU_S390_FLIC)
89 
90 #define SIC_IRQ_MODE_ALL 0
91 #define SIC_IRQ_MODE_SINGLE 1
92 #define AIS_MODE_MASK(isc) (0x80 >> isc)
93 
94 #define ISC_TO_PENDING_IO(_isc) (0x80 >> (_isc))
95 #define CR6_TO_PENDING_IO(_cr6) (((_cr6) >> 24) & 0xff)
96 
97 /* organize the ISC bits so that the macros above work */
98 #define FLIC_PENDING_IO_ISC7            (1 << 0)
99 #define FLIC_PENDING_IO_ISC6            (1 << 1)
100 #define FLIC_PENDING_IO_ISC5            (1 << 2)
101 #define FLIC_PENDING_IO_ISC4            (1 << 3)
102 #define FLIC_PENDING_IO_ISC3            (1 << 4)
103 #define FLIC_PENDING_IO_ISC2            (1 << 5)
104 #define FLIC_PENDING_IO_ISC1            (1 << 6)
105 #define FLIC_PENDING_IO_ISC0            (1 << 7)
106 #define FLIC_PENDING_SERVICE            (1 << 8)
107 #define FLIC_PENDING_MCHK_CR            (1 << 9)
108 
109 #define FLIC_PENDING_IO (FLIC_PENDING_IO_ISC0 | FLIC_PENDING_IO_ISC1 | \
110                          FLIC_PENDING_IO_ISC2 | FLIC_PENDING_IO_ISC3 | \
111                          FLIC_PENDING_IO_ISC4 | FLIC_PENDING_IO_ISC5 | \
112                          FLIC_PENDING_IO_ISC6 | FLIC_PENDING_IO_ISC7)
113 
114 typedef struct QEMUS390FlicIO {
115     uint16_t id;
116     uint16_t nr;
117     uint32_t parm;
118     uint32_t word;
119     QLIST_ENTRY(QEMUS390FlicIO) next;
120 } QEMUS390FlicIO;
121 
122 struct QEMUS390FLICState {
123     S390FLICState parent_obj;
124     uint32_t pending;
125     uint32_t service_param;
126     uint8_t simm;
127     uint8_t nimm;
128     QLIST_HEAD(, QEMUS390FlicIO) io[8];
129 };
130 
131 uint32_t qemu_s390_flic_dequeue_service(QEMUS390FLICState *flic);
132 QEMUS390FlicIO *qemu_s390_flic_dequeue_io(QEMUS390FLICState *flic,
133                                           uint64_t cr6);
134 void qemu_s390_flic_dequeue_crw_mchk(QEMUS390FLICState *flic);
135 bool qemu_s390_flic_has_service(QEMUS390FLICState *flic);
136 bool qemu_s390_flic_has_io(QEMUS390FLICState *fs, uint64_t cr6);
137 bool qemu_s390_flic_has_crw_mchk(QEMUS390FLICState *flic);
138 bool qemu_s390_flic_has_any(QEMUS390FLICState *flic);
139 
140 void s390_flic_init(void);
141 
142 S390FLICState *s390_get_flic(void);
143 QEMUS390FLICState *s390_get_qemu_flic(S390FLICState *fs);
144 S390FLICStateClass *s390_get_flic_class(S390FLICState *fs);
145 bool ais_needed(void *opaque);
146 
147 #endif /* HW_S390_FLIC_H */
148