xref: /openbmc/qemu/hw/intc/exynos4210_gic.c (revision 756a98dd)
1 /*
2  * Samsung exynos4210 GIC implementation. Based on hw/arm_gic.c
3  *
4  * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd.
5  * All rights reserved.
6  *
7  * Evgeny Voevodin <e.voevodin@samsung.com>
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU General Public License as published by the
11  * Free Software Foundation; either version 2 of the License, or (at your
12  * option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
17  * See the GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License along
20  * with this program; if not, see <http://www.gnu.org/licenses/>.
21  */
22 
23 #include "qemu/osdep.h"
24 #include "hw/sysbus.h"
25 #include "migration/vmstate.h"
26 #include "qapi/error.h"
27 #include "qemu/module.h"
28 #include "hw/irq.h"
29 #include "hw/qdev-properties.h"
30 #include "hw/arm/exynos4210.h"
31 #include "qom/object.h"
32 
33 enum ExtGicId {
34     EXT_GIC_ID_MDMA_LCD0 = 66,
35     EXT_GIC_ID_PDMA0,
36     EXT_GIC_ID_PDMA1,
37     EXT_GIC_ID_TIMER0,
38     EXT_GIC_ID_TIMER1,
39     EXT_GIC_ID_TIMER2,
40     EXT_GIC_ID_TIMER3,
41     EXT_GIC_ID_TIMER4,
42     EXT_GIC_ID_MCT_L0,
43     EXT_GIC_ID_WDT,
44     EXT_GIC_ID_RTC_ALARM,
45     EXT_GIC_ID_RTC_TIC,
46     EXT_GIC_ID_GPIO_XB,
47     EXT_GIC_ID_GPIO_XA,
48     EXT_GIC_ID_MCT_L1,
49     EXT_GIC_ID_IEM_APC,
50     EXT_GIC_ID_IEM_IEC,
51     EXT_GIC_ID_NFC,
52     EXT_GIC_ID_UART0,
53     EXT_GIC_ID_UART1,
54     EXT_GIC_ID_UART2,
55     EXT_GIC_ID_UART3,
56     EXT_GIC_ID_UART4,
57     EXT_GIC_ID_MCT_G0,
58     EXT_GIC_ID_I2C0,
59     EXT_GIC_ID_I2C1,
60     EXT_GIC_ID_I2C2,
61     EXT_GIC_ID_I2C3,
62     EXT_GIC_ID_I2C4,
63     EXT_GIC_ID_I2C5,
64     EXT_GIC_ID_I2C6,
65     EXT_GIC_ID_I2C7,
66     EXT_GIC_ID_SPI0,
67     EXT_GIC_ID_SPI1,
68     EXT_GIC_ID_SPI2,
69     EXT_GIC_ID_MCT_G1,
70     EXT_GIC_ID_USB_HOST,
71     EXT_GIC_ID_USB_DEVICE,
72     EXT_GIC_ID_MODEMIF,
73     EXT_GIC_ID_HSMMC0,
74     EXT_GIC_ID_HSMMC1,
75     EXT_GIC_ID_HSMMC2,
76     EXT_GIC_ID_HSMMC3,
77     EXT_GIC_ID_SDMMC,
78     EXT_GIC_ID_MIPI_CSI_4LANE,
79     EXT_GIC_ID_MIPI_DSI_4LANE,
80     EXT_GIC_ID_MIPI_CSI_2LANE,
81     EXT_GIC_ID_MIPI_DSI_2LANE,
82     EXT_GIC_ID_ONENAND_AUDI,
83     EXT_GIC_ID_ROTATOR,
84     EXT_GIC_ID_FIMC0,
85     EXT_GIC_ID_FIMC1,
86     EXT_GIC_ID_FIMC2,
87     EXT_GIC_ID_FIMC3,
88     EXT_GIC_ID_JPEG,
89     EXT_GIC_ID_2D,
90     EXT_GIC_ID_PCIe,
91     EXT_GIC_ID_MIXER,
92     EXT_GIC_ID_HDMI,
93     EXT_GIC_ID_HDMI_I2C,
94     EXT_GIC_ID_MFC,
95     EXT_GIC_ID_TVENC,
96 };
97 
98 enum ExtInt {
99     EXT_GIC_ID_EXTINT0 = 48,
100     EXT_GIC_ID_EXTINT1,
101     EXT_GIC_ID_EXTINT2,
102     EXT_GIC_ID_EXTINT3,
103     EXT_GIC_ID_EXTINT4,
104     EXT_GIC_ID_EXTINT5,
105     EXT_GIC_ID_EXTINT6,
106     EXT_GIC_ID_EXTINT7,
107     EXT_GIC_ID_EXTINT8,
108     EXT_GIC_ID_EXTINT9,
109     EXT_GIC_ID_EXTINT10,
110     EXT_GIC_ID_EXTINT11,
111     EXT_GIC_ID_EXTINT12,
112     EXT_GIC_ID_EXTINT13,
113     EXT_GIC_ID_EXTINT14,
114     EXT_GIC_ID_EXTINT15
115 };
116 
117 /*
118  * External GIC sources which are not from External Interrupt Combiner or
119  * External Interrupts are starting from EXYNOS4210_MAX_EXT_COMBINER_OUT_IRQ,
120  * which is INTG16 in Internal Interrupt Combiner.
121  */
122 
123 static const uint32_t
124 combiner_grp_to_gic_id[64-EXYNOS4210_MAX_EXT_COMBINER_OUT_IRQ][8] = {
125     /* int combiner groups 16-19 */
126     { }, { }, { }, { },
127     /* int combiner group 20 */
128     { 0, EXT_GIC_ID_MDMA_LCD0 },
129     /* int combiner group 21 */
130     { EXT_GIC_ID_PDMA0, EXT_GIC_ID_PDMA1 },
131     /* int combiner group 22 */
132     { EXT_GIC_ID_TIMER0, EXT_GIC_ID_TIMER1, EXT_GIC_ID_TIMER2,
133             EXT_GIC_ID_TIMER3, EXT_GIC_ID_TIMER4 },
134     /* int combiner group 23 */
135     { EXT_GIC_ID_RTC_ALARM, EXT_GIC_ID_RTC_TIC },
136     /* int combiner group 24 */
137     { EXT_GIC_ID_GPIO_XB, EXT_GIC_ID_GPIO_XA },
138     /* int combiner group 25 */
139     { EXT_GIC_ID_IEM_APC, EXT_GIC_ID_IEM_IEC },
140     /* int combiner group 26 */
141     { EXT_GIC_ID_UART0, EXT_GIC_ID_UART1, EXT_GIC_ID_UART2, EXT_GIC_ID_UART3,
142             EXT_GIC_ID_UART4 },
143     /* int combiner group 27 */
144     { EXT_GIC_ID_I2C0, EXT_GIC_ID_I2C1, EXT_GIC_ID_I2C2, EXT_GIC_ID_I2C3,
145             EXT_GIC_ID_I2C4, EXT_GIC_ID_I2C5, EXT_GIC_ID_I2C6,
146             EXT_GIC_ID_I2C7 },
147     /* int combiner group 28 */
148     { EXT_GIC_ID_SPI0, EXT_GIC_ID_SPI1, EXT_GIC_ID_SPI2 , EXT_GIC_ID_USB_HOST},
149     /* int combiner group 29 */
150     { EXT_GIC_ID_HSMMC0, EXT_GIC_ID_HSMMC1, EXT_GIC_ID_HSMMC2,
151      EXT_GIC_ID_HSMMC3, EXT_GIC_ID_SDMMC },
152     /* int combiner group 30 */
153     { EXT_GIC_ID_MIPI_CSI_4LANE, EXT_GIC_ID_MIPI_CSI_2LANE },
154     /* int combiner group 31 */
155     { EXT_GIC_ID_MIPI_DSI_4LANE, EXT_GIC_ID_MIPI_DSI_2LANE },
156     /* int combiner group 32 */
157     { EXT_GIC_ID_FIMC0, EXT_GIC_ID_FIMC1 },
158     /* int combiner group 33 */
159     { EXT_GIC_ID_FIMC2, EXT_GIC_ID_FIMC3 },
160     /* int combiner group 34 */
161     { EXT_GIC_ID_ONENAND_AUDI, EXT_GIC_ID_NFC },
162     /* int combiner group 35 */
163     { 0, 0, 0, EXT_GIC_ID_MCT_L1, EXT_GIC_ID_MCT_G0, EXT_GIC_ID_MCT_G1 },
164     /* int combiner group 36 */
165     { EXT_GIC_ID_MIXER },
166     /* int combiner group 37 */
167     { EXT_GIC_ID_EXTINT4, EXT_GIC_ID_EXTINT5, EXT_GIC_ID_EXTINT6,
168      EXT_GIC_ID_EXTINT7 },
169     /* groups 38-50 */
170     { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { },
171     /* int combiner group 51 */
172     { EXT_GIC_ID_MCT_L0, 0, 0, 0, EXT_GIC_ID_MCT_G0, EXT_GIC_ID_MCT_G1 },
173     /* group 52 */
174     { },
175     /* int combiner group 53 */
176     { EXT_GIC_ID_WDT, 0, 0, 0, EXT_GIC_ID_MCT_G0, EXT_GIC_ID_MCT_G1 },
177     /* groups 54-63 */
178     { }, { }, { }, { }, { }, { }, { }, { }, { }, { }
179 };
180 
181 #define EXYNOS4210_GIC_NIRQ 160
182 
183 #define EXYNOS4210_EXT_GIC_CPU_REGION_SIZE     0x10000
184 #define EXYNOS4210_EXT_GIC_DIST_REGION_SIZE    0x10000
185 
186 #define EXYNOS4210_EXT_GIC_PER_CPU_OFFSET      0x8000
187 #define EXYNOS4210_EXT_GIC_CPU_GET_OFFSET(n) \
188     ((n) * EXYNOS4210_EXT_GIC_PER_CPU_OFFSET)
189 #define EXYNOS4210_EXT_GIC_DIST_GET_OFFSET(n) \
190     ((n) * EXYNOS4210_EXT_GIC_PER_CPU_OFFSET)
191 
192 #define EXYNOS4210_GIC_CPU_REGION_SIZE  0x100
193 #define EXYNOS4210_GIC_DIST_REGION_SIZE 0x1000
194 
195 static void exynos4210_irq_handler(void *opaque, int irq, int level)
196 {
197     Exynos4210Irq *s = (Exynos4210Irq *)opaque;
198 
199     /* Bypass */
200     qemu_set_irq(s->board_irqs[irq], level);
201 }
202 
203 /*
204  * Initialize exynos4210 IRQ subsystem stub.
205  */
206 qemu_irq *exynos4210_init_irq(Exynos4210Irq *s)
207 {
208     return qemu_allocate_irqs(exynos4210_irq_handler, s,
209             EXYNOS4210_MAX_INT_COMBINER_IN_IRQ);
210 }
211 
212 /*
213  * Initialize board IRQs.
214  * These IRQs contain splitted Int/External Combiner and External Gic IRQs.
215  */
216 void exynos4210_init_board_irqs(Exynos4210Irq *s)
217 {
218     uint32_t grp, bit, irq_id, n;
219 
220     for (n = 0; n < EXYNOS4210_MAX_EXT_COMBINER_IN_IRQ; n++) {
221         irq_id = 0;
222         if (n == EXYNOS4210_COMBINER_GET_IRQ_NUM(1, 4) ||
223                 n == EXYNOS4210_COMBINER_GET_IRQ_NUM(12, 4)) {
224             /* MCT_G0 is passed to External GIC */
225             irq_id = EXT_GIC_ID_MCT_G0;
226         }
227         if (n == EXYNOS4210_COMBINER_GET_IRQ_NUM(1, 5) ||
228                 n == EXYNOS4210_COMBINER_GET_IRQ_NUM(12, 5)) {
229             /* MCT_G1 is passed to External and GIC */
230             irq_id = EXT_GIC_ID_MCT_G1;
231         }
232         if (irq_id) {
233             s->board_irqs[n] = qemu_irq_split(s->int_combiner_irq[n],
234                     s->ext_gic_irq[irq_id-32]);
235         } else {
236             s->board_irqs[n] = qemu_irq_split(s->int_combiner_irq[n],
237                     s->ext_combiner_irq[n]);
238         }
239     }
240     for (; n < EXYNOS4210_MAX_INT_COMBINER_IN_IRQ; n++) {
241         /* these IDs are passed to Internal Combiner and External GIC */
242         grp = EXYNOS4210_COMBINER_GET_GRP_NUM(n);
243         bit = EXYNOS4210_COMBINER_GET_BIT_NUM(n);
244         irq_id = combiner_grp_to_gic_id[grp -
245                      EXYNOS4210_MAX_EXT_COMBINER_OUT_IRQ][bit];
246 
247         if (irq_id) {
248             s->board_irqs[n] = qemu_irq_split(s->int_combiner_irq[n],
249                     s->ext_gic_irq[irq_id-32]);
250         }
251     }
252 }
253 
254 /*
255  * Get IRQ number from exynos4210 IRQ subsystem stub.
256  * To identify IRQ source use internal combiner group and bit number
257  *  grp - group number
258  *  bit - bit number inside group
259  */
260 uint32_t exynos4210_get_irq(uint32_t grp, uint32_t bit)
261 {
262     return EXYNOS4210_COMBINER_GET_IRQ_NUM(grp, bit);
263 }
264 
265 /********* GIC part *********/
266 
267 #define TYPE_EXYNOS4210_GIC "exynos4210.gic"
268 OBJECT_DECLARE_SIMPLE_TYPE(Exynos4210GicState, EXYNOS4210_GIC)
269 
270 struct Exynos4210GicState {
271     SysBusDevice parent_obj;
272 
273     MemoryRegion cpu_container;
274     MemoryRegion dist_container;
275     MemoryRegion cpu_alias[EXYNOS4210_NCPUS];
276     MemoryRegion dist_alias[EXYNOS4210_NCPUS];
277     uint32_t num_cpu;
278     DeviceState *gic;
279 };
280 
281 static void exynos4210_gic_set_irq(void *opaque, int irq, int level)
282 {
283     Exynos4210GicState *s = (Exynos4210GicState *)opaque;
284     qemu_set_irq(qdev_get_gpio_in(s->gic, irq), level);
285 }
286 
287 static void exynos4210_gic_realize(DeviceState *dev, Error **errp)
288 {
289     Object *obj = OBJECT(dev);
290     Exynos4210GicState *s = EXYNOS4210_GIC(obj);
291     SysBusDevice *sbd = SYS_BUS_DEVICE(obj);
292     SysBusDevice *gicbusdev;
293     uint32_t n = s->num_cpu;
294     uint32_t i;
295 
296     s->gic = qdev_new("arm_gic");
297     qdev_prop_set_uint32(s->gic, "num-cpu", s->num_cpu);
298     qdev_prop_set_uint32(s->gic, "num-irq", EXYNOS4210_GIC_NIRQ);
299     gicbusdev = SYS_BUS_DEVICE(s->gic);
300     sysbus_realize_and_unref(gicbusdev, &error_fatal);
301 
302     /* Pass through outbound IRQ lines from the GIC */
303     sysbus_pass_irq(sbd, gicbusdev);
304 
305     /* Pass through inbound GPIO lines to the GIC */
306     qdev_init_gpio_in(dev, exynos4210_gic_set_irq,
307                       EXYNOS4210_GIC_NIRQ - 32);
308 
309     memory_region_init(&s->cpu_container, obj, "exynos4210-cpu-container",
310             EXYNOS4210_EXT_GIC_CPU_REGION_SIZE);
311     memory_region_init(&s->dist_container, obj, "exynos4210-dist-container",
312             EXYNOS4210_EXT_GIC_DIST_REGION_SIZE);
313 
314     /*
315      * This clues in gcc that our on-stack buffers do, in fact have
316      * enough room for the cpu numbers.  gcc 9.2.1 on 32-bit x86
317      * doesn't figure this out, otherwise and gives spurious warnings.
318      */
319     assert(n <= EXYNOS4210_NCPUS);
320     for (i = 0; i < n; i++) {
321         g_autofree char *cpu_alias_name = g_strdup_printf("exynos4210-gic-alias_cpu%u", i);
322         g_autofree char *dist_alias_name = g_strdup_printf("exynos4210-gic-alias_dist%u", i);
323 
324         /* Map CPU interface per SMP Core */
325         memory_region_init_alias(&s->cpu_alias[i], obj,
326                                  cpu_alias_name,
327                                  sysbus_mmio_get_region(gicbusdev, 1),
328                                  0,
329                                  EXYNOS4210_GIC_CPU_REGION_SIZE);
330         memory_region_add_subregion(&s->cpu_container,
331                 EXYNOS4210_EXT_GIC_CPU_GET_OFFSET(i), &s->cpu_alias[i]);
332 
333         /* Map Distributor per SMP Core */
334         memory_region_init_alias(&s->dist_alias[i], obj,
335                                  dist_alias_name,
336                                  sysbus_mmio_get_region(gicbusdev, 0),
337                                  0,
338                                  EXYNOS4210_GIC_DIST_REGION_SIZE);
339         memory_region_add_subregion(&s->dist_container,
340                 EXYNOS4210_EXT_GIC_DIST_GET_OFFSET(i), &s->dist_alias[i]);
341     }
342 
343     sysbus_init_mmio(sbd, &s->cpu_container);
344     sysbus_init_mmio(sbd, &s->dist_container);
345 }
346 
347 static Property exynos4210_gic_properties[] = {
348     DEFINE_PROP_UINT32("num-cpu", Exynos4210GicState, num_cpu, 1),
349     DEFINE_PROP_END_OF_LIST(),
350 };
351 
352 static void exynos4210_gic_class_init(ObjectClass *klass, void *data)
353 {
354     DeviceClass *dc = DEVICE_CLASS(klass);
355 
356     device_class_set_props(dc, exynos4210_gic_properties);
357     dc->realize = exynos4210_gic_realize;
358 }
359 
360 static const TypeInfo exynos4210_gic_info = {
361     .name          = TYPE_EXYNOS4210_GIC,
362     .parent        = TYPE_SYS_BUS_DEVICE,
363     .instance_size = sizeof(Exynos4210GicState),
364     .class_init    = exynos4210_gic_class_init,
365 };
366 
367 static void exynos4210_gic_register_types(void)
368 {
369     type_register_static(&exynos4210_gic_info);
370 }
371 
372 type_init(exynos4210_gic_register_types)
373 
374 /* IRQ OR Gate struct.
375  *
376  * This device models an OR gate. There are n_in input qdev gpio lines and one
377  * output sysbus IRQ line. The output IRQ level is formed as OR between all
378  * gpio inputs.
379  */
380 
381 #define TYPE_EXYNOS4210_IRQ_GATE "exynos4210.irq_gate"
382 OBJECT_DECLARE_SIMPLE_TYPE(Exynos4210IRQGateState, EXYNOS4210_IRQ_GATE)
383 
384 struct Exynos4210IRQGateState {
385     SysBusDevice parent_obj;
386 
387     uint32_t n_in;      /* inputs amount */
388     uint32_t *level;    /* input levels */
389     qemu_irq out;       /* output IRQ */
390 };
391 
392 static Property exynos4210_irq_gate_properties[] = {
393     DEFINE_PROP_UINT32("n_in", Exynos4210IRQGateState, n_in, 1),
394     DEFINE_PROP_END_OF_LIST(),
395 };
396 
397 static const VMStateDescription vmstate_exynos4210_irq_gate = {
398     .name = "exynos4210.irq_gate",
399     .version_id = 2,
400     .minimum_version_id = 2,
401     .fields = (VMStateField[]) {
402         VMSTATE_VBUFFER_UINT32(level, Exynos4210IRQGateState, 1, NULL, n_in),
403         VMSTATE_END_OF_LIST()
404     }
405 };
406 
407 /* Process a change in IRQ input. */
408 static void exynos4210_irq_gate_handler(void *opaque, int irq, int level)
409 {
410     Exynos4210IRQGateState *s = (Exynos4210IRQGateState *)opaque;
411     uint32_t i;
412 
413     assert(irq < s->n_in);
414 
415     s->level[irq] = level;
416 
417     for (i = 0; i < s->n_in; i++) {
418         if (s->level[i] >= 1) {
419             qemu_irq_raise(s->out);
420             return;
421         }
422     }
423 
424     qemu_irq_lower(s->out);
425 }
426 
427 static void exynos4210_irq_gate_reset(DeviceState *d)
428 {
429     Exynos4210IRQGateState *s = EXYNOS4210_IRQ_GATE(d);
430 
431     memset(s->level, 0, s->n_in * sizeof(*s->level));
432 }
433 
434 /*
435  * IRQ Gate initialization.
436  */
437 static void exynos4210_irq_gate_init(Object *obj)
438 {
439     Exynos4210IRQGateState *s = EXYNOS4210_IRQ_GATE(obj);
440     SysBusDevice *sbd = SYS_BUS_DEVICE(obj);
441 
442     sysbus_init_irq(sbd, &s->out);
443 }
444 
445 static void exynos4210_irq_gate_realize(DeviceState *dev, Error **errp)
446 {
447     Exynos4210IRQGateState *s = EXYNOS4210_IRQ_GATE(dev);
448 
449     /* Allocate general purpose input signals and connect a handler to each of
450      * them */
451     qdev_init_gpio_in(dev, exynos4210_irq_gate_handler, s->n_in);
452 
453     s->level = g_malloc0(s->n_in * sizeof(*s->level));
454 }
455 
456 static void exynos4210_irq_gate_class_init(ObjectClass *klass, void *data)
457 {
458     DeviceClass *dc = DEVICE_CLASS(klass);
459 
460     dc->reset = exynos4210_irq_gate_reset;
461     dc->vmsd = &vmstate_exynos4210_irq_gate;
462     device_class_set_props(dc, exynos4210_irq_gate_properties);
463     dc->realize = exynos4210_irq_gate_realize;
464 }
465 
466 static const TypeInfo exynos4210_irq_gate_info = {
467     .name          = TYPE_EXYNOS4210_IRQ_GATE,
468     .parent        = TYPE_SYS_BUS_DEVICE,
469     .instance_size = sizeof(Exynos4210IRQGateState),
470     .instance_init = exynos4210_irq_gate_init,
471     .class_init    = exynos4210_irq_gate_class_init,
472 };
473 
474 static void exynos4210_irq_gate_register_types(void)
475 {
476     type_register_static(&exynos4210_irq_gate_info);
477 }
478 
479 type_init(exynos4210_irq_gate_register_types)
480