xref: /openbmc/qemu/include/hw/s390x/s390_flic.h (revision 60efffa4)
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 OBJECT_DECLARE_TYPE(S390FLICState, S390FLICStateClass,
43                     s390_flic_common, S390_FLIC_COMMON)
44 
45 struct S390FLICState {
46     SysBusDevice parent_obj;
47     /* to limit AdapterRoutes.num_routes for compat */
48     uint32_t adapter_routes_max_batch;
49     bool ais_supported;
50 };
51 
52 
53 struct S390FLICStateClass {
54     DeviceClass parent_class;
55 
56     int (*register_io_adapter)(S390FLICState *fs, uint32_t id, uint8_t isc,
57                                bool swap, bool maskable, uint8_t flags);
58     int (*io_adapter_map)(S390FLICState *fs, uint32_t id, uint64_t map_addr,
59                           bool do_map);
60     int (*add_adapter_routes)(S390FLICState *fs, AdapterRoutes *routes);
61     void (*release_adapter_routes)(S390FLICState *fs, AdapterRoutes *routes);
62     int (*clear_io_irq)(S390FLICState *fs, uint16_t subchannel_id,
63                         uint16_t subchannel_nr);
64     int (*modify_ais_mode)(S390FLICState *fs, uint8_t isc, uint16_t mode);
65     int (*inject_airq)(S390FLICState *fs, uint8_t type, uint8_t isc,
66                        uint8_t flags);
67     void (*inject_service)(S390FLICState *fs, uint32_t parm);
68     void (*inject_io)(S390FLICState *fs, uint16_t subchannel_id,
69                       uint16_t subchannel_nr, uint32_t io_int_parm,
70                       uint32_t io_int_word);
71     void (*inject_crw_mchk)(S390FLICState *fs);
72 };
73 
74 #define TYPE_KVM_S390_FLIC "s390-flic-kvm"
75 typedef struct KVMS390FLICState KVMS390FLICState;
76 DECLARE_INSTANCE_CHECKER(KVMS390FLICState, KVM_S390_FLIC,
77                          TYPE_KVM_S390_FLIC)
78 
79 #define TYPE_QEMU_S390_FLIC "s390-flic-qemu"
80 typedef struct QEMUS390FLICState QEMUS390FLICState;
81 DECLARE_INSTANCE_CHECKER(QEMUS390FLICState, QEMU_S390_FLIC,
82                          TYPE_QEMU_S390_FLIC)
83 
84 #define SIC_IRQ_MODE_ALL 0
85 #define SIC_IRQ_MODE_SINGLE 1
86 #define AIS_MODE_MASK(isc) (0x80 >> isc)
87 
88 #define ISC_TO_PENDING_IO(_isc) (0x80 >> (_isc))
89 #define CR6_TO_PENDING_IO(_cr6) (((_cr6) >> 24) & 0xff)
90 
91 /* organize the ISC bits so that the macros above work */
92 #define FLIC_PENDING_IO_ISC7            (1 << 0)
93 #define FLIC_PENDING_IO_ISC6            (1 << 1)
94 #define FLIC_PENDING_IO_ISC5            (1 << 2)
95 #define FLIC_PENDING_IO_ISC4            (1 << 3)
96 #define FLIC_PENDING_IO_ISC3            (1 << 4)
97 #define FLIC_PENDING_IO_ISC2            (1 << 5)
98 #define FLIC_PENDING_IO_ISC1            (1 << 6)
99 #define FLIC_PENDING_IO_ISC0            (1 << 7)
100 #define FLIC_PENDING_SERVICE            (1 << 8)
101 #define FLIC_PENDING_MCHK_CR            (1 << 9)
102 
103 #define FLIC_PENDING_IO (FLIC_PENDING_IO_ISC0 | FLIC_PENDING_IO_ISC1 | \
104                          FLIC_PENDING_IO_ISC2 | FLIC_PENDING_IO_ISC3 | \
105                          FLIC_PENDING_IO_ISC4 | FLIC_PENDING_IO_ISC5 | \
106                          FLIC_PENDING_IO_ISC6 | FLIC_PENDING_IO_ISC7)
107 
108 typedef struct QEMUS390FlicIO {
109     uint16_t id;
110     uint16_t nr;
111     uint32_t parm;
112     uint32_t word;
113     QLIST_ENTRY(QEMUS390FlicIO) next;
114 } QEMUS390FlicIO;
115 
116 struct QEMUS390FLICState {
117     S390FLICState parent_obj;
118     uint32_t pending;
119     uint32_t service_param;
120     uint8_t simm;
121     uint8_t nimm;
122     QLIST_HEAD(, QEMUS390FlicIO) io[8];
123 };
124 
125 uint32_t qemu_s390_flic_dequeue_service(QEMUS390FLICState *flic);
126 QEMUS390FlicIO *qemu_s390_flic_dequeue_io(QEMUS390FLICState *flic,
127                                           uint64_t cr6);
128 void qemu_s390_flic_dequeue_crw_mchk(QEMUS390FLICState *flic);
129 bool qemu_s390_flic_has_service(QEMUS390FLICState *flic);
130 bool qemu_s390_flic_has_io(QEMUS390FLICState *fs, uint64_t cr6);
131 bool qemu_s390_flic_has_crw_mchk(QEMUS390FLICState *flic);
132 bool qemu_s390_flic_has_any(QEMUS390FLICState *flic);
133 
134 void s390_flic_init(void);
135 
136 S390FLICState *s390_get_flic(void);
137 QEMUS390FLICState *s390_get_qemu_flic(S390FLICState *fs);
138 S390FLICStateClass *s390_get_flic_class(S390FLICState *fs);
139 bool ais_needed(void *opaque);
140 
141 #endif /* HW_S390_FLIC_H */
142