include/hw/s390x/s390_flic.h

   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)
  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 OBJECT_DECLARE_SIMPLE_TYPE(QEMUS390FLICState, QEMU_S390_FLIC)
  81
  82 #define SIC_IRQ_MODE_ALL 0
  83 #define SIC_IRQ_MODE_SINGLE 1
  84 #define AIS_MODE_MASK(isc) (0x80 >> isc)
  85
  86 #define ISC_TO_PENDING_IO(_isc) (0x80 >> (_isc))
  87 #define CR6_TO_PENDING_IO(_cr6) (((_cr6) >> 24) & 0xff)
  88
  89 /* organize the ISC bits so that the macros above work */
  90 #define FLIC_PENDING_IO_ISC7            (1 << 0)
  91 #define FLIC_PENDING_IO_ISC6            (1 << 1)
  92 #define FLIC_PENDING_IO_ISC5            (1 << 2)
  93 #define FLIC_PENDING_IO_ISC4            (1 << 3)
  94 #define FLIC_PENDING_IO_ISC3            (1 << 4)
  95 #define FLIC_PENDING_IO_ISC2            (1 << 5)
  96 #define FLIC_PENDING_IO_ISC1            (1 << 6)
  97 #define FLIC_PENDING_IO_ISC0            (1 << 7)
  98 #define FLIC_PENDING_SERVICE            (1 << 8)
  99 #define FLIC_PENDING_MCHK_CR            (1 << 9)
 100
 101 #define FLIC_PENDING_IO (FLIC_PENDING_IO_ISC0 | FLIC_PENDING_IO_ISC1 | \
 102                          FLIC_PENDING_IO_ISC2 | FLIC_PENDING_IO_ISC3 | \
 103                          FLIC_PENDING_IO_ISC4 | FLIC_PENDING_IO_ISC5 | \
 104                          FLIC_PENDING_IO_ISC6 | FLIC_PENDING_IO_ISC7)
 105
 106 typedef struct QEMUS390FlicIO {
 107     uint16_t id;
 108     uint16_t nr;
 109     uint32_t parm;
 110     uint32_t word;
 111     QLIST_ENTRY(QEMUS390FlicIO) next;
 112 } QEMUS390FlicIO;
 113
 114 struct QEMUS390FLICState {
 115     S390FLICState parent_obj;
 116     uint32_t pending;
 117     uint32_t service_param;
 118     uint8_t simm;
 119     uint8_t nimm;
 120     QLIST_HEAD(, QEMUS390FlicIO) io[8];
 121 };
 122
 123 uint32_t qemu_s390_flic_dequeue_service(QEMUS390FLICState *flic);
 124 QEMUS390FlicIO *qemu_s390_flic_dequeue_io(QEMUS390FLICState *flic,
 125                                           uint64_t cr6);
 126 void qemu_s390_flic_dequeue_crw_mchk(QEMUS390FLICState *flic);
 127 bool qemu_s390_flic_has_service(QEMUS390FLICState *flic);
 128 bool qemu_s390_flic_has_io(QEMUS390FLICState *fs, uint64_t cr6);
 129 bool qemu_s390_flic_has_crw_mchk(QEMUS390FLICState *flic);
 130 bool qemu_s390_flic_has_any(QEMUS390FLICState *flic);
 131
 132 void s390_flic_init(void);
 133
 134 S390FLICState *s390_get_flic(void);
 135 QEMUS390FLICState *s390_get_qemu_flic(S390FLICState *fs);
 136 S390FLICStateClass *s390_get_flic_class(S390FLICState *fs);
 137 bool ais_needed(void *opaque);
 138
 139 #endif /* HW_S390_FLIC_H */