1 /* 2 * QEMU PowerPC pSeries Logical Partition (aka sPAPR) hardware System Emulator 3 * 4 * PAPR Virtualized Interrupt System, aka ICS/ICP aka xics 5 * 6 * Copyright (c) 2010,2011 David Gibson, IBM Corporation. 7 * 8 * Permission is hereby granted, free of charge, to any person obtaining a copy 9 * of this software and associated documentation files (the "Software"), to deal 10 * in the Software without restriction, including without limitation the rights 11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 12 * copies of the Software, and to permit persons to whom the Software is 13 * furnished to do so, subject to the following conditions: 14 * 15 * The above copyright notice and this permission notice shall be included in 16 * all copies or substantial portions of the Software. 17 * 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 24 * THE SOFTWARE. 25 * 26 */ 27 28 #ifndef XICS_H 29 #define XICS_H 30 31 #include "hw/qdev.h" 32 #include "target/ppc/cpu-qom.h" 33 34 #define XICS_IPI 0x2 35 #define XICS_BUID 0x1 36 #define XICS_IRQ_BASE (XICS_BUID << 12) 37 38 /* 39 * We currently only support one BUID which is our interrupt base 40 * (the kernel implementation supports more but we don't exploit 41 * that yet) 42 */ 43 typedef struct ICPStateClass ICPStateClass; 44 typedef struct ICPState ICPState; 45 typedef struct PnvICPState PnvICPState; 46 typedef struct ICSStateClass ICSStateClass; 47 typedef struct ICSState ICSState; 48 typedef struct ICSIRQState ICSIRQState; 49 typedef struct XICSFabric XICSFabric; 50 51 #define TYPE_ICP "icp" 52 #define ICP(obj) OBJECT_CHECK(ICPState, (obj), TYPE_ICP) 53 54 #define TYPE_KVM_ICP "icp-kvm" 55 #define KVM_ICP(obj) OBJECT_CHECK(ICPState, (obj), TYPE_KVM_ICP) 56 57 #define TYPE_PNV_ICP "pnv-icp" 58 #define PNV_ICP(obj) OBJECT_CHECK(PnvICPState, (obj), TYPE_PNV_ICP) 59 60 #define ICP_CLASS(klass) \ 61 OBJECT_CLASS_CHECK(ICPStateClass, (klass), TYPE_ICP) 62 #define ICP_GET_CLASS(obj) \ 63 OBJECT_GET_CLASS(ICPStateClass, (obj), TYPE_ICP) 64 65 struct ICPStateClass { 66 DeviceClass parent_class; 67 68 void (*realize)(DeviceState *dev, Error **errp); 69 void (*pre_save)(ICPState *s); 70 int (*post_load)(ICPState *s, int version_id); 71 void (*cpu_setup)(ICPState *icp, PowerPCCPU *cpu); 72 }; 73 74 struct ICPState { 75 /*< private >*/ 76 DeviceState parent_obj; 77 /*< public >*/ 78 CPUState *cs; 79 ICSState *xirr_owner; 80 uint32_t xirr; 81 uint8_t pending_priority; 82 uint8_t mfrr; 83 qemu_irq output; 84 85 XICSFabric *xics; 86 }; 87 88 struct PnvICPState { 89 ICPState parent_obj; 90 91 MemoryRegion mmio; 92 uint32_t links[3]; 93 }; 94 95 #define TYPE_ICS_BASE "ics-base" 96 #define ICS_BASE(obj) OBJECT_CHECK(ICSState, (obj), TYPE_ICS_BASE) 97 98 /* Retain ics for sPAPR for migration from existing sPAPR guests */ 99 #define TYPE_ICS_SIMPLE "ics" 100 #define ICS_SIMPLE(obj) OBJECT_CHECK(ICSState, (obj), TYPE_ICS_SIMPLE) 101 102 #define TYPE_ICS_KVM "icskvm" 103 #define ICS_KVM(obj) OBJECT_CHECK(ICSState, (obj), TYPE_ICS_KVM) 104 105 #define ICS_BASE_CLASS(klass) \ 106 OBJECT_CLASS_CHECK(ICSStateClass, (klass), TYPE_ICS_BASE) 107 #define ICS_BASE_GET_CLASS(obj) \ 108 OBJECT_GET_CLASS(ICSStateClass, (obj), TYPE_ICS_BASE) 109 110 struct ICSStateClass { 111 DeviceClass parent_class; 112 113 void (*realize)(DeviceState *dev, Error **errp); 114 void (*pre_save)(ICSState *s); 115 int (*post_load)(ICSState *s, int version_id); 116 void (*reject)(ICSState *s, uint32_t irq); 117 void (*resend)(ICSState *s); 118 void (*eoi)(ICSState *s, uint32_t irq); 119 }; 120 121 struct ICSState { 122 /*< private >*/ 123 DeviceState parent_obj; 124 /*< public >*/ 125 uint32_t nr_irqs; 126 uint32_t offset; 127 qemu_irq *qirqs; 128 ICSIRQState *irqs; 129 XICSFabric *xics; 130 }; 131 132 static inline bool ics_valid_irq(ICSState *ics, uint32_t nr) 133 { 134 return (ics->offset != 0) && (nr >= ics->offset) 135 && (nr < (ics->offset + ics->nr_irqs)); 136 } 137 138 struct ICSIRQState { 139 uint32_t server; 140 uint8_t priority; 141 uint8_t saved_priority; 142 #define XICS_STATUS_ASSERTED 0x1 143 #define XICS_STATUS_SENT 0x2 144 #define XICS_STATUS_REJECTED 0x4 145 #define XICS_STATUS_MASKED_PENDING 0x8 146 #define XICS_STATUS_PRESENTED 0x10 147 #define XICS_STATUS_QUEUED 0x20 148 uint8_t status; 149 /* (flags & XICS_FLAGS_IRQ_MASK) == 0 means the interrupt is not allocated */ 150 #define XICS_FLAGS_IRQ_LSI 0x1 151 #define XICS_FLAGS_IRQ_MSI 0x2 152 #define XICS_FLAGS_IRQ_MASK 0x3 153 uint8_t flags; 154 }; 155 156 struct XICSFabric { 157 Object parent; 158 }; 159 160 #define TYPE_XICS_FABRIC "xics-fabric" 161 #define XICS_FABRIC(obj) \ 162 OBJECT_CHECK(XICSFabric, (obj), TYPE_XICS_FABRIC) 163 #define XICS_FABRIC_CLASS(klass) \ 164 OBJECT_CLASS_CHECK(XICSFabricClass, (klass), TYPE_XICS_FABRIC) 165 #define XICS_FABRIC_GET_CLASS(obj) \ 166 OBJECT_GET_CLASS(XICSFabricClass, (obj), TYPE_XICS_FABRIC) 167 168 typedef struct XICSFabricClass { 169 InterfaceClass parent; 170 ICSState *(*ics_get)(XICSFabric *xi, int irq); 171 void (*ics_resend)(XICSFabric *xi); 172 ICPState *(*icp_get)(XICSFabric *xi, int server); 173 } XICSFabricClass; 174 175 #define XICS_IRQS_SPAPR 1024 176 177 int spapr_ics_alloc(ICSState *ics, int irq_hint, bool lsi, Error **errp); 178 int spapr_ics_alloc_block(ICSState *ics, int num, bool lsi, bool align, 179 Error **errp); 180 void spapr_ics_free(ICSState *ics, int irq, int num); 181 void spapr_dt_xics(int nr_servers, void *fdt, uint32_t phandle); 182 183 qemu_irq xics_get_qirq(XICSFabric *xi, int irq); 184 ICPState *xics_icp_get(XICSFabric *xi, int server); 185 void xics_cpu_setup(XICSFabric *xi, PowerPCCPU *cpu, ICPState *icp); 186 void xics_cpu_destroy(XICSFabric *xi, PowerPCCPU *cpu); 187 188 /* Internal XICS interfaces */ 189 void icp_set_cppr(ICPState *icp, uint8_t cppr); 190 void icp_set_mfrr(ICPState *icp, uint8_t mfrr); 191 uint32_t icp_accept(ICPState *ss); 192 uint32_t icp_ipoll(ICPState *ss, uint32_t *mfrr); 193 void icp_eoi(ICPState *icp, uint32_t xirr); 194 195 void ics_simple_write_xive(ICSState *ics, int nr, int server, 196 uint8_t priority, uint8_t saved_priority); 197 198 void ics_set_irq_type(ICSState *ics, int srcno, bool lsi); 199 void icp_pic_print_info(ICPState *icp, Monitor *mon); 200 void ics_pic_print_info(ICSState *ics, Monitor *mon); 201 202 void ics_resend(ICSState *ics); 203 void icp_resend(ICPState *ss); 204 205 typedef struct sPAPRMachineState sPAPRMachineState; 206 207 int xics_kvm_init(sPAPRMachineState *spapr, Error **errp); 208 void xics_spapr_init(sPAPRMachineState *spapr); 209 210 #endif /* XICS_H */ 211