xref: /openbmc/qemu/hw/intc/arm_gic_common.c (revision 80e5db30)
1 /*
2  * ARM GIC support - common bits of emulated and KVM kernel model
3  *
4  * Copyright (c) 2012 Linaro Limited
5  * Written by Peter Maydell
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 #include "qemu/osdep.h"
22 #include "qapi/error.h"
23 #include "gic_internal.h"
24 #include "hw/arm/linux-boot-if.h"
25 
26 static void gic_pre_save(void *opaque)
27 {
28     GICState *s = (GICState *)opaque;
29     ARMGICCommonClass *c = ARM_GIC_COMMON_GET_CLASS(s);
30 
31     if (c->pre_save) {
32         c->pre_save(s);
33     }
34 }
35 
36 static int gic_post_load(void *opaque, int version_id)
37 {
38     GICState *s = (GICState *)opaque;
39     ARMGICCommonClass *c = ARM_GIC_COMMON_GET_CLASS(s);
40 
41     if (c->post_load) {
42         c->post_load(s);
43     }
44     return 0;
45 }
46 
47 static const VMStateDescription vmstate_gic_irq_state = {
48     .name = "arm_gic_irq_state",
49     .version_id = 1,
50     .minimum_version_id = 1,
51     .fields = (VMStateField[]) {
52         VMSTATE_UINT8(enabled, gic_irq_state),
53         VMSTATE_UINT8(pending, gic_irq_state),
54         VMSTATE_UINT8(active, gic_irq_state),
55         VMSTATE_UINT8(level, gic_irq_state),
56         VMSTATE_BOOL(model, gic_irq_state),
57         VMSTATE_BOOL(edge_trigger, gic_irq_state),
58         VMSTATE_UINT8(group, gic_irq_state),
59         VMSTATE_END_OF_LIST()
60     }
61 };
62 
63 static const VMStateDescription vmstate_gic = {
64     .name = "arm_gic",
65     .version_id = 12,
66     .minimum_version_id = 12,
67     .pre_save = gic_pre_save,
68     .post_load = gic_post_load,
69     .fields = (VMStateField[]) {
70         VMSTATE_UINT32(ctlr, GICState),
71         VMSTATE_UINT32_ARRAY(cpu_ctlr, GICState, GIC_NCPU),
72         VMSTATE_STRUCT_ARRAY(irq_state, GICState, GIC_MAXIRQ, 1,
73                              vmstate_gic_irq_state, gic_irq_state),
74         VMSTATE_UINT8_ARRAY(irq_target, GICState, GIC_MAXIRQ),
75         VMSTATE_UINT8_2DARRAY(priority1, GICState, GIC_INTERNAL, GIC_NCPU),
76         VMSTATE_UINT8_ARRAY(priority2, GICState, GIC_MAXIRQ - GIC_INTERNAL),
77         VMSTATE_UINT8_2DARRAY(sgi_pending, GICState, GIC_NR_SGIS, GIC_NCPU),
78         VMSTATE_UINT16_ARRAY(priority_mask, GICState, GIC_NCPU),
79         VMSTATE_UINT16_ARRAY(running_priority, GICState, GIC_NCPU),
80         VMSTATE_UINT16_ARRAY(current_pending, GICState, GIC_NCPU),
81         VMSTATE_UINT8_ARRAY(bpr, GICState, GIC_NCPU),
82         VMSTATE_UINT8_ARRAY(abpr, GICState, GIC_NCPU),
83         VMSTATE_UINT32_2DARRAY(apr, GICState, GIC_NR_APRS, GIC_NCPU),
84         VMSTATE_UINT32_2DARRAY(nsapr, GICState, GIC_NR_APRS, GIC_NCPU),
85         VMSTATE_END_OF_LIST()
86     }
87 };
88 
89 void gic_init_irqs_and_mmio(GICState *s, qemu_irq_handler handler,
90                             const MemoryRegionOps *ops)
91 {
92     SysBusDevice *sbd = SYS_BUS_DEVICE(s);
93     int i = s->num_irq - GIC_INTERNAL;
94 
95     /* For the GIC, also expose incoming GPIO lines for PPIs for each CPU.
96      * GPIO array layout is thus:
97      *  [0..N-1] SPIs
98      *  [N..N+31] PPIs for CPU 0
99      *  [N+32..N+63] PPIs for CPU 1
100      *   ...
101      */
102     if (s->revision != REV_NVIC) {
103         i += (GIC_INTERNAL * s->num_cpu);
104     }
105     qdev_init_gpio_in(DEVICE(s), handler, i);
106 
107     for (i = 0; i < s->num_cpu; i++) {
108         sysbus_init_irq(sbd, &s->parent_irq[i]);
109     }
110     for (i = 0; i < s->num_cpu; i++) {
111         sysbus_init_irq(sbd, &s->parent_fiq[i]);
112     }
113     for (i = 0; i < s->num_cpu; i++) {
114         sysbus_init_irq(sbd, &s->parent_virq[i]);
115     }
116     for (i = 0; i < s->num_cpu; i++) {
117         sysbus_init_irq(sbd, &s->parent_vfiq[i]);
118     }
119 
120     /* Distributor */
121     memory_region_init_io(&s->iomem, OBJECT(s), ops, s, "gic_dist", 0x1000);
122     sysbus_init_mmio(sbd, &s->iomem);
123 
124     if (s->revision != REV_NVIC) {
125         /* This is the main CPU interface "for this core". It is always
126          * present because it is required by both software emulation and KVM.
127          * NVIC is not handled here because its CPU interface is different,
128          * neither it can use KVM.
129          */
130         memory_region_init_io(&s->cpuiomem[0], OBJECT(s), ops ? &ops[1] : NULL,
131                               s, "gic_cpu", s->revision == 2 ? 0x2000 : 0x100);
132         sysbus_init_mmio(sbd, &s->cpuiomem[0]);
133     }
134 }
135 
136 static void arm_gic_common_realize(DeviceState *dev, Error **errp)
137 {
138     GICState *s = ARM_GIC_COMMON(dev);
139     int num_irq = s->num_irq;
140 
141     if (s->num_cpu > GIC_NCPU) {
142         error_setg(errp, "requested %u CPUs exceeds GIC maximum %d",
143                    s->num_cpu, GIC_NCPU);
144         return;
145     }
146     s->num_irq += GIC_BASE_IRQ;
147     if (s->num_irq > GIC_MAXIRQ) {
148         error_setg(errp,
149                    "requested %u interrupt lines exceeds GIC maximum %d",
150                    num_irq, GIC_MAXIRQ);
151         return;
152     }
153     /* ITLinesNumber is represented as (N / 32) - 1 (see
154      * gic_dist_readb) so this is an implementation imposed
155      * restriction, not an architectural one:
156      */
157     if (s->num_irq < 32 || (s->num_irq % 32)) {
158         error_setg(errp,
159                    "%d interrupt lines unsupported: not divisible by 32",
160                    num_irq);
161         return;
162     }
163 
164     if (s->security_extn &&
165         (s->revision == REV_11MPCORE || s->revision == REV_NVIC)) {
166         error_setg(errp, "this GIC revision does not implement "
167                    "the security extensions");
168         return;
169     }
170 }
171 
172 static void arm_gic_common_reset(DeviceState *dev)
173 {
174     GICState *s = ARM_GIC_COMMON(dev);
175     int i, j;
176     int resetprio;
177 
178     /* If we're resetting a TZ-aware GIC as if secure firmware
179      * had set it up ready to start a kernel in non-secure,
180      * we need to set interrupt priorities to a "zero for the
181      * NS view" value. This is particularly critical for the
182      * priority_mask[] values, because if they are zero then NS
183      * code cannot ever rewrite the priority to anything else.
184      */
185     if (s->security_extn && s->irq_reset_nonsecure) {
186         resetprio = 0x80;
187     } else {
188         resetprio = 0;
189     }
190 
191     memset(s->irq_state, 0, GIC_MAXIRQ * sizeof(gic_irq_state));
192     for (i = 0 ; i < s->num_cpu; i++) {
193         if (s->revision == REV_11MPCORE) {
194             s->priority_mask[i] = 0xf0;
195         } else {
196             s->priority_mask[i] = resetprio;
197         }
198         s->current_pending[i] = 1023;
199         s->running_priority[i] = 0x100;
200         s->cpu_ctlr[i] = 0;
201         s->bpr[i] = GIC_MIN_BPR;
202         s->abpr[i] = GIC_MIN_ABPR;
203         for (j = 0; j < GIC_INTERNAL; j++) {
204             s->priority1[j][i] = resetprio;
205         }
206         for (j = 0; j < GIC_NR_SGIS; j++) {
207             s->sgi_pending[j][i] = 0;
208         }
209     }
210     for (i = 0; i < GIC_NR_SGIS; i++) {
211         GIC_SET_ENABLED(i, ALL_CPU_MASK);
212         GIC_SET_EDGE_TRIGGER(i);
213     }
214 
215     for (i = 0; i < ARRAY_SIZE(s->priority2); i++) {
216         s->priority2[i] = resetprio;
217     }
218 
219     for (i = 0; i < GIC_MAXIRQ; i++) {
220         /* For uniprocessor GICs all interrupts always target the sole CPU */
221         if (s->num_cpu == 1) {
222             s->irq_target[i] = 1;
223         } else {
224             s->irq_target[i] = 0;
225         }
226     }
227     if (s->security_extn && s->irq_reset_nonsecure) {
228         for (i = 0; i < GIC_MAXIRQ; i++) {
229             GIC_SET_GROUP(i, ALL_CPU_MASK);
230         }
231     }
232 
233     s->ctlr = 0;
234 }
235 
236 static void arm_gic_common_linux_init(ARMLinuxBootIf *obj,
237                                       bool secure_boot)
238 {
239     GICState *s = ARM_GIC_COMMON(obj);
240 
241     if (s->security_extn && !secure_boot) {
242         /* We're directly booting a kernel into NonSecure. If this GIC
243          * implements the security extensions then we must configure it
244          * to have all the interrupts be NonSecure (this is a job that
245          * is done by the Secure boot firmware in real hardware, and in
246          * this mode QEMU is acting as a minimalist firmware-and-bootloader
247          * equivalent).
248          */
249         s->irq_reset_nonsecure = true;
250     }
251 }
252 
253 static Property arm_gic_common_properties[] = {
254     DEFINE_PROP_UINT32("num-cpu", GICState, num_cpu, 1),
255     DEFINE_PROP_UINT32("num-irq", GICState, num_irq, 32),
256     /* Revision can be 1 or 2 for GIC architecture specification
257      * versions 1 or 2, or 0 to indicate the legacy 11MPCore GIC.
258      * (Internally, 0xffffffff also indicates "not a GIC but an NVIC".)
259      */
260     DEFINE_PROP_UINT32("revision", GICState, revision, 1),
261     /* True if the GIC should implement the security extensions */
262     DEFINE_PROP_BOOL("has-security-extensions", GICState, security_extn, 0),
263     DEFINE_PROP_END_OF_LIST(),
264 };
265 
266 static void arm_gic_common_class_init(ObjectClass *klass, void *data)
267 {
268     DeviceClass *dc = DEVICE_CLASS(klass);
269     ARMLinuxBootIfClass *albifc = ARM_LINUX_BOOT_IF_CLASS(klass);
270 
271     dc->reset = arm_gic_common_reset;
272     dc->realize = arm_gic_common_realize;
273     dc->props = arm_gic_common_properties;
274     dc->vmsd = &vmstate_gic;
275     albifc->arm_linux_init = arm_gic_common_linux_init;
276 }
277 
278 static const TypeInfo arm_gic_common_type = {
279     .name = TYPE_ARM_GIC_COMMON,
280     .parent = TYPE_SYS_BUS_DEVICE,
281     .instance_size = sizeof(GICState),
282     .class_size = sizeof(ARMGICCommonClass),
283     .class_init = arm_gic_common_class_init,
284     .abstract = true,
285     .interfaces = (InterfaceInfo []) {
286         { TYPE_ARM_LINUX_BOOT_IF },
287         { },
288     },
289 };
290 
291 static void register_types(void)
292 {
293     type_register_static(&arm_gic_common_type);
294 }
295 
296 type_init(register_types)
297